dagster-sling 0.28.8__py3-none-any.whl

dagster_sling/sling_event_iterator.py

@@ -0,0 +1,236 @@
+import re
+from collections.abc import Iterator, Sequence
+from typing import TYPE_CHECKING, Any, Optional, Union, cast
+
+from dagster import (
+    AssetMaterialization,
+    MaterializeResult,
+    _check as check,
+)
+from dagster._annotations import public
+from dagster._core.definitions.metadata.metadata_set import TableMetadataSet
+from dagster._core.definitions.metadata.table import (
+    TableColumn,
+    TableColumnDep,
+    TableColumnLineage,
+    TableSchema,
+)
+from dagster._core.execution.context.asset_execution_context import AssetExecutionContext
+from dagster._core.execution.context.op_execution_context import OpExecutionContext
+from typing_extensions import TypeVar
+
+if TYPE_CHECKING:
+    from dagster_sling.resources import SlingResource
+
+
+SlingEventType = Union[AssetMaterialization, MaterializeResult]
+
+# We define SlingEventIterator as a generic type for the sake of type hinting.
+# This is so that users who inspect the type of the return value of `SlingResource.replicate()`
+# will be able to see the inner type of the iterator, rather than just `SlingEventIterator`.
+T = TypeVar("T", bound=SlingEventType)
+
+
+def _get_logs_for_stream(
+    stream_name: str,
+    sling_cli: "SlingResource",
+) -> Sequence[str]:
+    """Parses out the logs for a specific stream from the raw logs returned by the Sling CLI."""
+    corresponding_logs = []
+    recording_logs = False
+    for log in sling_cli.stream_raw_logs():
+        if stream_name in log:
+            corresponding_logs.append(log)
+            recording_logs = True
+        elif recording_logs:
+            if len(log.strip()) == 0:
+                break
+            corresponding_logs.append(log)
+    return corresponding_logs
+
+
+def _strip_quotes_target_table_name(target_table_name: str) -> str:
+    return target_table_name.replace('"', "")
+
+
+INSERT_REGEX = re.compile(r".*inserted (\d+) rows into (.*) in.*")
+
+
+def _get_target_table_name(stream_name: str, sling_cli: "SlingResource") -> Optional[str]:
+    """Extracts the target table name from the logs for a specific stream."""
+    corresponding_logs = _get_logs_for_stream(stream_name, sling_cli)
+    insert_log = next((log for log in corresponding_logs if re.match(INSERT_REGEX, log)), None)
+    if not insert_log:
+        return None
+
+    target_table_name = check.not_none(re.match(INSERT_REGEX, insert_log)).group(2)
+    return _strip_quotes_target_table_name(target_table_name)
+
+
+COLUMN_NAME_COL = "Column"
+COLUMN_TYPE_COL = "General Type"
+
+SLING_COLUMN_PREFIX = "_sling_"
+
+
+def fetch_row_count_metadata(
+    materialization: SlingEventType,
+    sling_cli: "SlingResource",
+    replication_config: dict[str, Any],
+    context: Union[OpExecutionContext, AssetExecutionContext],
+) -> dict[str, Any]:
+    target_name = replication_config["target"]
+    if not materialization.metadata:
+        raise Exception("Missing required metadata to retrieve stream_name")
+
+    stream_name = cast("str", materialization.metadata["stream_name"])
+    target_table_name = _get_target_table_name(stream_name, sling_cli)
+
+    if target_table_name:
+        try:
+            row_count = sling_cli.get_row_count_for_table(target_name, target_table_name)
+            return dict(TableMetadataSet(row_count=row_count))
+        except Exception as e:
+            context.log.warning(
+                f"Failed to fetch row count for stream %s\nException: {e}",
+                stream_name,
+                exc_info=True,
+            )
+
+    return {}
+
+
+def fetch_column_metadata(
+    materialization: SlingEventType,
+    sling_cli: "SlingResource",
+    replication_config: dict[str, Any],
+    context: Union[OpExecutionContext, AssetExecutionContext],
+) -> dict[str, Any]:
+    target_name = replication_config["target"]
+
+    if not materialization.metadata:
+        raise Exception("Missing required metadata to retrieve stream_name")
+
+    stream_name = cast("str", materialization.metadata["stream_name"])
+
+    upstream_assets = set()
+    if isinstance(context, AssetExecutionContext):
+        if materialization.asset_key:
+            upstream_assets = context.assets_def.asset_deps[materialization.asset_key]
+
+    target_table_name = _get_target_table_name(stream_name, sling_cli)
+
+    if target_table_name:
+        try:
+            column_info = sling_cli.get_column_info_for_table(target_name, target_table_name)
+            column_type_map = {
+                col[COLUMN_NAME_COL]: col[COLUMN_TYPE_COL]
+                for col in column_info
+                if COLUMN_TYPE_COL in col
+            }
+
+            column_lineage = None
+            # If there is only one upstream asset (typical case), we can infer column lineage
+            # from the single upstream asset which is being replicated exactly.
+            if len(upstream_assets) == 1:
+                upstream_asset_key = next(iter(upstream_assets))
+                column_lineage = TableColumnLineage(
+                    deps_by_column={
+                        column_name.lower(): [
+                            TableColumnDep(
+                                asset_key=upstream_asset_key,
+                                column_name=column_name.lower(),
+                            )
+                        ]
+                        for column_name in column_type_map.keys()
+                        if not column_name.startswith(SLING_COLUMN_PREFIX)
+                    }
+                )
+
+            return dict(
+                TableMetadataSet(
+                    column_schema=TableSchema(
+                        columns=[
+                            TableColumn(name=column_name.lower(), type=column_type)
+                            for column_name, column_type in column_type_map.items()
+                        ]
+                    ),
+                    column_lineage=column_lineage,
+                )
+            )
+        except Exception as e:
+            context.log.warning(
+                f"Failed to fetch column metadata for stream %s\nException: {e}",
+                stream_name,
+                exc_info=True,
+            )
+
+    return {}
+
+
+class SlingEventIterator(Iterator[T]):
+    """A wrapper around an iterator of Sling events which contains additional methods for
+    post-processing the events, such as fetching column metadata.
+    """
+
+    def __init__(
+        self,
+        events: Iterator[T],
+        sling_cli: "SlingResource",
+        replication_config: dict[str, Any],
+        context: Union[OpExecutionContext, AssetExecutionContext],
+    ) -> None:
+        self._inner_iterator = events
+        self._sling_cli = sling_cli
+        self._replication_config = replication_config
+        self._context = context
+
+    def __next__(self) -> T:
+        return next(self._inner_iterator)
+
+    def __iter__(self) -> "SlingEventIterator[T]":
+        return self
+
+    @public
+    def fetch_column_metadata(self) -> "SlingEventIterator":
+        """Fetches column metadata for each table synced by the Sling CLI.
+
+        Retrieves the column schema and lineage for each target table.
+
+        Returns:
+            SlingEventIterator: An iterator of Dagster events with column metadata attached.
+        """
+
+        def _fetch_column_metadata() -> Iterator[T]:
+            for event in self:
+                col_metadata = fetch_column_metadata(
+                    event, self._sling_cli, self._replication_config, self._context
+                )
+                if event.metadata:
+                    yield event._replace(metadata={**col_metadata, **event.metadata})
+
+        return SlingEventIterator[T](
+            _fetch_column_metadata(), self._sling_cli, self._replication_config, self._context
+        )
+
+    @public
+    def fetch_row_count(self) -> "SlingEventIterator":
+        """Fetches row count metadata for each table synced by the Sling CLI.
+
+        Retrieves the row count for each target table.
+
+        Returns:
+            SlingEventIterator: An iterator of Dagster events with row count metadata attached.
+        """
+
+        def _fetch_row_count() -> Iterator[T]:
+            for event in self:
+                row_count_metadata = fetch_row_count_metadata(
+                    event, self._sling_cli, self._replication_config, self._context
+                )
+                if event.metadata:
+                    yield event._replace(metadata={**row_count_metadata, **event.metadata})
+
+        return SlingEventIterator[T](
+            _fetch_row_count(), self._sling_cli, self._replication_config, self._context
+        )

dagster_sling/sling_replication.py

@@ -0,0 +1,33 @@
+from collections.abc import Mapping
+from functools import cache
+from pathlib import Path
+from typing import Any, Optional, Union, cast
+
+import dagster._check as check
+import yaml
+
+SlingReplicationParam = Union[Mapping[str, Any], str, Path]
+
+
+@cache
+def read_replication_path(replication_path: Path) -> Mapping[str, Any]:
+    """Reads a Sling replication config from a path and returns a dict.
+
+    This function is cached to ensure that we don't read the same path multiple times, which
+    creates multiple copies of the parsed manifest in memory.
+    """
+    return cast("Mapping[str, Any]", yaml.safe_load(replication_path.read_bytes()))
+
+
+def validate_replication(replication: Optional[SlingReplicationParam]) -> Mapping[str, Any]:
+    replication = replication or {}
+    check.inst_param(replication, "manifest", (Path, str, dict))
+
+    if isinstance(replication, str):
+        replication = Path(replication)
+
+    if isinstance(replication, Path):
+        # Resolve the path to ensure a consistent key for the cache
+        replication = read_replication_path(replication.resolve())
+
+    return replication

dagster_sling/version.py

@@ -0,0 +1 @@
+__version__ = "0.28.8"

dagster_sling-0.28.8.dist-info/METADATA

@@ -0,0 +1,33 @@
+Metadata-Version: 2.4
+Name: dagster-sling
+Version: 0.28.8
+Summary: Package for performing ETL/ELT tasks with Sling in Dagster.
+Home-page: https://github.com/dagster-io/dagster/tree/master/python_modules/libraries/dagster-sling
+Author: Dagster Labs
+Author-email: hello@dagsterlabs.com
+License: Apache-2.0
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10,<3.15
+License-File: LICENSE
+Requires-Dist: dagster==1.12.8
+Requires-Dist: sling>=1.1.5
+Requires-Dist: sling-mac-arm64; platform_system == "Darwin" and platform_machine == "arm64"
+Provides-Extra: test
+Requires-Dist: duckdb; extra == "test"
+Requires-Dist: dagster-dg-cli; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

dagster_sling-0.28.8.dist-info/RECORD

@@ -0,0 +1,19 @@
+dagster_sling/__init__.py,sha256=bMx84ssIRAWK3TrxK1CMrDiOAgq5ynJvcJX-EKXKjvM,842
+dagster_sling/asset_decorator.py,sha256=hECGET1VNLYKD6rIUnJpo7yI5hQqfgVNXxY70OoAkXU,6403
+dagster_sling/asset_defs.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dagster_sling/dagster_sling_translator.py,sha256=F1j20UFeqYeTesQuxju8U76LpX23E-KY6xWt85y4Sq4,21428
+dagster_sling/py.typed,sha256=la67KBlbjXN-_-DfGNcdOcjYumVpKG_Tkw-8n5dnGB4,8
+dagster_sling/resources.py,sha256=N6Sy_9ykqJYB4NIY_4QAuYyndF_A_8UdKGy-zIbkHM8,26262
+dagster_sling/sling_event_iterator.py,sha256=zLlcYAO-ZbTw-K0lbaIMDuzQPmhNSRrIMcNRvvWkkNY,8460
+dagster_sling/sling_replication.py,sha256=24Fwuokmc2l_8HBStoTMvZSj77Qpt8ZcKUSAJNq34_M,1113
+dagster_sling/version.py,sha256=rMjeJYs_MOkcUCEGMkmwm1PlX0JRu_r70Ywo8pJrCDs,23
+dagster_sling/components/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dagster_sling/components/sling_replication_collection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dagster_sling/components/sling_replication_collection/component.py,sha256=BszJk4iW6_0xuW-7NeqnH9J3dcAaZ_f2E94HIDcrYtA,10854
+dagster_sling/components/sling_replication_collection/scaffolder.py,sha256=b0L4DtJifCg4FGEQ9E3O9N93WyiGSBlJikSbJOLsq1c,608
+dagster_sling-0.28.8.dist-info/licenses/LICENSE,sha256=4lsMW-RCvfVD4_F57wrmpe3vX1xwUk_OAKKmV_XT7Z0,11348
+dagster_sling-0.28.8.dist-info/METADATA,sha256=cACGV0LM8EnZ7jOCC8qgjcgcwezbkjNFZhjKJ9udvH4,1184
+dagster_sling-0.28.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+dagster_sling-0.28.8.dist-info/entry_points.txt,sha256=X75y2oDwNMmfILdNMk3CNOsskBN-RQnDoFV9D3PgVvc,64
+dagster_sling-0.28.8.dist-info/top_level.txt,sha256=eoJKEGsD6fqIEmF6xaF8tj5Kq9a7riWyRHbZn6oHTk8,14
+dagster_sling-0.28.8.dist-info/RECORD,,

dagster_sling-0.28.8.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

dagster_sling-0.28.8.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[dagster_dg_cli.registry_modules]
+dagster_sling = dagster_sling

dagster_sling-0.28.8.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2025 Dagster Labs, Inc.
+
+   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.

dagster_sling-0.28.8.dist-info/top_level.txt

@@ -0,0 +1 @@
+dagster_sling