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.common.types

AwsAccessSecretKeyAWS access key ID / secret access key credentials.
AwsRegionSpecA valid AWS region name, e.g.
AzContainerSpecA valid Azure Blob container name: 3-63 characters, lowercase letters and digits with single (non-leading, non-trailing) hyphens.
AzureAccountKeyAzure storage account name / key credentials.
AzureCredentialsAbstract base for Azure credential types.
BoolSpecA boolean flag as text: one of true/false, t/f, yes/no, y/n, on/off, 1/0 (case-insensitive).
CfgSpecType for a connector conn_cfg field: a free-form dict forwarding 3rd-party-specific configuration.
cloud_full_pathJoin a cloud base_path (object-key prefix) with path, stripping leading and trailing / from each side and from the result.
CloudRelativePathSpecA cloud object-key prefix, relative to the container/bucket root.
CredentialsAbstract base for every credential type.
DataTypePlaceholder enumeration of basic data types.
EntityWhitelistSpecOptional list of regex patterns narrowing which of the external system's entities (tables / collections / objects / datasets / ...) a source considers.
GCPCredentialsAbstract base for Google Cloud credential types.
GCPHmacHMAC access key / secret for GCS's S3-compatible endpoint.
GCPJsonGCP service-account JSON key credentials.
GCSBucketSpecA valid GCS bucket name: 3-63 characters, lowercase letters, digits, hyphens and underscores, starting and ending with a letter or digit.
HostSpecA DNS host name or IPv4 literal (e.g.
local_full_pathJoin a local-filesystem base_path with the relative path, returning a native path for the running OS.
LocalAbsolutePathSpecAn absolute local-filesystem path: POSIX (/a/b) or Windows drive-absolute (C:/a/b or C:\a\b).
normalize_dir_pathRender path as a directory-style prefix with a leading and/or trailing / forced on per the flags -- for an external driver that expects a specific spelling of the prefix.
PortSpecA TCP port number, 1-65535.
S3BucketSpecA valid S3 bucket name: 3-63 characters, lowercase letters, digits and hyphens, starting and ending with a letter or digit.
UserPasswordUsername / password credentials.

AwsRegionSpec

type_alias 
AwsRegionSpec: StrOrSecretSpec

Resolved type:

str | Secret

A valid AWS region name, e.g. us-east-1 or us-gov-west-1. Accepts a plain string or a Secret.

AzContainerSpec

type_alias 
AzContainerSpec: StrOrSecretSpec

Resolved type:

str | Secret

A valid Azure Blob container name: 3-63 characters, lowercase letters and digits with single (non-leading, non-trailing) hyphens. Accepts a plain string or a Secret.

BoolSpec

type_alias 
BoolSpec: StrOrSecretSpec

Resolved type:

str | Secret

A boolean flag as text: one of true/false, t/f, yes/no, y/n, on/off, 1/0 (case-insensitive). Accepts a plain string or a Secret; read the parsed bool with _convert(x, bool).

CfgSpec

type_alias 
CfgSpec: dict

Type for a connector conn_cfg field: a free-form dict forwarding 3rd-party-specific configuration.

Keys targeting a dependency are prefixed with its package name plus . (e.g. "sqlalchemy.connect_args", "mysql.charset"); the connector strips the prefix before forwarding. Values must be JSON-like: str / int / float / bool / None, or a (recursively validated) str-keyed dict or list.

cloud_full_path

function 
def cloud_full_path(base_path: CloudRelativePathSpec, path: str) -> str

Join a cloud base_path (object-key prefix) with path, stripping leading and trailing / from each side and from the result. base_path may be a str or a Secret whose .value() resolves to the path string.

Parameters:

parameter
base_pathCloudRelativePathSpec (str | Secret)

parameter
pathstr

CloudRelativePathSpec

type_alias 
CloudRelativePathSpec: StrOrSecretSpec

Resolved type:

str | Secret

A cloud object-key prefix, relative to the container/bucket root.

Starts with /, has no trailing / (except the bare root /) and no empty segments (no //); backslash and NUL are forbidden. Accepts a plain string or a Secret.

DataType

class 
class DataType(
    BOOL = 'bool',
    INT = 'int',
    FLOAT = 'float',
    STRING = 'string',
    BYTES = 'bytes',
    DATE = 'date',
    TIME = 'time',
    DATETIME = 'datetime',
)

Bases: Enum

Placeholder enumeration of basic data types.

Not yet part of the stable public surface; subject to change.

Parameters:

parameter
BOOL

parameter
INT

parameter
FLOAT

parameter
STRING

parameter
BYTES

parameter
DATE

parameter
TIME

parameter
DATETIME

EntityWhitelistSpec

type_alias 
EntityWhitelistSpec: list[str]

Optional list of regex patterns narrowing which of the external system's entities (tables / collections / objects / datasets / ...) a source considers.

None (the default) means no filtering. Each entry must be a valid Python regular expression, matched against entity metadata names.

GCSBucketSpec

type_alias 
GCSBucketSpec: StrOrSecretSpec

Resolved type:

str | Secret

A valid GCS bucket name: 3-63 characters, lowercase letters, digits, hyphens and underscores, starting and ending with a letter or digit. Accepts a plain string or a Secret.

HostSpec

type_alias 
HostSpec: StrOrSecretSpec

Resolved type:

str | Secret

A DNS host name or IPv4 literal (e.g. localhost, db.example.com, 10.0.0.1). Accepts a plain string or a Secret.

local_full_path

function 
def local_full_path(base_path: LocalAbsolutePathSpec, path: str) -> str

Join a local-filesystem base_path with the relative path, returning a native path for the running OS.

base_path is absolute (POSIX or Windows drive-absolute). path is relative to it and may use / or \ separators; both are accepted and the segments are re-joined with the OS-native separator so the result is usable directly for filesystem access. base_path may be a str or a Secret.

Parameters:

parameter
base_pathLocalAbsolutePathSpec (str | Secret)

parameter
pathstr

LocalAbsolutePathSpec

type_alias 
LocalAbsolutePathSpec: StrOrSecretSpec

Resolved type:

str | Secret

An absolute local-filesystem path: POSIX (/a/b) or Windows drive-absolute (C:/a/b or C:\a\b). UNC and relative paths are rejected; no empty segments or NUL. Accepts a plain string or a Secret.

normalize_dir_path

function 
def normalize_dir_path(path: str, lead_separator: bool, back_separator: bool) -> str

Render path as a directory-style prefix with a leading and/or trailing / forced on per the flags -- for an external driver that expects a specific spelling of the prefix. path is first reduced to its slash-stripped core; an empty core yields "" regardless of the flags (there is no directory to delimit).

Parameters:

parameter
pathstr

parameter
lead_separatorbool

parameter
back_separatorbool

PortSpec

type_alias 
PortSpec: StrOrSecretSpec

Resolved type:

str | Secret

A TCP port number, 1-65535. Accepts a plain string or a Secret; read the parsed int with _convert(x, int).

S3BucketSpec

type_alias 
S3BucketSpec: StrOrSecretSpec

Resolved type:

str | Secret

A valid S3 bucket name: 3-63 characters, lowercase letters, digits and hyphens, starting and ending with a letter or digit. Accepts a plain string or a Secret.