Skip to content

kiara_model_types

database_metadata

type_name database_metadata The registered name for this item type.
documentation

Database and table properties.

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 DatabaseMetadata 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.DatabaseMetadata The full class namespace.
The python class that implements this module type.
metadata_schema
title DatabaseMetadata
description Database and table properties.
type object
properties
tables
title Tables
description The table schema.
type object
additionalProperties
$ref #/definitions/TableMetadata
required
  • tables
additionalProperties False
definitions
ColumnSchema
title ColumnSchema
description Describes properties of a single column of the 'table' data type.
type object
properties
type_name
title Type Name
description The type name of the column (backend-specific).
type string
metadata
title Metadata
description Other metadata for the column.
type object
required
  • type_name
TableMetadata
title TableMetadata
description Describes properties for the 'table' data type.
type object
properties
column_names
title Column Names
description The name of the columns of the table.
type array
items
type string
column_schema
title Column Schema
description The schema description of the table.
type object
additionalProperties
$ref #/definitions/ColumnSchema
rows
title Rows
description The number of rows the table contains.
type integer
size
title Size
description The tables size in bytes.
type integer
required
  • column_names
  • column_schema
  • rows
additionalProperties False
The (json) schema for this model data.

kiara_table_metadata

type_name kiara_table_metadata The registered name for this item type.
documentation

File stats.

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 KiaraTableMetadata 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.KiaraTableMetadata The full class namespace.
The python class that implements this module type.
metadata_schema
title KiaraTableMetadata
description File stats.
type object
properties
table
title Table
description The table schema.
allOf
  • $ref #/definitions/TableMetadata
required
  • table
additionalProperties False
definitions
ColumnSchema
title ColumnSchema
description Describes properties of a single column of the 'table' data type.
type object
properties
type_name
title Type Name
description The type name of the column (backend-specific).
type string
metadata
title Metadata
description Other metadata for the column.
type object
required
  • type_name
TableMetadata
title TableMetadata
description Describes properties for the 'table' data type.
type object
properties
column_names
title Column Names
description The name of the columns of the table.
type array
items
type string
column_schema
title Column Schema
description The schema description of the table.
type object
additionalProperties
$ref #/definitions/ColumnSchema
rows
title Rows
description The number of rows the table contains.
type integer
size
title Size
description The tables size in bytes.
type integer
required
  • column_names
  • column_schema
  • rows
additionalProperties False
The (json) schema for this model data.

table_metadata

type_name table_metadata The registered name for this item type.
documentation

Describes properties for the 'table' data type.

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 TableMetadata The name of the Python class.
python_module_name kiara_plugin.tabular.models The name of the Python module this class lives in.
full_name kiara_plugin.tabular.models.TableMetadata The full class namespace.
The python class that implements this module type.
metadata_schema
title TableMetadata
description Describes properties for the 'table' data type.
type object
properties
column_names
title Column Names
description The name of the columns of the table.
type array
items
type string
column_schema
title Column Schema
description The schema description of the table.
type object
additionalProperties
$ref #/definitions/ColumnSchema
rows
title Rows
description The number of rows the table contains.
type integer
size
title Size
description The tables size in bytes.
type integer
required
  • column_names
  • column_schema
  • rows
additionalProperties False
definitions
ColumnSchema
title ColumnSchema
description Describes properties of a single column of the 'table' data type.
type object
properties
type_name
title Type Name
description The type name of the column (backend-specific).
type string
metadata
title Metadata
description Other metadata for the column.
type object
required
  • type_name
The (json) schema for this model data.

kiara_array

type_name kiara_array The registered name for this item type.
documentation

A class to manage array-like data.

Internally, this uses an Apache Arrow Array to handle 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 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 that implements this module type.
metadata_schema
title KiaraArray
description A class to manage array-like data. Internally, this uses an [Apache Arrow Array](https://arrow.apache.org/docs/python/generated/pyarrow.Array.html#pyarrow.Array) to handle the data in memory and on disk.
type object
properties
data_path
title Data Path
description The path to the (feather) file backing this array.
type string
additionalProperties False
The (json) schema for this model data.

kiara_database

type_name kiara_database The registered name for this item type.
documentation

A wrapper class to manage a sqlite database.

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 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 that implements this module type.
metadata_schema
title KiaraDatabase
description A wrapper class to manage a sqlite database.
type object
properties
db_file_path
title Db File Path
description The path to the sqlite database file.
type string
required
  • db_file_path
additionalProperties False
The (json) schema for this model data.

kiara_table

type_name kiara_table The registered name for this item type.
documentation

A wrapper class to manage tabular data in a memory efficient way.

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 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 that implements this module type.
metadata_schema
title KiaraTable
description A wrapper class to manage tabular data in a memory efficient way.
type object
properties
data_path
title Data Path
description The path to the (feather) file backing this array.
type string
additionalProperties False
The (json) schema for this model data.