Submodules

airbyte_cdk.sources.deprecated.base_source module

class airbyte_cdk.sources.deprecated.base_source.BaseSource

Bases: airbyte_cdk.sources.source.Source

Base source that designed to work with clients derived from BaseClient

check(logger: logging.Logger, config: Mapping[str, Any]) airbyte_protocol.models.airbyte_protocol.AirbyteConnectionStatus

Check connection

client_class: Type[airbyte_cdk.sources.deprecated.client.BaseClient]
discover(logger: logging.Logger, config: Mapping[str, Any]) airbyte_protocol.models.airbyte_protocol.AirbyteCatalog

Discover streams

property name: str

Source name

read(logger: logging.Logger, config: Mapping[str, Any], catalog: airbyte_protocol.models.airbyte_protocol.ConfiguredAirbyteCatalog, state: Optional[MutableMapping[str, Any]] = None) Iterable[airbyte_protocol.models.airbyte_protocol.AirbyteMessage]

Returns a generator of the AirbyteMessages generated by reading the source with the given configuration, catalog, and state.

airbyte_cdk.sources.deprecated.client module

class airbyte_cdk.sources.deprecated.client.BaseClient(**kwargs)

Bases: airbyte_cdk.sources.deprecated.client.StreamStateMixin, abc.ABC

Base client for API

abstract health_check() Tuple[bool, str]

Check if service is up and running

read_stream(stream: airbyte_protocol.models.airbyte_protocol.AirbyteStream) Generator[Dict[str, Any], None, None]

Yield records from stream

schema_loader_class

alias of airbyte_cdk.sources.utils.schema_helpers.ResourceSchemaLoader

property streams: Generator[airbyte_protocol.models.airbyte_protocol.AirbyteStream, None, None]

List of available streams

class airbyte_cdk.sources.deprecated.client.StreamStateMixin

Bases: object

get_stream_state(name: str) Any

Get state of stream with corresponding name

set_stream_state(name: str, state: Any)

Set state of stream with corresponding name

stream_has_state(name: str) bool

Tell if stream supports incremental sync

airbyte_cdk.sources.deprecated.client.configured_catalog_from_client(client: airbyte_cdk.sources.deprecated.client.BaseClient) airbyte_protocol.models.airbyte_protocol.ConfiguredAirbyteCatalog

Helper to generate configured catalog for testing

airbyte_cdk.sources.deprecated.client.package_name_from_class(cls: object) str

Find the package name given a class name

Module contents