Typing

Public type aliases, metadata types, and protocol definitions used throughout SQLSpec.

Metadata Types

class sqlspec.typing.ForeignKeyMetadata

Bases: object

Metadata for a foreign key constraint.

__init__(table_name, column_name, referenced_table, referenced_column, constraint_name=None, schema=None, referenced_schema=None)

class sqlspec.typing.ColumnMetadata

Bases: TypedDict

Metadata for a database column.

class sqlspec.typing.TableMetadata

Bases: TypedDict

Metadata for a database table.

class sqlspec.typing.IndexMetadata

Bases: TypedDict

Metadata for a database index.

class sqlspec.typing.VersionInfo

Bases: object

Parsed database version info.

__init__(major, minor=0, patch=0)

Initialize version info.

Parameters:

• major (int) – Major version number

• minor (int) – Minor version number

• patch (int) – Patch version number

property version_tuple: tuple[int, int, int]

Get version as tuple for comparison.

__str__()

String representation of version info.

Return type:

str

__repr__()

Detailed string representation.

Return type:

str

__eq__(other)

Check version equality.

Return type:

bool

__lt__(other)

Check if this version is less than another.

Return type:

bool

__le__(other)

Check if this version is less than or equal to another.

Return type:

bool

__gt__(other)

Check if this version is greater than another.

Return type:

bool

__ge__(other)

Check if this version is greater than or equal to another.

Return type:

bool

__hash__()

Make VersionInfo hashable based on version tuple.

Return type:

int

Protocols

class sqlspec.typing.DictLike

Bases: Protocol

A protocol for objects that behave like a dictionary for reading.

__init__(*args, **kwargs)

Feature Flags

class sqlspec.data_dictionary.FeatureFlags

Bases: TypedDict

Typed feature flags for data dictionary dialects.

class sqlspec.data_dictionary.FeatureVersions

Bases: TypedDict

Typed feature version requirements for data dictionary dialects.

Driver Protocols