sqlalchemy.dialects.mysql.enumerated.SET

class documentation

class SET(_StringType):

MySQL SET type.

Method	`__init__`	Construct a SET.
Method	`adapt`	Produce an "adapted" form of this type, given an "impl" class to work with.
Method	`bind_processor`	Return a conversion function for processing bind values.
Method	`column_expression`	Given a SELECT column expression, return a wrapping SQL expression.
Method	`result_processor`	Return a conversion function for processing result row values.
Class Variable	`__visit_name__`	Undocumented
Instance Variable	`_bitmap`	Undocumented
Instance Variable	`retrieve_as_bitwise`	Undocumented
Instance Variable	`values`	Undocumented

Inherited from _StringType:

Method	`__repr__`	Undocumented
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	`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.
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	`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	`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

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

overrides sqlalchemy.dialects.mysql.types._StringType.__init__

Construct a SET.

E.g.:

Column('myset', SET("foo", "bar", "baz"))

The list of potential values is required in the case that this set will be used to generate DDL for a table, or if the :paramref:`.SET.retrieve_as_bitwise` flag is set to True.

Parameters
*values	The range of valid values for this SET. The values are not quoted, they will be escaped and surrounded by single quotes when generating the schema.
**kw	Undocumented
convert_unicode	Same flag as that of :paramref:`.String.convert_unicode`.
collation	same as that of :paramref:`.String.collation`
charset	same as that of :paramref:`.VARCHAR.charset`.
ascii	same as that of :paramref:`.VARCHAR.ascii`.
unicode	same as that of :paramref:`.VARCHAR.unicode`.
binary	same as that of :paramref:`.VARCHAR.binary`.
retrieve_as_bitwise	if True, the data for the set type will be persisted and selected using an integer value, where a set is coerced into a bitwise mask for persistence. MySQL allows this mode which has the advantage of being able to store values unambiguously, such as the blank string `''`. The datatype will appear as the expression `col + 0` in a SELECT statement, so that the value is coerced into an integer value in result sets. This flag is required if one wishes to persist a set that can store the blank string `''` as a value. Warning When using :paramref:`.mysql.SET.retrieve_as_bitwise`, it is essential that the list of set values is expressed in the exact same order as exists on the MySQL database. New in version 1.0.0.
quoting	Not used. A warning will be raised if passed.

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

overrides sqlalchemy.types.TypeEngine.adapt

Produce an "adapted" form of this type, given an "impl" class to work with.

This method is used internally to associate generic types with "implementation" types that are specific to a particular dialect.

def bind_processor(self, dialect):

overrides sqlalchemy.types.String.bind_processor

Return a conversion function for processing bind values.

Returns a callable which will receive a bind parameter value as the sole positional argument and will return a value to send to the DB-API.

If processing is not necessary, the method should return None.

Note

This method is only called relative to a dialect specific type object, which is often private to a dialect in use and is not the same type object as the public facing one, which means it's not feasible to subclass a .types.TypeEngine class in order to provide an alternate _types.TypeEngine.bind_processor method, unless subclassing the _types.UserDefinedType class explicitly.

To provide alternate behavior for _types.TypeEngine.bind_processor, implement a _types.TypeDecorator class and provide an implementation of _types.TypeDecorator.process_bind_param.

See Also

:ref:`types_typedecorator`

Parameters
dialect	Dialect instance in use.

def column_expression(self, colexpr):

overrides sqlalchemy.types.TypeEngine.column_expression

Given a SELECT column expression, return a wrapping SQL expression.

This is typically a SQL function that wraps a column expression as rendered in the columns clause of a SELECT statement. It is used for special data types that require columns to be wrapped in some special database function in order to coerce the value before being sent back to the application. It is the SQL analogue of the .TypeEngine.result_processor method.

This method is called during the SQL compilation phase of a statement, when rendering a SQL string. It is not called against specific values.

Note

This method is only called relative to a dialect specific type object, which is often private to a dialect in use and is not the same type object as the public facing one, which means it's not feasible to subclass a .types.TypeEngine class in order to provide an alternate _types.TypeEngine.column_expression method, unless subclassing the _types.UserDefinedType class explicitly.

To provide alternate behavior for _types.TypeEngine.column_expression, implement a _types.TypeDecorator class and provide an implementation of _types.TypeDecorator.column_expression.

See Also

:ref:`types_typedecorator`

See Also

:ref:`types_sql_value_processing`

def result_processor(self, dialect, coltype):

overrides sqlalchemy.types.String.result_processor

Return a conversion function for processing result row values.

Returns a callable which will receive a result row column value as the sole positional argument and will return a value to return to the user.

If processing is not necessary, the method should return None.

Note

This method is only called relative to a dialect specific type object, which is often private to a dialect in use and is not the same type object as the public facing one, which means it's not feasible to subclass a .types.TypeEngine class in order to provide an alternate _types.TypeEngine.result_processor method, unless subclassing the _types.UserDefinedType class explicitly.

To provide alternate behavior for _types.TypeEngine.result_processor, implement a _types.TypeDecorator class and provide an implementation of _types.TypeDecorator.process_result_value.

See Also

:ref:`types_typedecorator`

Parameters
dialect	Dialect instance in use.
coltype	DBAPI coltype argument received in cursor.description.

__visit_name__: str =

overrides sqlalchemy.types.String.__visit_name__

Undocumented

_bitmap =

Undocumented

retrieve_as_bitwise =

Undocumented

values =

Undocumented