sqlalchemy.engine.interfaces.ReflectedForeignKeyConstraint

class documentation

class ReflectedForeignKeyConstraint(ReflectedConstraint): (source)

Dictionary representing the reflected elements corresponding to :class:`.ForeignKeyConstraint`. The :class:`.ReflectedForeignKeyConstraint` structure is returned by the :meth:`.Inspector.get_foreign_keys` method.

Class Variable	`constrained_columns`	local column names which comprise the foreign key
Class Variable	`options`	Additional options detected for this foreign key constraint
Class Variable	`referred_columns`	referred column names that correspond to ``constrained_columns``
Class Variable	`referred_schema`	schema name of the table being referred
Class Variable	`referred_table`	name of the table being referred

Inherited from ReflectedConstraint:

Class Variable	`comment`	comment for the constraint, if present
Class Variable	`name`	constraint name

constrained_columns: List[str] = (source) ¶

local column names which comprise the foreign key

options: NotRequired[Dict[str, Any]] = (source) ¶

Additional options detected for this foreign key constraint

referred_columns: List[str] = (source) ¶

referred column names that correspond to ``constrained_columns``

referred_schema: Optional[str] = (source) ¶

schema name of the table being referred

referred_table: str = (source) ¶

name of the table being referred