openmetadata-ingestion 1.5.13.1__py3-none-any.whl → 1.6.0.0__py3-none-any.whl

metadata/profiler/source/base/profiler_source.py

@@ -1,299 +0,0 @@
-#  Copyright 2021 Collate
-#  Licensed 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.
-
-"""
-Base source for the profiler used to instantiate a profiler runner with
-its interface
-"""
-from copy import deepcopy
-from typing import List, Optional, Tuple, cast
-
-from sqlalchemy import MetaData
-
-from metadata.generated.schema.configuration.profilerConfiguration import (
-    ProfilerConfiguration,
-)
-from metadata.generated.schema.entity.data.database import Database
-from metadata.generated.schema.entity.data.databaseSchema import DatabaseSchema
-from metadata.generated.schema.entity.data.table import ColumnProfilerConfig, Table
-from metadata.generated.schema.entity.services.connections.database.datalakeConnection import (
-    DatalakeConnection,
-)
-from metadata.generated.schema.entity.services.databaseService import (
-    DatabaseConnection,
-    DatabaseService,
-)
-from metadata.generated.schema.metadataIngestion.databaseServiceProfilerPipeline import (
-    DatabaseServiceProfilerPipeline,
-)
-from metadata.generated.schema.metadataIngestion.workflow import (
-    OpenMetadataWorkflowConfig,
-)
-from metadata.ingestion.ometa.ometa_api import OpenMetadata
-from metadata.profiler.api.models import ProfilerProcessorConfig, TableConfig
-from metadata.profiler.interface.profiler_interface import ProfilerInterface
-from metadata.profiler.metrics.registry import Metrics
-from metadata.profiler.processor.core import Profiler
-from metadata.profiler.processor.default import DefaultProfiler, get_default_metrics
-from metadata.profiler.source.profiler_source_interface import ProfilerSourceInterface
-
-NON_SQA_DATABASE_CONNECTIONS = (DatalakeConnection,)
-
-
-class ProfilerSource(ProfilerSourceInterface):
-    """
-    Base class for the profiler source
-    """
-
-    def __init__(
-        self,
-        config: OpenMetadataWorkflowConfig,
-        database: DatabaseService,
-        ometa_client: OpenMetadata,
-        global_profiler_configuration: ProfilerConfiguration,
-    ):
-        self.service_conn_config = self._copy_service_config(config, database)
-        self.source_config = config.source.sourceConfig.config
-        self.source_config = cast(
-            DatabaseServiceProfilerPipeline, self.source_config
-        )  # satisfy type checker
-        self.profiler_config = ProfilerProcessorConfig.model_validate(
-            config.processor.model_dump().get("config")
-        )
-        self.ometa_client = ometa_client
-        self.profiler_interface_type: str = self._get_profiler_interface_type(config)
-        self.sqa_metadata = self._set_sqa_metadata()
-        self._interface = None
-        self.global_profiler_configuration = global_profiler_configuration
-
-    @property
-    def interface(
-        self,
-    ) -> Optional[ProfilerInterface]:
-        """Get the interface"""
-        return self._interface
-
-    @interface.setter
-    def interface(self, interface):
-        """Set the interface"""
-        self._interface = interface
-
-    def _set_sqa_metadata(self):
-        """Set sqlalchemy metadata"""
-        if not isinstance(self.service_conn_config, NON_SQA_DATABASE_CONNECTIONS):
-            return MetaData()
-        return None
-
-    def _get_profiler_interface_type(self, config) -> str:
-        """_summary_
-
-        Args:
-            config (_type_): profiler config
-        Returns:
-            str:
-        """
-        if isinstance(self.service_conn_config, NON_SQA_DATABASE_CONNECTIONS):
-            return self.service_conn_config.__class__.__name__
-        return config.source.serviceConnection.root.config.__class__.__name__
-
-    @staticmethod
-    def get_config_for_table(entity: Table, profiler_config) -> Optional[TableConfig]:
-        """Get config for a specific entity
-
-        Args:
-            entity: table entity
-        """
-        for table_config in profiler_config.tableConfig or []:
-            if table_config.fullyQualifiedName.root == entity.fullyQualifiedName.root:
-                return table_config
-
-        for schema_config in profiler_config.schemaConfig or []:
-            if (
-                schema_config.fullyQualifiedName.root
-                == entity.databaseSchema.fullyQualifiedName
-            ):
-                return TableConfig.from_database_and_schema_config(
-                    schema_config, entity.fullyQualifiedName.root
-                )
-        for database_config in profiler_config.databaseConfig or []:
-            if (
-                database_config.fullyQualifiedName.root
-                == entity.database.fullyQualifiedName
-            ):
-                return TableConfig.from_database_and_schema_config(
-                    database_config, entity.fullyQualifiedName.root
-                )
-
-        return None
-
-    def _get_include_columns(
-        self, entity, entity_config: Optional[TableConfig]
-    ) -> Optional[List[ColumnProfilerConfig]]:
-        """get included columns"""
-        if entity_config and entity_config.columnConfig:
-            return entity_config.columnConfig.includeColumns
-
-        if entity.tableProfilerConfig:
-            return entity.tableProfilerConfig.includeColumns
-
-        return None
-
-    def _get_exclude_columns(
-        self, entity, entity_config: Optional[TableConfig]
-    ) -> Optional[List[str]]:
-        """get included columns"""
-        if entity_config and entity_config.columnConfig:
-            return entity_config.columnConfig.excludeColumns
-
-        if entity.tableProfilerConfig:
-            return entity.tableProfilerConfig.excludeColumns
-
-        return None
-
-    def _copy_service_config(
-        self, config: OpenMetadataWorkflowConfig, database: DatabaseService
-    ) -> DatabaseConnection:
-        """Make a copy of the service config and update the database name
-
-        Args:
-            database (_type_): a database entity
-
-        Returns:
-            DatabaseService.__config__
-        """
-        config_copy = deepcopy(
-            config.source.serviceConnection.root.config  # type: ignore
-        )
-        if hasattr(
-            config_copy,  # type: ignore
-            "supportsDatabase",
-        ):
-            if hasattr(config_copy, "database"):
-                config_copy.database = database.name.root  # type: ignore
-            if hasattr(config_copy, "catalog"):
-                config_copy.catalog = database.name.root  # type: ignore
-
-        # we know we'll only be working with DatabaseConnection, we cast the type to satisfy type checker
-        config_copy = cast(DatabaseConnection, config_copy)
-
-        return config_copy
-
-    def create_profiler_interface(
-        self,
-        entity: Table,
-        config: Optional[TableConfig],
-        profiler_config: Optional[ProfilerProcessorConfig],
-        schema_entity: Optional[DatabaseSchema],
-        database_entity: Optional[Database],
-        db_service: Optional[DatabaseService],
-    ) -> ProfilerInterface:
-        """Create sqlalchemy profiler interface"""
-        from metadata.profiler.interface.profiler_interface_factory import (  # pylint: disable=import-outside-toplevel
-            profiler_interface_factory,
-        )
-
-        profiler_interface: ProfilerInterface = profiler_interface_factory.create(
-            self.profiler_interface_type,
-            entity,
-            schema_entity,
-            database_entity,
-            db_service,
-            config,
-            profiler_config,
-            self.source_config,
-            self.service_conn_config,
-            self.ometa_client,
-            sqa_metadata=self.sqa_metadata,
-        )  # type: ignore
-
-        self.interface = profiler_interface
-        return self.interface
-
-    def _get_context_entities(
-        self, entity: Table
-    ) -> Tuple[DatabaseSchema, Database, DatabaseService]:
-        schema_entity = None
-        database_entity = None
-        db_service = None
-
-        if entity.databaseSchema:
-            schema_entity_list = self.ometa_client.es_search_from_fqn(
-                entity_type=DatabaseSchema,
-                fqn_search_string=entity.databaseSchema.fullyQualifiedName,
-                fields="databaseSchemaProfilerConfig",
-            )
-            if schema_entity_list:
-                schema_entity = schema_entity_list[0]
-
-        if entity.database:
-            database_entity_list = self.ometa_client.es_search_from_fqn(
-                entity_type=Database,
-                fqn_search_string=entity.database.fullyQualifiedName,
-                fields="databaseProfilerConfig",
-            )
-            if database_entity_list:
-                database_entity = database_entity_list[0]
-
-        if entity.service:
-            db_service_list = self.ometa_client.es_search_from_fqn(
-                entity_type=DatabaseService,
-                fqn_search_string=entity.service.fullyQualifiedName,
-            )
-            if db_service_list:
-                db_service = db_service_list[0]
-
-        return schema_entity, database_entity, db_service
-
-    def get_profiler_runner(
-        self, entity: Table, profiler_config: ProfilerProcessorConfig
-    ) -> Profiler:
-        """
-        Returns the runner for the profiler
-        """
-        table_config = self.get_config_for_table(entity, profiler_config)
-        schema_entity, database_entity, db_service = self._get_context_entities(
-            entity=entity
-        )
-        profiler_interface = self.create_profiler_interface(
-            entity,
-            table_config,
-            profiler_config,
-            schema_entity,
-            database_entity,
-            db_service,
-        )
-
-        if not profiler_config.profiler:
-            return DefaultProfiler(
-                profiler_interface=profiler_interface,
-                include_columns=self._get_include_columns(entity, table_config),
-                exclude_columns=self._get_exclude_columns(entity, table_config),
-                global_profiler_configuration=self.global_profiler_configuration,
-                db_service=db_service,
-            )
-
-        metrics = (
-            [Metrics.get(name) for name in profiler_config.profiler.metrics]
-            if profiler_config.profiler.metrics
-            else get_default_metrics(
-                table=profiler_interface.table,
-                ometa_client=self.ometa_client,
-                db_service=db_service,
-            )
-        )
-
-        return Profiler(
-            *metrics,  # type: ignore
-            profiler_interface=profiler_interface,
-            include_columns=self._get_include_columns(entity, table_config),
-            exclude_columns=self._get_exclude_columns(entity, table_config),
-            global_profiler_configuration=self.global_profiler_configuration,
-        )

metadata/profiler/source/profiler_source_factory.py

@@ -1,54 +0,0 @@
-#  Copyright 2021 Collate
-#  Licensed 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.
-
-"""
-Factory class for creating profiler source objects
-"""
-
-from metadata.generated.schema.entity.services.connections.database.bigQueryConnection import (
-    BigqueryType,
-)
-from metadata.generated.schema.entity.services.connections.database.databricksConnection import (
-    DatabricksType,
-)
-from metadata.profiler.source.base.profiler_source import ProfilerSource
-from metadata.profiler.source.bigquery.profiler_source import BigQueryProfilerSource
-from metadata.profiler.source.databricks.profiler_source import DataBricksProfilerSource
-
-
-class ProfilerSourceFactory:
-    """Creational factory for profiler source objects"""
-
-    def __init__(self):
-        self._source_type = {"base": ProfilerSource}
-
-    def register_source(self, source_type: str, source_class):
-        """Register a new source type"""
-        self._source_type[source_type] = source_class
-
-    def create(self, source_type: str, *args, **kwargs) -> ProfilerSource:
-        """Create source object based on source type"""
-        source_class = self._source_type.get(source_type)
-        if not source_class:
-            source_class = self._source_type["base"]
-            return source_class(*args, **kwargs)
-        return source_class(*args, **kwargs)
-
-
-profiler_source_factory = ProfilerSourceFactory()
-profiler_source_factory.register_source(
-    BigqueryType.BigQuery.value.lower(),
-    BigQueryProfilerSource,
-)
-profiler_source_factory.register_source(
-    DatabricksType.Databricks.value.lower(),
-    DataBricksProfilerSource,
-)

openmetadata_ingestion-1.5.13.1.dist-info/LICENSE

@@ -1,201 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed 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.