API Reference

This is the reference documentation for the entire public API of quivr.

The quivr module is the public API. The submodules of quivr (for example, quivr.tables or quivr.columns) are not for direct access.

Table of Contents

• Tables
  • The Table Class
    • Table
    • Constructors
    • Serialization/Deserialization
    • Validation
    • Interoperability
    • Filtering, Selection, Sorting
    • Data Internals
    • Miscellaneous
  • Utility Functions
    • concatenate()
    • defragment()
  • Type Information Helpers
    • AnyTable
    • DataSourceType
    • AttributeValueType
• Columns
  • Simple Types
    • StringColumn
    • LargeStringColumn
    • Int8Column
    • Int16Column
    • Int32Column
    • Int64Column
    • UInt8Column
    • UInt16Column
    • UInt32Column
    • UInt64Column
    • Float16Column
    • Float32Column
    • Float64Column
    • BooleanColumn
    • NullColumn
    • BinaryColumn
    • LargeBinaryColumn
  • Fixed-Size Binary Data
    • FixedSizeBinaryColumn
  • Decimals
    • Decimal128Column
    • Decimal256Column
  • Time-Related Types
    • TimestampColumn
    • DurationColumn
    • Time32Column
    • Time64Column
    • Date32Column
    • Date64Column
    • MonthDayNanoIntervalColumn
  • Structured Data
    • ListColumn
    • FixedSizeListColumn
    • LargeListColumn
    • MapColumn
    • StructColumn
    • SubTableColumn
  • Types For Encoding Efficiency
    • DictionaryColumn
    • RunEndEncodedColumn
  • Base Class
    • Column
  • Typing Helpers
    • T
    • MetadataDict
    • Byteslike
• Column Validators
  • eq()
  • lt()
  • le()
  • gt()
  • ge()
  • is_in()
  • and_()
  • Validator
    • Validator.evaluate()
    • Validator.valid()
    • Validator.validate()
    • Validator.failures()
• Table Attributes
  • StringAttribute
  • FloatAttribute
  • IntAttribute
• Linkages
  • Linkage
    • Linkage.select_left()
    • Linkage.select_right()
    • Linkage.select()
    • Linkage.iterate()
  • MultiKeyLinkage
    • MultiKeyLinkage.key()
  • combine_linkages()
  • combine_multilinkages()
  • LeftTable
  • RightTable
• Errors
  • ValidationError
  • TableFragmentedError
  • InvariantViolatedError
  • TablesNotCompatibleError
  • LinkageCombinationError

Primary API Objects

Table	Table is the primary data structure in quivr.
Column	A Column is an accessor for data in a Table, and also a descriptor for the Table's structure.
Linkage	A Linkage is a mapping of rows across two Tables.

Column Types

Column	A Column is an accessor for data in a Table, and also a descriptor for the Table's structure.
SubTableColumn	A column which represents an embedded Quivr table.
Int8Column	A column for storing 8-bit integers.
Int16Column	A column for storing 16-bit integers.
Int32Column	A column for storing 32-bit integers.
Int64Column	A column for storing 64-bit integers.
UInt8Column	A column for storing 8-bit unsigned integers.
UInt16Column	A column for storing 16-bit unsigned integers.
UInt32Column	A column for storing 32-bit unsigned integers.
UInt64Column	A column for storing 64-bit unsigned integers.
Float16Column	A column for storing 16-bit floating point numbers.
Float32Column	A column for storing 32-bit floating point numbers.
Float64Column	A column for storing 64-bit floating point numbers.
Decimal128Column	A column for storing arbitrary-precision decimal numbers.
Decimal256Column	A column for storing arbitrary-precision decimal numbers.
StringColumn	A column for storing strings.
LargeStringColumn	A column for storing large strings (over 231 bytes long).
BinaryColumn	A column for storing opaque binary data.
LargeBinaryColumn	A column for storing large binary objects (over 231 bytes long).
TimestampColumn	A column for storing timestamps.
DurationColumn	A column which stores an absolute length of time.
Time32Column	A column for storing time values.
Time64Column	A column for storing time values with high precision.
Date32Column	A column for storing dates.
Date64Column	A column for storing dates.
MonthDayNanoIntervalColumn	A column for storing calendar intervals (an elapsed number of months, days, and nanoseconds).
NullColumn	A column for storing null values.
StructColumn	A column for storing structured data.
ListColumn	A column for storing variably-sized lists of values.
LargeListColumn	A column for storing large lists of values (over 231 objects).
MapColumn	A column for storing maps of key-value pairs.
DictionaryColumn	A column for storing dictionary-encoded values.
RunEndEncodedColumn	A column for storing run-end encoded data.

Column Validators

Validator	A Validator is a tool to validate that data in a pyarrow.Array matches a predicate expression.
eq	Validator that all data in a column is equal to a given value.
lt	Validator that all data in a column is less than a given value.
le	Validator that all data in a column is less than or equal to a given value.
gt	Validator that all data in a column is greater than a given value.
ge	Validator that all data in a column is greater than or equal to a given value.
is_in	Validator that all data in a column is in a given set.
and_	Validator that all data in a column passes all of the given validators.

Table Attributes

StringAttribute	StringAttribute represents a string which is stored as UTF-8 bytes in Table metadata.
IntAttribute	IntAttribute represents an integer which is stored as little-endian bytes in Table metadata.
FloatAttribute	FloatAttribute represents a floating-point number which is stored as little-endian bytes in Table metadata.

Utility Functions

concatenate	Concatenate a collection of Tables into a single Table.
defragment	Condense the underlying memory which backs the table to make it all contiguous.