sqlalchemy.dialects.mysql.enumerated.ENUM

class documentation

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

MySQL ENUM type.

Class Method	`adapt_emulated_to_native`	Produce a MySQL native `.mysql.ENUM` from plain `.Enum`.
Method	`__init__`	Construct an ENUM.
Method	`__repr__`	Undocumented
Method	`_object_value_for_elem`	Undocumented
Class Variable	`__visit_name__`	Undocumented
Class Variable	`native_enum`	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:

Class	`Comparator`	Undocumented
Method	`_db_value_for_elem`	Undocumented
Method	`_enum_init`	internal init for `.Enum` and subclasses.
Method	`_parse_into_values`	Undocumented
Method	`_set_table`	Undocumented
Method	`_setup_for_values`	Undocumented
Method	`_should_create_constraint`	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	`_object_lookup`	Undocumented
Instance Variable	`_omit_aliases`	Undocumented
Instance Variable	`_sort_key_function`	Undocumented
Instance Variable	`_valid_lookup`	Undocumented
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	`_enums_argument`	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.

Inherited from String (via Enum):

Method	`get_dbapi_type`	Return the corresponding type object from the underlying DB-API, if any.
Constant	`RETURNS_BYTES`	Undocumented
Constant	`RETURNS_CONDITIONAL`	Undocumented
Constant	`RETURNS_UNICODE`	Undocumented
Constant	`RETURNS_UNKNOWN`	Undocumented
Class Method	`_warn_deprecated_unicode`	Undocumented
Instance Variable	`_expect_unicode`	Undocumented
Instance Variable	`_expect_unicode_error`	Undocumented
Instance Variable	`_warn_on_bytestring`	Undocumented
Instance Variable	`collation`	Undocumented
Instance Variable	`length`	Undocumented

Inherited from TypeEngine (via Enum, String):

Method	`bind_expression`	Given a bind value (i.e. a `.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 `.TypeEngine`.
Method	`dialect_impl`	Return a dialect-specific implementation for this `.TypeEngine`.
Method	`evaluates_none`	Return a copy of this type which has the `.should_evaluate_none` flag set to True.
Method	`with_variant`	Produce a new 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	`should_evaluate_none`	If True, the Python constant `None` is considered to be handled explicitly by this type.
Static Method	`_to_instance`	Undocumented
Method	`__str__`	Undocumented
Method	`_cached_bind_processor`	Return a dialect-specific bind processor for this type.
Method	`_cached_custom_processor`	Undocumented
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	`_resolve_for_literal`	adjust this type given a literal Python value that will be stored in a bound parameter.
Method	`_unwrapped_dialect_impl`	Return the 'unwrapped' dialect impl for this type.
Method	`copy_value`	Undocumented
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	`_static_cache_key`	Undocumented
Property	`_type_affinity`	Return a rudimental 'affinity' value expressing the general class of type.

Inherited from Traversible (via Enum, String, TypeEngine):

Method	`get_children`	Return immediate child `.visitors.Traversible` elements of this `.visitors.Traversible`.
Method	`__class_getitem__`	Undocumented

Inherited from SchemaType (via Enum):

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
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 (via Enum, SchemaType):

Method _set_parent_with_dispatch Undocumented

Inherited from _StringType:

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

Inherited from String (via _StringType):

Method	`bind_processor`	Return a conversion function for processing bind values.
Method	`get_dbapi_type`	Return the corresponding type object from the underlying DB-API, if any.
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.
Constant	`RETURNS_BYTES`	Undocumented
Constant	`RETURNS_CONDITIONAL`	Undocumented
Constant	`RETURNS_UNICODE`	Undocumented
Constant	`RETURNS_UNKNOWN`	Undocumented
Class Method	`_warn_deprecated_unicode`	Undocumented
Instance Variable	`_expect_unicode`	Undocumented
Instance Variable	`_expect_unicode_error`	Undocumented
Instance Variable	`_warn_on_bytestring`	Undocumented
Instance Variable	`collation`	Undocumented
Instance Variable	`length`	Undocumented
Property	`python_type`	Return the Python type object expected to be returned by instances of this type, if known.

Inherited from Concatenable (via _StringType, String):

Class Comparator Undocumented

Inherited from TypeEngine (via _StringType, String):

Class	`Comparator`	Base class for custom comparison operations defined at the type level. See `.TypeEngine.comparator_factory`.
Method	`adapt`	Produce an "adapted" form of this type, given an "impl" class to work with.
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_expression`	Given a bind value (i.e. a `.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 `.TypeEngine`.
Method	`dialect_impl`	Return a dialect-specific implementation for this `.TypeEngine`.
Method	`evaluates_none`	Return a copy of this type which has the `.should_evaluate_none` flag set to True.
Method	`with_variant`	Produce a new 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	`should_evaluate_none`	If True, the Python constant `None` is considered to be handled explicitly by this type.
Class Variable	`sort_key_function`	A sorting function that can be passed as the key to sorted.
Static Method	`_to_instance`	Undocumented
Method	`__str__`	Undocumented
Method	`_cached_bind_processor`	Return a dialect-specific bind processor for this type.
Method	`_cached_custom_processor`	Undocumented
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	`_resolve_for_literal`	adjust this type given a literal Python value that will be stored in a bound parameter.
Method	`_unwrapped_dialect_impl`	Return the 'unwrapped' dialect impl for this type.
Method	`copy`	Undocumented
Method	`copy_value`	Undocumented
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	`_static_cache_key`	Undocumented
Property	`_type_affinity`	Return a rudimental 'affinity' value expressing the general class of type.

Inherited from Traversible (via _StringType, String, TypeEngine):

Method	`get_children`	Return immediate child `.visitors.Traversible` elements of this `.visitors.Traversible`.
Method	`__class_getitem__`	Undocumented

@classmethod
def adapt_emulated_to_native(cls, impl, **kw):

overrides sqlalchemy.sql.type_api.NativeForEmulated.adapt_emulated_to_native

Produce a MySQL native .mysql.ENUM from plain .Enum.

def __init__(self, *enums, **kw):

overrides sqlalchemy.types.Enum.__init__

Construct an ENUM.

E.g.:

Column('myenum', ENUM("foo", "bar", "baz"))

Parameters
*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.
**kw	Undocumented
strict	This flag has no effect. Changed in version The: MySQL ENUM type as well as the base Enum type now validates all Python data values.
charset	Optional, a column-level character set for this string value. Takes precedence to 'ascii' or 'unicode' short-hand.
collation	Optional, a column-level collation for this string value. Takes precedence to 'binary' short-hand.
ascii	Defaults to False: short-hand for the `latin1` character set, generates ASCII in schema.
unicode	Defaults to False: short-hand for the `ucs2` character set, generates UNICODE in schema.
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.
quoting	Not used. A warning will be raised if provided.

def __repr__(self):

overrides sqlalchemy.types.Enum.__repr__

Undocumented

def _object_value_for_elem(self, elem):

overrides sqlalchemy.types.Enum._object_value_for_elem

Undocumented

__visit_name__: str =

overrides sqlalchemy.types.Enum.__visit_name__

Undocumented

native_enum: bool =

overrides sqlalchemy.types.Enum.native_enum

Undocumented