@query-farm/vgi 0.42.0 → 0.44.0
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 +5 -2
- package/dist/attach-ticket.d.ts +18 -7
- package/dist/client-entry.js +215 -91
- package/dist/client-entry.js.map +10 -9
- package/dist/codec/asd.d.ts +3 -1
- package/dist/codec/conform.d.ts +51 -0
- package/dist/errors.d.ts +5 -1
- package/dist/generated/vgi-service.d.ts +1315 -0
- package/dist/index.core.d.ts +1 -1
- package/dist/index.js +2143 -932
- package/dist/index.js.map +29 -28
- package/dist/protocol/dispatch.d.ts +14 -5
- package/dist/protocol/handlers/aggregate.d.ts +3 -2
- package/dist/protocol/handlers/catalog/admin.d.ts +2 -2
- package/dist/protocol/handlers/catalog/index.d.ts +3 -2
- package/dist/protocol/handlers/catalog/index_methods.d.ts +2 -2
- package/dist/protocol/handlers/catalog/macro.d.ts +2 -2
- package/dist/protocol/handlers/catalog/shared.d.ts +7 -14
- package/dist/protocol/handlers/catalog/table.d.ts +2 -2
- package/dist/protocol/handlers/catalog/view.d.ts +2 -2
- package/dist/protocol/handlers/function.d.ts +3 -2
- package/dist/protocol/handlers/shared.d.ts +2 -2
- package/dist/protocol/handlers/table-buffering.d.ts +3 -2
- package/dist/protocol/handlers/unimplemented.d.ts +4 -17
- package/dist/protocol/serializers/shared.d.ts +2 -1
- package/dist/rpc-server.d.ts +2 -2
- package/dist/serve-entry.js +2104 -903
- package/dist/serve-entry.js.map +25 -24
- package/dist/worker-cf-entry.js +2045 -842
- package/dist/worker-cf-entry.js.map +29 -28
- package/package.json +3 -3
- package/src/attach-ticket.ts +41 -13
- package/src/catalog/composite.ts +2 -1
- package/src/catalog/interface.ts +5 -4
- package/src/catalog/read-only.ts +8 -6
- package/src/client/client.ts +13 -5
- package/src/codec/asd.ts +5 -2
- package/src/codec/conform.ts +193 -0
- package/src/errors.ts +27 -7
- package/src/functions/registry.ts +3 -2
- package/src/generated/vgi-service.ts +2678 -0
- package/src/http/fetch.ts +1 -1
- package/src/index.core.ts +3 -1
- package/src/protocol/dispatch.ts +40 -29
- package/src/protocol/handlers/aggregate.ts +205 -232
- package/src/protocol/handlers/catalog/admin.ts +228 -299
- package/src/protocol/handlers/catalog/index.ts +17 -16
- package/src/protocol/handlers/catalog/index_methods.ts +26 -36
- package/src/protocol/handlers/catalog/macro.ts +54 -77
- package/src/protocol/handlers/catalog/shared.ts +30 -47
- package/src/protocol/handlers/catalog/table.ts +205 -270
- package/src/protocol/handlers/catalog/view.ts +59 -85
- package/src/protocol/handlers/function.ts +127 -156
- package/src/protocol/handlers/shared.ts +8 -6
- package/src/protocol/handlers/table-buffering.ts +53 -71
- package/src/protocol/handlers/unimplemented.ts +18 -62
- package/src/protocol/serializers/bind.ts +3 -1
- package/src/protocol/serializers/shared.ts +5 -2
- package/src/rpc-server.ts +7 -7
|
@@ -0,0 +1,1315 @@
|
|
|
1
|
+
import { type CallContext, type ExchangeFn, type ExchangeInit, type HeaderInit, type ProducerFn, type ProducerInit, Protocol, type SchemaLike } from "@query-farm/vgi-rpc";
|
|
2
|
+
import { type VgiSchema } from "../arrow/index.js";
|
|
3
|
+
/** The protocol's wire name: the `vgi_rpc.protocol` routing key and the HTTP path segment. */
|
|
4
|
+
export declare const VGI_PROTOCOL_NAME = "vgi.v2";
|
|
5
|
+
/** The protocol's semver, stamped on every request by a client of this protocol. */
|
|
6
|
+
export declare const VGI_PROTOCOL_VERSION = "2.1.0";
|
|
7
|
+
/** What a unary handler returns: the result row, now or later. */
|
|
8
|
+
export type VgiReply<T> = T | Promise<T>;
|
|
9
|
+
/** The result of a unary method with no `result` column. */
|
|
10
|
+
export type NoResult = Record<string, never>;
|
|
11
|
+
/** A `list` column's value as the Arrow backend decodes it: a vector on arrow-js, an array on flechette. */
|
|
12
|
+
export type WireList<T> = Iterable<T>;
|
|
13
|
+
/** A `map` column's value: vgi-rpc passes it through opaque, in the Arrow backend's own representation. */
|
|
14
|
+
export type WireMap = unknown;
|
|
15
|
+
/** The exchange (bidirectional) callbacks of a stream method. */
|
|
16
|
+
export interface VgiExchangeStream<S = unknown> {
|
|
17
|
+
readonly kind: "exchange";
|
|
18
|
+
readonly inputSchema: SchemaLike;
|
|
19
|
+
readonly outputSchema: SchemaLike;
|
|
20
|
+
readonly init: ExchangeInit<S>;
|
|
21
|
+
readonly exchange: ExchangeFn<S>;
|
|
22
|
+
readonly onCancel?: (state: S) => Promise<void> | void;
|
|
23
|
+
readonly headerInit?: HeaderInit;
|
|
24
|
+
}
|
|
25
|
+
/** The producer (server-streaming) callbacks of a stream method. */
|
|
26
|
+
export interface VgiProducerStream<S = unknown> {
|
|
27
|
+
readonly kind: "producer";
|
|
28
|
+
readonly outputSchema: SchemaLike;
|
|
29
|
+
readonly init: ProducerInit<S>;
|
|
30
|
+
readonly produce: ProducerFn<S>;
|
|
31
|
+
readonly onCancel?: (state: S) => Promise<void> | void;
|
|
32
|
+
readonly headerInit?: HeaderInit;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* A stream method's implementation. The params and header schemas come from
|
|
36
|
+
* the registration table, never from here: only the callbacks are the
|
|
37
|
+
* implementation's to choose. Build one with {@link exchangeStream} or
|
|
38
|
+
* {@link producerStream}, which infer the state type from `init`.
|
|
39
|
+
*/
|
|
40
|
+
export type VgiStream = VgiExchangeStream<any> | VgiProducerStream<any>;
|
|
41
|
+
/** An exchange {@link VgiStream}, its state type inferred from `init`. */
|
|
42
|
+
export declare function exchangeStream<S>(callbacks: Omit<VgiExchangeStream<S>, "kind">): VgiStream;
|
|
43
|
+
/** A producer {@link VgiStream}, its state type inferred from `init`. */
|
|
44
|
+
export declare function producerStream<S>(callbacks: Omit<VgiProducerStream<S>, "kind">): VgiStream;
|
|
45
|
+
/** The params of `aggregate_bind`, one property per params-schema column. */
|
|
46
|
+
export interface AggregateBindParams {
|
|
47
|
+
/** The packed `AggregateBindRequest`, as its IPC bytes (`binary`). */
|
|
48
|
+
request: Uint8Array;
|
|
49
|
+
}
|
|
50
|
+
/** The params of `aggregate_combine`, one property per params-schema column. */
|
|
51
|
+
export interface AggregateCombineParams {
|
|
52
|
+
/** The packed `AggregateCombineRequest`, as its IPC bytes (`binary`). */
|
|
53
|
+
request: Uint8Array;
|
|
54
|
+
}
|
|
55
|
+
/** The params of `aggregate_destructor`, one property per params-schema column. */
|
|
56
|
+
export interface AggregateDestructorParams {
|
|
57
|
+
/** The packed `AggregateDestructorRequest`, as its IPC bytes (`binary`). */
|
|
58
|
+
request: Uint8Array;
|
|
59
|
+
}
|
|
60
|
+
/** The params of `aggregate_finalize`, one property per params-schema column. */
|
|
61
|
+
export interface AggregateFinalizeParams {
|
|
62
|
+
/** The packed `AggregateFinalizeRequest`, as its IPC bytes (`binary`). */
|
|
63
|
+
request: Uint8Array;
|
|
64
|
+
}
|
|
65
|
+
/** The params of `aggregate_streaming_chunk`, one property per params-schema column. */
|
|
66
|
+
export interface AggregateStreamingChunkParams {
|
|
67
|
+
/** The packed `AggregateStreamingChunkRequest`, as its IPC bytes (`binary`). */
|
|
68
|
+
request: Uint8Array;
|
|
69
|
+
}
|
|
70
|
+
/** The params of `aggregate_streaming_close`, one property per params-schema column. */
|
|
71
|
+
export interface AggregateStreamingCloseParams {
|
|
72
|
+
/** The packed `AggregateStreamingCloseRequest`, as its IPC bytes (`binary`). */
|
|
73
|
+
request: Uint8Array;
|
|
74
|
+
}
|
|
75
|
+
/** The params of `aggregate_streaming_open`, one property per params-schema column. */
|
|
76
|
+
export interface AggregateStreamingOpenParams {
|
|
77
|
+
/** The packed `AggregateStreamingOpenRequest`, as its IPC bytes (`binary`). */
|
|
78
|
+
request: Uint8Array;
|
|
79
|
+
}
|
|
80
|
+
/** The params of `aggregate_update`, one property per params-schema column. */
|
|
81
|
+
export interface AggregateUpdateParams {
|
|
82
|
+
/** The packed `AggregateUpdateRequest`, as its IPC bytes (`binary`). */
|
|
83
|
+
request: Uint8Array;
|
|
84
|
+
}
|
|
85
|
+
/** The params of `aggregate_window`, one property per params-schema column. */
|
|
86
|
+
export interface AggregateWindowParams {
|
|
87
|
+
/** The packed `AggregateWindowRequest`, as its IPC bytes (`binary`). */
|
|
88
|
+
request: Uint8Array;
|
|
89
|
+
}
|
|
90
|
+
/** The params of `aggregate_window_batch`, one property per params-schema column. */
|
|
91
|
+
export interface AggregateWindowBatchParams {
|
|
92
|
+
/** The packed `AggregateWindowBatchRequest`, as its IPC bytes (`binary`). */
|
|
93
|
+
request: Uint8Array;
|
|
94
|
+
}
|
|
95
|
+
/** The params of `aggregate_window_destructor`, one property per params-schema column. */
|
|
96
|
+
export interface AggregateWindowDestructorParams {
|
|
97
|
+
/** The packed `AggregateWindowDestructorRequest`, as its IPC bytes (`binary`). */
|
|
98
|
+
request: Uint8Array;
|
|
99
|
+
}
|
|
100
|
+
/** The params of `aggregate_window_init`, one property per params-schema column. */
|
|
101
|
+
export interface AggregateWindowInitParams {
|
|
102
|
+
/** The packed `AggregateWindowInitRequest`, as its IPC bytes (`binary`). */
|
|
103
|
+
request: Uint8Array;
|
|
104
|
+
}
|
|
105
|
+
/** The params of `bind`, one property per params-schema column. */
|
|
106
|
+
export interface BindParams {
|
|
107
|
+
/** The packed `BindRequest`, as its IPC bytes (`binary`). */
|
|
108
|
+
request: Uint8Array;
|
|
109
|
+
}
|
|
110
|
+
/** The params of `catalog_attach`, one property per params-schema column. */
|
|
111
|
+
export interface CatalogAttachParams {
|
|
112
|
+
/** The packed `CatalogAttachRequest`, as its IPC bytes (`binary`). */
|
|
113
|
+
request: Uint8Array;
|
|
114
|
+
}
|
|
115
|
+
/** The params of `catalog_catalogs`, one property per params-schema column. */
|
|
116
|
+
export type CatalogCatalogsParams = Record<string, never>;
|
|
117
|
+
/** The params of `catalog_contents`, one property per params-schema column. */
|
|
118
|
+
export interface CatalogContentsParams {
|
|
119
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
120
|
+
attach_opaque_data: Uint8Array;
|
|
121
|
+
/** The `if_none_match` column (`string`, nullable). */
|
|
122
|
+
if_none_match: string | null;
|
|
123
|
+
}
|
|
124
|
+
/** The params of `catalog_copy_from_formats`, one property per params-schema column. */
|
|
125
|
+
export interface CatalogCopyFromFormatsParams {
|
|
126
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
127
|
+
attach_opaque_data: Uint8Array;
|
|
128
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
129
|
+
transaction_opaque_data: Uint8Array | null;
|
|
130
|
+
}
|
|
131
|
+
/** The params of `catalog_create`, one property per params-schema column. */
|
|
132
|
+
export interface CatalogCreateParams {
|
|
133
|
+
/** The packed `CatalogCreateRequest`, as its IPC bytes (`binary`). */
|
|
134
|
+
request: Uint8Array;
|
|
135
|
+
}
|
|
136
|
+
/** The params of `catalog_detach`, one property per params-schema column. */
|
|
137
|
+
export interface CatalogDetachParams {
|
|
138
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
139
|
+
attach_opaque_data: Uint8Array;
|
|
140
|
+
}
|
|
141
|
+
/** The params of `catalog_drop`, one property per params-schema column. */
|
|
142
|
+
export interface CatalogDropParams {
|
|
143
|
+
/** The `name` column (`string`). */
|
|
144
|
+
name: string;
|
|
145
|
+
}
|
|
146
|
+
/** The params of `catalog_index_create`, one property per params-schema column. */
|
|
147
|
+
export interface CatalogIndexCreateParams {
|
|
148
|
+
/** The packed `IndexCreateRequest`, as its IPC bytes (`binary`). */
|
|
149
|
+
request: Uint8Array;
|
|
150
|
+
}
|
|
151
|
+
/** The params of `catalog_index_drop`, one property per params-schema column. */
|
|
152
|
+
export interface CatalogIndexDropParams {
|
|
153
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
154
|
+
attach_opaque_data: Uint8Array;
|
|
155
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
156
|
+
schema_path: WireList<string | null>;
|
|
157
|
+
/** The `name` column (`string`). */
|
|
158
|
+
name: string;
|
|
159
|
+
/** The `ignore_not_found` column (`bool`). */
|
|
160
|
+
ignore_not_found: boolean;
|
|
161
|
+
/** The `cascade` column (`bool`). */
|
|
162
|
+
cascade: boolean;
|
|
163
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
164
|
+
transaction_opaque_data: Uint8Array | null;
|
|
165
|
+
}
|
|
166
|
+
/** The params of `catalog_index_get`, one property per params-schema column. */
|
|
167
|
+
export interface CatalogIndexGetParams {
|
|
168
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
169
|
+
attach_opaque_data: Uint8Array;
|
|
170
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
171
|
+
schema_path: WireList<string | null>;
|
|
172
|
+
/** The `name` column (`string`). */
|
|
173
|
+
name: string;
|
|
174
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
175
|
+
transaction_opaque_data: Uint8Array | null;
|
|
176
|
+
}
|
|
177
|
+
/** The params of `catalog_macro_create`, one property per params-schema column. */
|
|
178
|
+
export interface CatalogMacroCreateParams {
|
|
179
|
+
/** The packed `MacroCreateRequest`, as its IPC bytes (`binary`). */
|
|
180
|
+
request: Uint8Array;
|
|
181
|
+
}
|
|
182
|
+
/** The params of `catalog_macro_drop`, one property per params-schema column. */
|
|
183
|
+
export interface CatalogMacroDropParams {
|
|
184
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
185
|
+
attach_opaque_data: Uint8Array;
|
|
186
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
187
|
+
schema_path: WireList<string | null>;
|
|
188
|
+
/** The `name` column (`string`). */
|
|
189
|
+
name: string;
|
|
190
|
+
/** The `ignore_not_found` column (`bool`). */
|
|
191
|
+
ignore_not_found: boolean;
|
|
192
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
193
|
+
transaction_opaque_data: Uint8Array | null;
|
|
194
|
+
}
|
|
195
|
+
/** The params of `catalog_macro_get`, one property per params-schema column. */
|
|
196
|
+
export interface CatalogMacroGetParams {
|
|
197
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
198
|
+
attach_opaque_data: Uint8Array;
|
|
199
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
200
|
+
schema_path: WireList<string | null>;
|
|
201
|
+
/** The `name` column (`string`). */
|
|
202
|
+
name: string;
|
|
203
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
204
|
+
transaction_opaque_data: Uint8Array | null;
|
|
205
|
+
}
|
|
206
|
+
/** The params of `catalog_schema_contents_functions`, one property per params-schema column. */
|
|
207
|
+
export interface CatalogSchemaContentsFunctionsParams {
|
|
208
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
209
|
+
attach_opaque_data: Uint8Array;
|
|
210
|
+
/** The `path` column (`list<item: string>`). */
|
|
211
|
+
path: WireList<string | null>;
|
|
212
|
+
/** The `type` column (`dictionary<values=string, indices=int16, ordered=0>`). */
|
|
213
|
+
type: string;
|
|
214
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
215
|
+
transaction_opaque_data: Uint8Array | null;
|
|
216
|
+
}
|
|
217
|
+
/** The params of `catalog_schema_contents_indexes`, one property per params-schema column. */
|
|
218
|
+
export interface CatalogSchemaContentsIndexesParams {
|
|
219
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
220
|
+
attach_opaque_data: Uint8Array;
|
|
221
|
+
/** The `path` column (`list<item: string>`). */
|
|
222
|
+
path: WireList<string | null>;
|
|
223
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
224
|
+
transaction_opaque_data: Uint8Array | null;
|
|
225
|
+
}
|
|
226
|
+
/** The params of `catalog_schema_contents_macros`, one property per params-schema column. */
|
|
227
|
+
export interface CatalogSchemaContentsMacrosParams {
|
|
228
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
229
|
+
attach_opaque_data: Uint8Array;
|
|
230
|
+
/** The `path` column (`list<item: string>`). */
|
|
231
|
+
path: WireList<string | null>;
|
|
232
|
+
/** The `type` column (`dictionary<values=string, indices=int16, ordered=0>`). */
|
|
233
|
+
type: string;
|
|
234
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
235
|
+
transaction_opaque_data: Uint8Array | null;
|
|
236
|
+
}
|
|
237
|
+
/** The params of `catalog_schema_contents_tables`, one property per params-schema column. */
|
|
238
|
+
export interface CatalogSchemaContentsTablesParams {
|
|
239
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
240
|
+
attach_opaque_data: Uint8Array;
|
|
241
|
+
/** The `path` column (`list<item: string>`). */
|
|
242
|
+
path: WireList<string | null>;
|
|
243
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
244
|
+
transaction_opaque_data: Uint8Array | null;
|
|
245
|
+
}
|
|
246
|
+
/** The params of `catalog_schema_contents_views`, one property per params-schema column. */
|
|
247
|
+
export interface CatalogSchemaContentsViewsParams {
|
|
248
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
249
|
+
attach_opaque_data: Uint8Array;
|
|
250
|
+
/** The `path` column (`list<item: string>`). */
|
|
251
|
+
path: WireList<string | null>;
|
|
252
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
253
|
+
transaction_opaque_data: Uint8Array | null;
|
|
254
|
+
}
|
|
255
|
+
/** The params of `catalog_schema_create`, one property per params-schema column. */
|
|
256
|
+
export interface CatalogSchemaCreateParams {
|
|
257
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
258
|
+
attach_opaque_data: Uint8Array;
|
|
259
|
+
/** The `path` column (`list<item: string>`). */
|
|
260
|
+
path: WireList<string | null>;
|
|
261
|
+
/** The `on_conflict` column (`dictionary<values=string, indices=int16, ordered=0>`). */
|
|
262
|
+
on_conflict: string;
|
|
263
|
+
/** The `comment` column (`string`, nullable). */
|
|
264
|
+
comment: string | null;
|
|
265
|
+
/** The `tags` column (`map<string, string>`, nullable). */
|
|
266
|
+
tags: WireMap | null;
|
|
267
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
268
|
+
transaction_opaque_data: Uint8Array | null;
|
|
269
|
+
}
|
|
270
|
+
/** The params of `catalog_schema_drop`, one property per params-schema column. */
|
|
271
|
+
export interface CatalogSchemaDropParams {
|
|
272
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
273
|
+
attach_opaque_data: Uint8Array;
|
|
274
|
+
/** The `path` column (`list<item: string>`). */
|
|
275
|
+
path: WireList<string | null>;
|
|
276
|
+
/** The `ignore_not_found` column (`bool`). */
|
|
277
|
+
ignore_not_found: boolean;
|
|
278
|
+
/** The `cascade` column (`bool`). */
|
|
279
|
+
cascade: boolean;
|
|
280
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
281
|
+
transaction_opaque_data: Uint8Array | null;
|
|
282
|
+
}
|
|
283
|
+
/** The params of `catalog_schema_get`, one property per params-schema column. */
|
|
284
|
+
export interface CatalogSchemaGetParams {
|
|
285
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
286
|
+
attach_opaque_data: Uint8Array;
|
|
287
|
+
/** The `path` column (`list<item: string>`). */
|
|
288
|
+
path: WireList<string | null>;
|
|
289
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
290
|
+
transaction_opaque_data: Uint8Array | null;
|
|
291
|
+
}
|
|
292
|
+
/** The params of `catalog_schemas`, one property per params-schema column. */
|
|
293
|
+
export interface CatalogSchemasParams {
|
|
294
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
295
|
+
attach_opaque_data: Uint8Array;
|
|
296
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
297
|
+
transaction_opaque_data: Uint8Array | null;
|
|
298
|
+
}
|
|
299
|
+
/** The params of `catalog_table_column_add`, one property per params-schema column. */
|
|
300
|
+
export interface CatalogTableColumnAddParams {
|
|
301
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
302
|
+
attach_opaque_data: Uint8Array;
|
|
303
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
304
|
+
schema_path: WireList<string | null>;
|
|
305
|
+
/** The `name` column (`string`). */
|
|
306
|
+
name: string;
|
|
307
|
+
/** The `column_definition` column (`binary`). */
|
|
308
|
+
column_definition: Uint8Array;
|
|
309
|
+
/** The `ignore_not_found` column (`bool`). */
|
|
310
|
+
ignore_not_found: boolean;
|
|
311
|
+
/** The `if_column_not_exists` column (`bool`). */
|
|
312
|
+
if_column_not_exists: boolean;
|
|
313
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
314
|
+
transaction_opaque_data: Uint8Array | null;
|
|
315
|
+
}
|
|
316
|
+
/** The params of `catalog_table_column_comment_set`, one property per params-schema column. */
|
|
317
|
+
export interface CatalogTableColumnCommentSetParams {
|
|
318
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
319
|
+
attach_opaque_data: Uint8Array;
|
|
320
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
321
|
+
schema_path: WireList<string | null>;
|
|
322
|
+
/** The `name` column (`string`). */
|
|
323
|
+
name: string;
|
|
324
|
+
/** The `column_name` column (`string`). */
|
|
325
|
+
column_name: string;
|
|
326
|
+
/** The `comment` column (`string`, nullable). */
|
|
327
|
+
comment: string | null;
|
|
328
|
+
/** The `ignore_not_found` column (`bool`). */
|
|
329
|
+
ignore_not_found: boolean;
|
|
330
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
331
|
+
transaction_opaque_data: Uint8Array | null;
|
|
332
|
+
}
|
|
333
|
+
/** The params of `catalog_table_column_default_drop`, one property per params-schema column. */
|
|
334
|
+
export interface CatalogTableColumnDefaultDropParams {
|
|
335
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
336
|
+
attach_opaque_data: Uint8Array;
|
|
337
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
338
|
+
schema_path: WireList<string | null>;
|
|
339
|
+
/** The `name` column (`string`). */
|
|
340
|
+
name: string;
|
|
341
|
+
/** The `column_name` column (`string`). */
|
|
342
|
+
column_name: string;
|
|
343
|
+
/** The `ignore_not_found` column (`bool`). */
|
|
344
|
+
ignore_not_found: boolean;
|
|
345
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
346
|
+
transaction_opaque_data: Uint8Array | null;
|
|
347
|
+
}
|
|
348
|
+
/** The params of `catalog_table_column_default_set`, one property per params-schema column. */
|
|
349
|
+
export interface CatalogTableColumnDefaultSetParams {
|
|
350
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
351
|
+
attach_opaque_data: Uint8Array;
|
|
352
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
353
|
+
schema_path: WireList<string | null>;
|
|
354
|
+
/** The `name` column (`string`). */
|
|
355
|
+
name: string;
|
|
356
|
+
/** The `column_name` column (`string`). */
|
|
357
|
+
column_name: string;
|
|
358
|
+
/** The `expression` column (`string`). */
|
|
359
|
+
expression: string;
|
|
360
|
+
/** The `ignore_not_found` column (`bool`). */
|
|
361
|
+
ignore_not_found: boolean;
|
|
362
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
363
|
+
transaction_opaque_data: Uint8Array | null;
|
|
364
|
+
}
|
|
365
|
+
/** The params of `catalog_table_column_drop`, one property per params-schema column. */
|
|
366
|
+
export interface CatalogTableColumnDropParams {
|
|
367
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
368
|
+
attach_opaque_data: Uint8Array;
|
|
369
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
370
|
+
schema_path: WireList<string | null>;
|
|
371
|
+
/** The `name` column (`string`). */
|
|
372
|
+
name: string;
|
|
373
|
+
/** The `column_name` column (`string`). */
|
|
374
|
+
column_name: string;
|
|
375
|
+
/** The `ignore_not_found` column (`bool`). */
|
|
376
|
+
ignore_not_found: boolean;
|
|
377
|
+
/** The `if_column_exists` column (`bool`). */
|
|
378
|
+
if_column_exists: boolean;
|
|
379
|
+
/** The `cascade` column (`bool`). */
|
|
380
|
+
cascade: boolean;
|
|
381
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
382
|
+
transaction_opaque_data: Uint8Array | null;
|
|
383
|
+
}
|
|
384
|
+
/** The params of `catalog_table_column_rename`, one property per params-schema column. */
|
|
385
|
+
export interface CatalogTableColumnRenameParams {
|
|
386
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
387
|
+
attach_opaque_data: Uint8Array;
|
|
388
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
389
|
+
schema_path: WireList<string | null>;
|
|
390
|
+
/** The `name` column (`string`). */
|
|
391
|
+
name: string;
|
|
392
|
+
/** The `column_name` column (`string`). */
|
|
393
|
+
column_name: string;
|
|
394
|
+
/** The `new_column_name` column (`string`). */
|
|
395
|
+
new_column_name: string;
|
|
396
|
+
/** The `ignore_not_found` column (`bool`). */
|
|
397
|
+
ignore_not_found: boolean;
|
|
398
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
399
|
+
transaction_opaque_data: Uint8Array | null;
|
|
400
|
+
}
|
|
401
|
+
/** The params of `catalog_table_column_statistics_get`, one property per params-schema column. */
|
|
402
|
+
export interface CatalogTableColumnStatisticsGetParams {
|
|
403
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
404
|
+
attach_opaque_data: Uint8Array;
|
|
405
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
406
|
+
schema_path: WireList<string | null>;
|
|
407
|
+
/** The `name` column (`string`). */
|
|
408
|
+
name: string;
|
|
409
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
410
|
+
transaction_opaque_data: Uint8Array | null;
|
|
411
|
+
}
|
|
412
|
+
/** The params of `catalog_table_column_type_change`, one property per params-schema column. */
|
|
413
|
+
export interface CatalogTableColumnTypeChangeParams {
|
|
414
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
415
|
+
attach_opaque_data: Uint8Array;
|
|
416
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
417
|
+
schema_path: WireList<string | null>;
|
|
418
|
+
/** The `name` column (`string`). */
|
|
419
|
+
name: string;
|
|
420
|
+
/** The `column_definition` column (`binary`). */
|
|
421
|
+
column_definition: Uint8Array;
|
|
422
|
+
/** The `expression` column (`string`, nullable). */
|
|
423
|
+
expression: string | null;
|
|
424
|
+
/** The `ignore_not_found` column (`bool`). */
|
|
425
|
+
ignore_not_found: boolean;
|
|
426
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
427
|
+
transaction_opaque_data: Uint8Array | null;
|
|
428
|
+
}
|
|
429
|
+
/** The params of `catalog_table_comment_set`, one property per params-schema column. */
|
|
430
|
+
export interface CatalogTableCommentSetParams {
|
|
431
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
432
|
+
attach_opaque_data: Uint8Array;
|
|
433
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
434
|
+
schema_path: WireList<string | null>;
|
|
435
|
+
/** The `name` column (`string`). */
|
|
436
|
+
name: string;
|
|
437
|
+
/** The `comment` column (`string`, nullable). */
|
|
438
|
+
comment: string | null;
|
|
439
|
+
/** The `ignore_not_found` column (`bool`). */
|
|
440
|
+
ignore_not_found: boolean;
|
|
441
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
442
|
+
transaction_opaque_data: Uint8Array | null;
|
|
443
|
+
}
|
|
444
|
+
/** The params of `catalog_table_create`, one property per params-schema column. */
|
|
445
|
+
export interface CatalogTableCreateParams {
|
|
446
|
+
/** The packed `TableCreateRequest`, as its IPC bytes (`binary`). */
|
|
447
|
+
request: Uint8Array;
|
|
448
|
+
}
|
|
449
|
+
/** The params of `catalog_table_delete_function_get`, one property per params-schema column. */
|
|
450
|
+
export interface CatalogTableDeleteFunctionGetParams {
|
|
451
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
452
|
+
attach_opaque_data: Uint8Array;
|
|
453
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
454
|
+
schema_path: WireList<string | null>;
|
|
455
|
+
/** The `name` column (`string`). */
|
|
456
|
+
name: string;
|
|
457
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
458
|
+
transaction_opaque_data: Uint8Array | null;
|
|
459
|
+
}
|
|
460
|
+
/** The params of `catalog_table_drop`, one property per params-schema column. */
|
|
461
|
+
export interface CatalogTableDropParams {
|
|
462
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
463
|
+
attach_opaque_data: Uint8Array;
|
|
464
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
465
|
+
schema_path: WireList<string | null>;
|
|
466
|
+
/** The `name` column (`string`). */
|
|
467
|
+
name: string;
|
|
468
|
+
/** The `ignore_not_found` column (`bool`). */
|
|
469
|
+
ignore_not_found: boolean;
|
|
470
|
+
/** The `cascade` column (`bool`). */
|
|
471
|
+
cascade: boolean;
|
|
472
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
473
|
+
transaction_opaque_data: Uint8Array | null;
|
|
474
|
+
}
|
|
475
|
+
/** The params of `catalog_table_get`, one property per params-schema column. */
|
|
476
|
+
export interface CatalogTableGetParams {
|
|
477
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
478
|
+
attach_opaque_data: Uint8Array;
|
|
479
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
480
|
+
schema_path: WireList<string | null>;
|
|
481
|
+
/** The `name` column (`string`). */
|
|
482
|
+
name: string;
|
|
483
|
+
/** The `at_unit` column (`string`, nullable). */
|
|
484
|
+
at_unit: string | null;
|
|
485
|
+
/** The `at_value` column (`string`, nullable). */
|
|
486
|
+
at_value: string | null;
|
|
487
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
488
|
+
transaction_opaque_data: Uint8Array | null;
|
|
489
|
+
}
|
|
490
|
+
/** The params of `catalog_table_insert_function_get`, one property per params-schema column. */
|
|
491
|
+
export interface CatalogTableInsertFunctionGetParams {
|
|
492
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
493
|
+
attach_opaque_data: Uint8Array;
|
|
494
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
495
|
+
schema_path: WireList<string | null>;
|
|
496
|
+
/** The `name` column (`string`). */
|
|
497
|
+
name: string;
|
|
498
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
499
|
+
transaction_opaque_data: Uint8Array | null;
|
|
500
|
+
/** The `writable_branch_function_name` column (`string`, nullable). */
|
|
501
|
+
writable_branch_function_name: string | null;
|
|
502
|
+
}
|
|
503
|
+
/** The params of `catalog_table_not_null_drop`, one property per params-schema column. */
|
|
504
|
+
export interface CatalogTableNotNullDropParams {
|
|
505
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
506
|
+
attach_opaque_data: Uint8Array;
|
|
507
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
508
|
+
schema_path: WireList<string | null>;
|
|
509
|
+
/** The `name` column (`string`). */
|
|
510
|
+
name: string;
|
|
511
|
+
/** The `column_name` column (`string`). */
|
|
512
|
+
column_name: string;
|
|
513
|
+
/** The `ignore_not_found` column (`bool`). */
|
|
514
|
+
ignore_not_found: boolean;
|
|
515
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
516
|
+
transaction_opaque_data: Uint8Array | null;
|
|
517
|
+
}
|
|
518
|
+
/** The params of `catalog_table_not_null_set`, one property per params-schema column. */
|
|
519
|
+
export interface CatalogTableNotNullSetParams {
|
|
520
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
521
|
+
attach_opaque_data: Uint8Array;
|
|
522
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
523
|
+
schema_path: WireList<string | null>;
|
|
524
|
+
/** The `name` column (`string`). */
|
|
525
|
+
name: string;
|
|
526
|
+
/** The `column_name` column (`string`). */
|
|
527
|
+
column_name: string;
|
|
528
|
+
/** The `ignore_not_found` column (`bool`). */
|
|
529
|
+
ignore_not_found: boolean;
|
|
530
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
531
|
+
transaction_opaque_data: Uint8Array | null;
|
|
532
|
+
}
|
|
533
|
+
/** The params of `catalog_table_rename`, one property per params-schema column. */
|
|
534
|
+
export interface CatalogTableRenameParams {
|
|
535
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
536
|
+
attach_opaque_data: Uint8Array;
|
|
537
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
538
|
+
schema_path: WireList<string | null>;
|
|
539
|
+
/** The `name` column (`string`). */
|
|
540
|
+
name: string;
|
|
541
|
+
/** The `new_name` column (`string`). */
|
|
542
|
+
new_name: string;
|
|
543
|
+
/** The `ignore_not_found` column (`bool`). */
|
|
544
|
+
ignore_not_found: boolean;
|
|
545
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
546
|
+
transaction_opaque_data: Uint8Array | null;
|
|
547
|
+
}
|
|
548
|
+
/** The params of `catalog_table_scan_branches_get`, one property per params-schema column. */
|
|
549
|
+
export interface CatalogTableScanBranchesGetParams {
|
|
550
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
551
|
+
attach_opaque_data: Uint8Array;
|
|
552
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
553
|
+
schema_path: WireList<string | null>;
|
|
554
|
+
/** The `name` column (`string`). */
|
|
555
|
+
name: string;
|
|
556
|
+
/** The `at_unit` column (`string`, nullable). */
|
|
557
|
+
at_unit: string | null;
|
|
558
|
+
/** The `at_value` column (`string`, nullable). */
|
|
559
|
+
at_value: string | null;
|
|
560
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
561
|
+
transaction_opaque_data: Uint8Array | null;
|
|
562
|
+
}
|
|
563
|
+
/** The params of `catalog_table_scan_function_get`, one property per params-schema column. */
|
|
564
|
+
export interface CatalogTableScanFunctionGetParams {
|
|
565
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
566
|
+
attach_opaque_data: Uint8Array;
|
|
567
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
568
|
+
schema_path: WireList<string | null>;
|
|
569
|
+
/** The `name` column (`string`). */
|
|
570
|
+
name: string;
|
|
571
|
+
/** The `at_unit` column (`string`, nullable). */
|
|
572
|
+
at_unit: string | null;
|
|
573
|
+
/** The `at_value` column (`string`, nullable). */
|
|
574
|
+
at_value: string | null;
|
|
575
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
576
|
+
transaction_opaque_data: Uint8Array | null;
|
|
577
|
+
}
|
|
578
|
+
/** The params of `catalog_table_update_function_get`, one property per params-schema column. */
|
|
579
|
+
export interface CatalogTableUpdateFunctionGetParams {
|
|
580
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
581
|
+
attach_opaque_data: Uint8Array;
|
|
582
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
583
|
+
schema_path: WireList<string | null>;
|
|
584
|
+
/** The `name` column (`string`). */
|
|
585
|
+
name: string;
|
|
586
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
587
|
+
transaction_opaque_data: Uint8Array | null;
|
|
588
|
+
}
|
|
589
|
+
/** The params of `catalog_transaction_begin`, one property per params-schema column. */
|
|
590
|
+
export interface CatalogTransactionBeginParams {
|
|
591
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
592
|
+
attach_opaque_data: Uint8Array;
|
|
593
|
+
}
|
|
594
|
+
/** The params of `catalog_transaction_commit`, one property per params-schema column. */
|
|
595
|
+
export interface CatalogTransactionCommitParams {
|
|
596
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
597
|
+
attach_opaque_data: Uint8Array;
|
|
598
|
+
/** The `transaction_opaque_data` column (`binary`). */
|
|
599
|
+
transaction_opaque_data: Uint8Array;
|
|
600
|
+
}
|
|
601
|
+
/** The params of `catalog_transaction_rollback`, one property per params-schema column. */
|
|
602
|
+
export interface CatalogTransactionRollbackParams {
|
|
603
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
604
|
+
attach_opaque_data: Uint8Array;
|
|
605
|
+
/** The `transaction_opaque_data` column (`binary`). */
|
|
606
|
+
transaction_opaque_data: Uint8Array;
|
|
607
|
+
}
|
|
608
|
+
/** The params of `catalog_version`, one property per params-schema column. */
|
|
609
|
+
export interface CatalogVersionParams {
|
|
610
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
611
|
+
attach_opaque_data: Uint8Array;
|
|
612
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
613
|
+
transaction_opaque_data: Uint8Array | null;
|
|
614
|
+
}
|
|
615
|
+
/** The params of `catalog_view_comment_set`, one property per params-schema column. */
|
|
616
|
+
export interface CatalogViewCommentSetParams {
|
|
617
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
618
|
+
attach_opaque_data: Uint8Array;
|
|
619
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
620
|
+
schema_path: WireList<string | null>;
|
|
621
|
+
/** The `name` column (`string`). */
|
|
622
|
+
name: string;
|
|
623
|
+
/** The `comment` column (`string`, nullable). */
|
|
624
|
+
comment: string | null;
|
|
625
|
+
/** The `ignore_not_found` column (`bool`). */
|
|
626
|
+
ignore_not_found: boolean;
|
|
627
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
628
|
+
transaction_opaque_data: Uint8Array | null;
|
|
629
|
+
}
|
|
630
|
+
/** The params of `catalog_view_create`, one property per params-schema column. */
|
|
631
|
+
export interface CatalogViewCreateParams {
|
|
632
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
633
|
+
attach_opaque_data: Uint8Array;
|
|
634
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
635
|
+
schema_path: WireList<string | null>;
|
|
636
|
+
/** The `name` column (`string`). */
|
|
637
|
+
name: string;
|
|
638
|
+
/** The `definition` column (`string`). */
|
|
639
|
+
definition: string;
|
|
640
|
+
/** The `on_conflict` column (`dictionary<values=string, indices=int16, ordered=0>`). */
|
|
641
|
+
on_conflict: string;
|
|
642
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
643
|
+
transaction_opaque_data: Uint8Array | null;
|
|
644
|
+
}
|
|
645
|
+
/** The params of `catalog_view_drop`, one property per params-schema column. */
|
|
646
|
+
export interface CatalogViewDropParams {
|
|
647
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
648
|
+
attach_opaque_data: Uint8Array;
|
|
649
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
650
|
+
schema_path: WireList<string | null>;
|
|
651
|
+
/** The `name` column (`string`). */
|
|
652
|
+
name: string;
|
|
653
|
+
/** The `ignore_not_found` column (`bool`). */
|
|
654
|
+
ignore_not_found: boolean;
|
|
655
|
+
/** The `cascade` column (`bool`). */
|
|
656
|
+
cascade: boolean;
|
|
657
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
658
|
+
transaction_opaque_data: Uint8Array | null;
|
|
659
|
+
}
|
|
660
|
+
/** The params of `catalog_view_get`, one property per params-schema column. */
|
|
661
|
+
export interface CatalogViewGetParams {
|
|
662
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
663
|
+
attach_opaque_data: Uint8Array;
|
|
664
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
665
|
+
schema_path: WireList<string | null>;
|
|
666
|
+
/** The `name` column (`string`). */
|
|
667
|
+
name: string;
|
|
668
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
669
|
+
transaction_opaque_data: Uint8Array | null;
|
|
670
|
+
}
|
|
671
|
+
/** The params of `catalog_view_rename`, one property per params-schema column. */
|
|
672
|
+
export interface CatalogViewRenameParams {
|
|
673
|
+
/** The `attach_opaque_data` column (`binary`). */
|
|
674
|
+
attach_opaque_data: Uint8Array;
|
|
675
|
+
/** The `schema_path` column (`list<item: string>`). */
|
|
676
|
+
schema_path: WireList<string | null>;
|
|
677
|
+
/** The `name` column (`string`). */
|
|
678
|
+
name: string;
|
|
679
|
+
/** The `new_name` column (`string`). */
|
|
680
|
+
new_name: string;
|
|
681
|
+
/** The `ignore_not_found` column (`bool`). */
|
|
682
|
+
ignore_not_found: boolean;
|
|
683
|
+
/** The `transaction_opaque_data` column (`binary`, nullable). */
|
|
684
|
+
transaction_opaque_data: Uint8Array | null;
|
|
685
|
+
}
|
|
686
|
+
/** The params of `init`, one property per params-schema column. */
|
|
687
|
+
export interface InitParams {
|
|
688
|
+
/** The packed `InitRequest`, as its IPC bytes (`binary`). */
|
|
689
|
+
request: Uint8Array;
|
|
690
|
+
}
|
|
691
|
+
/** The params of `table_buffering_combine`, one property per params-schema column. */
|
|
692
|
+
export interface TableBufferingCombineParams {
|
|
693
|
+
/** The packed `TableBufferingCombineRequest`, as its IPC bytes (`binary`). */
|
|
694
|
+
request: Uint8Array;
|
|
695
|
+
}
|
|
696
|
+
/** The params of `table_buffering_destructor`, one property per params-schema column. */
|
|
697
|
+
export interface TableBufferingDestructorParams {
|
|
698
|
+
/** The packed `TableBufferingDestructorRequest`, as its IPC bytes (`binary`). */
|
|
699
|
+
request: Uint8Array;
|
|
700
|
+
}
|
|
701
|
+
/** The params of `table_buffering_process`, one property per params-schema column. */
|
|
702
|
+
export interface TableBufferingProcessParams {
|
|
703
|
+
/** The packed `TableBufferingProcessRequest`, as its IPC bytes (`binary`). */
|
|
704
|
+
request: Uint8Array;
|
|
705
|
+
}
|
|
706
|
+
/** The params of `table_function_cardinality`, one property per params-schema column. */
|
|
707
|
+
export interface TableFunctionCardinalityParams {
|
|
708
|
+
/** The packed `TableFunctionCardinalityRequest`, as its IPC bytes (`binary`). */
|
|
709
|
+
request: Uint8Array;
|
|
710
|
+
}
|
|
711
|
+
/** The params of `table_function_dynamic_to_string`, one property per params-schema column. */
|
|
712
|
+
export interface TableFunctionDynamicToStringParams {
|
|
713
|
+
/** The packed `TableFunctionDynamicToStringRequest`, as its IPC bytes (`binary`). */
|
|
714
|
+
request: Uint8Array;
|
|
715
|
+
}
|
|
716
|
+
/** The params of `table_function_plan`, one property per params-schema column. */
|
|
717
|
+
export interface TableFunctionPlanParams {
|
|
718
|
+
/** The packed `TableFunctionPlanRequest`, as its IPC bytes (`binary`). */
|
|
719
|
+
request: Uint8Array;
|
|
720
|
+
}
|
|
721
|
+
/** The params of `table_function_statistics`, one property per params-schema column. */
|
|
722
|
+
export interface TableFunctionStatisticsParams {
|
|
723
|
+
/** The packed `TableFunctionStatisticsRequest`, as its IPC bytes (`binary`). */
|
|
724
|
+
request: Uint8Array;
|
|
725
|
+
}
|
|
726
|
+
/**
|
|
727
|
+
* The `vgi.v2` protocol: every method a VGI worker serves, generated from the
|
|
728
|
+
* reference (`vgi.protocol.VgiProtocol` in vgi-python).
|
|
729
|
+
*
|
|
730
|
+
* The protocol is the unit of optionality: every method is registered, whether
|
|
731
|
+
* or not this worker implements it, so `vgi_rpc.Reflection.v1` reports one
|
|
732
|
+
* `vgi.v2` hash in every SDK. Build an implementation by spreading handlers
|
|
733
|
+
* over {@link UNIMPLEMENTED_VGI_SERVICE}; register it with
|
|
734
|
+
* {@link registerVgiService}. Never change a signature here by hand:
|
|
735
|
+
* regenerate it, so the change comes from the protocol.
|
|
736
|
+
*/
|
|
737
|
+
export interface VgiService {
|
|
738
|
+
/**
|
|
739
|
+
* Bind an aggregate function, return output schema and execution_id.
|
|
740
|
+
*
|
|
741
|
+
* Wire method `aggregate_bind` (unary). Default: answers `UNIMPLEMENTED`.
|
|
742
|
+
*/
|
|
743
|
+
aggregateBind(params: AggregateBindParams, ctx: CallContext): VgiReply<{
|
|
744
|
+
result: Uint8Array;
|
|
745
|
+
}>;
|
|
746
|
+
/**
|
|
747
|
+
* Merge source states into target states.
|
|
748
|
+
*
|
|
749
|
+
* Wire method `aggregate_combine` (unary). Default: answers `UNIMPLEMENTED`.
|
|
750
|
+
*/
|
|
751
|
+
aggregateCombine(params: AggregateCombineParams, ctx: CallContext): VgiReply<{
|
|
752
|
+
result: Uint8Array;
|
|
753
|
+
}>;
|
|
754
|
+
/**
|
|
755
|
+
* Best-effort cleanup of aggregate states. Must not raise.
|
|
756
|
+
*
|
|
757
|
+
* Wire method `aggregate_destructor` (unary). Default: answers `UNIMPLEMENTED`.
|
|
758
|
+
*/
|
|
759
|
+
aggregateDestructor(params: AggregateDestructorParams, ctx: CallContext): VgiReply<{
|
|
760
|
+
result: Uint8Array;
|
|
761
|
+
}>;
|
|
762
|
+
/**
|
|
763
|
+
* Produce results for a chunk of group_ids.
|
|
764
|
+
*
|
|
765
|
+
* Wire method `aggregate_finalize` (unary). Default: answers `UNIMPLEMENTED`.
|
|
766
|
+
*/
|
|
767
|
+
aggregateFinalize(params: AggregateFinalizeParams, ctx: CallContext): VgiReply<{
|
|
768
|
+
result: Uint8Array;
|
|
769
|
+
}>;
|
|
770
|
+
/**
|
|
771
|
+
* Process one input chunk; returns one output row per input row.
|
|
772
|
+
*
|
|
773
|
+
* Wire method `aggregate_streaming_chunk` (unary). Default: answers `UNIMPLEMENTED`.
|
|
774
|
+
*/
|
|
775
|
+
aggregateStreamingChunk(params: AggregateStreamingChunkParams, ctx: CallContext): VgiReply<{
|
|
776
|
+
result: Uint8Array;
|
|
777
|
+
}>;
|
|
778
|
+
/**
|
|
779
|
+
* End the streaming session, free per-session state.
|
|
780
|
+
*
|
|
781
|
+
* Wire method `aggregate_streaming_close` (unary). Default: answers `UNIMPLEMENTED`.
|
|
782
|
+
*/
|
|
783
|
+
aggregateStreamingClose(params: AggregateStreamingCloseParams, ctx: CallContext): VgiReply<{
|
|
784
|
+
result: Uint8Array;
|
|
785
|
+
}>;
|
|
786
|
+
/**
|
|
787
|
+
* Start a streaming-partitioned aggregate session.
|
|
788
|
+
*
|
|
789
|
+
* Wire method `aggregate_streaming_open` (unary). Default: answers `UNIMPLEMENTED`.
|
|
790
|
+
*/
|
|
791
|
+
aggregateStreamingOpen(params: AggregateStreamingOpenParams, ctx: CallContext): VgiReply<{
|
|
792
|
+
result: Uint8Array;
|
|
793
|
+
}>;
|
|
794
|
+
/**
|
|
795
|
+
* Accumulate rows from a `DataChunk` into per-group state.
|
|
796
|
+
*
|
|
797
|
+
* Wire method `aggregate_update` (unary). Default: answers `UNIMPLEMENTED`.
|
|
798
|
+
*/
|
|
799
|
+
aggregateUpdate(params: AggregateUpdateParams, ctx: CallContext): VgiReply<{
|
|
800
|
+
result: Uint8Array;
|
|
801
|
+
}>;
|
|
802
|
+
/**
|
|
803
|
+
* Compute an aggregate value for one output row of the window.
|
|
804
|
+
*
|
|
805
|
+
* Wire method `aggregate_window` (unary). Default: answers `UNIMPLEMENTED`.
|
|
806
|
+
*/
|
|
807
|
+
aggregateWindow(params: AggregateWindowParams, ctx: CallContext): VgiReply<{
|
|
808
|
+
result: Uint8Array;
|
|
809
|
+
}>;
|
|
810
|
+
/**
|
|
811
|
+
* Compute ``count`` window output rows in one batched RPC.
|
|
812
|
+
*
|
|
813
|
+
* Wire method `aggregate_window_batch` (unary). Default: answers `UNIMPLEMENTED`.
|
|
814
|
+
*/
|
|
815
|
+
aggregateWindowBatch(params: AggregateWindowBatchParams, ctx: CallContext): VgiReply<{
|
|
816
|
+
result: Uint8Array;
|
|
817
|
+
}>;
|
|
818
|
+
/**
|
|
819
|
+
* Evict a cached partition from storage.
|
|
820
|
+
*
|
|
821
|
+
* Wire method `aggregate_window_destructor` (unary). Default: answers `UNIMPLEMENTED`.
|
|
822
|
+
*/
|
|
823
|
+
aggregateWindowDestructor(params: AggregateWindowDestructorParams, ctx: CallContext): VgiReply<{
|
|
824
|
+
result: Uint8Array;
|
|
825
|
+
}>;
|
|
826
|
+
/**
|
|
827
|
+
* Ship a partition to the worker for windowed aggregation.
|
|
828
|
+
*
|
|
829
|
+
* Wire method `aggregate_window_init` (unary). Default: answers `UNIMPLEMENTED`.
|
|
830
|
+
*/
|
|
831
|
+
aggregateWindowInit(params: AggregateWindowInitParams, ctx: CallContext): VgiReply<{
|
|
832
|
+
result: Uint8Array;
|
|
833
|
+
}>;
|
|
834
|
+
/**
|
|
835
|
+
* Resolve output schema and validate arguments.
|
|
836
|
+
*
|
|
837
|
+
* Wire method `bind` (unary). Default: answers `UNIMPLEMENTED`.
|
|
838
|
+
*/
|
|
839
|
+
bind(params: BindParams, ctx: CallContext): VgiReply<{
|
|
840
|
+
result: Uint8Array;
|
|
841
|
+
}>;
|
|
842
|
+
/**
|
|
843
|
+
* Attach to a catalog with options.
|
|
844
|
+
*
|
|
845
|
+
* Wire method `catalog_attach` (unary). Default: answers `UNIMPLEMENTED`.
|
|
846
|
+
*/
|
|
847
|
+
catalogAttach(params: CatalogAttachParams, ctx: CallContext): VgiReply<{
|
|
848
|
+
result: Uint8Array;
|
|
849
|
+
}>;
|
|
850
|
+
/**
|
|
851
|
+
* List available catalog names.
|
|
852
|
+
*
|
|
853
|
+
* Wire method `catalog_catalogs` (unary). Default: answers `UNIMPLEMENTED`.
|
|
854
|
+
*/
|
|
855
|
+
catalogCatalogs(params: CatalogCatalogsParams, ctx: CallContext): VgiReply<{
|
|
856
|
+
result: Uint8Array;
|
|
857
|
+
}>;
|
|
858
|
+
/**
|
|
859
|
+
* Return every schema and all of its contents in one result.
|
|
860
|
+
*
|
|
861
|
+
* Only called when the attach result sets ``supports_catalog_contents``. Replaces ``catalog_schemas`` plus every ``catalog_schema_contents_*`` call for a client that wants the whole catalog. Takes no transaction: the client caches the answer catalog-wide, so it is the committed catalog at ``catalog_version``.
|
|
862
|
+
*
|
|
863
|
+
* ``if_none_match`` is the ``etag`` of a snapshot the client holds. When it equals the current etag the response is ``not_modified`` with no schemas. A worker that returns ``etag = None`` ignores it.
|
|
864
|
+
*
|
|
865
|
+
* Wire method `catalog_contents` (unary). Default: answers `UNIMPLEMENTED`.
|
|
866
|
+
*/
|
|
867
|
+
catalogContents(params: CatalogContentsParams, ctx: CallContext): VgiReply<{
|
|
868
|
+
result: Uint8Array;
|
|
869
|
+
}>;
|
|
870
|
+
/**
|
|
871
|
+
* List custom ``COPY ... FROM`` formats advertised by this catalog.
|
|
872
|
+
*
|
|
873
|
+
* Catalog-level (not schema-scoped). Returns an empty list for catalogs with no custom formats. Additive: workers that don't implement this method return ``MethodNotImplementedError``, which the VGI extension treats as "this catalog advertises no COPY formats" and continues the ATTACH normally.
|
|
874
|
+
*
|
|
875
|
+
* Wire method `catalog_copy_from_formats` (unary). Default: answers `UNIMPLEMENTED`.
|
|
876
|
+
*/
|
|
877
|
+
catalogCopyFromFormats(params: CatalogCopyFromFormatsParams, ctx: CallContext): VgiReply<{
|
|
878
|
+
result: Uint8Array;
|
|
879
|
+
}>;
|
|
880
|
+
/**
|
|
881
|
+
* Create a new catalog.
|
|
882
|
+
*
|
|
883
|
+
* Wire method `catalog_create` (unary). Default: answers `UNIMPLEMENTED`.
|
|
884
|
+
*/
|
|
885
|
+
catalogCreate(params: CatalogCreateParams, ctx: CallContext): VgiReply<NoResult>;
|
|
886
|
+
/**
|
|
887
|
+
* Detach from a catalog.
|
|
888
|
+
*
|
|
889
|
+
* Wire method `catalog_detach` (unary). Default: answers `UNIMPLEMENTED`.
|
|
890
|
+
*/
|
|
891
|
+
catalogDetach(params: CatalogDetachParams, ctx: CallContext): VgiReply<NoResult>;
|
|
892
|
+
/**
|
|
893
|
+
* Drop a catalog.
|
|
894
|
+
*
|
|
895
|
+
* Wire method `catalog_drop` (unary). Default: answers `UNIMPLEMENTED`.
|
|
896
|
+
*/
|
|
897
|
+
catalogDrop(params: CatalogDropParams, ctx: CallContext): VgiReply<NoResult>;
|
|
898
|
+
/**
|
|
899
|
+
* Create a new index.
|
|
900
|
+
*
|
|
901
|
+
* Wire method `catalog_index_create` (unary). Default: answers `UNIMPLEMENTED`.
|
|
902
|
+
*/
|
|
903
|
+
catalogIndexCreate(params: CatalogIndexCreateParams, ctx: CallContext): VgiReply<NoResult>;
|
|
904
|
+
/**
|
|
905
|
+
* Drop an index.
|
|
906
|
+
*
|
|
907
|
+
* Wire method `catalog_index_drop` (unary). Default: answers `UNIMPLEMENTED`.
|
|
908
|
+
*/
|
|
909
|
+
catalogIndexDrop(params: CatalogIndexDropParams, ctx: CallContext): VgiReply<NoResult>;
|
|
910
|
+
/**
|
|
911
|
+
* Get information about an index. Returns 0 or 1 items.
|
|
912
|
+
*
|
|
913
|
+
* Wire method `catalog_index_get` (unary). Default: answers `UNIMPLEMENTED`.
|
|
914
|
+
*/
|
|
915
|
+
catalogIndexGet(params: CatalogIndexGetParams, ctx: CallContext): VgiReply<{
|
|
916
|
+
result: Uint8Array;
|
|
917
|
+
}>;
|
|
918
|
+
/**
|
|
919
|
+
* Create a new macro.
|
|
920
|
+
*
|
|
921
|
+
* Wire method `catalog_macro_create` (unary). Default: answers `UNIMPLEMENTED`.
|
|
922
|
+
*/
|
|
923
|
+
catalogMacroCreate(params: CatalogMacroCreateParams, ctx: CallContext): VgiReply<NoResult>;
|
|
924
|
+
/**
|
|
925
|
+
* Drop a macro.
|
|
926
|
+
*
|
|
927
|
+
* Wire method `catalog_macro_drop` (unary). Default: answers `UNIMPLEMENTED`.
|
|
928
|
+
*/
|
|
929
|
+
catalogMacroDrop(params: CatalogMacroDropParams, ctx: CallContext): VgiReply<NoResult>;
|
|
930
|
+
/**
|
|
931
|
+
* Get information about a macro. Returns 0 or 1 items.
|
|
932
|
+
*
|
|
933
|
+
* Wire method `catalog_macro_get` (unary). Default: answers `UNIMPLEMENTED`.
|
|
934
|
+
*/
|
|
935
|
+
catalogMacroGet(params: CatalogMacroGetParams, ctx: CallContext): VgiReply<{
|
|
936
|
+
result: Uint8Array;
|
|
937
|
+
}>;
|
|
938
|
+
/**
|
|
939
|
+
* List functions in a schema (scalar or table).
|
|
940
|
+
*
|
|
941
|
+
* Wire method `catalog_schema_contents_functions` (unary). Default: answers `UNIMPLEMENTED`.
|
|
942
|
+
*/
|
|
943
|
+
catalogSchemaContentsFunctions(params: CatalogSchemaContentsFunctionsParams, ctx: CallContext): VgiReply<{
|
|
944
|
+
result: Uint8Array;
|
|
945
|
+
}>;
|
|
946
|
+
/**
|
|
947
|
+
* List indexes in a schema.
|
|
948
|
+
*
|
|
949
|
+
* Wire method `catalog_schema_contents_indexes` (unary). Default: answers `UNIMPLEMENTED`.
|
|
950
|
+
*/
|
|
951
|
+
catalogSchemaContentsIndexes(params: CatalogSchemaContentsIndexesParams, ctx: CallContext): VgiReply<{
|
|
952
|
+
result: Uint8Array;
|
|
953
|
+
}>;
|
|
954
|
+
/**
|
|
955
|
+
* List macros in a schema (scalar or table).
|
|
956
|
+
*
|
|
957
|
+
* Wire method `catalog_schema_contents_macros` (unary). Default: answers `UNIMPLEMENTED`.
|
|
958
|
+
*/
|
|
959
|
+
catalogSchemaContentsMacros(params: CatalogSchemaContentsMacrosParams, ctx: CallContext): VgiReply<{
|
|
960
|
+
result: Uint8Array;
|
|
961
|
+
}>;
|
|
962
|
+
/**
|
|
963
|
+
* List tables in a schema.
|
|
964
|
+
*
|
|
965
|
+
* Wire method `catalog_schema_contents_tables` (unary). Default: answers `UNIMPLEMENTED`.
|
|
966
|
+
*/
|
|
967
|
+
catalogSchemaContentsTables(params: CatalogSchemaContentsTablesParams, ctx: CallContext): VgiReply<{
|
|
968
|
+
result: Uint8Array;
|
|
969
|
+
}>;
|
|
970
|
+
/**
|
|
971
|
+
* List views in a schema.
|
|
972
|
+
*
|
|
973
|
+
* Wire method `catalog_schema_contents_views` (unary). Default: answers `UNIMPLEMENTED`.
|
|
974
|
+
*/
|
|
975
|
+
catalogSchemaContentsViews(params: CatalogSchemaContentsViewsParams, ctx: CallContext): VgiReply<{
|
|
976
|
+
result: Uint8Array;
|
|
977
|
+
}>;
|
|
978
|
+
/**
|
|
979
|
+
* Create a new schema.
|
|
980
|
+
*
|
|
981
|
+
* Wire method `catalog_schema_create` (unary). Default: answers `UNIMPLEMENTED`.
|
|
982
|
+
*/
|
|
983
|
+
catalogSchemaCreate(params: CatalogSchemaCreateParams, ctx: CallContext): VgiReply<NoResult>;
|
|
984
|
+
/**
|
|
985
|
+
* Drop a schema.
|
|
986
|
+
*
|
|
987
|
+
* Wire method `catalog_schema_drop` (unary). Default: answers `UNIMPLEMENTED`.
|
|
988
|
+
*/
|
|
989
|
+
catalogSchemaDrop(params: CatalogSchemaDropParams, ctx: CallContext): VgiReply<NoResult>;
|
|
990
|
+
/**
|
|
991
|
+
* Get information about a schema. Returns 0 or 1 items.
|
|
992
|
+
*
|
|
993
|
+
* Wire method `catalog_schema_get` (unary). Default: answers `UNIMPLEMENTED`.
|
|
994
|
+
*/
|
|
995
|
+
catalogSchemaGet(params: CatalogSchemaGetParams, ctx: CallContext): VgiReply<{
|
|
996
|
+
result: Uint8Array;
|
|
997
|
+
}>;
|
|
998
|
+
/**
|
|
999
|
+
* List schemas in the catalog.
|
|
1000
|
+
*
|
|
1001
|
+
* Wire method `catalog_schemas` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1002
|
+
*/
|
|
1003
|
+
catalogSchemas(params: CatalogSchemasParams, ctx: CallContext): VgiReply<{
|
|
1004
|
+
result: Uint8Array;
|
|
1005
|
+
}>;
|
|
1006
|
+
/**
|
|
1007
|
+
* Add a new column to a table.
|
|
1008
|
+
*
|
|
1009
|
+
* Wire method `catalog_table_column_add` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1010
|
+
*/
|
|
1011
|
+
catalogTableColumnAdd(params: CatalogTableColumnAddParams, ctx: CallContext): VgiReply<NoResult>;
|
|
1012
|
+
/**
|
|
1013
|
+
* Set or clear the comment on a table column.
|
|
1014
|
+
*
|
|
1015
|
+
* Wire method `catalog_table_column_comment_set` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1016
|
+
*/
|
|
1017
|
+
catalogTableColumnCommentSet(params: CatalogTableColumnCommentSetParams, ctx: CallContext): VgiReply<NoResult>;
|
|
1018
|
+
/**
|
|
1019
|
+
* Remove the default value from a column.
|
|
1020
|
+
*
|
|
1021
|
+
* Wire method `catalog_table_column_default_drop` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1022
|
+
*/
|
|
1023
|
+
catalogTableColumnDefaultDrop(params: CatalogTableColumnDefaultDropParams, ctx: CallContext): VgiReply<NoResult>;
|
|
1024
|
+
/**
|
|
1025
|
+
* Set the default value expression for a column.
|
|
1026
|
+
*
|
|
1027
|
+
* Wire method `catalog_table_column_default_set` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1028
|
+
*/
|
|
1029
|
+
catalogTableColumnDefaultSet(params: CatalogTableColumnDefaultSetParams, ctx: CallContext): VgiReply<NoResult>;
|
|
1030
|
+
/**
|
|
1031
|
+
* Drop a column from a table.
|
|
1032
|
+
*
|
|
1033
|
+
* Wire method `catalog_table_column_drop` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1034
|
+
*/
|
|
1035
|
+
catalogTableColumnDrop(params: CatalogTableColumnDropParams, ctx: CallContext): VgiReply<NoResult>;
|
|
1036
|
+
/**
|
|
1037
|
+
* Rename a column.
|
|
1038
|
+
*
|
|
1039
|
+
* Wire method `catalog_table_column_rename` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1040
|
+
*/
|
|
1041
|
+
catalogTableColumnRename(params: CatalogTableColumnRenameParams, ctx: CallContext): VgiReply<NoResult>;
|
|
1042
|
+
/**
|
|
1043
|
+
* Get column statistics for a table.
|
|
1044
|
+
*
|
|
1045
|
+
* Returns IPC bytes of a `RecordBatch` with sparse-union min/max columns, or None if statistics are not available.
|
|
1046
|
+
*
|
|
1047
|
+
* Wire method `catalog_table_column_statistics_get` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1048
|
+
*/
|
|
1049
|
+
catalogTableColumnStatisticsGet(params: CatalogTableColumnStatisticsGetParams, ctx: CallContext): VgiReply<{
|
|
1050
|
+
result: Uint8Array | null;
|
|
1051
|
+
}>;
|
|
1052
|
+
/**
|
|
1053
|
+
* Change the type of a column.
|
|
1054
|
+
*
|
|
1055
|
+
* Wire method `catalog_table_column_type_change` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1056
|
+
*/
|
|
1057
|
+
catalogTableColumnTypeChange(params: CatalogTableColumnTypeChangeParams, ctx: CallContext): VgiReply<NoResult>;
|
|
1058
|
+
/**
|
|
1059
|
+
* Set or clear the comment on a table.
|
|
1060
|
+
*
|
|
1061
|
+
* Wire method `catalog_table_comment_set` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1062
|
+
*/
|
|
1063
|
+
catalogTableCommentSet(params: CatalogTableCommentSetParams, ctx: CallContext): VgiReply<NoResult>;
|
|
1064
|
+
/**
|
|
1065
|
+
* Create a new table.
|
|
1066
|
+
*
|
|
1067
|
+
* Wire method `catalog_table_create` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1068
|
+
*/
|
|
1069
|
+
catalogTableCreate(params: CatalogTableCreateParams, ctx: CallContext): VgiReply<NoResult>;
|
|
1070
|
+
/**
|
|
1071
|
+
* Get the delete function for a table. Returns `WriteFunctionResult` as IPC bytes.
|
|
1072
|
+
*
|
|
1073
|
+
* Wire method `catalog_table_delete_function_get` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1074
|
+
*/
|
|
1075
|
+
catalogTableDeleteFunctionGet(params: CatalogTableDeleteFunctionGetParams, ctx: CallContext): VgiReply<{
|
|
1076
|
+
result: Uint8Array;
|
|
1077
|
+
}>;
|
|
1078
|
+
/**
|
|
1079
|
+
* Drop a table.
|
|
1080
|
+
*
|
|
1081
|
+
* Wire method `catalog_table_drop` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1082
|
+
*/
|
|
1083
|
+
catalogTableDrop(params: CatalogTableDropParams, ctx: CallContext): VgiReply<NoResult>;
|
|
1084
|
+
/**
|
|
1085
|
+
* Get information about a table. Returns 0 or 1 items.
|
|
1086
|
+
*
|
|
1087
|
+
* Wire method `catalog_table_get` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1088
|
+
*/
|
|
1089
|
+
catalogTableGet(params: CatalogTableGetParams, ctx: CallContext): VgiReply<{
|
|
1090
|
+
result: Uint8Array;
|
|
1091
|
+
}>;
|
|
1092
|
+
/**
|
|
1093
|
+
* Get the insert function for a table. Returns `WriteFunctionResult` as IPC bytes.
|
|
1094
|
+
*
|
|
1095
|
+
* ``writable_branch_function_name`` is set by the C++ extension when the table is multi-branch and a branch declared ``writable=True``: the value is the writable arm's ``ScanBranch.function_name``. The worker uses it to disambiguate which physical arm to dispatch the INSERT to without re-resolving the writable arm internally. For single-branch tables (the common case) this is None and the worker dispatches as today.
|
|
1096
|
+
*
|
|
1097
|
+
* Wire method `catalog_table_insert_function_get` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1098
|
+
*/
|
|
1099
|
+
catalogTableInsertFunctionGet(params: CatalogTableInsertFunctionGetParams, ctx: CallContext): VgiReply<{
|
|
1100
|
+
result: Uint8Array;
|
|
1101
|
+
}>;
|
|
1102
|
+
/**
|
|
1103
|
+
* Remove NOT NULL constraint from a column.
|
|
1104
|
+
*
|
|
1105
|
+
* Wire method `catalog_table_not_null_drop` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1106
|
+
*/
|
|
1107
|
+
catalogTableNotNullDrop(params: CatalogTableNotNullDropParams, ctx: CallContext): VgiReply<NoResult>;
|
|
1108
|
+
/**
|
|
1109
|
+
* Add NOT NULL constraint to a column.
|
|
1110
|
+
*
|
|
1111
|
+
* Wire method `catalog_table_not_null_set` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1112
|
+
*/
|
|
1113
|
+
catalogTableNotNullSet(params: CatalogTableNotNullSetParams, ctx: CallContext): VgiReply<NoResult>;
|
|
1114
|
+
/**
|
|
1115
|
+
* Rename a table.
|
|
1116
|
+
*
|
|
1117
|
+
* Wire method `catalog_table_rename` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1118
|
+
*/
|
|
1119
|
+
catalogTableRename(params: CatalogTableRenameParams, ctx: CallContext): VgiReply<NoResult>;
|
|
1120
|
+
/**
|
|
1121
|
+
* Get the list of scan branches for a multi-branch table. Returns `ScanBranchesResult` as IPC bytes.
|
|
1122
|
+
*
|
|
1123
|
+
* Additive successor to ``catalog_table_scan_function_get``. Workers that only implement the legacy method continue to work — the VGI extension's C++ side catches ``MethodNotImplementedError`` and falls back to the legacy RPC, wrapping the single-function result as a one-branch list. Workers that implement BOTH the legacy and the branches method guarantee single-process compatibility with both old and new extensions.
|
|
1124
|
+
*
|
|
1125
|
+
* Multi-branch tables compose a logical scan from N physical sources (canonical case: Kafka hot tier + Iceberg cold tier). The extension's optimizer rewrite stitches the branches together via ``LogicalSetOperation(UNION_ALL, ...)``, one arm per branch.
|
|
1126
|
+
*
|
|
1127
|
+
* Wire method `catalog_table_scan_branches_get` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1128
|
+
*/
|
|
1129
|
+
catalogTableScanBranchesGet(params: CatalogTableScanBranchesGetParams, ctx: CallContext): VgiReply<{
|
|
1130
|
+
result: Uint8Array;
|
|
1131
|
+
}>;
|
|
1132
|
+
/**
|
|
1133
|
+
* Get the scan function for a table. Returns `ScanFunctionResult` as IPC bytes.
|
|
1134
|
+
*
|
|
1135
|
+
* Wire method `catalog_table_scan_function_get` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1136
|
+
*/
|
|
1137
|
+
catalogTableScanFunctionGet(params: CatalogTableScanFunctionGetParams, ctx: CallContext): VgiReply<{
|
|
1138
|
+
result: Uint8Array;
|
|
1139
|
+
}>;
|
|
1140
|
+
/**
|
|
1141
|
+
* Get the update function for a table. Returns `WriteFunctionResult` as IPC bytes.
|
|
1142
|
+
*
|
|
1143
|
+
* Wire method `catalog_table_update_function_get` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1144
|
+
*/
|
|
1145
|
+
catalogTableUpdateFunctionGet(params: CatalogTableUpdateFunctionGetParams, ctx: CallContext): VgiReply<{
|
|
1146
|
+
result: Uint8Array;
|
|
1147
|
+
}>;
|
|
1148
|
+
/**
|
|
1149
|
+
* Begin a new transaction.
|
|
1150
|
+
*
|
|
1151
|
+
* Wire method `catalog_transaction_begin` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1152
|
+
*/
|
|
1153
|
+
catalogTransactionBegin(params: CatalogTransactionBeginParams, ctx: CallContext): VgiReply<{
|
|
1154
|
+
result: Uint8Array;
|
|
1155
|
+
}>;
|
|
1156
|
+
/**
|
|
1157
|
+
* Commit a transaction.
|
|
1158
|
+
*
|
|
1159
|
+
* Wire method `catalog_transaction_commit` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1160
|
+
*/
|
|
1161
|
+
catalogTransactionCommit(params: CatalogTransactionCommitParams, ctx: CallContext): VgiReply<NoResult>;
|
|
1162
|
+
/**
|
|
1163
|
+
* Rollback a transaction.
|
|
1164
|
+
*
|
|
1165
|
+
* Wire method `catalog_transaction_rollback` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1166
|
+
*/
|
|
1167
|
+
catalogTransactionRollback(params: CatalogTransactionRollbackParams, ctx: CallContext): VgiReply<NoResult>;
|
|
1168
|
+
/**
|
|
1169
|
+
* Get the current catalog version.
|
|
1170
|
+
*
|
|
1171
|
+
* Wire method `catalog_version` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1172
|
+
*/
|
|
1173
|
+
catalogVersion(params: CatalogVersionParams, ctx: CallContext): VgiReply<{
|
|
1174
|
+
result: Uint8Array;
|
|
1175
|
+
}>;
|
|
1176
|
+
/**
|
|
1177
|
+
* Set or clear the comment on a view.
|
|
1178
|
+
*
|
|
1179
|
+
* Wire method `catalog_view_comment_set` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1180
|
+
*/
|
|
1181
|
+
catalogViewCommentSet(params: CatalogViewCommentSetParams, ctx: CallContext): VgiReply<NoResult>;
|
|
1182
|
+
/**
|
|
1183
|
+
* Create a new view.
|
|
1184
|
+
*
|
|
1185
|
+
* Wire method `catalog_view_create` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1186
|
+
*/
|
|
1187
|
+
catalogViewCreate(params: CatalogViewCreateParams, ctx: CallContext): VgiReply<NoResult>;
|
|
1188
|
+
/**
|
|
1189
|
+
* Drop a view.
|
|
1190
|
+
*
|
|
1191
|
+
* Wire method `catalog_view_drop` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1192
|
+
*/
|
|
1193
|
+
catalogViewDrop(params: CatalogViewDropParams, ctx: CallContext): VgiReply<NoResult>;
|
|
1194
|
+
/**
|
|
1195
|
+
* Get information about a view. Returns 0 or 1 items.
|
|
1196
|
+
*
|
|
1197
|
+
* Wire method `catalog_view_get` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1198
|
+
*/
|
|
1199
|
+
catalogViewGet(params: CatalogViewGetParams, ctx: CallContext): VgiReply<{
|
|
1200
|
+
result: Uint8Array;
|
|
1201
|
+
}>;
|
|
1202
|
+
/**
|
|
1203
|
+
* Rename a view.
|
|
1204
|
+
*
|
|
1205
|
+
* Wire method `catalog_view_rename` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1206
|
+
*/
|
|
1207
|
+
catalogViewRename(params: CatalogViewRenameParams, ctx: CallContext): VgiReply<NoResult>;
|
|
1208
|
+
/**
|
|
1209
|
+
* Initialize a function execution and return a processing stream.
|
|
1210
|
+
*
|
|
1211
|
+
* Wire method `init` (stream, headed by a `GlobalInitResponse`). Default: answers `UNIMPLEMENTED`.
|
|
1212
|
+
*/
|
|
1213
|
+
readonly init: VgiStream;
|
|
1214
|
+
/**
|
|
1215
|
+
* Once-per-query end-of-input signal. Returns finalize_state_ids.
|
|
1216
|
+
*
|
|
1217
|
+
* Wire method `table_buffering_combine` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1218
|
+
*/
|
|
1219
|
+
tableBufferingCombine(params: TableBufferingCombineParams, ctx: CallContext): VgiReply<{
|
|
1220
|
+
result: Uint8Array;
|
|
1221
|
+
}>;
|
|
1222
|
+
/**
|
|
1223
|
+
* Best-effort end-of-query cleanup. Must not raise.
|
|
1224
|
+
*
|
|
1225
|
+
* Wire method `table_buffering_destructor` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1226
|
+
*/
|
|
1227
|
+
tableBufferingDestructor(params: TableBufferingDestructorParams, ctx: CallContext): VgiReply<{
|
|
1228
|
+
result: Uint8Array;
|
|
1229
|
+
}>;
|
|
1230
|
+
/**
|
|
1231
|
+
* Sink one input batch; return the worker-chosen state_id.
|
|
1232
|
+
*
|
|
1233
|
+
* Wire method `table_buffering_process` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1234
|
+
*/
|
|
1235
|
+
tableBufferingProcess(params: TableBufferingProcessParams, ctx: CallContext): VgiReply<{
|
|
1236
|
+
result: Uint8Array;
|
|
1237
|
+
}>;
|
|
1238
|
+
/**
|
|
1239
|
+
* Estimate the cardinality of a table function's output.
|
|
1240
|
+
*
|
|
1241
|
+
* Wire method `table_function_cardinality` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1242
|
+
*/
|
|
1243
|
+
tableFunctionCardinality(params: TableFunctionCardinalityParams, ctx: CallContext): VgiReply<{
|
|
1244
|
+
result: Uint8Array;
|
|
1245
|
+
}>;
|
|
1246
|
+
/**
|
|
1247
|
+
* Return user-defined diagnostics for EXPLAIN ANALYZE Extra Info.
|
|
1248
|
+
*
|
|
1249
|
+
* Fired once per parallel scan thread at end-of-stream. The function class is responsible for persisting any diagnostics it wants to report and retrieving them by ``global_execution_id`` here.
|
|
1250
|
+
*
|
|
1251
|
+
* Best-effort: must not raise. The dispatcher catches exceptions and returns an empty response so EXPLAIN ANALYZE never breaks the query.
|
|
1252
|
+
*
|
|
1253
|
+
* Wire method `table_function_dynamic_to_string` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1254
|
+
*/
|
|
1255
|
+
tableFunctionDynamicToString(params: TableFunctionDynamicToStringParams, ctx: CallContext): VgiReply<{
|
|
1256
|
+
result: Uint8Array;
|
|
1257
|
+
}>;
|
|
1258
|
+
/**
|
|
1259
|
+
* Plan a table-function scan into named, independently redeemable splits.
|
|
1260
|
+
*
|
|
1261
|
+
* Runs once with the pushdown filters; each returned split is then redeemed by ``init()`` from any process or host. Workers that do not opt in via ``supports_splits`` inherit a framework default.
|
|
1262
|
+
*
|
|
1263
|
+
* Wire method `table_function_plan` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1264
|
+
*/
|
|
1265
|
+
tableFunctionPlan(params: TableFunctionPlanParams, ctx: CallContext): VgiReply<{
|
|
1266
|
+
result: Uint8Array;
|
|
1267
|
+
}>;
|
|
1268
|
+
/**
|
|
1269
|
+
* Return per-column statistics for a table function's output.
|
|
1270
|
+
*
|
|
1271
|
+
* Returns IPC bytes of a `RecordBatch` with sparse-union min/max columns (same shape as `catalog_table_column_statistics_get`), or None if no statistics are available.
|
|
1272
|
+
*
|
|
1273
|
+
* Wire method `table_function_statistics` (unary). Default: answers `UNIMPLEMENTED`.
|
|
1274
|
+
*/
|
|
1275
|
+
tableFunctionStatistics(params: TableFunctionStatisticsParams, ctx: CallContext): VgiReply<{
|
|
1276
|
+
result: Uint8Array | null;
|
|
1277
|
+
}>;
|
|
1278
|
+
}
|
|
1279
|
+
/** One `vgi.v2` method: its wire name, its `VgiService` member, and its schemas. */
|
|
1280
|
+
export type VgiMethodSpec = {
|
|
1281
|
+
readonly name: string;
|
|
1282
|
+
readonly key: keyof VgiService;
|
|
1283
|
+
readonly type: "unary";
|
|
1284
|
+
readonly params: VgiSchema;
|
|
1285
|
+
/** The `result` column, or no fields for a method that returns nothing. */
|
|
1286
|
+
readonly result: VgiSchema;
|
|
1287
|
+
readonly doc: string;
|
|
1288
|
+
} | {
|
|
1289
|
+
readonly name: string;
|
|
1290
|
+
readonly key: keyof VgiService;
|
|
1291
|
+
readonly type: "stream";
|
|
1292
|
+
readonly params: VgiSchema;
|
|
1293
|
+
readonly header: VgiSchema | null;
|
|
1294
|
+
readonly doc: string;
|
|
1295
|
+
};
|
|
1296
|
+
/**
|
|
1297
|
+
* Every `vgi.v2` method, sorted by wire name, with the reference's
|
|
1298
|
+
* params / result / header schemas. This table is what
|
|
1299
|
+
* {@link registerVgiService} registers, so it is what reflection hashes.
|
|
1300
|
+
*/
|
|
1301
|
+
export declare const VGI_V2_METHODS: readonly VgiMethodSpec[];
|
|
1302
|
+
/**
|
|
1303
|
+
* A `VgiService` in which every method answers `UNIMPLEMENTED` /
|
|
1304
|
+
* `method_not_implemented` with `"<method> is not implemented by this worker"`.
|
|
1305
|
+
*/
|
|
1306
|
+
export declare const UNIMPLEMENTED_VGI_SERVICE: VgiService;
|
|
1307
|
+
/** The message every unimplemented method answers with. */
|
|
1308
|
+
export declare function unimplementedMessage(method: string): string;
|
|
1309
|
+
/**
|
|
1310
|
+
* Register every `vgi.v2` method on *protocol*, with the reference's schemas
|
|
1311
|
+
* from {@link VGI_V2_METHODS} and the handlers from *service*.
|
|
1312
|
+
*/
|
|
1313
|
+
export declare function registerVgiService(protocol: Protocol, service: VgiService): Protocol;
|
|
1314
|
+
/** A `Protocol` named {@link VGI_PROTOCOL_NAME} at {@link VGI_PROTOCOL_VERSION}, serving *service*. */
|
|
1315
|
+
export declare function createVgiProtocol(service: VgiService): Protocol;
|