Data Table¶

Each table in the schema must be defined using one of the below tables.

Reference Table ¶

class hazy_configurator.data_schema.data_table.reference_table.ReferenceTable¶

Bases: BaseTable

Used for reference tables that are passed as is to the synthesised data.

Fields:

drop_columns (List[str])
dtypes (List[HazyDataTypeUnion])
name (str)
table_type (Literal['reference'])

field name: TableName [Required]¶: The name of the table.

field dtypes: List[HazyDataTypeUnion] [Required]¶: Predefined list of hazy data types. See Data Types.

field drop_columns: List[str] = []¶: Columns to be dropped from the table.

Tabular Table ¶

class hazy_configurator.data_schema.data_table.tabular_table.TabularTable¶

Bases: BaseTable

Used for tables containing data where each row is an independent item.

Fields:

drop_columns (List[str])
dtypes (List[HazyDataTypeUnion])
name (str)
table_type (Literal['tabular'])

field name: TableName [Required]¶: The name of the table.

field dtypes: List[HazyDataTypeUnion] [Required]¶: Predefined list of hazy data types. See Data Types.

field drop_columns: List[str] = []¶: Columns to be dropped from the table.

Sequential Table ¶

class hazy_configurator.data_schema.data_table.sequential_table.SequentialTable¶

Bases: BaseTable

Used for tables where several rows can be grouped together to form a sequence.

Fields:

drop_columns (List[str])
dtypes (List[HazyDataTypeUnion])
name (str)
seq_id (str)
sort_by (List[str])
table_type (Literal['sequential'])

field sort_by: List[str] = []¶: The list of columns to use to identify a sequential record.

field seq_id: str [Required]¶: The column to use to identify the unique sequences.

field name: TableName [Required]¶: The name of the table.

field dtypes: List[HazyDataTypeUnion] [Required]¶: Predefined list of hazy data types. See Data Types.

field drop_columns: List[str] = []¶: Columns to be dropped from the table.

Data Schema