singer_sdk.singerlib.catalog.CatalogEntry¶

class singer_sdk.singerlib.catalog.CatalogEntry[source]¶

Singer catalog entry.

classmethod from_dict(stream)[source]¶

Create a catalog entry from a dictionary.

Parameters:: stream (dict[str, Any]) – A dictionary with the defined catalog stream.
Returns:: A catalog entry.
Return type:: CatalogEntry

__init__(tap_stream_id, metadata, schema, stream=None, key_properties=None, replication_key=None, is_view=None, database=None, table=None, row_count=None, stream_alias=None, replication_method=None)[source]¶

Parameters:

tap_stream_id (str)
metadata (MetadataMapping)
schema (Schema)
stream (str | None)
key_properties (Sequence[str] | None)
replication_key (str | None)
is_view (bool | None)
database (str | None)
table (str | None)
row_count (int | None)
stream_alias (str | None)
replication_method (str | None)

Return type:

None

to_dict()[source]¶

Convert entry to a dictionary.

Returns:: A dictionary representation of the catalog entry.
Return type:: dict[str, Any]