Skip to content

Commit

Permalink
[dagster-airbyte][docs] Update airbyte API docs with asset decorator,…
Browse files Browse the repository at this point in the history
… factory and materialization method
  • Loading branch information
maximearmstrong committed Dec 26, 2024
1 parent 7e000d9 commit 070cb62
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ Assets (Airbyte API)

.. autofunction:: load_airbyte_cloud_asset_specs

.. autodecorator:: airbyte_assets

.. autofunction:: build_airbyte_assets_definitions


Legacy
======
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1062,6 +1062,7 @@ def build_airbyte_assets_definitions(
Examples:
Sync the tables of a Airbyte connection:
.. code-block:: python
from dagster_airbyte import AirbyteCloudWorkspace, build_airbyte_assets_definitions
Expand All @@ -1083,6 +1084,7 @@ def build_airbyte_assets_definitions(
)
Sync the tables of a Airbyte connection with a custom translator:
.. code-block:: python
from dagster_airbyte import (
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
get_dagster_logger,
resource,
)
from dagster._annotations import experimental
from dagster._annotations import experimental, public
from dagster._config.pythonic_config import infer_schema_from_config_class
from dagster._core.definitions.asset_spec import AssetSpec
from dagster._core.definitions.definitions_load_context import StateBackedDefinitionsLoader
Expand Down Expand Up @@ -1258,6 +1258,7 @@ def _generate_materialization(
metadata=stream_asset_spec.metadata,
)

@public
@experimental
def sync_and_poll(self, context: AssetExecutionContext):
"""Executes a sync and poll process to materialize Airbyte Cloud assets.
Expand Down

0 comments on commit 070cb62

Please sign in to comment.