sqlalchemy.dialects.mysql.ENUM

class documentation

class ENUM(sqltypes.NativeForEmulated, sqltypes.Enum, _StringType): (source)

View In Hierarchy

MySQL ENUM type.

Class Method adapt_emulated_to_native Produce a MySQL native :class:`.mysql.ENUM` from plain :class:`.Enum`.
Method __init__ Construct an ENUM.
Method __repr__ Undocumented
Class Variable __visit_name__ Undocumented
Class Variable native_enum Undocumented
Method _object_value_for_elem Undocumented

Inherited from NativeForEmulated:

Class Method adapt_native_to_emulated Given an impl, adapt this type's class to the impl assuming "emulated".

Inherited from Enum (via NativeForEmulated):

Class Comparator Undocumented
Method adapt Produce an "adapted" form of this type, given an "impl" class to work with.
Method adapt_to_emulated Given an impl class, adapt this type to the impl assuming "emulated".
Method as_generic Return an instance of the generic type corresponding to this type using heuristic rule. The method may be overridden if this heuristic rule is not sufficient.
Method bind_processor Return a conversion function for processing bind values.
Method copy Undocumented
Method literal_processor Return a conversion function for processing literal values that are to be rendered directly without using binds.
Method result_processor Return a conversion function for processing result row values.
Instance Variable create_constraint Undocumented
Instance Variable enum_class Undocumented
Instance Variable enums Undocumented
Instance Variable validate_strings Undocumented
Instance Variable values_callable Undocumented
Property native Undocumented
Property python_type Return the Python type object expected to be returned by instances of this type, if known.
Property sort_key_function A sorting function that can be passed as the key to sorted.
Method _db_value_for_elem Undocumented
Method _enum_init internal init for :class:`.Enum` and subclasses.
Method _make_enum_kw Undocumented
Method _parse_into_values Undocumented
Method _resolve_for_literal adjust this type given a literal Python value that will be stored in a bound parameter.
Method _resolve_for_python_type given a Python type (e.g. ``int``, ``str``, etc. ) return an instance of this :class:`.TypeEngine` that's appropriate for this type.
Method _set_table Undocumented
Method _setup_for_values Undocumented
Method _should_create_constraint Undocumented
Instance Variable _default_length Undocumented
Instance Variable _object_lookup Undocumented
Instance Variable _omit_aliases Undocumented
Instance Variable _sort_key_function Undocumented
Instance Variable _valid_lookup Undocumented
Property _enums_argument Undocumented

Inherited from _StringType (via NativeForEmulated, Enum):

Instance Variable ascii Undocumented
Instance Variable binary Undocumented
Instance Variable charset Undocumented
Instance Variable national Undocumented
Instance Variable unicode Undocumented

Inherited from String (via NativeForEmulated, Enum, _StringType):

Method get_dbapi_type Return the corresponding type object from the underlying DB-API, if any.
Instance Variable collation Undocumented
Instance Variable length Undocumented

Inherited from SchemaType (via NativeForEmulated, Enum, _StringType, String, Concatenable):

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 _variant_mapping_for_set_table Undocumented
Class Variable _use_schema_map Undocumented
Instance Variable _create_events Undocumented

Inherited from SchemaEventTarget (via NativeForEmulated, Enum, _StringType, String, Concatenable, SchemaType):

Method _set_parent_with_dispatch Undocumented

Inherited from EventTarget (via NativeForEmulated, Enum, _StringType, String, Concatenable, SchemaType, SchemaEventTarget):

Class Variable __slots__ Undocumented

Inherited from TypeEngineMixin (via NativeForEmulated, Enum, _StringType, String, Concatenable, SchemaType, SchemaEventTarget, EventTarget, Emulated):

Method dialect_impl Undocumented
Property _static_cache_key Undocumented

Inherited from TypeEngine (via NativeForEmulated, Enum, _StringType, String, Concatenable, SchemaType, SchemaEventTarget, EventTarget, Emulated, TypeEngineMixin):

Method __str__ Undocumented
Method bind_expression Given a bind value (i.e. a :class:`.BindParameter` instance), return a SQL expression in its place.
Method coerce_compared_value Suggest a type for a 'coerced' Python value in an expression.
Method column_expression Given a SELECT column expression, return a wrapping SQL expression.
Method compare_against_backend Compare this type against the given backend type.
Method compare_values Compare two values for equality.
Method compile Produce a string-compiled form of this :class:`.TypeEngine`.
Method copy_value Undocumented
Method evaluates_none Return a copy of this type which has the :attr:`.should_evaluate_none` flag set to True.
Method with_variant Produce a copy of this type object that will utilize the given type when applied to the dialect of the given name.
Class Variable hashable Flag, if False, means values from this type aren't hashable.
Class Variable render_bind_cast Render bind casts for :attr:`.BindTyping.RENDER_CASTS` mode.
Class Variable render_literal_cast render casts when rendering a value as an inline literal, e.g. with :meth:`.TypeEngine.literal_processor`.
Class Variable should_evaluate_none If True, the Python constant ``None`` is considered to be handled explicitly by this type.
Static Method _to_instance Undocumented
Method _cached_bind_processor Return a dialect-specific bind processor for this type.
Method _cached_custom_processor return a dialect-specific processing object for custom purposes.
Method _cached_literal_processor Return a dialect-specific literal processor for this type.
Method _cached_result_processor Return a dialect-specific result processor for this type.
Method _compare_type_affinity Undocumented
Method _default_dialect Undocumented
Method _dialect_info Return a dialect-specific registry which caches a dialect-specific implementation, bind processing function, and one or more result processing functions.
Method _gen_dialect_impl Undocumented
Method _unwrapped_dialect_impl Return the 'unwrapped' dialect impl for this type.
Class Variable _is_array Undocumented
Class Variable _is_table_value Undocumented
Class Variable _is_tuple_type Undocumented
Class Variable _is_type_decorator Undocumented
Class Variable _isnull Undocumented
Class Variable _sqla_type Undocumented
Property _generic_type_affinity Undocumented
Property _has_bind_expression memoized boolean, check if bind_expression is implemented.
Property _has_column_expression memoized boolean, check if column_expression is implemented.
Property _type_affinity Return a rudimental 'affinity' value expressing the general class of type.

Inherited from Visitable (via NativeForEmulated, Enum, _StringType, String, Concatenable, SchemaType, SchemaEventTarget, EventTarget, Emulated, TypeEngineMixin, TypeEngine):

Method __class_getitem__ Undocumented
Method __init_subclass__ Undocumented
Class Method _generate_compiler_dispatch Undocumented
Method _compiler_dispatch Undocumented
Class Variable _original_compiler_dispatch Undocumented
@classmethod
def adapt_emulated_to_native(cls, impl, **kw): (source)
overrides sqlalchemy.sql.type_api.NativeForEmulated.adapt_emulated_to_native

Produce a MySQL native :class:`.mysql.ENUM` from plain :class:`.Enum`.

def __init__(self, *enums, **kw): (source)
overrides sqlalchemy.sql.sqltypes.Enum.__init__

Construct an ENUM. E.g.:: Column('myenum', ENUM("foo", "bar", "baz")) :param enums: The range of valid values for this ENUM. Values in enums are not quoted, they will be escaped and surrounded by single quotes when generating the schema. This object may also be a PEP-435-compliant enumerated type. .. versionadded: 1.1 added support for PEP-435-compliant enumerated types. :param strict: This flag has no effect. .. versionchanged:: The MySQL ENUM type as well as the base Enum type now validates all Python data values. :param charset: Optional, a column-level character set for this string value. Takes precedence to 'ascii' or 'unicode' short-hand. :param collation: Optional, a column-level collation for this string value. Takes precedence to 'binary' short-hand. :param ascii: Defaults to False: short-hand for the ``latin1`` character set, generates ASCII in schema. :param unicode: Defaults to False: short-hand for the ``ucs2`` character set, generates UNICODE in schema. :param binary: Defaults to False: short-hand, pick the binary collation type that matches the column's character set. Generates BINARY in schema. This does not affect the type of data stored, only the collation of character data.

def __repr__(self): (source)
overrides sqlalchemy.sql.sqltypes.Enum.__repr__

Undocumented

__visit_name__: str = (source)
overrides sqlalchemy.sql.sqltypes.Enum.__visit_name__

Undocumented

native_enum: bool = (source)
overrides sqlalchemy.sql.sqltypes.Enum.native_enum

Undocumented

def _object_value_for_elem(self, elem): (source)
overrides sqlalchemy.sql.sqltypes.Enum._object_value_for_elem

Undocumented