package rerun.common.v1alpha1

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: log_msg.v1alpha1.StoreInfo

• string id = 1

Used in: manifest_registry.v1alpha1.IndexColumn

• optional string archetype_name = 1

  Optional name of the `Archetype` associated with this data.

• optional string archetype_field_name = 2

  Optional name of the field within `Archetype` associated with this data.

• optional string component_name = 3

  Semantic name associated with this data.

DataframePart is arrow IPC encoded RecordBatch

Used in: frontend.v1alpha1.ScanTableResponse, frontend.v1alpha1.SearchDatasetRequest, manifest_registry.v1alpha1.CreateIndexResponse, manifest_registry.v1alpha1.CreatePartitionManifestsResponse, manifest_registry.v1alpha1.FetchChunkManifestResponse, manifest_registry.v1alpha1.FetchPartitionManifestResponse, manifest_registry.v1alpha1.QueryDatasetResponse, manifest_registry.v1alpha1.ReIndexResponse, manifest_registry.v1alpha1.RegisterWithDatasetBlockingResponse, manifest_registry.v1alpha1.RegisterWithDatasetResponse, manifest_registry.v1alpha1.ScanPartitionTableResponse, manifest_registry.v1alpha1.SearchDatasetRequest, manifest_registry.v1alpha1.SearchDatasetResponse, redap_tasks.v1alpha1.FetchTaskOutputResponse, redap_tasks.v1alpha1.QueryTasksOnCompletionResponse, redap_tasks.v1alpha1.QueryTasksResponse, redap_tasks.v1alpha1.SubmitTasksResponse, sdk_comms.v1alpha1.ReadTablesResponse, sdk_comms.v1alpha1.WriteTableRequest

• EncoderVersion encoder_version = 1

  encoder version used to encode the data

• optional bytes payload = 2

  Data payload is Arrow IPC encoded RecordBatch

Entry point for all ManifestRegistryService APIs

Used in: catalog.v1alpha1.DatasetEntry, manifest_registry.v1alpha1.CreateIndexRequest, manifest_registry.v1alpha1.CreatePartitionManifestsRequest, manifest_registry.v1alpha1.FetchChunkManifestRequest, manifest_registry.v1alpha1.FetchPartitionManifestRequest, manifest_registry.v1alpha1.GetChunksRequest, manifest_registry.v1alpha1.GetDatasetSchemaRequest, manifest_registry.v1alpha1.GetPartitionTableSchemaRequest, manifest_registry.v1alpha1.QueryDatasetRequest, manifest_registry.v1alpha1.ReIndexRequest, manifest_registry.v1alpha1.RegisterWithDatasetBlockingRequest, manifest_registry.v1alpha1.RegisterWithDatasetRequest, manifest_registry.v1alpha1.ScanPartitionTableRequest, manifest_registry.v1alpha1.SearchDatasetRequest, manifest_registry.v1alpha1.WriteChunksRequest

• optional EntryId entry_id = 1

  Unique entry identifier (for debug purposes)

• optional string dataset_url = 2

  Path to Dataset backing storage (e.g. s3://bucket/file or file:///path/to/file)

supported encoder versions for encoding data See `RerunData` and `RerunChunkData` for its usage

Used in: DataframePart, RerunChunk

• ENCODER_VERSION_UNSPECIFIED = 0

• ENCODER_VERSION_V0 = 1

The unique identifier of an entity, e.g. `camera/3/points` See <https://www.rerun.io/docs/concepts/entity-path> for more on entity paths.

Used in: frontend.v1alpha1.GetChunksRequest, frontend.v1alpha1.QueryDatasetRequest, manifest_registry.v1alpha1.GetChunksRequest, manifest_registry.v1alpha1.IndexColumn, manifest_registry.v1alpha1.QueryDatasetRequest

• string path = 1

Used in: catalog.v1alpha1.DeleteEntryRequest, catalog.v1alpha1.EntryDetails, catalog.v1alpha1.EntryFilter, catalog.v1alpha1.ReadDatasetEntryRequest, catalog.v1alpha1.ReadTableEntryRequest, DatasetHandle, frontend.v1alpha1.CreateIndexRequest, frontend.v1alpha1.GetChunksRequest, frontend.v1alpha1.GetDatasetSchemaRequest, frontend.v1alpha1.GetPartitionTableSchemaRequest, frontend.v1alpha1.GetTableSchemaRequest, frontend.v1alpha1.QueryDatasetRequest, frontend.v1alpha1.ReIndexRequest, frontend.v1alpha1.RegisterWithDatasetRequest, frontend.v1alpha1.ScanPartitionTableRequest, frontend.v1alpha1.ScanTableRequest, frontend.v1alpha1.SearchDatasetRequest, frontend.v1alpha1.WriteChunksRequest

• optional Tuid id = 1

Specify how the relevant creation call behaves in case of previously created (duplicate) items

Used in: frontend.v1alpha1.CreateIndexRequest, frontend.v1alpha1.RegisterWithDatasetRequest, manifest_registry.v1alpha1.CreateIndexRequest, manifest_registry.v1alpha1.CreatePartitionManifestsRequest, manifest_registry.v1alpha1.RegisterWithDatasetBlockingRequest, manifest_registry.v1alpha1.RegisterWithDatasetRequest

• IF_DUPLICATE_BEHAVIOR_UNSPECIFIED = 0

• IF_DUPLICATE_BEHAVIOR_OVERWRITE = 1

  Overwrite the existing item

• IF_DUPLICATE_BEHAVIOR_SKIP = 2

  Skip if the item already exists

• IF_DUPLICATE_BEHAVIOR_ERROR = 3

  Return an error if the item already exists

Used in: ScanParameters

• IF_MISSING_BEHAVIOR_UNSPECIFIED = 0

• IF_MISSING_BEHAVIOR_SKIP = 1

• IF_MISSING_BEHAVIOR_ERROR = 2

Used in: manifest_registry.v1alpha1.IndexConfig, manifest_registry.v1alpha1.QueryLatestAt, manifest_registry.v1alpha1.QueryRange

• optional Timeline timeline = 1

  TODO(zehiko) we need to add support for other types of index selectors

• optional TimeRange time_range = 1

  TODO(zehiko) support for other ranges for other index selectors

Unique identifier for a partition. Can be user defined which means it can be of any type. For simplicity we start with a string, but we will probably revisit this.

Used in: frontend.v1alpha1.CreateIndexRequest, frontend.v1alpha1.GetChunksRequest, frontend.v1alpha1.QueryDatasetRequest, manifest_registry.v1alpha1.CreateIndexRequest, manifest_registry.v1alpha1.CreatePartitionManifestsRequest, manifest_registry.v1alpha1.FetchPartitionManifestRequest, manifest_registry.v1alpha1.GetChunksRequest, manifest_registry.v1alpha1.QueryDatasetRequest

• optional string id = 1

RerunChunk is arrow IPC encoded RecordBatch that has rerun-specific semantic constraints and can be directly converted to a Rerun Chunk (`re_chunk::Chunk`)

Used in: manifest_registry.v1alpha1.GetChunksResponse

• EncoderVersion encoder_version = 1

  encoder version used to encode the data

• bytes payload = 2

  Data payload is Arrow IPC encoded RecordBatch TODO(zehiko) make this optional (#9285)

Generic parameters that will influence the behavior of the Lance scanner. TODO(zehiko, cmc): This should be available for every endpoint that queries data in one way or another.

Used in: frontend.v1alpha1.QueryDatasetRequest, frontend.v1alpha1.ScanPartitionTableRequest, frontend.v1alpha1.SearchDatasetRequest, manifest_registry.v1alpha1.FetchChunkManifestRequest, manifest_registry.v1alpha1.FetchPartitionManifestRequest, manifest_registry.v1alpha1.QueryDatasetRequest, manifest_registry.v1alpha1.ScanPartitionTableRequest, manifest_registry.v1alpha1.SearchDatasetRequest

• repeated string columns = 1

  List of columns to project. If empty, all columns will be projected.

• IfMissingBehavior on_missing_columns = 2

• optional string filter = 3

  An arbitrary filter expression that will be passed to the Lance scanner as-is. ```text scanner.filter(filter) ```

• optional int64 limit_offset = 4

  An arbitrary offset that will be passed to the Lance scanner as-is. ```text scanner.limit(_, limit_offset) ```

• optional int64 limit_len = 5

  An arbitrary limit that will be passed to the Lance scanner as-is. ```text scanner.limit(limit_len, _) ```

• optional ScanParametersOrderClause order_by = 6

  An arbitrary order clause that will be passed to the Lance scanner as-is. ```text scanner.order_by(…) ```

• bool explain_plan = 7

  If set, the output of `scanner.explain_plan` will be dumped to the server's log.

• bool explain_filter = 8

  If set, the final `scanner.filter` will be dumped to the server's log.

Used in: ScanParameters

• bool descending = 1

• bool nulls_last = 2

• optional string column_name = 3

arrow IPC serialized schema

Used in: catalog.v1alpha1.TableEntry, frontend.v1alpha1.GetTableSchemaResponse, manifest_registry.v1alpha1.GetDatasetSchemaResponse, manifest_registry.v1alpha1.GetPartitionTableSchemaResponse

• optional bytes arrow_schema = 1

Used in: log_msg.v1alpha1.ArrowMsg, log_msg.v1alpha1.BlueprintActivationCommand, log_msg.v1alpha1.StoreInfo

• StoreKind kind = 1

• string id = 2

Used in: StoreId

• STORE_KIND_UNSPECIFIED = 0

• STORE_KIND_RECORDING = 1

• STORE_KIND_BLUEPRINT = 2

uniquely identifies a table

Used in: sdk_comms.v1alpha1.ReadTablesResponse, sdk_comms.v1alpha1.WriteTableRequest

• string id = 1

Unique identifier of a task submitted in the redap tasks subsystem

Used in: redap_tasks.v1alpha1.FetchTaskOutputRequest, redap_tasks.v1alpha1.QueryTasksOnCompletionRequest, redap_tasks.v1alpha1.QueryTasksRequest, redap_tasks.v1alpha1.Task

• string id = 1

A time range between start and end time points. Each 64 bit number can represent different time point data depending on the timeline it is associated with. Time range is inclusive for both start and end time points.

Used in: IndexRange, manifest_registry.v1alpha1.QueryRange

• int64 start = 1

• int64 end = 2

A recording can have multiple timelines, each is identified by a name, for example `log_tick`, `log_time`, etc.

Used in: IndexColumnSelector

• string name = 1

Used in: EntryId, frontend.v1alpha1.GetChunksRequest, frontend.v1alpha1.QueryDatasetRequest, log_msg.v1alpha1.SetStoreInfo, manifest_registry.v1alpha1.GetChunksRequest, manifest_registry.v1alpha1.QueryDatasetRequest

• optional fixed64 time_ns = 1

  Approximate nanoseconds since epoch.

• optional fixed64 inc = 2

  Initialized to something random on each thread, then incremented for each new `Tuid` being allocated.