Function Overview

Main functions

Functions that read in data

Function	Description
read	Reads in a file to a Table-like or TableDict-like object
read_native	Reads in a file to a TableDict-like object of the native tabular type
io_open	Reads a file as a file object
check_columns	Checks that the a file has the same or fewer columns than a given list
iterator	Reads in data from a file one chunk at a time to a given format
iterator_native	Reads in data from a file one chunk at a time to its native tabular format

Functions that write data

Function	Description
write	Writes a Table-like or TableDict-like object to a file
write_native	Writes a Table-like or TableDict-like object to its native file type

Other functions

Function	Description
convert	Convert a Table-like or TableDict-like object to a specified tabular format
convert_table	Convert a Table-like object to a specified tabular format
concat_tabledict	Concatenate multiple TableDict-like objects
concat_table	Concatenate multiple Table-like objects
slice_tabledict	Slice a TableDict-like object
slice_table	Slice a Table-like object
get_table_type	Returns the tabular type of a Table-like or TableDict-like object

HDF5 module

The HDF5 module exists to allow users easier access to manually do chunked operations with HDF5 files. While iterator provides a way to do chunked reads of HDF5 files, this is the only way to do chunked writes of HDF5 files. To use the hdf5 module run:

from tables_io import hdf5

Functions that read in data

Function	Description
read_HDF5_group	Read and return the requested group and file object from an HDF5 file.
read_HDF5_group_names <tables_io.io_utils.read.read_HDF5_group_names()	Read and return the list of group names from one level of an HDF5 file
read_HDF5_to_dict	Reads in data from an HDF5 file to a dictionary
read_HDF5_group_to_dict	Reads in data from an open HDF5 file object to a dictionary or numpy.array
read_HDF5_dataset_to_array	Reads in all or part of an HDF5 dataset

Functions that write data

Function	Description
initialize_HDF5_write	Prepares an HDF5 file for output.
write_dict_to_HDF5_chunk	Writes a chunk of data from a TableDict-like object to an HDF5 group or file object.
write_dicts_to_HDF5	Writes a Table-like object to an HDF5 file given a filepath.
finalize_HDF5_write	Writes any last data and closes an HDF5 file object.

Utility functions

Function	Description
get_group_input_data_length	Returns the length of an HDF5 group object
get_input_data_length	Opens a file and gets the length of the first axis of the data in that file.
data_ranges_by_rank	Given a number of rows and chunk size, yields the data range for each process