ConstraintEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)Constraint is not used as an independent entity, it is retrieved as part of another entity such as Table or View.
Attributes | |
|---|---|
| Name | Description |
name |
str
The name of the table constraint. |
type_ |
str
Type of constraint, for example unique, primary key, foreign key (currently only primary key is supported). |
table_columns |
MutableSequence[str]
Table columns used as part of the Constraint, for example primary key constraint should list the columns which constitutes the key. |
custom_features |
google.protobuf.struct_pb2.Struct
Custom engine specific features. |
reference_columns |
MutableSequence[str]
Reference columns which may be associated with the constraint. For example, if the constraint is a FOREIGN_KEY, this represents the list of full names of referenced columns by the foreign key. |
reference_table |
str
Reference table which may be associated with the constraint. For example, if the constraint is a FOREIGN_KEY, this represents the list of full name of the referenced table by the foreign key. |
table_name |
str
Table which is associated with the constraint. In case the constraint is defined on a table, this field is left empty as this information is stored in parent_name. However, if constraint is defined on a view, this field stores the table name on which the view is defined. |