@@ -46,7 +46,9 @@ service RerunCloudService {
46
46
47
47
/* Write data */
48
48
49
- // Register new partitions with the Dataset
49
+ // Register new partitions with the Dataset.
50
+ //
51
+ // This endpoint requires the standard dataset headers.
50
52
rpc RegisterWithDataset (RegisterWithDatasetRequest ) returns (RegisterWithDatasetResponse ) {}
51
53
52
54
// Write chunks to one or more partitions.
@@ -71,22 +73,30 @@ service RerunCloudService {
71
73
// Inspect the contents of the partition table.
72
74
//
73
75
// The data will follow the schema returned by `GetPartitionTableSchema`.
76
+ //
77
+ // This endpoint requires the standard dataset headers.
74
78
rpc ScanPartitionTable (ScanPartitionTableRequest ) returns (stream ScanPartitionTableResponse ) {}
75
79
76
80
// Returns the schema of the dataset.
77
81
//
78
82
// This is the union of all the schemas from all the underlying partitions. It will contain all the indexes,
79
83
// entities and components present in the dataset.
84
+ //
85
+ // This endpoint requires the standard dataset headers.
80
86
rpc GetDatasetSchema (GetDatasetSchemaRequest ) returns (GetDatasetSchemaResponse ) {}
81
87
82
88
/* Indexing */
83
89
84
90
// Creates a custom index for a specific column (vector search, full-text search, etc).
91
+ //
92
+ // This endpoint requires the standard dataset headers.
85
93
rpc CreateIndex (CreateIndexRequest ) returns (CreateIndexResponse ) {}
86
94
87
95
/* Queries */
88
96
89
97
// Search a previously created index.
98
+ //
99
+ // This endpoint requires the standard dataset headers.
90
100
rpc SearchDataset (SearchDatasetRequest ) returns (stream SearchDatasetResponse ) {}
91
101
92
102
// Perform Rerun-native queries on a dataset, returning the matching chunk IDs, as well
@@ -103,6 +113,8 @@ service RerunCloudService {
103
113
// To fetch the actual chunks themselves, see `GetChunks`.
104
114
//
105
115
// Passing chunk IDs to this method effectively acts as a IF_EXIST filter.
116
+ //
117
+ // This endpoint requires the standard dataset headers.
106
118
rpc QueryDataset (QueryDatasetRequest ) returns (stream QueryDatasetResponse ) {}
107
119
108
120
// Perform Rerun-native queries on a dataset, returning the underlying chunks.
@@ -113,6 +125,8 @@ service RerunCloudService {
113
125
// * Arbitrary Lance filters.
114
126
//
115
127
// To fetch only the actual chunk IDs rather than the chunks themselves, see `QueryDataset`.
128
+ //
129
+ // This endpoint requires the standard dataset headers.
116
130
rpc GetChunks (GetChunksRequest ) returns (stream GetChunksResponse ) {}
117
131
118
132
// Fetch specific chunks from Rerun Cloud. In a 2-step query process, result of 1st phase,
@@ -146,6 +160,8 @@ service RerunCloudService {
146
160
// --- Utilities ---
147
161
148
162
// Rerun Manifests maintenance operations: scalar index creation, compaction, etc.
163
+ //
164
+ // This endpoint requires the standard dataset headers.
149
165
rpc DoMaintenance (DoMaintenanceRequest ) returns (DoMaintenanceResponse ) {}
150
166
151
167
// Run global maintenance operations on the platform: this includes optimization
@@ -515,8 +531,6 @@ message QueryRange {
515
531
}
516
532
517
533
message GetChunksRequest {
518
- rerun.common.v1alpha1.EntryId dataset_id = 1 ;
519
-
520
534
// Client can specify from which partitions to get chunks. If left unspecified (empty list),
521
535
// data from all partition (that match other query parameters) will be included.
522
536
repeated rerun.common.v1alpha1.PartitionId partition_ids = 2 ;
@@ -562,6 +576,9 @@ message GetChunksRequest {
562
576
563
577
// Query details
564
578
Query query = 5 ;
579
+
580
+ reserved 1 ;
581
+ reserved "dataset_id" ;
565
582
}
566
583
567
584
message GetChunksResponse {
@@ -609,8 +626,6 @@ message ScanTableResponse {
609
626
// --- Maintenance ---
610
627
611
628
message DoMaintenanceRequest {
612
- rerun.common.v1alpha1.EntryId dataset_id = 1 ;
613
-
614
629
// Optimize all builtin and user-defined indexes on this dataset.
615
630
//
616
631
// This merges all individual index deltas back in the main index, improving runtime performance
@@ -645,6 +660,9 @@ message DoMaintenanceRequest {
645
660
//
646
661
// ⚠️ Do not ever use this unless you know exactly what you're doing. Improper use will lead to data loss.
647
662
bool unsafe_allow_recent_cleanup = 5 ;
663
+
664
+ reserved 1 ;
665
+ reserved "dataset_id" ;
648
666
}
649
667
650
668
message DoMaintenanceResponse {
0 commit comments