Skip to main content
GuideServerConfigure and deploy Tabsdata servers on your machine.TutorialsConfigure data integration workflows within a running Tabsdata server.Advanced TutorialsBuild end-to-end workflows between two specific systems.API ReferenceCLI ReferenceRelease Notes
Version: 2.0.0

tabsdatak.conn.db2

CdcColumnsFormatSpecLayout of the change-values payload on each emitted row: one of "columns", "struct" or "map".
CdcSrcCfgKey
CdcSrcCfgSpec
CommitSeqPositionCDC start position: one global commit sequence for every table.
CredentialsSpecThe credential type for Db2 connections: UserPassword (user + password), spliced into the URI by the engine factory.
Db2CdcStartFromSpecWhere a Db2 CDC stream begins: a "head" / "tail" keyword, a CommitSeqPosition, a TableCommitSeqPosition or a TimestampPosition.
Db2CdcStreamSrcDb2 CDC stream source for @stream_publisher.
Db2CdcStreamSrcConnDb2 CDC connection used by Db2CdcStreamSrc.
Db2DestDb2 destination for @subscriber -- one target table per slot.
Db2DestConnDb2 connection used by Db2Dest.
Db2SrcDb2 source for @publisher -- one output slot per query.
Db2SrcConnDb2 connection used by Db2Src.
Db2TableNameSpecA Db2 table name, either table or schema.table (at most two dot-separated parts).
Db2TableNamesSpecA list of Db2 table names (see Db2TableNameSpec).
DestCfgKey
DestCfgSpec
IfTableExistsSpecWrite disposition when the target table exists: "append" adds rows; "replace" truncates before insert.
QueriesSpecA non-empty, ordered list of SELECT statements -- one output slot per query.
RelativePositionSpecRelative CDC start position: "head" rewinds to the oldest row still retained in each tracked CD table; "tail" skips to each CD table's current watermark (only later changes are emitted).
SrcCfgKey
SrcCfgSpec
TableCommitSeqPositionCDC start position: independent commit sequence per table.
TimestampPositionCDC start position given as a wall-clock timestamp.
UriSpecA SQLAlchemy-style Db2 URI, e.g.

CdcColumnsFormatSpec

type_alias 
CdcColumnsFormatSpec: Literal['columns', 'struct', 'map']

Layout of the change-values payload on each emitted row: one of "columns", "struct" or "map".

CdcSrcCfgKey

type_alias 
CdcSrcCfgKey: Literal['db2.cdc.blocking_timeout_seconds', 'db2.cdc.fetch_size', 'db2.cdc.logging_level', 'tabsdata.cdc.buffer.max_rows', 'tabsdata.cdc.buffer.max_bytes', 'tabsdata.cdc.buffer.max_secs', 'tabsdata.cdc.trigger.max_rows', 'tabsdata.cdc.trigger.max_bytes', 'tabsdata.cdc.trigger.max_secs', 'tabsdata.cdc.poll_interval_seconds']

CdcSrcCfgSpec

type_alias 
CdcSrcCfgSpec: Mapping[CdcSrcCfgKey, Any]

Resolved type:

Mapping[Literal['db2.cdc.blocking_timeout_seconds', 'db2.cdc.fetch_size', 'db2.cdc.logging_level', 'tabsdata.cdc.buffer.max_rows', 'tabsdata.cdc.buffer.max_bytes', 'tabsdata.cdc.buffer.max_secs', 'tabsdata.cdc.trigger.max_rows', 'tabsdata.cdc.trigger.max_bytes', 'tabsdata.cdc.trigger.max_secs', 'tabsdata.cdc.poll_interval_seconds'], Any]

CredentialsSpec

type_alias 
CredentialsSpec: UserPassword

The credential type for Db2 connections: UserPassword (user + password), spliced into the URI by the engine factory.

Db2CdcStartFromSpec

type_alias 
Db2CdcStartFromSpec: Union[RelativePositionSpec, CommitSeqPosition, TableCommitSeqPosition, TimestampPosition]

Resolved type:

Literal['head', 'tail'] | CommitSeqPosition | TableCommitSeqPosition | TimestampPosition

Where a Db2 CDC stream begins: a "head" / "tail" keyword, a CommitSeqPosition, a TableCommitSeqPosition or a TimestampPosition.

Db2TableNameSpec

type_alias 
Db2TableNameSpec: str

A Db2 table name, either table or schema.table (at most two dot-separated parts). Parts may be double-quoted, using the doubled double-quote convention to embed a literal quote.

Db2TableNamesSpec

type_alias 
Db2TableNamesSpec: list[Db2TableNameSpec]

Resolved type:

list[str]

A list of Db2 table names (see Db2TableNameSpec).

DestCfgKey

type_alias 
DestCfgKey: Literal['db2.logging_level', 'tabsdata.sql.write_engine', 'tabsdata.sql.chunk_size']

DestCfgSpec

type_alias 
DestCfgSpec: Mapping[DestCfgKey, Any]

Resolved type:

Mapping[Literal['db2.logging_level', 'tabsdata.sql.write_engine', 'tabsdata.sql.chunk_size'], Any]

IfTableExistsSpec

type_alias 
IfTableExistsSpec: Literal['append', 'replace']

Write disposition when the target table exists: "append" adds rows; "replace" truncates before insert.

QueriesSpec

type_alias 
QueriesSpec: list[str]

A non-empty, ordered list of SELECT statements -- one output slot per query.

RelativePositionSpec

type_alias 
RelativePositionSpec: Literal['head', 'tail']

Relative CDC start position: "head" rewinds to the oldest row still retained in each tracked CD table; "tail" skips to each CD table's current watermark (only later changes are emitted).

SrcCfgKey

type_alias 
SrcCfgKey: Literal['db2.logging_level', 'tabsdata.sql.read_engine', 'tabsdata.sql.chunk_size', 'tabsdata.src_metadata.drop']

SrcCfgSpec

type_alias 
SrcCfgSpec: Mapping[SrcCfgKey, Any]

Resolved type:

Mapping[Literal['db2.logging_level', 'tabsdata.sql.read_engine', 'tabsdata.sql.chunk_size', 'tabsdata.src_metadata.drop'], Any]

UriSpec

type_alias 
UriSpec: StrOrSecretSpec

Resolved type:

str | Secret

A SQLAlchemy-style Db2 URI, e.g. db2+ibm_db://host:port/db. The scheme must be db2 or ibm_db_sa (an optional +driver is allowed). Accepts a plain string or a Secret.