@xata.io/client 0.0.0-alpha.vf501d195ec7907e696637eff52ae02941341dca1 → 0.0.0-alpha.vf51f3b091fcf725931ff8f287de9707ee0e7d752
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/.turbo/turbo-add-version.log +1 -1
- package/.turbo/turbo-build.log +3 -3
- package/CHANGELOG.md +55 -3
- package/dist/index.cjs +3816 -3009
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +2212 -1005
- package/dist/index.mjs +3792 -3007
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
@@ -28,6 +28,8 @@ declare abstract class XataPlugin {
|
|
28
28
|
type XataPluginOptions = ApiExtraProps & {
|
29
29
|
cache: CacheImpl;
|
30
30
|
host: HostProvider;
|
31
|
+
tables: Table[];
|
32
|
+
branch: string;
|
31
33
|
};
|
32
34
|
|
33
35
|
type AttributeDictionary = Record<string, string | number | boolean | undefined>;
|
@@ -55,11 +57,154 @@ type Response = {
|
|
55
57
|
};
|
56
58
|
type FetchImpl = (url: string, init?: RequestInit) => Promise<Response>;
|
57
59
|
|
60
|
+
type StringKeys<O> = Extract<keyof O, string>;
|
61
|
+
type Values<O> = O[StringKeys<O>];
|
62
|
+
type UnionToIntersection<T> = (T extends any ? (x: T) => any : never) extends (x: infer R) => any ? R : never;
|
63
|
+
type If<Condition, Then, Else> = Condition extends true ? Then : Else;
|
64
|
+
type IsObject<T> = T extends Record<string, any> ? true : false;
|
65
|
+
type IsArray<T> = T extends Array<any> ? true : false;
|
66
|
+
type RequiredBy<T, K extends keyof T> = T & {
|
67
|
+
[P in K]-?: NonNullable<T[P]>;
|
68
|
+
};
|
69
|
+
type GetArrayInnerType<T extends readonly any[]> = T[number];
|
70
|
+
type SingleOrArray<T> = T | T[];
|
71
|
+
type Dictionary<T> = Record<string, T>;
|
72
|
+
type OmitBy<T, K extends keyof T> = T extends any ? Omit<T, K> : never;
|
73
|
+
type Without<T, U> = {
|
74
|
+
[P in Exclude<keyof T, keyof U>]?: never;
|
75
|
+
};
|
76
|
+
type ExclusiveOr<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
|
77
|
+
type Explode<T> = keyof T extends infer K ? K extends unknown ? {
|
78
|
+
[I in keyof T]: I extends K ? T[I] : never;
|
79
|
+
} : never : never;
|
80
|
+
type AtMostOne<T> = Explode<Partial<T>>;
|
81
|
+
type AtLeastOne<T, U = {
|
82
|
+
[K in keyof T]: Pick<T, K>;
|
83
|
+
}> = Partial<T> & U[keyof U];
|
84
|
+
type ExactlyOne<T> = AtMostOne<T> & AtLeastOne<T>;
|
85
|
+
type Fn = (...args: any[]) => any;
|
86
|
+
type NarrowRaw<A> = (A extends [] ? [] : never) | (A extends Narrowable ? A : never) | {
|
87
|
+
[K in keyof A]: A[K] extends Fn ? A[K] : NarrowRaw<A[K]>;
|
88
|
+
};
|
89
|
+
type Narrowable = string | number | bigint | boolean;
|
90
|
+
type Try<A1, A2, Catch = never> = A1 extends A2 ? A1 : Catch;
|
91
|
+
type Narrow<A> = Try<A, [], NarrowRaw<A>>;
|
92
|
+
type RequiredKeys<T> = {
|
93
|
+
[K in keyof T]-?: {} extends Pick<T, K> ? never : K;
|
94
|
+
}[keyof T];
|
95
|
+
|
58
96
|
/**
|
59
97
|
* Generated by @openapi-codegen
|
60
98
|
*
|
61
99
|
* @version 1.0
|
62
100
|
*/
|
101
|
+
/**
|
102
|
+
* @x-internal true
|
103
|
+
* @pattern [a-zA-Z0-9_-~:]+
|
104
|
+
*/
|
105
|
+
type ClusterID$1 = string;
|
106
|
+
/**
|
107
|
+
* Page size.
|
108
|
+
*
|
109
|
+
* @x-internal true
|
110
|
+
* @default 25
|
111
|
+
* @minimum 0
|
112
|
+
*/
|
113
|
+
type PageSize$1 = number;
|
114
|
+
/**
|
115
|
+
* Page token
|
116
|
+
*
|
117
|
+
* @x-internal true
|
118
|
+
* @maxLength 255
|
119
|
+
* @minLength 24
|
120
|
+
*/
|
121
|
+
type PageToken$1 = string;
|
122
|
+
/**
|
123
|
+
* @format date-time
|
124
|
+
* @x-go-type string
|
125
|
+
*/
|
126
|
+
type DateTime$1 = string;
|
127
|
+
/**
|
128
|
+
* @x-internal true
|
129
|
+
*/
|
130
|
+
type BranchDetails = {
|
131
|
+
name: string;
|
132
|
+
id: string;
|
133
|
+
/**
|
134
|
+
* The cluster where this branch resides.
|
135
|
+
*
|
136
|
+
* @minLength 1
|
137
|
+
*/
|
138
|
+
clusterID: string;
|
139
|
+
state: string;
|
140
|
+
createdAt: DateTime$1;
|
141
|
+
databaseName: string;
|
142
|
+
databaseID: string;
|
143
|
+
};
|
144
|
+
/**
|
145
|
+
* @x-internal true
|
146
|
+
*/
|
147
|
+
type PageResponse$1 = {
|
148
|
+
size: number;
|
149
|
+
hasMore: boolean;
|
150
|
+
token?: string;
|
151
|
+
};
|
152
|
+
/**
|
153
|
+
* @x-internal true
|
154
|
+
*/
|
155
|
+
type ListClusterBranchesResponse = {
|
156
|
+
branches: BranchDetails[];
|
157
|
+
page?: PageResponse$1;
|
158
|
+
};
|
159
|
+
/**
|
160
|
+
* @x-internal true
|
161
|
+
*/
|
162
|
+
type ExtensionDetails = {
|
163
|
+
name: string;
|
164
|
+
description: string;
|
165
|
+
status: 'installed' | 'not_installed';
|
166
|
+
version: string;
|
167
|
+
};
|
168
|
+
/**
|
169
|
+
* @x-internal true
|
170
|
+
*/
|
171
|
+
type ListClusterExtensionsResponse = {
|
172
|
+
extensions: ExtensionDetails[];
|
173
|
+
};
|
174
|
+
/**
|
175
|
+
* @x-internal true
|
176
|
+
*/
|
177
|
+
type ClusterExtensionInstallationResponse = {
|
178
|
+
extension: string;
|
179
|
+
status: 'success' | 'failure';
|
180
|
+
reason?: string;
|
181
|
+
};
|
182
|
+
/**
|
183
|
+
* @x-internal true
|
184
|
+
*/
|
185
|
+
type MetricMessage = {
|
186
|
+
code?: string;
|
187
|
+
value?: string;
|
188
|
+
};
|
189
|
+
/**
|
190
|
+
* @x-internal true
|
191
|
+
*/
|
192
|
+
type MetricData = {
|
193
|
+
id?: string;
|
194
|
+
label?: string;
|
195
|
+
messages?: MetricMessage[] | null;
|
196
|
+
status: 'complete' | 'error' | 'partial' | 'forbidden';
|
197
|
+
timestamps: string[];
|
198
|
+
values: number[];
|
199
|
+
};
|
200
|
+
/**
|
201
|
+
* @x-internal true
|
202
|
+
*/
|
203
|
+
type MetricsResponse = {
|
204
|
+
metrics: MetricData[];
|
205
|
+
messages: MetricMessage[];
|
206
|
+
page?: PageResponse$1;
|
207
|
+
};
|
63
208
|
/**
|
64
209
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
65
210
|
*
|
@@ -68,15 +213,156 @@ type FetchImpl = (url: string, init?: RequestInit) => Promise<Response>;
|
|
68
213
|
* @pattern [a-zA-Z0-9_\-~]+:[a-zA-Z0-9_\-~]+
|
69
214
|
*/
|
70
215
|
type DBBranchName = string;
|
71
|
-
type
|
216
|
+
type ApplyMigrationResponse = {
|
217
|
+
/**
|
218
|
+
* The id of the migration job
|
219
|
+
*/
|
220
|
+
jobID: string;
|
221
|
+
};
|
222
|
+
type StartMigrationResponse = {
|
223
|
+
/**
|
224
|
+
* The id of the migration job
|
225
|
+
*/
|
226
|
+
jobID: string;
|
227
|
+
};
|
228
|
+
type CompleteMigrationResponse = {
|
229
|
+
/**
|
230
|
+
* The id of the migration job
|
231
|
+
*/
|
232
|
+
jobID: string;
|
233
|
+
};
|
234
|
+
type RollbackMigrationResponse = {
|
235
|
+
/**
|
236
|
+
* The id of the migration job
|
237
|
+
*/
|
238
|
+
jobID: string;
|
239
|
+
};
|
240
|
+
/**
|
241
|
+
* @maxLength 255
|
242
|
+
* @minLength 1
|
243
|
+
* @pattern [a-zA-Z0-9_\-~]+
|
244
|
+
*/
|
245
|
+
type TableName = string;
|
246
|
+
type MigrationJobType = 'apply' | 'start' | 'complete' | 'rollback';
|
247
|
+
type MigrationJobStatus = 'pending' | 'in_progress' | 'completed' | 'failed';
|
248
|
+
/**
|
249
|
+
* The effect of a migration operation in terms of CRUD operations on the underlying schema
|
250
|
+
*/
|
251
|
+
type MigrationOperationDescription = {
|
252
|
+
/**
|
253
|
+
* A new database object created by the operation
|
254
|
+
*/
|
255
|
+
create?: {
|
256
|
+
/**
|
257
|
+
* The type of object created
|
258
|
+
*/
|
259
|
+
type: 'table' | 'column' | 'index';
|
260
|
+
/**
|
261
|
+
* The name of the object created
|
262
|
+
*/
|
263
|
+
name: string;
|
264
|
+
/**
|
265
|
+
* The name of the table on which the object is created, if applicable
|
266
|
+
*/
|
267
|
+
table?: string;
|
268
|
+
/**
|
269
|
+
* The mapping between the virtual and physical name of the new object, if applicable
|
270
|
+
*/
|
271
|
+
mapping?: Record<string, any>;
|
272
|
+
};
|
273
|
+
/**
|
274
|
+
* A database object updated by the operation
|
275
|
+
*/
|
276
|
+
update?: {
|
277
|
+
/**
|
278
|
+
* The type of updated object
|
279
|
+
*/
|
280
|
+
type: 'table' | 'column';
|
281
|
+
/**
|
282
|
+
* The name of the updated object
|
283
|
+
*/
|
284
|
+
name: string;
|
285
|
+
/**
|
286
|
+
* The name of the table on which the object is updated, if applicable
|
287
|
+
*/
|
288
|
+
table?: string;
|
289
|
+
/**
|
290
|
+
* The mapping between the virtual and physical name of the updated object, if applicable
|
291
|
+
*/
|
292
|
+
mapping?: Record<string, any>;
|
293
|
+
};
|
294
|
+
/**
|
295
|
+
* A database object renamed by the operation
|
296
|
+
*/
|
297
|
+
rename?: {
|
298
|
+
/**
|
299
|
+
* The type of the renamed object
|
300
|
+
*/
|
301
|
+
type: 'table' | 'column' | 'constraint';
|
302
|
+
/**
|
303
|
+
* The name of the table on which the object is renamed, if applicable
|
304
|
+
*/
|
305
|
+
table?: string;
|
306
|
+
/**
|
307
|
+
* The old name of the renamed object
|
308
|
+
*/
|
309
|
+
from: string;
|
310
|
+
/**
|
311
|
+
* The new name of the renamed object
|
312
|
+
*/
|
313
|
+
to: string;
|
314
|
+
};
|
315
|
+
/**
|
316
|
+
* A database object deleted by the operation
|
317
|
+
*/
|
318
|
+
['delete']?: {
|
319
|
+
/**
|
320
|
+
* The type of the deleted object
|
321
|
+
*/
|
322
|
+
type: 'table' | 'column' | 'constraint' | 'index';
|
323
|
+
/**
|
324
|
+
* The name of the deleted object
|
325
|
+
*/
|
326
|
+
name: string;
|
327
|
+
/**
|
328
|
+
* The name of the table on which the object is deleted, if applicable
|
329
|
+
*/
|
330
|
+
table: string;
|
331
|
+
};
|
332
|
+
};
|
333
|
+
/**
|
334
|
+
* @minItems 1
|
335
|
+
*/
|
336
|
+
type MigrationDescription = MigrationOperationDescription[];
|
337
|
+
type MigrationJobStatusResponse = {
|
72
338
|
/**
|
73
339
|
* The id of the migration job
|
74
340
|
*/
|
75
341
|
jobID: string;
|
342
|
+
/**
|
343
|
+
* The type of the migration job
|
344
|
+
*/
|
345
|
+
type: MigrationJobType;
|
346
|
+
/**
|
347
|
+
* The status of the migration job
|
348
|
+
*/
|
349
|
+
status: MigrationJobStatus;
|
350
|
+
/**
|
351
|
+
* The effect of any active migration on the schema
|
352
|
+
*/
|
353
|
+
description?: MigrationDescription;
|
354
|
+
/**
|
355
|
+
* The timestamp at which the migration job completed or failed
|
356
|
+
*
|
357
|
+
* @format date-time
|
358
|
+
*/
|
359
|
+
completedAt?: string;
|
360
|
+
/**
|
361
|
+
* The error message associated with the migration job
|
362
|
+
*/
|
363
|
+
error?: string;
|
76
364
|
};
|
77
|
-
type
|
78
|
-
type PgRollJobStatus = 'pending' | 'in_progress' | 'completed' | 'failed';
|
79
|
-
type PgRollJobStatusResponse = {
|
365
|
+
type MigrationJobItem = {
|
80
366
|
/**
|
81
367
|
* The id of the migration job
|
82
368
|
*/
|
@@ -84,28 +370,62 @@ type PgRollJobStatusResponse = {
|
|
84
370
|
/**
|
85
371
|
* The type of the migration job
|
86
372
|
*/
|
87
|
-
type:
|
373
|
+
type: MigrationJobType;
|
88
374
|
/**
|
89
375
|
* The status of the migration job
|
90
376
|
*/
|
91
|
-
status:
|
377
|
+
status: MigrationJobStatus;
|
378
|
+
/**
|
379
|
+
* The pgroll migration that was applied
|
380
|
+
*/
|
381
|
+
migration?: string;
|
382
|
+
/**
|
383
|
+
* The effect of any active migration on the schema
|
384
|
+
*/
|
385
|
+
description?: MigrationDescription;
|
386
|
+
/**
|
387
|
+
* The timestamp at which the migration job was enqueued
|
388
|
+
*
|
389
|
+
* @format date-time
|
390
|
+
*/
|
391
|
+
enqueuedAt: string;
|
392
|
+
/**
|
393
|
+
* The timestamp at which the migration job completed or failed
|
394
|
+
*
|
395
|
+
* @format date-time
|
396
|
+
*/
|
397
|
+
completedAt?: string;
|
92
398
|
/**
|
93
399
|
* The error message associated with the migration job
|
94
400
|
*/
|
95
401
|
error?: string;
|
96
402
|
};
|
403
|
+
type GetMigrationJobsResponse = {
|
404
|
+
/**
|
405
|
+
* The list of migration jobs
|
406
|
+
*/
|
407
|
+
jobs: MigrationJobItem[];
|
408
|
+
/**
|
409
|
+
* The cursor (timestamp) for the next page of results
|
410
|
+
*/
|
411
|
+
cursor?: string;
|
412
|
+
};
|
97
413
|
/**
|
98
414
|
* @maxLength 255
|
99
415
|
* @minLength 1
|
100
416
|
* @pattern [a-zA-Z0-9_\-~]+
|
101
417
|
*/
|
102
|
-
type
|
103
|
-
type
|
104
|
-
type
|
418
|
+
type MigrationJobID = string;
|
419
|
+
type MigrationType = 'pgroll' | 'inferred';
|
420
|
+
type MigrationHistoryItem = {
|
105
421
|
/**
|
106
422
|
* The name of the migration
|
107
423
|
*/
|
108
424
|
name: string;
|
425
|
+
/**
|
426
|
+
* The schema in which the migration was applied
|
427
|
+
*/
|
428
|
+
schema: string;
|
109
429
|
/**
|
110
430
|
* The pgroll migration that was applied
|
111
431
|
*/
|
@@ -127,13 +447,17 @@ type PgRollMigrationHistoryItem = {
|
|
127
447
|
/**
|
128
448
|
* The type of the migration
|
129
449
|
*/
|
130
|
-
migrationType:
|
450
|
+
migrationType: MigrationType;
|
131
451
|
};
|
132
|
-
type
|
452
|
+
type MigrationHistoryResponse = {
|
133
453
|
/**
|
134
454
|
* The migrations that have been applied to the branch
|
135
455
|
*/
|
136
|
-
migrations:
|
456
|
+
migrations: MigrationHistoryItem[];
|
457
|
+
/**
|
458
|
+
* The cursor (timestamp) for the next page of results
|
459
|
+
*/
|
460
|
+
cursor?: string;
|
137
461
|
};
|
138
462
|
/**
|
139
463
|
* @maxLength 255
|
@@ -142,25 +466,29 @@ type PgRollMigrationHistoryResponse = {
|
|
142
466
|
*/
|
143
467
|
type DBName$1 = string;
|
144
468
|
/**
|
145
|
-
*
|
146
|
-
* @x-go-type string
|
469
|
+
* Represent the state of the branch, used for branch lifecycle management
|
147
470
|
*/
|
148
|
-
type
|
471
|
+
type BranchState = 'active' | 'move_scheduled' | 'moving';
|
149
472
|
type Branch = {
|
150
473
|
name: string;
|
151
474
|
/**
|
152
475
|
* The cluster where this branch resides. Value of 'shared-cluster' for branches in shared clusters
|
153
476
|
*
|
154
477
|
* @minLength 1
|
155
|
-
* @x-internal true
|
156
478
|
*/
|
157
479
|
clusterID?: string;
|
480
|
+
state: BranchState;
|
158
481
|
createdAt: DateTime$1;
|
482
|
+
searchDisabled?: boolean;
|
483
|
+
inactiveSharedCluster?: boolean;
|
159
484
|
};
|
160
485
|
type ListBranchesResponse = {
|
161
486
|
databaseName: string;
|
162
487
|
branches: Branch[];
|
163
488
|
};
|
489
|
+
type DatabaseSettings = {
|
490
|
+
searchEnabled: boolean;
|
491
|
+
};
|
164
492
|
/**
|
165
493
|
* @maxLength 255
|
166
494
|
* @minLength 1
|
@@ -188,12 +516,6 @@ type StartedFromMetadata = {
|
|
188
516
|
dbBranchID: string;
|
189
517
|
migrationID: string;
|
190
518
|
};
|
191
|
-
/**
|
192
|
-
* @maxLength 255
|
193
|
-
* @minLength 1
|
194
|
-
* @pattern [a-zA-Z0-9_\-~]+
|
195
|
-
*/
|
196
|
-
type TableName = string;
|
197
519
|
type ColumnLink = {
|
198
520
|
table: string;
|
199
521
|
};
|
@@ -209,7 +531,7 @@ type ColumnFile = {
|
|
209
531
|
};
|
210
532
|
type Column = {
|
211
533
|
name: string;
|
212
|
-
type:
|
534
|
+
type: string;
|
213
535
|
link?: ColumnLink;
|
214
536
|
vector?: ColumnVector;
|
215
537
|
file?: ColumnFile;
|
@@ -248,12 +570,63 @@ type DBBranch = {
|
|
248
570
|
*/
|
249
571
|
clusterID?: string;
|
250
572
|
version: number;
|
573
|
+
state: BranchState;
|
251
574
|
lastMigrationID: string;
|
252
575
|
metadata?: BranchMetadata$1;
|
253
576
|
startedFrom?: StartedFromMetadata;
|
254
577
|
schema: Schema;
|
255
578
|
};
|
256
579
|
type MigrationStatus$1 = 'completed' | 'pending' | 'failed';
|
580
|
+
type BranchSchema = {
|
581
|
+
name: string;
|
582
|
+
tables: {
|
583
|
+
[key: string]: {
|
584
|
+
oid: string;
|
585
|
+
name: string;
|
586
|
+
xataCompatible: boolean;
|
587
|
+
comment: string;
|
588
|
+
columns: {
|
589
|
+
[key: string]: {
|
590
|
+
name: string;
|
591
|
+
type: string;
|
592
|
+
['default']: string | null;
|
593
|
+
nullable: boolean;
|
594
|
+
unique: boolean;
|
595
|
+
comment: string;
|
596
|
+
};
|
597
|
+
};
|
598
|
+
indexes: {
|
599
|
+
[key: string]: {
|
600
|
+
name: string;
|
601
|
+
unique: boolean;
|
602
|
+
columns: string[];
|
603
|
+
};
|
604
|
+
};
|
605
|
+
primaryKey: string[];
|
606
|
+
foreignKeys: {
|
607
|
+
[key: string]: {
|
608
|
+
name: string;
|
609
|
+
columns: string[];
|
610
|
+
referencedTable: string;
|
611
|
+
referencedColumns: string[];
|
612
|
+
};
|
613
|
+
};
|
614
|
+
checkConstraints: {
|
615
|
+
[key: string]: {
|
616
|
+
name: string;
|
617
|
+
columns: string[];
|
618
|
+
definition: string;
|
619
|
+
};
|
620
|
+
};
|
621
|
+
uniqueConstraints: {
|
622
|
+
[key: string]: {
|
623
|
+
name: string;
|
624
|
+
columns: string[];
|
625
|
+
};
|
626
|
+
};
|
627
|
+
};
|
628
|
+
};
|
629
|
+
};
|
257
630
|
type BranchWithCopyID = {
|
258
631
|
branchName: BranchName$1;
|
259
632
|
dbBranchID: string;
|
@@ -906,14 +1279,60 @@ type RecordMeta = {
|
|
906
1279
|
*/
|
907
1280
|
warnings?: string[];
|
908
1281
|
};
|
909
|
-
}
|
910
|
-
|
911
|
-
|
912
|
-
|
913
|
-
|
914
|
-
|
915
|
-
|
1282
|
+
} | {
|
1283
|
+
xata_id: RecordID;
|
1284
|
+
/**
|
1285
|
+
* The record's version. Can be used for optimistic concurrency control.
|
1286
|
+
*/
|
1287
|
+
xata_version: number;
|
1288
|
+
/**
|
1289
|
+
* The time when the record was created.
|
1290
|
+
*/
|
1291
|
+
xata_createdat?: string;
|
1292
|
+
/**
|
1293
|
+
* The time when the record was last updated.
|
1294
|
+
*/
|
1295
|
+
xata_updatedat?: string;
|
1296
|
+
/**
|
1297
|
+
* The record's table name. APIs that return records from multiple tables will set this field accordingly.
|
1298
|
+
*/
|
1299
|
+
xata_table?: string;
|
1300
|
+
/**
|
1301
|
+
* Highlights of the record. This is used by the search APIs to indicate which fields and parts of the fields have matched the search.
|
1302
|
+
*/
|
1303
|
+
xata_highlight?: {
|
1304
|
+
[key: string]: string[] | {
|
1305
|
+
[key: string]: any;
|
1306
|
+
};
|
1307
|
+
};
|
1308
|
+
/**
|
1309
|
+
* The record's relevancy score. This is returned by the search APIs.
|
1310
|
+
*/
|
1311
|
+
xata_score?: number;
|
1312
|
+
/**
|
1313
|
+
* Encoding/Decoding errors
|
1314
|
+
*/
|
1315
|
+
xata_warnings?: string[];
|
1316
|
+
};
|
1317
|
+
/**
|
1318
|
+
* File metadata
|
1319
|
+
*/
|
1320
|
+
type FileResponse = {
|
1321
|
+
id?: FileItemID;
|
1322
|
+
name: FileName;
|
916
1323
|
mediaType: MediaType;
|
1324
|
+
/**
|
1325
|
+
* Enable public access to the file
|
1326
|
+
*/
|
1327
|
+
enablePublicUrl: boolean;
|
1328
|
+
/**
|
1329
|
+
* Time to live for signed URLs
|
1330
|
+
*/
|
1331
|
+
signedUrlTimeout: number;
|
1332
|
+
/**
|
1333
|
+
* Time to live for signed URLs
|
1334
|
+
*/
|
1335
|
+
uploadUrlTimeout: number;
|
917
1336
|
/**
|
918
1337
|
* @format int64
|
919
1338
|
*/
|
@@ -922,6 +1341,24 @@ type FileResponse = {
|
|
922
1341
|
* @format int64
|
923
1342
|
*/
|
924
1343
|
version: number;
|
1344
|
+
/**
|
1345
|
+
* File access URL
|
1346
|
+
*
|
1347
|
+
* @format uri
|
1348
|
+
*/
|
1349
|
+
url: string;
|
1350
|
+
/**
|
1351
|
+
* Signed file access URL
|
1352
|
+
*
|
1353
|
+
* @format uri
|
1354
|
+
*/
|
1355
|
+
signedUrl: string;
|
1356
|
+
/**
|
1357
|
+
* Upload file URL
|
1358
|
+
*
|
1359
|
+
* @format uri
|
1360
|
+
*/
|
1361
|
+
uploadUrl: string;
|
925
1362
|
attributes?: Record<string, any>;
|
926
1363
|
};
|
927
1364
|
type QueryColumnsProjection = (string | ProjectionConfig)[];
|
@@ -1369,6 +1806,57 @@ type FileSignature = string;
|
|
1369
1806
|
type SQLRecord = {
|
1370
1807
|
[key: string]: any;
|
1371
1808
|
};
|
1809
|
+
/**
|
1810
|
+
* @default strong
|
1811
|
+
*/
|
1812
|
+
type SQLConsistency = 'strong' | 'eventual';
|
1813
|
+
/**
|
1814
|
+
* @default json
|
1815
|
+
*/
|
1816
|
+
type SQLResponseType$1 = 'json' | 'array';
|
1817
|
+
type PreparedStatement = {
|
1818
|
+
/**
|
1819
|
+
* The SQL statement.
|
1820
|
+
*
|
1821
|
+
* @minLength 1
|
1822
|
+
*/
|
1823
|
+
statement: string;
|
1824
|
+
/**
|
1825
|
+
* The query parameter list.
|
1826
|
+
*
|
1827
|
+
* @x-go-type []any
|
1828
|
+
*/
|
1829
|
+
params?: any[] | null;
|
1830
|
+
};
|
1831
|
+
type SQLResponseBase = {
|
1832
|
+
/**
|
1833
|
+
* Name of the column and its PostgreSQL type
|
1834
|
+
*
|
1835
|
+
* @x-go-type []sqlproxy.ColumnMeta
|
1836
|
+
*/
|
1837
|
+
columns: {
|
1838
|
+
name: string;
|
1839
|
+
type: string;
|
1840
|
+
}[];
|
1841
|
+
/**
|
1842
|
+
* Number of selected columns
|
1843
|
+
*/
|
1844
|
+
total: number;
|
1845
|
+
warning?: string;
|
1846
|
+
};
|
1847
|
+
type SQLResponseJSON = SQLResponseBase & {
|
1848
|
+
/**
|
1849
|
+
* @x-go-type []xata.Record
|
1850
|
+
*/
|
1851
|
+
records: SQLRecord[];
|
1852
|
+
};
|
1853
|
+
type SQLResponseArray = SQLResponseBase & {
|
1854
|
+
/**
|
1855
|
+
* @x-go-type []xata.Row
|
1856
|
+
*/
|
1857
|
+
rows: any[][];
|
1858
|
+
};
|
1859
|
+
type SQLResponse$1 = SQLResponseJSON | SQLResponseArray;
|
1372
1860
|
/**
|
1373
1861
|
* Xata Table Record Metadata
|
1374
1862
|
*/
|
@@ -1425,6 +1913,11 @@ type RecordUpdateResponse = XataRecord$1 | {
|
|
1425
1913
|
createdAt: string;
|
1426
1914
|
updatedAt: string;
|
1427
1915
|
};
|
1916
|
+
} | {
|
1917
|
+
xata_id: string;
|
1918
|
+
xata_version: number;
|
1919
|
+
xata_createdat: string;
|
1920
|
+
xata_updatedat: string;
|
1428
1921
|
};
|
1429
1922
|
type PutFileResponse = FileResponse;
|
1430
1923
|
type RecordResponse = XataRecord$1;
|
@@ -1466,17 +1959,9 @@ type AggResponse = {
|
|
1466
1959
|
[key: string]: AggResponse$1;
|
1467
1960
|
};
|
1468
1961
|
};
|
1469
|
-
type SQLResponse =
|
1470
|
-
|
1471
|
-
|
1472
|
-
* Name of the column and its PostgreSQL type
|
1473
|
-
*/
|
1474
|
-
columns?: Record<string, any>;
|
1475
|
-
/**
|
1476
|
-
* Number of selected columns
|
1477
|
-
*/
|
1478
|
-
total?: number;
|
1479
|
-
warning?: string;
|
1962
|
+
type SQLResponse = SQLResponse$1;
|
1963
|
+
type SQLBatchResponse = {
|
1964
|
+
results: SQLResponse$1[];
|
1480
1965
|
};
|
1481
1966
|
|
1482
1967
|
/**
|
@@ -1572,6 +2057,9 @@ type Workspace = WorkspaceMeta & {
|
|
1572
2057
|
memberCount: number;
|
1573
2058
|
plan: WorkspacePlan;
|
1574
2059
|
};
|
2060
|
+
type WorkspaceSettings = {
|
2061
|
+
dedicatedClusters: boolean;
|
2062
|
+
};
|
1575
2063
|
type WorkspaceMember = {
|
1576
2064
|
userId: UserID;
|
1577
2065
|
fullname: string;
|
@@ -1638,6 +2126,8 @@ type ClusterShortMetadata = {
|
|
1638
2126
|
* @format int64
|
1639
2127
|
*/
|
1640
2128
|
branches: number;
|
2129
|
+
createdAt: DateTime;
|
2130
|
+
terminatedAt?: DateTime;
|
1641
2131
|
};
|
1642
2132
|
/**
|
1643
2133
|
* @x-internal true
|
@@ -1735,6 +2225,13 @@ type ClusterConfiguration = {
|
|
1735
2225
|
* @format int64
|
1736
2226
|
*/
|
1737
2227
|
replicas?: number;
|
2228
|
+
/**
|
2229
|
+
* @format int64
|
2230
|
+
* @default 1
|
2231
|
+
* @maximum 3
|
2232
|
+
* @minimum 1
|
2233
|
+
*/
|
2234
|
+
instanceCount?: number;
|
1738
2235
|
/**
|
1739
2236
|
* @default false
|
1740
2237
|
*/
|
@@ -1753,7 +2250,7 @@ type ClusterCreateDetails = {
|
|
1753
2250
|
/**
|
1754
2251
|
* @maxLength 63
|
1755
2252
|
* @minLength 1
|
1756
|
-
* @pattern [a-
|
2253
|
+
* @pattern [a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*
|
1757
2254
|
*/
|
1758
2255
|
name: string;
|
1759
2256
|
configuration: ClusterConfiguration;
|
@@ -1765,6 +2262,57 @@ type ClusterResponse = {
|
|
1765
2262
|
state: string;
|
1766
2263
|
clusterID: string;
|
1767
2264
|
};
|
2265
|
+
/**
|
2266
|
+
* @x-internal true
|
2267
|
+
*/
|
2268
|
+
type AutoscalingConfigResponse = {
|
2269
|
+
/**
|
2270
|
+
* @format double
|
2271
|
+
* @default 0.5
|
2272
|
+
*/
|
2273
|
+
minCapacity: number;
|
2274
|
+
/**
|
2275
|
+
* @format double
|
2276
|
+
* @default 4
|
2277
|
+
*/
|
2278
|
+
maxCapacity: number;
|
2279
|
+
};
|
2280
|
+
/**
|
2281
|
+
* @x-internal true
|
2282
|
+
*/
|
2283
|
+
type MaintenanceConfigResponse = {
|
2284
|
+
/**
|
2285
|
+
* @default false
|
2286
|
+
*/
|
2287
|
+
autoMinorVersionUpgrade: boolean;
|
2288
|
+
/**
|
2289
|
+
* @default false
|
2290
|
+
*/
|
2291
|
+
applyImmediately: boolean;
|
2292
|
+
maintenanceWindow: WeeklyTimeWindow;
|
2293
|
+
backupWindow: DailyTimeWindow;
|
2294
|
+
};
|
2295
|
+
/**
|
2296
|
+
* @x-internal true
|
2297
|
+
*/
|
2298
|
+
type ClusterConfigurationResponse = {
|
2299
|
+
engineVersion: string;
|
2300
|
+
instanceType: string;
|
2301
|
+
/**
|
2302
|
+
* @format int64
|
2303
|
+
*/
|
2304
|
+
replicas: number;
|
2305
|
+
/**
|
2306
|
+
* @format int64
|
2307
|
+
*/
|
2308
|
+
instanceCount: number;
|
2309
|
+
/**
|
2310
|
+
* @default false
|
2311
|
+
*/
|
2312
|
+
deletionProtection: boolean;
|
2313
|
+
autoscaling?: AutoscalingConfigResponse;
|
2314
|
+
maintenance: MaintenanceConfigResponse;
|
2315
|
+
};
|
1768
2316
|
/**
|
1769
2317
|
* @x-internal true
|
1770
2318
|
*/
|
@@ -1777,22 +2325,36 @@ type ClusterMetadata = {
|
|
1777
2325
|
* @format int64
|
1778
2326
|
*/
|
1779
2327
|
branches: number;
|
1780
|
-
configuration
|
2328
|
+
configuration: ClusterConfigurationResponse;
|
1781
2329
|
};
|
1782
2330
|
/**
|
1783
2331
|
* @x-internal true
|
1784
2332
|
*/
|
1785
|
-
type
|
2333
|
+
type ClusterDeleteMetadata = {
|
1786
2334
|
id: ClusterID;
|
2335
|
+
state: string;
|
2336
|
+
region: string;
|
2337
|
+
name: string;
|
1787
2338
|
/**
|
1788
|
-
* @
|
1789
|
-
* @minLength 1
|
1790
|
-
* @pattern [a-zA-Z0-9_-~:]+
|
2339
|
+
* @format int64
|
1791
2340
|
*/
|
1792
|
-
|
1793
|
-
|
1794
|
-
|
1795
|
-
|
2341
|
+
branches: number;
|
2342
|
+
};
|
2343
|
+
/**
|
2344
|
+
* @x-internal true
|
2345
|
+
*/
|
2346
|
+
type ClusterUpdateDetails = {
|
2347
|
+
/**
|
2348
|
+
* @pattern ^[Ss][Tt][Oo][Pp]|[Ss][Tt][Aa][Rr][Tt]$
|
2349
|
+
*/
|
2350
|
+
command: string;
|
2351
|
+
};
|
2352
|
+
/**
|
2353
|
+
* @x-internal true
|
2354
|
+
*/
|
2355
|
+
type ClusterUpdateMetadata = {
|
2356
|
+
id: ClusterID;
|
2357
|
+
state: string;
|
1796
2358
|
};
|
1797
2359
|
/**
|
1798
2360
|
* Metadata of databases
|
@@ -1815,9 +2377,13 @@ type DatabaseMetadata = {
|
|
1815
2377
|
*/
|
1816
2378
|
newMigrations?: boolean;
|
1817
2379
|
/**
|
1818
|
-
*
|
2380
|
+
* The default cluster ID where branches from this database reside. Value of 'shared-cluster' for branches in shared clusters.
|
1819
2381
|
*/
|
1820
2382
|
defaultClusterID?: string;
|
2383
|
+
/**
|
2384
|
+
* The database is accessible via the Postgres protocol
|
2385
|
+
*/
|
2386
|
+
postgresEnabled?: boolean;
|
1821
2387
|
/**
|
1822
2388
|
* Metadata about the database for display in Xata user interfaces
|
1823
2389
|
*/
|
@@ -2251,6 +2817,7 @@ type GetWorkspacesListError = ErrorWrapper$1<{
|
|
2251
2817
|
type GetWorkspacesListResponse = {
|
2252
2818
|
workspaces: {
|
2253
2819
|
id: WorkspaceID;
|
2820
|
+
unique_id: string;
|
2254
2821
|
name: string;
|
2255
2822
|
slug: string;
|
2256
2823
|
role: Role;
|
@@ -2358,6 +2925,59 @@ type DeleteWorkspaceVariables = {
|
|
2358
2925
|
* Delete the workspace with the provided ID
|
2359
2926
|
*/
|
2360
2927
|
declare const deleteWorkspace: (variables: DeleteWorkspaceVariables, signal?: AbortSignal) => Promise<undefined>;
|
2928
|
+
type GetWorkspaceSettingsPathParams = {
|
2929
|
+
/**
|
2930
|
+
* Workspace ID
|
2931
|
+
*/
|
2932
|
+
workspaceId: WorkspaceID;
|
2933
|
+
};
|
2934
|
+
type GetWorkspaceSettingsError = ErrorWrapper$1<{
|
2935
|
+
status: 400;
|
2936
|
+
payload: BadRequestError;
|
2937
|
+
} | {
|
2938
|
+
status: 401;
|
2939
|
+
payload: AuthError;
|
2940
|
+
} | {
|
2941
|
+
status: 403;
|
2942
|
+
payload: AuthError;
|
2943
|
+
} | {
|
2944
|
+
status: 404;
|
2945
|
+
payload: SimpleError;
|
2946
|
+
}>;
|
2947
|
+
type GetWorkspaceSettingsVariables = {
|
2948
|
+
pathParams: GetWorkspaceSettingsPathParams;
|
2949
|
+
} & ControlPlaneFetcherExtraProps;
|
2950
|
+
/**
|
2951
|
+
* Retrieve workspace settings from a workspace ID
|
2952
|
+
*/
|
2953
|
+
declare const getWorkspaceSettings: (variables: GetWorkspaceSettingsVariables, signal?: AbortSignal) => Promise<WorkspaceSettings>;
|
2954
|
+
type UpdateWorkspaceSettingsPathParams = {
|
2955
|
+
/**
|
2956
|
+
* Workspace ID
|
2957
|
+
*/
|
2958
|
+
workspaceId: WorkspaceID;
|
2959
|
+
};
|
2960
|
+
type UpdateWorkspaceSettingsError = ErrorWrapper$1<{
|
2961
|
+
status: 400;
|
2962
|
+
payload: BadRequestError;
|
2963
|
+
} | {
|
2964
|
+
status: 401;
|
2965
|
+
payload: AuthError;
|
2966
|
+
} | {
|
2967
|
+
status: 403;
|
2968
|
+
payload: AuthError;
|
2969
|
+
} | {
|
2970
|
+
status: 404;
|
2971
|
+
payload: SimpleError;
|
2972
|
+
}>;
|
2973
|
+
type UpdateWorkspaceSettingsVariables = {
|
2974
|
+
body?: Record<string, any>;
|
2975
|
+
pathParams: UpdateWorkspaceSettingsPathParams;
|
2976
|
+
} & ControlPlaneFetcherExtraProps;
|
2977
|
+
/**
|
2978
|
+
* Update workspace settings
|
2979
|
+
*/
|
2980
|
+
declare const updateWorkspaceSettings: (variables: UpdateWorkspaceSettingsVariables, signal?: AbortSignal) => Promise<WorkspaceSettings>;
|
2361
2981
|
type GetWorkspaceMembersListPathParams = {
|
2362
2982
|
/**
|
2363
2983
|
* Workspace ID
|
@@ -2715,7 +3335,31 @@ type UpdateClusterVariables = {
|
|
2715
3335
|
/**
|
2716
3336
|
* Update cluster for given cluster ID
|
2717
3337
|
*/
|
2718
|
-
declare const updateCluster: (variables: UpdateClusterVariables, signal?: AbortSignal) => Promise<
|
3338
|
+
declare const updateCluster: (variables: UpdateClusterVariables, signal?: AbortSignal) => Promise<ClusterUpdateMetadata>;
|
3339
|
+
type DeleteClusterPathParams = {
|
3340
|
+
/**
|
3341
|
+
* Workspace ID
|
3342
|
+
*/
|
3343
|
+
workspaceId: WorkspaceID;
|
3344
|
+
/**
|
3345
|
+
* Cluster ID
|
3346
|
+
*/
|
3347
|
+
clusterId: ClusterID;
|
3348
|
+
};
|
3349
|
+
type DeleteClusterError = ErrorWrapper$1<{
|
3350
|
+
status: 400;
|
3351
|
+
payload: BadRequestError;
|
3352
|
+
} | {
|
3353
|
+
status: 401;
|
3354
|
+
payload: AuthError;
|
3355
|
+
}>;
|
3356
|
+
type DeleteClusterVariables = {
|
3357
|
+
pathParams: DeleteClusterPathParams;
|
3358
|
+
} & ControlPlaneFetcherExtraProps;
|
3359
|
+
/**
|
3360
|
+
* Delete cluster with given cluster ID
|
3361
|
+
*/
|
3362
|
+
declare const deleteCluster: (variables: DeleteClusterVariables, signal?: AbortSignal) => Promise<ClusterDeleteMetadata>;
|
2719
3363
|
type GetDatabaseListPathParams = {
|
2720
3364
|
/**
|
2721
3365
|
* Workspace ID
|
@@ -3064,6 +3708,174 @@ type ErrorWrapper<TError> = TError | {
|
|
3064
3708
|
* @version 1.0
|
3065
3709
|
*/
|
3066
3710
|
|
3711
|
+
type ListClusterBranchesPathParams = {
|
3712
|
+
/**
|
3713
|
+
* Cluster ID
|
3714
|
+
*/
|
3715
|
+
clusterId: ClusterID$1;
|
3716
|
+
workspace: string;
|
3717
|
+
region: string;
|
3718
|
+
};
|
3719
|
+
type ListClusterBranchesQueryParams = {
|
3720
|
+
/**
|
3721
|
+
* Page size
|
3722
|
+
*/
|
3723
|
+
page?: PageSize$1;
|
3724
|
+
/**
|
3725
|
+
* Page token
|
3726
|
+
*/
|
3727
|
+
token?: PageToken$1;
|
3728
|
+
};
|
3729
|
+
type ListClusterBranchesError = ErrorWrapper<{
|
3730
|
+
status: 400;
|
3731
|
+
payload: BadRequestError$1;
|
3732
|
+
} | {
|
3733
|
+
status: 401;
|
3734
|
+
payload: AuthError$1;
|
3735
|
+
}>;
|
3736
|
+
type ListClusterBranchesVariables = {
|
3737
|
+
pathParams: ListClusterBranchesPathParams;
|
3738
|
+
queryParams?: ListClusterBranchesQueryParams;
|
3739
|
+
} & DataPlaneFetcherExtraProps;
|
3740
|
+
/**
|
3741
|
+
* Retrieve branches for given cluster ID
|
3742
|
+
*/
|
3743
|
+
declare const listClusterBranches: (variables: ListClusterBranchesVariables, signal?: AbortSignal) => Promise<ListClusterBranchesResponse>;
|
3744
|
+
type ListClusterExtensionsPathParams = {
|
3745
|
+
/**
|
3746
|
+
* Cluster ID
|
3747
|
+
*/
|
3748
|
+
clusterId: ClusterID$1;
|
3749
|
+
workspace: string;
|
3750
|
+
region: string;
|
3751
|
+
};
|
3752
|
+
type ListClusterExtensionsQueryParams = {
|
3753
|
+
extensionType: 'available' | 'installed';
|
3754
|
+
};
|
3755
|
+
type ListClusterExtensionsError = ErrorWrapper<{
|
3756
|
+
status: 400;
|
3757
|
+
payload: BadRequestError$1;
|
3758
|
+
} | {
|
3759
|
+
status: 401;
|
3760
|
+
payload: AuthError$1;
|
3761
|
+
}>;
|
3762
|
+
type ListClusterExtensionsVariables = {
|
3763
|
+
pathParams: ListClusterExtensionsPathParams;
|
3764
|
+
queryParams: ListClusterExtensionsQueryParams;
|
3765
|
+
} & DataPlaneFetcherExtraProps;
|
3766
|
+
/**
|
3767
|
+
* Retrieve extensions for given cluster ID
|
3768
|
+
*/
|
3769
|
+
declare const listClusterExtensions: (variables: ListClusterExtensionsVariables, signal?: AbortSignal) => Promise<ListClusterExtensionsResponse>;
|
3770
|
+
type InstallClusterExtensionPathParams = {
|
3771
|
+
/**
|
3772
|
+
* Cluster ID
|
3773
|
+
*/
|
3774
|
+
clusterId: ClusterID$1;
|
3775
|
+
workspace: string;
|
3776
|
+
region: string;
|
3777
|
+
};
|
3778
|
+
type InstallClusterExtensionError = ErrorWrapper<{
|
3779
|
+
status: 400;
|
3780
|
+
payload: BadRequestError$1;
|
3781
|
+
} | {
|
3782
|
+
status: 401;
|
3783
|
+
payload: AuthError$1;
|
3784
|
+
}>;
|
3785
|
+
type InstallClusterExtensionRequestBody = {
|
3786
|
+
/**
|
3787
|
+
* Extension name
|
3788
|
+
*/
|
3789
|
+
extension: string;
|
3790
|
+
/**
|
3791
|
+
* Schema name
|
3792
|
+
*/
|
3793
|
+
schema?: string;
|
3794
|
+
/**
|
3795
|
+
* install with cascade option
|
3796
|
+
*/
|
3797
|
+
cascade?: boolean;
|
3798
|
+
};
|
3799
|
+
type InstallClusterExtensionVariables = {
|
3800
|
+
body: InstallClusterExtensionRequestBody;
|
3801
|
+
pathParams: InstallClusterExtensionPathParams;
|
3802
|
+
} & DataPlaneFetcherExtraProps;
|
3803
|
+
/**
|
3804
|
+
* Install an extension for given cluster ID
|
3805
|
+
*/
|
3806
|
+
declare const installClusterExtension: (variables: InstallClusterExtensionVariables, signal?: AbortSignal) => Promise<ClusterExtensionInstallationResponse>;
|
3807
|
+
type DropClusterExtensionPathParams = {
|
3808
|
+
/**
|
3809
|
+
* Cluster ID
|
3810
|
+
*/
|
3811
|
+
clusterId: ClusterID$1;
|
3812
|
+
workspace: string;
|
3813
|
+
region: string;
|
3814
|
+
};
|
3815
|
+
type DropClusterExtensionError = ErrorWrapper<{
|
3816
|
+
status: 400;
|
3817
|
+
payload: BadRequestError$1;
|
3818
|
+
} | {
|
3819
|
+
status: 401;
|
3820
|
+
payload: AuthError$1;
|
3821
|
+
}>;
|
3822
|
+
type DropClusterExtensionRequestBody = {
|
3823
|
+
/**
|
3824
|
+
* Extension name
|
3825
|
+
*/
|
3826
|
+
extension: string;
|
3827
|
+
/**
|
3828
|
+
* drop with cascade option, true by default
|
3829
|
+
*/
|
3830
|
+
cascade?: boolean;
|
3831
|
+
};
|
3832
|
+
type DropClusterExtensionVariables = {
|
3833
|
+
body: DropClusterExtensionRequestBody;
|
3834
|
+
pathParams: DropClusterExtensionPathParams;
|
3835
|
+
} & DataPlaneFetcherExtraProps;
|
3836
|
+
/**
|
3837
|
+
* Drop an extension for given cluster ID
|
3838
|
+
*/
|
3839
|
+
declare const dropClusterExtension: (variables: DropClusterExtensionVariables, signal?: AbortSignal) => Promise<undefined>;
|
3840
|
+
type GetClusterMetricsPathParams = {
|
3841
|
+
/**
|
3842
|
+
* Cluster ID
|
3843
|
+
*/
|
3844
|
+
clusterId: ClusterID$1;
|
3845
|
+
workspace: string;
|
3846
|
+
region: string;
|
3847
|
+
};
|
3848
|
+
type GetClusterMetricsQueryParams = {
|
3849
|
+
startTime: string;
|
3850
|
+
endTime: string;
|
3851
|
+
period: '5min' | '15min' | '1hour';
|
3852
|
+
/**
|
3853
|
+
* Page size
|
3854
|
+
*/
|
3855
|
+
page?: PageSize$1;
|
3856
|
+
/**
|
3857
|
+
* Page token
|
3858
|
+
*/
|
3859
|
+
token?: PageToken$1;
|
3860
|
+
};
|
3861
|
+
type GetClusterMetricsError = ErrorWrapper<{
|
3862
|
+
status: 400;
|
3863
|
+
payload: BadRequestError$1;
|
3864
|
+
} | {
|
3865
|
+
status: 401;
|
3866
|
+
payload: AuthError$1;
|
3867
|
+
} | {
|
3868
|
+
status: 404;
|
3869
|
+
payload: SimpleError$1;
|
3870
|
+
}>;
|
3871
|
+
type GetClusterMetricsVariables = {
|
3872
|
+
pathParams: GetClusterMetricsPathParams;
|
3873
|
+
queryParams: GetClusterMetricsQueryParams;
|
3874
|
+
} & DataPlaneFetcherExtraProps;
|
3875
|
+
/**
|
3876
|
+
* retrieve a standard set of RDS cluster metrics
|
3877
|
+
*/
|
3878
|
+
declare const getClusterMetrics: (variables: GetClusterMetricsVariables, signal?: AbortSignal) => Promise<MetricsResponse>;
|
3067
3879
|
type ApplyMigrationPathParams = {
|
3068
3880
|
/**
|
3069
3881
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3090,6 +3902,13 @@ type ApplyMigrationRequestBody = {
|
|
3090
3902
|
operations: {
|
3091
3903
|
[key: string]: any;
|
3092
3904
|
}[];
|
3905
|
+
/**
|
3906
|
+
* The schema in which the migration should be applied
|
3907
|
+
*
|
3908
|
+
* @default public
|
3909
|
+
*/
|
3910
|
+
schema?: string;
|
3911
|
+
adaptTables?: boolean;
|
3093
3912
|
};
|
3094
3913
|
type ApplyMigrationVariables = {
|
3095
3914
|
body: ApplyMigrationRequestBody;
|
@@ -3098,8 +3917,171 @@ type ApplyMigrationVariables = {
|
|
3098
3917
|
/**
|
3099
3918
|
* Applies a pgroll migration to the specified database.
|
3100
3919
|
*/
|
3101
|
-
declare const applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal) => Promise<
|
3102
|
-
type
|
3920
|
+
declare const applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
|
3921
|
+
type StartMigrationPathParams = {
|
3922
|
+
/**
|
3923
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3924
|
+
*/
|
3925
|
+
dbBranchName: DBBranchName;
|
3926
|
+
workspace: string;
|
3927
|
+
region: string;
|
3928
|
+
};
|
3929
|
+
type StartMigrationError = ErrorWrapper<{
|
3930
|
+
status: 400;
|
3931
|
+
payload: BadRequestError$1;
|
3932
|
+
} | {
|
3933
|
+
status: 401;
|
3934
|
+
payload: AuthError$1;
|
3935
|
+
} | {
|
3936
|
+
status: 404;
|
3937
|
+
payload: SimpleError$1;
|
3938
|
+
}>;
|
3939
|
+
type StartMigrationRequestBody = {
|
3940
|
+
/**
|
3941
|
+
* Migration name
|
3942
|
+
*/
|
3943
|
+
name?: string;
|
3944
|
+
operations: {
|
3945
|
+
[key: string]: any;
|
3946
|
+
}[];
|
3947
|
+
/**
|
3948
|
+
* The schema in which the migration should be started
|
3949
|
+
*
|
3950
|
+
* @default public
|
3951
|
+
*/
|
3952
|
+
schema?: string;
|
3953
|
+
};
|
3954
|
+
type StartMigrationVariables = {
|
3955
|
+
body: StartMigrationRequestBody;
|
3956
|
+
pathParams: StartMigrationPathParams;
|
3957
|
+
} & DataPlaneFetcherExtraProps;
|
3958
|
+
/**
|
3959
|
+
* Starts a pgroll migration on the specified database.
|
3960
|
+
*/
|
3961
|
+
declare const startMigration: (variables: StartMigrationVariables, signal?: AbortSignal) => Promise<StartMigrationResponse>;
|
3962
|
+
type CompleteMigrationPathParams = {
|
3963
|
+
/**
|
3964
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3965
|
+
*/
|
3966
|
+
dbBranchName: DBBranchName;
|
3967
|
+
workspace: string;
|
3968
|
+
region: string;
|
3969
|
+
};
|
3970
|
+
type CompleteMigrationError = ErrorWrapper<{
|
3971
|
+
status: 400;
|
3972
|
+
payload: BadRequestError$1;
|
3973
|
+
} | {
|
3974
|
+
status: 401;
|
3975
|
+
payload: AuthError$1;
|
3976
|
+
} | {
|
3977
|
+
status: 404;
|
3978
|
+
payload: SimpleError$1;
|
3979
|
+
}>;
|
3980
|
+
type CompleteMigrationRequestBody = {
|
3981
|
+
/**
|
3982
|
+
* The schema in which the migration should be completed
|
3983
|
+
*
|
3984
|
+
* @default public
|
3985
|
+
*/
|
3986
|
+
schema?: string;
|
3987
|
+
};
|
3988
|
+
type CompleteMigrationVariables = {
|
3989
|
+
body?: CompleteMigrationRequestBody;
|
3990
|
+
pathParams: CompleteMigrationPathParams;
|
3991
|
+
} & DataPlaneFetcherExtraProps;
|
3992
|
+
/**
|
3993
|
+
* Complete an active migration on the specified database
|
3994
|
+
*/
|
3995
|
+
declare const completeMigration: (variables: CompleteMigrationVariables, signal?: AbortSignal) => Promise<CompleteMigrationResponse>;
|
3996
|
+
type RollbackMigrationPathParams = {
|
3997
|
+
/**
|
3998
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3999
|
+
*/
|
4000
|
+
dbBranchName: DBBranchName;
|
4001
|
+
workspace: string;
|
4002
|
+
region: string;
|
4003
|
+
};
|
4004
|
+
type RollbackMigrationError = ErrorWrapper<{
|
4005
|
+
status: 400;
|
4006
|
+
payload: BadRequestError$1;
|
4007
|
+
} | {
|
4008
|
+
status: 401;
|
4009
|
+
payload: AuthError$1;
|
4010
|
+
} | {
|
4011
|
+
status: 404;
|
4012
|
+
payload: SimpleError$1;
|
4013
|
+
}>;
|
4014
|
+
type RollbackMigrationRequestBody = {
|
4015
|
+
/**
|
4016
|
+
* The schema in which the migration should be rolled back
|
4017
|
+
*
|
4018
|
+
* @default public
|
4019
|
+
*/
|
4020
|
+
schema?: string;
|
4021
|
+
};
|
4022
|
+
type RollbackMigrationVariables = {
|
4023
|
+
body?: RollbackMigrationRequestBody;
|
4024
|
+
pathParams: RollbackMigrationPathParams;
|
4025
|
+
} & DataPlaneFetcherExtraProps;
|
4026
|
+
/**
|
4027
|
+
* Roll back an active migration on the specified database
|
4028
|
+
*/
|
4029
|
+
declare const rollbackMigration: (variables: RollbackMigrationVariables, signal?: AbortSignal) => Promise<RollbackMigrationResponse>;
|
4030
|
+
type AdaptTablePathParams = {
|
4031
|
+
/**
|
4032
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4033
|
+
*/
|
4034
|
+
dbBranchName: DBBranchName;
|
4035
|
+
/**
|
4036
|
+
* The Table name
|
4037
|
+
*/
|
4038
|
+
tableName: TableName;
|
4039
|
+
workspace: string;
|
4040
|
+
region: string;
|
4041
|
+
};
|
4042
|
+
type AdaptTableError = ErrorWrapper<{
|
4043
|
+
status: 400;
|
4044
|
+
payload: BadRequestError$1;
|
4045
|
+
} | {
|
4046
|
+
status: 401;
|
4047
|
+
payload: AuthError$1;
|
4048
|
+
} | {
|
4049
|
+
status: 404;
|
4050
|
+
payload: SimpleError$1;
|
4051
|
+
}>;
|
4052
|
+
type AdaptTableVariables = {
|
4053
|
+
pathParams: AdaptTablePathParams;
|
4054
|
+
} & DataPlaneFetcherExtraProps;
|
4055
|
+
/**
|
4056
|
+
* Adapt a table to be used from Xata, this will add the Xata metadata fields to the table, making it accessible through the data API.
|
4057
|
+
*/
|
4058
|
+
declare const adaptTable: (variables: AdaptTableVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
|
4059
|
+
type AdaptAllTablesPathParams = {
|
4060
|
+
/**
|
4061
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4062
|
+
*/
|
4063
|
+
dbBranchName: DBBranchName;
|
4064
|
+
workspace: string;
|
4065
|
+
region: string;
|
4066
|
+
};
|
4067
|
+
type AdaptAllTablesError = ErrorWrapper<{
|
4068
|
+
status: 400;
|
4069
|
+
payload: BadRequestError$1;
|
4070
|
+
} | {
|
4071
|
+
status: 401;
|
4072
|
+
payload: AuthError$1;
|
4073
|
+
} | {
|
4074
|
+
status: 404;
|
4075
|
+
payload: SimpleError$1;
|
4076
|
+
}>;
|
4077
|
+
type AdaptAllTablesVariables = {
|
4078
|
+
pathParams: AdaptAllTablesPathParams;
|
4079
|
+
} & DataPlaneFetcherExtraProps;
|
4080
|
+
/**
|
4081
|
+
* Adapt all xata incompatible tables present in the branch, this will add the Xata metadata fields to the table, making them accessible through the data API.
|
4082
|
+
*/
|
4083
|
+
declare const adaptAllTables: (variables: AdaptAllTablesVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
|
4084
|
+
type GetBranchMigrationJobStatusPathParams = {
|
3103
4085
|
/**
|
3104
4086
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3105
4087
|
*/
|
@@ -3107,7 +4089,7 @@ type PgRollStatusPathParams = {
|
|
3107
4089
|
workspace: string;
|
3108
4090
|
region: string;
|
3109
4091
|
};
|
3110
|
-
type
|
4092
|
+
type GetBranchMigrationJobStatusError = ErrorWrapper<{
|
3111
4093
|
status: 400;
|
3112
4094
|
payload: BadRequestError$1;
|
3113
4095
|
} | {
|
@@ -3117,23 +4099,111 @@ type PgRollStatusError = ErrorWrapper<{
|
|
3117
4099
|
status: 404;
|
3118
4100
|
payload: SimpleError$1;
|
3119
4101
|
}>;
|
3120
|
-
type
|
3121
|
-
pathParams:
|
4102
|
+
type GetBranchMigrationJobStatusVariables = {
|
4103
|
+
pathParams: GetBranchMigrationJobStatusPathParams;
|
3122
4104
|
} & DataPlaneFetcherExtraProps;
|
3123
|
-
declare const
|
3124
|
-
type
|
4105
|
+
declare const getBranchMigrationJobStatus: (variables: GetBranchMigrationJobStatusVariables, signal?: AbortSignal) => Promise<MigrationJobStatusResponse>;
|
4106
|
+
type GetMigrationJobsPathParams = {
|
3125
4107
|
/**
|
3126
4108
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3127
4109
|
*/
|
3128
4110
|
dbBranchName: DBBranchName;
|
4111
|
+
workspace: string;
|
4112
|
+
region: string;
|
4113
|
+
};
|
4114
|
+
type GetMigrationJobsQueryParams = {
|
4115
|
+
/**
|
4116
|
+
* @format date-time
|
4117
|
+
*/
|
4118
|
+
cursor?: string;
|
4119
|
+
/**
|
4120
|
+
* Page size
|
4121
|
+
*/
|
4122
|
+
limit?: PageSize$1;
|
4123
|
+
};
|
4124
|
+
type GetMigrationJobsError = ErrorWrapper<{
|
4125
|
+
status: 400;
|
4126
|
+
payload: BadRequestError$1;
|
4127
|
+
} | {
|
4128
|
+
status: 401;
|
4129
|
+
payload: AuthError$1;
|
4130
|
+
} | {
|
4131
|
+
status: 404;
|
4132
|
+
payload: SimpleError$1;
|
4133
|
+
}>;
|
4134
|
+
type GetMigrationJobsVariables = {
|
4135
|
+
pathParams: GetMigrationJobsPathParams;
|
4136
|
+
queryParams?: GetMigrationJobsQueryParams;
|
4137
|
+
} & DataPlaneFetcherExtraProps;
|
4138
|
+
declare const getMigrationJobs: (variables: GetMigrationJobsVariables, signal?: AbortSignal) => Promise<GetMigrationJobsResponse>;
|
4139
|
+
type GetMigrationJobStatusPathParams = {
|
4140
|
+
/**
|
4141
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4142
|
+
*/
|
4143
|
+
dbBranchName: DBBranchName;
|
4144
|
+
/**
|
4145
|
+
* The id of the migration job
|
4146
|
+
*/
|
4147
|
+
jobId: MigrationJobID;
|
4148
|
+
workspace: string;
|
4149
|
+
region: string;
|
4150
|
+
};
|
4151
|
+
type GetMigrationJobStatusError = ErrorWrapper<{
|
4152
|
+
status: 400;
|
4153
|
+
payload: BadRequestError$1;
|
4154
|
+
} | {
|
4155
|
+
status: 401;
|
4156
|
+
payload: AuthError$1;
|
4157
|
+
} | {
|
4158
|
+
status: 404;
|
4159
|
+
payload: SimpleError$1;
|
4160
|
+
}>;
|
4161
|
+
type GetMigrationJobStatusVariables = {
|
4162
|
+
pathParams: GetMigrationJobStatusPathParams;
|
4163
|
+
} & DataPlaneFetcherExtraProps;
|
4164
|
+
declare const getMigrationJobStatus: (variables: GetMigrationJobStatusVariables, signal?: AbortSignal) => Promise<MigrationJobStatusResponse>;
|
4165
|
+
type GetMigrationHistoryPathParams = {
|
4166
|
+
/**
|
4167
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4168
|
+
*/
|
4169
|
+
dbBranchName: DBBranchName;
|
4170
|
+
workspace: string;
|
4171
|
+
region: string;
|
4172
|
+
};
|
4173
|
+
type GetMigrationHistoryQueryParams = {
|
4174
|
+
/**
|
4175
|
+
* @format date-time
|
4176
|
+
*/
|
4177
|
+
cursor?: string;
|
4178
|
+
/**
|
4179
|
+
* Page size
|
4180
|
+
*/
|
4181
|
+
limit?: PageSize$1;
|
4182
|
+
};
|
4183
|
+
type GetMigrationHistoryError = ErrorWrapper<{
|
4184
|
+
status: 400;
|
4185
|
+
payload: BadRequestError$1;
|
4186
|
+
} | {
|
4187
|
+
status: 401;
|
4188
|
+
payload: AuthError$1;
|
4189
|
+
} | {
|
4190
|
+
status: 404;
|
4191
|
+
payload: SimpleError$1;
|
4192
|
+
}>;
|
4193
|
+
type GetMigrationHistoryVariables = {
|
4194
|
+
pathParams: GetMigrationHistoryPathParams;
|
4195
|
+
queryParams?: GetMigrationHistoryQueryParams;
|
4196
|
+
} & DataPlaneFetcherExtraProps;
|
4197
|
+
declare const getMigrationHistory: (variables: GetMigrationHistoryVariables, signal?: AbortSignal) => Promise<MigrationHistoryResponse>;
|
4198
|
+
type GetBranchListPathParams = {
|
3129
4199
|
/**
|
3130
|
-
* The
|
4200
|
+
* The Database Name
|
3131
4201
|
*/
|
3132
|
-
|
4202
|
+
dbName: DBName$1;
|
3133
4203
|
workspace: string;
|
3134
4204
|
region: string;
|
3135
4205
|
};
|
3136
|
-
type
|
4206
|
+
type GetBranchListError = ErrorWrapper<{
|
3137
4207
|
status: 400;
|
3138
4208
|
payload: BadRequestError$1;
|
3139
4209
|
} | {
|
@@ -3143,21 +4213,24 @@ type PgRollJobStatusError = ErrorWrapper<{
|
|
3143
4213
|
status: 404;
|
3144
4214
|
payload: SimpleError$1;
|
3145
4215
|
}>;
|
3146
|
-
type
|
3147
|
-
pathParams:
|
4216
|
+
type GetBranchListVariables = {
|
4217
|
+
pathParams: GetBranchListPathParams;
|
3148
4218
|
} & DataPlaneFetcherExtraProps;
|
3149
|
-
|
3150
|
-
|
4219
|
+
/**
|
4220
|
+
* List all available Branches
|
4221
|
+
*/
|
4222
|
+
declare const getBranchList: (variables: GetBranchListVariables, signal?: AbortSignal) => Promise<ListBranchesResponse>;
|
4223
|
+
type GetDatabaseSettingsPathParams = {
|
3151
4224
|
/**
|
3152
|
-
* The
|
4225
|
+
* The Database Name
|
3153
4226
|
*/
|
3154
|
-
|
4227
|
+
dbName: DBName$1;
|
3155
4228
|
workspace: string;
|
3156
4229
|
region: string;
|
3157
4230
|
};
|
3158
|
-
type
|
4231
|
+
type GetDatabaseSettingsError = ErrorWrapper<{
|
3159
4232
|
status: 400;
|
3160
|
-
payload:
|
4233
|
+
payload: SimpleError$1;
|
3161
4234
|
} | {
|
3162
4235
|
status: 401;
|
3163
4236
|
payload: AuthError$1;
|
@@ -3165,11 +4238,14 @@ type PgRollMigrationHistoryError = ErrorWrapper<{
|
|
3165
4238
|
status: 404;
|
3166
4239
|
payload: SimpleError$1;
|
3167
4240
|
}>;
|
3168
|
-
type
|
3169
|
-
pathParams:
|
4241
|
+
type GetDatabaseSettingsVariables = {
|
4242
|
+
pathParams: GetDatabaseSettingsPathParams;
|
3170
4243
|
} & DataPlaneFetcherExtraProps;
|
3171
|
-
|
3172
|
-
|
4244
|
+
/**
|
4245
|
+
* Get database settings
|
4246
|
+
*/
|
4247
|
+
declare const getDatabaseSettings: (variables: GetDatabaseSettingsVariables, signal?: AbortSignal) => Promise<DatabaseSettings>;
|
4248
|
+
type UpdateDatabaseSettingsPathParams = {
|
3173
4249
|
/**
|
3174
4250
|
* The Database Name
|
3175
4251
|
*/
|
@@ -3177,9 +4253,9 @@ type GetBranchListPathParams = {
|
|
3177
4253
|
workspace: string;
|
3178
4254
|
region: string;
|
3179
4255
|
};
|
3180
|
-
type
|
4256
|
+
type UpdateDatabaseSettingsError = ErrorWrapper<{
|
3181
4257
|
status: 400;
|
3182
|
-
payload:
|
4258
|
+
payload: SimpleError$1;
|
3183
4259
|
} | {
|
3184
4260
|
status: 401;
|
3185
4261
|
payload: AuthError$1;
|
@@ -3187,13 +4263,17 @@ type GetBranchListError = ErrorWrapper<{
|
|
3187
4263
|
status: 404;
|
3188
4264
|
payload: SimpleError$1;
|
3189
4265
|
}>;
|
3190
|
-
type
|
3191
|
-
|
4266
|
+
type UpdateDatabaseSettingsRequestBody = {
|
4267
|
+
searchEnabled?: boolean;
|
4268
|
+
};
|
4269
|
+
type UpdateDatabaseSettingsVariables = {
|
4270
|
+
body?: UpdateDatabaseSettingsRequestBody;
|
4271
|
+
pathParams: UpdateDatabaseSettingsPathParams;
|
3192
4272
|
} & DataPlaneFetcherExtraProps;
|
3193
4273
|
/**
|
3194
|
-
*
|
4274
|
+
* Update database settings, this endpoint can be used to disable search
|
3195
4275
|
*/
|
3196
|
-
declare const
|
4276
|
+
declare const updateDatabaseSettings: (variables: UpdateDatabaseSettingsVariables, signal?: AbortSignal) => Promise<DatabaseSettings>;
|
3197
4277
|
type GetBranchDetailsPathParams = {
|
3198
4278
|
/**
|
3199
4279
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3321,12 +4401,37 @@ type GetSchemaError = ErrorWrapper<{
|
|
3321
4401
|
payload: SimpleError$1;
|
3322
4402
|
}>;
|
3323
4403
|
type GetSchemaResponse = {
|
3324
|
-
schema:
|
4404
|
+
schema: BranchSchema;
|
3325
4405
|
};
|
3326
4406
|
type GetSchemaVariables = {
|
3327
4407
|
pathParams: GetSchemaPathParams;
|
3328
4408
|
} & DataPlaneFetcherExtraProps;
|
3329
4409
|
declare const getSchema: (variables: GetSchemaVariables, signal?: AbortSignal) => Promise<GetSchemaResponse>;
|
4410
|
+
type GetSchemasPathParams = {
|
4411
|
+
/**
|
4412
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4413
|
+
*/
|
4414
|
+
dbBranchName: DBBranchName;
|
4415
|
+
workspace: string;
|
4416
|
+
region: string;
|
4417
|
+
};
|
4418
|
+
type GetSchemasError = ErrorWrapper<{
|
4419
|
+
status: 400;
|
4420
|
+
payload: BadRequestError$1;
|
4421
|
+
} | {
|
4422
|
+
status: 401;
|
4423
|
+
payload: AuthError$1;
|
4424
|
+
} | {
|
4425
|
+
status: 404;
|
4426
|
+
payload: SimpleError$1;
|
4427
|
+
}>;
|
4428
|
+
type GetSchemasResponse = {
|
4429
|
+
schemas: BranchSchema[];
|
4430
|
+
};
|
4431
|
+
type GetSchemasVariables = {
|
4432
|
+
pathParams: GetSchemasPathParams;
|
4433
|
+
} & DataPlaneFetcherExtraProps;
|
4434
|
+
declare const getSchemas: (variables: GetSchemasVariables, signal?: AbortSignal) => Promise<GetSchemasResponse>;
|
3330
4435
|
type CopyBranchPathParams = {
|
3331
4436
|
/**
|
3332
4437
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3357,6 +4462,73 @@ type CopyBranchVariables = {
|
|
3357
4462
|
* Create a copy of the branch
|
3358
4463
|
*/
|
3359
4464
|
declare const copyBranch: (variables: CopyBranchVariables, signal?: AbortSignal) => Promise<BranchWithCopyID>;
|
4465
|
+
type GetBranchMoveStatusPathParams = {
|
4466
|
+
/**
|
4467
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4468
|
+
*/
|
4469
|
+
dbBranchName: DBBranchName;
|
4470
|
+
workspace: string;
|
4471
|
+
region: string;
|
4472
|
+
};
|
4473
|
+
type GetBranchMoveStatusError = ErrorWrapper<{
|
4474
|
+
status: 400;
|
4475
|
+
payload: BadRequestError$1;
|
4476
|
+
} | {
|
4477
|
+
status: 401;
|
4478
|
+
payload: AuthError$1;
|
4479
|
+
} | {
|
4480
|
+
status: 404;
|
4481
|
+
payload: SimpleError$1;
|
4482
|
+
}>;
|
4483
|
+
type GetBranchMoveStatusResponse = {
|
4484
|
+
state: string;
|
4485
|
+
pendingBytes: number;
|
4486
|
+
};
|
4487
|
+
type GetBranchMoveStatusVariables = {
|
4488
|
+
pathParams: GetBranchMoveStatusPathParams;
|
4489
|
+
} & DataPlaneFetcherExtraProps;
|
4490
|
+
/**
|
4491
|
+
* Get the branch move status (if a move is happening)
|
4492
|
+
*/
|
4493
|
+
declare const getBranchMoveStatus: (variables: GetBranchMoveStatusVariables, signal?: AbortSignal) => Promise<GetBranchMoveStatusResponse>;
|
4494
|
+
type MoveBranchPathParams = {
|
4495
|
+
/**
|
4496
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4497
|
+
*/
|
4498
|
+
dbBranchName: DBBranchName;
|
4499
|
+
workspace: string;
|
4500
|
+
region: string;
|
4501
|
+
};
|
4502
|
+
type MoveBranchError = ErrorWrapper<{
|
4503
|
+
status: 400;
|
4504
|
+
payload: BadRequestError$1;
|
4505
|
+
} | {
|
4506
|
+
status: 401;
|
4507
|
+
payload: AuthError$1;
|
4508
|
+
} | {
|
4509
|
+
status: 404;
|
4510
|
+
payload: SimpleError$1;
|
4511
|
+
} | {
|
4512
|
+
status: 423;
|
4513
|
+
payload: SimpleError$1;
|
4514
|
+
}>;
|
4515
|
+
type MoveBranchResponse = {
|
4516
|
+
state: string;
|
4517
|
+
};
|
4518
|
+
type MoveBranchRequestBody = {
|
4519
|
+
/**
|
4520
|
+
* Select the cluster to move the branch to. Must be different from the current cluster.
|
4521
|
+
*
|
4522
|
+
* @minLength 1
|
4523
|
+
* @x-internal true
|
4524
|
+
*/
|
4525
|
+
to: string;
|
4526
|
+
};
|
4527
|
+
type MoveBranchVariables = {
|
4528
|
+
body: MoveBranchRequestBody;
|
4529
|
+
pathParams: MoveBranchPathParams;
|
4530
|
+
} & DataPlaneFetcherExtraProps;
|
4531
|
+
declare const moveBranch: (variables: MoveBranchVariables, signal?: AbortSignal) => Promise<MoveBranchResponse>;
|
3360
4532
|
type UpdateBranchMetadataPathParams = {
|
3361
4533
|
/**
|
3362
4534
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3545,7 +4717,7 @@ type RemoveGitBranchesEntryPathParams = {
|
|
3545
4717
|
};
|
3546
4718
|
type RemoveGitBranchesEntryQueryParams = {
|
3547
4719
|
/**
|
3548
|
-
* The
|
4720
|
+
* The git branch to remove from the mapping
|
3549
4721
|
*/
|
3550
4722
|
gitBranch: string;
|
3551
4723
|
};
|
@@ -3608,7 +4780,7 @@ type ResolveBranchVariables = {
|
|
3608
4780
|
} & DataPlaneFetcherExtraProps;
|
3609
4781
|
/**
|
3610
4782
|
* In order to resolve the database branch, the following algorithm is used:
|
3611
|
-
* * if the `gitBranch` was provided and is found in the [git branches mapping](/api-reference/dbs/db_name/gitBranches), the associated Xata branch is returned
|
4783
|
+
* * if the `gitBranch` was provided and is found in the [git branches mapping](/docs/api-reference/dbs/db_name/gitBranches), the associated Xata branch is returned
|
3612
4784
|
* * else, if a Xata branch with the exact same name as `gitBranch` exists, return it
|
3613
4785
|
* * else, if `fallbackBranch` is provided and a branch with that name exists, return it
|
3614
4786
|
* * else, return the default branch of the DB (`main` or the first branch)
|
@@ -5209,7 +6381,7 @@ type QueryTableVariables = {
|
|
5209
6381
|
* }
|
5210
6382
|
* ```
|
5211
6383
|
*
|
5212
|
-
* For usage, see also the [
|
6384
|
+
* For usage, see also the [Xata SDK documentation](https://xata.io/docs/sdk/get).
|
5213
6385
|
*
|
5214
6386
|
* ### Column selection
|
5215
6387
|
*
|
@@ -6081,7 +7253,7 @@ type SearchTableVariables = {
|
|
6081
7253
|
/**
|
6082
7254
|
* Run a free text search operation in a particular table.
|
6083
7255
|
*
|
6084
|
-
* The endpoint accepts a `query` parameter that is used for the free text search and a set of structured filters (via the `filter` parameter) that are applied before the search. The `filter` parameter uses the same syntax as the [query endpoint](/api-reference/db/db_branch_name/tables/table_name/) with the following exceptions:
|
7256
|
+
* The endpoint accepts a `query` parameter that is used for the free text search and a set of structured filters (via the `filter` parameter) that are applied before the search. The `filter` parameter uses the same syntax as the [query endpoint](/docs/api-reference/db/db_branch_name/tables/table_name/query#filtering) with the following exceptions:
|
6085
7257
|
* * filters `$contains`, `$startsWith`, `$endsWith` don't work on columns of type `text`
|
6086
7258
|
* * filtering on columns of type `multiple` is currently unsupported
|
6087
7259
|
*/
|
@@ -6442,7 +7614,7 @@ type AggregateTableVariables = {
|
|
6442
7614
|
* store that is more appropriate for analytics, makes use of approximation algorithms
|
6443
7615
|
* (e.g for cardinality), and is generally faster and can do more complex aggregations.
|
6444
7616
|
*
|
6445
|
-
* For usage, see the [
|
7617
|
+
* For usage, see the [Aggregation documentation](https://xata.io/docs/sdk/aggregate).
|
6446
7618
|
*/
|
6447
7619
|
declare const aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal) => Promise<AggResponse>;
|
6448
7620
|
type FileAccessPathParams = {
|
@@ -6531,173 +7703,222 @@ type SqlQueryError = ErrorWrapper<{
|
|
6531
7703
|
status: 503;
|
6532
7704
|
payload: ServiceUnavailableError;
|
6533
7705
|
}>;
|
6534
|
-
type SqlQueryRequestBody = {
|
6535
|
-
|
6536
|
-
|
6537
|
-
|
6538
|
-
|
6539
|
-
|
6540
|
-
|
7706
|
+
type SqlQueryRequestBody = PreparedStatement & {
|
7707
|
+
consistency?: SQLConsistency;
|
7708
|
+
responseType?: SQLResponseType$1;
|
7709
|
+
};
|
7710
|
+
type SqlQueryVariables = {
|
7711
|
+
body: SqlQueryRequestBody;
|
7712
|
+
pathParams: SqlQueryPathParams;
|
7713
|
+
} & DataPlaneFetcherExtraProps;
|
7714
|
+
/**
|
7715
|
+
* Run an SQL query across the database branch.
|
7716
|
+
*/
|
7717
|
+
declare const sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<SQLResponse$1>;
|
7718
|
+
type SqlBatchQueryPathParams = {
|
6541
7719
|
/**
|
6542
|
-
* The
|
7720
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
6543
7721
|
*/
|
6544
|
-
|
7722
|
+
dbBranchName: DBBranchName;
|
7723
|
+
workspace: string;
|
7724
|
+
region: string;
|
7725
|
+
};
|
7726
|
+
type SqlBatchQueryError = ErrorWrapper<{
|
7727
|
+
status: 400;
|
7728
|
+
payload: BadRequestError$1;
|
7729
|
+
} | {
|
7730
|
+
status: 401;
|
7731
|
+
payload: AuthError$1;
|
7732
|
+
} | {
|
7733
|
+
status: 404;
|
7734
|
+
payload: SimpleError$1;
|
7735
|
+
} | {
|
7736
|
+
status: 503;
|
7737
|
+
payload: ServiceUnavailableError;
|
7738
|
+
}>;
|
7739
|
+
type SqlBatchQueryRequestBody = {
|
6545
7740
|
/**
|
6546
|
-
* The
|
7741
|
+
* The SQL statements.
|
6547
7742
|
*
|
6548
|
-
* @
|
7743
|
+
* @x-go-type []sqlproxy.PreparedStatement
|
6549
7744
|
*/
|
6550
|
-
|
7745
|
+
statements: PreparedStatement[];
|
7746
|
+
consistency?: SQLConsistency;
|
7747
|
+
responseType?: SQLResponseType$1;
|
6551
7748
|
};
|
6552
|
-
type
|
6553
|
-
body:
|
6554
|
-
pathParams:
|
7749
|
+
type SqlBatchQueryVariables = {
|
7750
|
+
body: SqlBatchQueryRequestBody;
|
7751
|
+
pathParams: SqlBatchQueryPathParams;
|
6555
7752
|
} & DataPlaneFetcherExtraProps;
|
6556
7753
|
/**
|
6557
|
-
* Run
|
7754
|
+
* Run multiple SQL queries across the database branch.
|
6558
7755
|
*/
|
6559
|
-
declare const
|
7756
|
+
declare const sqlBatchQuery: (variables: SqlBatchQueryVariables, signal?: AbortSignal) => Promise<SQLBatchResponse>;
|
6560
7757
|
|
6561
7758
|
declare const operationsByTag: {
|
6562
7759
|
branch: {
|
6563
|
-
|
6564
|
-
|
6565
|
-
|
6566
|
-
|
6567
|
-
|
6568
|
-
|
6569
|
-
|
6570
|
-
|
6571
|
-
|
6572
|
-
|
6573
|
-
|
6574
|
-
|
6575
|
-
|
6576
|
-
|
6577
|
-
removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
6578
|
-
resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal | undefined) => Promise<ResolveBranchResponse>;
|
7760
|
+
getBranchList: (variables: GetBranchListVariables, signal?: AbortSignal) => Promise<ListBranchesResponse>;
|
7761
|
+
getBranchDetails: (variables: GetBranchDetailsVariables, signal?: AbortSignal) => Promise<DBBranch>;
|
7762
|
+
createBranch: (variables: CreateBranchVariables, signal?: AbortSignal) => Promise<CreateBranchResponse>;
|
7763
|
+
deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal) => Promise<DeleteBranchResponse>;
|
7764
|
+
copyBranch: (variables: CopyBranchVariables, signal?: AbortSignal) => Promise<BranchWithCopyID>;
|
7765
|
+
getBranchMoveStatus: (variables: GetBranchMoveStatusVariables, signal?: AbortSignal) => Promise<GetBranchMoveStatusResponse>;
|
7766
|
+
moveBranch: (variables: MoveBranchVariables, signal?: AbortSignal) => Promise<MoveBranchResponse>;
|
7767
|
+
updateBranchMetadata: (variables: UpdateBranchMetadataVariables, signal?: AbortSignal) => Promise<undefined>;
|
7768
|
+
getBranchMetadata: (variables: GetBranchMetadataVariables, signal?: AbortSignal) => Promise<BranchMetadata$1>;
|
7769
|
+
getBranchStats: (variables: GetBranchStatsVariables, signal?: AbortSignal) => Promise<GetBranchStatsResponse>;
|
7770
|
+
getGitBranchesMapping: (variables: GetGitBranchesMappingVariables, signal?: AbortSignal) => Promise<ListGitBranchesResponse>;
|
7771
|
+
addGitBranchesEntry: (variables: AddGitBranchesEntryVariables, signal?: AbortSignal) => Promise<AddGitBranchesEntryResponse>;
|
7772
|
+
removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables, signal?: AbortSignal) => Promise<undefined>;
|
7773
|
+
resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal) => Promise<ResolveBranchResponse>;
|
6579
7774
|
};
|
6580
7775
|
workspaces: {
|
6581
|
-
getWorkspacesList: (variables:
|
6582
|
-
createWorkspace: (variables: CreateWorkspaceVariables, signal?: AbortSignal
|
6583
|
-
getWorkspace: (variables: GetWorkspaceVariables, signal?: AbortSignal
|
6584
|
-
updateWorkspace: (variables: UpdateWorkspaceVariables, signal?: AbortSignal
|
6585
|
-
deleteWorkspace: (variables: DeleteWorkspaceVariables, signal?: AbortSignal
|
6586
|
-
|
6587
|
-
|
6588
|
-
|
7776
|
+
getWorkspacesList: (variables: GetWorkspacesListVariables, signal?: AbortSignal) => Promise<GetWorkspacesListResponse>;
|
7777
|
+
createWorkspace: (variables: CreateWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
7778
|
+
getWorkspace: (variables: GetWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
7779
|
+
updateWorkspace: (variables: UpdateWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
7780
|
+
deleteWorkspace: (variables: DeleteWorkspaceVariables, signal?: AbortSignal) => Promise<undefined>;
|
7781
|
+
getWorkspaceSettings: (variables: GetWorkspaceSettingsVariables, signal?: AbortSignal) => Promise<WorkspaceSettings>;
|
7782
|
+
updateWorkspaceSettings: (variables: UpdateWorkspaceSettingsVariables, signal?: AbortSignal) => Promise<WorkspaceSettings>;
|
7783
|
+
getWorkspaceMembersList: (variables: GetWorkspaceMembersListVariables, signal?: AbortSignal) => Promise<WorkspaceMembers>;
|
7784
|
+
updateWorkspaceMemberRole: (variables: UpdateWorkspaceMemberRoleVariables, signal?: AbortSignal) => Promise<undefined>;
|
7785
|
+
removeWorkspaceMember: (variables: RemoveWorkspaceMemberVariables, signal?: AbortSignal) => Promise<undefined>;
|
7786
|
+
};
|
7787
|
+
table: {
|
7788
|
+
createTable: (variables: CreateTableVariables, signal?: AbortSignal) => Promise<CreateTableResponse>;
|
7789
|
+
deleteTable: (variables: DeleteTableVariables, signal?: AbortSignal) => Promise<DeleteTableResponse>;
|
7790
|
+
updateTable: (variables: UpdateTableVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7791
|
+
getTableSchema: (variables: GetTableSchemaVariables, signal?: AbortSignal) => Promise<GetTableSchemaResponse>;
|
7792
|
+
setTableSchema: (variables: SetTableSchemaVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7793
|
+
getTableColumns: (variables: GetTableColumnsVariables, signal?: AbortSignal) => Promise<GetTableColumnsResponse>;
|
7794
|
+
addTableColumn: (variables: AddTableColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7795
|
+
getColumn: (variables: GetColumnVariables, signal?: AbortSignal) => Promise<Column>;
|
7796
|
+
updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7797
|
+
deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
6589
7798
|
};
|
6590
7799
|
migrations: {
|
6591
|
-
|
6592
|
-
|
6593
|
-
|
6594
|
-
|
6595
|
-
|
6596
|
-
|
6597
|
-
|
6598
|
-
|
6599
|
-
|
6600
|
-
|
6601
|
-
|
7800
|
+
applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
|
7801
|
+
startMigration: (variables: StartMigrationVariables, signal?: AbortSignal) => Promise<StartMigrationResponse>;
|
7802
|
+
completeMigration: (variables: CompleteMigrationVariables, signal?: AbortSignal) => Promise<CompleteMigrationResponse>;
|
7803
|
+
rollbackMigration: (variables: RollbackMigrationVariables, signal?: AbortSignal) => Promise<RollbackMigrationResponse>;
|
7804
|
+
adaptTable: (variables: AdaptTableVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
|
7805
|
+
adaptAllTables: (variables: AdaptAllTablesVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
|
7806
|
+
getBranchMigrationJobStatus: (variables: GetBranchMigrationJobStatusVariables, signal?: AbortSignal) => Promise<MigrationJobStatusResponse>;
|
7807
|
+
getMigrationJobs: (variables: GetMigrationJobsVariables, signal?: AbortSignal) => Promise<GetMigrationJobsResponse>;
|
7808
|
+
getMigrationJobStatus: (variables: GetMigrationJobStatusVariables, signal?: AbortSignal) => Promise<MigrationJobStatusResponse>;
|
7809
|
+
getMigrationHistory: (variables: GetMigrationHistoryVariables, signal?: AbortSignal) => Promise<MigrationHistoryResponse>;
|
7810
|
+
getSchema: (variables: GetSchemaVariables, signal?: AbortSignal) => Promise<GetSchemaResponse>;
|
7811
|
+
getSchemas: (variables: GetSchemasVariables, signal?: AbortSignal) => Promise<GetSchemasResponse>;
|
7812
|
+
getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal) => Promise<GetBranchMigrationHistoryResponse>;
|
7813
|
+
getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<BranchMigrationPlan>;
|
7814
|
+
executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7815
|
+
getBranchSchemaHistory: (variables: GetBranchSchemaHistoryVariables, signal?: AbortSignal) => Promise<GetBranchSchemaHistoryResponse>;
|
7816
|
+
compareBranchWithUserSchema: (variables: CompareBranchWithUserSchemaVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
7817
|
+
compareBranchSchemas: (variables: CompareBranchSchemasVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
7818
|
+
updateBranchSchema: (variables: UpdateBranchSchemaVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7819
|
+
previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables, signal?: AbortSignal) => Promise<PreviewBranchSchemaEditResponse>;
|
7820
|
+
applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7821
|
+
pushBranchMigrations: (variables: PushBranchMigrationsVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
6602
7822
|
};
|
6603
7823
|
records: {
|
6604
|
-
branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal
|
6605
|
-
insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal
|
6606
|
-
getRecord: (variables: GetRecordVariables, signal?: AbortSignal
|
6607
|
-
insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal
|
6608
|
-
updateRecordWithID: (variables: UpdateRecordWithIDVariables, signal?: AbortSignal
|
6609
|
-
upsertRecordWithID: (variables: UpsertRecordWithIDVariables, signal?: AbortSignal
|
6610
|
-
deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal
|
6611
|
-
bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal
|
7824
|
+
branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal) => Promise<TransactionSuccess>;
|
7825
|
+
insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
7826
|
+
getRecord: (variables: GetRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
|
7827
|
+
insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
7828
|
+
updateRecordWithID: (variables: UpdateRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
7829
|
+
upsertRecordWithID: (variables: UpsertRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
7830
|
+
deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
|
7831
|
+
bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal) => Promise<BulkInsertResponse>;
|
6612
7832
|
};
|
6613
|
-
|
6614
|
-
|
6615
|
-
|
6616
|
-
|
6617
|
-
|
6618
|
-
|
6619
|
-
compareMigrationRequest: (variables: CompareMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<SchemaCompareResponse>;
|
6620
|
-
getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables, signal?: AbortSignal | undefined) => Promise<GetMigrationRequestIsMergedResponse>;
|
6621
|
-
mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<BranchOp>;
|
7833
|
+
cluster: {
|
7834
|
+
listClusterBranches: (variables: ListClusterBranchesVariables, signal?: AbortSignal) => Promise<ListClusterBranchesResponse>;
|
7835
|
+
listClusterExtensions: (variables: ListClusterExtensionsVariables, signal?: AbortSignal) => Promise<ListClusterExtensionsResponse>;
|
7836
|
+
installClusterExtension: (variables: InstallClusterExtensionVariables, signal?: AbortSignal) => Promise<ClusterExtensionInstallationResponse>;
|
7837
|
+
dropClusterExtension: (variables: DropClusterExtensionVariables, signal?: AbortSignal) => Promise<undefined>;
|
7838
|
+
getClusterMetrics: (variables: GetClusterMetricsVariables, signal?: AbortSignal) => Promise<MetricsResponse>;
|
6622
7839
|
};
|
6623
|
-
|
6624
|
-
|
6625
|
-
|
6626
|
-
|
6627
|
-
|
6628
|
-
|
6629
|
-
|
6630
|
-
|
6631
|
-
|
6632
|
-
|
6633
|
-
|
7840
|
+
database: {
|
7841
|
+
getDatabaseSettings: (variables: GetDatabaseSettingsVariables, signal?: AbortSignal) => Promise<DatabaseSettings>;
|
7842
|
+
updateDatabaseSettings: (variables: UpdateDatabaseSettingsVariables, signal?: AbortSignal) => Promise<DatabaseSettings>;
|
7843
|
+
};
|
7844
|
+
migrationRequests: {
|
7845
|
+
queryMigrationRequests: (variables: QueryMigrationRequestsVariables, signal?: AbortSignal) => Promise<QueryMigrationRequestsResponse>;
|
7846
|
+
createMigrationRequest: (variables: CreateMigrationRequestVariables, signal?: AbortSignal) => Promise<CreateMigrationRequestResponse>;
|
7847
|
+
getMigrationRequest: (variables: GetMigrationRequestVariables, signal?: AbortSignal) => Promise<MigrationRequest>;
|
7848
|
+
updateMigrationRequest: (variables: UpdateMigrationRequestVariables, signal?: AbortSignal) => Promise<undefined>;
|
7849
|
+
listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables, signal?: AbortSignal) => Promise<ListMigrationRequestsCommitsResponse>;
|
7850
|
+
compareMigrationRequest: (variables: CompareMigrationRequestVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
7851
|
+
getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables, signal?: AbortSignal) => Promise<GetMigrationRequestIsMergedResponse>;
|
7852
|
+
mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal) => Promise<BranchOp>;
|
6634
7853
|
};
|
6635
7854
|
files: {
|
6636
|
-
getFileItem: (variables: GetFileItemVariables, signal?: AbortSignal
|
6637
|
-
putFileItem: (variables: PutFileItemVariables, signal?: AbortSignal
|
6638
|
-
deleteFileItem: (variables: DeleteFileItemVariables, signal?: AbortSignal
|
6639
|
-
getFile: (variables: GetFileVariables, signal?: AbortSignal
|
6640
|
-
putFile: (variables: PutFileVariables, signal?: AbortSignal
|
6641
|
-
deleteFile: (variables: DeleteFileVariables, signal?: AbortSignal
|
6642
|
-
fileAccess: (variables: FileAccessVariables, signal?: AbortSignal
|
6643
|
-
fileUpload: (variables: FileUploadVariables, signal?: AbortSignal
|
7855
|
+
getFileItem: (variables: GetFileItemVariables, signal?: AbortSignal) => Promise<Blob>;
|
7856
|
+
putFileItem: (variables: PutFileItemVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
7857
|
+
deleteFileItem: (variables: DeleteFileItemVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
7858
|
+
getFile: (variables: GetFileVariables, signal?: AbortSignal) => Promise<Blob>;
|
7859
|
+
putFile: (variables: PutFileVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
7860
|
+
deleteFile: (variables: DeleteFileVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
7861
|
+
fileAccess: (variables: FileAccessVariables, signal?: AbortSignal) => Promise<Blob>;
|
7862
|
+
fileUpload: (variables: FileUploadVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
6644
7863
|
};
|
6645
7864
|
searchAndFilter: {
|
6646
|
-
queryTable: (variables: QueryTableVariables, signal?: AbortSignal
|
6647
|
-
searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal
|
6648
|
-
searchTable: (variables: SearchTableVariables, signal?: AbortSignal
|
6649
|
-
vectorSearchTable: (variables: VectorSearchTableVariables, signal?: AbortSignal
|
6650
|
-
askTable: (variables: AskTableVariables, signal?: AbortSignal
|
6651
|
-
askTableSession: (variables: AskTableSessionVariables, signal?: AbortSignal
|
6652
|
-
summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal
|
6653
|
-
aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal
|
7865
|
+
queryTable: (variables: QueryTableVariables, signal?: AbortSignal) => Promise<QueryResponse>;
|
7866
|
+
searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
7867
|
+
searchTable: (variables: SearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
7868
|
+
vectorSearchTable: (variables: VectorSearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
7869
|
+
askTable: (variables: AskTableVariables, signal?: AbortSignal) => Promise<AskTableResponse>;
|
7870
|
+
askTableSession: (variables: AskTableSessionVariables, signal?: AbortSignal) => Promise<AskTableSessionResponse>;
|
7871
|
+
summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal) => Promise<SummarizeResponse>;
|
7872
|
+
aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal) => Promise<AggResponse>;
|
6654
7873
|
};
|
6655
7874
|
sql: {
|
6656
|
-
sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal
|
7875
|
+
sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<SQLResponse$1>;
|
7876
|
+
sqlBatchQuery: (variables: SqlBatchQueryVariables, signal?: AbortSignal) => Promise<SQLBatchResponse>;
|
6657
7877
|
};
|
6658
7878
|
oAuth: {
|
6659
|
-
getAuthorizationCode: (variables: GetAuthorizationCodeVariables, signal?: AbortSignal
|
6660
|
-
grantAuthorizationCode: (variables: GrantAuthorizationCodeVariables, signal?: AbortSignal
|
6661
|
-
getUserOAuthClients: (variables:
|
6662
|
-
deleteUserOAuthClient: (variables: DeleteUserOAuthClientVariables, signal?: AbortSignal
|
6663
|
-
getUserOAuthAccessTokens: (variables:
|
6664
|
-
deleteOAuthAccessToken: (variables: DeleteOAuthAccessTokenVariables, signal?: AbortSignal
|
6665
|
-
updateOAuthAccessToken: (variables: UpdateOAuthAccessTokenVariables, signal?: AbortSignal
|
7879
|
+
getAuthorizationCode: (variables: GetAuthorizationCodeVariables, signal?: AbortSignal) => Promise<AuthorizationCodeResponse>;
|
7880
|
+
grantAuthorizationCode: (variables: GrantAuthorizationCodeVariables, signal?: AbortSignal) => Promise<AuthorizationCodeResponse>;
|
7881
|
+
getUserOAuthClients: (variables: GetUserOAuthClientsVariables, signal?: AbortSignal) => Promise<GetUserOAuthClientsResponse>;
|
7882
|
+
deleteUserOAuthClient: (variables: DeleteUserOAuthClientVariables, signal?: AbortSignal) => Promise<undefined>;
|
7883
|
+
getUserOAuthAccessTokens: (variables: GetUserOAuthAccessTokensVariables, signal?: AbortSignal) => Promise<GetUserOAuthAccessTokensResponse>;
|
7884
|
+
deleteOAuthAccessToken: (variables: DeleteOAuthAccessTokenVariables, signal?: AbortSignal) => Promise<undefined>;
|
7885
|
+
updateOAuthAccessToken: (variables: UpdateOAuthAccessTokenVariables, signal?: AbortSignal) => Promise<OAuthAccessToken>;
|
6666
7886
|
};
|
6667
7887
|
users: {
|
6668
|
-
getUser: (variables:
|
6669
|
-
updateUser: (variables: UpdateUserVariables, signal?: AbortSignal
|
6670
|
-
deleteUser: (variables:
|
7888
|
+
getUser: (variables: GetUserVariables, signal?: AbortSignal) => Promise<UserWithID>;
|
7889
|
+
updateUser: (variables: UpdateUserVariables, signal?: AbortSignal) => Promise<UserWithID>;
|
7890
|
+
deleteUser: (variables: DeleteUserVariables, signal?: AbortSignal) => Promise<undefined>;
|
6671
7891
|
};
|
6672
7892
|
authentication: {
|
6673
|
-
getUserAPIKeys: (variables:
|
6674
|
-
createUserAPIKey: (variables: CreateUserAPIKeyVariables, signal?: AbortSignal
|
6675
|
-
deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal
|
7893
|
+
getUserAPIKeys: (variables: GetUserAPIKeysVariables, signal?: AbortSignal) => Promise<GetUserAPIKeysResponse>;
|
7894
|
+
createUserAPIKey: (variables: CreateUserAPIKeyVariables, signal?: AbortSignal) => Promise<CreateUserAPIKeyResponse>;
|
7895
|
+
deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal) => Promise<undefined>;
|
6676
7896
|
};
|
6677
7897
|
invites: {
|
6678
|
-
inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables, signal?: AbortSignal
|
6679
|
-
updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables, signal?: AbortSignal
|
6680
|
-
cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables, signal?: AbortSignal
|
6681
|
-
acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables, signal?: AbortSignal
|
6682
|
-
resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal
|
7898
|
+
inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables, signal?: AbortSignal) => Promise<WorkspaceInvite>;
|
7899
|
+
updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<WorkspaceInvite>;
|
7900
|
+
cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
7901
|
+
acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
7902
|
+
resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
6683
7903
|
};
|
6684
7904
|
xbcontrolOther: {
|
6685
|
-
listClusters: (variables: ListClustersVariables, signal?: AbortSignal
|
6686
|
-
createCluster: (variables: CreateClusterVariables, signal?: AbortSignal
|
6687
|
-
getCluster: (variables: GetClusterVariables, signal?: AbortSignal
|
6688
|
-
updateCluster: (variables: UpdateClusterVariables, signal?: AbortSignal
|
7905
|
+
listClusters: (variables: ListClustersVariables, signal?: AbortSignal) => Promise<ListClustersResponse>;
|
7906
|
+
createCluster: (variables: CreateClusterVariables, signal?: AbortSignal) => Promise<ClusterResponse>;
|
7907
|
+
getCluster: (variables: GetClusterVariables, signal?: AbortSignal) => Promise<ClusterMetadata>;
|
7908
|
+
updateCluster: (variables: UpdateClusterVariables, signal?: AbortSignal) => Promise<ClusterUpdateMetadata>;
|
7909
|
+
deleteCluster: (variables: DeleteClusterVariables, signal?: AbortSignal) => Promise<ClusterDeleteMetadata>;
|
6689
7910
|
};
|
6690
7911
|
databases: {
|
6691
|
-
getDatabaseList: (variables: GetDatabaseListVariables, signal?: AbortSignal
|
6692
|
-
createDatabase: (variables: CreateDatabaseVariables, signal?: AbortSignal
|
6693
|
-
deleteDatabase: (variables: DeleteDatabaseVariables, signal?: AbortSignal
|
6694
|
-
getDatabaseMetadata: (variables: GetDatabaseMetadataVariables, signal?: AbortSignal
|
6695
|
-
updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal
|
6696
|
-
renameDatabase: (variables: RenameDatabaseVariables, signal?: AbortSignal
|
6697
|
-
getDatabaseGithubSettings: (variables: GetDatabaseGithubSettingsVariables, signal?: AbortSignal
|
6698
|
-
updateDatabaseGithubSettings: (variables: UpdateDatabaseGithubSettingsVariables, signal?: AbortSignal
|
6699
|
-
deleteDatabaseGithubSettings: (variables: DeleteDatabaseGithubSettingsVariables, signal?: AbortSignal
|
6700
|
-
listRegions: (variables: ListRegionsVariables, signal?: AbortSignal
|
7912
|
+
getDatabaseList: (variables: GetDatabaseListVariables, signal?: AbortSignal) => Promise<ListDatabasesResponse>;
|
7913
|
+
createDatabase: (variables: CreateDatabaseVariables, signal?: AbortSignal) => Promise<CreateDatabaseResponse>;
|
7914
|
+
deleteDatabase: (variables: DeleteDatabaseVariables, signal?: AbortSignal) => Promise<DeleteDatabaseResponse>;
|
7915
|
+
getDatabaseMetadata: (variables: GetDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
7916
|
+
updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
7917
|
+
renameDatabase: (variables: RenameDatabaseVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
7918
|
+
getDatabaseGithubSettings: (variables: GetDatabaseGithubSettingsVariables, signal?: AbortSignal) => Promise<DatabaseGithubSettings>;
|
7919
|
+
updateDatabaseGithubSettings: (variables: UpdateDatabaseGithubSettingsVariables, signal?: AbortSignal) => Promise<DatabaseGithubSettings>;
|
7920
|
+
deleteDatabaseGithubSettings: (variables: DeleteDatabaseGithubSettingsVariables, signal?: AbortSignal) => Promise<undefined>;
|
7921
|
+
listRegions: (variables: ListRegionsVariables, signal?: AbortSignal) => Promise<ListRegionsResponse>;
|
6701
7922
|
};
|
6702
7923
|
};
|
6703
7924
|
|
@@ -6715,9 +7936,32 @@ declare function buildProviderString(provider: HostProvider): string;
|
|
6715
7936
|
declare function parseWorkspacesUrlParts(url: string): {
|
6716
7937
|
workspace: string;
|
6717
7938
|
region: string;
|
7939
|
+
database: string;
|
7940
|
+
branch?: string;
|
6718
7941
|
host: HostAliases;
|
6719
7942
|
} | null;
|
6720
7943
|
|
7944
|
+
type ApiExtraProps = Omit<FetcherExtraProps, 'endpoint'>;
|
7945
|
+
interface XataApiClientOptions {
|
7946
|
+
fetch?: FetchImpl;
|
7947
|
+
apiKey?: string;
|
7948
|
+
host?: HostProvider;
|
7949
|
+
trace?: TraceFunction;
|
7950
|
+
clientName?: string;
|
7951
|
+
xataAgentExtra?: Record<string, string>;
|
7952
|
+
}
|
7953
|
+
type UserProps = {
|
7954
|
+
headers?: Record<string, unknown>;
|
7955
|
+
};
|
7956
|
+
type XataApiProxy = {
|
7957
|
+
[Tag in keyof typeof operationsByTag]: {
|
7958
|
+
[Method in keyof (typeof operationsByTag)[Tag]]: (typeof operationsByTag)[Tag][Method] extends infer Operation extends (...args: any) => any ? Omit<Parameters<Operation>[0], keyof ApiExtraProps> extends infer Params ? RequiredKeys<Params> extends never ? (params?: Params & UserProps) => ReturnType<Operation> : (params: Params & UserProps) => ReturnType<Operation> : never : never;
|
7959
|
+
};
|
7960
|
+
};
|
7961
|
+
declare const XataApiClient_base: new (options?: XataApiClientOptions) => XataApiProxy;
|
7962
|
+
declare class XataApiClient extends XataApiClient_base {
|
7963
|
+
}
|
7964
|
+
|
6721
7965
|
type responses_AggResponse = AggResponse;
|
6722
7966
|
type responses_BranchMigrationPlan = BranchMigrationPlan;
|
6723
7967
|
type responses_BulkError = BulkError;
|
@@ -6727,6 +7971,7 @@ type responses_QueryResponse = QueryResponse;
|
|
6727
7971
|
type responses_RateLimitError = RateLimitError;
|
6728
7972
|
type responses_RecordResponse = RecordResponse;
|
6729
7973
|
type responses_RecordUpdateResponse = RecordUpdateResponse;
|
7974
|
+
type responses_SQLBatchResponse = SQLBatchResponse;
|
6730
7975
|
type responses_SQLResponse = SQLResponse;
|
6731
7976
|
type responses_SchemaCompareResponse = SchemaCompareResponse;
|
6732
7977
|
type responses_SchemaUpdateResponse = SchemaUpdateResponse;
|
@@ -6734,29 +7979,37 @@ type responses_SearchResponse = SearchResponse;
|
|
6734
7979
|
type responses_ServiceUnavailableError = ServiceUnavailableError;
|
6735
7980
|
type responses_SummarizeResponse = SummarizeResponse;
|
6736
7981
|
declare namespace responses {
|
6737
|
-
export type { responses_AggResponse as AggResponse, AuthError$1 as AuthError, BadRequestError$1 as BadRequestError, responses_BranchMigrationPlan as BranchMigrationPlan, responses_BulkError as BulkError, responses_BulkInsertResponse as BulkInsertResponse, responses_PutFileResponse as PutFileResponse, responses_QueryResponse as QueryResponse, responses_RateLimitError as RateLimitError, responses_RecordResponse as RecordResponse, responses_RecordUpdateResponse as RecordUpdateResponse, responses_SQLResponse as SQLResponse, responses_SchemaCompareResponse as SchemaCompareResponse, responses_SchemaUpdateResponse as SchemaUpdateResponse, responses_SearchResponse as SearchResponse, responses_ServiceUnavailableError as ServiceUnavailableError, SimpleError$1 as SimpleError, responses_SummarizeResponse as SummarizeResponse };
|
7982
|
+
export type { responses_AggResponse as AggResponse, AuthError$1 as AuthError, BadRequestError$1 as BadRequestError, responses_BranchMigrationPlan as BranchMigrationPlan, responses_BulkError as BulkError, responses_BulkInsertResponse as BulkInsertResponse, responses_PutFileResponse as PutFileResponse, responses_QueryResponse as QueryResponse, responses_RateLimitError as RateLimitError, responses_RecordResponse as RecordResponse, responses_RecordUpdateResponse as RecordUpdateResponse, responses_SQLBatchResponse as SQLBatchResponse, responses_SQLResponse as SQLResponse, responses_SchemaCompareResponse as SchemaCompareResponse, responses_SchemaUpdateResponse as SchemaUpdateResponse, responses_SearchResponse as SearchResponse, responses_ServiceUnavailableError as ServiceUnavailableError, SimpleError$1 as SimpleError, responses_SummarizeResponse as SummarizeResponse };
|
6738
7983
|
}
|
6739
7984
|
|
6740
7985
|
type schemas_APIKeyName = APIKeyName;
|
6741
7986
|
type schemas_AccessToken = AccessToken;
|
6742
7987
|
type schemas_AggExpression = AggExpression;
|
6743
7988
|
type schemas_AggExpressionMap = AggExpressionMap;
|
7989
|
+
type schemas_ApplyMigrationResponse = ApplyMigrationResponse;
|
6744
7990
|
type schemas_AuthorizationCodeRequest = AuthorizationCodeRequest;
|
6745
7991
|
type schemas_AuthorizationCodeResponse = AuthorizationCodeResponse;
|
6746
7992
|
type schemas_AutoscalingConfig = AutoscalingConfig;
|
7993
|
+
type schemas_AutoscalingConfigResponse = AutoscalingConfigResponse;
|
6747
7994
|
type schemas_AverageAgg = AverageAgg;
|
6748
7995
|
type schemas_BoosterExpression = BoosterExpression;
|
6749
7996
|
type schemas_Branch = Branch;
|
7997
|
+
type schemas_BranchDetails = BranchDetails;
|
6750
7998
|
type schemas_BranchMigration = BranchMigration;
|
6751
7999
|
type schemas_BranchOp = BranchOp;
|
8000
|
+
type schemas_BranchSchema = BranchSchema;
|
8001
|
+
type schemas_BranchState = BranchState;
|
6752
8002
|
type schemas_BranchWithCopyID = BranchWithCopyID;
|
6753
8003
|
type schemas_ClusterConfiguration = ClusterConfiguration;
|
8004
|
+
type schemas_ClusterConfigurationResponse = ClusterConfigurationResponse;
|
6754
8005
|
type schemas_ClusterCreateDetails = ClusterCreateDetails;
|
6755
|
-
type
|
8006
|
+
type schemas_ClusterDeleteMetadata = ClusterDeleteMetadata;
|
8007
|
+
type schemas_ClusterExtensionInstallationResponse = ClusterExtensionInstallationResponse;
|
6756
8008
|
type schemas_ClusterMetadata = ClusterMetadata;
|
6757
8009
|
type schemas_ClusterResponse = ClusterResponse;
|
6758
8010
|
type schemas_ClusterShortMetadata = ClusterShortMetadata;
|
6759
8011
|
type schemas_ClusterUpdateDetails = ClusterUpdateDetails;
|
8012
|
+
type schemas_ClusterUpdateMetadata = ClusterUpdateMetadata;
|
6760
8013
|
type schemas_Column = Column;
|
6761
8014
|
type schemas_ColumnFile = ColumnFile;
|
6762
8015
|
type schemas_ColumnLink = ColumnLink;
|
@@ -6768,6 +8021,7 @@ type schemas_ColumnOpRename = ColumnOpRename;
|
|
6768
8021
|
type schemas_ColumnVector = ColumnVector;
|
6769
8022
|
type schemas_ColumnsProjection = ColumnsProjection;
|
6770
8023
|
type schemas_Commit = Commit;
|
8024
|
+
type schemas_CompleteMigrationResponse = CompleteMigrationResponse;
|
6771
8025
|
type schemas_CountAgg = CountAgg;
|
6772
8026
|
type schemas_DBBranch = DBBranch;
|
6773
8027
|
type schemas_DBBranchName = DBBranchName;
|
@@ -6775,7 +8029,9 @@ type schemas_DailyTimeWindow = DailyTimeWindow;
|
|
6775
8029
|
type schemas_DataInputRecord = DataInputRecord;
|
6776
8030
|
type schemas_DatabaseGithubSettings = DatabaseGithubSettings;
|
6777
8031
|
type schemas_DatabaseMetadata = DatabaseMetadata;
|
8032
|
+
type schemas_DatabaseSettings = DatabaseSettings;
|
6778
8033
|
type schemas_DateHistogramAgg = DateHistogramAgg;
|
8034
|
+
type schemas_ExtensionDetails = ExtensionDetails;
|
6779
8035
|
type schemas_FileAccessID = FileAccessID;
|
6780
8036
|
type schemas_FileItemID = FileItemID;
|
6781
8037
|
type schemas_FileName = FileName;
|
@@ -6791,6 +8047,7 @@ type schemas_FilterPredicateRangeOp = FilterPredicateRangeOp;
|
|
6791
8047
|
type schemas_FilterRangeValue = FilterRangeValue;
|
6792
8048
|
type schemas_FilterValue = FilterValue;
|
6793
8049
|
type schemas_FuzzinessExpression = FuzzinessExpression;
|
8050
|
+
type schemas_GetMigrationJobsResponse = GetMigrationJobsResponse;
|
6794
8051
|
type schemas_HighlightExpression = HighlightExpression;
|
6795
8052
|
type schemas_InputFile = InputFile;
|
6796
8053
|
type schemas_InputFileArray = InputFileArray;
|
@@ -6798,22 +8055,38 @@ type schemas_InputFileEntry = InputFileEntry;
|
|
6798
8055
|
type schemas_InviteID = InviteID;
|
6799
8056
|
type schemas_InviteKey = InviteKey;
|
6800
8057
|
type schemas_ListBranchesResponse = ListBranchesResponse;
|
8058
|
+
type schemas_ListClusterBranchesResponse = ListClusterBranchesResponse;
|
8059
|
+
type schemas_ListClusterExtensionsResponse = ListClusterExtensionsResponse;
|
6801
8060
|
type schemas_ListClustersResponse = ListClustersResponse;
|
6802
8061
|
type schemas_ListDatabasesResponse = ListDatabasesResponse;
|
6803
8062
|
type schemas_ListGitBranchesResponse = ListGitBranchesResponse;
|
6804
8063
|
type schemas_ListRegionsResponse = ListRegionsResponse;
|
6805
8064
|
type schemas_MaintenanceConfig = MaintenanceConfig;
|
8065
|
+
type schemas_MaintenanceConfigResponse = MaintenanceConfigResponse;
|
6806
8066
|
type schemas_MaxAgg = MaxAgg;
|
6807
8067
|
type schemas_MediaType = MediaType;
|
8068
|
+
type schemas_MetricData = MetricData;
|
8069
|
+
type schemas_MetricMessage = MetricMessage;
|
6808
8070
|
type schemas_MetricsDatapoint = MetricsDatapoint;
|
6809
8071
|
type schemas_MetricsLatency = MetricsLatency;
|
8072
|
+
type schemas_MetricsResponse = MetricsResponse;
|
6810
8073
|
type schemas_Migration = Migration;
|
6811
8074
|
type schemas_MigrationColumnOp = MigrationColumnOp;
|
8075
|
+
type schemas_MigrationDescription = MigrationDescription;
|
8076
|
+
type schemas_MigrationHistoryItem = MigrationHistoryItem;
|
8077
|
+
type schemas_MigrationHistoryResponse = MigrationHistoryResponse;
|
8078
|
+
type schemas_MigrationJobID = MigrationJobID;
|
8079
|
+
type schemas_MigrationJobItem = MigrationJobItem;
|
8080
|
+
type schemas_MigrationJobStatus = MigrationJobStatus;
|
8081
|
+
type schemas_MigrationJobStatusResponse = MigrationJobStatusResponse;
|
8082
|
+
type schemas_MigrationJobType = MigrationJobType;
|
6812
8083
|
type schemas_MigrationObject = MigrationObject;
|
6813
8084
|
type schemas_MigrationOp = MigrationOp;
|
8085
|
+
type schemas_MigrationOperationDescription = MigrationOperationDescription;
|
6814
8086
|
type schemas_MigrationRequest = MigrationRequest;
|
6815
8087
|
type schemas_MigrationRequestNumber = MigrationRequestNumber;
|
6816
8088
|
type schemas_MigrationTableOp = MigrationTableOp;
|
8089
|
+
type schemas_MigrationType = MigrationType;
|
6817
8090
|
type schemas_MinAgg = MinAgg;
|
6818
8091
|
type schemas_NumericHistogramAgg = NumericHistogramAgg;
|
6819
8092
|
type schemas_OAuthAccessToken = OAuthAccessToken;
|
@@ -6823,19 +8096,9 @@ type schemas_OAuthResponseType = OAuthResponseType;
|
|
6823
8096
|
type schemas_OAuthScope = OAuthScope;
|
6824
8097
|
type schemas_ObjectValue = ObjectValue;
|
6825
8098
|
type schemas_PageConfig = PageConfig;
|
6826
|
-
type schemas_PageResponse = PageResponse;
|
6827
|
-
type schemas_PageSize = PageSize;
|
6828
|
-
type schemas_PageToken = PageToken;
|
6829
8099
|
type schemas_PercentilesAgg = PercentilesAgg;
|
6830
|
-
type schemas_PgRollApplyMigrationResponse = PgRollApplyMigrationResponse;
|
6831
|
-
type schemas_PgRollJobStatus = PgRollJobStatus;
|
6832
|
-
type schemas_PgRollJobStatusResponse = PgRollJobStatusResponse;
|
6833
|
-
type schemas_PgRollJobType = PgRollJobType;
|
6834
|
-
type schemas_PgRollMigrationHistoryItem = PgRollMigrationHistoryItem;
|
6835
|
-
type schemas_PgRollMigrationHistoryResponse = PgRollMigrationHistoryResponse;
|
6836
|
-
type schemas_PgRollMigrationJobID = PgRollMigrationJobID;
|
6837
|
-
type schemas_PgRollMigrationType = PgRollMigrationType;
|
6838
8100
|
type schemas_PrefixExpression = PrefixExpression;
|
8101
|
+
type schemas_PreparedStatement = PreparedStatement;
|
6839
8102
|
type schemas_ProjectionConfig = ProjectionConfig;
|
6840
8103
|
type schemas_QueryColumnsProjection = QueryColumnsProjection;
|
6841
8104
|
type schemas_RecordID = RecordID;
|
@@ -6844,12 +8107,18 @@ type schemas_RecordsMetadata = RecordsMetadata;
|
|
6844
8107
|
type schemas_Region = Region;
|
6845
8108
|
type schemas_RevLink = RevLink;
|
6846
8109
|
type schemas_Role = Role;
|
8110
|
+
type schemas_RollbackMigrationResponse = RollbackMigrationResponse;
|
8111
|
+
type schemas_SQLConsistency = SQLConsistency;
|
6847
8112
|
type schemas_SQLRecord = SQLRecord;
|
8113
|
+
type schemas_SQLResponseArray = SQLResponseArray;
|
8114
|
+
type schemas_SQLResponseBase = SQLResponseBase;
|
8115
|
+
type schemas_SQLResponseJSON = SQLResponseJSON;
|
6848
8116
|
type schemas_Schema = Schema;
|
6849
8117
|
type schemas_SchemaEditScript = SchemaEditScript;
|
6850
8118
|
type schemas_SearchPageConfig = SearchPageConfig;
|
6851
8119
|
type schemas_SortExpression = SortExpression;
|
6852
8120
|
type schemas_SortOrder = SortOrder;
|
8121
|
+
type schemas_StartMigrationResponse = StartMigrationResponse;
|
6853
8122
|
type schemas_StartedFromMetadata = StartedFromMetadata;
|
6854
8123
|
type schemas_SumAgg = SumAgg;
|
6855
8124
|
type schemas_SummaryExpression = SummaryExpression;
|
@@ -6887,753 +8156,14 @@ type schemas_WorkspaceMember = WorkspaceMember;
|
|
6887
8156
|
type schemas_WorkspaceMembers = WorkspaceMembers;
|
6888
8157
|
type schemas_WorkspaceMeta = WorkspaceMeta;
|
6889
8158
|
type schemas_WorkspacePlan = WorkspacePlan;
|
8159
|
+
type schemas_WorkspaceSettings = WorkspaceSettings;
|
6890
8160
|
declare namespace schemas {
|
6891
|
-
export type { schemas_APIKeyName as APIKeyName, schemas_AccessToken as AccessToken, schemas_AggExpression as AggExpression, schemas_AggExpressionMap as AggExpressionMap, AggResponse$1 as AggResponse, schemas_AuthorizationCodeRequest as AuthorizationCodeRequest, schemas_AuthorizationCodeResponse as AuthorizationCodeResponse, schemas_AutoscalingConfig as AutoscalingConfig, schemas_AverageAgg as AverageAgg, schemas_BoosterExpression as BoosterExpression, schemas_Branch as Branch, BranchMetadata$1 as BranchMetadata, schemas_BranchMigration as BranchMigration, BranchName$1 as BranchName, schemas_BranchOp as BranchOp, schemas_BranchWithCopyID as BranchWithCopyID, schemas_ClusterConfiguration as ClusterConfiguration, schemas_ClusterCreateDetails as ClusterCreateDetails,
|
6892
|
-
}
|
6893
|
-
|
6894
|
-
|
6895
|
-
|
6896
|
-
|
6897
|
-
apiKey?: string;
|
6898
|
-
host?: HostProvider;
|
6899
|
-
trace?: TraceFunction;
|
6900
|
-
clientName?: string;
|
6901
|
-
xataAgentExtra?: Record<string, string>;
|
6902
|
-
}
|
6903
|
-
declare class XataApiClient {
|
6904
|
-
#private;
|
6905
|
-
constructor(options?: XataApiClientOptions);
|
6906
|
-
get user(): UserApi;
|
6907
|
-
get authentication(): AuthenticationApi;
|
6908
|
-
get workspaces(): WorkspaceApi;
|
6909
|
-
get invites(): InvitesApi;
|
6910
|
-
get database(): DatabaseApi;
|
6911
|
-
get branches(): BranchApi;
|
6912
|
-
get migrations(): MigrationsApi;
|
6913
|
-
get migrationRequests(): MigrationRequestsApi;
|
6914
|
-
get tables(): TableApi;
|
6915
|
-
get records(): RecordsApi;
|
6916
|
-
get files(): FilesApi;
|
6917
|
-
get searchAndFilter(): SearchAndFilterApi;
|
6918
|
-
}
|
6919
|
-
declare class UserApi {
|
6920
|
-
private extraProps;
|
6921
|
-
constructor(extraProps: ApiExtraProps);
|
6922
|
-
getUser(): Promise<UserWithID>;
|
6923
|
-
updateUser({ user }: {
|
6924
|
-
user: User;
|
6925
|
-
}): Promise<UserWithID>;
|
6926
|
-
deleteUser(): Promise<void>;
|
6927
|
-
}
|
6928
|
-
declare class AuthenticationApi {
|
6929
|
-
private extraProps;
|
6930
|
-
constructor(extraProps: ApiExtraProps);
|
6931
|
-
getUserAPIKeys(): Promise<GetUserAPIKeysResponse>;
|
6932
|
-
createUserAPIKey({ name }: {
|
6933
|
-
name: APIKeyName;
|
6934
|
-
}): Promise<CreateUserAPIKeyResponse>;
|
6935
|
-
deleteUserAPIKey({ name }: {
|
6936
|
-
name: APIKeyName;
|
6937
|
-
}): Promise<void>;
|
6938
|
-
}
|
6939
|
-
declare class WorkspaceApi {
|
6940
|
-
private extraProps;
|
6941
|
-
constructor(extraProps: ApiExtraProps);
|
6942
|
-
getWorkspacesList(): Promise<GetWorkspacesListResponse>;
|
6943
|
-
createWorkspace({ data }: {
|
6944
|
-
data: WorkspaceMeta;
|
6945
|
-
}): Promise<Workspace>;
|
6946
|
-
getWorkspace({ workspace }: {
|
6947
|
-
workspace: WorkspaceID;
|
6948
|
-
}): Promise<Workspace>;
|
6949
|
-
updateWorkspace({ workspace, update }: {
|
6950
|
-
workspace: WorkspaceID;
|
6951
|
-
update: WorkspaceMeta;
|
6952
|
-
}): Promise<Workspace>;
|
6953
|
-
deleteWorkspace({ workspace }: {
|
6954
|
-
workspace: WorkspaceID;
|
6955
|
-
}): Promise<void>;
|
6956
|
-
getWorkspaceMembersList({ workspace }: {
|
6957
|
-
workspace: WorkspaceID;
|
6958
|
-
}): Promise<WorkspaceMembers>;
|
6959
|
-
updateWorkspaceMemberRole({ workspace, user, role }: {
|
6960
|
-
workspace: WorkspaceID;
|
6961
|
-
user: UserID;
|
6962
|
-
role: Role;
|
6963
|
-
}): Promise<void>;
|
6964
|
-
removeWorkspaceMember({ workspace, user }: {
|
6965
|
-
workspace: WorkspaceID;
|
6966
|
-
user: UserID;
|
6967
|
-
}): Promise<void>;
|
6968
|
-
}
|
6969
|
-
declare class InvitesApi {
|
6970
|
-
private extraProps;
|
6971
|
-
constructor(extraProps: ApiExtraProps);
|
6972
|
-
inviteWorkspaceMember({ workspace, email, role }: {
|
6973
|
-
workspace: WorkspaceID;
|
6974
|
-
email: string;
|
6975
|
-
role: Role;
|
6976
|
-
}): Promise<WorkspaceInvite>;
|
6977
|
-
updateWorkspaceMemberInvite({ workspace, invite, role }: {
|
6978
|
-
workspace: WorkspaceID;
|
6979
|
-
invite: InviteID;
|
6980
|
-
role: Role;
|
6981
|
-
}): Promise<WorkspaceInvite>;
|
6982
|
-
cancelWorkspaceMemberInvite({ workspace, invite }: {
|
6983
|
-
workspace: WorkspaceID;
|
6984
|
-
invite: InviteID;
|
6985
|
-
}): Promise<void>;
|
6986
|
-
acceptWorkspaceMemberInvite({ workspace, key }: {
|
6987
|
-
workspace: WorkspaceID;
|
6988
|
-
key: InviteKey;
|
6989
|
-
}): Promise<void>;
|
6990
|
-
resendWorkspaceMemberInvite({ workspace, invite }: {
|
6991
|
-
workspace: WorkspaceID;
|
6992
|
-
invite: InviteID;
|
6993
|
-
}): Promise<void>;
|
6994
|
-
}
|
6995
|
-
declare class BranchApi {
|
6996
|
-
private extraProps;
|
6997
|
-
constructor(extraProps: ApiExtraProps);
|
6998
|
-
getBranchList({ workspace, region, database }: {
|
6999
|
-
workspace: WorkspaceID;
|
7000
|
-
region: string;
|
7001
|
-
database: DBName$1;
|
7002
|
-
}): Promise<ListBranchesResponse>;
|
7003
|
-
getBranchDetails({ workspace, region, database, branch }: {
|
7004
|
-
workspace: WorkspaceID;
|
7005
|
-
region: string;
|
7006
|
-
database: DBName$1;
|
7007
|
-
branch: BranchName$1;
|
7008
|
-
}): Promise<DBBranch>;
|
7009
|
-
createBranch({ workspace, region, database, branch, from, metadata }: {
|
7010
|
-
workspace: WorkspaceID;
|
7011
|
-
region: string;
|
7012
|
-
database: DBName$1;
|
7013
|
-
branch: BranchName$1;
|
7014
|
-
from?: string;
|
7015
|
-
metadata?: BranchMetadata$1;
|
7016
|
-
}): Promise<CreateBranchResponse>;
|
7017
|
-
deleteBranch({ workspace, region, database, branch }: {
|
7018
|
-
workspace: WorkspaceID;
|
7019
|
-
region: string;
|
7020
|
-
database: DBName$1;
|
7021
|
-
branch: BranchName$1;
|
7022
|
-
}): Promise<DeleteBranchResponse>;
|
7023
|
-
copyBranch({ workspace, region, database, branch, destinationBranch, limit }: {
|
7024
|
-
workspace: WorkspaceID;
|
7025
|
-
region: string;
|
7026
|
-
database: DBName$1;
|
7027
|
-
branch: BranchName$1;
|
7028
|
-
destinationBranch: BranchName$1;
|
7029
|
-
limit?: number;
|
7030
|
-
}): Promise<BranchWithCopyID>;
|
7031
|
-
updateBranchMetadata({ workspace, region, database, branch, metadata }: {
|
7032
|
-
workspace: WorkspaceID;
|
7033
|
-
region: string;
|
7034
|
-
database: DBName$1;
|
7035
|
-
branch: BranchName$1;
|
7036
|
-
metadata: BranchMetadata$1;
|
7037
|
-
}): Promise<void>;
|
7038
|
-
getBranchMetadata({ workspace, region, database, branch }: {
|
7039
|
-
workspace: WorkspaceID;
|
7040
|
-
region: string;
|
7041
|
-
database: DBName$1;
|
7042
|
-
branch: BranchName$1;
|
7043
|
-
}): Promise<BranchMetadata$1>;
|
7044
|
-
getBranchStats({ workspace, region, database, branch }: {
|
7045
|
-
workspace: WorkspaceID;
|
7046
|
-
region: string;
|
7047
|
-
database: DBName$1;
|
7048
|
-
branch: BranchName$1;
|
7049
|
-
}): Promise<GetBranchStatsResponse>;
|
7050
|
-
getGitBranchesMapping({ workspace, region, database }: {
|
7051
|
-
workspace: WorkspaceID;
|
7052
|
-
region: string;
|
7053
|
-
database: DBName$1;
|
7054
|
-
}): Promise<ListGitBranchesResponse>;
|
7055
|
-
addGitBranchesEntry({ workspace, region, database, gitBranch, xataBranch }: {
|
7056
|
-
workspace: WorkspaceID;
|
7057
|
-
region: string;
|
7058
|
-
database: DBName$1;
|
7059
|
-
gitBranch: string;
|
7060
|
-
xataBranch: BranchName$1;
|
7061
|
-
}): Promise<AddGitBranchesEntryResponse>;
|
7062
|
-
removeGitBranchesEntry({ workspace, region, database, gitBranch }: {
|
7063
|
-
workspace: WorkspaceID;
|
7064
|
-
region: string;
|
7065
|
-
database: DBName$1;
|
7066
|
-
gitBranch: string;
|
7067
|
-
}): Promise<void>;
|
7068
|
-
resolveBranch({ workspace, region, database, gitBranch, fallbackBranch }: {
|
7069
|
-
workspace: WorkspaceID;
|
7070
|
-
region: string;
|
7071
|
-
database: DBName$1;
|
7072
|
-
gitBranch?: string;
|
7073
|
-
fallbackBranch?: string;
|
7074
|
-
}): Promise<ResolveBranchResponse>;
|
7075
|
-
}
|
7076
|
-
declare class TableApi {
|
7077
|
-
private extraProps;
|
7078
|
-
constructor(extraProps: ApiExtraProps);
|
7079
|
-
createTable({ workspace, region, database, branch, table }: {
|
7080
|
-
workspace: WorkspaceID;
|
7081
|
-
region: string;
|
7082
|
-
database: DBName$1;
|
7083
|
-
branch: BranchName$1;
|
7084
|
-
table: TableName;
|
7085
|
-
}): Promise<CreateTableResponse>;
|
7086
|
-
deleteTable({ workspace, region, database, branch, table }: {
|
7087
|
-
workspace: WorkspaceID;
|
7088
|
-
region: string;
|
7089
|
-
database: DBName$1;
|
7090
|
-
branch: BranchName$1;
|
7091
|
-
table: TableName;
|
7092
|
-
}): Promise<DeleteTableResponse>;
|
7093
|
-
updateTable({ workspace, region, database, branch, table, update }: {
|
7094
|
-
workspace: WorkspaceID;
|
7095
|
-
region: string;
|
7096
|
-
database: DBName$1;
|
7097
|
-
branch: BranchName$1;
|
7098
|
-
table: TableName;
|
7099
|
-
update: UpdateTableRequestBody;
|
7100
|
-
}): Promise<SchemaUpdateResponse>;
|
7101
|
-
getTableSchema({ workspace, region, database, branch, table }: {
|
7102
|
-
workspace: WorkspaceID;
|
7103
|
-
region: string;
|
7104
|
-
database: DBName$1;
|
7105
|
-
branch: BranchName$1;
|
7106
|
-
table: TableName;
|
7107
|
-
}): Promise<GetTableSchemaResponse>;
|
7108
|
-
setTableSchema({ workspace, region, database, branch, table, schema }: {
|
7109
|
-
workspace: WorkspaceID;
|
7110
|
-
region: string;
|
7111
|
-
database: DBName$1;
|
7112
|
-
branch: BranchName$1;
|
7113
|
-
table: TableName;
|
7114
|
-
schema: SetTableSchemaRequestBody;
|
7115
|
-
}): Promise<SchemaUpdateResponse>;
|
7116
|
-
getTableColumns({ workspace, region, database, branch, table }: {
|
7117
|
-
workspace: WorkspaceID;
|
7118
|
-
region: string;
|
7119
|
-
database: DBName$1;
|
7120
|
-
branch: BranchName$1;
|
7121
|
-
table: TableName;
|
7122
|
-
}): Promise<GetTableColumnsResponse>;
|
7123
|
-
addTableColumn({ workspace, region, database, branch, table, column }: {
|
7124
|
-
workspace: WorkspaceID;
|
7125
|
-
region: string;
|
7126
|
-
database: DBName$1;
|
7127
|
-
branch: BranchName$1;
|
7128
|
-
table: TableName;
|
7129
|
-
column: Column;
|
7130
|
-
}): Promise<SchemaUpdateResponse>;
|
7131
|
-
getColumn({ workspace, region, database, branch, table, column }: {
|
7132
|
-
workspace: WorkspaceID;
|
7133
|
-
region: string;
|
7134
|
-
database: DBName$1;
|
7135
|
-
branch: BranchName$1;
|
7136
|
-
table: TableName;
|
7137
|
-
column: ColumnName;
|
7138
|
-
}): Promise<Column>;
|
7139
|
-
updateColumn({ workspace, region, database, branch, table, column, update }: {
|
7140
|
-
workspace: WorkspaceID;
|
7141
|
-
region: string;
|
7142
|
-
database: DBName$1;
|
7143
|
-
branch: BranchName$1;
|
7144
|
-
table: TableName;
|
7145
|
-
column: ColumnName;
|
7146
|
-
update: UpdateColumnRequestBody;
|
7147
|
-
}): Promise<SchemaUpdateResponse>;
|
7148
|
-
deleteColumn({ workspace, region, database, branch, table, column }: {
|
7149
|
-
workspace: WorkspaceID;
|
7150
|
-
region: string;
|
7151
|
-
database: DBName$1;
|
7152
|
-
branch: BranchName$1;
|
7153
|
-
table: TableName;
|
7154
|
-
column: ColumnName;
|
7155
|
-
}): Promise<SchemaUpdateResponse>;
|
7156
|
-
}
|
7157
|
-
declare class RecordsApi {
|
7158
|
-
private extraProps;
|
7159
|
-
constructor(extraProps: ApiExtraProps);
|
7160
|
-
insertRecord({ workspace, region, database, branch, table, record, columns }: {
|
7161
|
-
workspace: WorkspaceID;
|
7162
|
-
region: string;
|
7163
|
-
database: DBName$1;
|
7164
|
-
branch: BranchName$1;
|
7165
|
-
table: TableName;
|
7166
|
-
record: Record<string, any>;
|
7167
|
-
columns?: ColumnsProjection;
|
7168
|
-
}): Promise<RecordUpdateResponse>;
|
7169
|
-
getRecord({ workspace, region, database, branch, table, id, columns }: {
|
7170
|
-
workspace: WorkspaceID;
|
7171
|
-
region: string;
|
7172
|
-
database: DBName$1;
|
7173
|
-
branch: BranchName$1;
|
7174
|
-
table: TableName;
|
7175
|
-
id: RecordID;
|
7176
|
-
columns?: ColumnsProjection;
|
7177
|
-
}): Promise<XataRecord$1>;
|
7178
|
-
insertRecordWithID({ workspace, region, database, branch, table, id, record, columns, createOnly, ifVersion }: {
|
7179
|
-
workspace: WorkspaceID;
|
7180
|
-
region: string;
|
7181
|
-
database: DBName$1;
|
7182
|
-
branch: BranchName$1;
|
7183
|
-
table: TableName;
|
7184
|
-
id: RecordID;
|
7185
|
-
record: Record<string, any>;
|
7186
|
-
columns?: ColumnsProjection;
|
7187
|
-
createOnly?: boolean;
|
7188
|
-
ifVersion?: number;
|
7189
|
-
}): Promise<RecordUpdateResponse>;
|
7190
|
-
updateRecordWithID({ workspace, region, database, branch, table, id, record, columns, ifVersion }: {
|
7191
|
-
workspace: WorkspaceID;
|
7192
|
-
region: string;
|
7193
|
-
database: DBName$1;
|
7194
|
-
branch: BranchName$1;
|
7195
|
-
table: TableName;
|
7196
|
-
id: RecordID;
|
7197
|
-
record: Record<string, any>;
|
7198
|
-
columns?: ColumnsProjection;
|
7199
|
-
ifVersion?: number;
|
7200
|
-
}): Promise<RecordUpdateResponse>;
|
7201
|
-
upsertRecordWithID({ workspace, region, database, branch, table, id, record, columns, ifVersion }: {
|
7202
|
-
workspace: WorkspaceID;
|
7203
|
-
region: string;
|
7204
|
-
database: DBName$1;
|
7205
|
-
branch: BranchName$1;
|
7206
|
-
table: TableName;
|
7207
|
-
id: RecordID;
|
7208
|
-
record: Record<string, any>;
|
7209
|
-
columns?: ColumnsProjection;
|
7210
|
-
ifVersion?: number;
|
7211
|
-
}): Promise<RecordUpdateResponse>;
|
7212
|
-
deleteRecord({ workspace, region, database, branch, table, id, columns }: {
|
7213
|
-
workspace: WorkspaceID;
|
7214
|
-
region: string;
|
7215
|
-
database: DBName$1;
|
7216
|
-
branch: BranchName$1;
|
7217
|
-
table: TableName;
|
7218
|
-
id: RecordID;
|
7219
|
-
columns?: ColumnsProjection;
|
7220
|
-
}): Promise<RecordUpdateResponse>;
|
7221
|
-
bulkInsertTableRecords({ workspace, region, database, branch, table, records, columns }: {
|
7222
|
-
workspace: WorkspaceID;
|
7223
|
-
region: string;
|
7224
|
-
database: DBName$1;
|
7225
|
-
branch: BranchName$1;
|
7226
|
-
table: TableName;
|
7227
|
-
records: Record<string, any>[];
|
7228
|
-
columns?: ColumnsProjection;
|
7229
|
-
}): Promise<BulkInsertResponse>;
|
7230
|
-
branchTransaction({ workspace, region, database, branch, operations }: {
|
7231
|
-
workspace: WorkspaceID;
|
7232
|
-
region: string;
|
7233
|
-
database: DBName$1;
|
7234
|
-
branch: BranchName$1;
|
7235
|
-
operations: TransactionOperation$1[];
|
7236
|
-
}): Promise<TransactionSuccess>;
|
7237
|
-
}
|
7238
|
-
declare class FilesApi {
|
7239
|
-
private extraProps;
|
7240
|
-
constructor(extraProps: ApiExtraProps);
|
7241
|
-
getFileItem({ workspace, region, database, branch, table, record, column, fileId }: {
|
7242
|
-
workspace: WorkspaceID;
|
7243
|
-
region: string;
|
7244
|
-
database: DBName$1;
|
7245
|
-
branch: BranchName$1;
|
7246
|
-
table: TableName;
|
7247
|
-
record: RecordID;
|
7248
|
-
column: ColumnName;
|
7249
|
-
fileId: string;
|
7250
|
-
}): Promise<any>;
|
7251
|
-
putFileItem({ workspace, region, database, branch, table, record, column, fileId, file }: {
|
7252
|
-
workspace: WorkspaceID;
|
7253
|
-
region: string;
|
7254
|
-
database: DBName$1;
|
7255
|
-
branch: BranchName$1;
|
7256
|
-
table: TableName;
|
7257
|
-
record: RecordID;
|
7258
|
-
column: ColumnName;
|
7259
|
-
fileId: string;
|
7260
|
-
file: any;
|
7261
|
-
}): Promise<PutFileResponse>;
|
7262
|
-
deleteFileItem({ workspace, region, database, branch, table, record, column, fileId }: {
|
7263
|
-
workspace: WorkspaceID;
|
7264
|
-
region: string;
|
7265
|
-
database: DBName$1;
|
7266
|
-
branch: BranchName$1;
|
7267
|
-
table: TableName;
|
7268
|
-
record: RecordID;
|
7269
|
-
column: ColumnName;
|
7270
|
-
fileId: string;
|
7271
|
-
}): Promise<PutFileResponse>;
|
7272
|
-
getFile({ workspace, region, database, branch, table, record, column }: {
|
7273
|
-
workspace: WorkspaceID;
|
7274
|
-
region: string;
|
7275
|
-
database: DBName$1;
|
7276
|
-
branch: BranchName$1;
|
7277
|
-
table: TableName;
|
7278
|
-
record: RecordID;
|
7279
|
-
column: ColumnName;
|
7280
|
-
}): Promise<any>;
|
7281
|
-
putFile({ workspace, region, database, branch, table, record, column, file }: {
|
7282
|
-
workspace: WorkspaceID;
|
7283
|
-
region: string;
|
7284
|
-
database: DBName$1;
|
7285
|
-
branch: BranchName$1;
|
7286
|
-
table: TableName;
|
7287
|
-
record: RecordID;
|
7288
|
-
column: ColumnName;
|
7289
|
-
file: Blob;
|
7290
|
-
}): Promise<PutFileResponse>;
|
7291
|
-
deleteFile({ workspace, region, database, branch, table, record, column }: {
|
7292
|
-
workspace: WorkspaceID;
|
7293
|
-
region: string;
|
7294
|
-
database: DBName$1;
|
7295
|
-
branch: BranchName$1;
|
7296
|
-
table: TableName;
|
7297
|
-
record: RecordID;
|
7298
|
-
column: ColumnName;
|
7299
|
-
}): Promise<PutFileResponse>;
|
7300
|
-
fileAccess({ workspace, region, fileId, verify }: {
|
7301
|
-
workspace: WorkspaceID;
|
7302
|
-
region: string;
|
7303
|
-
fileId: string;
|
7304
|
-
verify?: FileSignature;
|
7305
|
-
}): Promise<any>;
|
7306
|
-
}
|
7307
|
-
declare class SearchAndFilterApi {
|
7308
|
-
private extraProps;
|
7309
|
-
constructor(extraProps: ApiExtraProps);
|
7310
|
-
queryTable({ workspace, region, database, branch, table, filter, sort, page, columns, consistency }: {
|
7311
|
-
workspace: WorkspaceID;
|
7312
|
-
region: string;
|
7313
|
-
database: DBName$1;
|
7314
|
-
branch: BranchName$1;
|
7315
|
-
table: TableName;
|
7316
|
-
filter?: FilterExpression;
|
7317
|
-
sort?: SortExpression;
|
7318
|
-
page?: PageConfig;
|
7319
|
-
columns?: ColumnsProjection;
|
7320
|
-
consistency?: 'strong' | 'eventual';
|
7321
|
-
}): Promise<QueryResponse>;
|
7322
|
-
searchTable({ workspace, region, database, branch, table, query, fuzziness, target, prefix, filter, highlight, boosters }: {
|
7323
|
-
workspace: WorkspaceID;
|
7324
|
-
region: string;
|
7325
|
-
database: DBName$1;
|
7326
|
-
branch: BranchName$1;
|
7327
|
-
table: TableName;
|
7328
|
-
query: string;
|
7329
|
-
fuzziness?: FuzzinessExpression;
|
7330
|
-
target?: TargetExpression;
|
7331
|
-
prefix?: PrefixExpression;
|
7332
|
-
filter?: FilterExpression;
|
7333
|
-
highlight?: HighlightExpression;
|
7334
|
-
boosters?: BoosterExpression[];
|
7335
|
-
}): Promise<SearchResponse>;
|
7336
|
-
searchBranch({ workspace, region, database, branch, tables, query, fuzziness, prefix, highlight }: {
|
7337
|
-
workspace: WorkspaceID;
|
7338
|
-
region: string;
|
7339
|
-
database: DBName$1;
|
7340
|
-
branch: BranchName$1;
|
7341
|
-
tables?: (string | {
|
7342
|
-
table: string;
|
7343
|
-
filter?: FilterExpression;
|
7344
|
-
target?: TargetExpression;
|
7345
|
-
boosters?: BoosterExpression[];
|
7346
|
-
})[];
|
7347
|
-
query: string;
|
7348
|
-
fuzziness?: FuzzinessExpression;
|
7349
|
-
prefix?: PrefixExpression;
|
7350
|
-
highlight?: HighlightExpression;
|
7351
|
-
}): Promise<SearchResponse>;
|
7352
|
-
vectorSearchTable({ workspace, region, database, branch, table, queryVector, column, similarityFunction, size, filter }: {
|
7353
|
-
workspace: WorkspaceID;
|
7354
|
-
region: string;
|
7355
|
-
database: DBName$1;
|
7356
|
-
branch: BranchName$1;
|
7357
|
-
table: TableName;
|
7358
|
-
queryVector: number[];
|
7359
|
-
column: string;
|
7360
|
-
similarityFunction?: string;
|
7361
|
-
size?: number;
|
7362
|
-
filter?: FilterExpression;
|
7363
|
-
}): Promise<SearchResponse>;
|
7364
|
-
askTable({ workspace, region, database, branch, table, options }: {
|
7365
|
-
workspace: WorkspaceID;
|
7366
|
-
region: string;
|
7367
|
-
database: DBName$1;
|
7368
|
-
branch: BranchName$1;
|
7369
|
-
table: TableName;
|
7370
|
-
options: AskTableRequestBody;
|
7371
|
-
}): Promise<AskTableResponse>;
|
7372
|
-
askTableSession({ workspace, region, database, branch, table, sessionId, message }: {
|
7373
|
-
workspace: WorkspaceID;
|
7374
|
-
region: string;
|
7375
|
-
database: DBName$1;
|
7376
|
-
branch: BranchName$1;
|
7377
|
-
table: TableName;
|
7378
|
-
sessionId: string;
|
7379
|
-
message: string;
|
7380
|
-
}): Promise<AskTableSessionResponse>;
|
7381
|
-
summarizeTable({ workspace, region, database, branch, table, filter, columns, summaries, sort, summariesFilter, page, consistency }: {
|
7382
|
-
workspace: WorkspaceID;
|
7383
|
-
region: string;
|
7384
|
-
database: DBName$1;
|
7385
|
-
branch: BranchName$1;
|
7386
|
-
table: TableName;
|
7387
|
-
filter?: FilterExpression;
|
7388
|
-
columns?: ColumnsProjection;
|
7389
|
-
summaries?: SummaryExpressionList;
|
7390
|
-
sort?: SortExpression;
|
7391
|
-
summariesFilter?: FilterExpression;
|
7392
|
-
page?: {
|
7393
|
-
size?: number;
|
7394
|
-
};
|
7395
|
-
consistency?: 'strong' | 'eventual';
|
7396
|
-
}): Promise<SummarizeResponse>;
|
7397
|
-
aggregateTable({ workspace, region, database, branch, table, filter, aggs }: {
|
7398
|
-
workspace: WorkspaceID;
|
7399
|
-
region: string;
|
7400
|
-
database: DBName$1;
|
7401
|
-
branch: BranchName$1;
|
7402
|
-
table: TableName;
|
7403
|
-
filter?: FilterExpression;
|
7404
|
-
aggs?: AggExpressionMap;
|
7405
|
-
}): Promise<AggResponse>;
|
7406
|
-
}
|
7407
|
-
declare class MigrationRequestsApi {
|
7408
|
-
private extraProps;
|
7409
|
-
constructor(extraProps: ApiExtraProps);
|
7410
|
-
queryMigrationRequests({ workspace, region, database, filter, sort, page, columns }: {
|
7411
|
-
workspace: WorkspaceID;
|
7412
|
-
region: string;
|
7413
|
-
database: DBName$1;
|
7414
|
-
filter?: FilterExpression;
|
7415
|
-
sort?: SortExpression;
|
7416
|
-
page?: PageConfig;
|
7417
|
-
columns?: ColumnsProjection;
|
7418
|
-
}): Promise<QueryMigrationRequestsResponse>;
|
7419
|
-
createMigrationRequest({ workspace, region, database, migration }: {
|
7420
|
-
workspace: WorkspaceID;
|
7421
|
-
region: string;
|
7422
|
-
database: DBName$1;
|
7423
|
-
migration: CreateMigrationRequestRequestBody;
|
7424
|
-
}): Promise<CreateMigrationRequestResponse>;
|
7425
|
-
getMigrationRequest({ workspace, region, database, migrationRequest }: {
|
7426
|
-
workspace: WorkspaceID;
|
7427
|
-
region: string;
|
7428
|
-
database: DBName$1;
|
7429
|
-
migrationRequest: MigrationRequestNumber;
|
7430
|
-
}): Promise<MigrationRequest>;
|
7431
|
-
updateMigrationRequest({ workspace, region, database, migrationRequest, update }: {
|
7432
|
-
workspace: WorkspaceID;
|
7433
|
-
region: string;
|
7434
|
-
database: DBName$1;
|
7435
|
-
migrationRequest: MigrationRequestNumber;
|
7436
|
-
update: UpdateMigrationRequestRequestBody;
|
7437
|
-
}): Promise<void>;
|
7438
|
-
listMigrationRequestsCommits({ workspace, region, database, migrationRequest, page }: {
|
7439
|
-
workspace: WorkspaceID;
|
7440
|
-
region: string;
|
7441
|
-
database: DBName$1;
|
7442
|
-
migrationRequest: MigrationRequestNumber;
|
7443
|
-
page?: {
|
7444
|
-
after?: string;
|
7445
|
-
before?: string;
|
7446
|
-
size?: number;
|
7447
|
-
};
|
7448
|
-
}): Promise<ListMigrationRequestsCommitsResponse>;
|
7449
|
-
compareMigrationRequest({ workspace, region, database, migrationRequest }: {
|
7450
|
-
workspace: WorkspaceID;
|
7451
|
-
region: string;
|
7452
|
-
database: DBName$1;
|
7453
|
-
migrationRequest: MigrationRequestNumber;
|
7454
|
-
}): Promise<SchemaCompareResponse>;
|
7455
|
-
getMigrationRequestIsMerged({ workspace, region, database, migrationRequest }: {
|
7456
|
-
workspace: WorkspaceID;
|
7457
|
-
region: string;
|
7458
|
-
database: DBName$1;
|
7459
|
-
migrationRequest: MigrationRequestNumber;
|
7460
|
-
}): Promise<GetMigrationRequestIsMergedResponse>;
|
7461
|
-
mergeMigrationRequest({ workspace, region, database, migrationRequest }: {
|
7462
|
-
workspace: WorkspaceID;
|
7463
|
-
region: string;
|
7464
|
-
database: DBName$1;
|
7465
|
-
migrationRequest: MigrationRequestNumber;
|
7466
|
-
}): Promise<BranchOp>;
|
7467
|
-
}
|
7468
|
-
declare class MigrationsApi {
|
7469
|
-
private extraProps;
|
7470
|
-
constructor(extraProps: ApiExtraProps);
|
7471
|
-
getBranchMigrationHistory({ workspace, region, database, branch, limit, startFrom }: {
|
7472
|
-
workspace: WorkspaceID;
|
7473
|
-
region: string;
|
7474
|
-
database: DBName$1;
|
7475
|
-
branch: BranchName$1;
|
7476
|
-
limit?: number;
|
7477
|
-
startFrom?: string;
|
7478
|
-
}): Promise<GetBranchMigrationHistoryResponse>;
|
7479
|
-
getBranchMigrationPlan({ workspace, region, database, branch, schema }: {
|
7480
|
-
workspace: WorkspaceID;
|
7481
|
-
region: string;
|
7482
|
-
database: DBName$1;
|
7483
|
-
branch: BranchName$1;
|
7484
|
-
schema: Schema;
|
7485
|
-
}): Promise<BranchMigrationPlan>;
|
7486
|
-
executeBranchMigrationPlan({ workspace, region, database, branch, plan }: {
|
7487
|
-
workspace: WorkspaceID;
|
7488
|
-
region: string;
|
7489
|
-
database: DBName$1;
|
7490
|
-
branch: BranchName$1;
|
7491
|
-
plan: ExecuteBranchMigrationPlanRequestBody;
|
7492
|
-
}): Promise<SchemaUpdateResponse>;
|
7493
|
-
getBranchSchemaHistory({ workspace, region, database, branch, page }: {
|
7494
|
-
workspace: WorkspaceID;
|
7495
|
-
region: string;
|
7496
|
-
database: DBName$1;
|
7497
|
-
branch: BranchName$1;
|
7498
|
-
page?: {
|
7499
|
-
after?: string;
|
7500
|
-
before?: string;
|
7501
|
-
size?: number;
|
7502
|
-
};
|
7503
|
-
}): Promise<GetBranchSchemaHistoryResponse>;
|
7504
|
-
compareBranchWithUserSchema({ workspace, region, database, branch, schema, schemaOperations, branchOperations }: {
|
7505
|
-
workspace: WorkspaceID;
|
7506
|
-
region: string;
|
7507
|
-
database: DBName$1;
|
7508
|
-
branch: BranchName$1;
|
7509
|
-
schema: Schema;
|
7510
|
-
schemaOperations?: MigrationOp[];
|
7511
|
-
branchOperations?: MigrationOp[];
|
7512
|
-
}): Promise<SchemaCompareResponse>;
|
7513
|
-
compareBranchSchemas({ workspace, region, database, branch, compare, sourceBranchOperations, targetBranchOperations }: {
|
7514
|
-
workspace: WorkspaceID;
|
7515
|
-
region: string;
|
7516
|
-
database: DBName$1;
|
7517
|
-
branch: BranchName$1;
|
7518
|
-
compare: BranchName$1;
|
7519
|
-
sourceBranchOperations?: MigrationOp[];
|
7520
|
-
targetBranchOperations?: MigrationOp[];
|
7521
|
-
}): Promise<SchemaCompareResponse>;
|
7522
|
-
updateBranchSchema({ workspace, region, database, branch, migration }: {
|
7523
|
-
workspace: WorkspaceID;
|
7524
|
-
region: string;
|
7525
|
-
database: DBName$1;
|
7526
|
-
branch: BranchName$1;
|
7527
|
-
migration: Migration;
|
7528
|
-
}): Promise<SchemaUpdateResponse>;
|
7529
|
-
previewBranchSchemaEdit({ workspace, region, database, branch, data }: {
|
7530
|
-
workspace: WorkspaceID;
|
7531
|
-
region: string;
|
7532
|
-
database: DBName$1;
|
7533
|
-
branch: BranchName$1;
|
7534
|
-
data: {
|
7535
|
-
edits?: SchemaEditScript;
|
7536
|
-
};
|
7537
|
-
}): Promise<PreviewBranchSchemaEditResponse>;
|
7538
|
-
applyBranchSchemaEdit({ workspace, region, database, branch, edits }: {
|
7539
|
-
workspace: WorkspaceID;
|
7540
|
-
region: string;
|
7541
|
-
database: DBName$1;
|
7542
|
-
branch: BranchName$1;
|
7543
|
-
edits: SchemaEditScript;
|
7544
|
-
}): Promise<SchemaUpdateResponse>;
|
7545
|
-
pushBranchMigrations({ workspace, region, database, branch, migrations }: {
|
7546
|
-
workspace: WorkspaceID;
|
7547
|
-
region: string;
|
7548
|
-
database: DBName$1;
|
7549
|
-
branch: BranchName$1;
|
7550
|
-
migrations: MigrationObject[];
|
7551
|
-
}): Promise<SchemaUpdateResponse>;
|
7552
|
-
}
|
7553
|
-
declare class DatabaseApi {
|
7554
|
-
private extraProps;
|
7555
|
-
constructor(extraProps: ApiExtraProps);
|
7556
|
-
getDatabaseList({ workspace }: {
|
7557
|
-
workspace: WorkspaceID;
|
7558
|
-
}): Promise<ListDatabasesResponse>;
|
7559
|
-
createDatabase({ workspace, database, data, headers }: {
|
7560
|
-
workspace: WorkspaceID;
|
7561
|
-
database: DBName$1;
|
7562
|
-
data: CreateDatabaseRequestBody;
|
7563
|
-
headers?: Record<string, string>;
|
7564
|
-
}): Promise<CreateDatabaseResponse>;
|
7565
|
-
deleteDatabase({ workspace, database }: {
|
7566
|
-
workspace: WorkspaceID;
|
7567
|
-
database: DBName$1;
|
7568
|
-
}): Promise<DeleteDatabaseResponse>;
|
7569
|
-
getDatabaseMetadata({ workspace, database }: {
|
7570
|
-
workspace: WorkspaceID;
|
7571
|
-
database: DBName$1;
|
7572
|
-
}): Promise<DatabaseMetadata>;
|
7573
|
-
updateDatabaseMetadata({ workspace, database, metadata }: {
|
7574
|
-
workspace: WorkspaceID;
|
7575
|
-
database: DBName$1;
|
7576
|
-
metadata: DatabaseMetadata;
|
7577
|
-
}): Promise<DatabaseMetadata>;
|
7578
|
-
renameDatabase({ workspace, database, newName }: {
|
7579
|
-
workspace: WorkspaceID;
|
7580
|
-
database: DBName$1;
|
7581
|
-
newName: DBName$1;
|
7582
|
-
}): Promise<DatabaseMetadata>;
|
7583
|
-
getDatabaseGithubSettings({ workspace, database }: {
|
7584
|
-
workspace: WorkspaceID;
|
7585
|
-
database: DBName$1;
|
7586
|
-
}): Promise<DatabaseGithubSettings>;
|
7587
|
-
updateDatabaseGithubSettings({ workspace, database, settings }: {
|
7588
|
-
workspace: WorkspaceID;
|
7589
|
-
database: DBName$1;
|
7590
|
-
settings: DatabaseGithubSettings;
|
7591
|
-
}): Promise<DatabaseGithubSettings>;
|
7592
|
-
deleteDatabaseGithubSettings({ workspace, database }: {
|
7593
|
-
workspace: WorkspaceID;
|
7594
|
-
database: DBName$1;
|
7595
|
-
}): Promise<void>;
|
7596
|
-
listRegions({ workspace }: {
|
7597
|
-
workspace: WorkspaceID;
|
7598
|
-
}): Promise<ListRegionsResponse>;
|
7599
|
-
}
|
7600
|
-
|
7601
|
-
declare class XataApiPlugin implements XataPlugin {
|
7602
|
-
build(options: XataPluginOptions): XataApiClient;
|
7603
|
-
}
|
7604
|
-
|
7605
|
-
type StringKeys<O> = Extract<keyof O, string>;
|
7606
|
-
type Values<O> = O[StringKeys<O>];
|
7607
|
-
type UnionToIntersection<T> = (T extends any ? (x: T) => any : never) extends (x: infer R) => any ? R : never;
|
7608
|
-
type If<Condition, Then, Else> = Condition extends true ? Then : Else;
|
7609
|
-
type IsObject<T> = T extends Record<string, any> ? true : false;
|
7610
|
-
type IsArray<T> = T extends Array<any> ? true : false;
|
7611
|
-
type RequiredBy<T, K extends keyof T> = T & {
|
7612
|
-
[P in K]-?: NonNullable<T[P]>;
|
7613
|
-
};
|
7614
|
-
type GetArrayInnerType<T extends readonly any[]> = T[number];
|
7615
|
-
type SingleOrArray<T> = T | T[];
|
7616
|
-
type Dictionary<T> = Record<string, T>;
|
7617
|
-
type OmitBy<T, K extends keyof T> = T extends any ? Omit<T, K> : never;
|
7618
|
-
type Without<T, U> = {
|
7619
|
-
[P in Exclude<keyof T, keyof U>]?: never;
|
7620
|
-
};
|
7621
|
-
type ExclusiveOr<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
|
7622
|
-
type Explode<T> = keyof T extends infer K ? K extends unknown ? {
|
7623
|
-
[I in keyof T]: I extends K ? T[I] : never;
|
7624
|
-
} : never : never;
|
7625
|
-
type AtMostOne<T> = Explode<Partial<T>>;
|
7626
|
-
type AtLeastOne<T, U = {
|
7627
|
-
[K in keyof T]: Pick<T, K>;
|
7628
|
-
}> = Partial<T> & U[keyof U];
|
7629
|
-
type ExactlyOne<T> = AtMostOne<T> & AtLeastOne<T>;
|
7630
|
-
type Fn = (...args: any[]) => any;
|
7631
|
-
type NarrowRaw<A> = (A extends [] ? [] : never) | (A extends Narrowable ? A : never) | {
|
7632
|
-
[K in keyof A]: A[K] extends Fn ? A[K] : NarrowRaw<A[K]>;
|
7633
|
-
};
|
7634
|
-
type Narrowable = string | number | bigint | boolean;
|
7635
|
-
type Try<A1, A2, Catch = never> = A1 extends A2 ? A1 : Catch;
|
7636
|
-
type Narrow<A> = Try<A, [], NarrowRaw<A>>;
|
8161
|
+
export type { schemas_APIKeyName as APIKeyName, schemas_AccessToken as AccessToken, schemas_AggExpression as AggExpression, schemas_AggExpressionMap as AggExpressionMap, AggResponse$1 as AggResponse, schemas_ApplyMigrationResponse as ApplyMigrationResponse, schemas_AuthorizationCodeRequest as AuthorizationCodeRequest, schemas_AuthorizationCodeResponse as AuthorizationCodeResponse, schemas_AutoscalingConfig as AutoscalingConfig, schemas_AutoscalingConfigResponse as AutoscalingConfigResponse, schemas_AverageAgg as AverageAgg, schemas_BoosterExpression as BoosterExpression, schemas_Branch as Branch, schemas_BranchDetails as BranchDetails, BranchMetadata$1 as BranchMetadata, schemas_BranchMigration as BranchMigration, BranchName$1 as BranchName, schemas_BranchOp as BranchOp, schemas_BranchSchema as BranchSchema, schemas_BranchState as BranchState, schemas_BranchWithCopyID as BranchWithCopyID, schemas_ClusterConfiguration as ClusterConfiguration, schemas_ClusterConfigurationResponse as ClusterConfigurationResponse, schemas_ClusterCreateDetails as ClusterCreateDetails, schemas_ClusterDeleteMetadata as ClusterDeleteMetadata, schemas_ClusterExtensionInstallationResponse as ClusterExtensionInstallationResponse, ClusterID$1 as ClusterID, schemas_ClusterMetadata as ClusterMetadata, schemas_ClusterResponse as ClusterResponse, schemas_ClusterShortMetadata as ClusterShortMetadata, schemas_ClusterUpdateDetails as ClusterUpdateDetails, schemas_ClusterUpdateMetadata as ClusterUpdateMetadata, schemas_Column as Column, schemas_ColumnFile as ColumnFile, schemas_ColumnLink as ColumnLink, schemas_ColumnMigration as ColumnMigration, schemas_ColumnName as ColumnName, schemas_ColumnOpAdd as ColumnOpAdd, schemas_ColumnOpRemove as ColumnOpRemove, schemas_ColumnOpRename as ColumnOpRename, schemas_ColumnVector as ColumnVector, schemas_ColumnsProjection as ColumnsProjection, schemas_Commit as Commit, schemas_CompleteMigrationResponse as CompleteMigrationResponse, schemas_CountAgg as CountAgg, schemas_DBBranch as DBBranch, schemas_DBBranchName as DBBranchName, DBName$1 as DBName, schemas_DailyTimeWindow as DailyTimeWindow, schemas_DataInputRecord as DataInputRecord, schemas_DatabaseGithubSettings as DatabaseGithubSettings, schemas_DatabaseMetadata as DatabaseMetadata, schemas_DatabaseSettings as DatabaseSettings, DateBooster$1 as DateBooster, schemas_DateHistogramAgg as DateHistogramAgg, DateTime$1 as DateTime, schemas_ExtensionDetails as ExtensionDetails, schemas_FileAccessID as FileAccessID, schemas_FileItemID as FileItemID, schemas_FileName as FileName, schemas_FileResponse as FileResponse, schemas_FileSignature as FileSignature, schemas_FilterColumn as FilterColumn, schemas_FilterColumnIncludes as FilterColumnIncludes, schemas_FilterExpression as FilterExpression, schemas_FilterList as FilterList, schemas_FilterPredicate as FilterPredicate, schemas_FilterPredicateOp as FilterPredicateOp, schemas_FilterPredicateRangeOp as FilterPredicateRangeOp, schemas_FilterRangeValue as FilterRangeValue, schemas_FilterValue as FilterValue, schemas_FuzzinessExpression as FuzzinessExpression, schemas_GetMigrationJobsResponse as GetMigrationJobsResponse, schemas_HighlightExpression as HighlightExpression, schemas_InputFile as InputFile, schemas_InputFileArray as InputFileArray, schemas_InputFileEntry as InputFileEntry, schemas_InviteID as InviteID, schemas_InviteKey as InviteKey, schemas_ListBranchesResponse as ListBranchesResponse, schemas_ListClusterBranchesResponse as ListClusterBranchesResponse, schemas_ListClusterExtensionsResponse as ListClusterExtensionsResponse, schemas_ListClustersResponse as ListClustersResponse, schemas_ListDatabasesResponse as ListDatabasesResponse, schemas_ListGitBranchesResponse as ListGitBranchesResponse, schemas_ListRegionsResponse as ListRegionsResponse, schemas_MaintenanceConfig as MaintenanceConfig, schemas_MaintenanceConfigResponse as MaintenanceConfigResponse, schemas_MaxAgg as MaxAgg, schemas_MediaType as MediaType, schemas_MetricData as MetricData, schemas_MetricMessage as MetricMessage, schemas_MetricsDatapoint as MetricsDatapoint, schemas_MetricsLatency as MetricsLatency, schemas_MetricsResponse as MetricsResponse, schemas_Migration as Migration, schemas_MigrationColumnOp as MigrationColumnOp, schemas_MigrationDescription as MigrationDescription, schemas_MigrationHistoryItem as MigrationHistoryItem, schemas_MigrationHistoryResponse as MigrationHistoryResponse, schemas_MigrationJobID as MigrationJobID, schemas_MigrationJobItem as MigrationJobItem, schemas_MigrationJobStatus as MigrationJobStatus, schemas_MigrationJobStatusResponse as MigrationJobStatusResponse, schemas_MigrationJobType as MigrationJobType, schemas_MigrationObject as MigrationObject, schemas_MigrationOp as MigrationOp, schemas_MigrationOperationDescription as MigrationOperationDescription, schemas_MigrationRequest as MigrationRequest, schemas_MigrationRequestNumber as MigrationRequestNumber, MigrationStatus$1 as MigrationStatus, schemas_MigrationTableOp as MigrationTableOp, schemas_MigrationType as MigrationType, schemas_MinAgg as MinAgg, NumericBooster$1 as NumericBooster, schemas_NumericHistogramAgg as NumericHistogramAgg, schemas_OAuthAccessToken as OAuthAccessToken, schemas_OAuthClientID as OAuthClientID, schemas_OAuthClientPublicDetails as OAuthClientPublicDetails, schemas_OAuthResponseType as OAuthResponseType, schemas_OAuthScope as OAuthScope, schemas_ObjectValue as ObjectValue, schemas_PageConfig as PageConfig, PageResponse$1 as PageResponse, PageSize$1 as PageSize, PageToken$1 as PageToken, schemas_PercentilesAgg as PercentilesAgg, schemas_PrefixExpression as PrefixExpression, schemas_PreparedStatement as PreparedStatement, schemas_ProjectionConfig as ProjectionConfig, schemas_QueryColumnsProjection as QueryColumnsProjection, schemas_RecordID as RecordID, schemas_RecordMeta as RecordMeta, schemas_RecordsMetadata as RecordsMetadata, schemas_Region as Region, schemas_RevLink as RevLink, schemas_Role as Role, schemas_RollbackMigrationResponse as RollbackMigrationResponse, schemas_SQLConsistency as SQLConsistency, schemas_SQLRecord as SQLRecord, SQLResponse$1 as SQLResponse, schemas_SQLResponseArray as SQLResponseArray, schemas_SQLResponseBase as SQLResponseBase, schemas_SQLResponseJSON as SQLResponseJSON, SQLResponseType$1 as SQLResponseType, schemas_Schema as Schema, schemas_SchemaEditScript as SchemaEditScript, schemas_SearchPageConfig as SearchPageConfig, schemas_SortExpression as SortExpression, schemas_SortOrder as SortOrder, schemas_StartMigrationResponse as StartMigrationResponse, schemas_StartedFromMetadata as StartedFromMetadata, schemas_SumAgg as SumAgg, schemas_SummaryExpression as SummaryExpression, schemas_SummaryExpressionList as SummaryExpressionList, schemas_Table as Table, schemas_TableMigration as TableMigration, schemas_TableName as TableName, schemas_TableOpAdd as TableOpAdd, schemas_TableOpRemove as TableOpRemove, schemas_TableOpRename as TableOpRename, schemas_TableRename as TableRename, schemas_TargetExpression as TargetExpression, schemas_TopValuesAgg as TopValuesAgg, schemas_TransactionDeleteOp as TransactionDeleteOp, schemas_TransactionError as TransactionError, schemas_TransactionFailure as TransactionFailure, schemas_TransactionGetOp as TransactionGetOp, schemas_TransactionInsertOp as TransactionInsertOp, TransactionOperation$1 as TransactionOperation, schemas_TransactionResultColumns as TransactionResultColumns, schemas_TransactionResultDelete as TransactionResultDelete, schemas_TransactionResultGet as TransactionResultGet, schemas_TransactionResultInsert as TransactionResultInsert, schemas_TransactionResultUpdate as TransactionResultUpdate, schemas_TransactionSuccess as TransactionSuccess, schemas_TransactionUpdateOp as TransactionUpdateOp, schemas_UniqueCountAgg as UniqueCountAgg, schemas_User as User, schemas_UserID as UserID, schemas_UserWithID as UserWithID, ValueBooster$1 as ValueBooster, schemas_WeeklyTimeWindow as WeeklyTimeWindow, schemas_Workspace as Workspace, schemas_WorkspaceID as WorkspaceID, schemas_WorkspaceInvite as WorkspaceInvite, schemas_WorkspaceMember as WorkspaceMember, schemas_WorkspaceMembers as WorkspaceMembers, schemas_WorkspaceMeta as WorkspaceMeta, schemas_WorkspacePlan as WorkspacePlan, schemas_WorkspaceSettings as WorkspaceSettings, XataRecord$1 as XataRecord };
|
8162
|
+
}
|
8163
|
+
|
8164
|
+
declare class XataApiPlugin implements XataPlugin {
|
8165
|
+
build(options: XataPluginOptions): XataApiClient;
|
8166
|
+
}
|
7637
8167
|
|
7638
8168
|
interface ImageTransformations {
|
7639
8169
|
/**
|
@@ -7800,6 +8330,580 @@ interface ImageTransformations {
|
|
7800
8330
|
declare function transformImage(url: string, ...transformations: ImageTransformations[]): string;
|
7801
8331
|
declare function transformImage(url: string | undefined, ...transformations: ImageTransformations[]): string | undefined;
|
7802
8332
|
|
8333
|
+
declare class Buffer extends Uint8Array {
|
8334
|
+
/**
|
8335
|
+
* Allocates a new buffer containing the given `str`.
|
8336
|
+
*
|
8337
|
+
* @param str String to store in buffer.
|
8338
|
+
* @param encoding Encoding to use, optional. Default is `utf8`.
|
8339
|
+
*/
|
8340
|
+
constructor(str: string, encoding?: Encoding);
|
8341
|
+
/**
|
8342
|
+
* Allocates a new buffer of `size` octets.
|
8343
|
+
*
|
8344
|
+
* @param size Count of octets to allocate.
|
8345
|
+
*/
|
8346
|
+
constructor(size: number);
|
8347
|
+
/**
|
8348
|
+
* Allocates a new buffer containing the given `array` of octets.
|
8349
|
+
*
|
8350
|
+
* @param array The octets to store.
|
8351
|
+
*/
|
8352
|
+
constructor(array: Uint8Array);
|
8353
|
+
/**
|
8354
|
+
* Allocates a new buffer containing the given `array` of octet values.
|
8355
|
+
*
|
8356
|
+
* @param array
|
8357
|
+
*/
|
8358
|
+
constructor(array: number[]);
|
8359
|
+
/**
|
8360
|
+
* Allocates a new buffer containing the given `array` of octet values.
|
8361
|
+
*
|
8362
|
+
* @param array
|
8363
|
+
* @param encoding
|
8364
|
+
*/
|
8365
|
+
constructor(array: number[], encoding: Encoding);
|
8366
|
+
/**
|
8367
|
+
* Copies the passed `buffer` data onto a new `Buffer` instance.
|
8368
|
+
*
|
8369
|
+
* @param buffer
|
8370
|
+
*/
|
8371
|
+
constructor(buffer: Buffer);
|
8372
|
+
/**
|
8373
|
+
* When passed a reference to the .buffer property of a TypedArray instance, the newly created Buffer will share
|
8374
|
+
* the same allocated memory as the TypedArray. The optional `byteOffset` and `length` arguments specify a memory
|
8375
|
+
* range within the `arrayBuffer` that will be shared by the Buffer.
|
8376
|
+
*
|
8377
|
+
* @param buffer The .buffer property of a TypedArray or a new ArrayBuffer().
|
8378
|
+
* @param byteOffset
|
8379
|
+
* @param length
|
8380
|
+
*/
|
8381
|
+
constructor(buffer: ArrayBuffer, byteOffset?: number, length?: number);
|
8382
|
+
/**
|
8383
|
+
* Return JSON representation of the buffer.
|
8384
|
+
*/
|
8385
|
+
toJSON(): {
|
8386
|
+
type: 'Buffer';
|
8387
|
+
data: number[];
|
8388
|
+
};
|
8389
|
+
/**
|
8390
|
+
* Writes `string` to the buffer at `offset` according to the character encoding in `encoding`. The `length`
|
8391
|
+
* parameter is the number of bytes to write. If the buffer does not contain enough space to fit the entire string,
|
8392
|
+
* only part of `string` will be written. However, partially encoded characters will not be written.
|
8393
|
+
*
|
8394
|
+
* @param string String to write to `buf`.
|
8395
|
+
* @param encoding The character encoding of `string`. Default: `utf8`.
|
8396
|
+
*/
|
8397
|
+
write(string: string, encoding?: Encoding): number;
|
8398
|
+
/**
|
8399
|
+
* Writes `string` to the buffer at `offset` according to the character encoding in `encoding`. The `length`
|
8400
|
+
* parameter is the number of bytes to write. If the buffer does not contain enough space to fit the entire string,
|
8401
|
+
* only part of `string` will be written. However, partially encoded characters will not be written.
|
8402
|
+
*
|
8403
|
+
* @param string String to write to `buf`.
|
8404
|
+
* @param offset Number of bytes to skip before starting to write `string`. Default: `0`.
|
8405
|
+
* @param length Maximum number of bytes to write: Default: `buf.length - offset`.
|
8406
|
+
* @param encoding The character encoding of `string`. Default: `utf8`.
|
8407
|
+
*/
|
8408
|
+
write(string: string, offset?: number, length?: number, encoding?: Encoding): number;
|
8409
|
+
/**
|
8410
|
+
* Decodes the buffer to a string according to the specified character encoding.
|
8411
|
+
* Passing `start` and `end` will decode only a subset of the buffer.
|
8412
|
+
*
|
8413
|
+
* Note that if the encoding is `utf8` and a byte sequence in the input is not valid UTF-8, then each invalid byte
|
8414
|
+
* will be replaced with `U+FFFD`.
|
8415
|
+
*
|
8416
|
+
* @param encoding
|
8417
|
+
* @param start
|
8418
|
+
* @param end
|
8419
|
+
*/
|
8420
|
+
toString(encoding?: Encoding, start?: number, end?: number): string;
|
8421
|
+
/**
|
8422
|
+
* Returns true if this buffer's is equal to the provided buffer, meaning they share the same exact data.
|
8423
|
+
*
|
8424
|
+
* @param otherBuffer
|
8425
|
+
*/
|
8426
|
+
equals(otherBuffer: Buffer): boolean;
|
8427
|
+
/**
|
8428
|
+
* Compares the buffer with `otherBuffer` and returns a number indicating whether the buffer comes before, after,
|
8429
|
+
* or is the same as `otherBuffer` in sort order. Comparison is based on the actual sequence of bytes in each
|
8430
|
+
* buffer.
|
8431
|
+
*
|
8432
|
+
* - `0` is returned if `otherBuffer` is the same as this buffer.
|
8433
|
+
* - `1` is returned if `otherBuffer` should come before this buffer when sorted.
|
8434
|
+
* - `-1` is returned if `otherBuffer` should come after this buffer when sorted.
|
8435
|
+
*
|
8436
|
+
* @param otherBuffer The buffer to compare to.
|
8437
|
+
* @param targetStart The offset within `otherBuffer` at which to begin comparison.
|
8438
|
+
* @param targetEnd The offset within `otherBuffer` at which to end comparison (exclusive).
|
8439
|
+
* @param sourceStart The offset within this buffer at which to begin comparison.
|
8440
|
+
* @param sourceEnd The offset within this buffer at which to end the comparison (exclusive).
|
8441
|
+
*/
|
8442
|
+
compare(otherBuffer: Uint8Array, targetStart?: number, targetEnd?: number, sourceStart?: number, sourceEnd?: number): number;
|
8443
|
+
/**
|
8444
|
+
* Copies data from a region of this buffer to a region in `targetBuffer`, even if the `targetBuffer` memory
|
8445
|
+
* region overlaps with this buffer.
|
8446
|
+
*
|
8447
|
+
* @param targetBuffer The target buffer to copy into.
|
8448
|
+
* @param targetStart The offset within `targetBuffer` at which to begin writing.
|
8449
|
+
* @param sourceStart The offset within this buffer at which to begin copying.
|
8450
|
+
* @param sourceEnd The offset within this buffer at which to end copying (exclusive).
|
8451
|
+
*/
|
8452
|
+
copy(targetBuffer: Uint8Array, targetStart?: number, sourceStart?: number, sourceEnd?: number): number;
|
8453
|
+
/**
|
8454
|
+
* Returns a new `Buffer` that references the same memory as the original, but offset and cropped by the `start`
|
8455
|
+
* and `end` indices. This is the same behavior as `buf.subarray()`.
|
8456
|
+
*
|
8457
|
+
* This method is not compatible with the `Uint8Array.prototype.slice()`, which is a superclass of Buffer. To copy
|
8458
|
+
* the slice, use `Uint8Array.prototype.slice()`.
|
8459
|
+
*
|
8460
|
+
* @param start
|
8461
|
+
* @param end
|
8462
|
+
*/
|
8463
|
+
slice(start?: number, end?: number): Buffer;
|
8464
|
+
/**
|
8465
|
+
* Writes `byteLength` bytes of `value` to `buf` at the specified `offset` as little-endian. Supports up to 48 bits
|
8466
|
+
* of accuracy. Behavior is undefined when value is anything other than an unsigned integer.
|
8467
|
+
*
|
8468
|
+
* @param value Number to write.
|
8469
|
+
* @param offset Number of bytes to skip before starting to write.
|
8470
|
+
* @param byteLength Number of bytes to write, between 0 and 6.
|
8471
|
+
* @param noAssert
|
8472
|
+
* @returns `offset` plus the number of bytes written.
|
8473
|
+
*/
|
8474
|
+
writeUIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
|
8475
|
+
/**
|
8476
|
+
* Writes `byteLength` bytes of `value` to `buf` at the specified `offset` as big-endian. Supports up to 48 bits of
|
8477
|
+
* accuracy. Behavior is undefined when `value` is anything other than an unsigned integer.
|
8478
|
+
*
|
8479
|
+
* @param value Number to write.
|
8480
|
+
* @param offset Number of bytes to skip before starting to write.
|
8481
|
+
* @param byteLength Number of bytes to write, between 0 and 6.
|
8482
|
+
* @param noAssert
|
8483
|
+
* @returns `offset` plus the number of bytes written.
|
8484
|
+
*/
|
8485
|
+
writeUIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
|
8486
|
+
/**
|
8487
|
+
* Writes `byteLength` bytes of `value` to `buf` at the specified `offset` as little-endian. Supports up to 48 bits
|
8488
|
+
* of accuracy. Behavior is undefined when `value` is anything other than a signed integer.
|
8489
|
+
*
|
8490
|
+
* @param value Number to write.
|
8491
|
+
* @param offset Number of bytes to skip before starting to write.
|
8492
|
+
* @param byteLength Number of bytes to write, between 0 and 6.
|
8493
|
+
* @param noAssert
|
8494
|
+
* @returns `offset` plus the number of bytes written.
|
8495
|
+
*/
|
8496
|
+
writeIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
|
8497
|
+
/**
|
8498
|
+
* Writes `byteLength` bytes of `value` to `buf` at the specified `offset` as big-endian. Supports up to 48 bits
|
8499
|
+
* of accuracy. Behavior is undefined when `value` is anything other than a signed integer.
|
8500
|
+
*
|
8501
|
+
* @param value Number to write.
|
8502
|
+
* @param offset Number of bytes to skip before starting to write.
|
8503
|
+
* @param byteLength Number of bytes to write, between 0 and 6.
|
8504
|
+
* @param noAssert
|
8505
|
+
* @returns `offset` plus the number of bytes written.
|
8506
|
+
*/
|
8507
|
+
writeIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
|
8508
|
+
/**
|
8509
|
+
* Reads `byteLength` number of bytes from `buf` at the specified `offset` and interprets the result as an
|
8510
|
+
* unsigned, little-endian integer supporting up to 48 bits of accuracy.
|
8511
|
+
*
|
8512
|
+
* @param offset Number of bytes to skip before starting to read.
|
8513
|
+
* @param byteLength Number of bytes to read, between 0 and 6.
|
8514
|
+
* @param noAssert
|
8515
|
+
*/
|
8516
|
+
readUIntLE(offset: number, byteLength: number, noAssert?: boolean): number;
|
8517
|
+
/**
|
8518
|
+
* Reads `byteLength` number of bytes from `buf` at the specified `offset` and interprets the result as an
|
8519
|
+
* unsigned, big-endian integer supporting up to 48 bits of accuracy.
|
8520
|
+
*
|
8521
|
+
* @param offset Number of bytes to skip before starting to read.
|
8522
|
+
* @param byteLength Number of bytes to read, between 0 and 6.
|
8523
|
+
* @param noAssert
|
8524
|
+
*/
|
8525
|
+
readUIntBE(offset: number, byteLength: number, noAssert?: boolean): number;
|
8526
|
+
/**
|
8527
|
+
* Reads `byteLength` number of bytes from `buf` at the specified `offset` and interprets the result as a
|
8528
|
+
* little-endian, two's complement signed value supporting up to 48 bits of accuracy.
|
8529
|
+
*
|
8530
|
+
* @param offset Number of bytes to skip before starting to read.
|
8531
|
+
* @param byteLength Number of bytes to read, between 0 and 6.
|
8532
|
+
* @param noAssert
|
8533
|
+
*/
|
8534
|
+
readIntLE(offset: number, byteLength: number, noAssert?: boolean): number;
|
8535
|
+
/**
|
8536
|
+
* Reads `byteLength` number of bytes from `buf` at the specified `offset` and interprets the result as a
|
8537
|
+
* big-endian, two's complement signed value supporting up to 48 bits of accuracy.
|
8538
|
+
*
|
8539
|
+
* @param offset Number of bytes to skip before starting to read.
|
8540
|
+
* @param byteLength Number of bytes to read, between 0 and 6.
|
8541
|
+
* @param noAssert
|
8542
|
+
*/
|
8543
|
+
readIntBE(offset: number, byteLength: number, noAssert?: boolean): number;
|
8544
|
+
/**
|
8545
|
+
* Reads an unsigned 8-bit integer from `buf` at the specified `offset`.
|
8546
|
+
*
|
8547
|
+
* @param offset Number of bytes to skip before starting to read.
|
8548
|
+
* @param noAssert
|
8549
|
+
*/
|
8550
|
+
readUInt8(offset: number, noAssert?: boolean): number;
|
8551
|
+
/**
|
8552
|
+
* Reads an unsigned, little-endian 16-bit integer from `buf` at the specified `offset`.
|
8553
|
+
*
|
8554
|
+
* @param offset Number of bytes to skip before starting to read.
|
8555
|
+
* @param noAssert
|
8556
|
+
*/
|
8557
|
+
readUInt16LE(offset: number, noAssert?: boolean): number;
|
8558
|
+
/**
|
8559
|
+
* Reads an unsigned, big-endian 16-bit integer from `buf` at the specified `offset`.
|
8560
|
+
*
|
8561
|
+
* @param offset Number of bytes to skip before starting to read.
|
8562
|
+
* @param noAssert
|
8563
|
+
*/
|
8564
|
+
readUInt16BE(offset: number, noAssert?: boolean): number;
|
8565
|
+
/**
|
8566
|
+
* Reads an unsigned, little-endian 32-bit integer from `buf` at the specified `offset`.
|
8567
|
+
*
|
8568
|
+
* @param offset Number of bytes to skip before starting to read.
|
8569
|
+
* @param noAssert
|
8570
|
+
*/
|
8571
|
+
readUInt32LE(offset: number, noAssert?: boolean): number;
|
8572
|
+
/**
|
8573
|
+
* Reads an unsigned, big-endian 32-bit integer from `buf` at the specified `offset`.
|
8574
|
+
*
|
8575
|
+
* @param offset Number of bytes to skip before starting to read.
|
8576
|
+
* @param noAssert
|
8577
|
+
*/
|
8578
|
+
readUInt32BE(offset: number, noAssert?: boolean): number;
|
8579
|
+
/**
|
8580
|
+
* Reads a signed 8-bit integer from `buf` at the specified `offset`. Integers read from a `Buffer` are interpreted
|
8581
|
+
* as two's complement signed values.
|
8582
|
+
*
|
8583
|
+
* @param offset Number of bytes to skip before starting to read.
|
8584
|
+
* @param noAssert
|
8585
|
+
*/
|
8586
|
+
readInt8(offset: number, noAssert?: boolean): number;
|
8587
|
+
/**
|
8588
|
+
* Reads a signed, little-endian 16-bit integer from `buf` at the specified `offset`. Integers read from a `Buffer`
|
8589
|
+
* are interpreted as two's complement signed values.
|
8590
|
+
*
|
8591
|
+
* @param offset Number of bytes to skip before starting to read.
|
8592
|
+
* @param noAssert
|
8593
|
+
*/
|
8594
|
+
readInt16LE(offset: number, noAssert?: boolean): number;
|
8595
|
+
/**
|
8596
|
+
* Reads a signed, big-endian 16-bit integer from `buf` at the specified `offset`. Integers read from a `Buffer`
|
8597
|
+
* are interpreted as two's complement signed values.
|
8598
|
+
*
|
8599
|
+
* @param offset Number of bytes to skip before starting to read.
|
8600
|
+
* @param noAssert
|
8601
|
+
*/
|
8602
|
+
readInt16BE(offset: number, noAssert?: boolean): number;
|
8603
|
+
/**
|
8604
|
+
* Reads a signed, little-endian 32-bit integer from `buf` at the specified `offset`. Integers read from a `Buffer`
|
8605
|
+
* are interpreted as two's complement signed values.
|
8606
|
+
*
|
8607
|
+
* @param offset Number of bytes to skip before starting to read.
|
8608
|
+
* @param noAssert
|
8609
|
+
*/
|
8610
|
+
readInt32LE(offset: number, noAssert?: boolean): number;
|
8611
|
+
/**
|
8612
|
+
* Reads a signed, big-endian 32-bit integer from `buf` at the specified `offset`. Integers read from a `Buffer`
|
8613
|
+
* are interpreted as two's complement signed values.
|
8614
|
+
*
|
8615
|
+
* @param offset Number of bytes to skip before starting to read.
|
8616
|
+
* @param noAssert
|
8617
|
+
*/
|
8618
|
+
readInt32BE(offset: number, noAssert?: boolean): number;
|
8619
|
+
/**
|
8620
|
+
* Interprets `buf` as an array of unsigned 16-bit integers and swaps the byte order in-place.
|
8621
|
+
* Throws a `RangeError` if `buf.length` is not a multiple of 2.
|
8622
|
+
*/
|
8623
|
+
swap16(): Buffer;
|
8624
|
+
/**
|
8625
|
+
* Interprets `buf` as an array of unsigned 32-bit integers and swaps the byte order in-place.
|
8626
|
+
* Throws a `RangeError` if `buf.length` is not a multiple of 4.
|
8627
|
+
*/
|
8628
|
+
swap32(): Buffer;
|
8629
|
+
/**
|
8630
|
+
* Interprets `buf` as an array of unsigned 64-bit integers and swaps the byte order in-place.
|
8631
|
+
* Throws a `RangeError` if `buf.length` is not a multiple of 8.
|
8632
|
+
*/
|
8633
|
+
swap64(): Buffer;
|
8634
|
+
/**
|
8635
|
+
* Swaps two octets.
|
8636
|
+
*
|
8637
|
+
* @param b
|
8638
|
+
* @param n
|
8639
|
+
* @param m
|
8640
|
+
*/
|
8641
|
+
private _swap;
|
8642
|
+
/**
|
8643
|
+
* Writes `value` to `buf` at the specified `offset`. The `value` must be a valid unsigned 8-bit integer.
|
8644
|
+
* Behavior is undefined when `value` is anything other than an unsigned 8-bit integer.
|
8645
|
+
*
|
8646
|
+
* @param value Number to write.
|
8647
|
+
* @param offset Number of bytes to skip before starting to write.
|
8648
|
+
* @param noAssert
|
8649
|
+
* @returns `offset` plus the number of bytes written.
|
8650
|
+
*/
|
8651
|
+
writeUInt8(value: number, offset: number, noAssert?: boolean): number;
|
8652
|
+
/**
|
8653
|
+
* Writes `value` to `buf` at the specified `offset` as little-endian. The `value` must be a valid unsigned 16-bit
|
8654
|
+
* integer. Behavior is undefined when `value` is anything other than an unsigned 16-bit integer.
|
8655
|
+
*
|
8656
|
+
* @param value Number to write.
|
8657
|
+
* @param offset Number of bytes to skip before starting to write.
|
8658
|
+
* @param noAssert
|
8659
|
+
* @returns `offset` plus the number of bytes written.
|
8660
|
+
*/
|
8661
|
+
writeUInt16LE(value: number | string, offset: number, noAssert?: boolean): number;
|
8662
|
+
/**
|
8663
|
+
* Writes `value` to `buf` at the specified `offset` as big-endian. The `value` must be a valid unsigned 16-bit
|
8664
|
+
* integer. Behavior is undefined when `value` is anything other than an unsigned 16-bit integer.
|
8665
|
+
*
|
8666
|
+
* @param value Number to write.
|
8667
|
+
* @param offset Number of bytes to skip before starting to write.
|
8668
|
+
* @param noAssert
|
8669
|
+
* @returns `offset` plus the number of bytes written.
|
8670
|
+
*/
|
8671
|
+
writeUInt16BE(value: number, offset: number, noAssert?: boolean): number;
|
8672
|
+
/**
|
8673
|
+
* Writes `value` to `buf` at the specified `offset` as little-endian. The `value` must be a valid unsigned 32-bit
|
8674
|
+
* integer. Behavior is undefined when `value` is anything other than an unsigned 32-bit integer.
|
8675
|
+
*
|
8676
|
+
* @param value Number to write.
|
8677
|
+
* @param offset Number of bytes to skip before starting to write.
|
8678
|
+
* @param noAssert
|
8679
|
+
* @returns `offset` plus the number of bytes written.
|
8680
|
+
*/
|
8681
|
+
writeUInt32LE(value: number, offset: number, noAssert?: boolean): number;
|
8682
|
+
/**
|
8683
|
+
* Writes `value` to `buf` at the specified `offset` as big-endian. The `value` must be a valid unsigned 32-bit
|
8684
|
+
* integer. Behavior is undefined when `value` is anything other than an unsigned 32-bit integer.
|
8685
|
+
*
|
8686
|
+
* @param value Number to write.
|
8687
|
+
* @param offset Number of bytes to skip before starting to write.
|
8688
|
+
* @param noAssert
|
8689
|
+
* @returns `offset` plus the number of bytes written.
|
8690
|
+
*/
|
8691
|
+
writeUInt32BE(value: number, offset: number, noAssert?: boolean): number;
|
8692
|
+
/**
|
8693
|
+
* Writes `value` to `buf` at the specified `offset`. The `value` must be a valid signed 8-bit integer.
|
8694
|
+
* Behavior is undefined when `value` is anything other than a signed 8-bit integer.
|
8695
|
+
*
|
8696
|
+
* @param value Number to write.
|
8697
|
+
* @param offset Number of bytes to skip before starting to write.
|
8698
|
+
* @param noAssert
|
8699
|
+
* @returns `offset` plus the number of bytes written.
|
8700
|
+
*/
|
8701
|
+
writeInt8(value: number, offset: number, noAssert?: boolean): number;
|
8702
|
+
/**
|
8703
|
+
* Writes `value` to `buf` at the specified `offset` as little-endian. The `value` must be a valid signed 16-bit
|
8704
|
+
* integer. Behavior is undefined when `value` is anything other than a signed 16-bit integer.
|
8705
|
+
*
|
8706
|
+
* @param value Number to write.
|
8707
|
+
* @param offset Number of bytes to skip before starting to write.
|
8708
|
+
* @param noAssert
|
8709
|
+
* @returns `offset` plus the number of bytes written.
|
8710
|
+
*/
|
8711
|
+
writeInt16LE(value: number, offset: number, noAssert?: boolean): number;
|
8712
|
+
/**
|
8713
|
+
* Writes `value` to `buf` at the specified `offset` as big-endian. The `value` must be a valid signed 16-bit
|
8714
|
+
* integer. Behavior is undefined when `value` is anything other than a signed 16-bit integer.
|
8715
|
+
*
|
8716
|
+
* @param value Number to write.
|
8717
|
+
* @param offset Number of bytes to skip before starting to write.
|
8718
|
+
* @param noAssert
|
8719
|
+
* @returns `offset` plus the number of bytes written.
|
8720
|
+
*/
|
8721
|
+
writeInt16BE(value: number, offset: number, noAssert?: boolean): number;
|
8722
|
+
/**
|
8723
|
+
* Writes `value` to `buf` at the specified `offset` as little-endian. The `value` must be a valid signed 32-bit
|
8724
|
+
* integer. Behavior is undefined when `value` is anything other than a signed 32-bit integer.
|
8725
|
+
*
|
8726
|
+
* @param value Number to write.
|
8727
|
+
* @param offset Number of bytes to skip before starting to write.
|
8728
|
+
* @param noAssert
|
8729
|
+
* @returns `offset` plus the number of bytes written.
|
8730
|
+
*/
|
8731
|
+
writeInt32LE(value: number, offset: number, noAssert?: boolean): number;
|
8732
|
+
/**
|
8733
|
+
* Writes `value` to `buf` at the specified `offset` as big-endian. The `value` must be a valid signed 32-bit
|
8734
|
+
* integer. Behavior is undefined when `value` is anything other than a signed 32-bit integer.
|
8735
|
+
*
|
8736
|
+
* @param value Number to write.
|
8737
|
+
* @param offset Number of bytes to skip before starting to write.
|
8738
|
+
* @param noAssert
|
8739
|
+
* @returns `offset` plus the number of bytes written.
|
8740
|
+
*/
|
8741
|
+
writeInt32BE(value: number, offset: number, noAssert?: boolean): number;
|
8742
|
+
/**
|
8743
|
+
* Fills `buf` with the specified `value`. If the `offset` and `end` are not given, the entire `buf` will be
|
8744
|
+
* filled. The `value` is coerced to a `uint32` value if it is not a string, `Buffer`, or integer. If the resulting
|
8745
|
+
* integer is greater than `255` (decimal), then `buf` will be filled with `value & 255`.
|
8746
|
+
*
|
8747
|
+
* If the final write of a `fill()` operation falls on a multi-byte character, then only the bytes of that
|
8748
|
+
* character that fit into `buf` are written.
|
8749
|
+
*
|
8750
|
+
* If `value` contains invalid characters, it is truncated; if no valid fill data remains, an exception is thrown.
|
8751
|
+
*
|
8752
|
+
* @param value
|
8753
|
+
* @param encoding
|
8754
|
+
*/
|
8755
|
+
fill(value: any, offset?: number, end?: number, encoding?: Encoding): this;
|
8756
|
+
/**
|
8757
|
+
* Returns the index of the specified value.
|
8758
|
+
*
|
8759
|
+
* If `value` is:
|
8760
|
+
* - a string, `value` is interpreted according to the character encoding in `encoding`.
|
8761
|
+
* - a `Buffer` or `Uint8Array`, `value` will be used in its entirety. To compare a partial Buffer, use `slice()`.
|
8762
|
+
* - a number, `value` will be interpreted as an unsigned 8-bit integer value between `0` and `255`.
|
8763
|
+
*
|
8764
|
+
* Any other types will throw a `TypeError`.
|
8765
|
+
*
|
8766
|
+
* @param value What to search for.
|
8767
|
+
* @param byteOffset Where to begin searching in `buf`. If negative, then calculated from the end.
|
8768
|
+
* @param encoding If `value` is a string, this is the encoding used to search.
|
8769
|
+
* @returns The index of the first occurrence of `value` in `buf`, or `-1` if not found.
|
8770
|
+
*/
|
8771
|
+
indexOf(value: string | number | Buffer, byteOffset?: number, encoding?: Encoding): number;
|
8772
|
+
/**
|
8773
|
+
* Gets the last index of the specified value.
|
8774
|
+
*
|
8775
|
+
* @see indexOf()
|
8776
|
+
* @param value
|
8777
|
+
* @param byteOffset
|
8778
|
+
* @param encoding
|
8779
|
+
*/
|
8780
|
+
lastIndexOf(value: string | number | Buffer, byteOffset?: number, encoding?: Encoding): number;
|
8781
|
+
private _bidirectionalIndexOf;
|
8782
|
+
/**
|
8783
|
+
* Equivalent to `buf.indexOf() !== -1`.
|
8784
|
+
*
|
8785
|
+
* @param value
|
8786
|
+
* @param byteOffset
|
8787
|
+
* @param encoding
|
8788
|
+
*/
|
8789
|
+
includes(value: string | number | Buffer, byteOffset?: number, encoding?: Encoding): boolean;
|
8790
|
+
/**
|
8791
|
+
* Allocates a new Buffer using an `array` of octet values.
|
8792
|
+
*
|
8793
|
+
* @param array
|
8794
|
+
*/
|
8795
|
+
static from(array: number[]): Buffer;
|
8796
|
+
/**
|
8797
|
+
* When passed a reference to the .buffer property of a TypedArray instance, the newly created Buffer will share
|
8798
|
+
* the same allocated memory as the TypedArray. The optional `byteOffset` and `length` arguments specify a memory
|
8799
|
+
* range within the `arrayBuffer` that will be shared by the Buffer.
|
8800
|
+
*
|
8801
|
+
* @param buffer The .buffer property of a TypedArray or a new ArrayBuffer().
|
8802
|
+
* @param byteOffset
|
8803
|
+
* @param length
|
8804
|
+
*/
|
8805
|
+
static from(buffer: ArrayBuffer, byteOffset?: number, length?: number): Buffer;
|
8806
|
+
/**
|
8807
|
+
* Copies the passed `buffer` data onto a new Buffer instance.
|
8808
|
+
*
|
8809
|
+
* @param buffer
|
8810
|
+
*/
|
8811
|
+
static from(buffer: Buffer | Uint8Array): Buffer;
|
8812
|
+
/**
|
8813
|
+
* Creates a new Buffer containing the given string `str`. If provided, the `encoding` parameter identifies the
|
8814
|
+
* character encoding.
|
8815
|
+
*
|
8816
|
+
* @param str String to store in buffer.
|
8817
|
+
* @param encoding Encoding to use, optional. Default is `utf8`.
|
8818
|
+
*/
|
8819
|
+
static from(str: string, encoding?: Encoding): Buffer;
|
8820
|
+
/**
|
8821
|
+
* Returns true if `obj` is a Buffer.
|
8822
|
+
*
|
8823
|
+
* @param obj
|
8824
|
+
*/
|
8825
|
+
static isBuffer(obj: any): obj is Buffer;
|
8826
|
+
/**
|
8827
|
+
* Returns true if `encoding` is a supported encoding.
|
8828
|
+
*
|
8829
|
+
* @param encoding
|
8830
|
+
*/
|
8831
|
+
static isEncoding(encoding: string): encoding is Encoding;
|
8832
|
+
/**
|
8833
|
+
* Gives the actual byte length of a string for an encoding. This is not the same as `string.length` since that
|
8834
|
+
* returns the number of characters in the string.
|
8835
|
+
*
|
8836
|
+
* @param string The string to test.
|
8837
|
+
* @param encoding The encoding to use for calculation. Defaults is `utf8`.
|
8838
|
+
*/
|
8839
|
+
static byteLength(string: string | Buffer | ArrayBuffer, encoding?: Encoding): number;
|
8840
|
+
/**
|
8841
|
+
* Returns a Buffer which is the result of concatenating all the buffers in the list together.
|
8842
|
+
*
|
8843
|
+
* - If the list has no items, or if the `totalLength` is 0, then it returns a zero-length buffer.
|
8844
|
+
* - If the list has exactly one item, then the first item is returned.
|
8845
|
+
* - If the list has more than one item, then a new buffer is created.
|
8846
|
+
*
|
8847
|
+
* It is faster to provide the `totalLength` if it is known. However, it will be calculated if not provided at
|
8848
|
+
* a small computational expense.
|
8849
|
+
*
|
8850
|
+
* @param list An array of Buffer objects to concatenate.
|
8851
|
+
* @param totalLength Total length of the buffers when concatenated.
|
8852
|
+
*/
|
8853
|
+
static concat(list: Uint8Array[], totalLength?: number): Buffer;
|
8854
|
+
/**
|
8855
|
+
* The same as `buf1.compare(buf2)`.
|
8856
|
+
*/
|
8857
|
+
static compare(buf1: Uint8Array, buf2: Uint8Array): number;
|
8858
|
+
/**
|
8859
|
+
* Allocates a new buffer of `size` octets.
|
8860
|
+
*
|
8861
|
+
* @param size The number of octets to allocate.
|
8862
|
+
* @param fill If specified, the buffer will be initialized by calling `buf.fill(fill)`, or with zeroes otherwise.
|
8863
|
+
* @param encoding The encoding used for the call to `buf.fill()` while initializing.
|
8864
|
+
*/
|
8865
|
+
static alloc(size: number, fill?: string | Buffer | number, encoding?: Encoding): Buffer;
|
8866
|
+
/**
|
8867
|
+
* Allocates a new buffer of `size` octets without initializing memory. The contents of the buffer are unknown.
|
8868
|
+
*
|
8869
|
+
* @param size
|
8870
|
+
*/
|
8871
|
+
static allocUnsafe(size: number): Buffer;
|
8872
|
+
/**
|
8873
|
+
* Returns true if the given `obj` is an instance of `type`.
|
8874
|
+
*
|
8875
|
+
* @param obj
|
8876
|
+
* @param type
|
8877
|
+
*/
|
8878
|
+
private static _isInstance;
|
8879
|
+
private static _checked;
|
8880
|
+
private static _blitBuffer;
|
8881
|
+
private static _utf8Write;
|
8882
|
+
private static _asciiWrite;
|
8883
|
+
private static _base64Write;
|
8884
|
+
private static _ucs2Write;
|
8885
|
+
private static _hexWrite;
|
8886
|
+
private static _utf8ToBytes;
|
8887
|
+
private static _base64ToBytes;
|
8888
|
+
private static _asciiToBytes;
|
8889
|
+
private static _utf16leToBytes;
|
8890
|
+
private static _hexSlice;
|
8891
|
+
private static _base64Slice;
|
8892
|
+
private static _utf8Slice;
|
8893
|
+
private static _decodeCodePointsArray;
|
8894
|
+
private static _asciiSlice;
|
8895
|
+
private static _latin1Slice;
|
8896
|
+
private static _utf16leSlice;
|
8897
|
+
private static _arrayIndexOf;
|
8898
|
+
private static _checkOffset;
|
8899
|
+
private static _checkInt;
|
8900
|
+
private static _getEncoding;
|
8901
|
+
}
|
8902
|
+
/**
|
8903
|
+
* The encodings that are supported in both native and polyfilled `Buffer` instances.
|
8904
|
+
*/
|
8905
|
+
type Encoding = 'ascii' | 'utf8' | 'utf16le' | 'ucs2' | 'binary' | 'hex' | 'latin1' | 'base64';
|
8906
|
+
|
7803
8907
|
type XataFileEditableFields = Partial<Pick<XataArrayFile, keyof InputFileEntry>>;
|
7804
8908
|
type XataFileFields = Partial<Pick<XataArrayFile, {
|
7805
8909
|
[K in StringKeys<XataArrayFile>]: XataArrayFile[K] extends Function ? never : K;
|
@@ -8046,13 +9150,13 @@ type XataRecordMetadata = {
|
|
8046
9150
|
declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
|
8047
9151
|
declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;
|
8048
9152
|
type NumericOperator = ExclusiveOr<{
|
8049
|
-
$increment
|
9153
|
+
$increment: number;
|
8050
9154
|
}, ExclusiveOr<{
|
8051
|
-
$decrement
|
9155
|
+
$decrement: number;
|
8052
9156
|
}, ExclusiveOr<{
|
8053
|
-
$multiply
|
9157
|
+
$multiply: number;
|
8054
9158
|
}, {
|
8055
|
-
$divide
|
9159
|
+
$divide: number;
|
8056
9160
|
}>>>;
|
8057
9161
|
type InputXataFile = Partial<XataArrayFile> | Promise<Partial<XataArrayFile>>;
|
8058
9162
|
type EditableDataFields<T> = T extends XataRecord ? {
|
@@ -8320,10 +9424,11 @@ type SearchPluginResult<Schemas extends Record<string, BaseData>> = {
|
|
8320
9424
|
declare class SearchPlugin<Schemas extends Record<string, XataRecord>> extends XataPlugin {
|
8321
9425
|
#private;
|
8322
9426
|
private db;
|
8323
|
-
constructor(db: SchemaPluginResult<Schemas
|
9427
|
+
constructor(db: SchemaPluginResult<Schemas>);
|
8324
9428
|
build(pluginOptions: XataPluginOptions): SearchPluginResult<Schemas>;
|
8325
9429
|
}
|
8326
|
-
type SearchXataRecord<Record extends XataRecord> = Omit<Record, 'getMetadata'> & {
|
9430
|
+
type SearchXataRecord<Record extends XataRecord> = Omit<Record, 'getMetadata' | 'xata'> & {
|
9431
|
+
xata: XataRecordMetadata & SearchExtraProperties;
|
8327
9432
|
getMetadata: () => XataRecordMetadata & SearchExtraProperties;
|
8328
9433
|
};
|
8329
9434
|
type SearchExtraProperties = {
|
@@ -8644,7 +9749,7 @@ type QueryOptions<T extends XataRecord> = BaseOptions<T> & (CursorQueryOptions |
|
|
8644
9749
|
declare class Query<Record extends XataRecord, Result extends XataRecord = Record> implements Paginable<Record, Result> {
|
8645
9750
|
#private;
|
8646
9751
|
readonly meta: PaginationQueryMeta;
|
8647
|
-
readonly records:
|
9752
|
+
readonly records: PageRecordArray<Result>;
|
8648
9753
|
constructor(repository: RestRepository<Record> | null, table: {
|
8649
9754
|
name: string;
|
8650
9755
|
schema?: Table;
|
@@ -8772,25 +9877,25 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
8772
9877
|
* Performs the query in the database and returns a set of results.
|
8773
9878
|
* @returns An array of records from the database.
|
8774
9879
|
*/
|
8775
|
-
getMany(): Promise<
|
9880
|
+
getMany(): Promise<PageRecordArray<Result>>;
|
8776
9881
|
/**
|
8777
9882
|
* Performs the query in the database and returns a set of results.
|
8778
9883
|
* @param options Additional options to be used when performing the query.
|
8779
9884
|
* @returns An array of records from the database.
|
8780
9885
|
*/
|
8781
|
-
getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<
|
9886
|
+
getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<PageRecordArray<SelectedPick<Record, (typeof options)['columns']>>>;
|
8782
9887
|
/**
|
8783
9888
|
* Performs the query in the database and returns a set of results.
|
8784
9889
|
* @param options Additional options to be used when performing the query.
|
8785
9890
|
* @returns An array of records from the database.
|
8786
9891
|
*/
|
8787
|
-
getMany(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<
|
9892
|
+
getMany(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<PageRecordArray<Result>>;
|
8788
9893
|
/**
|
8789
9894
|
* Performs the query in the database and returns all the results.
|
8790
9895
|
* Warning: If there are a large number of results, this method can have performance implications.
|
8791
9896
|
* @returns An array of records from the database.
|
8792
9897
|
*/
|
8793
|
-
getAll(): Promise<Result
|
9898
|
+
getAll(): Promise<RecordArray<Result>>;
|
8794
9899
|
/**
|
8795
9900
|
* Performs the query in the database and returns all the results.
|
8796
9901
|
* Warning: If there are a large number of results, this method can have performance implications.
|
@@ -8799,7 +9904,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
8799
9904
|
*/
|
8800
9905
|
getAll<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
|
8801
9906
|
batchSize?: number;
|
8802
|
-
}>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']
|
9907
|
+
}>(options: Options): Promise<RecordArray<SelectedPick<Record, (typeof options)['columns']>>>;
|
8803
9908
|
/**
|
8804
9909
|
* Performs the query in the database and returns all the results.
|
8805
9910
|
* Warning: If there are a large number of results, this method can have performance implications.
|
@@ -8808,7 +9913,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
8808
9913
|
*/
|
8809
9914
|
getAll(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'> & {
|
8810
9915
|
batchSize?: number;
|
8811
|
-
}): Promise<Result
|
9916
|
+
}): Promise<RecordArray<Result>>;
|
8812
9917
|
/**
|
8813
9918
|
* Performs the query in the database and returns the first result.
|
8814
9919
|
* @returns The first record that matches the query, or null if no record matched the query.
|
@@ -8892,7 +9997,7 @@ type PaginationQueryMeta = {
|
|
8892
9997
|
};
|
8893
9998
|
interface Paginable<Record extends XataRecord, Result extends XataRecord = Record> {
|
8894
9999
|
meta: PaginationQueryMeta;
|
8895
|
-
records:
|
10000
|
+
records: PageRecordArray<Result>;
|
8896
10001
|
nextPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
8897
10002
|
previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
8898
10003
|
startPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
@@ -8912,7 +10017,7 @@ declare class Page<Record extends XataRecord, Result extends XataRecord = Record
|
|
8912
10017
|
/**
|
8913
10018
|
* The set of results for this page.
|
8914
10019
|
*/
|
8915
|
-
readonly records:
|
10020
|
+
readonly records: PageRecordArray<Result>;
|
8916
10021
|
constructor(query: Query<Record, Result>, meta: PaginationQueryMeta, records?: Result[]);
|
8917
10022
|
/**
|
8918
10023
|
* Retrieves the next page of results.
|
@@ -8966,6 +10071,14 @@ declare const PAGINATION_MAX_OFFSET = 49000;
|
|
8966
10071
|
declare const PAGINATION_DEFAULT_OFFSET = 0;
|
8967
10072
|
declare function isCursorPaginationOptions(options: Record<string, unknown> | undefined | null): options is CursorNavigationOptions;
|
8968
10073
|
declare class RecordArray<Result extends XataRecord> extends Array<Result> {
|
10074
|
+
constructor(overrideRecords?: Result[]);
|
10075
|
+
static parseConstructorParams(...args: any[]): any[];
|
10076
|
+
toArray(): Result[];
|
10077
|
+
toSerializable(): JSONData<Result>[];
|
10078
|
+
toString(): string;
|
10079
|
+
map<U>(callbackfn: (value: Result, index: number, array: Result[]) => U, thisArg?: any): U[];
|
10080
|
+
}
|
10081
|
+
declare class PageRecordArray<Result extends XataRecord> extends Array<Result> {
|
8969
10082
|
#private;
|
8970
10083
|
constructor(page: Paginable<any, Result>, overrideRecords?: Result[]);
|
8971
10084
|
static parseConstructorParams(...args: any[]): any[];
|
@@ -8978,25 +10091,25 @@ declare class RecordArray<Result extends XataRecord> extends Array<Result> {
|
|
8978
10091
|
*
|
8979
10092
|
* @returns A new array of objects
|
8980
10093
|
*/
|
8981
|
-
nextPage(size?: number, offset?: number): Promise<
|
10094
|
+
nextPage(size?: number, offset?: number): Promise<PageRecordArray<Result>>;
|
8982
10095
|
/**
|
8983
10096
|
* Retrieve previous page of records
|
8984
10097
|
*
|
8985
10098
|
* @returns A new array of objects
|
8986
10099
|
*/
|
8987
|
-
previousPage(size?: number, offset?: number): Promise<
|
10100
|
+
previousPage(size?: number, offset?: number): Promise<PageRecordArray<Result>>;
|
8988
10101
|
/**
|
8989
10102
|
* Retrieve start page of records
|
8990
10103
|
*
|
8991
10104
|
* @returns A new array of objects
|
8992
10105
|
*/
|
8993
|
-
startPage(size?: number, offset?: number): Promise<
|
10106
|
+
startPage(size?: number, offset?: number): Promise<PageRecordArray<Result>>;
|
8994
10107
|
/**
|
8995
10108
|
* Retrieve end page of records
|
8996
10109
|
*
|
8997
10110
|
* @returns A new array of objects
|
8998
10111
|
*/
|
8999
|
-
endPage(size?: number, offset?: number): Promise<
|
10112
|
+
endPage(size?: number, offset?: number): Promise<PageRecordArray<Result>>;
|
9000
10113
|
/**
|
9001
10114
|
* @returns Boolean indicating if there is a next page
|
9002
10115
|
*/
|
@@ -9733,7 +10846,7 @@ type PropertyType<Tables, Properties, PropertyName extends PropertyKey> = Proper
|
|
9733
10846
|
} : {
|
9734
10847
|
[K in PropertyName]?: InnerType<Type, Tables, LinkedTable> | null;
|
9735
10848
|
} : never : never;
|
9736
|
-
type InnerType<Type, Tables, LinkedTable> = Type extends 'string' | 'text' | 'email' ? string : Type extends 'int' | 'float' ? number : Type extends 'bool' ? boolean : Type extends 'datetime' ? Date : Type extends 'multiple' ? string[] : Type extends 'vector' ? number[] : Type extends 'file' ? XataFile : Type extends 'file[]' ? XataArrayFile[] : Type extends 'json' ? JSONValue<any> : Type extends 'link' ? TableType<Tables, LinkedTable> & XataRecord :
|
10849
|
+
type InnerType<Type, Tables, LinkedTable> = Type extends 'string' | 'text' | 'email' | 'character' | 'varchar' | 'character varying' | `varchar(${number})` | `character(${number})` ? string : Type extends 'int' | 'float' | 'bigint' | 'int8' | 'integer' | 'int4' | 'smallint' | 'double precision' | 'float8' | 'real' | 'numeric' ? number : Type extends 'bool' | 'boolean' ? boolean : Type extends 'datetime' | 'timestamptz' ? Date : Type extends 'multiple' | 'text[]' ? string[] : Type extends 'vector' | 'real[]' | 'float[]' | 'double precision[]' | 'float8[]' | 'numeric[]' ? number[] : Type extends 'int[]' | 'bigint[]' | 'int8[]' | 'integer[]' | 'int4[]' | 'smallint[]' ? number[] : Type extends 'bool[]' | 'boolean[]' ? boolean[] : Type extends 'file' | 'xata_file' ? XataFile : Type extends 'file[]' | 'xata_file_array' ? XataArrayFile[] : Type extends 'json' | 'jsonb' ? JSONValue<any> : Type extends 'link' ? TableType<Tables, LinkedTable> & XataRecord : string;
|
9737
10850
|
|
9738
10851
|
/**
|
9739
10852
|
* Operator to restrict results to only values that are greater than the given value.
|
@@ -9786,11 +10899,11 @@ declare const le: <T extends ComparableType>(value: T) => ComparableTypeFilter<T
|
|
9786
10899
|
/**
|
9787
10900
|
* Operator to restrict results to only values that are not null.
|
9788
10901
|
*/
|
9789
|
-
declare const exists: <T>(column?: FilterColumns<T>
|
10902
|
+
declare const exists: <T>(column?: FilterColumns<T>) => ExistanceFilter<T>;
|
9790
10903
|
/**
|
9791
10904
|
* Operator to restrict results to only values that are null.
|
9792
10905
|
*/
|
9793
|
-
declare const notExists: <T>(column?: FilterColumns<T>
|
10906
|
+
declare const notExists: <T>(column?: FilterColumns<T>) => ExistanceFilter<T>;
|
9794
10907
|
/**
|
9795
10908
|
* Operator to restrict results to only values that start with the given prefix.
|
9796
10909
|
*/
|
@@ -9852,7 +10965,7 @@ type SchemaPluginResult<Schemas extends Record<string, XataRecord>> = {
|
|
9852
10965
|
};
|
9853
10966
|
declare class SchemaPlugin<Schemas extends Record<string, XataRecord>> extends XataPlugin {
|
9854
10967
|
#private;
|
9855
|
-
constructor(
|
10968
|
+
constructor();
|
9856
10969
|
build(pluginOptions: XataPluginOptions): SchemaPluginResult<Schemas>;
|
9857
10970
|
}
|
9858
10971
|
|
@@ -9893,18 +11006,112 @@ declare class FilesPlugin<Schemas extends Record<string, XataRecord>> extends Xa
|
|
9893
11006
|
}
|
9894
11007
|
|
9895
11008
|
type SQLQueryParams<T = any[]> = {
|
11009
|
+
/**
|
11010
|
+
* The SQL statement to execute.
|
11011
|
+
* @example
|
11012
|
+
* ```ts
|
11013
|
+
* const { records } = await xata.sql<TeamsRecord>({
|
11014
|
+
* statement: `SELECT * FROM teams WHERE name = $1`,
|
11015
|
+
* params: ['A name']
|
11016
|
+
* });
|
11017
|
+
* ```
|
11018
|
+
*
|
11019
|
+
* Be careful when using this with user input and use parametrized statements to avoid SQL injection.
|
11020
|
+
*/
|
9896
11021
|
statement: string;
|
11022
|
+
/**
|
11023
|
+
* The parameters to pass to the SQL statement.
|
11024
|
+
*/
|
9897
11025
|
params?: T;
|
11026
|
+
/**
|
11027
|
+
* The consistency level to use when executing the query.
|
11028
|
+
* @default 'strong'
|
11029
|
+
*/
|
11030
|
+
consistency?: 'strong' | 'eventual';
|
11031
|
+
/**
|
11032
|
+
* The response type to use when executing the query.
|
11033
|
+
* @default 'json'
|
11034
|
+
*/
|
11035
|
+
responseType?: 'json' | 'array';
|
11036
|
+
};
|
11037
|
+
type SQLBatchQuery = {
|
11038
|
+
/**
|
11039
|
+
* The SQL statements to execute.
|
11040
|
+
*/
|
11041
|
+
statements: {
|
11042
|
+
/**
|
11043
|
+
* The SQL statement to execute.
|
11044
|
+
*/
|
11045
|
+
statement: string;
|
11046
|
+
/**
|
11047
|
+
* The parameters to pass to the SQL statement.
|
11048
|
+
*/
|
11049
|
+
params?: any[];
|
11050
|
+
}[];
|
11051
|
+
/**
|
11052
|
+
* The consistency level to use when executing the queries.
|
11053
|
+
* @default 'strong'
|
11054
|
+
*/
|
9898
11055
|
consistency?: 'strong' | 'eventual';
|
11056
|
+
/**
|
11057
|
+
* The response type to use when executing the queries.
|
11058
|
+
* @default 'json'
|
11059
|
+
*/
|
11060
|
+
responseType?: 'json' | 'array';
|
9899
11061
|
};
|
9900
|
-
type SQLQuery = TemplateStringsArray | SQLQueryParams
|
9901
|
-
type
|
11062
|
+
type SQLQuery = TemplateStringsArray | SQLQueryParams;
|
11063
|
+
type SQLResponseType = 'json' | 'array';
|
11064
|
+
type SQLQueryResultJSON<T> = {
|
11065
|
+
/**
|
11066
|
+
* The records returned by the query.
|
11067
|
+
*/
|
9902
11068
|
records: T[];
|
9903
|
-
|
9904
|
-
|
11069
|
+
/**
|
11070
|
+
* The columns metadata returned by the query.
|
11071
|
+
*/
|
11072
|
+
columns: Array<{
|
11073
|
+
name: string;
|
11074
|
+
type: string;
|
9905
11075
|
}>;
|
11076
|
+
/**
|
11077
|
+
* Optional warning message returned by the query.
|
11078
|
+
*/
|
9906
11079
|
warning?: string;
|
9907
|
-
}
|
11080
|
+
};
|
11081
|
+
type SQLQueryResultArray = {
|
11082
|
+
/**
|
11083
|
+
* The records returned by the query.
|
11084
|
+
*/
|
11085
|
+
rows: any[][];
|
11086
|
+
/**
|
11087
|
+
* The columns metadata returned by the query.
|
11088
|
+
*/
|
11089
|
+
columns: Array<{
|
11090
|
+
name: string;
|
11091
|
+
type: string;
|
11092
|
+
}>;
|
11093
|
+
/**
|
11094
|
+
* Optional warning message returned by the query.
|
11095
|
+
*/
|
11096
|
+
warning?: string;
|
11097
|
+
};
|
11098
|
+
type SQLQueryResult<T, Mode extends SQLResponseType = 'json'> = Mode extends 'json' ? SQLQueryResultJSON<T> : Mode extends 'array' ? SQLQueryResultArray : never;
|
11099
|
+
type SQLPluginFunction = <T, Query extends SQLQuery = SQLQuery>(query: Query, ...parameters: any[]) => Promise<SQLQueryResult<T, Query extends SQLQueryParams<any> ? Query['responseType'] extends SQLResponseType ? NonNullable<Query['responseType']> : 'json' : 'json'>>;
|
11100
|
+
type SQLPluginResult = SQLPluginFunction & {
|
11101
|
+
/**
|
11102
|
+
* Connection string to use when connecting to the database.
|
11103
|
+
* It includes the workspace, region, database and branch.
|
11104
|
+
* Connects with the same credentials as the Xata client.
|
11105
|
+
*/
|
11106
|
+
connectionString: string;
|
11107
|
+
/**
|
11108
|
+
* Executes a batch of SQL statements.
|
11109
|
+
* @param query The batch of SQL statements to execute.
|
11110
|
+
*/
|
11111
|
+
batch: <Query extends SQLBatchQuery = SQLBatchQuery>(query: Query) => Promise<{
|
11112
|
+
results: Array<SQLQueryResult<any, Query extends SQLBatchQuery ? Query['responseType'] extends SQLResponseType ? NonNullable<Query['responseType']> : 'json' : 'json'>>;
|
11113
|
+
}>;
|
11114
|
+
};
|
9908
11115
|
declare class SQLPlugin extends XataPlugin {
|
9909
11116
|
build(pluginOptions: XataPluginOptions): SQLPluginResult;
|
9910
11117
|
}
|
@@ -10020,7 +11227,7 @@ type BaseClientOptions = {
|
|
10020
11227
|
clientName?: string;
|
10021
11228
|
xataAgentExtra?: Record<string, string>;
|
10022
11229
|
};
|
10023
|
-
declare const buildClient: <Plugins extends Record<string, XataPlugin> = {}>(plugins?: Plugins
|
11230
|
+
declare const buildClient: <Plugins extends Record<string, XataPlugin> = {}>(plugins?: Plugins) => ClientConstructor<Plugins>;
|
10024
11231
|
interface ClientConstructor<Plugins extends Record<string, XataPlugin>> {
|
10025
11232
|
new <Schemas extends Record<string, XataRecord> = {}>(options?: Partial<BaseClientOptions>, schemaTables?: readonly BaseSchema[]): Omit<{
|
10026
11233
|
db: Awaited<ReturnType<SchemaPlugin<Schemas>['build']>>;
|
@@ -10071,4 +11278,4 @@ declare class XataError extends Error {
|
|
10071
11278
|
constructor(message: string, status: number);
|
10072
11279
|
}
|
10073
11280
|
|
10074
|
-
export { type AcceptWorkspaceMemberInviteError, type AcceptWorkspaceMemberInvitePathParams, type AcceptWorkspaceMemberInviteVariables, type AddGitBranchesEntryError, type AddGitBranchesEntryPathParams, type AddGitBranchesEntryRequestBody, type AddGitBranchesEntryResponse, type AddGitBranchesEntryVariables, type AddTableColumnError, type AddTableColumnPathParams, type AddTableColumnVariables, type AggregateTableError, type AggregateTablePathParams, type AggregateTableRequestBody, type AggregateTableVariables, type ApiExtraProps, type ApplyBranchSchemaEditError, type ApplyBranchSchemaEditPathParams, type ApplyBranchSchemaEditRequestBody, type ApplyBranchSchemaEditVariables, type ApplyMigrationError, type ApplyMigrationPathParams, type ApplyMigrationRequestBody, type ApplyMigrationVariables, type AskOptions, type AskResult, type AskTableError, type AskTablePathParams, type AskTableRequestBody, type AskTableResponse, type AskTableSessionError, type AskTableSessionPathParams, type AskTableSessionRequestBody, type AskTableSessionResponse, type AskTableSessionVariables, type AskTableVariables, BaseClient, type BaseClientOptions, type BaseData, type BaseSchema, type BinaryFile, type BranchTransactionError, type BranchTransactionPathParams, type BranchTransactionRequestBody, type BranchTransactionVariables, type BulkInsertTableRecordsError, type BulkInsertTableRecordsPathParams, type BulkInsertTableRecordsQueryParams, type BulkInsertTableRecordsRequestBody, type BulkInsertTableRecordsVariables, type CacheImpl, type CancelWorkspaceMemberInviteError, type CancelWorkspaceMemberInvitePathParams, type CancelWorkspaceMemberInviteVariables, type ClientConstructor, type ColumnsByValue, type CompareBranchSchemasError, type CompareBranchSchemasPathParams, type CompareBranchSchemasRequestBody, type CompareBranchSchemasVariables, type CompareBranchWithUserSchemaError, type CompareBranchWithUserSchemaPathParams, type CompareBranchWithUserSchemaRequestBody, type CompareBranchWithUserSchemaVariables, type CompareMigrationRequestError, type CompareMigrationRequestPathParams, type CompareMigrationRequestVariables, type CopyBranchError, type CopyBranchPathParams, type CopyBranchRequestBody, type CopyBranchVariables, type CreateBranchError, type CreateBranchPathParams, type CreateBranchQueryParams, type CreateBranchRequestBody, type CreateBranchResponse, type CreateBranchVariables, type CreateClusterError, type CreateClusterPathParams, type CreateClusterVariables, type CreateDatabaseError, type CreateDatabasePathParams, type CreateDatabaseRequestBody, type CreateDatabaseResponse, type CreateDatabaseVariables, type CreateMigrationRequestError, type CreateMigrationRequestPathParams, type CreateMigrationRequestRequestBody, type CreateMigrationRequestResponse, type CreateMigrationRequestVariables, type CreateTableError, type CreateTablePathParams, type CreateTableResponse, type CreateTableVariables, type CreateUserAPIKeyError, type CreateUserAPIKeyPathParams, type CreateUserAPIKeyResponse, type CreateUserAPIKeyVariables, type CreateWorkspaceError, type CreateWorkspaceVariables, type CursorNavigationOptions, type DeleteBranchError, type DeleteBranchPathParams, type DeleteBranchResponse, type DeleteBranchVariables, type DeleteColumnError, type DeleteColumnPathParams, type DeleteColumnVariables, type DeleteDatabaseError, type DeleteDatabaseGithubSettingsError, type DeleteDatabaseGithubSettingsPathParams, type DeleteDatabaseGithubSettingsVariables, type DeleteDatabasePathParams, type DeleteDatabaseResponse, type DeleteDatabaseVariables, type DeleteFileError, type DeleteFileItemError, type DeleteFileItemPathParams, type DeleteFileItemVariables, type DeleteFilePathParams, type DeleteFileVariables, type DeleteOAuthAccessTokenError, type DeleteOAuthAccessTokenPathParams, type DeleteOAuthAccessTokenVariables, type DeleteRecordError, type DeleteRecordPathParams, type DeleteRecordQueryParams, type DeleteRecordVariables, type DeleteTableError, type DeleteTablePathParams, type DeleteTableResponse, type DeleteTableVariables, type DeleteTransactionOperation, type DeleteUserAPIKeyError, type DeleteUserAPIKeyPathParams, type DeleteUserAPIKeyVariables, type DeleteUserError, type DeleteUserOAuthClientError, type DeleteUserOAuthClientPathParams, type DeleteUserOAuthClientVariables, type DeleteUserVariables, type DeleteWorkspaceError, type DeleteWorkspacePathParams, type DeleteWorkspaceVariables, type DeserializedType, type DownloadDestination, type EditableData, type ExecuteBranchMigrationPlanError, type ExecuteBranchMigrationPlanPathParams, type ExecuteBranchMigrationPlanRequestBody, type ExecuteBranchMigrationPlanVariables, type FetchImpl, FetcherError, type FetcherExtraProps, type FileAccessError, type FileAccessPathParams, type FileAccessQueryParams, type FileAccessVariables, type FileUploadError, type FileUploadPathParams, type FileUploadQueryParams, type FileUploadVariables, FilesPlugin, type FilesPluginResult, type GetAuthorizationCodeError, type GetAuthorizationCodeQueryParams, type GetAuthorizationCodeVariables, type GetBranchDetailsError, type GetBranchDetailsPathParams, type GetBranchDetailsVariables, type GetBranchListError, type GetBranchListPathParams, type GetBranchListVariables, type GetBranchMetadataError, type GetBranchMetadataPathParams, type GetBranchMetadataVariables, type GetBranchMigrationHistoryError, type GetBranchMigrationHistoryPathParams, type GetBranchMigrationHistoryRequestBody, type GetBranchMigrationHistoryResponse, type GetBranchMigrationHistoryVariables, type GetBranchMigrationPlanError, type GetBranchMigrationPlanPathParams, type GetBranchMigrationPlanVariables, type GetBranchSchemaHistoryError, type GetBranchSchemaHistoryPathParams, type GetBranchSchemaHistoryRequestBody, type GetBranchSchemaHistoryResponse, type GetBranchSchemaHistoryVariables, type GetBranchStatsError, type GetBranchStatsPathParams, type GetBranchStatsResponse, type GetBranchStatsVariables, type GetClusterError, type GetClusterPathParams, type GetClusterVariables, type GetColumnError, type GetColumnPathParams, type GetColumnVariables, type GetDatabaseGithubSettingsError, type GetDatabaseGithubSettingsPathParams, type GetDatabaseGithubSettingsVariables, type GetDatabaseListError, type GetDatabaseListPathParams, type GetDatabaseListVariables, type GetDatabaseMetadataError, type GetDatabaseMetadataPathParams, type GetDatabaseMetadataVariables, type GetFileError, type GetFileItemError, type GetFileItemPathParams, type GetFileItemVariables, type GetFilePathParams, type GetFileVariables, type GetGitBranchesMappingError, type GetGitBranchesMappingPathParams, type GetGitBranchesMappingVariables, type GetMigrationRequestError, type GetMigrationRequestIsMergedError, type GetMigrationRequestIsMergedPathParams, type GetMigrationRequestIsMergedResponse, type GetMigrationRequestIsMergedVariables, type GetMigrationRequestPathParams, type GetMigrationRequestVariables, type GetRecordError, type GetRecordPathParams, type GetRecordQueryParams, type GetRecordVariables, type GetSchemaError, type GetSchemaPathParams, type GetSchemaResponse, type GetSchemaVariables, type GetTableColumnsError, type GetTableColumnsPathParams, type GetTableColumnsResponse, type GetTableColumnsVariables, type GetTableSchemaError, type GetTableSchemaPathParams, type GetTableSchemaResponse, type GetTableSchemaVariables, type GetTransactionOperation, type GetUserAPIKeysError, type GetUserAPIKeysResponse, type GetUserAPIKeysVariables, type GetUserError, type GetUserOAuthAccessTokensError, type GetUserOAuthAccessTokensResponse, type GetUserOAuthAccessTokensVariables, type GetUserOAuthClientsError, type GetUserOAuthClientsResponse, type GetUserOAuthClientsVariables, type GetUserVariables, type GetWorkspaceError, type GetWorkspaceMembersListError, type GetWorkspaceMembersListPathParams, type GetWorkspaceMembersListVariables, type GetWorkspacePathParams, type GetWorkspaceVariables, type GetWorkspacesListError, type GetWorkspacesListResponse, type GetWorkspacesListVariables, type GrantAuthorizationCodeError, type GrantAuthorizationCodeVariables, type HostProvider, type Identifiable, type ImageTransformations, type InsertRecordError, type InsertRecordPathParams, type InsertRecordQueryParams, type InsertRecordVariables, type InsertRecordWithIDError, type InsertRecordWithIDPathParams, type InsertRecordWithIDQueryParams, type InsertRecordWithIDVariables, type InsertTransactionOperation, type InviteWorkspaceMemberError, type InviteWorkspaceMemberPathParams, type InviteWorkspaceMemberRequestBody, type InviteWorkspaceMemberVariables, type JSONData, type KeywordAskOptions, type Link, type ListClustersError, type ListClustersPathParams, type ListClustersQueryParams, type ListClustersVariables, type ListMigrationRequestsCommitsError, type ListMigrationRequestsCommitsPathParams, type ListMigrationRequestsCommitsRequestBody, type ListMigrationRequestsCommitsResponse, type ListMigrationRequestsCommitsVariables, type ListRegionsError, type ListRegionsPathParams, type ListRegionsVariables, type MergeMigrationRequestError, type MergeMigrationRequestPathParams, type MergeMigrationRequestVariables, type OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, type Paginable, type PaginationQueryMeta, type PgRollJobStatusError, type PgRollJobStatusPathParams, type PgRollJobStatusVariables, type PgRollMigrationHistoryError, type PgRollMigrationHistoryPathParams, type PgRollMigrationHistoryVariables, type PgRollStatusError, type PgRollStatusPathParams, type PgRollStatusVariables, type PreviewBranchSchemaEditError, type PreviewBranchSchemaEditPathParams, type PreviewBranchSchemaEditRequestBody, type PreviewBranchSchemaEditResponse, type PreviewBranchSchemaEditVariables, type PushBranchMigrationsError, type PushBranchMigrationsPathParams, type PushBranchMigrationsRequestBody, type PushBranchMigrationsVariables, type PutFileError, type PutFileItemError, type PutFileItemPathParams, type PutFileItemVariables, type PutFilePathParams, type PutFileVariables, Query, type QueryMigrationRequestsError, type QueryMigrationRequestsPathParams, type QueryMigrationRequestsRequestBody, type QueryMigrationRequestsResponse, type QueryMigrationRequestsVariables, type QueryTableError, type QueryTablePathParams, type QueryTableRequestBody, type QueryTableVariables, RecordArray, RecordColumnTypes, type RemoveGitBranchesEntryError, type RemoveGitBranchesEntryPathParams, type RemoveGitBranchesEntryQueryParams, type RemoveGitBranchesEntryVariables, type RemoveWorkspaceMemberError, type RemoveWorkspaceMemberPathParams, type RemoveWorkspaceMemberVariables, type RenameDatabaseError, type RenameDatabasePathParams, type RenameDatabaseRequestBody, type RenameDatabaseVariables, Repository, type ResendWorkspaceMemberInviteError, type ResendWorkspaceMemberInvitePathParams, type ResendWorkspaceMemberInviteVariables, type ResolveBranchError, type ResolveBranchPathParams, type ResolveBranchQueryParams, type ResolveBranchResponse, type ResolveBranchVariables, responses as Responses, RestRepository, SQLPlugin, type SQLPluginResult, type SQLQuery, type SQLQueryParams, type SchemaDefinition, type SchemaInference, SchemaPlugin, type SchemaPluginResult, schemas as Schemas, type SearchBranchError, type SearchBranchPathParams, type SearchBranchRequestBody, type SearchBranchVariables, type SearchOptions, SearchPlugin, type SearchPluginResult, type SearchTableError, type SearchTablePathParams, type SearchTableRequestBody, type SearchTableVariables, type SearchXataRecord, type SelectableColumn, type SelectableColumnWithObjectNotation, type SelectedPick, type SerializedString, Serializer, type SerializerResult, type SetTableSchemaError, type SetTableSchemaPathParams, type SetTableSchemaRequestBody, type SetTableSchemaVariables, SimpleCache, type SimpleCacheOptions, type SqlQueryError, type SqlQueryPathParams, type SqlQueryRequestBody, type SqlQueryVariables, type SummarizeTableError, type SummarizeTablePathParams, type SummarizeTableRequestBody, type SummarizeTableVariables, type TotalCount, type TransactionOperation, TransactionPlugin, type TransactionPluginResult, type TransactionResults, type UpdateBranchMetadataError, type UpdateBranchMetadataPathParams, type UpdateBranchMetadataVariables, type UpdateBranchSchemaError, type UpdateBranchSchemaPathParams, type UpdateBranchSchemaVariables, type UpdateClusterError, type UpdateClusterPathParams, type UpdateClusterVariables, type UpdateColumnError, type UpdateColumnPathParams, type UpdateColumnRequestBody, type UpdateColumnVariables, type UpdateDatabaseGithubSettingsError, type UpdateDatabaseGithubSettingsPathParams, type UpdateDatabaseGithubSettingsVariables, type UpdateDatabaseMetadataError, type UpdateDatabaseMetadataPathParams, type UpdateDatabaseMetadataRequestBody, type UpdateDatabaseMetadataVariables, type UpdateMigrationRequestError, type UpdateMigrationRequestPathParams, type UpdateMigrationRequestRequestBody, type UpdateMigrationRequestVariables, type UpdateOAuthAccessTokenError, type UpdateOAuthAccessTokenPathParams, type UpdateOAuthAccessTokenRequestBody, type UpdateOAuthAccessTokenVariables, type UpdateRecordWithIDError, type UpdateRecordWithIDPathParams, type UpdateRecordWithIDQueryParams, type UpdateRecordWithIDVariables, type UpdateTableError, type UpdateTablePathParams, type UpdateTableRequestBody, type UpdateTableVariables, type UpdateTransactionOperation, type UpdateUserError, type UpdateUserVariables, type UpdateWorkspaceError, type UpdateWorkspaceMemberInviteError, type UpdateWorkspaceMemberInvitePathParams, type UpdateWorkspaceMemberInviteRequestBody, type UpdateWorkspaceMemberInviteVariables, type UpdateWorkspaceMemberRoleError, type UpdateWorkspaceMemberRolePathParams, type UpdateWorkspaceMemberRoleRequestBody, type UpdateWorkspaceMemberRoleVariables, type UpdateWorkspacePathParams, type UpdateWorkspaceVariables, type UploadDestination, type UpsertRecordWithIDError, type UpsertRecordWithIDPathParams, type UpsertRecordWithIDQueryParams, type UpsertRecordWithIDVariables, type ValueAtColumn, type VectorAskOptions, type VectorSearchTableError, type VectorSearchTablePathParams, type VectorSearchTableRequestBody, type VectorSearchTableVariables, XataApiClient, type XataApiClientOptions, XataApiPlugin, type XataArrayFile, XataError, XataFile, XataPlugin, type XataPluginOptions, type XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, applyMigration, askTable, askTableSession, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createCluster, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteFile, deleteFileItem, deleteOAuthAccessToken, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteUserOAuthClient, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, fileAccess, fileUpload, ge, getAPIKey, getAuthorizationCode, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getCluster, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getFile, getFileItem, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, getRecord, getSchema, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getUserOAuthAccessTokens, getUserOAuthClients, getWorkspace, getWorkspaceMembersList, getWorkspacesList, grantAuthorizationCode, greaterEquals, greaterThan, greaterThanEquals, gt, gte, iContains, iPattern, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isValidExpandedColumn, isValidSelectableColumns, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listClusters, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, pgRollJobStatus, pgRollMigrationHistory, pgRollStatus, previewBranchSchemaEdit, pushBranchMigrations, putFile, putFileItem, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, renameDatabase, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, sqlQuery, startsWith, summarizeTable, transformImage, updateBranchMetadata, updateBranchSchema, updateCluster, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateOAuthAccessToken, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
|
11281
|
+
export { type AcceptWorkspaceMemberInviteError, type AcceptWorkspaceMemberInvitePathParams, type AcceptWorkspaceMemberInviteVariables, type AdaptAllTablesError, type AdaptAllTablesPathParams, type AdaptAllTablesVariables, type AdaptTableError, type AdaptTablePathParams, type AdaptTableVariables, type AddGitBranchesEntryError, type AddGitBranchesEntryPathParams, type AddGitBranchesEntryRequestBody, type AddGitBranchesEntryResponse, type AddGitBranchesEntryVariables, type AddTableColumnError, type AddTableColumnPathParams, type AddTableColumnVariables, type AggregateTableError, type AggregateTablePathParams, type AggregateTableRequestBody, type AggregateTableVariables, type ApiExtraProps, type ApplyBranchSchemaEditError, type ApplyBranchSchemaEditPathParams, type ApplyBranchSchemaEditRequestBody, type ApplyBranchSchemaEditVariables, type ApplyMigrationError, type ApplyMigrationPathParams, type ApplyMigrationRequestBody, type ApplyMigrationVariables, type AskOptions, type AskResult, type AskTableError, type AskTablePathParams, type AskTableRequestBody, type AskTableResponse, type AskTableSessionError, type AskTableSessionPathParams, type AskTableSessionRequestBody, type AskTableSessionResponse, type AskTableSessionVariables, type AskTableVariables, BaseClient, type BaseClientOptions, type BaseData, type BaseSchema, type BinaryFile, type BranchTransactionError, type BranchTransactionPathParams, type BranchTransactionRequestBody, type BranchTransactionVariables, Buffer, type BulkInsertTableRecordsError, type BulkInsertTableRecordsPathParams, type BulkInsertTableRecordsQueryParams, type BulkInsertTableRecordsRequestBody, type BulkInsertTableRecordsVariables, type CacheImpl, type CancelWorkspaceMemberInviteError, type CancelWorkspaceMemberInvitePathParams, type CancelWorkspaceMemberInviteVariables, type ClientConstructor, type ColumnsByValue, type CompareBranchSchemasError, type CompareBranchSchemasPathParams, type CompareBranchSchemasRequestBody, type CompareBranchSchemasVariables, type CompareBranchWithUserSchemaError, type CompareBranchWithUserSchemaPathParams, type CompareBranchWithUserSchemaRequestBody, type CompareBranchWithUserSchemaVariables, type CompareMigrationRequestError, type CompareMigrationRequestPathParams, type CompareMigrationRequestVariables, type CompleteMigrationError, type CompleteMigrationPathParams, type CompleteMigrationRequestBody, type CompleteMigrationVariables, type CopyBranchError, type CopyBranchPathParams, type CopyBranchRequestBody, type CopyBranchVariables, type CreateBranchError, type CreateBranchPathParams, type CreateBranchQueryParams, type CreateBranchRequestBody, type CreateBranchResponse, type CreateBranchVariables, type CreateClusterError, type CreateClusterPathParams, type CreateClusterVariables, type CreateDatabaseError, type CreateDatabasePathParams, type CreateDatabaseRequestBody, type CreateDatabaseResponse, type CreateDatabaseVariables, type CreateMigrationRequestError, type CreateMigrationRequestPathParams, type CreateMigrationRequestRequestBody, type CreateMigrationRequestResponse, type CreateMigrationRequestVariables, type CreateTableError, type CreateTablePathParams, type CreateTableResponse, type CreateTableVariables, type CreateUserAPIKeyError, type CreateUserAPIKeyPathParams, type CreateUserAPIKeyResponse, type CreateUserAPIKeyVariables, type CreateWorkspaceError, type CreateWorkspaceVariables, type CursorNavigationOptions, type DeleteBranchError, type DeleteBranchPathParams, type DeleteBranchResponse, type DeleteBranchVariables, type DeleteClusterError, type DeleteClusterPathParams, type DeleteClusterVariables, type DeleteColumnError, type DeleteColumnPathParams, type DeleteColumnVariables, type DeleteDatabaseError, type DeleteDatabaseGithubSettingsError, type DeleteDatabaseGithubSettingsPathParams, type DeleteDatabaseGithubSettingsVariables, type DeleteDatabasePathParams, type DeleteDatabaseResponse, type DeleteDatabaseVariables, type DeleteFileError, type DeleteFileItemError, type DeleteFileItemPathParams, type DeleteFileItemVariables, type DeleteFilePathParams, type DeleteFileVariables, type DeleteOAuthAccessTokenError, type DeleteOAuthAccessTokenPathParams, type DeleteOAuthAccessTokenVariables, type DeleteRecordError, type DeleteRecordPathParams, type DeleteRecordQueryParams, type DeleteRecordVariables, type DeleteTableError, type DeleteTablePathParams, type DeleteTableResponse, type DeleteTableVariables, type DeleteTransactionOperation, type DeleteUserAPIKeyError, type DeleteUserAPIKeyPathParams, type DeleteUserAPIKeyVariables, type DeleteUserError, type DeleteUserOAuthClientError, type DeleteUserOAuthClientPathParams, type DeleteUserOAuthClientVariables, type DeleteUserVariables, type DeleteWorkspaceError, type DeleteWorkspacePathParams, type DeleteWorkspaceVariables, type DeserializedType, type DownloadDestination, type DropClusterExtensionError, type DropClusterExtensionPathParams, type DropClusterExtensionRequestBody, type DropClusterExtensionVariables, type EditableData, type ExecuteBranchMigrationPlanError, type ExecuteBranchMigrationPlanPathParams, type ExecuteBranchMigrationPlanRequestBody, type ExecuteBranchMigrationPlanVariables, type FetchImpl, FetcherError, type FetcherExtraProps, type FileAccessError, type FileAccessPathParams, type FileAccessQueryParams, type FileAccessVariables, type FileUploadError, type FileUploadPathParams, type FileUploadQueryParams, type FileUploadVariables, FilesPlugin, type FilesPluginResult, type GetAuthorizationCodeError, type GetAuthorizationCodeQueryParams, type GetAuthorizationCodeVariables, type GetBranchDetailsError, type GetBranchDetailsPathParams, type GetBranchDetailsVariables, type GetBranchListError, type GetBranchListPathParams, type GetBranchListVariables, type GetBranchMetadataError, type GetBranchMetadataPathParams, type GetBranchMetadataVariables, type GetBranchMigrationHistoryError, type GetBranchMigrationHistoryPathParams, type GetBranchMigrationHistoryRequestBody, type GetBranchMigrationHistoryResponse, type GetBranchMigrationHistoryVariables, type GetBranchMigrationJobStatusError, type GetBranchMigrationJobStatusPathParams, type GetBranchMigrationJobStatusVariables, type GetBranchMigrationPlanError, type GetBranchMigrationPlanPathParams, type GetBranchMigrationPlanVariables, type GetBranchMoveStatusError, type GetBranchMoveStatusPathParams, type GetBranchMoveStatusResponse, type GetBranchMoveStatusVariables, type GetBranchSchemaHistoryError, type GetBranchSchemaHistoryPathParams, type GetBranchSchemaHistoryRequestBody, type GetBranchSchemaHistoryResponse, type GetBranchSchemaHistoryVariables, type GetBranchStatsError, type GetBranchStatsPathParams, type GetBranchStatsResponse, type GetBranchStatsVariables, type GetClusterError, type GetClusterMetricsError, type GetClusterMetricsPathParams, type GetClusterMetricsQueryParams, type GetClusterMetricsVariables, type GetClusterPathParams, type GetClusterVariables, type GetColumnError, type GetColumnPathParams, type GetColumnVariables, type GetDatabaseGithubSettingsError, type GetDatabaseGithubSettingsPathParams, type GetDatabaseGithubSettingsVariables, type GetDatabaseListError, type GetDatabaseListPathParams, type GetDatabaseListVariables, type GetDatabaseMetadataError, type GetDatabaseMetadataPathParams, type GetDatabaseMetadataVariables, type GetDatabaseSettingsError, type GetDatabaseSettingsPathParams, type GetDatabaseSettingsVariables, type GetFileError, type GetFileItemError, type GetFileItemPathParams, type GetFileItemVariables, type GetFilePathParams, type GetFileVariables, type GetGitBranchesMappingError, type GetGitBranchesMappingPathParams, type GetGitBranchesMappingVariables, type GetMigrationHistoryError, type GetMigrationHistoryPathParams, type GetMigrationHistoryQueryParams, type GetMigrationHistoryVariables, type GetMigrationJobStatusError, type GetMigrationJobStatusPathParams, type GetMigrationJobStatusVariables, type GetMigrationJobsError, type GetMigrationJobsPathParams, type GetMigrationJobsQueryParams, type GetMigrationJobsVariables, type GetMigrationRequestError, type GetMigrationRequestIsMergedError, type GetMigrationRequestIsMergedPathParams, type GetMigrationRequestIsMergedResponse, type GetMigrationRequestIsMergedVariables, type GetMigrationRequestPathParams, type GetMigrationRequestVariables, type GetRecordError, type GetRecordPathParams, type GetRecordQueryParams, type GetRecordVariables, type GetSchemaError, type GetSchemaPathParams, type GetSchemaResponse, type GetSchemaVariables, type GetSchemasError, type GetSchemasPathParams, type GetSchemasResponse, type GetSchemasVariables, type GetTableColumnsError, type GetTableColumnsPathParams, type GetTableColumnsResponse, type GetTableColumnsVariables, type GetTableSchemaError, type GetTableSchemaPathParams, type GetTableSchemaResponse, type GetTableSchemaVariables, type GetTransactionOperation, type GetUserAPIKeysError, type GetUserAPIKeysResponse, type GetUserAPIKeysVariables, type GetUserError, type GetUserOAuthAccessTokensError, type GetUserOAuthAccessTokensResponse, type GetUserOAuthAccessTokensVariables, type GetUserOAuthClientsError, type GetUserOAuthClientsResponse, type GetUserOAuthClientsVariables, type GetUserVariables, type GetWorkspaceError, type GetWorkspaceMembersListError, type GetWorkspaceMembersListPathParams, type GetWorkspaceMembersListVariables, type GetWorkspacePathParams, type GetWorkspaceSettingsError, type GetWorkspaceSettingsPathParams, type GetWorkspaceSettingsVariables, type GetWorkspaceVariables, type GetWorkspacesListError, type GetWorkspacesListResponse, type GetWorkspacesListVariables, type GrantAuthorizationCodeError, type GrantAuthorizationCodeVariables, type HostProvider, type Identifiable, type ImageTransformations, type InsertRecordError, type InsertRecordPathParams, type InsertRecordQueryParams, type InsertRecordVariables, type InsertRecordWithIDError, type InsertRecordWithIDPathParams, type InsertRecordWithIDQueryParams, type InsertRecordWithIDVariables, type InsertTransactionOperation, type InstallClusterExtensionError, type InstallClusterExtensionPathParams, type InstallClusterExtensionRequestBody, type InstallClusterExtensionVariables, type InviteWorkspaceMemberError, type InviteWorkspaceMemberPathParams, type InviteWorkspaceMemberRequestBody, type InviteWorkspaceMemberVariables, type JSONData, type KeywordAskOptions, type Link, type ListClusterBranchesError, type ListClusterBranchesPathParams, type ListClusterBranchesQueryParams, type ListClusterBranchesVariables, type ListClusterExtensionsError, type ListClusterExtensionsPathParams, type ListClusterExtensionsQueryParams, type ListClusterExtensionsVariables, type ListClustersError, type ListClustersPathParams, type ListClustersQueryParams, type ListClustersVariables, type ListMigrationRequestsCommitsError, type ListMigrationRequestsCommitsPathParams, type ListMigrationRequestsCommitsRequestBody, type ListMigrationRequestsCommitsResponse, type ListMigrationRequestsCommitsVariables, type ListRegionsError, type ListRegionsPathParams, type ListRegionsVariables, type MergeMigrationRequestError, type MergeMigrationRequestPathParams, type MergeMigrationRequestVariables, type MoveBranchError, type MoveBranchPathParams, type MoveBranchRequestBody, type MoveBranchResponse, type MoveBranchVariables, type OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, PageRecordArray, type Paginable, type PaginationQueryMeta, type PreviewBranchSchemaEditError, type PreviewBranchSchemaEditPathParams, type PreviewBranchSchemaEditRequestBody, type PreviewBranchSchemaEditResponse, type PreviewBranchSchemaEditVariables, type PushBranchMigrationsError, type PushBranchMigrationsPathParams, type PushBranchMigrationsRequestBody, type PushBranchMigrationsVariables, type PutFileError, type PutFileItemError, type PutFileItemPathParams, type PutFileItemVariables, type PutFilePathParams, type PutFileVariables, Query, type QueryMigrationRequestsError, type QueryMigrationRequestsPathParams, type QueryMigrationRequestsRequestBody, type QueryMigrationRequestsResponse, type QueryMigrationRequestsVariables, type QueryTableError, type QueryTablePathParams, type QueryTableRequestBody, type QueryTableVariables, RecordArray, RecordColumnTypes, type RemoveGitBranchesEntryError, type RemoveGitBranchesEntryPathParams, type RemoveGitBranchesEntryQueryParams, type RemoveGitBranchesEntryVariables, type RemoveWorkspaceMemberError, type RemoveWorkspaceMemberPathParams, type RemoveWorkspaceMemberVariables, type RenameDatabaseError, type RenameDatabasePathParams, type RenameDatabaseRequestBody, type RenameDatabaseVariables, Repository, type ResendWorkspaceMemberInviteError, type ResendWorkspaceMemberInvitePathParams, type ResendWorkspaceMemberInviteVariables, type ResolveBranchError, type ResolveBranchPathParams, type ResolveBranchQueryParams, type ResolveBranchResponse, type ResolveBranchVariables, responses as Responses, RestRepository, type RollbackMigrationError, type RollbackMigrationPathParams, type RollbackMigrationRequestBody, type RollbackMigrationVariables, type SQLBatchQuery, SQLPlugin, type SQLPluginResult, type SQLQuery, type SQLQueryParams, type SQLQueryResult, type SchemaDefinition, type SchemaInference, SchemaPlugin, type SchemaPluginResult, schemas as Schemas, type SearchBranchError, type SearchBranchPathParams, type SearchBranchRequestBody, type SearchBranchVariables, type SearchOptions, SearchPlugin, type SearchPluginResult, type SearchTableError, type SearchTablePathParams, type SearchTableRequestBody, type SearchTableVariables, type SearchXataRecord, type SelectableColumn, type SelectableColumnWithObjectNotation, type SelectedPick, type SerializedString, Serializer, type SerializerResult, type SetTableSchemaError, type SetTableSchemaPathParams, type SetTableSchemaRequestBody, type SetTableSchemaVariables, SimpleCache, type SimpleCacheOptions, type SqlBatchQueryError, type SqlBatchQueryPathParams, type SqlBatchQueryRequestBody, type SqlBatchQueryVariables, type SqlQueryError, type SqlQueryPathParams, type SqlQueryRequestBody, type SqlQueryVariables, type StartMigrationError, type StartMigrationPathParams, type StartMigrationRequestBody, type StartMigrationVariables, type SummarizeTableError, type SummarizeTablePathParams, type SummarizeTableRequestBody, type SummarizeTableVariables, type TotalCount, type TransactionOperation, TransactionPlugin, type TransactionPluginResult, type TransactionResults, type UpdateBranchMetadataError, type UpdateBranchMetadataPathParams, type UpdateBranchMetadataVariables, type UpdateBranchSchemaError, type UpdateBranchSchemaPathParams, type UpdateBranchSchemaVariables, type UpdateClusterError, type UpdateClusterPathParams, type UpdateClusterVariables, type UpdateColumnError, type UpdateColumnPathParams, type UpdateColumnRequestBody, type UpdateColumnVariables, type UpdateDatabaseGithubSettingsError, type UpdateDatabaseGithubSettingsPathParams, type UpdateDatabaseGithubSettingsVariables, type UpdateDatabaseMetadataError, type UpdateDatabaseMetadataPathParams, type UpdateDatabaseMetadataRequestBody, type UpdateDatabaseMetadataVariables, type UpdateDatabaseSettingsError, type UpdateDatabaseSettingsPathParams, type UpdateDatabaseSettingsRequestBody, type UpdateDatabaseSettingsVariables, type UpdateMigrationRequestError, type UpdateMigrationRequestPathParams, type UpdateMigrationRequestRequestBody, type UpdateMigrationRequestVariables, type UpdateOAuthAccessTokenError, type UpdateOAuthAccessTokenPathParams, type UpdateOAuthAccessTokenRequestBody, type UpdateOAuthAccessTokenVariables, type UpdateRecordWithIDError, type UpdateRecordWithIDPathParams, type UpdateRecordWithIDQueryParams, type UpdateRecordWithIDVariables, type UpdateTableError, type UpdateTablePathParams, type UpdateTableRequestBody, type UpdateTableVariables, type UpdateTransactionOperation, type UpdateUserError, type UpdateUserVariables, type UpdateWorkspaceError, type UpdateWorkspaceMemberInviteError, type UpdateWorkspaceMemberInvitePathParams, type UpdateWorkspaceMemberInviteRequestBody, type UpdateWorkspaceMemberInviteVariables, type UpdateWorkspaceMemberRoleError, type UpdateWorkspaceMemberRolePathParams, type UpdateWorkspaceMemberRoleRequestBody, type UpdateWorkspaceMemberRoleVariables, type UpdateWorkspacePathParams, type UpdateWorkspaceSettingsError, type UpdateWorkspaceSettingsPathParams, type UpdateWorkspaceSettingsVariables, type UpdateWorkspaceVariables, type UploadDestination, type UpsertRecordWithIDError, type UpsertRecordWithIDPathParams, type UpsertRecordWithIDQueryParams, type UpsertRecordWithIDVariables, type ValueAtColumn, type VectorAskOptions, type VectorSearchTableError, type VectorSearchTablePathParams, type VectorSearchTableRequestBody, type VectorSearchTableVariables, XataApiClient, type XataApiClientOptions, XataApiPlugin, type XataArrayFile, XataError, XataFile, XataPlugin, type XataPluginOptions, type XataRecord, acceptWorkspaceMemberInvite, adaptAllTables, adaptTable, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, applyMigration, askTable, askTableSession, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, completeMigration, contains, copyBranch, createBranch, createCluster, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteCluster, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteFile, deleteFileItem, deleteOAuthAccessToken, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteUserOAuthClient, deleteWorkspace, deserialize, dropClusterExtension, endsWith, equals, executeBranchMigrationPlan, exists, fileAccess, fileUpload, ge, getAPIKey, getAuthorizationCode, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationJobStatus, getBranchMigrationPlan, getBranchMoveStatus, getBranchSchemaHistory, getBranchStats, getCluster, getClusterMetrics, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseSettings, getDatabaseURL, getFile, getFileItem, getGitBranchesMapping, getHostUrl, getMigrationHistory, getMigrationJobStatus, getMigrationJobs, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, getRecord, getSchema, getSchemas, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getUserOAuthAccessTokens, getUserOAuthClients, getWorkspace, getWorkspaceMembersList, getWorkspaceSettings, getWorkspacesList, grantAuthorizationCode, greaterEquals, greaterThan, greaterThanEquals, gt, gte, iContains, iPattern, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, installClusterExtension, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isValidExpandedColumn, isValidSelectableColumns, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listClusterBranches, listClusterExtensions, listClusters, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, moveBranch, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, pushBranchMigrations, putFile, putFileItem, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, renameDatabase, resendWorkspaceMemberInvite, resolveBranch, rollbackMigration, searchBranch, searchTable, serialize, setTableSchema, sqlBatchQuery, sqlQuery, startMigration, startsWith, summarizeTable, transformImage, updateBranchMetadata, updateBranchSchema, updateCluster, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateDatabaseSettings, updateMigrationRequest, updateOAuthAccessToken, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, updateWorkspaceSettings, upsertRecordWithID, vectorSearchTable };
|