sqlalchemy.sql.sqltypes.MatchType

class documentation

class MatchType(Boolean):

Known subclasses: sqlalchemy.dialects.mysql.types._MatchType

View In Hierarchy

Refers to the return type of the MATCH operator.

As the .ColumnOperators.match is probably the most open-ended operator in generic SQLAlchemy Core, we can't assume the return type at SQL evaluation time, as MySQL returns a floating point, not a boolean, and other backends might do something different. So this type acts as a placeholder, currently subclassing .Boolean. The type allows dialects to inject result-processing functionality if needed, and on MySQL will return floating-point values.

New in version 1.0.0.

Inherited from Boolean:

Method __init__ Construct a Boolean.
Method bind​_processor Return a conversion function for processing bind values.
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.
Method ​_set​_table Undocumented
Method ​_should​_create​_constraint Undocumented
Method ​_strict​_as​_bool Undocumented
Class Variable __visit​_name__ Undocumented
Class Variable ​_strict​_bools Undocumented
Class Variable native Undocumented
Instance Variable ​_create​_events Undocumented
Instance Variable create​_constraint Undocumented
Instance Variable name Undocumented
Property python​_type Return the Python type object expected to be returned by instances of this type, if known.

Inherited from Emulated (via Boolean):

Method adapt Undocumented
Method adapt​_to​_emulated Given an impl class, adapt this type to the impl assuming "emulated".

Inherited from TypeEngine (via Boolean):

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 get​_dbapi​_type Return the corresponding type object from the underlying DB-API, if any.
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 __repr__ 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 Boolean, TypeEngine):

Method get​_children Return immediate child .visitors.Traversible elements of this .visitors.Traversible.
Method __class​_getitem__ Undocumented

Inherited from SchemaType (via Boolean):

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 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 inherit​_schema Undocumented
Instance Variable metadata Undocumented
Instance Variable schema Undocumented
Property bind Undocumented

Inherited from SchemaEventTarget (via Boolean, SchemaType):

Method ​_set​_parent​_with​_dispatch Undocumented