class documentation

class _PsycopgARRAY(PGARRAY): (source)

View In Hierarchy

Undocumented

Class Variable render_bind_cast Render bind casts for :attr:`.BindTyping.RENDER_CASTS` mode.

Inherited from ARRAY:

Class Comparator Define comparison operations for :class:`_types.ARRAY`.
Method __init__ Construct an ARRAY.
Method bind_processor Return a conversion function for processing bind values.
Method compare_values Compare two values for equality.
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 as_tuple Undocumented
Instance Variable dimensions Undocumented
Instance Variable item_type Undocumented
Instance Variable zero_indexes If True, Python zero-based indexes should be interpreted as one-based on the SQL expression side.
Property hashable Flag, if False, means values from this type aren't hashable.
Property python_type Return the Python type object expected to be returned by instances of this type, if known.
Property _against_native_enum Undocumented

Inherited from ARRAY (via ARRAY):

Class Variable __visit_name__ Undocumented
Method _apply_item_processor Helper method that can be used by bind_processor(), literal_processor(), etc. to apply an item processor to elements of an array value, taking into account the 'dimensions' for this array type.
Method _set_parent Support SchemaEventTarget
Method _set_parent_with_dispatch Support SchemaEventTarget
Class Variable _is_array Undocumented

Inherited from SchemaEventTarget (via ARRAY, ARRAY):

Class Variable dispatch Undocumented

Inherited from EventTarget (via ARRAY, ARRAY, SchemaEventTarget):

Class Variable __slots__ Undocumented

Inherited from TypeEngineMixin (via ARRAY, ARRAY, SchemaEventTarget, EventTarget, Indexable, Concatenable):

Method adapt Undocumented
Method dialect_impl Undocumented
Property _static_cache_key Undocumented

Inherited from TypeEngine (via ARRAY, ARRAY, SchemaEventTarget, EventTarget, Indexable, Concatenable, TypeEngineMixin):

Method __repr__ Undocumented
Method __str__ Undocumented
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 :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 compile Produce a string-compiled form of this :class:`.TypeEngine`.
Method copy Undocumented
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 get_dbapi_type Return the corresponding type object from the underlying DB-API, if any.
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 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.
Class Variable sort_key_function A sorting function that can be passed as the key to sorted.
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 _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 _unwrapped_dialect_impl Return the 'unwrapped' dialect impl for this type.
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 ARRAY, ARRAY, SchemaEventTarget, EventTarget, Indexable, Concatenable, 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
render_bind_cast: bool = (source)

Render bind casts for :attr:`.BindTyping.RENDER_CASTS` mode. If True, this type (usually a dialect level impl type) signals to the compiler that a cast should be rendered around a bound parameter for this type. .. versionadded:: 2.0 .. seealso:: :class:`.BindTyping`