dagster-fivetran 0.27.16__tar.gz → 0.28.0__tar.gz

{dagster_fivetran-0.27.16/dagster_fivetran.egg-info → dagster_fivetran-0.28.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dagster-fivetran
-Version: 0.27.16
+Version: 0.28.0
 Summary: Package for integrating Fivetran with Dagster.
 Home-page: https://github.com/dagster-io/dagster/tree/master/python_modules/libraries/dagster-fivetran
 Author: Dagster Labs
@@ -15,9 +15,9 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.9,<3.14
 License-File: LICENSE
-Requires-Dist: dagster==1.11.16
+Requires-Dist: dagster==1.12.0
 Provides-Extra: managed
-Requires-Dist: dagster-managed-elements==0.27.16; extra == "managed"
+Requires-Dist: dagster-managed-elements==0.28.0; extra == "managed"
 Provides-Extra: test
 Requires-Dist: pytest-order; extra == "test"
 Dynamic: author

{dagster_fivetran-0.27.16 → dagster_fivetran-0.28.0}/dagster_fivetran/components/workspace_component/component.py

@@ -82,6 +82,23 @@ class FivetranAccountComponent(StateBackedComponent, dg.Model, dg.Resolvable):
     """Loads Fivetran connectors from a given Fivetran instance as Dagster assets.
     Materializing these assets will trigger a sync of the Fivetran connector, enabling
     you to schedule Fivetran syncs using Dagster.
+
+    Example:
+
+        .. code-block:: yaml
+
+            # defs.yaml
+
+            type: dagster_fivetran.FivetranAccountComponent
+            attributes:
+              workspace:
+                account_id: your_account_id
+                api_key: "{{ env.FIVETRAN_API_KEY }}"
+                api_secret: "{{ env.FIVETRAN_API_SECRET }}"
+              connector_selector:
+                by_name:
+                  - my_postgres_connector
+                  - my_snowflake_connector
     """
 
     workspace: Annotated[
@@ -129,12 +146,72 @@ class FivetranAccountComponent(StateBackedComponent, dg.Model, dg.Resolvable):
         default_key = f"{self.__class__.__name__}[{self.workspace_resource.account_id}]"
         return DefsStateConfig.from_args(self.defs_state, default_key=default_key)
 
+    @public
     def get_asset_spec(self, props: FivetranConnectorTableProps) -> dg.AssetSpec:
+        """Generates an AssetSpec for a given Fivetran connector table.
+
+        This method can be overridden in a subclass to customize how Fivetran connector tables
+        are converted to Dagster asset specs. By default, it delegates to the configured
+        DagsterFivetranTranslator.
+
+        Args:
+            props: The FivetranConnectorTableProps containing information about the connector
+                and destination table being synced
+
+        Returns:
+            An AssetSpec that represents the Fivetran connector table as a Dagster asset
+
+        Example:
+            Override this method to add custom tags based on connector properties:
+
+            .. code-block:: python
+
+                from dagster_fivetran import FivetranAccountComponent
+                import dagster as dg
+
+                class CustomFivetranAccountComponent(FivetranAccountComponent):
+                    def get_asset_spec(self, props):
+                        base_spec = super().get_asset_spec(props)
+                        return base_spec.replace_attributes(
+                            tags={
+                                **base_spec.tags,
+                                "connector_type": props.connector_type,
+                                "destination": props.destination_name
+                            }
+                        )
+        """
         return self._base_translator.get_asset_spec(props)
 
+    @public
     def execute(
         self, context: dg.AssetExecutionContext, fivetran: FivetranWorkspace
     ) -> Iterable[Union[dg.AssetMaterialization, dg.MaterializeResult]]:
+        """Executes a Fivetran sync for the selected connector.
+
+        This method can be overridden in a subclass to customize the sync execution behavior,
+        such as adding custom logging or handling sync results differently.
+
+        Args:
+            context: The asset execution context provided by Dagster
+            fivetran: The FivetranWorkspace resource used to trigger and monitor syncs
+
+        Yields:
+            AssetMaterialization or MaterializeResult events from the Fivetran sync
+
+        Example:
+            Override this method to add custom logging during sync execution:
+
+            .. code-block:: python
+
+                from dagster_fivetran import FivetranAccountComponent
+                import dagster as dg
+
+                class CustomFivetranAccountComponent(FivetranAccountComponent):
+                    def execute(self, context, fivetran):
+                        context.log.info("Starting Fivetran sync")
+                        yield from super().execute(context, fivetran)
+                        context.log.info("Fivetran sync completed successfully")
+        """
         yield from fivetran.sync_and_poll(context=context)
 
     def _load_asset_specs(self, state: FivetranWorkspaceData) -> Sequence[dg.AssetSpec]:

dagster_fivetran-0.28.0/dagster_fivetran/version.py

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

{dagster_fivetran-0.27.16 → dagster_fivetran-0.28.0/dagster_fivetran.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dagster-fivetran
-Version: 0.27.16
+Version: 0.28.0
 Summary: Package for integrating Fivetran with Dagster.
 Home-page: https://github.com/dagster-io/dagster/tree/master/python_modules/libraries/dagster-fivetran
 Author: Dagster Labs
@@ -15,9 +15,9 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.9,<3.14
 License-File: LICENSE
-Requires-Dist: dagster==1.11.16
+Requires-Dist: dagster==1.12.0
 Provides-Extra: managed
-Requires-Dist: dagster-managed-elements==0.27.16; extra == "managed"
+Requires-Dist: dagster-managed-elements==0.28.0; extra == "managed"
 Provides-Extra: test
 Requires-Dist: pytest-order; extra == "test"
 Dynamic: author

dagster_fivetran-0.28.0/dagster_fivetran.egg-info/requires.txt

@@ -0,0 +1,7 @@
+dagster==1.12.0
+
+[managed]
+dagster-managed-elements==0.28.0
+
+[test]
+pytest-order

{dagster_fivetran-0.27.16 → dagster_fivetran-0.28.0}/setup.py

@@ -34,7 +34,7 @@ setup(
     packages=find_packages(exclude=["dagster_fivetran_tests*"]),
     include_package_data=True,
     python_requires=">=3.9,<3.14",
-    install_requires=["dagster==1.11.16"],
+    install_requires=["dagster==1.12.0"],
     zip_safe=False,
     entry_points={
         "console_scripts": [
@@ -46,7 +46,7 @@ setup(
     },
     extras_require={
         "managed": [
-            "dagster-managed-elements==0.27.16",
+            "dagster-managed-elements==0.28.0",
         ],
         "test": [
             "pytest-order",

dagster_fivetran-0.27.16/dagster_fivetran/version.py

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

dagster_fivetran-0.27.16/dagster_fivetran.egg-info/requires.txt

@@ -1,7 +0,0 @@
-dagster==1.11.16
-
-[managed]
-dagster-managed-elements==0.27.16
-
-[test]
-pytest-order