sqlalchemy.types.Text

class documentation

class Text(String):

Known subclasses: sqlalchemy.dialects.mssql.XML, sqlalchemy.dialects.oracle.LONG, sqlalchemy.dialects.oracle.NCLOB, sqlalchemy.types.CLOB, sqlalchemy.types.TEXT, sqlalchemy.types.UnicodeText, sqlalchemy.dialects.oracle.cx_oracle._OracleText

View In Hierarchy

A variably sized string type.

In SQL, usually corresponds to CLOB or TEXT. Can also take Python unicode objects and encode to the database's encoding in bind params (and the reverse for result sets.) In general, TEXT objects do not have a length; while some databases will accept a length argument here, it will be rejected by others.

Class Variable __visit_name__ Undocumented

Inherited from String:

Method	`__init__`	Create a string-holding type.
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 String):

Class Comparator Undocumented

Inherited from TypeEngine (via 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	`__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 String, TypeEngine):

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

__visit_name__: str =

overrides sqlalchemy.types.String.__visit_name__

overridden in sqlalchemy.dialects.mssql.XML, sqlalchemy.dialects.oracle.LONG, sqlalchemy.dialects.oracle.NCLOB, sqlalchemy.types.CLOB, sqlalchemy.types.TEXT, sqlalchemy.types.UnicodeText

Undocumented