ReferenceProperties

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.ReferenceProperties(
    self,
    resource: str | None = None,
    fields: list[str] | None = None,
)

The destination part of a foreign key.

Attributes

resource : str | None

(str | None): The name of the resource within the current data package where the fields are located.

fields : list[str] | None

(list[str] | None): An array of strings of the same length as TableSchemaForeignKeyProperties.fields, specifying the field (or fields) that form the destination part of the foreign key.

Methods

Name	Description
default	Creates a ReferenceProperties dataclass with default values.

default

core.ReferenceProperties.default()

Creates a ReferenceProperties dataclass with default values.

Returns

Self

A ReferenceProperties dataclass with default values.