Submodules

airbyte_cdk.sources.declarative.checks.check_stream module

class airbyte_cdk.sources.declarative.checks.check_stream.CheckStream(stream_names: List[str], parameters: dataclasses.InitVar[Mapping[str, Any]])

Bases: airbyte_cdk.sources.declarative.checks.connection_checker.ConnectionChecker

Checks the connections by checking availability of one or many streams selected by the developer

stream_name

names of streams to check

Type

List[str]

check_connection(source: airbyte_cdk.sources.source.Source, logger: logging.Logger, config: Mapping[str, Any]) → Tuple[bool, any]

Tests if the input configuration can be used to successfully connect to the integration e.g: if a provided Stripe API token can be used to connect to the Stripe API.

Parameters

• source – source

• logger – source logger

• config – The user-provided configuration as specified by the source’s spec. This usually contains information required to check connection e.g. tokens, secrets and keys etc.

Returns

A tuple of (boolean, error). If boolean is true, then the connection check is successful and we can connect to the underlying data source using the provided configuration. Otherwise, the input config cannot be used to connect to the underlying data source, and the “error” object should describe what went wrong. The error object will be cast to string to display the problem to the user.

parameters: dataclasses.InitVar[Mapping[str, Any]]

stream_names: List[str]

airbyte_cdk.sources.declarative.checks.connection_checker module

class airbyte_cdk.sources.declarative.checks.connection_checker.ConnectionChecker

Bases: abc.ABC

Abstract base class for checking a connection

abstract check_connection(source: airbyte_cdk.sources.source.Source, logger: logging.Logger, config: Mapping[str, Any]) → Tuple[bool, any]

Tests if the input configuration can be used to successfully connect to the integration e.g: if a provided Stripe API token can be used to connect to the Stripe API.

Parameters

• source – source

• logger – source logger

• config – The user-provided configuration as specified by the source’s spec. This usually contains information required to check connection e.g. tokens, secrets and keys etc.

Returns

A tuple of (boolean, error). If boolean is true, then the connection check is successful and we can connect to the underlying data source using the provided configuration. Otherwise, the input config cannot be used to connect to the underlying data source, and the “error” object should describe what went wrong. The error object will be cast to string to display the problem to the user.

Module contents

class airbyte_cdk.sources.declarative.checks.CheckStream(stream_names: List[str], parameters: dataclasses.InitVar[Mapping[str, Any]])

Bases: airbyte_cdk.sources.declarative.checks.connection_checker.ConnectionChecker

Checks the connections by checking availability of one or many streams selected by the developer

stream_name

names of streams to check

Type

List[str]

check_connection(source: airbyte_cdk.sources.source.Source, logger: logging.Logger, config: Mapping[str, Any]) → Tuple[bool, any]

Tests if the input configuration can be used to successfully connect to the integration e.g: if a provided Stripe API token can be used to connect to the Stripe API.

Parameters

• source – source

• logger – source logger

• config – The user-provided configuration as specified by the source’s spec. This usually contains information required to check connection e.g. tokens, secrets and keys etc.

Returns

A tuple of (boolean, error). If boolean is true, then the connection check is successful and we can connect to the underlying data source using the provided configuration. Otherwise, the input config cannot be used to connect to the underlying data source, and the “error” object should describe what went wrong. The error object will be cast to string to display the problem to the user.

parameters: dataclasses.InitVar[Mapping[str, Any]]

stream_names: List[str]

class airbyte_cdk.sources.declarative.checks.ConnectionChecker

Bases: abc.ABC

Abstract base class for checking a connection

abstract check_connection(source: airbyte_cdk.sources.source.Source, logger: logging.Logger, config: Mapping[str, Any]) → Tuple[bool, any]

Tests if the input configuration can be used to successfully connect to the integration e.g: if a provided Stripe API token can be used to connect to the Stripe API.

Parameters

• source – source

• logger – source logger

• config – The user-provided configuration as specified by the source’s spec. This usually contains information required to check connection e.g. tokens, secrets and keys etc.

Returns

A tuple of (boolean, error). If boolean is true, then the connection check is successful and we can connect to the underlying data source using the provided configuration. Otherwise, the input config cannot be used to connect to the underlying data source, and the “error” object should describe what went wrong. The error object will be cast to string to display the problem to the user.