sqlalchemy.sql.schema.CheckConstraint

class documentation

class CheckConstraint(ColumnCollectionConstraint): (source)

View In Hierarchy

A table- or column-level CHECK constraint. Can be included in the definition of a Table or Column.

Method __init__ Construct a CHECK constraint.
Method copy Undocumented
Class Variable __visit_name__ Undocumented
Instance Variable sqltext Undocumented
Property is_column_level Undocumented
Method _copy Undocumented
Class Variable _allow_multiple_tables Undocumented

Inherited from ColumnCollectionConstraint:

Method __contains__ Undocumented
Method __iter__ Undocumented
Method __len__ Undocumented
Method contains_column Return True if this constraint contains the given column.
Class Variable columns A :class:`_expression.ColumnCollection` representing the set of columns for this constraint.
Method _set_parent Associate with this SchemaEvent's parent object.

Inherited from ColumnCollectionMixin (via ColumnCollectionConstraint):

Property c Undocumented
Method _check_attach Undocumented
Method _col_expressions Undocumented
Method _set_parent_with_dispatch Undocumented
Instance Variable _cols_wo_table Undocumented
Instance Variable _column_flag Undocumented
Instance Variable _columns Undocumented
Instance Variable _pending_colargs Undocumented

Inherited from Constraint (via ColumnCollectionConstraint, ColumnCollectionMixin):

Instance Variable comment Undocumented
Instance Variable deferrable Undocumented
Instance Variable info Info dictionary associated with the object, allowing user-defined data to be associated with this :class:`.SchemaItem`.
Instance Variable initially Undocumented
Instance Variable name Undocumented
Instance Variable parent Undocumented
Property table Undocumented
Method _should_create_for_compiler Undocumented
Class Variable _creation_order Undocumented
Instance Variable _create_rule Undocumented
Instance Variable _type_bound Undocumented

Inherited from DialectKWArgs (via ColumnCollectionConstraint, ColumnCollectionMixin, Constraint):

Class Method argument_for Add a new kind of dialect-specific keyword argument for this class.
Class Variable __slots__ Undocumented
Property dialect_kwargs A collection of keyword arguments specified as dialect-specific options to this construct.
Property dialect_options A collection of keyword arguments specified as dialect-specific options to this construct.
Property kwargs A synonym for :attr:`.DialectKWArgs.dialect_kwargs`.
Method _kw_reg_for_dialect_cls Undocumented
Method _validate_dialect_kwargs Undocumented
Class Variable _dialect_kwargs_traverse_internals Undocumented
Class Variable _kw_registry Undocumented

Inherited from HasConditionalDDL (via ColumnCollectionConstraint, ColumnCollectionMixin, Constraint, DialectKWArgs):

Method ddl_if apply a conditional DDL rule to this schema item.
Instance Variable _ddl_if Undocumented

Inherited from SchemaItem (via ColumnCollectionConstraint, ColumnCollectionMixin, Constraint, DialectKWArgs, HasConditionalDDL):

Method __repr__ Undocumented
Class Variable create_drop_stringify_dialect Undocumented
Method _init_items Initialize the list of child items for this SchemaItem.
Method _schema_item_copy Undocumented
Class Variable _use_schema_map Undocumented

Inherited from SchemaEventTarget (via ColumnCollectionConstraint, ColumnCollectionMixin, Constraint, DialectKWArgs, HasConditionalDDL, SchemaItem):

Class Variable dispatch Undocumented

Inherited from Visitable (via ColumnCollectionConstraint, ColumnCollectionMixin, Constraint, DialectKWArgs, HasConditionalDDL, SchemaItem, SchemaEventTarget, EventTarget):

Method __class_getitem__ Undocumented
Method __init_subclass__ Undocumented
Class Method _generate_compiler_dispatch Undocumented
Method _compiler_dispatch Undocumented
Class Variable _original_compiler_dispatch Undocumented
@_document_text_coercion('sqltext', ':class:`.CheckConstraint`', ':paramref:`.CheckConstraint.sqltext`')
def __init__(self, sqltext: _TextCoercedExpressionArgument[Any], name: _ConstraintNameArgument = None, deferrable: Optional[bool] = None, initially: Optional[str] = None, table: Optional[Table] = None, info: Optional[_InfoType] = None, _create_rule: Optional[Any] = None, _autoattach: bool = True, _type_bound: bool = False, **dialect_kw: Any): (source)
overrides sqlalchemy.sql.schema.ColumnCollectionConstraint.__init__

Construct a CHECK constraint. :param sqltext: A string containing the constraint definition, which will be used verbatim, or a SQL expression construct. If given as a string, the object is converted to a :func:`_expression.text` object. If the textual string includes a colon character, escape this using a backslash:: CheckConstraint(r"foo ~ E'a(?\:b|c)d") :param name: Optional, the in-database name of the constraint. :param deferrable: Optional bool. If set, emit DEFERRABLE or NOT DEFERRABLE when issuing DDL for this constraint. :param initially: Optional string. If set, emit INITIALLY <value> when issuing DDL for this constraint. :param info: Optional data dictionary which will be populated into the :attr:`.SchemaItem.info` attribute of this object. .. versionadded:: 1.0.0

@util.deprecated('1.4', 'The :meth:`_schema.CheckConstraint.copy` method is deprecated and will be removed in a future release.')
def copy(self, *, target_table: Optional[Table] = None, **kw: Any) -> CheckConstraint: (source)
overrides sqlalchemy.sql.schema.ColumnCollectionConstraint.copy

Undocumented

__visit_name__: str = (source)
overrides sqlalchemy.sql.schema.Constraint.__visit_name__

Undocumented

sqltext = (source)

Undocumented

@property
is_column_level: bool = (source)

Undocumented

def _copy(self, *, target_table: Optional[Table] = None, **kw: Any) -> CheckConstraint: (source)
overrides sqlalchemy.sql.schema.ColumnCollectionConstraint._copy

Undocumented

_allow_multiple_tables: bool = (source)
overrides sqlalchemy.sql.schema.ColumnCollectionMixin._allow_multiple_tables

Undocumented