sqlalchemy.sql.schema.ColumnCollectionConstraint

class documentation

class ColumnCollectionConstraint(ColumnCollectionMixin, Constraint):

Known subclasses: sqlalchemy.dialects.postgresql.ExcludeConstraint, sqlalchemy.sql.schema.CheckConstraint, sqlalchemy.sql.schema.ForeignKeyConstraint, sqlalchemy.sql.schema.PrimaryKeyConstraint, sqlalchemy.sql.schema.UniqueConstraint

View In Hierarchy

A constraint that proxies a ColumnCollection.

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

Inherited from ColumnCollectionMixin:

Method	`_check_attach`	Undocumented
Method	`_col_expressions`	Undocumented
Class Variable	`_allow_multiple_tables`	Undocumented
Instance Variable	`_cols_wo_table`	Undocumented
Instance Variable	`_column_flag`	Undocumented
Instance Variable	`_pending_colargs`	Undocumented

Inherited from Constraint:

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

Inherited from DialectKWArgs (via Constraint):

Class Method	`argument_for`	Add a new kind of dialect-specific keyword argument for this class.
Method	`_kw_reg_for_dialect_cls`	Undocumented
Method	`_validate_dialect_kwargs`	Undocumented
Class Variable	`_dialect_kwargs_traverse_internals`	Undocumented
Class Variable	`_kw_registry`	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 `.DialectKWArgs.dialect_kwargs`.

Inherited from SchemaItem (via Constraint):

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

Inherited from SchemaEventTarget (via Constraint, SchemaItem):

Method _set_parent_with_dispatch Undocumented

Inherited from Traversible (via Constraint, SchemaItem):

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

def __contains__(self, x):

Undocumented

def __init__(self, *columns, **kw):

overrides sqlalchemy.sql.schema.ColumnCollectionMixin.__init__

overridden in sqlalchemy.dialects.postgresql.ExcludeConstraint, sqlalchemy.sql.schema.CheckConstraint, sqlalchemy.sql.schema.ForeignKeyConstraint, sqlalchemy.sql.schema.PrimaryKeyConstraint

Parameters
*columns	A sequence of column names or Column objects.
**kw	other keyword arguments including dialect-specific arguments are propagated to the `.Constraint` superclass.
name	Optional, the in-database name of this constraint.
deferrable	Optional bool. If set, emit DEFERRABLE or NOT DEFERRABLE when issuing DDL for this constraint.
initially	Optional string. If set, emit INITIALLY <value> when issuing DDL for this constraint.

def __iter__(self):

Undocumented

def __len__(self):

Undocumented

def _copy(self, target_table=None, **kw):

overrides sqlalchemy.sql.schema.Constraint._copy

overridden in sqlalchemy.dialects.postgresql.ExcludeConstraint, sqlalchemy.sql.schema.CheckConstraint, sqlalchemy.sql.schema.ForeignKeyConstraint

Undocumented

def _set_parent(self, table, **kw):

overrides sqlalchemy.sql.schema.ColumnCollectionMixin._set_parent

overridden in sqlalchemy.dialects.postgresql.ExcludeConstraint, sqlalchemy.sql.schema.ForeignKeyConstraint, sqlalchemy.sql.schema.PrimaryKeyConstraint

Associate with this SchemaEvent's parent object.

def contains_column(self, col):

Return True if this constraint contains the given column.

Note that this object also contains an attribute .columns which is a _expression.ColumnCollection of _schema.Column objects.

@util.deprecated('1.4', 'The :meth:`_schema.ColumnCollectionConstraint.copy` method is deprecated and will be removed in a future release.')
def copy(self, target_table=None, **kw):

overrides sqlalchemy.sql.schema.Constraint.copy

overridden in sqlalchemy.sql.schema.CheckConstraint, sqlalchemy.sql.schema.ForeignKeyConstraint

Undocumented

columns =

overrides sqlalchemy.sql.schema.ColumnCollectionMixin.columns

overridden in sqlalchemy.sql.schema.ForeignKeyConstraint

A _expression.ColumnCollection representing the set of columns for this constraint.