apache-airflow-providers-common-sql 1.11.1rc1__py3-none-any.whl → 1.12.0rc1__py3-none-any.whl

airflow/providers/common/sql/__init__.py

@@ -27,7 +27,7 @@ import packaging.version
 
 __all__ = ["__version__"]
 
-__version__ = "1.11.1"
+__version__ = "1.12.0"
 
 try:
     from airflow import __version__ as airflow_version

airflow/providers/common/sql/get_provider_info.py

@@ -28,8 +28,9 @@ def get_provider_info():
         "name": "Common SQL",
         "description": "`Common SQL Provider <https://en.wikipedia.org/wiki/SQL>`__\n",
         "state": "ready",
-        "source-date-epoch": 1709555283,
+        "source-date-epoch": 1712665507,
         "versions": [
+            "1.12.0",
             "1.11.1",
             "1.11.0",
             "1.10.1",

airflow/providers/common/sql/hooks/sql.py

@@ -17,6 +17,7 @@
 from __future__ import annotations
 
 import contextlib
+import warnings
 from contextlib import closing
 from datetime import datetime
 from typing import (
@@ -36,11 +37,14 @@ from typing import (
 from urllib.parse import urlparse
 
 import sqlparse
-from deprecated import deprecated
 from more_itertools import chunked
 from sqlalchemy import create_engine
 
-from airflow.exceptions import AirflowException, AirflowProviderDeprecationWarning
+from airflow.exceptions import (
+    AirflowException,
+    AirflowOptionalProviderFeatureException,
+    AirflowProviderDeprecationWarning,
+)
 from airflow.hooks.base import BaseHook
 
 if TYPE_CHECKING:
@@ -50,6 +54,7 @@ if TYPE_CHECKING:
     from airflow.providers.openlineage.sqlparser import DatabaseInfo
 
 T = TypeVar("T")
+SQL_PLACEHOLDERS = frozenset({"%s", "?"})
 
 
 def return_single_query_results(sql: str | Iterable[str], return_last: bool, split_statements: bool):
@@ -146,6 +151,8 @@ class DbApiHook(BaseHook):
     connector: ConnectorProtocol | None = None
     # Override with db-specific query to check connection
     _test_connection_sql = "select 1"
+    # Default SQL placeholder
+    _placeholder: str = "%s"
 
     def __init__(self, *args, schema: str | None = None, log_sql: bool = True, **kwargs):
         super().__init__()
@@ -164,7 +171,6 @@ class DbApiHook(BaseHook):
         self.__schema = schema
         self.log_sql = log_sql
         self.descriptions: list[Sequence[Sequence] | None] = []
-        self._placeholder: str = "%s"
         self._insert_statement_format: str = kwargs.get(
             "insert_statement_format", "INSERT INTO {} {} VALUES ({})"
         )
@@ -173,7 +179,17 @@ class DbApiHook(BaseHook):
         )
 
     @property
-    def placeholder(self) -> str:
+    def placeholder(self):
+        conn = self.get_connection(getattr(self, self.conn_name_attr))
+        placeholder = conn.extra_dejson.get("placeholder")
+        if placeholder in SQL_PLACEHOLDERS:
+            return placeholder
+        self.log.warning(
+            "Placeholder defined in Connection '%s' is not listed in 'DEFAULT_SQL_PLACEHOLDERS' "
+            "and got ignored. Falling back to the default placeholder '%s'.",
+            placeholder,
+            self._placeholder,
+        )
         return self._placeholder
 
     def get_conn(self):
@@ -218,7 +234,7 @@ class DbApiHook(BaseHook):
         try:
             from pandas.io import sql as psql
         except ImportError:
-            raise Exception(
+            raise AirflowOptionalProviderFeatureException(
                 "pandas library not installed, run: pip install "
                 "'apache-airflow-providers-common-sql[pandas]'."
             )
@@ -245,7 +261,7 @@ class DbApiHook(BaseHook):
         try:
             from pandas.io import sql as psql
         except ImportError:
-            raise Exception(
+            raise AirflowOptionalProviderFeatureException(
                 "pandas library not installed, run: pip install "
                 "'apache-airflow-providers-common-sql[pandas]'."
             )
@@ -305,8 +321,7 @@ class DbApiHook(BaseHook):
         handler: None = ...,
         split_statements: bool = ...,
         return_last: bool = ...,
-    ) -> None:
-        ...
+    ) -> None: ...
 
     @overload
     def run(
@@ -317,8 +332,7 @@ class DbApiHook(BaseHook):
         handler: Callable[[Any], T] = ...,
         split_statements: bool = ...,
         return_last: bool = ...,
-    ) -> tuple | list[tuple] | list[list[tuple] | tuple] | None:
-        ...
+    ) -> tuple | list[tuple] | list[list[tuple] | tuple] | None: ...
 
     def run(
         self,
@@ -424,14 +438,6 @@ class DbApiHook(BaseHook):
         else:
             return results
 
-    @deprecated(
-        reason=(
-            "The `_make_serializable` method is deprecated and support will be removed in a future "
-            "version of the common.sql provider. Please update the DbApiHook's provider "
-            "to a version based on common.sql >= 1.9.1."
-        ),
-        category=AirflowProviderDeprecationWarning,
-    )
     def _make_common_data_structure(self, result: T | Sequence[T]) -> tuple | list[tuple]:
         """Ensure the data returned from an SQL command is a standard tuple or list[tuple].
 
@@ -446,6 +452,13 @@ class DbApiHook(BaseHook):
         # Back-compatibility call for providers implementing old ´_make_serializable' method.
         with contextlib.suppress(AttributeError):
             result = self._make_serializable(result=result)  # type: ignore[attr-defined]
+            warnings.warn(
+                "The `_make_serializable` method is deprecated and support will be removed in a future "
+                f"version of the common.sql provider. Please update the {self.__class__.__name__}'s provider "
+                "to a version based on common.sql >= 1.9.1.",
+                AirflowProviderDeprecationWarning,
+                stacklevel=2,
+            )
 
         if isinstance(result, Sequence):
             return cast(List[tuple], result)

airflow/providers/common/sql/operators/sql.py

@@ -220,7 +220,7 @@ class SQLExecuteQueryOperator(BaseSQLOperator):
         :ref:`howto/operator:SQLExecuteQueryOperator`
     """
 
-    template_fields: Sequence[str] = ("conn_id", "sql", "parameters")
+    template_fields: Sequence[str] = ("conn_id", "sql", "parameters", "hook_params")
     template_ext: Sequence[str] = (".sql", ".json")
     template_fields_renderers = {"sql": "sql", "parameters": "json"}
     ui_color = "#cdaaed"
@@ -416,7 +416,7 @@ class SQLColumnCheckOperator(BaseSQLOperator):
         :ref:`howto/operator:SQLColumnCheckOperator`
     """
 
-    template_fields: Sequence[str] = ("partition_clause", "table", "sql")
+    template_fields: Sequence[str] = ("partition_clause", "table", "sql", "hook_params")
     template_fields_renderers = {"sql": "sql"}
 
     sql_check_template = """
@@ -644,7 +644,7 @@ class SQLTableCheckOperator(BaseSQLOperator):
         :ref:`howto/operator:SQLTableCheckOperator`
     """
 
-    template_fields: Sequence[str] = ("partition_clause", "table", "sql", "conn_id")
+    template_fields: Sequence[str] = ("partition_clause", "table", "sql", "conn_id", "hook_params")
 
     template_fields_renderers = {"sql": "sql"}
 
@@ -760,7 +760,7 @@ class SQLCheckOperator(BaseSQLOperator):
     :param parameters: (optional) the parameters to render the SQL query with.
     """
 
-    template_fields: Sequence[str] = ("sql",)
+    template_fields: Sequence[str] = ("sql", "hook_params")
     template_ext: Sequence[str] = (
         ".hql",
         ".sql",
@@ -809,6 +809,7 @@ class SQLValueCheckOperator(BaseSQLOperator):
     template_fields: Sequence[str] = (
         "sql",
         "pass_value",
+        "hook_params",
     )
     template_ext: Sequence[str] = (
         ".hql",
@@ -906,7 +907,7 @@ class SQLIntervalCheckOperator(BaseSQLOperator):
     """
 
     __mapper_args__ = {"polymorphic_identity": "SQLIntervalCheckOperator"}
-    template_fields: Sequence[str] = ("sql1", "sql2")
+    template_fields: Sequence[str] = ("sql1", "sql2", "hook_params")
     template_ext: Sequence[str] = (
         ".hql",
         ".sql",
@@ -1034,7 +1035,7 @@ class SQLThresholdCheckOperator(BaseSQLOperator):
     :param max_threshold: numerical value or max threshold sql to be executed (templated)
     """
 
-    template_fields: Sequence[str] = ("sql", "min_threshold", "max_threshold")
+    template_fields: Sequence[str] = ("sql", "min_threshold", "max_threshold", "hook_params")
     template_ext: Sequence[str] = (
         ".hql",
         ".sql",

airflow/providers/common/sql/sensors/sql.py

@@ -51,7 +51,7 @@ class SqlSensor(BaseSensorOperator):
             Should match the desired hook constructor params.
     """
 
-    template_fields: Sequence[str] = ("sql",)
+    template_fields: Sequence[str] = ("sql", "hook_params")
     template_ext: Sequence[str] = (
         ".hql",
         ".sql",

{apache_airflow_providers_common_sql-1.11.1rc1.dist-info → apache_airflow_providers_common_sql-1.12.0rc1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: apache-airflow-providers-common-sql
-Version: 1.11.1rc1
+Version: 1.12.0rc1
 Summary: Provider package apache-airflow-providers-common-sql for Apache Airflow
 Keywords: airflow-provider,common.sql,airflow,integration
 Author-email: Apache Software Foundation <dev@airflow.apache.org>
@@ -19,15 +19,16 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: System :: Monitoring
-Requires-Dist: apache-airflow>=2.6.0.dev0
+Requires-Dist: apache-airflow>=2.6.0rc0
 Requires-Dist: more-itertools>=9.0.0
 Requires-Dist: sqlparse>=0.4.2
 Requires-Dist: apache-airflow-providers-openlineage ; extra == "openlineage"
 Requires-Dist: pandas>=1.2.5,<2.2 ; extra == "pandas"
 Project-URL: Bug Tracker, https://github.com/apache/airflow/issues
-Project-URL: Changelog, https://airflow.apache.org/docs/apache-airflow-providers-common-sql/1.11.1/changelog.html
-Project-URL: Documentation, https://airflow.apache.org/docs/apache-airflow-providers-common-sql/1.11.1
+Project-URL: Changelog, https://airflow.apache.org/docs/apache-airflow-providers-common-sql/1.12.0/changelog.html
+Project-URL: Documentation, https://airflow.apache.org/docs/apache-airflow-providers-common-sql/1.12.0
 Project-URL: Slack Chat, https://s.apache.org/airflow-slack
 Project-URL: Source Code, https://github.com/apache/airflow
 Project-URL: Twitter, https://twitter.com/ApacheAirflow
@@ -79,7 +80,7 @@ Provides-Extra: pandas
 
 Package ``apache-airflow-providers-common-sql``
 
-Release: ``1.11.1.rc1``
+Release: ``1.12.0.rc1``
 
 
 `Common SQL Provider <https://en.wikipedia.org/wiki/SQL>`__
@@ -92,7 +93,7 @@ This is a provider package for ``common.sql`` provider. All classes for this pro
 are in ``airflow.providers.common.sql`` python package.
 
 You can find package information and changelog for the provider
-in the `documentation <https://airflow.apache.org/docs/apache-airflow-providers-common-sql/1.11.1/>`_.
+in the `documentation <https://airflow.apache.org/docs/apache-airflow-providers-common-sql/1.12.0/>`_.
 
 Installation
 ------------
@@ -101,7 +102,7 @@ You can install this package on top of an existing Airflow 2 installation (see `
 for the minimum Airflow version supported) via
 ``pip install apache-airflow-providers-common-sql``
 
-The package supports the following python versions: 3.8,3.9,3.10,3.11
+The package supports the following python versions: 3.8,3.9,3.10,3.11,3.12
 
 Requirements
 ------------
@@ -134,4 +135,4 @@ Dependent package
 ==============================================================================================================  ===============
 
 The changelog for the provider package can be found in the
-`changelog <https://airflow.apache.org/docs/apache-airflow-providers-common-sql/1.11.1/changelog.html>`_.
+`changelog <https://airflow.apache.org/docs/apache-airflow-providers-common-sql/1.12.0/changelog.html>`_.

{apache_airflow_providers_common_sql-1.11.1rc1.dist-info → apache_airflow_providers_common_sql-1.12.0rc1.dist-info}/RECORD

@@ -1,19 +1,19 @@
 airflow/providers/common/sql/LICENSE,sha256=ywUBpKZc7Jb96rVt5I3IDbg7dIJAbUSHkuoDcF3jbH4,13569
 airflow/providers/common/sql/README_API.md,sha256=CxhaS8EedZ4dcbLUPC4-GLCMaY3OH96oHxXttUGU06E,5932
-airflow/providers/common/sql/__init__.py,sha256=Z4nKM_CF0yg_BbPWiLMdZrWVId2qx9WybdNVkaJC0ZU,1586
-airflow/providers/common/sql/get_provider_info.py,sha256=8Bf1S0qIaFqjqRxw5Fsfd1d0rq6YY93wiy1OgEexkBA,2952
+airflow/providers/common/sql/__init__.py,sha256=klMx41vmt09tJSbH0p_K4neG58LhZ-sXr4Y6t9tpYEs,1586
+airflow/providers/common/sql/get_provider_info.py,sha256=H9lLcgafXyHuzteDB8Jl_yjKx2D1GRt2Fyh1ws1jcg0,2974
 airflow/providers/common/sql/doc/adr/0001-record-architecture-decisions.md,sha256=TfANqrzoFto9PMOMza3MitIkXHGLx2kY_BhhF-N0_ow,1675
 airflow/providers/common/sql/doc/adr/0002-return-common-data-structure-from-dbapihook-derived-hooks.md,sha256=ze5w9IVS-HkUwdZvPW8_JaJaVwel7-N6XdEVN4pTuCE,8457
 airflow/providers/common/sql/hooks/__init__.py,sha256=9hdXHABrVpkbpjZgUft39kOFL2xSGeG4GEua0Hmelus,785
-airflow/providers/common/sql/hooks/sql.py,sha256=LtEVnpkHcVsYC8TmZKUsOG6CQjpwj3S50vX2UTSM_Xg,27763
+airflow/providers/common/sql/hooks/sql.py,sha256=aCDIgO1wmWWJjluSBiHc5rBaBBqQHHRlSozPgctEOdY,28425
 airflow/providers/common/sql/hooks/sql.pyi,sha256=dqxjIq0JLrsPiC65wvOntDpXpEzWdEuv80abfqq2yFU,4138
 airflow/providers/common/sql/operators/__init__.py,sha256=9hdXHABrVpkbpjZgUft39kOFL2xSGeG4GEua0Hmelus,785
-airflow/providers/common/sql/operators/sql.py,sha256=VRSiXFqWBIHc0fF9ez_HRhThtkX4kDaLTLkA_KCecUM,47731
+airflow/providers/common/sql/operators/sql.py,sha256=C7w4xxXQdrkJCuqQqgUxYqL_pxkXhI65YAKtYMrO5WA,47843
 airflow/providers/common/sql/operators/sql.pyi,sha256=-Wa-4uMtRPvUowYgSDnfH98Joe3Uakzvof4F4G4mgMM,7769
 airflow/providers/common/sql/sensors/__init__.py,sha256=9hdXHABrVpkbpjZgUft39kOFL2xSGeG4GEua0Hmelus,785
-airflow/providers/common/sql/sensors/sql.py,sha256=bqyaw3pQpvCRJ5h2R2eZiJJuGtW-6g4RcI-5WaREPRk,5669
+airflow/providers/common/sql/sensors/sql.py,sha256=t4RiXUZGrr_FgcRo5QV-rIwNgo7qNuyafqP-GzWJuFY,5683
 airflow/providers/common/sql/sensors/sql.pyi,sha256=ZwVia3SUHrW7eB98r3vHYT_jhgkSWHRZqA2srYDHVbc,2295
-apache_airflow_providers_common_sql-1.11.1rc1.dist-info/entry_points.txt,sha256=h8UXRp2crPuGmYVYRM5oe168qIh7g-4t2QQbVMizKjI,106
-apache_airflow_providers_common_sql-1.11.1rc1.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-apache_airflow_providers_common_sql-1.11.1rc1.dist-info/METADATA,sha256=Z3ARm8D8nD-pEb_Zz8Br8z-bLaGQ89wGBloD28Iye6I,6064
-apache_airflow_providers_common_sql-1.11.1rc1.dist-info/RECORD,,
+apache_airflow_providers_common_sql-1.12.0rc1.dist-info/entry_points.txt,sha256=h8UXRp2crPuGmYVYRM5oe168qIh7g-4t2QQbVMizKjI,106
+apache_airflow_providers_common_sql-1.12.0rc1.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
+apache_airflow_providers_common_sql-1.12.0rc1.dist-info/METADATA,sha256=dWCb63rDgZyHzMdykloxRc6SLZuRbBINj1-u-2flqnk,6118
+apache_airflow_providers_common_sql-1.12.0rc1.dist-info/RECORD,,