sqlalchemy.sql.sqltypes.SchemaType

class documentation

class SchemaType(SchemaEventTarget):

Known subclasses: sqlalchemy.types.Boolean, sqlalchemy.types.Enum

Mark a type as possibly requiring schema-level DDL for usage.

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.

.SchemaType classes can also be targets for the .DDLEvents.before_parent_attach and .DDLEvents.after_parent_attach events, where the events fire off surrounding the association of the type object with a parent _schema.Column.

See Also

.Enum

.Boolean

Method	`__init__`	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
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.
Class Variable	`_use_schema_map`	Undocumented
Instance Variable	`_create_events`	Undocumented
Instance Variable	`inherit_schema`	Undocumented
Instance Variable	`metadata`	Undocumented
Instance Variable	`name`	Undocumented
Instance Variable	`schema`	Undocumented
Property	`bind`	Undocumented

Inherited from SchemaEventTarget:

Method _set_parent_with_dispatch Undocumented

def __init__(self, name=None, schema=None, metadata=None, inherit_schema=False, quote=None, _create_events=True):

overridden in sqlalchemy.types.Boolean, sqlalchemy.types.Enum

Undocumented

def _is_impl_for_variant(self, dialect, kw):

Undocumented

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

overridden in sqlalchemy.dialects.postgresql.ENUM

Undocumented

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

overridden in sqlalchemy.dialects.postgresql.ENUM

Undocumented

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

overridden in sqlalchemy.dialects.postgresql.ENUM

Undocumented

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

overridden in sqlalchemy.dialects.postgresql.ENUM

Undocumented

def _set_parent(self, column, **kw):

overrides sqlalchemy.sql.base.SchemaEventTarget._set_parent

Associate with this SchemaEvent's parent object.

def _set_table(self, column, table):

overridden in sqlalchemy.types.Boolean, sqlalchemy.types.Enum

Undocumented

def _variant_mapping_for_set_table(self, column):

Undocumented

def adapt(self, impltype, **kw):

overridden in sqlalchemy.types.Enum

Undocumented

def copy(self, **kw):

overridden in sqlalchemy.types.Enum

Undocumented

def create(self, bind=None, checkfirst=False):

overridden in sqlalchemy.dialects.postgresql.ENUM

Issue CREATE DDL for this type, if applicable.

def drop(self, bind=None, checkfirst=False):

overridden in sqlalchemy.dialects.postgresql.ENUM

Issue DROP DDL for this type, if applicable.

_use_schema_map: bool =

Undocumented

_create_events =

overridden in sqlalchemy.types.Boolean

Undocumented

inherit_schema =

Undocumented

metadata =

Undocumented

name =

overridden in sqlalchemy.types.Boolean

Undocumented

schema =

Undocumented

@property
bind =

Undocumented