Skip to main content

Data table

DataTable​

Typed wrapper around a data table project item.

Returned by: DataTable.update_mappings, JinkoClient.create_data_table_from_csv, JinkoClient.create_data_table_from_dataframe, JinkoClient.create_data_table_from_json, JinkoClient.create_data_table_from_sqlite, JinkoClient.get_data_table, JinkoClient.iter_data_tables, JinkoClient.list_data_tables, Trial.data_tables

Also has every member of ProjectItem.

MemberKindDescription
get_rawmethodReturn raw SQLite bytes for this item revision.
update_mappingsmethodReplace the active mapping list for the latest data table version.
summarymethodReturn backend summary information for this item revision.
validatemethodRun backend validation for this item revision and return details.
exportmethodExport this item revision as JSON or CSV, depending on accept.

get_raw​

get_raw(
*,
revision: int | None = None,
skip_normalize: bool = False,
apply_mappings: str | None = None
) -> bytes

Return raw SQLite bytes for this item revision.

update_mappings​

update_mappings(
mappings: list[dict[str, Any]],
*,
name: str | None = None,
description: str | None = None,
version: str | dict | None = None
) -> DataTable

Replace the active mapping list for the latest data table version.

summary​

summary(*, revision: int | None = None) -> Any

Return backend summary information for this item revision.

validate​

validate(*, revision: int | None = None) -> Any

Run backend validation for this item revision and return details.

export​

export(
*,
revision: int | None = None,
accept: str = "application/json",
skip_normalize: bool = False,
apply_mappings: str | None = None,
null_as: str | None = None
) -> Any

Export this item revision as JSON or CSV, depending on accept.