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 (#26583)

## Summary & Motivation

As title.

## How I Tested These Changes

Docs preview
  • Loading branch information
maximearmstrong authored Dec 26, 2024
1 parent 5ee51b7 commit 6849237
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 1 deletion.
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

2 comments on commit 6849237

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploy preview for dagster-docs ready!

✅ Preview
https://dagster-docs-7pqvbal69-elementl.vercel.app
https://master.dagster.dagster-docs.io

Built with commit 6849237.
This pull request is being automatically deployed with vercel-action

@github-actions
Copy link

@github-actions github-actions bot commented on 6849237 Dec 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploy preview for dagster-docs-beta ready!

✅ Preview
https://dagster-docs-beta-7ltkqwiy2-elementl.vercel.app

Built with commit 6849237.
This pull request is being automatically deployed with vercel-action

Please sign in to comment.