Class ForeignKey (3.18.0)

ForeignKey(
    name: str,
    referenced_table: google.cloud.bigquery.table.TableReference,
    column_references: typing.List[google.cloud.bigquery.table.ColumnReference],
)

Represents a foreign key constraint on a table's columns.

Parameters

NameDescription
name str

Set only if the foreign key constraint is named.

referenced_table TableReference

The table that holds the primary key and is referenced by this foreign key.

column_references typing.List[google.cloud.bigquery.table.ColumnReference]

The columns that compose the foreign key.

Methods

from_api_repr

from_api_repr(
    api_repr: typing.Dict[str, typing.Any]
) -> google.cloud.bigquery.table.ForeignKey

Create an instance from API representation.