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.spi

check_plugin_param_typeValidate a plugin method's parameter type matches expected.
CommitStateFn
ConnAbstract base for every connection.
ConnMetaModelAbstract base for a connection kind (SQL, objects, storage, ...).
DestContextContext handed to DestPlugin.write_out -- combines TrxCtx with PluginCtx.
DestDefEntry-point registration for a Dest binding.
DestPluginPlugin implementing the write-side of a Dest subclass.
EntityAbstract base for an entity within a connection.
ExplorerOptional connector capability for ad-hoc inspection of a live Conn: catalog metadata and arbitrary query execution.
FilesSpec
FlowCtxFlow-level identifiers (collection / function) shared by every role that runs inside a trx -- plugins and user-decorated functions.
FunctionCtxContext handed to a user-decorated function (@publisher / @transformer / @subscriber) that declares a trailing ctx parameter.
MetadataSpec
PluginCtxCommon context surface shared by every plugin variant (batch source, stream source, destination).
SrcDefEntry-point registration for a batch Src binding.
SrcPluginPlugin implementing the read-side of a Src subclass.
SrcPluginCtxContext handed to SrcPlugin.read_in -- combines TrxCtx (trx identifiers + scratch state) with PluginCtx (flow identifiers + work dir).
StreamSrcDefEntry-point registration for a StreamSrc binding.
StreamSrcPluginPlugin implementing the long-running side of a StreamSrc subclass (CDC, log tail, queue tail).
StreamSrcPluginCtxContext handed to StreamSrcPlugin.run -- the plugin's long-lived control surface.
StreamStageSrcConfig type for the hidden batch source that ingests a stream's staged manifests.
StreamStageSrcPluginHidden batch-side (publisher) source that ingests a stream stage's manifests.
StreamStateSpec
TableFileInputOne parquet file SrcPlugin.read_in produces for an output slot, paired with optional metadata to carry alongside it.
TableFileSpec
TableModeHow a SrcPlugin returns slot contents -- the length of each inner list in SrcPlugin.read_in's return.
to_table_file_inputsWrap per-slot parquet paths as TableFileInput\ s with no metadata -- the shape SrcPlugin.read_in returns.

CommitStateFn

type_alias
CommitStateFn: Callable[[], None]

FilesSpec

type_alias
FilesSpec: list[TableFileSpec]

Resolved type:

list[Path]

MetadataSpec

type_alias
MetadataSpec: dict[str, _MetadataBasicType]

Resolved type:

dict[str, str | int | float | bool]

StreamStateSpec

type_alias
StreamStateSpec: Union[BasicDictSpec, CommitStateFn]

Resolved type:

dict[str, str | int | float | bool] | Callable[[], None]

TableFileSpec

type_alias
TableFileSpec: Path