[GitHub] [airflow] JDarDagran commented on a diff in pull request #31398: openlineage, common.sql: provide OL SQL parser as internal OpenLineage provider API

["JDarDagran (via GitHub)" <gi...@apache.org>]

JDarDagran commented on code in PR #31398:
URL: https://github.com/apache/airflow/pull/31398#discussion_r1212964865


##########
airflow/providers/openlineage/sqlparser.py:
##########
@@ -0,0 +1,297 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Callable
+
+from attrs import define
+
+from airflow.providers.openlineage.extractors.base import OperatorLineage
+from airflow.providers.openlineage.utils.sql import (
+    TablesHierarchy,
+    create_information_schema_query,
+    get_table_schemas,
+)
+from airflow.typing_compat import TypedDict
+from openlineage.client.facet import ExtractionError, ExtractionErrorRunFacet, SqlJobFacet
+from openlineage.client.run import Dataset
+from openlineage.common.sql import DbTableMeta, SqlMeta, parse
+
+if TYPE_CHECKING:
+    from airflow.hooks.base import BaseHook
+
+DEFAULT_NAMESPACE = "default"
+DEFAULT_INFORMATION_SCHEMA_COLUMNS = [
+    "table_schema",
+    "table_name",
+    "column_name",
+    "ordinal_position",
+    "udt_name",
+]
+DEFAULT_INFORMATION_SCHEMA_TABLE_NAME = "information_schema.columns"
+
+
+def default_normalize_name_method(name: str) -> str:
+    return name.lower()
+
+
+class GetTableSchemasParams(TypedDict):
+    """get_table_schemas params"""
+
+    normalize_name: Callable[[str], str]
+    is_cross_db: bool
+    information_schema_columns: list[str]
+    information_schema_table: str
+    is_uppercase_names: bool
+    allow_trailing_semicolon: bool
+    column_quote_style: str
+    database: str | None
+
+
+@define
+class DatabaseInfo:
+    """
+    Contains database specific information needed to process
+    SQL statement parse result.
+
+    :param scheme: Scheme part of URI in OpenLineage namespace.
+    :param authority: Authority part of URI in OpenLineage namespace.
+    :param database: Takes precedence over parsed database name.
+    :param information_schema_columns: List of columns names from information schema table.
+    :param information_schema_table_name: Information schema table name.
+    :param is_information_schema_cross_db: Specifies if information schema contains
+        cross-database data.
+    :param is_uppercase_names: Specifies if database accepts only uppercase names (e.g. Snowflake).
+    :param allow_trailing_semicolon: For some databases such as Trino,
+        trailing semicolon can cause a syntax error. If True it adds semicolon at the end of query.
+    :param column_quote_style: Specifies how to quote column names.
+    :param normalize_name_method: Method to normalize database, schema and table names.
+        Defaults to `name.lower()`.
+    """
+
+    scheme: str
+    authority: str | None = None
+    database: str | None = None
+    information_schema_columns: list[str] = DEFAULT_INFORMATION_SCHEMA_COLUMNS
+    information_schema_table_name: str = DEFAULT_INFORMATION_SCHEMA_TABLE_NAME
+    is_information_schema_cross_db: bool = False
+    is_uppercase_names: bool = False
+    allow_trailing_semicolon: bool = True
+    column_quote_style: str = '"'
+    normalize_name_method: Callable[[str], str] = default_normalize_name_method
+
+
+class SQLParser:
+    """
+    An interface for `openlineage_sql` library.
+
+    :param dialect: dialect specific to the database
+    :param default_schema: schema applied to each table with no schema parsed
+    """
+
+    def __init__(self, dialect: str | None = None, default_schema: str | None = None) -> None:
+        self.dialect = dialect
+        self.default_schema = default_schema
+
+    def parse(self, sql: list[str] | str) -> SqlMeta | None:
+        """Parse a single or a list of SQL statements"""
+        parse_result: SqlMeta | None = parse(
+            sql=sql, dialect=self.dialect, default_schema=self.default_schema
+        )
+        return parse_result
+
+    def parse_table_schemas(
+        self,
+        hook: BaseHook,
+        inputs: list[DbTableMeta],
+        outputs: list[DbTableMeta],
+        database_info: DatabaseInfo,
+        namespace: str = DEFAULT_NAMESPACE,
+        database: str | None = None,
+    ) -> tuple[list[Dataset], ...]:
+        """Parse schemas for input and output tables."""
+        database_kwargs: GetTableSchemasParams = dict(
+            normalize_name=database_info.normalize_name_method,
+            is_cross_db=database_info.is_information_schema_cross_db,
+            information_schema_columns=database_info.information_schema_columns,
+            information_schema_table=database_info.information_schema_table_name,
+            is_uppercase_names=database_info.is_uppercase_names,
+            allow_trailing_semicolon=database_info.allow_trailing_semicolon,
+            column_quote_style=database_info.column_quote_style,
+            database=database or database_info.database,
+        )
+        return get_table_schemas(
+            hook,
+            namespace,
+            database or database_info.database,
+            SQLParser.create_information_schema_query(tables=inputs, **database_kwargs) if inputs else None,
+            SQLParser.create_information_schema_query(tables=outputs, **database_kwargs) if outputs else None,
+        )
+
+    def generate_openlineage_metadata_from_sql(
+        self,
+        sql: list[str] | str,
+        hook: BaseHook,
+        database_info: DatabaseInfo,
+        database: str | None = None,
+    ) -> OperatorLineage:
+        """
+        Parses SQL statement(s) and generate OpenLineage metadata:
+            * input tables with schemas parsed
+            * output tables with schemas parsed
+            * run facets
+            * job facets
+
+        :param sql: a SQL statement or list of SQL statement to be parsed
+        :param hook: Airflow Hook used to connect to the database
+        :param database_info: database specific information
+        :param database: when passed it takes precedence over parsed database name
+        """
+        job_facets = {"sql": SqlJobFacet(query=SQLParser.normalize_sql(sql))}
+
+        parse_result: SqlMeta | None = self.parse(SQLParser.split_sql_string(sql))
+        if not parse_result:
+            return OperatorLineage(job_facets=job_facets)
+
+        run_facets: dict = {}
+
+        if parse_result.errors:
+            run_facets["extractionError"] = ExtractionErrorRunFacet(
+                totalTasks=len(sql) if isinstance(sql, list) else 1,
+                failedTasks=len(parse_result.errors),
+                errors=[
+                    ExtractionError(
+                        errorMessage=error.message,
+                        stackTrace=None,
+                        task=error.origin_statement,
+                        taskNumber=error.index,
+                    )
+                    for error in parse_result.errors
+                ],
+            )
+
+        namespace = SQLParser.create_namespace(database_info=database_info)
+        inputs, outputs = self.parse_table_schemas(
+            hook=hook,
+            inputs=parse_result.in_tables,
+            outputs=parse_result.out_tables,
+            namespace=namespace,
+            database=database,
+            database_info=database_info,
+        )
+
+        return OperatorLineage(
+            inputs=inputs,
+            outputs=outputs,
+            run_facets=run_facets,
+            job_facets=job_facets,
+        )
+
+    @staticmethod
+    def create_namespace(database_info: DatabaseInfo) -> str:
+        return (
+            f"{database_info.scheme}://{database_info.authority}"
+            if database_info.authority
+            else database_info.scheme
+        )
+
+    @staticmethod
+    def normalize_sql(sql: list[str] | str) -> str:
+        """Makes sure to return a semicolon-separated SQL statements"""
+        return ";\n".join(stmt.rstrip(" ;\r\n") for stmt in SQLParser.split_sql_string(sql))
+
+    @staticmethod
+    def split_sql_string(sql: list[str] | str) -> list[str]:
+        """
+        Split SQL string into list of statements
+        Tries to use `DbApiHook.split_sql_string` if available.
+        Otherwise, uses the same logic.
+        """
+        split_statement: Callable[[str], list[str]]
+        try:
+            from airflow.providers.common.sql.hooks.sql import DbApiHook

Review Comment:
   It's hard to predict where else SQLParser could be used but I can imagine that could happen without use of `common.sql` provider. That's why I've created the logic to reflect the same behaviour even when no `common.sql` provider is available.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org