Refactoring/610 use text construct for strings passed to execute (#611)

* Set SQLALCHEMY_WARN_20 in environment to output deprecation warnings in tests

* Set the deprecation we want to fix as an error to explicitly ensure we resolve

* Rename so clearer that control connection is from pyexasol and not sqlalchemy-exasol

* Resolve string to execute for test:regression

* Resolve string to execute for test:exasol

* Resolve string to execute for test:sqla

* Run project:fix on files

* Update pre-commit-config

Author: ArBridgeman

.github/workflows/checks.yml

@@ -180,7 +180,9 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Run Tests and Collect Coverage
-        run: poetry run -- nox -s test:unit -- --coverage
+        run: |
+          export SQLALCHEMY_WARN_20=1
+          poetry run -- nox -s test:unit -- --coverage
 
       - name: Upload Artifacts
         uses: actions/[email protected]

.github/workflows/slow-checks.yml

@@ -35,7 +35,9 @@ jobs:
         run: sudo apt-get install unixodbc unixodbc-dev libboost-date-time-dev libboost-locale-dev libboost-system-dev
 
       - name: Run Tests and Collect Coverage
-        run: poetry run -- nox -s test:integration -- --coverage --db-version ${{ matrix.exasol-version }}
+        run: |
+          export SQLALCHEMY_WARN_20=1
+          poetry run -- nox -s test:integration -- --coverage --db-version ${{ matrix.exasol-version }}
 
       - name: Upload Artifacts
         uses: actions/[email protected]

.pre-commit-config.yaml

@@ -1,28 +1,42 @@
-default_stages: [commit]
+default_stages: [ pre-commit, pre-push ]
 repos:
--   repo: local
+
+  - repo: local
+    hooks:
+      - id: code-format
+        name: code-format
+        types: [ python ]
+        pass_filenames: false
+        language: system
+        entry: poetry run -- nox -s project:fix
+        stages: [ pre-commit ]
+
+  - repo: local
     hooks:
-      -   id: code-format
-          name: code-format
-          types: [python]
-          pass_filenames: false
-          language: system
-          entry: poetry run -- python -m nox -s project:fix
+      - id: type-check
+        name: type-check
+        types: [ python ]
+        pass_filenames: false
+        language: system
+        entry: poetry run -- nox -s lint:typing
+        stages: [ pre-push ]
 
--   repo: local
+  - repo: local
     hooks:
-      -   id: type-check
-          name: type-check
-          types: [python]
-          pass_filenames: false
-          language: system
-          entry: poetry run -- python -m nox -s lint:typing
+      - id: lint
+        name: lint
+        types: [ python ]
+        pass_filenames: false
+        language: system
+        entry: poetry run -- nox -s lint:code
+        stages: [ pre-push ]
 
--   repo: local
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
     hooks:
-      -   id: lint
-          name:  lint
-          types: [python]
-          pass_filenames: false
-          language: system
-          entry: poetry run -- python -m nox -s lint:code
+      - id: check-yaml
+        stages: [ pre-commit ]
+      - id: end-of-file-fixer
+        stages: [ pre-commit ]
+      - id: trailing-whitespace
+        stages: [ pre-commit ]

README.rst

@@ -97,8 +97,10 @@ Using SQLAlchemy with EXASOL DB
 
 	from sqlalchemy import create_engine
 	url = "exa+websocket://A_USER:[email protected]:1234/my_schema?CONNECTIONLCALL=en_US.UTF-8"
-	e = create_engine(url)
-	r = e.execute("select 42 from dual").fetchall()
+    e = create_engine(url)
+    query = "select 42 from dual"
+    with engine.connect() as con:
+        result = con.execute(sql.text(query)).fetchall()
 
 Examples:
 
@@ -132,17 +134,21 @@ Examples:
 
 	from sqlalchemy import create_engine
 	url = "exa+pyodbc://A_USER:[email protected]:1234/my_schema?CONNECTIONLCALL=en_US.UTF-8&driver=EXAODBC"
-	e = create_engine(url)
-	r = e.execute("select 42 from dual").fetchall()
+    e = create_engine(url)
+    query = "select 42 from dual"
+    with engine.connect() as con:
+        result = con.execute(sql.text(query)).fetchall()
 
 **Turbodbc (ODBC based Dialect):**
 
 .. code-block:: python
 
 	from sqlalchemy import create_engine
 	url = "exa+turbodbc://A_USER:[email protected]:1234/my_schema?CONNECTIONLCALL=en_US.UTF-8&driver=EXAODBC"
-	e = create_engine(url)
-	r = e.execute("select 42 from dual").fetchall()
+    e = create_engine(url)
+    query = "select 42 from dual"
+    with engine.connect() as con:
+        result = con.execute(sql.text(query)).fetchall()
 
 
 Features

doc/changes/unreleased.md

@@ -7,12 +7,16 @@ This allows us to use the latest dependencies, which do not have open vulnerabil
 
 - #612: Updated CI tests to run against Exasol DB versions 7.1.30, 8.34.0, and 2025.1.0. Dropped support for Python 3.9.
 
-## 🧰 Internal
+## Refactoring
 
-- #558 Updated to poetry 2.1.2 & relocked dependencies to resolve CVE-2025-27516
+- #610: Altered string input into `Connection.execute()` to be handled properly
+
+## Internal
+
+- #558: Updated to poetry 2.1.2 & relocked dependencies to resolve CVE-2025-27516
 - #548: Replaced pytest-exasol-itde with pytest-backend
-- - Relocked dependencies to resolve CVE-2025-43859
+- Relocked dependencies to resolve CVE-2025-43859
 - #564: Replaced nox test:unit with that from exasol-toolbox
 - Reformatted files to meet project specifications
 - #588: Updated to exasol-toolbox 1.6.0 and relocked dependencies to resolve CVE-2025-50182, CVE-2025-50181, & CVE-2024-47081
-- #605: Removed non-ASCII unicode from templates & relocked dependencies to resolve CVE-2025-8869 (pip -> transitive dependency)
+- #605: Removed non-ASCII unicode from templates & relocked dependencies to resolve CVE-2025-8869 (pip -> transitive dependency)

doc/user_guide.rst

@@ -22,13 +22,15 @@ Getting Started
 
     .. code-block:: python
 
-        from sqlalchemy import create_engine
+        from sqlalchemy import create_engine, sql
         url = "exa+pyodbc://A_USER:[email protected]:1234/my_schema?CONNECTIONLCALL=en_US.UTF-8&driver=EXAODBC"
         e = create_engine(url)
-        r = e.execute("select 42 from dual").fetchall()
+        query = "select 42 from dual"
+        with engine.connect() as con:
+            result = con.execute(sql.text(query)).fetchall()
 
 
-For more details on SQLAlchemy consult it's `documenation <https://docs.sqlalchemy.org/en/13/>`_.
+For more details on SQLAlchemy consult it's `documentation <https://docs.sqlalchemy.org/en/13/>`_.
 
 Readme
 ~~~~~~

noxfile.py

@@ -61,7 +61,6 @@ def parser() -> ArgumentParser:
             "--db-version",
             choices=PROJECT_CONFIG.exasol_versions,
             default=PROJECT_CONFIG.exasol_versions[0],
-            help="which will be used",
         )
         return p
 
@@ -125,7 +124,6 @@ def parser() -> ArgumentParser:
             "--connector",
             choices=PROJECT_CONFIG.connectors,
             default=PROJECT_CONFIG.connectors[0],
-            help="which will be used",
         )
         return p
 
@@ -157,7 +155,6 @@ def parser() -> ArgumentParser:
             "--connector",
             choices=PROJECT_CONFIG.connectors,
             default=PROJECT_CONFIG.connectors[0],
-            help="which will be used",
         )
         return p
 
@@ -199,13 +196,11 @@ def parser() -> ArgumentParser:
             "--connector",
             choices=PROJECT_CONFIG.connectors,
             default=PROJECT_CONFIG.connectors[0],
-            help="which will be used",
         )
         p.add_argument(
             "--db-version",
             choices=PROJECT_CONFIG.exasol_versions,
             default=PROJECT_CONFIG.exasol_versions[0],
-            help="which will be used",
         )
         p.add_argument(
             "--coverage",
@@ -223,15 +218,15 @@ def parser() -> ArgumentParser:
         posargs=["--db-version", f"{args.db_version}"],
     )
     session.notify(
-        find_session_runner(session, f"test:sqla"),
+        find_session_runner(session, "test:sqla"),
         posargs=["--connector", f"{args.connector}"],
     )
     session.notify(
-        find_session_runner(session, f"test:exasol"),
+        find_session_runner(session, "test:exasol"),
         posargs=["--connector", f"{args.connector}"],
     )
     session.notify(
-        find_session_runner(session, f"test:regression"),
+        find_session_runner(session, "test:regression"),
     )
     session.notify(find_session_runner(session, "db:stop"))
 
@@ -271,14 +266,14 @@ def report_skipped(session: Session) -> None:
 
 
 def _connector_matrix(config: Config):
-    CONNECTORS = ["websocket"]
+    connectors_list = ["websocket"]
     attr = "connectors"
-    connectors = getattr(config, attr, CONNECTORS)
+    connectors = getattr(config, attr, connectors_list)
     if not hasattr(config, attr):
         _log.warning(
             "Config does not contain '%s' setting. Using default: %s",
             attr,
-            CONNECTORS,
+            connectors_list,
         )
     return {"connector": connectors}
 

pyproject.toml

@@ -92,9 +92,12 @@ exasol-toolbox = "^1.9.0"
 [tool.pytest.ini_options]
 addopts = "--tb native -v -r fxX"
 filterwarnings = [
-    "error::DeprecationWarning",
-    "ignore::DeprecationWarning:sqlalchemy.testing.plugin.*",
-    "ignore::DeprecationWarning:sqlalchemy_exasol.*",
+# before end of #413, switch this from a text specific issue to a general error on a warning to ensure known deprecation issues have been resolved
+"error:.*Passing a string.*",
+# this is used for turbodbc and pyodbc as historically we'd like to remove them.
+# thus far, it seems like this is not a strict requirement for the migration,
+# so we will ignore them.
+"ignore::sqlalchemy_exasol.warnings.SqlaExasolDeprecationWarning"
 ]
 
 [tool.black]
@@ -128,4 +131,4 @@ follow_untyped_imports = true
 [tool.sonar]
 projectKey = "com.exasol:sqlalchemy-exasol"
 hostUrl = "https://sonarcloud.io"
-organization = "exasol"
+organization = "exasol"

sqlalchemy_exasol/base.py

@@ -53,6 +53,7 @@
 from sqlalchemy import (
     event,
     schema,
+    select,
     sql,
 )
 from sqlalchemy import types as sqltypes
@@ -800,7 +801,7 @@ def _get_server_version_info(self, connection):
                 "select PARAM_VALUE from SYS.EXA_METADATA"
                 " where PARAM_NAME = 'databaseProductVersion'"
             )
-            result = connection.execute(query).fetchone()[0].split(".")
+            result = connection.execute(sql.text(query)).fetchone()[0].split(".")
             major, minor, patch = 0, 0, 0
             major = int(result[0])
             minor = int(result[1])
@@ -894,7 +895,7 @@ def _get_schema_for_input(self, connection, schema):
     @staticmethod
     def _get_current_schema(connection):
         sql_statement = "SELECT CURRENT_SCHEMA"
-        current_schema = connection.execute(sql_statement).fetchone()[0]
+        current_schema = connection.execute(sql.text(sql_statement)).fetchone()[0]
         return current_schema
 
     @reflection.cache
@@ -905,7 +906,7 @@ def get_table_names(self, connection, schema, **kw):
         )
         if schema is None:
             sql_statement += "CURRENT_SCHEMA ORDER BY table_name"
-            result = connection.execute(sql_statement)
+            result = connection.execute(sql.text(sql_statement))
         else:
             sql_statement += ":schema ORDER BY table_name"
             result = connection.execute(

sqlalchemy_exasol/pyodbc.py

@@ -250,7 +250,7 @@ def _get_columns(self, connection, table_name, schema=None, **kw):
         sql_statement = sql_statement.format(
             schema=quoted_schema_string, table=quoted_table_string
         )
-        response = connection.execute(sql_statement)
+        response = connection.execute(sql.text(sql_statement))
 
         return list(response)
 
@@ -295,7 +295,7 @@ def _get_foreign_keys(self, connection, table_name, schema=None, **kw):
                 quoted_schema_string, quoted_table_string, "FOREIGN KEY"
             )
         )
-        response = connection.execute(sql_statement)
+        response = connection.execute(sql.text(sql_statement))
 
         return list(response)