airflow.providers.airbyte.hooks.airbyte

Module Contents

Classes

AirbyteHook

Hook for Airbyte API.

Attributes

T

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

Bases: airflow.providers.http.hooks.http.HttpHook

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”.

  • api_type (Literal[config, cloud]) – Optional. The type of Airbyte API to use. Either “config” or “cloud”. Defaults to “config”.

conn_name_attr = 'airbyte_conn_id'[source]
default_conn_name = 'airbyte_default'[source]
conn_type = 'airbyte'[source]
hook_name = 'Airbyte'[source]
RUNNING = 'running'[source]
SUCCEEDED = 'succeeded'[source]
CANCELLED = 'cancelled'[source]
PENDING = 'pending'[source]
FAILED = 'failed'[source]
ERROR = 'error'[source]
INCOMPLETE = 'incomplete'[source]
async get_headers_tenants_from_connection()[source]

Get Headers, tenants from the connection details.

async get_job_details(job_id)[source]

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

Parameters

job_id (int) – The ID of an Airbyte Sync Job.

async get_job_status(job_id)[source]

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

Parameters

job_id (int) – The ID of an Airbyte Sync Job.

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]

Submit a job to a Airbyte server.

Parameters

connection_id (str) – Required. The ConnectionId of the Airbyte Connection.

get_job(job_id)[source]

Get the resource representation for a job in Airbyte.

Parameters

job_id (int) – Required. Id of the Airbyte job

cancel_job(job_id)[source]

Cancel the job when task is cancelled.

Parameters

job_id (int) – Required. Id of the Airbyte job

test_connection()[source]

Tests the Airbyte connection by hitting the health API.

Was this entry helpful?