sqlalchemy.sql.sqltypes.SchemaType

class documentation

class SchemaType(SchemaEventTarget, TypeEngineMixin): (source)

Known subclasses: sqlalchemy.dialects.postgresql.DOMAIN, sqlalchemy.sql.sqltypes.Boolean, sqlalchemy.sql.sqltypes.Enum

View In Hierarchy

Add capabilities to a type which allow for schema-level DDL to be associated with a type. Supports types that must be explicitly created/dropped (i.e. PG ENUM type) as well as types that are complimented by table or schema level constraints, triggers, and other rules. :class:`.SchemaType` classes can also be targets for the :meth:`.DDLEvents.before_parent_attach` and :meth:`.DDLEvents.after_parent_attach` events, where the events fire off surrounding the association of the type object with a parent :class:`_schema.Column`. .. seealso:: :class:`.Enum` :class:`.Boolean`

Method __init__ Undocumented
Method adapt Undocumented
Method copy Undocumented
Method create Issue CREATE DDL for this type, if applicable.
Method drop Issue DROP DDL for this type, if applicable.
Instance Variable dispatch Undocumented
Instance Variable inherit_schema Undocumented
Instance Variable metadata Undocumented
Instance Variable name Undocumented
Instance Variable schema Undocumented
Method _is_impl_for_variant Undocumented
Method _on_metadata_create Undocumented
Method _on_metadata_drop Undocumented
Method _on_table_create Undocumented
Method _on_table_drop Undocumented
Method _set_parent Associate with this SchemaEvent's parent object.
Method _set_table Undocumented
Method _variant_mapping_for_set_table Undocumented
Class Variable _use_schema_map Undocumented
Instance Variable _create_events Undocumented

Inherited from SchemaEventTarget:

Method _set_parent_with_dispatch Undocumented

Inherited from EventTarget (via SchemaEventTarget):

Class Variable __slots__ Undocumented

Inherited from TypeEngineMixin (via SchemaEventTarget, EventTarget):

Method dialect_impl Undocumented
Property _static_cache_key Undocumented
def __init__(self, name: Optional[str] = None, schema: Optional[str] = None, metadata: Optional[MetaData] = None, inherit_schema: bool = False, quote: Optional[bool] = None, _create_events: bool = True, _adapted_from: Optional[SchemaType] = None): (source)
overridden in sqlalchemy.dialects.postgresql.DOMAIN, sqlalchemy.sql.sqltypes.Boolean, sqlalchemy.sql.sqltypes.Enum

Undocumented

@overload
def adapt(self, cls: Type[_TE], **kw: Any) -> _TE:
@overload
def adapt(self, cls: Type[TypeEngineMixin], **kw: Any) -> TypeEngine[Any]:
(source)
overrides sqlalchemy.sql.type_api.TypeEngineMixin.adapt
overridden in sqlalchemy.sql.sqltypes.Enum

Undocumented

def copy(self, **kw): (source)
overridden in sqlalchemy.sql.sqltypes.Enum

Undocumented

def create(self, bind, checkfirst=False): (source)
overridden in sqlalchemy.dialects.postgresql.ENUM

Issue CREATE DDL for this type, if applicable.

def drop(self, bind, checkfirst=False): (source)
overridden in sqlalchemy.dialects.postgresql.ENUM

Issue DROP DDL for this type, if applicable.

dispatch = (source)
overrides sqlalchemy.sql.base.SchemaEventTarget.dispatch
overridden in sqlalchemy.sql.sqltypes.Boolean

Undocumented

inherit_schema = (source)

Undocumented

metadata = (source)

Undocumented

name = (source)
overridden in sqlalchemy.sql.sqltypes.Boolean

Undocumented

schema = (source)

Undocumented

def _is_impl_for_variant(self, dialect, kw): (source)

Undocumented

def _on_metadata_create(self, target, bind, **kw): (source)

Undocumented

def _on_metadata_drop(self, target, bind, **kw): (source)

Undocumented

def _on_table_create(self, target, bind, **kw): (source)

Undocumented

def _on_table_drop(self, target, bind, **kw): (source)

Undocumented

def _set_parent(self, column, **kw): (source)
overrides sqlalchemy.sql.base.SchemaEventTarget._set_parent

Associate with this SchemaEvent's parent object.

def _set_table(self, column, table): (source)
overridden in sqlalchemy.sql.sqltypes.Boolean, sqlalchemy.sql.sqltypes.Enum

Undocumented

def _variant_mapping_for_set_table(self, column): (source)

Undocumented

_use_schema_map: bool = (source)

Undocumented

_create_events = (source)
overridden in sqlalchemy.sql.sqltypes.Boolean

Undocumented