Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[dagster-airbyte][docs] Update airbyte API docs with asset decorator, factory and materialization method #26583

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/content/api/modules.json.gz
Binary file not shown.
Binary file modified docs/content/api/searchindex.json.gz
Binary file not shown.
Binary file modified docs/content/api/sections.json.gz
Binary file not shown.
Binary file modified docs/next/public/objects.inv
Binary file not shown.
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
Loading