Expand description
Rerun arrow metadata and record batch definitions.
Handles the structure of arrow record batches and their meta data for different use cases for Rerun.
An arrow record batch that follows a specific schema is called a SorbetBatch.
Some SorbetBatches has even more constrained requirements, such as ChunkBatch and DataframeBatch.
- Every
ChunkBatchis aSorbetBatch. - Every
DataframeBatchis aSorbetBatch.
NOTE: DataframeBatch has not yet been implemented.
Each batch type has a matching schema type:
SorbetBatchhas aSorbetSchemaChunkBatchhas aChunkSchemaDataframeBatchwill have aDataframeSchema
Structs§
- Chunk
Batch - The
ArrowRecordBatchrepresentation of a Rerun chunk. - Chunk
Schema - The parsed schema of a Rerun chunk, i.e. multiple columns of data for a single entity.
- Component
Column Descriptor - Describes a data/component column, such as
Position3D, in a dataframe. - Index
Column Descriptor - Describes a time column, such as
log_time. - Missing
Field Metadata - Missing
Metadata Key - RowId
Column Descriptor - Describes the schema of the primary
RowIdcolumn. - Sorbet
Batch - Any rerun-compatible
ArrowRecordBatch. - Sorbet
Column Descriptors - Sorbet
Schema - The parsed schema of a
SorbetBatch. - Unknown
Column Kind - Unsupported
Time Type - Wrong
Datatype Error
Enums§
- Batch
Type - The type of
SorbetBatch. - Column
Descriptor - Column
Descriptor Ref - Column
Error - Column
Kind - The type of column in a sorbet batch.
- Mismatched
Chunk Schema Error - Sorbet
Error
Traits§
- Metadata
Ext - Make it more ergonomic to work with arrow metadata.
Functions§
- ipc_
from_ schema - Encode an arrow schema as IPC bytes.
- migrate_
record_ batch - Migrate old renamed types to new types.
- schema_
from_ ipc - Decode an arrow schema from IPC bytes.
Type Aliases§
- Arrow
Batch Metadata - Arrow metadata for an arrow record batch.
- Arrow
Field Metadata - Arrow metadata for a column/field.