feat: implements a SQLTranslatorMixin mixin for SQL conversion. (#27)

Implements a `SQLTranslatorMixin` mixin that has a `convert_to_dialect` method for tranlating SQL between dialects.

Author: cofin

README.md

@@ -70,7 +70,11 @@ etl_config = sql.add_config(
     )
 )
 with sql.provide_session(etl_config) as session:
-    result = session.select_one("SELECT open_prompt(?)", "Can you write a haiku about DuckDB?", schema_type=ChatMessage)
+    result = session.select_one(
+        "SELECT open_prompt(?)",
+        "Can you write a haiku about DuckDB?",
+        schema_type=ChatMessage
+    )
     print(result) # result is a ChatMessage pydantic model
 ```
 

docs/PYPI_README.md

@@ -70,7 +70,11 @@ etl_config = sql.add_config(
     )
 )
 with sql.provide_session(etl_config) as session:
-    result = session.select_one("SELECT open_prompt(?)", "Can you write a haiku about DuckDB?", schema_type=ChatMessage)
+    result = session.select_one(
+        "SELECT open_prompt(?)",
+        "Can you write a haiku about DuckDB?",
+        schema_type=ChatMessage
+    )
     print(result) # result is a ChatMessage pydantic model
 ```
 

sqlspec/__init__.py

@@ -1,4 +1,4 @@
-from sqlspec import adapters, base, exceptions, extensions, filters, typing, utils
+from sqlspec import adapters, base, exceptions, extensions, filters, mixins, typing, utils
 from sqlspec.__metadata__ import __version__
 from sqlspec.base import SQLSpec
 
@@ -10,6 +10,7 @@
     "exceptions",
     "extensions",
     "filters",
+    "mixins",
     "typing",
     "utils",
 )

sqlspec/adapters/adbc/driver.py

@@ -7,13 +7,14 @@
 
 from adbc_driver_manager.dbapi import Connection, Cursor
 
-from sqlspec.base import SyncArrowBulkOperationsMixin, SyncDriverAdapterProtocol, T
+from sqlspec.base import SyncDriverAdapterProtocol
 from sqlspec.exceptions import ParameterStyleMismatchError, SQLParsingError
+from sqlspec.mixins import SQLTranslatorMixin, SyncArrowBulkOperationsMixin
 from sqlspec.statement import SQLStatement
 from sqlspec.typing import ArrowTable, StatementParameterType
 
 if TYPE_CHECKING:
-    from sqlspec.typing import ArrowTable, ModelDTOT, StatementParameterType
+    from sqlspec.typing import ArrowTable, ModelDTOT, StatementParameterType, T
 
 __all__ = ("AdbcDriver",)
 
@@ -33,7 +34,11 @@
 )
 
 
-class AdbcDriver(SyncArrowBulkOperationsMixin["Connection"], SyncDriverAdapterProtocol["Connection"]):
+class AdbcDriver(
+    SyncArrowBulkOperationsMixin["Connection"],
+    SQLTranslatorMixin["Connection"],
+    SyncDriverAdapterProtocol["Connection"],
+):
     """ADBC Sync Driver Adapter."""
 
     connection: Connection

sqlspec/adapters/aiosqlite/driver.py

@@ -1,19 +1,23 @@
 from contextlib import asynccontextmanager
 from typing import TYPE_CHECKING, Any, Optional, Union, cast, overload
 
-from sqlspec.base import AsyncDriverAdapterProtocol, T
+from sqlspec.base import AsyncDriverAdapterProtocol
+from sqlspec.mixins import SQLTranslatorMixin
 
 if TYPE_CHECKING:
     from collections.abc import AsyncGenerator, Sequence
 
     from aiosqlite import Connection, Cursor
 
-    from sqlspec.typing import ModelDTOT, StatementParameterType
+    from sqlspec.typing import ModelDTOT, StatementParameterType, T
 
 __all__ = ("AiosqliteDriver",)
 
 
-class AiosqliteDriver(AsyncDriverAdapterProtocol["Connection"]):
+class AiosqliteDriver(
+    SQLTranslatorMixin["Connection"],
+    AsyncDriverAdapterProtocol["Connection"],
+):
     """SQLite Async Driver Adapter."""
 
     connection: "Connection"

sqlspec/adapters/asyncmy/driver.py

@@ -3,18 +3,22 @@
 from contextlib import asynccontextmanager
 from typing import TYPE_CHECKING, Any, Optional, Union, cast, overload
 
-from sqlspec.base import AsyncDriverAdapterProtocol, T
+from sqlspec.base import AsyncDriverAdapterProtocol
+from sqlspec.mixins import SQLTranslatorMixin
 
 if TYPE_CHECKING:
     from asyncmy import Connection
     from asyncmy.cursors import Cursor
 
-    from sqlspec.typing import ModelDTOT, StatementParameterType
+    from sqlspec.typing import ModelDTOT, StatementParameterType, T
 
 __all__ = ("AsyncmyDriver",)
 
 
-class AsyncmyDriver(AsyncDriverAdapterProtocol["Connection"]):
+class AsyncmyDriver(
+    SQLTranslatorMixin["Connection"],
+    AsyncDriverAdapterProtocol["Connection"],
+):
     """Asyncmy MySQL/MariaDB Driver Adapter."""
 
     connection: "Connection"

sqlspec/adapters/asyncpg/driver.py

@@ -5,8 +5,9 @@
 from asyncpg import Connection
 from typing_extensions import TypeAlias
 
-from sqlspec.base import AsyncDriverAdapterProtocol, T
+from sqlspec.base import AsyncDriverAdapterProtocol
 from sqlspec.exceptions import SQLParsingError
+from sqlspec.mixins import SQLTranslatorMixin
 from sqlspec.statement import PARAM_REGEX, SQLStatement
 
 if TYPE_CHECKING:
@@ -15,7 +16,7 @@
     from asyncpg.connection import Connection
     from asyncpg.pool import PoolConnectionProxy
 
-    from sqlspec.typing import ModelDTOT, StatementParameterType
+    from sqlspec.typing import ModelDTOT, StatementParameterType, T
 
 __all__ = ("AsyncpgConnection", "AsyncpgDriver")
 
@@ -35,7 +36,10 @@
 AsyncpgConnection: TypeAlias = "Union[Connection[Any], PoolConnectionProxy[Any]]"  # pyright: ignore[reportMissingTypeArgument]
 
 
-class AsyncpgDriver(AsyncDriverAdapterProtocol["AsyncpgConnection"]):
+class AsyncpgDriver(
+    SQLTranslatorMixin["AsyncpgConnection"],
+    AsyncDriverAdapterProtocol["AsyncpgConnection"],
+):
     """AsyncPG Postgres Driver Adapter."""
 
     connection: "AsyncpgConnection"

sqlspec/adapters/duckdb/driver.py

@@ -1,19 +1,25 @@
 from contextlib import contextmanager
 from typing import TYPE_CHECKING, Any, Optional, Union, cast, overload
 
-from sqlspec.base import SyncArrowBulkOperationsMixin, SyncDriverAdapterProtocol, T
+from sqlspec.base import SyncDriverAdapterProtocol
+from sqlspec.mixins import SQLTranslatorMixin, SyncArrowBulkOperationsMixin
+from sqlspec.typing import ArrowTable, StatementParameterType
 
 if TYPE_CHECKING:
     from collections.abc import Generator, Sequence
 
     from duckdb import DuckDBPyConnection
 
-    from sqlspec.typing import ArrowTable, ModelDTOT, StatementParameterType
+    from sqlspec.typing import ArrowTable, ModelDTOT, StatementParameterType, T
 
 __all__ = ("DuckDBDriver",)
 
 
-class DuckDBDriver(SyncArrowBulkOperationsMixin["DuckDBPyConnection"], SyncDriverAdapterProtocol["DuckDBPyConnection"]):
+class DuckDBDriver(
+    SyncArrowBulkOperationsMixin["DuckDBPyConnection"],
+    SQLTranslatorMixin["DuckDBPyConnection"],
+    SyncDriverAdapterProtocol["DuckDBPyConnection"],
+):
     """DuckDB Sync Driver Adapter."""
 
     connection: "DuckDBPyConnection"

sqlspec/adapters/oracledb/driver.py

@@ -1,14 +1,9 @@
 from contextlib import asynccontextmanager, contextmanager
 from typing import TYPE_CHECKING, Any, Optional, Union, cast, overload
 
-from sqlspec.base import (
-    AsyncArrowBulkOperationsMixin,
-    AsyncDriverAdapterProtocol,
-    SyncArrowBulkOperationsMixin,
-    SyncDriverAdapterProtocol,
-    T,
-)
-from sqlspec.typing import ArrowTable, StatementParameterType
+from sqlspec.base import AsyncDriverAdapterProtocol, SyncDriverAdapterProtocol
+from sqlspec.mixins import AsyncArrowBulkOperationsMixin, SQLTranslatorMixin, SyncArrowBulkOperationsMixin
+from sqlspec.typing import ArrowTable, StatementParameterType, T
 
 if TYPE_CHECKING:
     from collections.abc import AsyncGenerator, Generator, Sequence
@@ -21,7 +16,11 @@
 __all__ = ("OracleAsyncDriver", "OracleSyncDriver")
 
 
-class OracleSyncDriver(SyncArrowBulkOperationsMixin["Connection"], SyncDriverAdapterProtocol["Connection"]):
+class OracleSyncDriver(
+    SyncArrowBulkOperationsMixin["Connection"],
+    SQLTranslatorMixin["Connection"],
+    SyncDriverAdapterProtocol["Connection"],
+):
     """Oracle Sync Driver Adapter."""
 
     connection: "Connection"
@@ -433,7 +432,9 @@ def select_arrow(  # pyright: ignore[reportUnknownParameterType]
 
 
 class OracleAsyncDriver(
-    AsyncArrowBulkOperationsMixin["AsyncConnection"], AsyncDriverAdapterProtocol["AsyncConnection"]
+    AsyncArrowBulkOperationsMixin["AsyncConnection"],
+    SQLTranslatorMixin["AsyncConnection"],
+    AsyncDriverAdapterProtocol["AsyncConnection"],
 ):
     """Oracle Async Driver Adapter."""
 

sqlspec/adapters/psqlpy/driver.py

@@ -7,16 +7,17 @@
 
 from psqlpy.exceptions import RustPSQLDriverPyBaseError
 
-from sqlspec.base import AsyncDriverAdapterProtocol, T
+from sqlspec.base import AsyncDriverAdapterProtocol
 from sqlspec.exceptions import SQLParsingError
+from sqlspec.mixins import SQLTranslatorMixin
 from sqlspec.statement import PARAM_REGEX, SQLStatement
 
 if TYPE_CHECKING:
     from collections.abc import Sequence
 
     from psqlpy import Connection, QueryResult
 
-    from sqlspec.typing import ModelDTOT, StatementParameterType
+    from sqlspec.typing import ModelDTOT, StatementParameterType, T
 
 __all__ = ("PsqlpyDriver",)
 
@@ -33,7 +34,10 @@
 logger = logging.getLogger("sqlspec")
 
 
-class PsqlpyDriver(AsyncDriverAdapterProtocol["Connection"]):
+class PsqlpyDriver(
+    SQLTranslatorMixin["Connection"],
+    AsyncDriverAdapterProtocol["Connection"],
+):
     """Psqlpy Postgres Driver Adapter."""
 
     connection: "Connection"