kiara modules for: core¶
This package contains a set of commonly used/useful modules, pipelines, types and metadata schemas for Kiara.
Description¶
TODO
Package content¶
Value types¶
- array: An Apache arrow array.
- boolean: A boolean.
- bytes: An array of bytes.
- database: A database, containing one or several tables.
- date: A date.
- dict: A dict-like object.
- file: A representation of a file.
- file_bundle: A representation of a set of files (folder, archive, etc.).
- float: A float.
- integer: An integer.
- list: A list-like object.
- renderables: A list of renderable objects, used in the 'rich' Python library, to print to the terminal or in Jupyter.
- string: A string.
- table: A table.
Modules¶
- array.map: Map a list of values into another list of values.
- array.metadata: Extract metadata from an 'array' value.
- array.sample: Sample an array.
- array.store: Save an Arrow array to a file.
- bytes.load: -- n/a --
- bytes.msgpack.from_value: -- n/a --
- bytes.msgpack.to_value: -- n/a --
- bytes.store: -- n/a --
- database.create: Create a database from files, file_bundles, etc.
- database.export_network_data: -- n/a --
- database.info: Extract extended metadata (like tables, schemas) from a database object.
- database.load: -- n/a --
- database.metadata: Extract basic metadata from a database object.
- database.query.sql: Execute a sql query against an (Arrow) table.
- database.store: Save an sqlite database to a file.
- date.extract_from_string: Extract a date object from a string.
- date.range_check: Check whether a date falls within a specified date range.
- dev.dummy: Module that simulates processing, but uses hard-coded outputs as a result.
- dict.store: -- n/a --
- file.import: Import an external file into a kiara session.
- file.load: Load a file and its metadata.
- file.metadata: -- n/a --
- file.store: Save a file to disk.
- file_bundle.import: Import a file bundle into the kiara data store.
- file_bundle.load: Load a file bundle and its metadata.
- file_bundle.metadata: -- n/a --
- file_bundle.store: Save a file bundle to disk.
- generic.restore_from_json: -- n/a --
- generic.restore_scalar: Utility module, only used internally.
- generic.store: -- n/a --
- json.to_json: Convert arbitrary types into json.
- list.contains: Check whether an element is in a list.
- list.store: -- n/a --
- logic.and: Returns 'True' if both inputs are 'True'.
- logic.not: Negates the input.
- logic.or: Returns 'True' if one of the inputs is 'True'.
- string.deserialize: -- n/a --
- string.match_regex: Match a string using a regular expression.
- string.replace: Replace a string if it matches a key in a mapping dictionary.
- string.serialize: -- n/a --
- table.create: Create an Arrow table from files, file_bundles, etc.
- table.cut_column: Cut off one column from a table, returning an array.
- table.export: Export a table object to disk.
- table.export_table: -- n/a --
- table.filter.with_mask: Filter a table using a mask array.
- table.load: Load a table object from disk.
- table.map_column: Map the items of one column of a table onto an array, using another module.
- table.merge: Create a table from other tables and/or arrays.
- table.metadata: Extract metadata from a table object.
- table.query.graphql: Execute a graphql aggregation query against an (Arrow) table.
- table.query.sql: Execute a sql query against an (Arrow) table.
- table.sample: Sample a table.
- table.store: -- n/a --
- value.data_profile: Generate a data profile report for a dataset.
- yaml.to_yaml: Convert arbitrary types into YAML format.
Pipelines¶
- array.restore: Load a column from a table object, returning an array.
- logic.nand: Returns 'False' if both inputs are 'True'.
- logic.nor: Returns 'True' if both inputs are 'False'.
- logic.xor: Returns 'True' if exactly one of it's two inputs is 'True'.
- table.filter.by_date: Filter a table by a date or date range.