Remove SQLAlchemy dialect

.github/workflows/codeql.yml

@@ -19,7 +19,7 @@ concurrency:
 jobs:
 
   analyze:
-    name: "Analyze with SQLAlchemy ${{ matrix.sqla-version }}"
+    name: "Analyze Python code"
     runs-on: ubuntu-latest
     permissions:
       actions: read
@@ -28,9 +28,7 @@ jobs:
 
     strategy:
       fail-fast: false
-      matrix:
-        language: [ python ]
-        sqla-version: ['<1.4', '<1.5', '<2.1']
+      language: [ python ]
 
     steps:
       - name: Checkout
@@ -57,10 +55,7 @@ jobs:
 
       - name: Install project
         run: |
-          pip install --editable=.[sqlalchemy,test]
-          pip install "sqlalchemy${{ matrix.sqla-version }}" --upgrade --pre
+          pip install --editable=.[test]
 
       - name: Perform CodeQL Analysis
         uses: github/codeql-action/analyze@v3
-        with:
-          category: "/language:${{ matrix.language }}/sqla-version:${{ matrix.sqla-version }}"

.github/workflows/nightly.yml

@@ -9,7 +9,6 @@ on:
 jobs:
   nightly:
     name: "Python: ${{ matrix.python-version }}
-     SQLA: ${{ matrix.sqla-version }}
      CrateDB: ${{ matrix.cratedb-version }}
      on ${{ matrix.os }}"
     runs-on: ${{ matrix.os }}
@@ -18,23 +17,11 @@ jobs:
         os: ['ubuntu-latest']
         python-version: ['3.7', '3.8', '3.9', '3.10', '3.11', '3.12']
         cratedb-version: ['nightly']
-        sqla-version: ['latest']
-        pip-allow-prerelease: ['false']
-
-        # Another CI test matrix slot to test against prerelease versions of Python packages.
-        include:
-          - os: 'ubuntu-latest'
-            python-version: '3.12'
-            cratedb-version: 'nightly'
-            sqla-version: 'latest'
-            pip-allow-prerelease: 'true'
 
       fail-fast: false
 
     env:
       CRATEDB_VERSION: ${{ matrix.cratedb-version }}
-      SQLALCHEMY_VERSION: ${{ matrix.sqla-version }}
-      PIP_ALLOW_PRERELEASE: ${{ matrix.pip-allow-prerelease }}
 
     steps:
       - uses: actions/checkout@v4
@@ -55,11 +42,10 @@ jobs:
           source bootstrap.sh
 
           # Report about the test matrix slot.
-          echo "Invoking tests with CrateDB ${CRATEDB_VERSION} and SQLAlchemy ${SQLALCHEMY_VERSION}"
+          echo "Invoking tests with CrateDB ${CRATEDB_VERSION}"
 
           # Run linter.
           flake8 src bin
 
           # Run tests.
-          export SQLALCHEMY_WARN_20=1
           bin/test -vvv

.github/workflows/tests.yml

@@ -13,16 +13,13 @@ concurrency:
 jobs:
   test:
     name: "Python: ${{ matrix.python-version }}
-     SQLA: ${{ matrix.sqla-version }}
      on ${{ matrix.os }}"
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: ['ubuntu-latest', 'macos-latest']
         python-version: ['3.7', '3.8', '3.9', '3.10', '3.11', '3.12']
         cratedb-version: ['5.4.5']
-        sqla-version: ['<1.4', '<1.5', '<2.1']
-        pip-allow-prerelease: ['false']
 
         # To save resources, only use the most recent Python versions on macOS.
         exclude:
@@ -35,20 +32,10 @@ jobs:
           - os: 'macos-latest'
             python-version: '3.10'
 
-        # Another CI test matrix slot to test against prerelease versions of Python packages.
-        include:
-          - os: 'ubuntu-latest'
-            python-version: '3.12'
-            cratedb-version: '5.4.5'
-            sqla-version: 'latest'
-            pip-allow-prerelease: 'true'
-
       fail-fast: false
 
     env:
       CRATEDB_VERSION: ${{ matrix.cratedb-version }}
-      SQLALCHEMY_VERSION: ${{ matrix.sqla-version }}
-      PIP_ALLOW_PRERELEASE: ${{ matrix.pip-allow-prerelease }}
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
     steps:
@@ -70,13 +57,12 @@ jobs:
           source bootstrap.sh
 
           # Report about the test matrix slot.
-          echo "Invoking tests with CrateDB ${CRATEDB_VERSION} and SQLAlchemy ${SQLALCHEMY_VERSION}"
+          echo "Invoking tests with CrateDB ${CRATEDB_VERSION}"
 
           # Run linter.
           flake8 src bin
 
           # Run tests.
-          export SQLALCHEMY_WARN_20=1
           coverage run bin/test -vvv
 
           # Set the stage for uploading the coverage report.

CHANGES.txt

@@ -5,6 +5,13 @@ Changes for crate
 Unreleased
 ==========
 
+- The SQLAlchemy dialect has been split off into the `sqlalchemy-cratedb`_
+  package. See `Migrate from crate.client to sqlalchemy-cratedb`_ to learn
+  about necessary migration steps.
+
+.. _Migrate from crate.client to sqlalchemy-cratedb: https://cratedb.com/docs/sqlalchemy-cratedb/migrate-from-crate-client.html
+.. _sqlalchemy-cratedb: https://pypi.org/project/sqlalchemy-cratedb/
+
 
 2024/01/18 0.35.2
 =================

DEVELOP.rst

@@ -30,9 +30,7 @@ Run all tests::
 
 Run specific tests::
 
-    ./bin/test -vvvv -t SqlAlchemyCompilerTest
     ./bin/test -vvvv -t test_score
-    ./bin/test -vvvv -t sqlalchemy
 
 Ignore specific test directories::
 

bootstrap.sh

@@ -18,7 +18,6 @@
 
 # Default variables.
 CRATEDB_VERSION=${CRATEDB_VERSION:-5.2.2}
-SQLALCHEMY_VERSION=${SQLALCHEMY_VERSION:-<2.1}
 
 
 function print_header() {
@@ -71,16 +70,7 @@ function setup_package() {
     fi
 
     # Install package in editable mode.
-    pip install ${PIP_OPTIONS} --editable='.[sqlalchemy,test]'
-
-    # Install designated SQLAlchemy version.
-    if [ -n "${SQLALCHEMY_VERSION}" ]; then
-      if [ "${SQLALCHEMY_VERSION}" = "latest" ]; then
-        pip install ${PIP_OPTIONS} --upgrade "sqlalchemy"
-      else
-        pip install ${PIP_OPTIONS} --upgrade "sqlalchemy${SQLALCHEMY_VERSION}"
-      fi
-    fi
+    pip install ${PIP_OPTIONS} --editable='.[test]'
 
 }
 
@@ -93,8 +83,6 @@ function finalize() {
     # Some steps before dropping into the activated virtualenv.
     echo
     echo "Sandbox environment ready"
-    echo -n "Using SQLAlchemy version: "
-    python -c 'import sqlalchemy; print(sqlalchemy.__version__)'
     echo
 
 }

docs/by-example/index.rst

@@ -5,11 +5,8 @@ By example
 ##########
 
 This part of the documentation enumerates different kinds of examples how to
-use the CrateDB Python client.
-
-
-DB API, HTTP, and BLOB interfaces
-=================================
+use the CrateDB Python DBAPI HTTP client for standards-based database
+conversations, and the proprietary BLOB interfaces.
 
 The examples in this section are all about CrateDB's `Python DB API`_ interface,
 the plain HTTP API interface, and a convenience interface for working with
@@ -27,24 +24,4 @@ methods, and behaviors of the ``Connection`` and ``Cursor`` objects.
     blob
 
 
-.. _sqlalchemy-by-example:
-
-SQLAlchemy by example
-=====================
-
-The examples in this section are all about CrateDB's `SQLAlchemy`_ dialect, and
-its corresponding API interfaces, see also :ref:`sqlalchemy-support`.
-
-.. toctree::
-    :maxdepth: 1
-
-    sqlalchemy/getting-started
-    sqlalchemy/crud
-    sqlalchemy/working-with-types
-    sqlalchemy/advanced-querying
-    sqlalchemy/inspection-reflection
-    sqlalchemy/dataframe
-
-
 .. _Python DB API: https://peps.python.org/pep-0249/
-.. _SQLAlchemy: https://www.sqlalchemy.org/