Warning

🚧 Sprout is still in active development and evolving quickly, so the documentation and functionality may not work as described and could undergo substantial changes 🚧

core.TableSchemaForeignKeyProperties

core.TableSchemaForeignKeyProperties(self, fields=None, reference=None)

A foreign key in a table schema.

A foreign key is a reference where values in a field (or fields) on the table (“resource” in data package terminology) described by the table schema connect to values in a field (or fields) on this or a separate table (resource).

Attributes

fields : list[str] | None

An array of strings specifying the field (or fields) on this resource that form the source part of the foreign key.

reference : ReferenceProperties | None

An object specifying the destination part of the foreign key.

Methods

Name	Description
default	Creates an instance with default values.

default

core.TableSchemaForeignKeyProperties.default()

Creates an instance with default values.

Returns

: Self

A TableSchemaForeignKeyProperties object with default values