snowflake.core.table.ForeignKey¶

class snowflake.core.table.ForeignKey(*, name: Annotated[str, Strict(strict=True)] | None = None, column_names: List[Annotated[str, Strict(strict=True)]] | None = None, referenced_table_name: Annotated[str, Strict(strict=True)], referenced_column_names: List[Annotated[str, Strict(strict=True)]])¶

Bases: Constraint

A model object representing the ForeignKey resource.

Constructs an object of type ForeignKey with the provided properties.

Parameters:

• referenced_table_name (str)

• referenced_column_names (list[str])

• name (str, optional) – Name of the Constraint

• column_names (list[str], optional)

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

classmethod from_dict(obj: dict) → ForeignKey¶

Create an instance of ForeignKey from a dict.

classmethod from_json(json_str: str) → ForeignKey¶

Create an instance of ForeignKey from a JSON string.

to_dict(hide_readonly_properties: bool = False) → dict[str, Any]¶

Returns the dictionary representation of the model using alias.

to_dict_without_readonly_properties() → dict[str, Any]¶

Return the dictionary representation of the model without readonly properties.

to_json() → str¶

Returns the JSON representation of the model using alias.

to_str() → str¶

Returns the string representation of the model using alias.