singer_sdk.connectors.sql.JSONSchemaToSQL

class singer_sdk.connectors.sql.JSONSchemaToSQL

A configurable mapper for converting JSON Schema types to SQLAlchemy types.

This class provides a mapping from JSON Schema types to SQLAlchemy types.

Added in version 0.42.0.

__init__(*, max_varchar_length=None)

Initialize the mapper with default type mappings.

Parameters:

max_varchar_length (int | None) – The absolute maximum length for VARCHAR columns that the database supports.

Return type:

None

handle_multiple_types(types)

Handle multiple types by returning a VARCHAR.

Parameters:

types (Sequence[str]) – The list of types to handle.

Returns:

A VARCHAR type.

Return type:

TypeEngine

handle_raw_string(schema)

Handle a string type generically.

Parameters:

schema (dict) – The JSON Schema object.

Returns:

Appropriate SQLAlchemy type.

Return type:

TypeEngine

register_format_handler(format_name, handler)

Register a custom format handler.

Parameters:

• format_name (str) – The format string (e.g., “date-time”, “email”, “custom-format”).

• handler (type[TypeEngine] | Callable[[dict], TypeEngine]) – Either a SQLAlchemy type class or a callable that takes a schema dict and returns a SQLAlchemy type instance.

Return type:

None

register_type_handler(json_type, handler)

Register a custom type handler.

Parameters:

• json_type (str) – The JSON Schema type to handle.

• handler (type[TypeEngine] | Callable[[dict], TypeEngine]) – Either a SQLAlchemy type class or a callable that takes a schema dict and returns a SQLAlchemy type instance.

Return type:

None

to_sql_type(schema)

Convert a JSON Schema type definition to a SQLAlchemy type.

Parameters:

schema (dict) – The JSON Schema object.

Returns:

The corresponding SQLAlchemy type.

Return type:

TypeEngine

property fallback_type: type[TypeEngine]

Return the fallback type.

Returns:

The fallback type.