airflow.providers.airbyte.hooks.airbyte¶

Attributes¶

Hook for Airbyte API.

class airflow.providers.airbyte.hooks.airbyte.AirbyteHook(airbyte_conn_id='airbyte_default', api_version='v1')[source]¶

Bases: airflow.providers.airbyte.version_compat.BaseHook

Hook for Airbyte API.

Parameters:

airbyte_conn_id (str) – Optional. The name of the Airflow connection to get connection information for Airbyte. Defaults to “airbyte_default”.
api_version (str) – Optional. Airbyte API version. Defaults to “v1”.

get_conn_params(conn_id)[source]¶

create_api_session()[source]¶

Create Airbyte API session.

classmethod get_ui_field_behaviour()[source]¶

Return custom field behaviour.

get_job_details(job_id)[source]¶

Use Http async call to retrieve metadata for a specific job of an Airbyte Sync.

get_job_status(job_id)[source]¶

Retrieve the status for a specific job of an Airbyte Sync.

wait_for_job(job_id, wait_seconds=3, timeout=3600)[source]¶

Poll a job to check if it finishes.

Parameters:

job_id (str | int) – Required. Id of the Airbyte job
wait_seconds (float) – Optional. Number of seconds between checks.
timeout (float | None) – Optional. How many seconds wait for job to be ready. Used only if asynchronous is False.

submit_sync_connection(connection_id)[source]¶

cancel_job(job_id)[source]¶

Cancel the job when task is cancelled.

test_connection()[source]¶: Tests the Airbyte connection by hitting the health API.