package rerun.common.v1alpha1

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: StoreId, log_msg.v1alpha1.StoreInfo

• string id = 1

Mirrors `re_build_info::BuildInfo`.

Used in: cloud.v1alpha1.VersionResponse

• optional string crate_name = 1

  `CARGO_PKG_NAME`.

• optional string features = 2

  Space-separated names of all features enabled for this crate.

• optional SemanticVersion version = 3

  Crate version, parsed from `CARGO_PKG_VERSION`, ignoring any `+metadata` suffix.

• optional string rustc_version = 4

  The raw version string of the Rust compiler used, or an empty string.

• optional string llvm_version = 5

  The raw version string of the LLVM toolchain used, or an empty string.

• optional string git_hash = 6

  Git commit hash, or empty string.

• optional string git_branch = 7

  Current git branch, or empty string.

• optional string target_triple = 8

  Target architecture and OS Example: `xaarch64-apple-darwin`

• optional string build_time = 9

  ISO 8601 / RFC 3339 build time. Example: `"2023-02-23T19:33:26Z"` Empty if unknown.

• optional bool is_debug_build = 10

  True if this is a debug build.

• optional string archetype = 4

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

• optional string component = 5

  Identifier of the field within `Archetype` associated with this data.

• optional string component_type = 6

  Optional semantic name associated with this data.

The type of compression used on the payload.

Used in: DataframePart, log_msg.v1alpha1.ArrowMsg

• COMPRESSION_UNSPECIFIED = 0

• COMPRESSION_NONE = 1

  No compression.

• COMPRESSION_LZ4 = 2

  LZ4 block compression.

DataframePart is arrow IPC encoded RecordBatch

Used in: cloud.v1alpha1.FetchChunksRequest, cloud.v1alpha1.QueryDatasetResponse, cloud.v1alpha1.QueryTasksOnCompletionResponse, cloud.v1alpha1.QueryTasksResponse, cloud.v1alpha1.RegisterWithDatasetResponse, cloud.v1alpha1.ScanDatasetManifestResponse, cloud.v1alpha1.ScanSegmentTableResponse, cloud.v1alpha1.ScanTableResponse, cloud.v1alpha1.UnregisterFromDatasetResponse, cloud.v1alpha1.WriteTableRequest, log_msg.v1alpha1.RrdManifest, 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

• Compression compression = 3

  Compression used. This was introduced late in `DataframePart`'s lifetime, and therefore might be unspecified in many real world recordings out there. Unspecified is synonymous with uncompressed in this case.

• uint64 uncompressed_size = 4

  How large is the uncompressed data? The value is undefined if `self.compression == Off`. This was introduced late in `DataframePart`'s lifetime, and therefore might be unspecified in many real world recordings out there (which is fine, because they are all implicitly using `Compression::Off`).

Entry point for all ManifestWriterService APIs

Used in: cloud.v1alpha1.DatasetEntry

• optional EntryId entry_id = 1

  Unique entry identifier (for debug purposes)

• StoreKind store_kind = 3

  The kind of dataset this handle refers to. Deprecated: use `dataset_kind` instead.

• DatasetKind dataset_kind = 4

  The kind of dataset this handle refers to.

• optional string dataset_url = 2

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

What type of dataset. This affects limits on what can be registered to the dataset.

Used in: DatasetHandle

• DATASET_KIND_UNSPECIFIED = 0

  Always reserve unspecified as default value

• DATASET_KIND_RECORDING = 1

• DATASET_KIND_BLUEPRINT = 2

• DATASET_KIND_ASSET = 3

Mirrors `re_build_info::DevAlpha`.

Used in: SemanticVersion

• optional fixed32 alpha = 1

• optional string commit = 2

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/logging-and-ingestion/entity-path> for more on entity paths.

Used in: cloud.v1alpha1.QueryDatasetRequest

• string path = 1

Used in: cloud.v1alpha1.CreateDatasetEntryRequest, cloud.v1alpha1.DatasetDetails, cloud.v1alpha1.DeleteEntryRequest, cloud.v1alpha1.EntryCreatedEvent, cloud.v1alpha1.EntryDeletedEvent, cloud.v1alpha1.EntryDetails, cloud.v1alpha1.EntryFilter, cloud.v1alpha1.GetAssetsForSegmentResponse, cloud.v1alpha1.GetTableSchemaRequest, cloud.v1alpha1.ReadTableEntryRequest, cloud.v1alpha1.ScanTableRequest, cloud.v1alpha1.TableDetails, cloud.v1alpha1.UpdateDatasetEntryRequest, cloud.v1alpha1.UpdateEntryRequest, cloud.v1alpha1.UpdateTableEntryRequest, DatasetHandle

• optional Tuid id = 1

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

Used in: cloud.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: cloud.v1alpha1.QueryLatestAt, cloud.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

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: cloud.v1alpha1.WriteChunksRequest

• EncoderVersion encoder_version = 1

  encoder version used to encode the data

• optional bytes payload = 2

  Data payload is Arrow IPC encoded RecordBatch

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: cloud.v1alpha1.QueryDatasetRequest

• 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, _) ```

• repeated 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: cloud.v1alpha1.CreateTableEntryRequest, cloud.v1alpha1.GetDatasetManifestSchemaResponse, cloud.v1alpha1.GetDatasetSchemaResponse, cloud.v1alpha1.GetSegmentTableSchemaResponse, cloud.v1alpha1.GetTableSchemaResponse, log_msg.v1alpha1.RrdManifest

• optional bytes arrow_schema = 1

Unique identifier for a segment. 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: cloud.v1alpha1.DatasetDetails, cloud.v1alpha1.GetAssetsForSegmentResponse, cloud.v1alpha1.GetRrdManifestRequest, cloud.v1alpha1.QueryDatasetRequest, cloud.v1alpha1.TableDetails, cloud.v1alpha1.UnregisterFromDatasetRequest

• optional string id = 1

Mirrors `re_build_info::CrateVersion`.

Used in: BuildInfo

• optional fixed32 major = 1

• optional fixed32 minor = 2

• optional fixed32 patch = 3

• oneof meta

  • fixed32 rc = 4

  • fixed32 alpha = 5

  • DevAlpha dev_alpha = 6

Used in: log_msg.v1alpha1.ArrowMsg, log_msg.v1alpha1.BlueprintActivationCommand, log_msg.v1alpha1.RrdManifest, log_msg.v1alpha1.StoreInfo, sdk_comms.v1alpha1.GetViewerStateResponse, sdk_comms.v1alpha1.SetTimeCursorRequest, sdk_comms.v1alpha1.SetTimeCursorResponse, sdk_comms.v1alpha1.ViewerRecording

• StoreKind kind = 1

  The kind of the store.

• string recording_id = 2

  The recording id of the store. For remote stores, this is the segment id. For blueprint store, this is an arbitrary uuid.

• optional ApplicationId application_id = 3

  User-chosen name of the application doing the logging. For remote stores, this is the dataset entry id.

Used in: DatasetHandle, 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: cloud.v1alpha1.CancelTasksRequest, cloud.v1alpha1.QueryTasksOnCompletionRequest, cloud.v1alpha1.QueryTasksRequest

• 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: cloud.v1alpha1.QueryRange, IndexRange, sdk_comms.v1alpha1.ViewerTimeline

• int64 start = 1

• int64 end = 2

The type of a timeline's time values. Mirrors `re_log_types::TimeType`.

Used in: sdk_comms.v1alpha1.SetTimeCursorResponse, sdk_comms.v1alpha1.TimeCursor, sdk_comms.v1alpha1.ViewerTimeline

• TIME_TYPE_UNSPECIFIED = 0

• TIME_TYPE_SEQUENCE = 1

  Used e.g. for frames in a film.

• TIME_TYPE_DURATION_NS = 2

  Duration measured in nanoseconds.

• TIME_TYPE_TIMESTAMP_NS = 3

  Nanoseconds since unix epoch (1970-01-01 00:00:00 UTC).

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

Used in: IndexColumnSelector, sdk_comms.v1alpha1.SetTimeCursorRequest, sdk_comms.v1alpha1.SetTimeCursorResponse, sdk_comms.v1alpha1.TimeCursor, sdk_comms.v1alpha1.ViewerTimeline

• string name = 1

A point in time on a timeline: a sequence index for sequence timelines, or nanoseconds for temporal timelines.

Used in: sdk_comms.v1alpha1.SetTimeCursorRequest, sdk_comms.v1alpha1.SetTimeCursorResponse, sdk_comms.v1alpha1.TimeCursor

• int64 time = 1

Used in: cloud.v1alpha1.ChunkKey, cloud.v1alpha1.QueryDatasetRequest, EntryId, log_msg.v1alpha1.ArrowMsg, log_msg.v1alpha1.SetStoreInfo

• 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.