Skip to content

data_types

array

type_name array The registered name for this item type.
documentation

An array, in most cases used as a column within a table.

Internally, this type uses the [KiaraArray][kiara_plugin.tabular.models.array.KiaraArray] wrapper class to manage array data. This wrapper class, in turn, uses an Apache Arrow Array to store the data in memory (and on disk).

Documentation for the item.
authors Information about authorship for the item.
context
tags tabular
labels
  • package: kiara_plugin.tabular
references
Generic properties of this item (description, tags, labels, references, ...).
python_class
python_class_name ArrayType The name of the Python class.
python_module_name kiara_plugin.tabular.data_types.array The name of the Python module this class lives in.
full_name kiara_plugin.tabular.data_types.array.ArrayType The full class namespace.
The python class that implements this module type.
value_cls
python_class_name KiaraArray The name of the Python class.
python_module_name kiara_plugin.tabular.models.array The name of the Python module this class lives in.
full_name kiara_plugin.tabular.models.array.KiaraArray The full class namespace.
The python class of the value itself.
data_type_config_cls
python_class_name DataTypeConfig The name of the Python class.
python_module_name kiara.data_types The name of the Python module this class lives in.
full_name kiara.data_types.DataTypeConfig The full class namespace.
The python class holding the schema for configuring this type.
lineage
  • array
  • any
This types lineage.
qualifier_profiles
A map of qualifier profiles for this data types.

database

type_name database The registered name for this item type.
documentation

A database, containing one or several tables.

This is backed by the [KiaraDatabase][kiara_plugin.tabular.models.db.KiaraDatabase] class to manage the stored data.

Documentation for the item.
authors Information about authorship for the item.
context
tags tabular
labels
  • package: kiara_plugin.tabular
references
Generic properties of this item (description, tags, labels, references, ...).
python_class
python_class_name DatabaseType The name of the Python class.
python_module_name kiara_plugin.tabular.data_types.db The name of the Python module this class lives in.
full_name kiara_plugin.tabular.data_types.db.DatabaseType The full class namespace.
The python class that implements this module type.
value_cls
python_class_name KiaraDatabase The name of the Python class.
python_module_name kiara_plugin.tabular.models.db The name of the Python module this class lives in.
full_name kiara_plugin.tabular.models.db.KiaraDatabase The full class namespace.
The python class of the value itself.
data_type_config_cls
python_class_name DataTypeConfig The name of the Python class.
python_module_name kiara.data_types The name of the Python module this class lives in.
full_name kiara.data_types.DataTypeConfig The full class namespace.
The python class holding the schema for configuring this type.
lineage
  • database
  • any
This types lineage.
qualifier_profiles
A map of qualifier profiles for this data types.

table

type_name table The registered name for this item type.
documentation

Tabular data (table, spreadsheet, data_frame, what have you).

The table data is organized in sets of columns (arrays of data of the same type), with each column having a string identifier.

kiara uses an instance of the [KiaraTable][kiara_plugin.tabular.models.table.KiaraTable] class to manage the table data, which let's developers access it in different formats (Apache Arrow Table, Pandas dataframe, Python dict of lists, more to follow...).

Please consult the API doc of the KiaraTable class for more information about how to access and query the data:

Internally, the data is stored in Apache Feather format -- both in memory and on disk when saved, which enables some advanced usage to preserve memory and compute overhead.

Documentation for the item.
authors Information about authorship for the item.
context
tags tabular
labels
  • package: kiara_plugin.tabular
references
Generic properties of this item (description, tags, labels, references, ...).
python_class
python_class_name TableType The name of the Python class.
python_module_name kiara_plugin.tabular.data_types.table The name of the Python module this class lives in.
full_name kiara_plugin.tabular.data_types.table.TableType The full class namespace.
The python class that implements this module type.
value_cls
python_class_name KiaraTable The name of the Python class.
python_module_name kiara_plugin.tabular.models.table The name of the Python module this class lives in.
full_name kiara_plugin.tabular.models.table.KiaraTable The full class namespace.
The python class of the value itself.
data_type_config_cls
python_class_name DataTypeConfig The name of the Python class.
python_module_name kiara.data_types The name of the Python module this class lives in.
full_name kiara.data_types.DataTypeConfig The full class namespace.
The python class holding the schema for configuring this type.
lineage
  • table
  • any
This types lineage.
qualifier_profiles
A map of qualifier profiles for this data types.