package rerun.frontend.v1alpha1
Get desktop application:
View/edit binary Protocol Buffers messages
service FrontendService
frontend.proto:19Redap's public API.
--- Catalog --- Mostly a 1:1 proxy at the moment.
rpc FindEntries (, )
frontend.proto:23rpc DeleteEntry (, )
frontend.proto:25rpc CreateDatasetEntry (, )
frontend.proto:27rpc ReadDatasetEntry (, )
frontend.proto:29rpc ReadTableEntry (, )
frontend.proto:31rpc RegisterWithDataset (, )
frontend.proto:39Register new partitions with the Dataset
message
frontend.proto:119optional dataset_id = 1
repeated data_sources = 2
common.v1alpha1.IfDuplicateBehavior on_duplicate = 3
rpc WriteChunks (stream , stream )
frontend.proto:42Unimplemented.
message
frontend.proto:125optional dataset_id = 1
Returns the schema of the partition table (i.e. the dataset manifest) itself, *not* the underlying dataset. * To inspect the data of the partition table, use `ScanPartitionTable`. * To retrieve the schema of the underlying dataset, use `GetDatasetSchema` instead.
message
frontend.proto:131optional dataset_id = 1
rpc ScanPartitionTable (, stream )
frontend.proto:55Inspect the contents of the partition table (i.e. the dataset manifest). The returned data will follow the schema specified by `GetPartitionTableSchema`.
message
frontend.proto:135optional dataset_id = 1
optional scan_parameters = 2
rpc GetDatasetSchema (, )
frontend.proto:61Returns the schema of the dataset. This is the union of all the schemas from all the underlying partitions. It will contain all the indexes, entities and components present in the dataset.
message
frontend.proto:140optional dataset_id = 1
rpc CreateIndex (, )
frontend.proto:66Creates a custom index for a specific column (vector search, full-text search, etc).
message
frontend.proto:146optional dataset_id = 1
repeated partition_ids = 2
List of specific partitions that will be indexed (all if left empty).
optional config = 3
common.v1alpha1.IfDuplicateBehavior on_duplicate = 4
Specify behavior when index for a partition was already created.
rpc ReIndex (, )
frontend.proto:69Recreate an index with the same configuration but (potentially) new data.
message
frontend.proto:158optional dataset_id = 1
rpc SearchDataset (, stream )
frontend.proto:74Search a previously created index.
message
frontend.proto:164optional dataset_id = 1
optional column = 2
Index column that is queried
optional query = 3
Query data - type of data is index specific. Caller must ensure to provide the right type. For vector search this should be a vector of appropriate size, for inverted index this should be a string. Query data is represented as a unit (single row) RecordBatch with 1 column.
optional properties = 4
Index type specific properties
optional scan_parameters = 5
Scan parameters
rpc QueryDataset (, stream )
frontend.proto:86Perform Rerun-native queries on a dataset, returning the matching chunk IDs. These Rerun-native queries include: * Filtering by specific partition and chunk IDs. * Latest-at, range and dataframe queries. * Arbitrary Lance filters. To fetch the actual chunks themselves, see `GetChunks`. Passing chunk IDs to this method effectively acts as a IF_EXIST filter.
message
frontend.proto:183optional dataset_id = 1
repeated partition_ids = 2
Client can specify what partitions are queried. If left unspecified (empty list), all partitions will be queried.
repeated chunk_ids = 3
Client can specify specific chunk ids to include. If left unspecified (empty list), all chunks that match other query parameters will be included.
repeated entity_paths = 4
Which entity paths are we interested in? Leave empty to query all of them.
optional scan_parameters = 5
Generic parameters that will influence the behavior of the Lance scanner.
optional query = 6
rpc GetChunks (, stream )
frontend.proto:96Perform Rerun-native queries on a dataset, returning the underlying chunks. These Rerun-native queries include: * Filtering by specific partition and chunk IDs. * Latest-at, range and dataframe queries. * Arbitrary Lance filters. To fetch only the actual chunk IDs rather than the chunks themselves, see `QueryDataset`.
message
frontend.proto:203optional dataset_id = 1
repeated partition_ids = 2
Client can specify from which partitions to get chunks. If left unspecified (empty list), data from all partition (that match other query parameters) will be included.
repeated chunk_ids = 3
Client can specify chunk ids to include. If left unspecified (empty list), all chunks (that match other query parameters) will be included.
repeated entity_paths = 4
Which entity paths are we interested in? Leave empty to query all of them.
optional query = 5
Query details
rpc GetTableSchema (, )
frontend.proto:101message
frontend.proto:223optional table_id = 1
message
frontend.proto:227optional schema = 1
rpc ScanTable (, stream )
frontend.proto:102message
frontend.proto:231optional table_id = 1
TODO(jleibs): support ScanParameters iff we can plumb them into Datafusion TableProvider Otherwise, just wait for Arrow Flight rerun.common.v1alpha1.ScanParameters scan_parameters = 2;
message
frontend.proto:238optional dataframe_part = 1
rpc QueryTasks (, )
frontend.proto:106--- Tasks service --- Query the status of submitted tasks
rpc FetchTaskOutput (, )
frontend.proto:109Fetch the output of a completed task
rpc QueryTasksOnCompletion (, stream )
frontend.proto:112Query the status of submitted tasks as soon as they are no longer pending