sqlalchemy.dialects.postgresql.DOMAIN

class documentation

class DOMAIN(NamedType, sqltypes.SchemaType): (source)

View In Hierarchy

Represent the DOMAIN PostgreSQL type. A domain is essentially a data type with optional constraints that restrict the allowed set of values. E.g.:: PositiveInt = Domain( "pos_int", Integer, check="VALUE > 0", not_null=True ) UsPostalCode = Domain( "us_postal_code", Text, check="VALUE ~ '^\d{5}$' OR VALUE ~ '^\d{5}-\d{4}$'" ) See the `PostgreSQL documentation`__ for additional details __ https://www.postgresql.org/docs/current/sql-createdomain.html .. versionadded:: 2.0

Class Method __test_init__ Undocumented
Method __init__ Construct a DOMAIN.
Class Variable __visit_name__ Undocumented
Instance Variable check Undocumented
Instance Variable collation Undocumented
Instance Variable constraint_name Undocumented
Instance Variable create_type Undocumented
Instance Variable data_type Undocumented
Instance Variable default Undocumented
Instance Variable not_null Undocumented

Inherited from NamedType:

Method create Emit ``CREATE`` DDL for this type.
Method drop Emit ``DROP`` DDL for this type.
Class Variable __abstract__ Undocumented
Class Variable DDLDropper Undocumented
Class Variable DDLGenerator Undocumented
Method _check_for_name_in_memos Look in the 'ddl runner' for 'memos', then note our name in that collection.
Method _on_metadata_create Undocumented
Method _on_metadata_drop Undocumented
Method _on_table_create Undocumented
Method _on_table_drop Undocumented

Inherited from TypeEngine (via NamedType):

Class Comparator Base class for custom comparison operations defined at the type level. See :attr:`.TypeEngine.comparator_factory`.
Method __repr__ Undocumented
Method __str__ Undocumented
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 :class:`.BindParameter` instance), return a SQL expression in its place.
Method bind_processor Return a conversion function for processing bind values.
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 :class:`.TypeEngine`.
Method copy Undocumented
Method copy_value Undocumented
Method dialect_impl Return a dialect-specific implementation for this :class:`.TypeEngine`.
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 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 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 hashable Flag, if False, means values from this type aren't hashable.
Class Variable render_bind_cast Render bind casts for :attr:`.BindTyping.RENDER_CASTS` mode.
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.
Property python_type Return the Python type object expected to be returned by instances of this type, if known.
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_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 Visitable (via NamedType, TypeEngine):

Method __class_getitem__ Undocumented
Method __init_subclass__ Undocumented
Class Variable __slots__ Undocumented
Class Method _generate_compiler_dispatch Undocumented
Method _compiler_dispatch Undocumented
Class Variable _original_compiler_dispatch Undocumented

Inherited from SchemaType (via NamedType, TypeEngine, Visitable):

Instance Variable dispatch Undocumented
Instance Variable inherit_schema Undocumented
Instance Variable metadata Undocumented
Instance Variable name Undocumented
Instance Variable schema Undocumented
Method _is_impl_for_variant Undocumented
Method _set_parent Associate with this SchemaEvent's parent object.
Method _set_table Undocumented
Method _variant_mapping_for_set_table Undocumented
Class Variable _use_schema_map Undocumented
Instance Variable _create_events Undocumented

Inherited from SchemaEventTarget (via NamedType, TypeEngine, Visitable, SchemaType):

Method _set_parent_with_dispatch Undocumented
@classmethod
def __test_init__(cls): (source)

Undocumented

def __init__(self, name: str, data_type: _TypeEngineArgument[Any], *, collation: Optional[str] = None, default: Optional[Union[str, elements.TextClause]] = None, constraint_name: Optional[str] = None, not_null: Optional[bool] = None, check: Optional[str] = None, create_type: bool = True, **kw: Any): (source)
overrides sqlalchemy.sql.sqltypes.SchemaType.__init__

Construct a DOMAIN. :param name: the name of the domain :param data_type: The underlying data type of the domain. This can include array specifiers. :param collation: An optional collation for the domain. If no collation is specified, the underlying data type's default collation is used. The underlying type must be collatable if ``collation`` is specified. :param default: The DEFAULT clause specifies a default value for columns of the domain data type. The default should be a string or a :func:`_expression.text` value. If no default value is specified, then the default value is the null value. :param constraint_name: An optional name for a constraint. If not specified, the backend generates a name. :param not_null: Values of this domain are prevented from being null. By default domain are allowed to be null. If not specified no nullability clause will be emitted. :param check: CHECK clause specify integrity constraint or test which values of the domain must satisfy. A constraint must be an expression producing a Boolean result that can use the key word VALUE to refer to the value being tested. Differently from PostgreSQL, only a single check clause is currently allowed in SQLAlchemy. :param schema: optional schema name :param metadata: optional :class:`_schema.MetaData` object which this :class:`_postgresql.DOMAIN` will be directly associated :param create_type: Defaults to True. Indicates that ``CREATE TYPE`` should be emitted, after optionally checking for the presence of the type, when the parent table is being created; and additionally that ``DROP TYPE`` is called when the table is dropped.

__visit_name__: str = (source)
overrides sqlalchemy.sql.visitors.Visitable.__visit_name__

Undocumented

check = (source)

Undocumented

collation = (source)

Undocumented

constraint_name = (source)

Undocumented

create_type = (source)
overrides sqlalchemy.dialects.postgresql.NamedType.create_type

Undocumented

data_type = (source)

Undocumented

default = (source)

Undocumented

not_null = (source)

Undocumented