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

SrcDef

class
class SrcDef(
type_: str,
system: str,
src_version: str,
conn: Type[Conn],
src: Type[S],
table_mode: TableMode,
cardinality: Callable[[S], int],
plugin: Type[SrcPlugin],
explorer: Type[Explorer] | None,
icon: str | None,
)

Categories: spi

Entry-point registration for a batch Src binding.

Registered via the tabsdatak.connectors entry point. Binds a Src config type to the SrcPlugin that reads it.

Parameters​

parameter
type_str

Wire-stable identifier, unique across all plugins (sources, stream sources and destinations share one namespace), e.g. "s3-file-in". The registry's key.

parameter
systemstr

Human-readable name of the target system (e.g. "AWS S3"); shown by tdk connection types.

parameter
src_versionstr

Connector schema version.

parameter
connType[Conn]

Concrete Conn subclass the source binds to.

parameter
srcType[S]

Concrete Src subclass this binding registers.

parameter
table_modeTableMode

Whether read_in produces one file per slot or many; see TableMode.

parameter
cardinalityCallable[[S], int]

Callable returning the number of output slots src declares (e.g. lambda s: len(s.paths)).

parameter

SrcPlugin subclass implementing read_in.

parameter
explorerType[Explorer] | None

Optional Explorer for tooling introspection.

parameter
iconstr | None

Path to the connector's icon relative to the tabsdatak namespace root (e.g. "conn/s3/resources/s3.svg"), or None for none.