Add support for PostgreSQL dialect (#400)

Co-authored-by: john-sanchez31 <[email protected]>

Author: juankx-bodo

.github/workflows/postgres_testing.yml

@@ -0,0 +1,71 @@
+name: Run Postgres Tests
+
+on:
+  workflow_call:
+    inputs:
+      python-versions:
+        description: "JSON string of Python versions"
+        type: string
+        required: true
+    secrets:
+      POSTGRES_USER:
+        required: true
+      POSTGRES_PASSWORD:
+        required: true
+
+jobs:
+  postgres-test:
+    name: Postgres Tests (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ${{ fromJSON(inputs.python-versions) }}
+
+    # Define services here to run Docker containers alongside your job
+    services:
+      postgres:
+        image: bodoai1/pydough-postgres-tpch:latest
+        env:
+          # Set environment variables for Postgres container
+          POSTGRES_USER: ${{ secrets.POSTGRES_USER }}
+          POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
+          POSTGRES_DB: "pydough_test"
+        ports:
+          - 5432:5432
+    env:
+      POSTGRES_USER: ${{ secrets.POSTGRES_USER }}
+      POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
+      POSTGRES_DB: pydough_test
+      POSTGRES_HOST: 127.0.0.1
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Python ${{ matrix.python-version }}
+        id: setup-python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "0.4.23"
+
+      - name: Create virtual environment
+        run: uv venv
+
+      - name: Install dependencies
+        run: uv pip install -e ".[postgres]" 
+
+      - name: Wait for Postgres to be ready
+        run: |
+          for i in $(seq 1 240); do
+            pg_isready -h ${{ env.POSTGRES_HOST }} -U ${{ env.POSTGRES_USER }} -d ${{ env.POSTGRES_DB }} && break || sleep 2;
+          done
+          pg_isready -h ${{ env.POSTGRES_HOST }} -U ${{ env.POSTGRES_USER }} -d ${{ env.POSTGRES_DB }} && echo "PostgreSQL is running" || exit 1;
+      - name: Confirm Postgres connector is installed
+        run: uv run python -c "import psycopg2; print('Postgres connector installed')"
+
+      - name: Run Postgres Tests
+        run: uv run pytest -m postgres tests/ -rs

.github/workflows/pr_testing.yml

@@ -36,6 +36,11 @@ on:
         type: boolean
         required: false
         default: false
+      run-postgres:
+        description: "Run Postgres Tests"
+        type: boolean
+        required: false
+        default: false        
 
 # Limit CI to cancel previous runs in the same PR
 concurrency:
@@ -138,7 +143,7 @@ jobs:
         run: uv run ruff check .
 
       - name: Run Tests
-        run: uv run pytest tests/ -m "not (snowflake or mysql)" -rs
+        run: uv run pytest tests/ -m "not (snowflake or mysql or postgres)" -rs
 
   run-sf-tests:
     name: Snowflake Tests
@@ -164,11 +169,27 @@ jobs:
       (github.event_name == 'pull_request' && contains(needs.get-msg.outputs.commitMsg, '[run all]')) ||
       (github.event_name == 'pull_request' && contains(needs.get-msg.outputs.commitMsg, '[run mysql]')) ||
       (github.event_name == 'workflow_dispatch' && (inputs.run-all || inputs.run-mysql))
-    uses: ./.github/workflows/mysql_testing.yml # Path to MySQL workflow file
+    uses: ./.github/workflows/mysql_testing.yml
     secrets:
       MYSQL_USERNAME: ${{ secrets.MYSQL_USERNAME }}
       MYSQL_PASSWORD: ${{ secrets.MYSQL_PASSWORD }}
     with:
       python-versions: ${{ github.event_name == 'workflow_dispatch'
                       && needs.get-py-ver-matrix.outputs.matrix
                       || '["3.10", "3.11", "3.12"]' }}
+
+  run-postgres-tests:
+    name: Postgres Tests
+    needs: [get-msg, get-py-ver-matrix]
+    if: |
+      (github.event_name == 'pull_request' && contains(needs.get-msg.outputs.commitMsg, '[run all]')) ||
+      (github.event_name == 'pull_request' && contains(needs.get-msg.outputs.commitMsg, '[run postgres]')) ||
+      (github.event_name == 'workflow_dispatch' && (inputs.run-all || inputs.run-postgres))
+    uses: ./.github/workflows/postgres_testing.yml
+    secrets:
+      POSTGRES_USER: ${{ secrets.POSTGRES_USER }}
+      POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
+    with:
+      python-versions: ${{ github.event_name == 'workflow_dispatch'
+                      && needs.get-py-ver-matrix.outputs.matrix
+                      || '["3.10", "3.11", "3.12"]' }}

README.md

@@ -141,6 +141,26 @@ To run **MySQL CI tests**, add the flag `[run mysql]` to your commit message.
         export MYSQL_USERNAME="your_username"
         export MYSQL_PASSWORD="your_password"
 
+## Running Postgres Tests on CI
+To run **Postgres CI tests**, add the flag `[run postgres]` to your commit message.
+
+**Running Postgres tests locally:**
+
+1. Make sure you have [**Docker Desktop**](https://www.docker.com/get-started/)
+ installed and running.
+
+2. Install the Postgres Connector for Python
+    ```bash
+    pip install psycopg2-binary
+    ```
+    
+3. Set your Postgres credentials as environment variables:
+    ```bash
+        export POSTGRES_DB="your_database"
+        export POSTGRES_USER="your_username"
+        export POSTGRES_PASSWORD="your_password"
+    ```
+
 ## Runtime Dependencies
 
 PyDough requires having the following Python modules installed to use

demos/README.md

@@ -23,6 +23,7 @@ Once the introduction notebook is complete, you can explore the other notebooks:
 - [3_exploration.ipynb](notebooks/3_exploration.ipynb) shows how to use several user APIs for exploring PyDough.
 - [4_tpch.ipynb](notebooks/4_tpch.ipynb) provides PyDough translations for most of the TPC-H benchmark queries.
 - [5_what_if.ipynb](notebooks/5_what_if.ipynb) demonstrates how to do WHAT-IF analysis with PyDough.
-- [MySQL_TPCH.ipynb](notebooks/MySQL_TPCH.ipynb) demonstrates how to connect a MySQL database with PyDough.
 - [SF_TPCH_q1.ipynb](notebooks/SF_TPCH_q1.ipynb) demonstrates how to connect a Snowflake database with PyDough.
+- [MySQL_TPCH.ipynb](notebooks/MySQL_TPCH.ipynb) demonstrates how to connect a MySQL database with PyDough.
+- [PG_TPCH.ipynb](notebooks/PG_TPCH.ipynb) demonstrates how to connect a Postgres database with PyDough.