Schema

PrimaryKey

Primary key

ForeignKey

__init__

__init__(parent: str) -> None

Foreign key of a relational dataset, namely a relation between two tables.

Parameters:

Name	Type	Description	Default
parent	str	Parent table (table to which the key refers to).	required

Column

Enumeration of column types. Supported types are: TEXT, CATEGORICAL, BOOLEAN, NUMERIC, INTEGER, DATETIME, DATE, TIME, COORDINATES, ITAFISCALCODE.

Table

__init__

__init__(
    columns: dict[str, Column | ForeignKey | PrimaryKey]
    | None = None,
    **kwargs: Column | ForeignKey | PrimaryKey,
) -> None

Class representing a table in a relational dataset.

Parameters:

Name	Type	Description	Default
columns	dict[str, Column | ForeignKey | PrimaryKey] | None	Dictionary mapping each feature column to a Column object and each foreign key column to a ForeignKey object. A single optional PrimaryKey may be specified.	None
**kwargs	Column | ForeignKey | PrimaryKey	Additional Column, PrimaryKey or ForeignKey objects.	{}

Schema

__init__

__init__(
    tables: dict[str, Table] | None = None, **kwargs: Table
) -> None

Schema of a relational dataset.

Parameters:

Name	Type	Description	Default
tables	dict[str, Table] | None	Dictionary associating each data table to a Table object. Tables will be reordered to allow traversing from the graph roots to its leaves.	None
**kwargs	Table	Additional Table objects.	{}