singer_sdk.connectors.BaseConnector

class singer_sdk.connectors.BaseConnector[source]

Base class for all connectors.

__init__(config=None)[source]

Initialize the connector.

Parameters:

config (Mapping[str, t.Any] | None) – Plugin configuration parameters.

Return type:

None

connect(*args, **kwargs)[source]

Connect to the destination.

Parameters:

  • args (Any) – Positional arguments to pass to the connection method.

  • kwargs (Any) – Keyword arguments to pass to the connection method.

Yields:

A connection object.

Return type:

Generator[_T, None, None]

abstractmethod get_connection(*args, **kwargs)[source]

Connect to the destination.

Parameters:

  • args (Any) – Positional arguments to pass to the connection method.

  • kwargs (Any) – Keyword arguments to pass to the connection method.

Return type:

_T

property config: Mapping[str, t.Any][source]

Return the connector configuration.

Returns:

A mapping of configuration parameters.