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.
There is also ChunkBatch, which is a has even more constrained requirements.
Every ChunkBatch is a SorbetBatch, but the opposite does not hold.
Each batch type has a matching schema type:
SorbetBatchhas aSorbetSchemawithSorbetColumnDescriptorsChunkBatchhas aChunkSchemawithChunkColumnDescriptors
Re-exports§
pub use self::metadata::ArrowBatchMetadata;pub use self::metadata::ArrowFieldMetadata;pub use self::metadata::MetadataExt;pub use self::metadata::MissingFieldMetadata;pub use self::metadata::MissingMetadataKey;pub use self::timestamp_metadata::TimestampMetadata;
Modules§
- metadata
- timestamp_
metadata - Tools for adding timpestamp metadata to a Record Batch.
Structs§
- Chunk
Batch - The
ArrowRecordBatchrepresentation of a Rerun chunk. - Chunk
Column Descriptors - Requires a specific ordering of the columns.
- Chunk
Schema - The parsed schema of a Rerun chunk, i.e. multiple columns of data for a single entity.
- Component
Column Descriptor - This is an
ArrowFieldthat contains specific meta-data. - Component
Column Selector - Select a component based on its entity path and identifier.
- Index
Column Descriptor - Describes a time column, such as
log_time. - RowId
Column Descriptor - Describes the schema of the primary
RowIdcolumn. - Schema
Builder - Helper to build a schema from a collection of chunks belonging to the same logical store.
- Sorbet
Batch - Any rerun-compatible
ArrowRecordBatch. - Sorbet
Column Descriptors - Sorbet
Schema - The parsed schema of a
SorbetBatch. - Time
Column Selector - Select a time column.
- Unknown
Column Kind - Unsupported
Time Type - Wrong
Datatype Error
Enums§
- Batch
Type - The type of
SorbetBatch. - Column
Descriptor - Describes any kind of column.
- Column
Descriptor Ref - Column
Error - Column
Kind - The type of column in a sorbet batch.
- Column
Selector - Describes a column selection to return as part of a query.
- Column
Selector Parse Error - Column
Selector Resolve Error - Mismatched
Chunk Schema Error - Sorbet
Error
Functions§
- chunk_
id_ of_ schema - Get the chunk ID from the metadata of the Arrow schema of a record batch containing a sorbet chunk.
- ipc_
from_ schema - Encode an arrow schema as IPC bytes.
- is_
static_ chunk - If this is a
ChunkBatch: does it contain static data? - migrate_
record_ batch - Migrate a sorbet record batch of unknown version to the latest version.
- migrate_
schema_ ref - Migrate a sorbet schema of unknown version to the latest version.
- migrated_
schema_ from_ ipc - Decode an arrow schema from IPC bytes, and migrate it to the latest sorbet version.
- raw_
schema_ from_ ipc - Decode an arrow schema from IPC bytes, WITHOUT migration.