@loams/client 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +78 -2
- package/dist/app.d.ts +149 -0
- package/dist/app.js +317 -0
- package/dist/builders/filter.d.ts +96 -0
- package/dist/builders/filter.js +190 -0
- package/dist/builders/schema.d.ts +50 -0
- package/dist/builders/schema.js +92 -0
- package/dist/builders/search.d.ts +159 -0
- package/dist/builders/search.js +307 -0
- package/dist/gen/facade.d.ts +267 -2
- package/dist/gen/facade.js +194 -0
- package/dist/handle.d.ts +67 -0
- package/dist/handle.js +107 -0
- package/dist/index.d.ts +12 -5
- package/dist/index.js +12 -3
- package/dist/loams.d.ts +77 -2
- package/dist/loams.js +84 -6
- package/dist/runtime/batch.d.ts +29 -0
- package/dist/runtime/batch.js +95 -0
- package/dist/runtime/call.d.ts +63 -9
- package/dist/runtime/call.js +243 -41
- package/dist/runtime/consistency.d.ts +65 -11
- package/dist/runtime/consistency.js +212 -46
- package/dist/runtime/errors.d.ts +29 -2
- package/dist/runtime/errors.js +26 -0
- package/dist/runtime/pagination.js +8 -2
- package/dist/runtime/subscribe.d.ts +37 -0
- package/dist/runtime/subscribe.js +128 -0
- package/dist/vendor/proto/collection-v1.d.ts +3 -0
- package/dist/vendor/proto/collection-v1.js +7 -0
- package/dist/vendor/proto/gen/loams/collection/v1/collection_pb.d.ts +1610 -0
- package/dist/vendor/proto/gen/loams/collection/v1/collection_pb.js +399 -0
- package/dist/vendor/proto/gen/loams/collection/v1/document_pb.d.ts +1054 -0
- package/dist/vendor/proto/gen/loams/collection/v1/document_pb.js +327 -0
- package/dist/vendor/proto/gen/loams/collection/v1/query_pb.d.ts +2101 -0
- package/dist/vendor/proto/gen/loams/collection/v1/query_pb.js +608 -0
- package/dist/vendor/proto/gen/loams/graph/v1/graph_pb.d.ts +2299 -0
- package/dist/vendor/proto/gen/loams/graph/v1/graph_pb.js +596 -0
- package/dist/vendor/proto/gen/loams/operations/v1/operations_pb.d.ts +399 -0
- package/dist/vendor/proto/gen/loams/operations/v1/operations_pb.js +118 -0
- package/dist/vendor/proto/gen/loams/sql/v1/sql_pb.d.ts +182 -0
- package/dist/vendor/proto/gen/loams/sql/v1/sql_pb.js +72 -0
- package/dist/vendor/proto/gen/loams/stream/v1/stream_pb.d.ts +688 -0
- package/dist/vendor/proto/gen/loams/stream/v1/stream_pb.js +180 -0
- package/package.json +2 -2
|
@@ -0,0 +1,1610 @@
|
|
|
1
|
+
import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
|
|
2
|
+
import type { JsonObject, Message } from "@bufbuild/protobuf";
|
|
3
|
+
/**
|
|
4
|
+
* Describes the file loams/collection/v1/collection.proto.
|
|
5
|
+
*/
|
|
6
|
+
export declare const file_loams_collection_v1_collection: GenFile;
|
|
7
|
+
/**
|
|
8
|
+
* @generated from message loams.collection.v1.CreateNamespaceRequest
|
|
9
|
+
*/
|
|
10
|
+
export type CreateNamespaceRequest = Message<"loams.collection.v1.CreateNamespaceRequest"> & {
|
|
11
|
+
/**
|
|
12
|
+
* The namespace's name, unique in the instance. Names are the REST route's
|
|
13
|
+
* names verbatim, so a caller migrating only changes its envelope.
|
|
14
|
+
*
|
|
15
|
+
* @generated from field: string namespace = 1;
|
|
16
|
+
*/
|
|
17
|
+
namespace: string;
|
|
18
|
+
};
|
|
19
|
+
/**
|
|
20
|
+
* Describes the message loams.collection.v1.CreateNamespaceRequest.
|
|
21
|
+
* Use `create(CreateNamespaceRequestSchema)` to create a new message.
|
|
22
|
+
*/
|
|
23
|
+
export declare const CreateNamespaceRequestSchema: GenMessage<CreateNamespaceRequest>;
|
|
24
|
+
/**
|
|
25
|
+
* @generated from message loams.collection.v1.CreateNamespaceResponse
|
|
26
|
+
*/
|
|
27
|
+
export type CreateNamespaceResponse = Message<"loams.collection.v1.CreateNamespaceResponse"> & {
|
|
28
|
+
/**
|
|
29
|
+
* The namespace that now exists, by name.
|
|
30
|
+
*
|
|
31
|
+
* @generated from field: string namespace = 1;
|
|
32
|
+
*/
|
|
33
|
+
namespace: string;
|
|
34
|
+
/**
|
|
35
|
+
* Its id, stable for the life of the namespace. A decimal string in JSON.
|
|
36
|
+
*
|
|
37
|
+
* @generated from field: uint64 namespace_id = 2;
|
|
38
|
+
*/
|
|
39
|
+
namespaceId: bigint;
|
|
40
|
+
};
|
|
41
|
+
/**
|
|
42
|
+
* Describes the message loams.collection.v1.CreateNamespaceResponse.
|
|
43
|
+
* Use `create(CreateNamespaceResponseSchema)` to create a new message.
|
|
44
|
+
*/
|
|
45
|
+
export declare const CreateNamespaceResponseSchema: GenMessage<CreateNamespaceResponse>;
|
|
46
|
+
/**
|
|
47
|
+
* @generated from message loams.collection.v1.ListNamespacesRequest
|
|
48
|
+
*/
|
|
49
|
+
export type ListNamespacesRequest = Message<"loams.collection.v1.ListNamespacesRequest"> & {
|
|
50
|
+
/**
|
|
51
|
+
* AIP-158 page size; 0 or absent is every namespace that fits.
|
|
52
|
+
*
|
|
53
|
+
* @generated from field: int32 page_size = 1;
|
|
54
|
+
*/
|
|
55
|
+
pageSize: number;
|
|
56
|
+
/**
|
|
57
|
+
* The `next_page_token` of the previous page; absent starts at the first.
|
|
58
|
+
*
|
|
59
|
+
* @generated from field: string page_token = 2;
|
|
60
|
+
*/
|
|
61
|
+
pageToken: string;
|
|
62
|
+
};
|
|
63
|
+
/**
|
|
64
|
+
* Describes the message loams.collection.v1.ListNamespacesRequest.
|
|
65
|
+
* Use `create(ListNamespacesRequestSchema)` to create a new message.
|
|
66
|
+
*/
|
|
67
|
+
export declare const ListNamespacesRequestSchema: GenMessage<ListNamespacesRequest>;
|
|
68
|
+
/**
|
|
69
|
+
* @generated from message loams.collection.v1.ListNamespacesResponse
|
|
70
|
+
*/
|
|
71
|
+
export type ListNamespacesResponse = Message<"loams.collection.v1.ListNamespacesResponse"> & {
|
|
72
|
+
/**
|
|
73
|
+
* By name.
|
|
74
|
+
*
|
|
75
|
+
* @generated from field: repeated loams.collection.v1.NamespaceInfo namespaces = 1;
|
|
76
|
+
*/
|
|
77
|
+
namespaces: NamespaceInfo[];
|
|
78
|
+
/**
|
|
79
|
+
* Absent on the last page.
|
|
80
|
+
*
|
|
81
|
+
* @generated from field: string next_page_token = 2;
|
|
82
|
+
*/
|
|
83
|
+
nextPageToken: string;
|
|
84
|
+
};
|
|
85
|
+
/**
|
|
86
|
+
* Describes the message loams.collection.v1.ListNamespacesResponse.
|
|
87
|
+
* Use `create(ListNamespacesResponseSchema)` to create a new message.
|
|
88
|
+
*/
|
|
89
|
+
export declare const ListNamespacesResponseSchema: GenMessage<ListNamespacesResponse>;
|
|
90
|
+
/**
|
|
91
|
+
* One namespace, as `ListNamespaces` answers it.
|
|
92
|
+
*
|
|
93
|
+
* @generated from message loams.collection.v1.NamespaceInfo
|
|
94
|
+
*/
|
|
95
|
+
export type NamespaceInfo = Message<"loams.collection.v1.NamespaceInfo"> & {
|
|
96
|
+
/**
|
|
97
|
+
* The namespace's name.
|
|
98
|
+
*
|
|
99
|
+
* @generated from field: string namespace = 1;
|
|
100
|
+
*/
|
|
101
|
+
namespace: string;
|
|
102
|
+
/**
|
|
103
|
+
* Its id, stable for the life of the namespace. A decimal string in JSON.
|
|
104
|
+
*
|
|
105
|
+
* @generated from field: uint64 namespace_id = 2;
|
|
106
|
+
*/
|
|
107
|
+
namespaceId: bigint;
|
|
108
|
+
/**
|
|
109
|
+
* How many collections it holds (absent: none).
|
|
110
|
+
*
|
|
111
|
+
* @generated from field: uint32 collection_count = 3;
|
|
112
|
+
*/
|
|
113
|
+
collectionCount: number;
|
|
114
|
+
/**
|
|
115
|
+
* How many streams it holds, a collection's own implicit stream and the
|
|
116
|
+
* engine's internal streams (names starting with `_`) not counted.
|
|
117
|
+
*
|
|
118
|
+
* @generated from field: uint32 stream_count = 4;
|
|
119
|
+
*/
|
|
120
|
+
streamCount: number;
|
|
121
|
+
};
|
|
122
|
+
/**
|
|
123
|
+
* Describes the message loams.collection.v1.NamespaceInfo.
|
|
124
|
+
* Use `create(NamespaceInfoSchema)` to create a new message.
|
|
125
|
+
*/
|
|
126
|
+
export declare const NamespaceInfoSchema: GenMessage<NamespaceInfo>;
|
|
127
|
+
/**
|
|
128
|
+
* @generated from message loams.collection.v1.CreateCollectionRequest
|
|
129
|
+
*/
|
|
130
|
+
export type CreateCollectionRequest = Message<"loams.collection.v1.CreateCollectionRequest"> & {
|
|
131
|
+
/**
|
|
132
|
+
* @generated from field: string namespace = 1;
|
|
133
|
+
*/
|
|
134
|
+
namespace: string;
|
|
135
|
+
/**
|
|
136
|
+
* The collection's name, unique in the namespace and never an alias.
|
|
137
|
+
*
|
|
138
|
+
* @generated from field: string name = 2;
|
|
139
|
+
*/
|
|
140
|
+
name: string;
|
|
141
|
+
/**
|
|
142
|
+
* The schema, as the native REST route's schema JSON (see the header).
|
|
143
|
+
*
|
|
144
|
+
* @generated from field: google.protobuf.Struct schema = 3;
|
|
145
|
+
*/
|
|
146
|
+
schema?: JsonObject | undefined;
|
|
147
|
+
/**
|
|
148
|
+
* The collection's partition count. Absent takes the server's default; a
|
|
149
|
+
* repeat of a create must send the same count or it is `already_exists`.
|
|
150
|
+
*
|
|
151
|
+
* @generated from field: optional uint32 partitions = 4;
|
|
152
|
+
*/
|
|
153
|
+
partitions?: number | undefined;
|
|
154
|
+
};
|
|
155
|
+
/**
|
|
156
|
+
* Describes the message loams.collection.v1.CreateCollectionRequest.
|
|
157
|
+
* Use `create(CreateCollectionRequestSchema)` to create a new message.
|
|
158
|
+
*/
|
|
159
|
+
export declare const CreateCollectionRequestSchema: GenMessage<CreateCollectionRequest>;
|
|
160
|
+
/**
|
|
161
|
+
* @generated from message loams.collection.v1.ListCollectionsRequest
|
|
162
|
+
*/
|
|
163
|
+
export type ListCollectionsRequest = Message<"loams.collection.v1.ListCollectionsRequest"> & {
|
|
164
|
+
/**
|
|
165
|
+
* @generated from field: string namespace = 1;
|
|
166
|
+
*/
|
|
167
|
+
namespace: string;
|
|
168
|
+
/**
|
|
169
|
+
* AIP-158 page size; 0 or absent is every collection that fits.
|
|
170
|
+
*
|
|
171
|
+
* @generated from field: int32 page_size = 2;
|
|
172
|
+
*/
|
|
173
|
+
pageSize: number;
|
|
174
|
+
/**
|
|
175
|
+
* The `next_page_token` of the previous page; absent starts at the first.
|
|
176
|
+
*
|
|
177
|
+
* @generated from field: string page_token = 3;
|
|
178
|
+
*/
|
|
179
|
+
pageToken: string;
|
|
180
|
+
};
|
|
181
|
+
/**
|
|
182
|
+
* Describes the message loams.collection.v1.ListCollectionsRequest.
|
|
183
|
+
* Use `create(ListCollectionsRequestSchema)` to create a new message.
|
|
184
|
+
*/
|
|
185
|
+
export declare const ListCollectionsRequestSchema: GenMessage<ListCollectionsRequest>;
|
|
186
|
+
/**
|
|
187
|
+
* @generated from message loams.collection.v1.ListCollectionsResponse
|
|
188
|
+
*/
|
|
189
|
+
export type ListCollectionsResponse = Message<"loams.collection.v1.ListCollectionsResponse"> & {
|
|
190
|
+
/**
|
|
191
|
+
* By name.
|
|
192
|
+
*
|
|
193
|
+
* @generated from field: repeated loams.collection.v1.CollectionInfo collections = 1;
|
|
194
|
+
*/
|
|
195
|
+
collections: CollectionInfo[];
|
|
196
|
+
/**
|
|
197
|
+
* Absent on the last page.
|
|
198
|
+
*
|
|
199
|
+
* @generated from field: string next_page_token = 2;
|
|
200
|
+
*/
|
|
201
|
+
nextPageToken: string;
|
|
202
|
+
};
|
|
203
|
+
/**
|
|
204
|
+
* Describes the message loams.collection.v1.ListCollectionsResponse.
|
|
205
|
+
* Use `create(ListCollectionsResponseSchema)` to create a new message.
|
|
206
|
+
*/
|
|
207
|
+
export declare const ListCollectionsResponseSchema: GenMessage<ListCollectionsResponse>;
|
|
208
|
+
/**
|
|
209
|
+
* @generated from message loams.collection.v1.GetCollectionRequest
|
|
210
|
+
*/
|
|
211
|
+
export type GetCollectionRequest = Message<"loams.collection.v1.GetCollectionRequest"> & {
|
|
212
|
+
/**
|
|
213
|
+
* @generated from field: string namespace = 1;
|
|
214
|
+
*/
|
|
215
|
+
namespace: string;
|
|
216
|
+
/**
|
|
217
|
+
* A collection name or an alias.
|
|
218
|
+
*
|
|
219
|
+
* @generated from field: string collection = 2;
|
|
220
|
+
*/
|
|
221
|
+
collection: string;
|
|
222
|
+
};
|
|
223
|
+
/**
|
|
224
|
+
* Describes the message loams.collection.v1.GetCollectionRequest.
|
|
225
|
+
* Use `create(GetCollectionRequestSchema)` to create a new message.
|
|
226
|
+
*/
|
|
227
|
+
export declare const GetCollectionRequestSchema: GenMessage<GetCollectionRequest>;
|
|
228
|
+
/**
|
|
229
|
+
* @generated from message loams.collection.v1.DropCollectionRequest
|
|
230
|
+
*/
|
|
231
|
+
export type DropCollectionRequest = Message<"loams.collection.v1.DropCollectionRequest"> & {
|
|
232
|
+
/**
|
|
233
|
+
* @generated from field: string namespace = 1;
|
|
234
|
+
*/
|
|
235
|
+
namespace: string;
|
|
236
|
+
/**
|
|
237
|
+
* A collection name, never an alias: dropping an alias is not a thing.
|
|
238
|
+
*
|
|
239
|
+
* @generated from field: string collection = 2;
|
|
240
|
+
*/
|
|
241
|
+
collection: string;
|
|
242
|
+
};
|
|
243
|
+
/**
|
|
244
|
+
* Describes the message loams.collection.v1.DropCollectionRequest.
|
|
245
|
+
* Use `create(DropCollectionRequestSchema)` to create a new message.
|
|
246
|
+
*/
|
|
247
|
+
export declare const DropCollectionRequestSchema: GenMessage<DropCollectionRequest>;
|
|
248
|
+
/**
|
|
249
|
+
* @generated from message loams.collection.v1.DropCollectionResponse
|
|
250
|
+
*/
|
|
251
|
+
export type DropCollectionResponse = Message<"loams.collection.v1.DropCollectionResponse"> & {
|
|
252
|
+
/**
|
|
253
|
+
* Whether this call dropped a collection. `false` when there was nothing
|
|
254
|
+
* to drop, and absent in JSON because `false` is a proto3 default.
|
|
255
|
+
*
|
|
256
|
+
* @generated from field: bool dropped = 1;
|
|
257
|
+
*/
|
|
258
|
+
dropped: boolean;
|
|
259
|
+
};
|
|
260
|
+
/**
|
|
261
|
+
* Describes the message loams.collection.v1.DropCollectionResponse.
|
|
262
|
+
* Use `create(DropCollectionResponseSchema)` to create a new message.
|
|
263
|
+
*/
|
|
264
|
+
export declare const DropCollectionResponseSchema: GenMessage<DropCollectionResponse>;
|
|
265
|
+
/**
|
|
266
|
+
* @generated from message loams.collection.v1.AddFieldsRequest
|
|
267
|
+
*/
|
|
268
|
+
export type AddFieldsRequest = Message<"loams.collection.v1.AddFieldsRequest"> & {
|
|
269
|
+
/**
|
|
270
|
+
* @generated from field: string namespace = 1;
|
|
271
|
+
*/
|
|
272
|
+
namespace: string;
|
|
273
|
+
/**
|
|
274
|
+
* A collection name or an alias.
|
|
275
|
+
*
|
|
276
|
+
* @generated from field: string collection = 2;
|
|
277
|
+
*/
|
|
278
|
+
collection: string;
|
|
279
|
+
/**
|
|
280
|
+
* The fields to add, as the native REST route's field JSON
|
|
281
|
+
* (`{"name", "source_path"?, "kind", "indexed"?, "fast"?,
|
|
282
|
+
* "ignore_malformed"?}`).
|
|
283
|
+
*
|
|
284
|
+
* @generated from field: repeated google.protobuf.Struct fields = 3;
|
|
285
|
+
*/
|
|
286
|
+
fields: JsonObject[];
|
|
287
|
+
/**
|
|
288
|
+
* The vectors to add, in the same form (`{"name", "dim", "distance", …}`).
|
|
289
|
+
*
|
|
290
|
+
* @generated from field: repeated google.protobuf.Struct vectors = 4;
|
|
291
|
+
*/
|
|
292
|
+
vectors: JsonObject[];
|
|
293
|
+
/**
|
|
294
|
+
* Schema annotations to set, by key; existing keys are replaced.
|
|
295
|
+
*
|
|
296
|
+
* @generated from field: map<string, string> annotations = 5;
|
|
297
|
+
*/
|
|
298
|
+
annotations: {
|
|
299
|
+
[key: string]: string;
|
|
300
|
+
};
|
|
301
|
+
};
|
|
302
|
+
/**
|
|
303
|
+
* Describes the message loams.collection.v1.AddFieldsRequest.
|
|
304
|
+
* Use `create(AddFieldsRequestSchema)` to create a new message.
|
|
305
|
+
*/
|
|
306
|
+
export declare const AddFieldsRequestSchema: GenMessage<AddFieldsRequest>;
|
|
307
|
+
/**
|
|
308
|
+
* @generated from message loams.collection.v1.AddFieldsResponse
|
|
309
|
+
*/
|
|
310
|
+
export type AddFieldsResponse = Message<"loams.collection.v1.AddFieldsResponse"> & {
|
|
311
|
+
/**
|
|
312
|
+
* The published schema, at its new version.
|
|
313
|
+
*
|
|
314
|
+
* @generated from field: google.protobuf.Struct schema = 1;
|
|
315
|
+
*/
|
|
316
|
+
schema?: JsonObject | undefined;
|
|
317
|
+
};
|
|
318
|
+
/**
|
|
319
|
+
* Describes the message loams.collection.v1.AddFieldsResponse.
|
|
320
|
+
* Use `create(AddFieldsResponseSchema)` to create a new message.
|
|
321
|
+
*/
|
|
322
|
+
export declare const AddFieldsResponseSchema: GenMessage<AddFieldsResponse>;
|
|
323
|
+
/**
|
|
324
|
+
* @generated from message loams.collection.v1.ListVersionsRequest
|
|
325
|
+
*/
|
|
326
|
+
export type ListVersionsRequest = Message<"loams.collection.v1.ListVersionsRequest"> & {
|
|
327
|
+
/**
|
|
328
|
+
* @generated from field: string namespace = 1;
|
|
329
|
+
*/
|
|
330
|
+
namespace: string;
|
|
331
|
+
/**
|
|
332
|
+
* A collection name or an alias.
|
|
333
|
+
*
|
|
334
|
+
* @generated from field: string collection = 2;
|
|
335
|
+
*/
|
|
336
|
+
collection: string;
|
|
337
|
+
/**
|
|
338
|
+
* @generated from field: int32 page_size = 3;
|
|
339
|
+
*/
|
|
340
|
+
pageSize: number;
|
|
341
|
+
/**
|
|
342
|
+
* @generated from field: string page_token = 4;
|
|
343
|
+
*/
|
|
344
|
+
pageToken: string;
|
|
345
|
+
};
|
|
346
|
+
/**
|
|
347
|
+
* Describes the message loams.collection.v1.ListVersionsRequest.
|
|
348
|
+
* Use `create(ListVersionsRequestSchema)` to create a new message.
|
|
349
|
+
*/
|
|
350
|
+
export declare const ListVersionsRequestSchema: GenMessage<ListVersionsRequest>;
|
|
351
|
+
/**
|
|
352
|
+
* @generated from message loams.collection.v1.ListVersionsResponse
|
|
353
|
+
*/
|
|
354
|
+
export type ListVersionsResponse = Message<"loams.collection.v1.ListVersionsResponse"> & {
|
|
355
|
+
/**
|
|
356
|
+
* Oldest first, so a caller walks the chain forwards.
|
|
357
|
+
*
|
|
358
|
+
* @generated from field: repeated loams.collection.v1.ManifestVersion versions = 1;
|
|
359
|
+
*/
|
|
360
|
+
versions: ManifestVersion[];
|
|
361
|
+
/**
|
|
362
|
+
* Absent on the last page.
|
|
363
|
+
*
|
|
364
|
+
* @generated from field: string next_page_token = 2;
|
|
365
|
+
*/
|
|
366
|
+
nextPageToken: string;
|
|
367
|
+
};
|
|
368
|
+
/**
|
|
369
|
+
* Describes the message loams.collection.v1.ListVersionsResponse.
|
|
370
|
+
* Use `create(ListVersionsResponseSchema)` to create a new message.
|
|
371
|
+
*/
|
|
372
|
+
export declare const ListVersionsResponseSchema: GenMessage<ListVersionsResponse>;
|
|
373
|
+
/**
|
|
374
|
+
* One retained manifest of a collection.
|
|
375
|
+
*
|
|
376
|
+
* @generated from message loams.collection.v1.ManifestVersion
|
|
377
|
+
*/
|
|
378
|
+
export type ManifestVersion = Message<"loams.collection.v1.ManifestVersion"> & {
|
|
379
|
+
/**
|
|
380
|
+
* The manifest version, as `ScanRequest.at.manifest_version` names it.
|
|
381
|
+
*
|
|
382
|
+
* @generated from field: uint64 version = 1;
|
|
383
|
+
*/
|
|
384
|
+
version: bigint;
|
|
385
|
+
/**
|
|
386
|
+
* When it was committed, on the metastore clock.
|
|
387
|
+
*
|
|
388
|
+
* @generated from field: uint64 created_at_ms = 2;
|
|
389
|
+
*/
|
|
390
|
+
createdAtMs: bigint;
|
|
391
|
+
/**
|
|
392
|
+
* The size of the collection at this manifest.
|
|
393
|
+
*
|
|
394
|
+
* @generated from field: uint64 size_bytes = 3;
|
|
395
|
+
*/
|
|
396
|
+
sizeBytes: bigint;
|
|
397
|
+
/**
|
|
398
|
+
* The live document count at this manifest.
|
|
399
|
+
*
|
|
400
|
+
* @generated from field: uint64 live_doc_count = 4;
|
|
401
|
+
*/
|
|
402
|
+
liveDocCount: bigint;
|
|
403
|
+
/**
|
|
404
|
+
* The Lance version this manifest names; 0 while it names none.
|
|
405
|
+
*
|
|
406
|
+
* @generated from field: uint64 lance_version = 5;
|
|
407
|
+
*/
|
|
408
|
+
lanceVersion: bigint;
|
|
409
|
+
};
|
|
410
|
+
/**
|
|
411
|
+
* Describes the message loams.collection.v1.ManifestVersion.
|
|
412
|
+
* Use `create(ManifestVersionSchema)` to create a new message.
|
|
413
|
+
*/
|
|
414
|
+
export declare const ManifestVersionSchema: GenMessage<ManifestVersion>;
|
|
415
|
+
/**
|
|
416
|
+
* @generated from message loams.collection.v1.ScanRequest
|
|
417
|
+
*/
|
|
418
|
+
export type ScanRequest = Message<"loams.collection.v1.ScanRequest"> & {
|
|
419
|
+
/**
|
|
420
|
+
* @generated from field: string namespace = 1;
|
|
421
|
+
*/
|
|
422
|
+
namespace: string;
|
|
423
|
+
/**
|
|
424
|
+
* A collection name or an alias. The plan reports the collection's own
|
|
425
|
+
* name, never the alias it was asked by.
|
|
426
|
+
*
|
|
427
|
+
* @generated from field: string collection = 2;
|
|
428
|
+
*/
|
|
429
|
+
collection: string;
|
|
430
|
+
/**
|
|
431
|
+
* The state to plan; absent plans the live manifest. A `ScanPoint` is a
|
|
432
|
+
* oneof, so the state is always named: the REST route's bare `"current"`
|
|
433
|
+
* string has no proto3 JSON spelling, and the absent field is how a caller
|
|
434
|
+
* asks for the live manifest.
|
|
435
|
+
*
|
|
436
|
+
* @generated from field: loams.collection.v1.ScanPoint at = 3;
|
|
437
|
+
*/
|
|
438
|
+
at?: ScanPoint | undefined;
|
|
439
|
+
};
|
|
440
|
+
/**
|
|
441
|
+
* Describes the message loams.collection.v1.ScanRequest.
|
|
442
|
+
* Use `create(ScanRequestSchema)` to create a new message.
|
|
443
|
+
*/
|
|
444
|
+
export declare const ScanRequestSchema: GenMessage<ScanRequest>;
|
|
445
|
+
/**
|
|
446
|
+
* The state a scan plans: absent is the live manifest.
|
|
447
|
+
*
|
|
448
|
+
* @generated from message loams.collection.v1.ScanPoint
|
|
449
|
+
*/
|
|
450
|
+
export type ScanPoint = Message<"loams.collection.v1.ScanPoint"> & {
|
|
451
|
+
/**
|
|
452
|
+
* @generated from oneof loams.collection.v1.ScanPoint.point
|
|
453
|
+
*/
|
|
454
|
+
point: {
|
|
455
|
+
/**
|
|
456
|
+
* A retained manifest version, as it is.
|
|
457
|
+
*
|
|
458
|
+
* @generated from field: uint64 manifest_version = 1;
|
|
459
|
+
*/
|
|
460
|
+
value: bigint;
|
|
461
|
+
case: "manifestVersion";
|
|
462
|
+
} | {
|
|
463
|
+
/**
|
|
464
|
+
* A consistency token an earlier `Scan` answered (its
|
|
465
|
+
* `loams-consistency-token` header, or `pin.token`): the first live
|
|
466
|
+
* manifest whose applied offsets cover it.
|
|
467
|
+
*
|
|
468
|
+
* @generated from field: string token = 2;
|
|
469
|
+
*/
|
|
470
|
+
value: string;
|
|
471
|
+
case: "token";
|
|
472
|
+
} | {
|
|
473
|
+
case: undefined;
|
|
474
|
+
value?: undefined;
|
|
475
|
+
};
|
|
476
|
+
};
|
|
477
|
+
/**
|
|
478
|
+
* Describes the message loams.collection.v1.ScanPoint.
|
|
479
|
+
* Use `create(ScanPointSchema)` to create a new message.
|
|
480
|
+
*/
|
|
481
|
+
export declare const ScanPointSchema: GenMessage<ScanPoint>;
|
|
482
|
+
/**
|
|
483
|
+
* @generated from message loams.collection.v1.UpdateAliasesRequest
|
|
484
|
+
*/
|
|
485
|
+
export type UpdateAliasesRequest = Message<"loams.collection.v1.UpdateAliasesRequest"> & {
|
|
486
|
+
/**
|
|
487
|
+
* @generated from field: string namespace = 1;
|
|
488
|
+
*/
|
|
489
|
+
namespace: string;
|
|
490
|
+
/**
|
|
491
|
+
* Applied atomically, in order.
|
|
492
|
+
*
|
|
493
|
+
* @generated from field: repeated loams.collection.v1.AliasAction actions = 2;
|
|
494
|
+
*/
|
|
495
|
+
actions: AliasAction[];
|
|
496
|
+
};
|
|
497
|
+
/**
|
|
498
|
+
* Describes the message loams.collection.v1.UpdateAliasesRequest.
|
|
499
|
+
* Use `create(UpdateAliasesRequestSchema)` to create a new message.
|
|
500
|
+
*/
|
|
501
|
+
export declare const UpdateAliasesRequestSchema: GenMessage<UpdateAliasesRequest>;
|
|
502
|
+
/**
|
|
503
|
+
* One alias change. A proto oneof, so the JSON is the REST route's
|
|
504
|
+
* `{"create": {…}}` / `{"delete": {…}}` unchanged.
|
|
505
|
+
*
|
|
506
|
+
* @generated from message loams.collection.v1.AliasAction
|
|
507
|
+
*/
|
|
508
|
+
export type AliasAction = Message<"loams.collection.v1.AliasAction"> & {
|
|
509
|
+
/**
|
|
510
|
+
* @generated from oneof loams.collection.v1.AliasAction.action
|
|
511
|
+
*/
|
|
512
|
+
action: {
|
|
513
|
+
/**
|
|
514
|
+
* Points `alias` at a collection, creating or re-pointing it.
|
|
515
|
+
*
|
|
516
|
+
* @generated from field: loams.collection.v1.CreateAlias create = 1;
|
|
517
|
+
*/
|
|
518
|
+
value: CreateAlias;
|
|
519
|
+
case: "create";
|
|
520
|
+
} | {
|
|
521
|
+
/**
|
|
522
|
+
* Removes an alias; a missing alias is a no-op.
|
|
523
|
+
*
|
|
524
|
+
* @generated from field: loams.collection.v1.DeleteAlias delete = 2;
|
|
525
|
+
*/
|
|
526
|
+
value: DeleteAlias;
|
|
527
|
+
case: "delete";
|
|
528
|
+
} | {
|
|
529
|
+
case: undefined;
|
|
530
|
+
value?: undefined;
|
|
531
|
+
};
|
|
532
|
+
};
|
|
533
|
+
/**
|
|
534
|
+
* Describes the message loams.collection.v1.AliasAction.
|
|
535
|
+
* Use `create(AliasActionSchema)` to create a new message.
|
|
536
|
+
*/
|
|
537
|
+
export declare const AliasActionSchema: GenMessage<AliasAction>;
|
|
538
|
+
/**
|
|
539
|
+
* @generated from message loams.collection.v1.CreateAlias
|
|
540
|
+
*/
|
|
541
|
+
export type CreateAlias = Message<"loams.collection.v1.CreateAlias"> & {
|
|
542
|
+
/**
|
|
543
|
+
* @generated from field: string alias = 1;
|
|
544
|
+
*/
|
|
545
|
+
alias: string;
|
|
546
|
+
/**
|
|
547
|
+
* A collection name, never an alias.
|
|
548
|
+
*
|
|
549
|
+
* @generated from field: string collection = 2;
|
|
550
|
+
*/
|
|
551
|
+
collection: string;
|
|
552
|
+
};
|
|
553
|
+
/**
|
|
554
|
+
* Describes the message loams.collection.v1.CreateAlias.
|
|
555
|
+
* Use `create(CreateAliasSchema)` to create a new message.
|
|
556
|
+
*/
|
|
557
|
+
export declare const CreateAliasSchema: GenMessage<CreateAlias>;
|
|
558
|
+
/**
|
|
559
|
+
* @generated from message loams.collection.v1.DeleteAlias
|
|
560
|
+
*/
|
|
561
|
+
export type DeleteAlias = Message<"loams.collection.v1.DeleteAlias"> & {
|
|
562
|
+
/**
|
|
563
|
+
* @generated from field: string alias = 1;
|
|
564
|
+
*/
|
|
565
|
+
alias: string;
|
|
566
|
+
};
|
|
567
|
+
/**
|
|
568
|
+
* Describes the message loams.collection.v1.DeleteAlias.
|
|
569
|
+
* Use `create(DeleteAliasSchema)` to create a new message.
|
|
570
|
+
*/
|
|
571
|
+
export declare const DeleteAliasSchema: GenMessage<DeleteAlias>;
|
|
572
|
+
/**
|
|
573
|
+
* @generated from message loams.collection.v1.UpdateAliasesResponse
|
|
574
|
+
*/
|
|
575
|
+
export type UpdateAliasesResponse = Message<"loams.collection.v1.UpdateAliasesResponse"> & {};
|
|
576
|
+
/**
|
|
577
|
+
* Describes the message loams.collection.v1.UpdateAliasesResponse.
|
|
578
|
+
* Use `create(UpdateAliasesResponseSchema)` to create a new message.
|
|
579
|
+
*/
|
|
580
|
+
export declare const UpdateAliasesResponseSchema: GenMessage<UpdateAliasesResponse>;
|
|
581
|
+
/**
|
|
582
|
+
* @generated from message loams.collection.v1.SetHotRequest
|
|
583
|
+
*/
|
|
584
|
+
export type SetHotRequest = Message<"loams.collection.v1.SetHotRequest"> & {
|
|
585
|
+
/**
|
|
586
|
+
* @generated from field: string namespace = 1;
|
|
587
|
+
*/
|
|
588
|
+
namespace: string;
|
|
589
|
+
/**
|
|
590
|
+
* A collection name or an alias.
|
|
591
|
+
*
|
|
592
|
+
* @generated from field: string collection = 2;
|
|
593
|
+
*/
|
|
594
|
+
collection: string;
|
|
595
|
+
/**
|
|
596
|
+
* The configuration to write. Every key absent is `false`, so the call
|
|
597
|
+
* states the whole configuration rather than a patch of it.
|
|
598
|
+
*
|
|
599
|
+
* @generated from field: loams.collection.v1.HotConfig hot = 3;
|
|
600
|
+
*/
|
|
601
|
+
hot?: HotConfig | undefined;
|
|
602
|
+
};
|
|
603
|
+
/**
|
|
604
|
+
* Describes the message loams.collection.v1.SetHotRequest.
|
|
605
|
+
* Use `create(SetHotRequestSchema)` to create a new message.
|
|
606
|
+
*/
|
|
607
|
+
export declare const SetHotRequestSchema: GenMessage<SetHotRequest>;
|
|
608
|
+
/**
|
|
609
|
+
* @generated from message loams.collection.v1.SetHotResponse
|
|
610
|
+
*/
|
|
611
|
+
export type SetHotResponse = Message<"loams.collection.v1.SetHotResponse"> & {
|
|
612
|
+
/**
|
|
613
|
+
* The status the local hot tier now builds towards.
|
|
614
|
+
*
|
|
615
|
+
* @generated from field: loams.collection.v1.HotStatus hot = 1;
|
|
616
|
+
*/
|
|
617
|
+
hot?: HotStatus | undefined;
|
|
618
|
+
};
|
|
619
|
+
/**
|
|
620
|
+
* Describes the message loams.collection.v1.SetHotResponse.
|
|
621
|
+
* Use `create(SetHotResponseSchema)` to create a new message.
|
|
622
|
+
*/
|
|
623
|
+
export declare const SetHotResponseSchema: GenMessage<SetHotResponse>;
|
|
624
|
+
/**
|
|
625
|
+
* @generated from message loams.collection.v1.WarmCollectionRequest
|
|
626
|
+
*/
|
|
627
|
+
export type WarmCollectionRequest = Message<"loams.collection.v1.WarmCollectionRequest"> & {
|
|
628
|
+
/**
|
|
629
|
+
* @generated from field: string namespace = 1;
|
|
630
|
+
*/
|
|
631
|
+
namespace: string;
|
|
632
|
+
/**
|
|
633
|
+
* A collection name or an alias.
|
|
634
|
+
*
|
|
635
|
+
* @generated from field: string collection = 2;
|
|
636
|
+
*/
|
|
637
|
+
collection: string;
|
|
638
|
+
};
|
|
639
|
+
/**
|
|
640
|
+
* Describes the message loams.collection.v1.WarmCollectionRequest.
|
|
641
|
+
* Use `create(WarmCollectionRequestSchema)` to create a new message.
|
|
642
|
+
*/
|
|
643
|
+
export declare const WarmCollectionRequestSchema: GenMessage<WarmCollectionRequest>;
|
|
644
|
+
/**
|
|
645
|
+
* @generated from message loams.collection.v1.WarmCollectionResponse
|
|
646
|
+
*/
|
|
647
|
+
export type WarmCollectionResponse = Message<"loams.collection.v1.WarmCollectionResponse"> & {};
|
|
648
|
+
/**
|
|
649
|
+
* Describes the message loams.collection.v1.WarmCollectionResponse.
|
|
650
|
+
* Use `create(WarmCollectionResponseSchema)` to create a new message.
|
|
651
|
+
*/
|
|
652
|
+
export declare const WarmCollectionResponseSchema: GenMessage<WarmCollectionResponse>;
|
|
653
|
+
/**
|
|
654
|
+
* What to keep hot for a collection (M1.3 Task 8 rule 1).
|
|
655
|
+
*
|
|
656
|
+
* @generated from message loams.collection.v1.HotConfig
|
|
657
|
+
*/
|
|
658
|
+
export type HotConfig = Message<"loams.collection.v1.HotConfig"> & {
|
|
659
|
+
/**
|
|
660
|
+
* @generated from field: bool vectors = 1;
|
|
661
|
+
*/
|
|
662
|
+
vectors: boolean;
|
|
663
|
+
/**
|
|
664
|
+
* @generated from field: bool text = 2;
|
|
665
|
+
*/
|
|
666
|
+
text: boolean;
|
|
667
|
+
/**
|
|
668
|
+
* @generated from field: bool fragments = 3;
|
|
669
|
+
*/
|
|
670
|
+
fragments: boolean;
|
|
671
|
+
};
|
|
672
|
+
/**
|
|
673
|
+
* Describes the message loams.collection.v1.HotConfig.
|
|
674
|
+
* Use `create(HotConfigSchema)` to create a new message.
|
|
675
|
+
*/
|
|
676
|
+
export declare const HotConfigSchema: GenMessage<HotConfig>;
|
|
677
|
+
/**
|
|
678
|
+
* One collection, as `GetCollection` and the collection-carrying list RPCs
|
|
679
|
+
* answer it.
|
|
680
|
+
*
|
|
681
|
+
* @generated from message loams.collection.v1.CollectionInfo
|
|
682
|
+
*/
|
|
683
|
+
export type CollectionInfo = Message<"loams.collection.v1.CollectionInfo"> & {
|
|
684
|
+
/**
|
|
685
|
+
* The collection's id, stable for its life. A decimal string in JSON.
|
|
686
|
+
*
|
|
687
|
+
* @generated from field: uint64 id = 1;
|
|
688
|
+
*/
|
|
689
|
+
id: bigint;
|
|
690
|
+
/**
|
|
691
|
+
* The collection's own name. An answer to a get-by-alias reports the
|
|
692
|
+
* collection, not the alias.
|
|
693
|
+
*
|
|
694
|
+
* @generated from field: string name = 2;
|
|
695
|
+
*/
|
|
696
|
+
name: string;
|
|
697
|
+
/**
|
|
698
|
+
* The namespace's name.
|
|
699
|
+
*
|
|
700
|
+
* @generated from field: string namespace = 3;
|
|
701
|
+
*/
|
|
702
|
+
namespace: string;
|
|
703
|
+
/**
|
|
704
|
+
* The live schema, at its current version, in the request's form.
|
|
705
|
+
*
|
|
706
|
+
* @generated from field: google.protobuf.Struct schema = 4;
|
|
707
|
+
*/
|
|
708
|
+
schema?: JsonObject | undefined;
|
|
709
|
+
/**
|
|
710
|
+
* @generated from field: uint32 partitions = 5;
|
|
711
|
+
*/
|
|
712
|
+
partitions: number;
|
|
713
|
+
/**
|
|
714
|
+
* The collection's aliases, sorted.
|
|
715
|
+
*
|
|
716
|
+
* @generated from field: repeated string aliases = 6;
|
|
717
|
+
*/
|
|
718
|
+
aliases: string[];
|
|
719
|
+
/**
|
|
720
|
+
* The implicit stream the collection's writes are appended to; reading it
|
|
721
|
+
* is how a caller follows the tail (M1.2 rule 4).
|
|
722
|
+
*
|
|
723
|
+
* @generated from field: uint64 stream = 7;
|
|
724
|
+
*/
|
|
725
|
+
stream: bigint;
|
|
726
|
+
/**
|
|
727
|
+
* The live manifest's version; 0 before the first commit.
|
|
728
|
+
*
|
|
729
|
+
* @generated from field: uint64 manifest_version = 8;
|
|
730
|
+
*/
|
|
731
|
+
manifestVersion: bigint;
|
|
732
|
+
/**
|
|
733
|
+
* The live manifest's `live_doc_count`.
|
|
734
|
+
*
|
|
735
|
+
* @generated from field: uint64 live_doc_count = 9;
|
|
736
|
+
*/
|
|
737
|
+
liveDocCount: bigint;
|
|
738
|
+
/**
|
|
739
|
+
* The size of the live Lance version.
|
|
740
|
+
*
|
|
741
|
+
* @generated from field: uint64 size_bytes = 10;
|
|
742
|
+
*/
|
|
743
|
+
sizeBytes: bigint;
|
|
744
|
+
/**
|
|
745
|
+
* When the collection was created, from the `loams.created_at_ms`
|
|
746
|
+
* annotation; 0 without it.
|
|
747
|
+
*
|
|
748
|
+
* @generated from field: uint64 created_at_ms = 11;
|
|
749
|
+
*/
|
|
750
|
+
createdAtMs: bigint;
|
|
751
|
+
/**
|
|
752
|
+
* Σ over partitions of (high watermark − applied): the writes the link has
|
|
753
|
+
* not put into the live manifest yet.
|
|
754
|
+
*
|
|
755
|
+
* @generated from field: uint64 link_lag_records = 12;
|
|
756
|
+
*/
|
|
757
|
+
linkLagRecords: bigint;
|
|
758
|
+
/**
|
|
759
|
+
* The hot tier's status for this collection. `GetCollection` answers the
|
|
760
|
+
* *owning* node's full status here (M1.3 rule 4); the other RPCs answer
|
|
761
|
+
* the catalog configuration this node holds, which is why `enabled`,
|
|
762
|
+
* `config` and `owner` can be absent.
|
|
763
|
+
*
|
|
764
|
+
* @generated from field: loams.collection.v1.HotStatus hot = 13;
|
|
765
|
+
*/
|
|
766
|
+
hot?: HotStatus | undefined;
|
|
767
|
+
/**
|
|
768
|
+
* The bytes of the offset index entries past `applied`.
|
|
769
|
+
*
|
|
770
|
+
* @generated from field: uint64 unapplied_bytes = 14;
|
|
771
|
+
*/
|
|
772
|
+
unappliedBytes: bigint;
|
|
773
|
+
/**
|
|
774
|
+
* The write budget and whether a plain write is refused now (M1.3 Task 15,
|
|
775
|
+
* D86).
|
|
776
|
+
*
|
|
777
|
+
* @generated from field: loams.collection.v1.BackpressureStatus backpressure = 15;
|
|
778
|
+
*/
|
|
779
|
+
backpressure?: BackpressureStatus | undefined;
|
|
780
|
+
};
|
|
781
|
+
/**
|
|
782
|
+
* Describes the message loams.collection.v1.CollectionInfo.
|
|
783
|
+
* Use `create(CollectionInfoSchema)` to create a new message.
|
|
784
|
+
*/
|
|
785
|
+
export declare const CollectionInfoSchema: GenMessage<CollectionInfo>;
|
|
786
|
+
/**
|
|
787
|
+
* The unapplied-data budget and admission's answer under it (D86).
|
|
788
|
+
*
|
|
789
|
+
* @generated from message loams.collection.v1.BackpressureStatus
|
|
790
|
+
*/
|
|
791
|
+
export type BackpressureStatus = Message<"loams.collection.v1.BackpressureStatus"> & {
|
|
792
|
+
/**
|
|
793
|
+
* @generated from field: loams.collection.v1.BackpressureState state = 1;
|
|
794
|
+
*/
|
|
795
|
+
state: BackpressureState;
|
|
796
|
+
/**
|
|
797
|
+
* @generated from field: uint64 unapplied_records = 2;
|
|
798
|
+
*/
|
|
799
|
+
unappliedRecords: bigint;
|
|
800
|
+
/**
|
|
801
|
+
* @generated from field: uint64 unapplied_bytes = 3;
|
|
802
|
+
*/
|
|
803
|
+
unappliedBytes: bigint;
|
|
804
|
+
/**
|
|
805
|
+
* @generated from field: uint64 max_unapplied_records = 4;
|
|
806
|
+
*/
|
|
807
|
+
maxUnappliedRecords: bigint;
|
|
808
|
+
/**
|
|
809
|
+
* @generated from field: uint64 max_unapplied_bytes = 5;
|
|
810
|
+
*/
|
|
811
|
+
maxUnappliedBytes: bigint;
|
|
812
|
+
};
|
|
813
|
+
/**
|
|
814
|
+
* Describes the message loams.collection.v1.BackpressureStatus.
|
|
815
|
+
* Use `create(BackpressureStatusSchema)` to create a new message.
|
|
816
|
+
*/
|
|
817
|
+
export declare const BackpressureStatusSchema: GenMessage<BackpressureStatus>;
|
|
818
|
+
/**
|
|
819
|
+
* The hot tier's status for one collection, as the node that owns it
|
|
820
|
+
* reports it.
|
|
821
|
+
*
|
|
822
|
+
* @generated from message loams.collection.v1.HotStatus
|
|
823
|
+
*/
|
|
824
|
+
export type HotStatus = Message<"loams.collection.v1.HotStatus"> & {
|
|
825
|
+
/**
|
|
826
|
+
* Whether the reporting node runs a hot tier at all.
|
|
827
|
+
*
|
|
828
|
+
* @generated from field: bool enabled = 1;
|
|
829
|
+
*/
|
|
830
|
+
enabled: boolean;
|
|
831
|
+
/**
|
|
832
|
+
* The catalog configuration `SetHot` wrote.
|
|
833
|
+
*
|
|
834
|
+
* @generated from field: loams.collection.v1.HotConfig config = 2;
|
|
835
|
+
*/
|
|
836
|
+
config?: HotConfig | undefined;
|
|
837
|
+
/**
|
|
838
|
+
* `--hot-pin-all` on the reporting node.
|
|
839
|
+
*
|
|
840
|
+
* @generated from field: bool pin_all = 3;
|
|
841
|
+
*/
|
|
842
|
+
pinAll: boolean;
|
|
843
|
+
/**
|
|
844
|
+
* A promotion lease is held for this collection.
|
|
845
|
+
*
|
|
846
|
+
* @generated from field: bool promoted = 4;
|
|
847
|
+
*/
|
|
848
|
+
promoted: boolean;
|
|
849
|
+
/**
|
|
850
|
+
* The node that answered.
|
|
851
|
+
*
|
|
852
|
+
* @generated from field: loams.collection.v1.HotOwner owner = 5;
|
|
853
|
+
*/
|
|
854
|
+
owner?: HotOwner | undefined;
|
|
855
|
+
/**
|
|
856
|
+
* The three structures a promotion or a warm makes hot. Each carries the
|
|
857
|
+
* keys that apply to it and omits the rest.
|
|
858
|
+
*
|
|
859
|
+
* @generated from field: loams.collection.v1.HotStructureStatus vectors = 6;
|
|
860
|
+
*/
|
|
861
|
+
vectors?: HotStructureStatus | undefined;
|
|
862
|
+
/**
|
|
863
|
+
* @generated from field: loams.collection.v1.HotStructureStatus text = 7;
|
|
864
|
+
*/
|
|
865
|
+
text?: HotStructureStatus | undefined;
|
|
866
|
+
/**
|
|
867
|
+
* @generated from field: loams.collection.v1.HotStructureStatus fragments = 8;
|
|
868
|
+
*/
|
|
869
|
+
fragments?: HotStructureStatus | undefined;
|
|
870
|
+
};
|
|
871
|
+
/**
|
|
872
|
+
* Describes the message loams.collection.v1.HotStatus.
|
|
873
|
+
* Use `create(HotStatusSchema)` to create a new message.
|
|
874
|
+
*/
|
|
875
|
+
export declare const HotStatusSchema: GenMessage<HotStatus>;
|
|
876
|
+
/**
|
|
877
|
+
* @generated from message loams.collection.v1.HotOwner
|
|
878
|
+
*/
|
|
879
|
+
export type HotOwner = Message<"loams.collection.v1.HotOwner"> & {
|
|
880
|
+
/**
|
|
881
|
+
* The reporting node's id.
|
|
882
|
+
*
|
|
883
|
+
* @generated from field: uint64 node_id = 1;
|
|
884
|
+
*/
|
|
885
|
+
nodeId: bigint;
|
|
886
|
+
/**
|
|
887
|
+
* Whether it also owns the collection, so this answer is the hot tier's
|
|
888
|
+
* own and not a forwarded one.
|
|
889
|
+
*
|
|
890
|
+
* @generated from field: bool local = 2;
|
|
891
|
+
*/
|
|
892
|
+
local: boolean;
|
|
893
|
+
};
|
|
894
|
+
/**
|
|
895
|
+
* Describes the message loams.collection.v1.HotOwner.
|
|
896
|
+
* Use `create(HotOwnerSchema)` to create a new message.
|
|
897
|
+
*/
|
|
898
|
+
export declare const HotOwnerSchema: GenMessage<HotOwner>;
|
|
899
|
+
/**
|
|
900
|
+
* One hot structure's state. A single message serves `vectors`, `text` and
|
|
901
|
+
* `fragments` because the catalog's `HotConfig` treats them alike and a
|
|
902
|
+
* caller asks one question of each: is it ready.
|
|
903
|
+
*
|
|
904
|
+
* @generated from message loams.collection.v1.HotStructureStatus
|
|
905
|
+
*/
|
|
906
|
+
export type HotStructureStatus = Message<"loams.collection.v1.HotStructureStatus"> & {
|
|
907
|
+
/**
|
|
908
|
+
* @generated from field: loams.collection.v1.HotStateKind state = 1;
|
|
909
|
+
*/
|
|
910
|
+
state: HotStateKind;
|
|
911
|
+
/**
|
|
912
|
+
* The manifest version the structure reflects; absent when it reflects
|
|
913
|
+
* none.
|
|
914
|
+
*
|
|
915
|
+
* @generated from field: optional uint64 source_version = 2;
|
|
916
|
+
*/
|
|
917
|
+
sourceVersion?: bigint | undefined;
|
|
918
|
+
/**
|
|
919
|
+
* Over its budget (`vectors`, `text`).
|
|
920
|
+
*
|
|
921
|
+
* @generated from field: bool over_budget = 3;
|
|
922
|
+
*/
|
|
923
|
+
overBudget: boolean;
|
|
924
|
+
/**
|
|
925
|
+
* By vector name (`vectors` only).
|
|
926
|
+
*
|
|
927
|
+
* @generated from field: map<string, loams.collection.v1.HotColumnStatus> columns = 4;
|
|
928
|
+
*/
|
|
929
|
+
columns: {
|
|
930
|
+
[key: string]: HotColumnStatus;
|
|
931
|
+
};
|
|
932
|
+
/**
|
|
933
|
+
* The live manifest's splits pinned on this node (`text` only).
|
|
934
|
+
*
|
|
935
|
+
* @generated from field: uint64 pinned_splits = 5;
|
|
936
|
+
*/
|
|
937
|
+
pinnedSplits: bigint;
|
|
938
|
+
/**
|
|
939
|
+
* The live manifest's splits (`text` only).
|
|
940
|
+
*
|
|
941
|
+
* @generated from field: uint64 splits = 6;
|
|
942
|
+
*/
|
|
943
|
+
splits: bigint;
|
|
944
|
+
/**
|
|
945
|
+
* Bytes read into the range cache (`fragments` only).
|
|
946
|
+
*
|
|
947
|
+
* @generated from field: uint64 prefetched_bytes = 7;
|
|
948
|
+
*/
|
|
949
|
+
prefetchedBytes: bigint;
|
|
950
|
+
/**
|
|
951
|
+
* The bytes of the live Lance version's files (`fragments` only).
|
|
952
|
+
*
|
|
953
|
+
* @generated from field: uint64 bytes = 8;
|
|
954
|
+
*/
|
|
955
|
+
bytes: bigint;
|
|
956
|
+
};
|
|
957
|
+
/**
|
|
958
|
+
* Describes the message loams.collection.v1.HotStructureStatus.
|
|
959
|
+
* Use `create(HotStructureStatusSchema)` to create a new message.
|
|
960
|
+
*/
|
|
961
|
+
export declare const HotStructureStatusSchema: GenMessage<HotStructureStatus>;
|
|
962
|
+
/**
|
|
963
|
+
* One vector column's hot state, the minimum of which is the structure's.
|
|
964
|
+
*
|
|
965
|
+
* @generated from message loams.collection.v1.HotColumnStatus
|
|
966
|
+
*/
|
|
967
|
+
export type HotColumnStatus = Message<"loams.collection.v1.HotColumnStatus"> & {
|
|
968
|
+
/**
|
|
969
|
+
* @generated from field: loams.collection.v1.HotStateKind state = 1;
|
|
970
|
+
*/
|
|
971
|
+
state: HotStateKind;
|
|
972
|
+
/**
|
|
973
|
+
* @generated from field: optional uint64 source_version = 2;
|
|
974
|
+
*/
|
|
975
|
+
sourceVersion?: bigint | undefined;
|
|
976
|
+
/**
|
|
977
|
+
* The loaded artifact's own source version, which lags `source_version`
|
|
978
|
+
* while a rebuild is in flight.
|
|
979
|
+
*
|
|
980
|
+
* @generated from field: optional uint64 artifact_source_version = 3;
|
|
981
|
+
*/
|
|
982
|
+
artifactSourceVersion?: bigint | undefined;
|
|
983
|
+
/**
|
|
984
|
+
* Rows in the delta index above the artifact.
|
|
985
|
+
*
|
|
986
|
+
* @generated from field: uint64 delta_rows = 4;
|
|
987
|
+
*/
|
|
988
|
+
deltaRows: bigint;
|
|
989
|
+
/**
|
|
990
|
+
* The last load error, until the artifact loads.
|
|
991
|
+
*
|
|
992
|
+
* @generated from field: string error = 5;
|
|
993
|
+
*/
|
|
994
|
+
error: string;
|
|
995
|
+
};
|
|
996
|
+
/**
|
|
997
|
+
* Describes the message loams.collection.v1.HotColumnStatus.
|
|
998
|
+
* Use `create(HotColumnStatusSchema)` to create a new message.
|
|
999
|
+
*/
|
|
1000
|
+
export declare const HotColumnStatusSchema: GenMessage<HotColumnStatus>;
|
|
1001
|
+
/**
|
|
1002
|
+
* One state of a collection, resolved into what an external reader needs to
|
|
1003
|
+
* read it (plan M1.2 rule 2 is its JSON form).
|
|
1004
|
+
*
|
|
1005
|
+
* @generated from message loams.collection.v1.ScanPlan
|
|
1006
|
+
*/
|
|
1007
|
+
export type ScanPlan = Message<"loams.collection.v1.ScanPlan"> & {
|
|
1008
|
+
/**
|
|
1009
|
+
* @generated from field: string namespace = 1;
|
|
1010
|
+
*/
|
|
1011
|
+
namespace: string;
|
|
1012
|
+
/**
|
|
1013
|
+
* The collection's own name, never the alias it was asked by.
|
|
1014
|
+
*
|
|
1015
|
+
* @generated from field: string collection = 2;
|
|
1016
|
+
*/
|
|
1017
|
+
collection: string;
|
|
1018
|
+
/**
|
|
1019
|
+
* @generated from field: uint64 collection_id = 3;
|
|
1020
|
+
*/
|
|
1021
|
+
collectionId: bigint;
|
|
1022
|
+
/**
|
|
1023
|
+
* The manifest this plan describes.
|
|
1024
|
+
*
|
|
1025
|
+
* @generated from field: uint64 manifest_version = 4;
|
|
1026
|
+
*/
|
|
1027
|
+
manifestVersion: bigint;
|
|
1028
|
+
/**
|
|
1029
|
+
* @generated from field: uint64 schema_version = 5;
|
|
1030
|
+
*/
|
|
1031
|
+
schemaVersion: bigint;
|
|
1032
|
+
/**
|
|
1033
|
+
* The Lance version the manifest names; absent while it names none.
|
|
1034
|
+
*
|
|
1035
|
+
* @generated from field: loams.collection.v1.LanceVersionRef lance = 6;
|
|
1036
|
+
*/
|
|
1037
|
+
lance?: LanceVersionRef | undefined;
|
|
1038
|
+
/**
|
|
1039
|
+
* In the Lance manifest's order.
|
|
1040
|
+
*
|
|
1041
|
+
* @generated from field: repeated loams.collection.v1.ScanFragment fragments = 7;
|
|
1042
|
+
*/
|
|
1043
|
+
fragments: ScanFragment[];
|
|
1044
|
+
/**
|
|
1045
|
+
* Σ fragment `live_rows`, which equals the manifest's `live_doc_count`.
|
|
1046
|
+
*
|
|
1047
|
+
* @generated from field: uint64 live_rows = 8;
|
|
1048
|
+
*/
|
|
1049
|
+
liveRows: bigint;
|
|
1050
|
+
/**
|
|
1051
|
+
* The Lance version's columns, in its order.
|
|
1052
|
+
*
|
|
1053
|
+
* @generated from field: repeated loams.collection.v1.ScanColumn columns = 9;
|
|
1054
|
+
*/
|
|
1055
|
+
columns: ScanColumn[];
|
|
1056
|
+
/**
|
|
1057
|
+
* How `_pk` encodes keys: `loams_canonical_v1`.
|
|
1058
|
+
*
|
|
1059
|
+
* @generated from field: string pk_encoding = 10;
|
|
1060
|
+
*/
|
|
1061
|
+
pkEncoding: string;
|
|
1062
|
+
/**
|
|
1063
|
+
* Whether the requested state holds records the Lance version does not.
|
|
1064
|
+
* A reader that answers `true` must read the tail through the native API
|
|
1065
|
+
* or Flight SQL as well as the Lance files.
|
|
1066
|
+
*
|
|
1067
|
+
* @generated from field: bool tail = 11;
|
|
1068
|
+
*/
|
|
1069
|
+
tail: boolean;
|
|
1070
|
+
/**
|
|
1071
|
+
* Σ over partitions of (target − applied).
|
|
1072
|
+
*
|
|
1073
|
+
* @generated from field: uint64 tail_records = 12;
|
|
1074
|
+
*/
|
|
1075
|
+
tailRecords: bigint;
|
|
1076
|
+
/**
|
|
1077
|
+
* One per partition, ascending.
|
|
1078
|
+
*
|
|
1079
|
+
* @generated from field: repeated loams.collection.v1.ScanOffsets offsets = 13;
|
|
1080
|
+
*/
|
|
1081
|
+
offsets: ScanOffsets[];
|
|
1082
|
+
/**
|
|
1083
|
+
* Exactly what the Lance version holds: the applied offsets. The same
|
|
1084
|
+
* token is the `loams-consistency-token` response header.
|
|
1085
|
+
*
|
|
1086
|
+
* @generated from field: string durable_token = 14;
|
|
1087
|
+
*/
|
|
1088
|
+
durableToken: string;
|
|
1089
|
+
/**
|
|
1090
|
+
* Reads the requested state, tail included (M1.2 rule 6).
|
|
1091
|
+
*
|
|
1092
|
+
* @generated from field: loams.collection.v1.ScanPin pin = 15;
|
|
1093
|
+
*/
|
|
1094
|
+
pin?: ScanPin | undefined;
|
|
1095
|
+
/**
|
|
1096
|
+
* The metastore clock of the planning read. It advances only with
|
|
1097
|
+
* time-stamped metastore writes, so it is not a wall clock.
|
|
1098
|
+
*
|
|
1099
|
+
* @generated from field: uint64 planned_at_ms = 16;
|
|
1100
|
+
*/
|
|
1101
|
+
plannedAtMs: bigint;
|
|
1102
|
+
/**
|
|
1103
|
+
* The earliest moment GC may stop retaining this manifest, on the
|
|
1104
|
+
* metastore clock; absent for manifest version 0.
|
|
1105
|
+
*
|
|
1106
|
+
* @generated from field: optional uint64 expires_at_ms = 17;
|
|
1107
|
+
*/
|
|
1108
|
+
expiresAtMs?: bigint | undefined;
|
|
1109
|
+
};
|
|
1110
|
+
/**
|
|
1111
|
+
* Describes the message loams.collection.v1.ScanPlan.
|
|
1112
|
+
* Use `create(ScanPlanSchema)` to create a new message.
|
|
1113
|
+
*/
|
|
1114
|
+
export declare const ScanPlanSchema: GenMessage<ScanPlan>;
|
|
1115
|
+
/**
|
|
1116
|
+
* The Lance version a manifest names.
|
|
1117
|
+
*
|
|
1118
|
+
* @generated from message loams.collection.v1.LanceVersionRef
|
|
1119
|
+
*/
|
|
1120
|
+
export type LanceVersionRef = Message<"loams.collection.v1.LanceVersionRef"> & {
|
|
1121
|
+
/**
|
|
1122
|
+
* `<lance base url>/<lance prefix>` without a trailing `/`; absent when
|
|
1123
|
+
* the service has no base URL and the dataset is not reachable over HTTP.
|
|
1124
|
+
*
|
|
1125
|
+
* @generated from field: optional string uri = 1;
|
|
1126
|
+
*/
|
|
1127
|
+
uri?: string | undefined;
|
|
1128
|
+
/**
|
|
1129
|
+
* The (detached) Lance version id; bit 63 is set for a detached version.
|
|
1130
|
+
*
|
|
1131
|
+
* @generated from field: uint64 version = 2;
|
|
1132
|
+
*/
|
|
1133
|
+
version: bigint;
|
|
1134
|
+
/**
|
|
1135
|
+
* The Lance manifest, relative to the dataset root
|
|
1136
|
+
* (`_versions/d<id>.manifest`).
|
|
1137
|
+
*
|
|
1138
|
+
* @generated from field: string manifest_path = 3;
|
|
1139
|
+
*/
|
|
1140
|
+
manifestPath: string;
|
|
1141
|
+
/**
|
|
1142
|
+
* The Lance storage format, for example `2.1`.
|
|
1143
|
+
*
|
|
1144
|
+
* @generated from field: string storage_format = 4;
|
|
1145
|
+
*/
|
|
1146
|
+
storageFormat: string;
|
|
1147
|
+
/**
|
|
1148
|
+
* Whether row ids are stable across the version.
|
|
1149
|
+
*
|
|
1150
|
+
* @generated from field: bool stable_row_ids = 5;
|
|
1151
|
+
*/
|
|
1152
|
+
stableRowIds: boolean;
|
|
1153
|
+
};
|
|
1154
|
+
/**
|
|
1155
|
+
* Describes the message loams.collection.v1.LanceVersionRef.
|
|
1156
|
+
* Use `create(LanceVersionRefSchema)` to create a new message.
|
|
1157
|
+
*/
|
|
1158
|
+
export declare const LanceVersionRefSchema: GenMessage<LanceVersionRef>;
|
|
1159
|
+
/**
|
|
1160
|
+
* One Lance fragment of the planned version.
|
|
1161
|
+
*
|
|
1162
|
+
* @generated from message loams.collection.v1.ScanFragment
|
|
1163
|
+
*/
|
|
1164
|
+
export type ScanFragment = Message<"loams.collection.v1.ScanFragment"> & {
|
|
1165
|
+
/**
|
|
1166
|
+
* @generated from field: uint64 id = 1;
|
|
1167
|
+
*/
|
|
1168
|
+
id: bigint;
|
|
1169
|
+
/**
|
|
1170
|
+
* @generated from field: uint64 physical_rows = 2;
|
|
1171
|
+
*/
|
|
1172
|
+
physicalRows: bigint;
|
|
1173
|
+
/**
|
|
1174
|
+
* @generated from field: uint64 deleted_rows = 3;
|
|
1175
|
+
*/
|
|
1176
|
+
deletedRows: bigint;
|
|
1177
|
+
/**
|
|
1178
|
+
* @generated from field: uint64 live_rows = 4;
|
|
1179
|
+
*/
|
|
1180
|
+
liveRows: bigint;
|
|
1181
|
+
/**
|
|
1182
|
+
* The fragment's data files, relative to the dataset root.
|
|
1183
|
+
*
|
|
1184
|
+
* @generated from field: repeated loams.collection.v1.ScanFile files = 5;
|
|
1185
|
+
*/
|
|
1186
|
+
files: ScanFile[];
|
|
1187
|
+
/**
|
|
1188
|
+
* Its deletion file; absent when the fragment deletes nothing.
|
|
1189
|
+
*
|
|
1190
|
+
* @generated from field: loams.collection.v1.ScanDeletionFile deletion_file = 6;
|
|
1191
|
+
*/
|
|
1192
|
+
deletionFile?: ScanDeletionFile | undefined;
|
|
1193
|
+
/**
|
|
1194
|
+
* Lance's own `Fragment` JSON, which is what pylance's
|
|
1195
|
+
* `FragmentMetadata.from_json` reads. Carried verbatim so a reader needs
|
|
1196
|
+
* no second copy of Lance's fragment model.
|
|
1197
|
+
*
|
|
1198
|
+
* @generated from field: google.protobuf.Struct lance = 7;
|
|
1199
|
+
*/
|
|
1200
|
+
lance?: JsonObject | undefined;
|
|
1201
|
+
};
|
|
1202
|
+
/**
|
|
1203
|
+
* Describes the message loams.collection.v1.ScanFragment.
|
|
1204
|
+
* Use `create(ScanFragmentSchema)` to create a new message.
|
|
1205
|
+
*/
|
|
1206
|
+
export declare const ScanFragmentSchema: GenMessage<ScanFragment>;
|
|
1207
|
+
/**
|
|
1208
|
+
* @generated from message loams.collection.v1.ScanFile
|
|
1209
|
+
*/
|
|
1210
|
+
export type ScanFile = Message<"loams.collection.v1.ScanFile"> & {
|
|
1211
|
+
/**
|
|
1212
|
+
* Relative to the dataset root: `data/…`.
|
|
1213
|
+
*
|
|
1214
|
+
* @generated from field: string path = 1;
|
|
1215
|
+
*/
|
|
1216
|
+
path: string;
|
|
1217
|
+
/**
|
|
1218
|
+
* @generated from field: optional uint64 size_bytes = 2;
|
|
1219
|
+
*/
|
|
1220
|
+
sizeBytes?: bigint | undefined;
|
|
1221
|
+
};
|
|
1222
|
+
/**
|
|
1223
|
+
* Describes the message loams.collection.v1.ScanFile.
|
|
1224
|
+
* Use `create(ScanFileSchema)` to create a new message.
|
|
1225
|
+
*/
|
|
1226
|
+
export declare const ScanFileSchema: GenMessage<ScanFile>;
|
|
1227
|
+
/**
|
|
1228
|
+
* @generated from message loams.collection.v1.ScanDeletionFile
|
|
1229
|
+
*/
|
|
1230
|
+
export type ScanDeletionFile = Message<"loams.collection.v1.ScanDeletionFile"> & {
|
|
1231
|
+
/**
|
|
1232
|
+
* Relative to the dataset root: `_deletions/…`.
|
|
1233
|
+
*
|
|
1234
|
+
* @generated from field: string path = 1;
|
|
1235
|
+
*/
|
|
1236
|
+
path: string;
|
|
1237
|
+
/**
|
|
1238
|
+
* @generated from field: loams.collection.v1.DeletionKind kind = 2;
|
|
1239
|
+
*/
|
|
1240
|
+
kind: DeletionKind;
|
|
1241
|
+
/**
|
|
1242
|
+
* @generated from field: uint64 deleted_rows = 3;
|
|
1243
|
+
*/
|
|
1244
|
+
deletedRows: bigint;
|
|
1245
|
+
};
|
|
1246
|
+
/**
|
|
1247
|
+
* Describes the message loams.collection.v1.ScanDeletionFile.
|
|
1248
|
+
* Use `create(ScanDeletionFileSchema)` to create a new message.
|
|
1249
|
+
*/
|
|
1250
|
+
export declare const ScanDeletionFileSchema: GenMessage<ScanDeletionFile>;
|
|
1251
|
+
/**
|
|
1252
|
+
* One readable column of the planned Lance version.
|
|
1253
|
+
*
|
|
1254
|
+
* @generated from message loams.collection.v1.ScanColumn
|
|
1255
|
+
*/
|
|
1256
|
+
export type ScanColumn = Message<"loams.collection.v1.ScanColumn"> & {
|
|
1257
|
+
/**
|
|
1258
|
+
* @generated from field: string name = 1;
|
|
1259
|
+
*/
|
|
1260
|
+
name: string;
|
|
1261
|
+
/**
|
|
1262
|
+
* Arrow's `DataType` display form.
|
|
1263
|
+
*
|
|
1264
|
+
* @generated from field: string data_type = 2;
|
|
1265
|
+
*/
|
|
1266
|
+
dataType: string;
|
|
1267
|
+
/**
|
|
1268
|
+
* What the column holds, in `lower_snake_case`: `pk`, `source`,
|
|
1269
|
+
* `ingest_partition`, `ingest_offset`, `vector`, `sparse_vector`. A string
|
|
1270
|
+
* rather than an enum, because it is the REST route's spelling and a
|
|
1271
|
+
* reader switches on it verbatim.
|
|
1272
|
+
*
|
|
1273
|
+
* @generated from field: string role = 3;
|
|
1274
|
+
*/
|
|
1275
|
+
role: string;
|
|
1276
|
+
/**
|
|
1277
|
+
* The vector's name, for a vector column.
|
|
1278
|
+
*
|
|
1279
|
+
* @generated from field: optional string vector = 4;
|
|
1280
|
+
*/
|
|
1281
|
+
vector?: string | undefined;
|
|
1282
|
+
/**
|
|
1283
|
+
* @generated from field: optional uint32 dim = 5;
|
|
1284
|
+
*/
|
|
1285
|
+
dim?: number | undefined;
|
|
1286
|
+
/**
|
|
1287
|
+
* `cosine`, `dot`, `euclid` or `manhattan`, for a vector column.
|
|
1288
|
+
*
|
|
1289
|
+
* @generated from field: optional string distance = 6;
|
|
1290
|
+
*/
|
|
1291
|
+
distance?: string | undefined;
|
|
1292
|
+
/**
|
|
1293
|
+
* `none` or `idf`, for a sparse vector column.
|
|
1294
|
+
*
|
|
1295
|
+
* @generated from field: optional string modifier = 7;
|
|
1296
|
+
*/
|
|
1297
|
+
modifier?: string | undefined;
|
|
1298
|
+
};
|
|
1299
|
+
/**
|
|
1300
|
+
* Describes the message loams.collection.v1.ScanColumn.
|
|
1301
|
+
* Use `create(ScanColumnSchema)` to create a new message.
|
|
1302
|
+
*/
|
|
1303
|
+
export declare const ScanColumnSchema: GenMessage<ScanColumn>;
|
|
1304
|
+
/**
|
|
1305
|
+
* One partition's applied offset against the requested one.
|
|
1306
|
+
*
|
|
1307
|
+
* @generated from message loams.collection.v1.ScanOffsets
|
|
1308
|
+
*/
|
|
1309
|
+
export type ScanOffsets = Message<"loams.collection.v1.ScanOffsets"> & {
|
|
1310
|
+
/**
|
|
1311
|
+
* @generated from field: uint32 partition = 1;
|
|
1312
|
+
*/
|
|
1313
|
+
partition: number;
|
|
1314
|
+
/**
|
|
1315
|
+
* @generated from field: uint64 applied = 2;
|
|
1316
|
+
*/
|
|
1317
|
+
applied: bigint;
|
|
1318
|
+
/**
|
|
1319
|
+
* @generated from field: uint64 target = 3;
|
|
1320
|
+
*/
|
|
1321
|
+
target: bigint;
|
|
1322
|
+
};
|
|
1323
|
+
/**
|
|
1324
|
+
* Describes the message loams.collection.v1.ScanOffsets.
|
|
1325
|
+
* Use `create(ScanOffsetsSchema)` to create a new message.
|
|
1326
|
+
*/
|
|
1327
|
+
export declare const ScanOffsetsSchema: GenMessage<ScanOffsets>;
|
|
1328
|
+
/**
|
|
1329
|
+
* What reads exactly the planned state.
|
|
1330
|
+
*
|
|
1331
|
+
* @generated from message loams.collection.v1.ScanPin
|
|
1332
|
+
*/
|
|
1333
|
+
export type ScanPin = Message<"loams.collection.v1.ScanPin"> & {
|
|
1334
|
+
/**
|
|
1335
|
+
* @generated from field: uint64 manifest_version = 1;
|
|
1336
|
+
*/
|
|
1337
|
+
manifestVersion: bigint;
|
|
1338
|
+
/**
|
|
1339
|
+
* The pin's consistency token, the `loams-consistency-token` the `Scan`
|
|
1340
|
+
* answered, and a `ScanPoint.token` that plans the same state again.
|
|
1341
|
+
*
|
|
1342
|
+
* @generated from field: string token = 2;
|
|
1343
|
+
*/
|
|
1344
|
+
token: string;
|
|
1345
|
+
};
|
|
1346
|
+
/**
|
|
1347
|
+
* Describes the message loams.collection.v1.ScanPin.
|
|
1348
|
+
* Use `create(ScanPinSchema)` to create a new message.
|
|
1349
|
+
*/
|
|
1350
|
+
export declare const ScanPinSchema: GenMessage<ScanPin>;
|
|
1351
|
+
/**
|
|
1352
|
+
* @generated from enum loams.collection.v1.BackpressureState
|
|
1353
|
+
*/
|
|
1354
|
+
export declare enum BackpressureState {
|
|
1355
|
+
/**
|
|
1356
|
+
* @generated from enum value: BACKPRESSURE_STATE_UNSPECIFIED = 0;
|
|
1357
|
+
*/
|
|
1358
|
+
UNSPECIFIED = 0,
|
|
1359
|
+
/**
|
|
1360
|
+
* A plain write is admitted now.
|
|
1361
|
+
*
|
|
1362
|
+
* @generated from enum value: BACKPRESSURE_STATE_OPEN = 1;
|
|
1363
|
+
*/
|
|
1364
|
+
OPEN = 1,
|
|
1365
|
+
/**
|
|
1366
|
+
* A plain write is refused now; `retry_after_ms` says when to come back.
|
|
1367
|
+
*
|
|
1368
|
+
* @generated from enum value: BACKPRESSURE_STATE_THROTTLING = 2;
|
|
1369
|
+
*/
|
|
1370
|
+
THROTTLING = 2,
|
|
1371
|
+
/**
|
|
1372
|
+
* Backpressure is off: nothing is refused.
|
|
1373
|
+
*
|
|
1374
|
+
* @generated from enum value: BACKPRESSURE_STATE_DISABLED = 3;
|
|
1375
|
+
*/
|
|
1376
|
+
DISABLED = 3
|
|
1377
|
+
}
|
|
1378
|
+
/**
|
|
1379
|
+
* Describes the enum loams.collection.v1.BackpressureState.
|
|
1380
|
+
*/
|
|
1381
|
+
export declare const BackpressureStateSchema: GenEnum<BackpressureState>;
|
|
1382
|
+
/**
|
|
1383
|
+
* @generated from enum loams.collection.v1.HotStateKind
|
|
1384
|
+
*/
|
|
1385
|
+
export declare enum HotStateKind {
|
|
1386
|
+
/**
|
|
1387
|
+
* @generated from enum value: HOT_STATE_KIND_UNSPECIFIED = 0;
|
|
1388
|
+
*/
|
|
1389
|
+
UNSPECIFIED = 0,
|
|
1390
|
+
/**
|
|
1391
|
+
* Nothing pinned here.
|
|
1392
|
+
*
|
|
1393
|
+
* @generated from enum value: HOT_STATE_KIND_OFF = 1;
|
|
1394
|
+
*/
|
|
1395
|
+
OFF = 1,
|
|
1396
|
+
/**
|
|
1397
|
+
* Being pinned.
|
|
1398
|
+
*
|
|
1399
|
+
* @generated from enum value: HOT_STATE_KIND_BUILDING = 2;
|
|
1400
|
+
*/
|
|
1401
|
+
BUILDING = 2,
|
|
1402
|
+
/**
|
|
1403
|
+
* Pinned and serving.
|
|
1404
|
+
*
|
|
1405
|
+
* @generated from enum value: HOT_STATE_KIND_READY = 3;
|
|
1406
|
+
*/
|
|
1407
|
+
READY = 3
|
|
1408
|
+
}
|
|
1409
|
+
/**
|
|
1410
|
+
* Describes the enum loams.collection.v1.HotStateKind.
|
|
1411
|
+
*/
|
|
1412
|
+
export declare const HotStateKindSchema: GenEnum<HotStateKind>;
|
|
1413
|
+
/**
|
|
1414
|
+
* How a deletion file stores its row offsets.
|
|
1415
|
+
*
|
|
1416
|
+
* @generated from enum loams.collection.v1.DeletionKind
|
|
1417
|
+
*/
|
|
1418
|
+
export declare enum DeletionKind {
|
|
1419
|
+
/**
|
|
1420
|
+
* @generated from enum value: DELETION_KIND_UNSPECIFIED = 0;
|
|
1421
|
+
*/
|
|
1422
|
+
UNSPECIFIED = 0,
|
|
1423
|
+
/**
|
|
1424
|
+
* A sorted list of row offsets.
|
|
1425
|
+
*
|
|
1426
|
+
* @generated from enum value: DELETION_KIND_ARRAY = 1;
|
|
1427
|
+
*/
|
|
1428
|
+
ARRAY = 1,
|
|
1429
|
+
/**
|
|
1430
|
+
* A roaring bitmap of row offsets.
|
|
1431
|
+
*
|
|
1432
|
+
* @generated from enum value: DELETION_KIND_BITMAP = 2;
|
|
1433
|
+
*/
|
|
1434
|
+
BITMAP = 2
|
|
1435
|
+
}
|
|
1436
|
+
/**
|
|
1437
|
+
* Describes the enum loams.collection.v1.DeletionKind.
|
|
1438
|
+
*/
|
|
1439
|
+
export declare const DeletionKindSchema: GenEnum<DeletionKind>;
|
|
1440
|
+
/**
|
|
1441
|
+
* @generated from service loams.collection.v1.NamespaceService
|
|
1442
|
+
*/
|
|
1443
|
+
export declare const NamespaceService: GenService<{
|
|
1444
|
+
/**
|
|
1445
|
+
* Creates the namespace, or answers `already_exists` when it is already
|
|
1446
|
+
* there. Creating a collection creates its namespace, so this RPC is for
|
|
1447
|
+
* a caller that wants the namespace to exist before it writes to it.
|
|
1448
|
+
*
|
|
1449
|
+
* @generated from rpc loams.collection.v1.NamespaceService.CreateNamespace
|
|
1450
|
+
*/
|
|
1451
|
+
createNamespace: {
|
|
1452
|
+
methodKind: "unary";
|
|
1453
|
+
input: typeof CreateNamespaceRequestSchema;
|
|
1454
|
+
output: typeof CreateNamespaceResponseSchema;
|
|
1455
|
+
};
|
|
1456
|
+
/**
|
|
1457
|
+
* The namespaces the caller can reach, by name (AIP-158 paged). The
|
|
1458
|
+
* engine's own reserved namespace is never listed. A caller reaches a
|
|
1459
|
+
* namespace by the same rules a namespace's data is reached by: the
|
|
1460
|
+
* operator (sign-in off, a key from the keys file) and an org owner or
|
|
1461
|
+
* admin reach every one; a member reaches the namespaces that are no
|
|
1462
|
+
* project's environment and the environments their project grants give
|
|
1463
|
+
* them; a credential bound to one environment reaches only that
|
|
1464
|
+
* environment's namespace; anyone outside the org reaches none.
|
|
1465
|
+
*
|
|
1466
|
+
* The counts come from the metastore's catalog in the same read, so they
|
|
1467
|
+
* cost nothing per namespace; document counts and bytes are not here,
|
|
1468
|
+
* since the engine does not keep them per namespace.
|
|
1469
|
+
*
|
|
1470
|
+
* @generated from rpc loams.collection.v1.NamespaceService.ListNamespaces
|
|
1471
|
+
*/
|
|
1472
|
+
listNamespaces: {
|
|
1473
|
+
methodKind: "unary";
|
|
1474
|
+
input: typeof ListNamespacesRequestSchema;
|
|
1475
|
+
output: typeof ListNamespacesResponseSchema;
|
|
1476
|
+
};
|
|
1477
|
+
}>;
|
|
1478
|
+
/**
|
|
1479
|
+
* @generated from service loams.collection.v1.CollectionService
|
|
1480
|
+
*/
|
|
1481
|
+
export declare const CollectionService: GenService<{
|
|
1482
|
+
/**
|
|
1483
|
+
* Creates the collection, or answers the one already under that name when
|
|
1484
|
+
* the request is the same one. `idempotency_level` is left unset: this is
|
|
1485
|
+
* not a free read, and `FacadeOptions.retry_safe` is what tells an SDK it
|
|
1486
|
+
* may repeat the call after a lost answer.
|
|
1487
|
+
*
|
|
1488
|
+
* @generated from rpc loams.collection.v1.CollectionService.CreateCollection
|
|
1489
|
+
*/
|
|
1490
|
+
createCollection: {
|
|
1491
|
+
methodKind: "unary";
|
|
1492
|
+
input: typeof CreateCollectionRequestSchema;
|
|
1493
|
+
output: typeof CollectionInfoSchema;
|
|
1494
|
+
};
|
|
1495
|
+
/**
|
|
1496
|
+
* Every collection of the namespace, by name.
|
|
1497
|
+
*
|
|
1498
|
+
* buf lint: RPC_RESPONSE_STANDARD_NAME is excepted for this file in
|
|
1499
|
+
* buf.yaml. The collection's own document is the answer, and
|
|
1500
|
+
* `ListCollections` embeds the same `CollectionInfo`, so a
|
|
1501
|
+
* `CreateCollectionResponse` wrapper would exist only to be unwrapped.
|
|
1502
|
+
*
|
|
1503
|
+
* @generated from rpc loams.collection.v1.CollectionService.ListCollections
|
|
1504
|
+
*/
|
|
1505
|
+
listCollections: {
|
|
1506
|
+
methodKind: "unary";
|
|
1507
|
+
input: typeof ListCollectionsRequestSchema;
|
|
1508
|
+
output: typeof ListCollectionsResponseSchema;
|
|
1509
|
+
};
|
|
1510
|
+
/**
|
|
1511
|
+
* One collection, by name or by alias.
|
|
1512
|
+
*
|
|
1513
|
+
* The `hot` value is the *owner's* full status, not the catalog
|
|
1514
|
+
* configuration this node holds (M1.3 rule 4), so a caller that reads it
|
|
1515
|
+
* from any node reads the node that serves the queries.
|
|
1516
|
+
*
|
|
1517
|
+
* @generated from rpc loams.collection.v1.CollectionService.GetCollection
|
|
1518
|
+
*/
|
|
1519
|
+
getCollection: {
|
|
1520
|
+
methodKind: "unary";
|
|
1521
|
+
input: typeof GetCollectionRequestSchema;
|
|
1522
|
+
output: typeof CollectionInfoSchema;
|
|
1523
|
+
};
|
|
1524
|
+
/**
|
|
1525
|
+
* Drops the collection, by name (never by alias), and stops its tail.
|
|
1526
|
+
* Dropping what is not there is a success that dropped nothing, so a
|
|
1527
|
+
* retried drop is not an error.
|
|
1528
|
+
*
|
|
1529
|
+
* @generated from rpc loams.collection.v1.CollectionService.DropCollection
|
|
1530
|
+
*/
|
|
1531
|
+
dropCollection: {
|
|
1532
|
+
methodKind: "unary";
|
|
1533
|
+
input: typeof DropCollectionRequestSchema;
|
|
1534
|
+
output: typeof DropCollectionResponseSchema;
|
|
1535
|
+
};
|
|
1536
|
+
/**
|
|
1537
|
+
* Adds fields and vectors to the schema and publishes a new schema
|
|
1538
|
+
* version. Additive only: a field is never removed or retyped, so a repeat
|
|
1539
|
+
* that names the same fields is a no-op the caller can retry.
|
|
1540
|
+
*
|
|
1541
|
+
* @generated from rpc loams.collection.v1.CollectionService.AddFields
|
|
1542
|
+
*/
|
|
1543
|
+
addFields: {
|
|
1544
|
+
methodKind: "unary";
|
|
1545
|
+
input: typeof AddFieldsRequestSchema;
|
|
1546
|
+
output: typeof AddFieldsResponseSchema;
|
|
1547
|
+
};
|
|
1548
|
+
/**
|
|
1549
|
+
* Every retained manifest version of the collection, oldest first.
|
|
1550
|
+
*
|
|
1551
|
+
* @generated from rpc loams.collection.v1.CollectionService.ListVersions
|
|
1552
|
+
*/
|
|
1553
|
+
listVersions: {
|
|
1554
|
+
methodKind: "unary";
|
|
1555
|
+
input: typeof ListVersionsRequestSchema;
|
|
1556
|
+
output: typeof ListVersionsResponseSchema;
|
|
1557
|
+
};
|
|
1558
|
+
/**
|
|
1559
|
+
* Plans an external read of one state of the collection (plan M1.2 Task 14,
|
|
1560
|
+
* D53) and pins that state.
|
|
1561
|
+
*
|
|
1562
|
+
* The answer is `ScanPlan`, and the pin's token is *also* returned in the
|
|
1563
|
+
* `loams-consistency-token` response header, which is what a non-Connect
|
|
1564
|
+
* reader (a Lance or Flight SQL client) has. Planning reads the metastore,
|
|
1565
|
+
* the manifest chain and one Lance manifest, never the tail, so any node
|
|
1566
|
+
* serves it; this is a read that pins, not a free one, so it is not
|
|
1567
|
+
* `NO_SIDE_EFFECTS` and stays a `POST`.
|
|
1568
|
+
*
|
|
1569
|
+
* @generated from rpc loams.collection.v1.CollectionService.Scan
|
|
1570
|
+
*/
|
|
1571
|
+
scan: {
|
|
1572
|
+
methodKind: "unary";
|
|
1573
|
+
input: typeof ScanRequestSchema;
|
|
1574
|
+
output: typeof ScanPlanSchema;
|
|
1575
|
+
};
|
|
1576
|
+
/**
|
|
1577
|
+
* Applies alias actions to the namespace atomically. A repeated identical
|
|
1578
|
+
* request is a no-op, so the call is retry-safe.
|
|
1579
|
+
*
|
|
1580
|
+
* @generated from rpc loams.collection.v1.CollectionService.UpdateAliases
|
|
1581
|
+
*/
|
|
1582
|
+
updateAliases: {
|
|
1583
|
+
methodKind: "unary";
|
|
1584
|
+
input: typeof UpdateAliasesRequestSchema;
|
|
1585
|
+
output: typeof UpdateAliasesResponseSchema;
|
|
1586
|
+
};
|
|
1587
|
+
/**
|
|
1588
|
+
* Writes the catalog's hot configuration for the collection and answers the
|
|
1589
|
+
* status the local hot tier then builds towards. It is the configuration,
|
|
1590
|
+
* not the work: nothing is awaited here.
|
|
1591
|
+
*
|
|
1592
|
+
* @generated from rpc loams.collection.v1.CollectionService.SetHot
|
|
1593
|
+
*/
|
|
1594
|
+
setHot: {
|
|
1595
|
+
methodKind: "unary";
|
|
1596
|
+
input: typeof SetHotRequestSchema;
|
|
1597
|
+
output: typeof SetHotResponseSchema;
|
|
1598
|
+
};
|
|
1599
|
+
/**
|
|
1600
|
+
* Starts warming the collection on its owner and answers as soon as the
|
|
1601
|
+
* warm has been started. The collection is named by its name or an alias.
|
|
1602
|
+
*
|
|
1603
|
+
* @generated from rpc loams.collection.v1.CollectionService.WarmCollection
|
|
1604
|
+
*/
|
|
1605
|
+
warmCollection: {
|
|
1606
|
+
methodKind: "unary";
|
|
1607
|
+
input: typeof WarmCollectionRequestSchema;
|
|
1608
|
+
output: typeof WarmCollectionResponseSchema;
|
|
1609
|
+
};
|
|
1610
|
+
}>;
|