@xata.io/client 0.0.0-alpha.vf501d195ec7907e696637eff52ae02941341dca1 → 0.0.0-alpha.vf549885c8da45e1041f8dcaf2060a77aa75becb1
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 +4 -4
- package/CHANGELOG.md +52 -2
- package/dist/index.cjs +3789 -3009
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +2049 -996
- package/dist/index.mjs +3768 -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,131 @@ 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 MetricMessage = {
|
163
|
+
code?: string;
|
164
|
+
value?: string;
|
165
|
+
};
|
166
|
+
/**
|
167
|
+
* @x-internal true
|
168
|
+
*/
|
169
|
+
type MetricData = {
|
170
|
+
id?: string;
|
171
|
+
label?: string;
|
172
|
+
messages?: MetricMessage[] | null;
|
173
|
+
status: 'complete' | 'error' | 'partial' | 'forbidden';
|
174
|
+
timestamps: string[];
|
175
|
+
values: number[];
|
176
|
+
};
|
177
|
+
/**
|
178
|
+
* @x-internal true
|
179
|
+
*/
|
180
|
+
type MetricsResponse = {
|
181
|
+
metrics: MetricData[];
|
182
|
+
messages: MetricMessage[];
|
183
|
+
page?: PageResponse$1;
|
184
|
+
};
|
63
185
|
/**
|
64
186
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
65
187
|
*
|
@@ -68,15 +190,156 @@ type FetchImpl = (url: string, init?: RequestInit) => Promise<Response>;
|
|
68
190
|
* @pattern [a-zA-Z0-9_\-~]+:[a-zA-Z0-9_\-~]+
|
69
191
|
*/
|
70
192
|
type DBBranchName = string;
|
71
|
-
type
|
193
|
+
type ApplyMigrationResponse = {
|
194
|
+
/**
|
195
|
+
* The id of the migration job
|
196
|
+
*/
|
197
|
+
jobID: string;
|
198
|
+
};
|
199
|
+
type StartMigrationResponse = {
|
200
|
+
/**
|
201
|
+
* The id of the migration job
|
202
|
+
*/
|
203
|
+
jobID: string;
|
204
|
+
};
|
205
|
+
type CompleteMigrationResponse = {
|
206
|
+
/**
|
207
|
+
* The id of the migration job
|
208
|
+
*/
|
209
|
+
jobID: string;
|
210
|
+
};
|
211
|
+
type RollbackMigrationResponse = {
|
212
|
+
/**
|
213
|
+
* The id of the migration job
|
214
|
+
*/
|
215
|
+
jobID: string;
|
216
|
+
};
|
217
|
+
/**
|
218
|
+
* @maxLength 255
|
219
|
+
* @minLength 1
|
220
|
+
* @pattern [a-zA-Z0-9_\-~]+
|
221
|
+
*/
|
222
|
+
type TableName = string;
|
223
|
+
type MigrationJobType = 'apply' | 'start' | 'complete' | 'rollback';
|
224
|
+
type MigrationJobStatus = 'pending' | 'in_progress' | 'completed' | 'failed';
|
225
|
+
/**
|
226
|
+
* The effect of a migration operation in terms of CRUD operations on the underlying schema
|
227
|
+
*/
|
228
|
+
type MigrationOperationDescription = {
|
229
|
+
/**
|
230
|
+
* A new database object created by the operation
|
231
|
+
*/
|
232
|
+
create?: {
|
233
|
+
/**
|
234
|
+
* The type of object created
|
235
|
+
*/
|
236
|
+
type: 'table' | 'column' | 'index';
|
237
|
+
/**
|
238
|
+
* The name of the object created
|
239
|
+
*/
|
240
|
+
name: string;
|
241
|
+
/**
|
242
|
+
* The name of the table on which the object is created, if applicable
|
243
|
+
*/
|
244
|
+
table?: string;
|
245
|
+
/**
|
246
|
+
* The mapping between the virtual and physical name of the new object, if applicable
|
247
|
+
*/
|
248
|
+
mapping?: Record<string, any>;
|
249
|
+
};
|
250
|
+
/**
|
251
|
+
* A database object updated by the operation
|
252
|
+
*/
|
253
|
+
update?: {
|
254
|
+
/**
|
255
|
+
* The type of updated object
|
256
|
+
*/
|
257
|
+
type: 'table' | 'column';
|
258
|
+
/**
|
259
|
+
* The name of the updated object
|
260
|
+
*/
|
261
|
+
name: string;
|
262
|
+
/**
|
263
|
+
* The name of the table on which the object is updated, if applicable
|
264
|
+
*/
|
265
|
+
table?: string;
|
266
|
+
/**
|
267
|
+
* The mapping between the virtual and physical name of the updated object, if applicable
|
268
|
+
*/
|
269
|
+
mapping?: Record<string, any>;
|
270
|
+
};
|
271
|
+
/**
|
272
|
+
* A database object renamed by the operation
|
273
|
+
*/
|
274
|
+
rename?: {
|
275
|
+
/**
|
276
|
+
* The type of the renamed object
|
277
|
+
*/
|
278
|
+
type: 'table' | 'column' | 'constraint';
|
279
|
+
/**
|
280
|
+
* The name of the table on which the object is renamed, if applicable
|
281
|
+
*/
|
282
|
+
table?: string;
|
283
|
+
/**
|
284
|
+
* The old name of the renamed object
|
285
|
+
*/
|
286
|
+
from: string;
|
287
|
+
/**
|
288
|
+
* The new name of the renamed object
|
289
|
+
*/
|
290
|
+
to: string;
|
291
|
+
};
|
292
|
+
/**
|
293
|
+
* A database object deleted by the operation
|
294
|
+
*/
|
295
|
+
['delete']?: {
|
296
|
+
/**
|
297
|
+
* The type of the deleted object
|
298
|
+
*/
|
299
|
+
type: 'table' | 'column' | 'constraint' | 'index';
|
300
|
+
/**
|
301
|
+
* The name of the deleted object
|
302
|
+
*/
|
303
|
+
name: string;
|
304
|
+
/**
|
305
|
+
* The name of the table on which the object is deleted, if applicable
|
306
|
+
*/
|
307
|
+
table: string;
|
308
|
+
};
|
309
|
+
};
|
310
|
+
/**
|
311
|
+
* @minItems 1
|
312
|
+
*/
|
313
|
+
type MigrationDescription = MigrationOperationDescription[];
|
314
|
+
type MigrationJobStatusResponse = {
|
72
315
|
/**
|
73
316
|
* The id of the migration job
|
74
317
|
*/
|
75
318
|
jobID: string;
|
319
|
+
/**
|
320
|
+
* The type of the migration job
|
321
|
+
*/
|
322
|
+
type: MigrationJobType;
|
323
|
+
/**
|
324
|
+
* The status of the migration job
|
325
|
+
*/
|
326
|
+
status: MigrationJobStatus;
|
327
|
+
/**
|
328
|
+
* The effect of any active migration on the schema
|
329
|
+
*/
|
330
|
+
description?: MigrationDescription;
|
331
|
+
/**
|
332
|
+
* The timestamp at which the migration job completed or failed
|
333
|
+
*
|
334
|
+
* @format date-time
|
335
|
+
*/
|
336
|
+
completedAt?: string;
|
337
|
+
/**
|
338
|
+
* The error message associated with the migration job
|
339
|
+
*/
|
340
|
+
error?: string;
|
76
341
|
};
|
77
|
-
type
|
78
|
-
type PgRollJobStatus = 'pending' | 'in_progress' | 'completed' | 'failed';
|
79
|
-
type PgRollJobStatusResponse = {
|
342
|
+
type MigrationJobItem = {
|
80
343
|
/**
|
81
344
|
* The id of the migration job
|
82
345
|
*/
|
@@ -84,24 +347,54 @@ type PgRollJobStatusResponse = {
|
|
84
347
|
/**
|
85
348
|
* The type of the migration job
|
86
349
|
*/
|
87
|
-
type:
|
350
|
+
type: MigrationJobType;
|
88
351
|
/**
|
89
352
|
* The status of the migration job
|
90
353
|
*/
|
91
|
-
status:
|
354
|
+
status: MigrationJobStatus;
|
355
|
+
/**
|
356
|
+
* The pgroll migration that was applied
|
357
|
+
*/
|
358
|
+
migration?: string;
|
359
|
+
/**
|
360
|
+
* The effect of any active migration on the schema
|
361
|
+
*/
|
362
|
+
description?: MigrationDescription;
|
363
|
+
/**
|
364
|
+
* The timestamp at which the migration job was enqueued
|
365
|
+
*
|
366
|
+
* @format date-time
|
367
|
+
*/
|
368
|
+
enqueuedAt: string;
|
369
|
+
/**
|
370
|
+
* The timestamp at which the migration job completed or failed
|
371
|
+
*
|
372
|
+
* @format date-time
|
373
|
+
*/
|
374
|
+
completedAt?: string;
|
92
375
|
/**
|
93
376
|
* The error message associated with the migration job
|
94
377
|
*/
|
95
378
|
error?: string;
|
96
379
|
};
|
380
|
+
type GetMigrationJobsResponse = {
|
381
|
+
/**
|
382
|
+
* The list of migration jobs
|
383
|
+
*/
|
384
|
+
jobs: MigrationJobItem[];
|
385
|
+
/**
|
386
|
+
* The cursor (timestamp) for the next page of results
|
387
|
+
*/
|
388
|
+
cursor?: string;
|
389
|
+
};
|
97
390
|
/**
|
98
391
|
* @maxLength 255
|
99
392
|
* @minLength 1
|
100
393
|
* @pattern [a-zA-Z0-9_\-~]+
|
101
394
|
*/
|
102
|
-
type
|
103
|
-
type
|
104
|
-
type
|
395
|
+
type MigrationJobID = string;
|
396
|
+
type MigrationType = 'pgroll' | 'inferred';
|
397
|
+
type MigrationHistoryItem = {
|
105
398
|
/**
|
106
399
|
* The name of the migration
|
107
400
|
*/
|
@@ -127,13 +420,17 @@ type PgRollMigrationHistoryItem = {
|
|
127
420
|
/**
|
128
421
|
* The type of the migration
|
129
422
|
*/
|
130
|
-
migrationType:
|
423
|
+
migrationType: MigrationType;
|
131
424
|
};
|
132
|
-
type
|
425
|
+
type MigrationHistoryResponse = {
|
133
426
|
/**
|
134
427
|
* The migrations that have been applied to the branch
|
135
428
|
*/
|
136
|
-
migrations:
|
429
|
+
migrations: MigrationHistoryItem[];
|
430
|
+
/**
|
431
|
+
* The cursor (timestamp) for the next page of results
|
432
|
+
*/
|
433
|
+
cursor?: string;
|
137
434
|
};
|
138
435
|
/**
|
139
436
|
* @maxLength 255
|
@@ -142,25 +439,29 @@ type PgRollMigrationHistoryResponse = {
|
|
142
439
|
*/
|
143
440
|
type DBName$1 = string;
|
144
441
|
/**
|
145
|
-
*
|
146
|
-
* @x-go-type string
|
442
|
+
* Represent the state of the branch, used for branch lifecycle management
|
147
443
|
*/
|
148
|
-
type
|
444
|
+
type BranchState = 'active' | 'move_scheduled' | 'moving';
|
149
445
|
type Branch = {
|
150
446
|
name: string;
|
151
447
|
/**
|
152
448
|
* The cluster where this branch resides. Value of 'shared-cluster' for branches in shared clusters
|
153
449
|
*
|
154
450
|
* @minLength 1
|
155
|
-
* @x-internal true
|
156
451
|
*/
|
157
452
|
clusterID?: string;
|
453
|
+
state: BranchState;
|
158
454
|
createdAt: DateTime$1;
|
455
|
+
searchDisabled?: boolean;
|
456
|
+
inactiveSharedCluster?: boolean;
|
159
457
|
};
|
160
458
|
type ListBranchesResponse = {
|
161
459
|
databaseName: string;
|
162
460
|
branches: Branch[];
|
163
461
|
};
|
462
|
+
type DatabaseSettings = {
|
463
|
+
searchEnabled: boolean;
|
464
|
+
};
|
164
465
|
/**
|
165
466
|
* @maxLength 255
|
166
467
|
* @minLength 1
|
@@ -188,12 +489,6 @@ type StartedFromMetadata = {
|
|
188
489
|
dbBranchID: string;
|
189
490
|
migrationID: string;
|
190
491
|
};
|
191
|
-
/**
|
192
|
-
* @maxLength 255
|
193
|
-
* @minLength 1
|
194
|
-
* @pattern [a-zA-Z0-9_\-~]+
|
195
|
-
*/
|
196
|
-
type TableName = string;
|
197
492
|
type ColumnLink = {
|
198
493
|
table: string;
|
199
494
|
};
|
@@ -209,7 +504,7 @@ type ColumnFile = {
|
|
209
504
|
};
|
210
505
|
type Column = {
|
211
506
|
name: string;
|
212
|
-
type:
|
507
|
+
type: string;
|
213
508
|
link?: ColumnLink;
|
214
509
|
vector?: ColumnVector;
|
215
510
|
file?: ColumnFile;
|
@@ -248,12 +543,63 @@ type DBBranch = {
|
|
248
543
|
*/
|
249
544
|
clusterID?: string;
|
250
545
|
version: number;
|
546
|
+
state: BranchState;
|
251
547
|
lastMigrationID: string;
|
252
548
|
metadata?: BranchMetadata$1;
|
253
549
|
startedFrom?: StartedFromMetadata;
|
254
550
|
schema: Schema;
|
255
551
|
};
|
256
552
|
type MigrationStatus$1 = 'completed' | 'pending' | 'failed';
|
553
|
+
type BranchSchema = {
|
554
|
+
name: string;
|
555
|
+
tables: {
|
556
|
+
[key: string]: {
|
557
|
+
oid: string;
|
558
|
+
name: string;
|
559
|
+
xataCompatible: boolean;
|
560
|
+
comment: string;
|
561
|
+
columns: {
|
562
|
+
[key: string]: {
|
563
|
+
name: string;
|
564
|
+
type: string;
|
565
|
+
['default']: string | null;
|
566
|
+
nullable: boolean;
|
567
|
+
unique: boolean;
|
568
|
+
comment: string;
|
569
|
+
};
|
570
|
+
};
|
571
|
+
indexes: {
|
572
|
+
[key: string]: {
|
573
|
+
name: string;
|
574
|
+
unique: boolean;
|
575
|
+
columns: string[];
|
576
|
+
};
|
577
|
+
};
|
578
|
+
primaryKey: string[];
|
579
|
+
foreignKeys: {
|
580
|
+
[key: string]: {
|
581
|
+
name: string;
|
582
|
+
columns: string[];
|
583
|
+
referencedTable: string;
|
584
|
+
referencedColumns: string[];
|
585
|
+
};
|
586
|
+
};
|
587
|
+
checkConstraints: {
|
588
|
+
[key: string]: {
|
589
|
+
name: string;
|
590
|
+
columns: string[];
|
591
|
+
definition: string;
|
592
|
+
};
|
593
|
+
};
|
594
|
+
uniqueConstraints: {
|
595
|
+
[key: string]: {
|
596
|
+
name: string;
|
597
|
+
columns: string[];
|
598
|
+
};
|
599
|
+
};
|
600
|
+
};
|
601
|
+
};
|
602
|
+
};
|
257
603
|
type BranchWithCopyID = {
|
258
604
|
branchName: BranchName$1;
|
259
605
|
dbBranchID: string;
|
@@ -906,6 +1252,40 @@ type RecordMeta = {
|
|
906
1252
|
*/
|
907
1253
|
warnings?: string[];
|
908
1254
|
};
|
1255
|
+
} | {
|
1256
|
+
xata_id: RecordID;
|
1257
|
+
/**
|
1258
|
+
* The record's version. Can be used for optimistic concurrency control.
|
1259
|
+
*/
|
1260
|
+
xata_version: number;
|
1261
|
+
/**
|
1262
|
+
* The time when the record was created.
|
1263
|
+
*/
|
1264
|
+
xata_createdat?: string;
|
1265
|
+
/**
|
1266
|
+
* The time when the record was last updated.
|
1267
|
+
*/
|
1268
|
+
xata_updatedat?: string;
|
1269
|
+
/**
|
1270
|
+
* The record's table name. APIs that return records from multiple tables will set this field accordingly.
|
1271
|
+
*/
|
1272
|
+
xata_table?: string;
|
1273
|
+
/**
|
1274
|
+
* Highlights of the record. This is used by the search APIs to indicate which fields and parts of the fields have matched the search.
|
1275
|
+
*/
|
1276
|
+
xata_highlight?: {
|
1277
|
+
[key: string]: string[] | {
|
1278
|
+
[key: string]: any;
|
1279
|
+
};
|
1280
|
+
};
|
1281
|
+
/**
|
1282
|
+
* The record's relevancy score. This is returned by the search APIs.
|
1283
|
+
*/
|
1284
|
+
xata_score?: number;
|
1285
|
+
/**
|
1286
|
+
* Encoding/Decoding errors
|
1287
|
+
*/
|
1288
|
+
xata_warnings?: string[];
|
909
1289
|
};
|
910
1290
|
/**
|
911
1291
|
* File metadata
|
@@ -915,13 +1295,43 @@ type FileResponse = {
|
|
915
1295
|
name: FileName;
|
916
1296
|
mediaType: MediaType;
|
917
1297
|
/**
|
918
|
-
*
|
1298
|
+
* Enable public access to the file
|
919
1299
|
*/
|
920
|
-
|
1300
|
+
enablePublicUrl: boolean;
|
1301
|
+
/**
|
1302
|
+
* Time to live for signed URLs
|
1303
|
+
*/
|
1304
|
+
signedUrlTimeout: number;
|
1305
|
+
/**
|
1306
|
+
* Time to live for signed URLs
|
1307
|
+
*/
|
1308
|
+
uploadUrlTimeout: number;
|
1309
|
+
/**
|
1310
|
+
* @format int64
|
1311
|
+
*/
|
1312
|
+
size: number;
|
921
1313
|
/**
|
922
1314
|
* @format int64
|
923
1315
|
*/
|
924
1316
|
version: number;
|
1317
|
+
/**
|
1318
|
+
* File access URL
|
1319
|
+
*
|
1320
|
+
* @format uri
|
1321
|
+
*/
|
1322
|
+
url: string;
|
1323
|
+
/**
|
1324
|
+
* Signed file access URL
|
1325
|
+
*
|
1326
|
+
* @format uri
|
1327
|
+
*/
|
1328
|
+
signedUrl: string;
|
1329
|
+
/**
|
1330
|
+
* Upload file URL
|
1331
|
+
*
|
1332
|
+
* @format uri
|
1333
|
+
*/
|
1334
|
+
uploadUrl: string;
|
925
1335
|
attributes?: Record<string, any>;
|
926
1336
|
};
|
927
1337
|
type QueryColumnsProjection = (string | ProjectionConfig)[];
|
@@ -1369,6 +1779,57 @@ type FileSignature = string;
|
|
1369
1779
|
type SQLRecord = {
|
1370
1780
|
[key: string]: any;
|
1371
1781
|
};
|
1782
|
+
/**
|
1783
|
+
* @default strong
|
1784
|
+
*/
|
1785
|
+
type SQLConsistency = 'strong' | 'eventual';
|
1786
|
+
/**
|
1787
|
+
* @default json
|
1788
|
+
*/
|
1789
|
+
type SQLResponseType$1 = 'json' | 'array';
|
1790
|
+
type PreparedStatement = {
|
1791
|
+
/**
|
1792
|
+
* The SQL statement.
|
1793
|
+
*
|
1794
|
+
* @minLength 1
|
1795
|
+
*/
|
1796
|
+
statement: string;
|
1797
|
+
/**
|
1798
|
+
* The query parameter list.
|
1799
|
+
*
|
1800
|
+
* @x-go-type []any
|
1801
|
+
*/
|
1802
|
+
params?: any[] | null;
|
1803
|
+
};
|
1804
|
+
type SQLResponseBase = {
|
1805
|
+
/**
|
1806
|
+
* Name of the column and its PostgreSQL type
|
1807
|
+
*
|
1808
|
+
* @x-go-type []sqlproxy.ColumnMeta
|
1809
|
+
*/
|
1810
|
+
columns: {
|
1811
|
+
name: string;
|
1812
|
+
type: string;
|
1813
|
+
}[];
|
1814
|
+
/**
|
1815
|
+
* Number of selected columns
|
1816
|
+
*/
|
1817
|
+
total: number;
|
1818
|
+
warning?: string;
|
1819
|
+
};
|
1820
|
+
type SQLResponseJSON = SQLResponseBase & {
|
1821
|
+
/**
|
1822
|
+
* @x-go-type []xata.Record
|
1823
|
+
*/
|
1824
|
+
records: SQLRecord[];
|
1825
|
+
};
|
1826
|
+
type SQLResponseArray = SQLResponseBase & {
|
1827
|
+
/**
|
1828
|
+
* @x-go-type []xata.Row
|
1829
|
+
*/
|
1830
|
+
rows: any[][];
|
1831
|
+
};
|
1832
|
+
type SQLResponse$1 = SQLResponseJSON | SQLResponseArray;
|
1372
1833
|
/**
|
1373
1834
|
* Xata Table Record Metadata
|
1374
1835
|
*/
|
@@ -1425,6 +1886,11 @@ type RecordUpdateResponse = XataRecord$1 | {
|
|
1425
1886
|
createdAt: string;
|
1426
1887
|
updatedAt: string;
|
1427
1888
|
};
|
1889
|
+
} | {
|
1890
|
+
xata_id: string;
|
1891
|
+
xata_version: number;
|
1892
|
+
xata_createdat: string;
|
1893
|
+
xata_updatedat: string;
|
1428
1894
|
};
|
1429
1895
|
type PutFileResponse = FileResponse;
|
1430
1896
|
type RecordResponse = XataRecord$1;
|
@@ -1466,17 +1932,9 @@ type AggResponse = {
|
|
1466
1932
|
[key: string]: AggResponse$1;
|
1467
1933
|
};
|
1468
1934
|
};
|
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;
|
1935
|
+
type SQLResponse = SQLResponse$1;
|
1936
|
+
type SQLBatchResponse = {
|
1937
|
+
results: SQLResponse$1[];
|
1480
1938
|
};
|
1481
1939
|
|
1482
1940
|
/**
|
@@ -1572,6 +2030,10 @@ type Workspace = WorkspaceMeta & {
|
|
1572
2030
|
memberCount: number;
|
1573
2031
|
plan: WorkspacePlan;
|
1574
2032
|
};
|
2033
|
+
type WorkspaceSettings = {
|
2034
|
+
postgresEnabled: boolean;
|
2035
|
+
dedicatedClusters: boolean;
|
2036
|
+
};
|
1575
2037
|
type WorkspaceMember = {
|
1576
2038
|
userId: UserID;
|
1577
2039
|
fullname: string;
|
@@ -1638,6 +2100,8 @@ type ClusterShortMetadata = {
|
|
1638
2100
|
* @format int64
|
1639
2101
|
*/
|
1640
2102
|
branches: number;
|
2103
|
+
createdAt: DateTime;
|
2104
|
+
terminatedAt?: DateTime;
|
1641
2105
|
};
|
1642
2106
|
/**
|
1643
2107
|
* @x-internal true
|
@@ -1735,6 +2199,13 @@ type ClusterConfiguration = {
|
|
1735
2199
|
* @format int64
|
1736
2200
|
*/
|
1737
2201
|
replicas?: number;
|
2202
|
+
/**
|
2203
|
+
* @format int64
|
2204
|
+
* @default 1
|
2205
|
+
* @maximum 3
|
2206
|
+
* @minimum 1
|
2207
|
+
*/
|
2208
|
+
instanceCount?: number;
|
1738
2209
|
/**
|
1739
2210
|
* @default false
|
1740
2211
|
*/
|
@@ -1753,7 +2224,7 @@ type ClusterCreateDetails = {
|
|
1753
2224
|
/**
|
1754
2225
|
* @maxLength 63
|
1755
2226
|
* @minLength 1
|
1756
|
-
* @pattern [a-
|
2227
|
+
* @pattern [a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*
|
1757
2228
|
*/
|
1758
2229
|
name: string;
|
1759
2230
|
configuration: ClusterConfiguration;
|
@@ -1765,6 +2236,57 @@ type ClusterResponse = {
|
|
1765
2236
|
state: string;
|
1766
2237
|
clusterID: string;
|
1767
2238
|
};
|
2239
|
+
/**
|
2240
|
+
* @x-internal true
|
2241
|
+
*/
|
2242
|
+
type AutoscalingConfigResponse = {
|
2243
|
+
/**
|
2244
|
+
* @format double
|
2245
|
+
* @default 0.5
|
2246
|
+
*/
|
2247
|
+
minCapacity: number;
|
2248
|
+
/**
|
2249
|
+
* @format double
|
2250
|
+
* @default 4
|
2251
|
+
*/
|
2252
|
+
maxCapacity: number;
|
2253
|
+
};
|
2254
|
+
/**
|
2255
|
+
* @x-internal true
|
2256
|
+
*/
|
2257
|
+
type MaintenanceConfigResponse = {
|
2258
|
+
/**
|
2259
|
+
* @default false
|
2260
|
+
*/
|
2261
|
+
autoMinorVersionUpgrade: boolean;
|
2262
|
+
/**
|
2263
|
+
* @default false
|
2264
|
+
*/
|
2265
|
+
applyImmediately: boolean;
|
2266
|
+
maintenanceWindow: WeeklyTimeWindow;
|
2267
|
+
backupWindow: DailyTimeWindow;
|
2268
|
+
};
|
2269
|
+
/**
|
2270
|
+
* @x-internal true
|
2271
|
+
*/
|
2272
|
+
type ClusterConfigurationResponse = {
|
2273
|
+
engineVersion: string;
|
2274
|
+
instanceType: string;
|
2275
|
+
/**
|
2276
|
+
* @format int64
|
2277
|
+
*/
|
2278
|
+
replicas: number;
|
2279
|
+
/**
|
2280
|
+
* @format int64
|
2281
|
+
*/
|
2282
|
+
instanceCount: number;
|
2283
|
+
/**
|
2284
|
+
* @default false
|
2285
|
+
*/
|
2286
|
+
deletionProtection: boolean;
|
2287
|
+
autoscaling?: AutoscalingConfigResponse;
|
2288
|
+
maintenance: MaintenanceConfigResponse;
|
2289
|
+
};
|
1768
2290
|
/**
|
1769
2291
|
* @x-internal true
|
1770
2292
|
*/
|
@@ -1777,22 +2299,36 @@ type ClusterMetadata = {
|
|
1777
2299
|
* @format int64
|
1778
2300
|
*/
|
1779
2301
|
branches: number;
|
1780
|
-
configuration
|
2302
|
+
configuration: ClusterConfigurationResponse;
|
1781
2303
|
};
|
1782
2304
|
/**
|
1783
2305
|
* @x-internal true
|
1784
2306
|
*/
|
1785
|
-
type
|
2307
|
+
type ClusterDeleteMetadata = {
|
1786
2308
|
id: ClusterID;
|
2309
|
+
state: string;
|
2310
|
+
region: string;
|
2311
|
+
name: string;
|
1787
2312
|
/**
|
1788
|
-
* @
|
1789
|
-
* @minLength 1
|
1790
|
-
* @pattern [a-zA-Z0-9_-~:]+
|
2313
|
+
* @format int64
|
1791
2314
|
*/
|
1792
|
-
|
1793
|
-
|
1794
|
-
|
1795
|
-
|
2315
|
+
branches: number;
|
2316
|
+
};
|
2317
|
+
/**
|
2318
|
+
* @x-internal true
|
2319
|
+
*/
|
2320
|
+
type ClusterUpdateDetails = {
|
2321
|
+
/**
|
2322
|
+
* @pattern ^[Ss][Tt][Oo][Pp]|[Ss][Tt][Aa][Rr][Tt]$
|
2323
|
+
*/
|
2324
|
+
command: string;
|
2325
|
+
};
|
2326
|
+
/**
|
2327
|
+
* @x-internal true
|
2328
|
+
*/
|
2329
|
+
type ClusterUpdateMetadata = {
|
2330
|
+
id: ClusterID;
|
2331
|
+
state: string;
|
1796
2332
|
};
|
1797
2333
|
/**
|
1798
2334
|
* Metadata of databases
|
@@ -1815,9 +2351,13 @@ type DatabaseMetadata = {
|
|
1815
2351
|
*/
|
1816
2352
|
newMigrations?: boolean;
|
1817
2353
|
/**
|
1818
|
-
*
|
2354
|
+
* The default cluster ID where branches from this database reside. Value of 'shared-cluster' for branches in shared clusters.
|
1819
2355
|
*/
|
1820
2356
|
defaultClusterID?: string;
|
2357
|
+
/**
|
2358
|
+
* The database is accessible via the Postgres protocol
|
2359
|
+
*/
|
2360
|
+
postgresEnabled?: boolean;
|
1821
2361
|
/**
|
1822
2362
|
* Metadata about the database for display in Xata user interfaces
|
1823
2363
|
*/
|
@@ -2251,6 +2791,7 @@ type GetWorkspacesListError = ErrorWrapper$1<{
|
|
2251
2791
|
type GetWorkspacesListResponse = {
|
2252
2792
|
workspaces: {
|
2253
2793
|
id: WorkspaceID;
|
2794
|
+
unique_id: string;
|
2254
2795
|
name: string;
|
2255
2796
|
slug: string;
|
2256
2797
|
role: Role;
|
@@ -2358,6 +2899,62 @@ type DeleteWorkspaceVariables = {
|
|
2358
2899
|
* Delete the workspace with the provided ID
|
2359
2900
|
*/
|
2360
2901
|
declare const deleteWorkspace: (variables: DeleteWorkspaceVariables, signal?: AbortSignal) => Promise<undefined>;
|
2902
|
+
type GetWorkspaceSettingsPathParams = {
|
2903
|
+
/**
|
2904
|
+
* Workspace ID
|
2905
|
+
*/
|
2906
|
+
workspaceId: WorkspaceID;
|
2907
|
+
};
|
2908
|
+
type GetWorkspaceSettingsError = ErrorWrapper$1<{
|
2909
|
+
status: 400;
|
2910
|
+
payload: BadRequestError;
|
2911
|
+
} | {
|
2912
|
+
status: 401;
|
2913
|
+
payload: AuthError;
|
2914
|
+
} | {
|
2915
|
+
status: 403;
|
2916
|
+
payload: AuthError;
|
2917
|
+
} | {
|
2918
|
+
status: 404;
|
2919
|
+
payload: SimpleError;
|
2920
|
+
}>;
|
2921
|
+
type GetWorkspaceSettingsVariables = {
|
2922
|
+
pathParams: GetWorkspaceSettingsPathParams;
|
2923
|
+
} & ControlPlaneFetcherExtraProps;
|
2924
|
+
/**
|
2925
|
+
* Retrieve workspace settings from a workspace ID
|
2926
|
+
*/
|
2927
|
+
declare const getWorkspaceSettings: (variables: GetWorkspaceSettingsVariables, signal?: AbortSignal) => Promise<WorkspaceSettings>;
|
2928
|
+
type UpdateWorkspaceSettingsPathParams = {
|
2929
|
+
/**
|
2930
|
+
* Workspace ID
|
2931
|
+
*/
|
2932
|
+
workspaceId: WorkspaceID;
|
2933
|
+
};
|
2934
|
+
type UpdateWorkspaceSettingsError = 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 UpdateWorkspaceSettingsRequestBody = {
|
2948
|
+
postgresEnabled: boolean;
|
2949
|
+
};
|
2950
|
+
type UpdateWorkspaceSettingsVariables = {
|
2951
|
+
body: UpdateWorkspaceSettingsRequestBody;
|
2952
|
+
pathParams: UpdateWorkspaceSettingsPathParams;
|
2953
|
+
} & ControlPlaneFetcherExtraProps;
|
2954
|
+
/**
|
2955
|
+
* Update workspace settings
|
2956
|
+
*/
|
2957
|
+
declare const updateWorkspaceSettings: (variables: UpdateWorkspaceSettingsVariables, signal?: AbortSignal) => Promise<WorkspaceSettings>;
|
2361
2958
|
type GetWorkspaceMembersListPathParams = {
|
2362
2959
|
/**
|
2363
2960
|
* Workspace ID
|
@@ -2715,7 +3312,31 @@ type UpdateClusterVariables = {
|
|
2715
3312
|
/**
|
2716
3313
|
* Update cluster for given cluster ID
|
2717
3314
|
*/
|
2718
|
-
declare const updateCluster: (variables: UpdateClusterVariables, signal?: AbortSignal) => Promise<
|
3315
|
+
declare const updateCluster: (variables: UpdateClusterVariables, signal?: AbortSignal) => Promise<ClusterUpdateMetadata>;
|
3316
|
+
type DeleteClusterPathParams = {
|
3317
|
+
/**
|
3318
|
+
* Workspace ID
|
3319
|
+
*/
|
3320
|
+
workspaceId: WorkspaceID;
|
3321
|
+
/**
|
3322
|
+
* Cluster ID
|
3323
|
+
*/
|
3324
|
+
clusterId: ClusterID;
|
3325
|
+
};
|
3326
|
+
type DeleteClusterError = ErrorWrapper$1<{
|
3327
|
+
status: 400;
|
3328
|
+
payload: BadRequestError;
|
3329
|
+
} | {
|
3330
|
+
status: 401;
|
3331
|
+
payload: AuthError;
|
3332
|
+
}>;
|
3333
|
+
type DeleteClusterVariables = {
|
3334
|
+
pathParams: DeleteClusterPathParams;
|
3335
|
+
} & ControlPlaneFetcherExtraProps;
|
3336
|
+
/**
|
3337
|
+
* Delete cluster with given cluster ID
|
3338
|
+
*/
|
3339
|
+
declare const deleteCluster: (variables: DeleteClusterVariables, signal?: AbortSignal) => Promise<ClusterDeleteMetadata>;
|
2719
3340
|
type GetDatabaseListPathParams = {
|
2720
3341
|
/**
|
2721
3342
|
* Workspace ID
|
@@ -3064,6 +3685,78 @@ type ErrorWrapper<TError> = TError | {
|
|
3064
3685
|
* @version 1.0
|
3065
3686
|
*/
|
3066
3687
|
|
3688
|
+
type ListClusterBranchesPathParams = {
|
3689
|
+
/**
|
3690
|
+
* Cluster ID
|
3691
|
+
*/
|
3692
|
+
clusterId: ClusterID$1;
|
3693
|
+
workspace: string;
|
3694
|
+
region: string;
|
3695
|
+
};
|
3696
|
+
type ListClusterBranchesQueryParams = {
|
3697
|
+
/**
|
3698
|
+
* Page size
|
3699
|
+
*/
|
3700
|
+
page?: PageSize$1;
|
3701
|
+
/**
|
3702
|
+
* Page token
|
3703
|
+
*/
|
3704
|
+
token?: PageToken$1;
|
3705
|
+
};
|
3706
|
+
type ListClusterBranchesError = ErrorWrapper<{
|
3707
|
+
status: 400;
|
3708
|
+
payload: BadRequestError$1;
|
3709
|
+
} | {
|
3710
|
+
status: 401;
|
3711
|
+
payload: AuthError$1;
|
3712
|
+
}>;
|
3713
|
+
type ListClusterBranchesVariables = {
|
3714
|
+
pathParams: ListClusterBranchesPathParams;
|
3715
|
+
queryParams?: ListClusterBranchesQueryParams;
|
3716
|
+
} & DataPlaneFetcherExtraProps;
|
3717
|
+
/**
|
3718
|
+
* Retrieve branches for given cluster ID
|
3719
|
+
*/
|
3720
|
+
declare const listClusterBranches: (variables: ListClusterBranchesVariables, signal?: AbortSignal) => Promise<ListClusterBranchesResponse>;
|
3721
|
+
type GetClusterMetricsPathParams = {
|
3722
|
+
/**
|
3723
|
+
* Cluster ID
|
3724
|
+
*/
|
3725
|
+
clusterId: ClusterID$1;
|
3726
|
+
workspace: string;
|
3727
|
+
region: string;
|
3728
|
+
};
|
3729
|
+
type GetClusterMetricsQueryParams = {
|
3730
|
+
startTime: string;
|
3731
|
+
endTime: string;
|
3732
|
+
period: '5min' | '15min' | '1hour';
|
3733
|
+
/**
|
3734
|
+
* Page size
|
3735
|
+
*/
|
3736
|
+
page?: PageSize$1;
|
3737
|
+
/**
|
3738
|
+
* Page token
|
3739
|
+
*/
|
3740
|
+
token?: PageToken$1;
|
3741
|
+
};
|
3742
|
+
type GetClusterMetricsError = ErrorWrapper<{
|
3743
|
+
status: 400;
|
3744
|
+
payload: BadRequestError$1;
|
3745
|
+
} | {
|
3746
|
+
status: 401;
|
3747
|
+
payload: AuthError$1;
|
3748
|
+
} | {
|
3749
|
+
status: 404;
|
3750
|
+
payload: SimpleError$1;
|
3751
|
+
}>;
|
3752
|
+
type GetClusterMetricsVariables = {
|
3753
|
+
pathParams: GetClusterMetricsPathParams;
|
3754
|
+
queryParams: GetClusterMetricsQueryParams;
|
3755
|
+
} & DataPlaneFetcherExtraProps;
|
3756
|
+
/**
|
3757
|
+
* retrieve a standard set of RDS cluster metrics
|
3758
|
+
*/
|
3759
|
+
declare const getClusterMetrics: (variables: GetClusterMetricsVariables, signal?: AbortSignal) => Promise<MetricsResponse>;
|
3067
3760
|
type ApplyMigrationPathParams = {
|
3068
3761
|
/**
|
3069
3762
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3090,6 +3783,7 @@ type ApplyMigrationRequestBody = {
|
|
3090
3783
|
operations: {
|
3091
3784
|
[key: string]: any;
|
3092
3785
|
}[];
|
3786
|
+
adaptTables?: boolean;
|
3093
3787
|
};
|
3094
3788
|
type ApplyMigrationVariables = {
|
3095
3789
|
body: ApplyMigrationRequestBody;
|
@@ -3098,8 +3792,123 @@ type ApplyMigrationVariables = {
|
|
3098
3792
|
/**
|
3099
3793
|
* Applies a pgroll migration to the specified database.
|
3100
3794
|
*/
|
3101
|
-
declare const applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal) => Promise<
|
3102
|
-
type
|
3795
|
+
declare const applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
|
3796
|
+
type StartMigrationPathParams = {
|
3797
|
+
/**
|
3798
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3799
|
+
*/
|
3800
|
+
dbBranchName: DBBranchName;
|
3801
|
+
workspace: string;
|
3802
|
+
region: string;
|
3803
|
+
};
|
3804
|
+
type StartMigrationError = ErrorWrapper<{
|
3805
|
+
status: 400;
|
3806
|
+
payload: BadRequestError$1;
|
3807
|
+
} | {
|
3808
|
+
status: 401;
|
3809
|
+
payload: AuthError$1;
|
3810
|
+
} | {
|
3811
|
+
status: 404;
|
3812
|
+
payload: SimpleError$1;
|
3813
|
+
}>;
|
3814
|
+
type StartMigrationRequestBody = {
|
3815
|
+
/**
|
3816
|
+
* Migration name
|
3817
|
+
*/
|
3818
|
+
name?: string;
|
3819
|
+
operations: {
|
3820
|
+
[key: string]: any;
|
3821
|
+
}[];
|
3822
|
+
adaptTables?: boolean;
|
3823
|
+
};
|
3824
|
+
type StartMigrationVariables = {
|
3825
|
+
body: StartMigrationRequestBody;
|
3826
|
+
pathParams: StartMigrationPathParams;
|
3827
|
+
} & DataPlaneFetcherExtraProps;
|
3828
|
+
/**
|
3829
|
+
* Starts a pgroll migration on the specified database.
|
3830
|
+
*/
|
3831
|
+
declare const startMigration: (variables: StartMigrationVariables, signal?: AbortSignal) => Promise<StartMigrationResponse>;
|
3832
|
+
type CompleteMigrationPathParams = {
|
3833
|
+
/**
|
3834
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3835
|
+
*/
|
3836
|
+
dbBranchName: DBBranchName;
|
3837
|
+
workspace: string;
|
3838
|
+
region: string;
|
3839
|
+
};
|
3840
|
+
type CompleteMigrationError = ErrorWrapper<{
|
3841
|
+
status: 400;
|
3842
|
+
payload: BadRequestError$1;
|
3843
|
+
} | {
|
3844
|
+
status: 401;
|
3845
|
+
payload: AuthError$1;
|
3846
|
+
} | {
|
3847
|
+
status: 404;
|
3848
|
+
payload: SimpleError$1;
|
3849
|
+
}>;
|
3850
|
+
type CompleteMigrationVariables = {
|
3851
|
+
pathParams: CompleteMigrationPathParams;
|
3852
|
+
} & DataPlaneFetcherExtraProps;
|
3853
|
+
/**
|
3854
|
+
* Complete an active migration on the specified database
|
3855
|
+
*/
|
3856
|
+
declare const completeMigration: (variables: CompleteMigrationVariables, signal?: AbortSignal) => Promise<CompleteMigrationResponse>;
|
3857
|
+
type RollbackMigrationPathParams = {
|
3858
|
+
/**
|
3859
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3860
|
+
*/
|
3861
|
+
dbBranchName: DBBranchName;
|
3862
|
+
workspace: string;
|
3863
|
+
region: string;
|
3864
|
+
};
|
3865
|
+
type RollbackMigrationError = ErrorWrapper<{
|
3866
|
+
status: 400;
|
3867
|
+
payload: BadRequestError$1;
|
3868
|
+
} | {
|
3869
|
+
status: 401;
|
3870
|
+
payload: AuthError$1;
|
3871
|
+
} | {
|
3872
|
+
status: 404;
|
3873
|
+
payload: SimpleError$1;
|
3874
|
+
}>;
|
3875
|
+
type RollbackMigrationVariables = {
|
3876
|
+
pathParams: RollbackMigrationPathParams;
|
3877
|
+
} & DataPlaneFetcherExtraProps;
|
3878
|
+
/**
|
3879
|
+
* Roll back an active migration on the specified database
|
3880
|
+
*/
|
3881
|
+
declare const rollbackMigration: (variables: RollbackMigrationVariables, signal?: AbortSignal) => Promise<RollbackMigrationResponse>;
|
3882
|
+
type AdaptTablePathParams = {
|
3883
|
+
/**
|
3884
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3885
|
+
*/
|
3886
|
+
dbBranchName: DBBranchName;
|
3887
|
+
/**
|
3888
|
+
* The Table name
|
3889
|
+
*/
|
3890
|
+
tableName: TableName;
|
3891
|
+
workspace: string;
|
3892
|
+
region: string;
|
3893
|
+
};
|
3894
|
+
type AdaptTableError = ErrorWrapper<{
|
3895
|
+
status: 400;
|
3896
|
+
payload: BadRequestError$1;
|
3897
|
+
} | {
|
3898
|
+
status: 401;
|
3899
|
+
payload: AuthError$1;
|
3900
|
+
} | {
|
3901
|
+
status: 404;
|
3902
|
+
payload: SimpleError$1;
|
3903
|
+
}>;
|
3904
|
+
type AdaptTableVariables = {
|
3905
|
+
pathParams: AdaptTablePathParams;
|
3906
|
+
} & DataPlaneFetcherExtraProps;
|
3907
|
+
/**
|
3908
|
+
* 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.
|
3909
|
+
*/
|
3910
|
+
declare const adaptTable: (variables: AdaptTableVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
|
3911
|
+
type AdaptAllTablesPathParams = {
|
3103
3912
|
/**
|
3104
3913
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3105
3914
|
*/
|
@@ -3107,7 +3916,7 @@ type PgRollStatusPathParams = {
|
|
3107
3916
|
workspace: string;
|
3108
3917
|
region: string;
|
3109
3918
|
};
|
3110
|
-
type
|
3919
|
+
type AdaptAllTablesError = ErrorWrapper<{
|
3111
3920
|
status: 400;
|
3112
3921
|
payload: BadRequestError$1;
|
3113
3922
|
} | {
|
@@ -3117,23 +3926,136 @@ type PgRollStatusError = ErrorWrapper<{
|
|
3117
3926
|
status: 404;
|
3118
3927
|
payload: SimpleError$1;
|
3119
3928
|
}>;
|
3120
|
-
type
|
3121
|
-
pathParams:
|
3929
|
+
type AdaptAllTablesVariables = {
|
3930
|
+
pathParams: AdaptAllTablesPathParams;
|
3122
3931
|
} & DataPlaneFetcherExtraProps;
|
3123
|
-
|
3124
|
-
|
3932
|
+
/**
|
3933
|
+
* 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.
|
3934
|
+
*/
|
3935
|
+
declare const adaptAllTables: (variables: AdaptAllTablesVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
|
3936
|
+
type GetBranchMigrationJobStatusPathParams = {
|
3125
3937
|
/**
|
3126
3938
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3127
3939
|
*/
|
3128
3940
|
dbBranchName: DBBranchName;
|
3941
|
+
workspace: string;
|
3942
|
+
region: string;
|
3943
|
+
};
|
3944
|
+
type GetBranchMigrationJobStatusError = ErrorWrapper<{
|
3945
|
+
status: 400;
|
3946
|
+
payload: BadRequestError$1;
|
3947
|
+
} | {
|
3948
|
+
status: 401;
|
3949
|
+
payload: AuthError$1;
|
3950
|
+
} | {
|
3951
|
+
status: 404;
|
3952
|
+
payload: SimpleError$1;
|
3953
|
+
}>;
|
3954
|
+
type GetBranchMigrationJobStatusVariables = {
|
3955
|
+
pathParams: GetBranchMigrationJobStatusPathParams;
|
3956
|
+
} & DataPlaneFetcherExtraProps;
|
3957
|
+
declare const getBranchMigrationJobStatus: (variables: GetBranchMigrationJobStatusVariables, signal?: AbortSignal) => Promise<MigrationJobStatusResponse>;
|
3958
|
+
type GetMigrationJobsPathParams = {
|
3959
|
+
/**
|
3960
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3961
|
+
*/
|
3962
|
+
dbBranchName: DBBranchName;
|
3963
|
+
workspace: string;
|
3964
|
+
region: string;
|
3965
|
+
};
|
3966
|
+
type GetMigrationJobsQueryParams = {
|
3967
|
+
/**
|
3968
|
+
* @format date-time
|
3969
|
+
*/
|
3970
|
+
cursor?: string;
|
3971
|
+
/**
|
3972
|
+
* Page size
|
3973
|
+
*/
|
3974
|
+
limit?: PageSize$1;
|
3975
|
+
};
|
3976
|
+
type GetMigrationJobsError = ErrorWrapper<{
|
3977
|
+
status: 400;
|
3978
|
+
payload: BadRequestError$1;
|
3979
|
+
} | {
|
3980
|
+
status: 401;
|
3981
|
+
payload: AuthError$1;
|
3982
|
+
} | {
|
3983
|
+
status: 404;
|
3984
|
+
payload: SimpleError$1;
|
3985
|
+
}>;
|
3986
|
+
type GetMigrationJobsVariables = {
|
3987
|
+
pathParams: GetMigrationJobsPathParams;
|
3988
|
+
queryParams?: GetMigrationJobsQueryParams;
|
3989
|
+
} & DataPlaneFetcherExtraProps;
|
3990
|
+
declare const getMigrationJobs: (variables: GetMigrationJobsVariables, signal?: AbortSignal) => Promise<GetMigrationJobsResponse>;
|
3991
|
+
type GetMigrationJobStatusPathParams = {
|
3992
|
+
/**
|
3993
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3994
|
+
*/
|
3995
|
+
dbBranchName: DBBranchName;
|
3996
|
+
/**
|
3997
|
+
* The id of the migration job
|
3998
|
+
*/
|
3999
|
+
jobId: MigrationJobID;
|
4000
|
+
workspace: string;
|
4001
|
+
region: string;
|
4002
|
+
};
|
4003
|
+
type GetMigrationJobStatusError = ErrorWrapper<{
|
4004
|
+
status: 400;
|
4005
|
+
payload: BadRequestError$1;
|
4006
|
+
} | {
|
4007
|
+
status: 401;
|
4008
|
+
payload: AuthError$1;
|
4009
|
+
} | {
|
4010
|
+
status: 404;
|
4011
|
+
payload: SimpleError$1;
|
4012
|
+
}>;
|
4013
|
+
type GetMigrationJobStatusVariables = {
|
4014
|
+
pathParams: GetMigrationJobStatusPathParams;
|
4015
|
+
} & DataPlaneFetcherExtraProps;
|
4016
|
+
declare const getMigrationJobStatus: (variables: GetMigrationJobStatusVariables, signal?: AbortSignal) => Promise<MigrationJobStatusResponse>;
|
4017
|
+
type GetMigrationHistoryPathParams = {
|
4018
|
+
/**
|
4019
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4020
|
+
*/
|
4021
|
+
dbBranchName: DBBranchName;
|
4022
|
+
workspace: string;
|
4023
|
+
region: string;
|
4024
|
+
};
|
4025
|
+
type GetMigrationHistoryQueryParams = {
|
4026
|
+
/**
|
4027
|
+
* @format date-time
|
4028
|
+
*/
|
4029
|
+
cursor?: string;
|
4030
|
+
/**
|
4031
|
+
* Page size
|
4032
|
+
*/
|
4033
|
+
limit?: PageSize$1;
|
4034
|
+
};
|
4035
|
+
type GetMigrationHistoryError = ErrorWrapper<{
|
4036
|
+
status: 400;
|
4037
|
+
payload: BadRequestError$1;
|
4038
|
+
} | {
|
4039
|
+
status: 401;
|
4040
|
+
payload: AuthError$1;
|
4041
|
+
} | {
|
4042
|
+
status: 404;
|
4043
|
+
payload: SimpleError$1;
|
4044
|
+
}>;
|
4045
|
+
type GetMigrationHistoryVariables = {
|
4046
|
+
pathParams: GetMigrationHistoryPathParams;
|
4047
|
+
queryParams?: GetMigrationHistoryQueryParams;
|
4048
|
+
} & DataPlaneFetcherExtraProps;
|
4049
|
+
declare const getMigrationHistory: (variables: GetMigrationHistoryVariables, signal?: AbortSignal) => Promise<MigrationHistoryResponse>;
|
4050
|
+
type GetBranchListPathParams = {
|
3129
4051
|
/**
|
3130
|
-
* The
|
4052
|
+
* The Database Name
|
3131
4053
|
*/
|
3132
|
-
|
4054
|
+
dbName: DBName$1;
|
3133
4055
|
workspace: string;
|
3134
4056
|
region: string;
|
3135
4057
|
};
|
3136
|
-
type
|
4058
|
+
type GetBranchListError = ErrorWrapper<{
|
3137
4059
|
status: 400;
|
3138
4060
|
payload: BadRequestError$1;
|
3139
4061
|
} | {
|
@@ -3143,21 +4065,24 @@ type PgRollJobStatusError = ErrorWrapper<{
|
|
3143
4065
|
status: 404;
|
3144
4066
|
payload: SimpleError$1;
|
3145
4067
|
}>;
|
3146
|
-
type
|
3147
|
-
pathParams:
|
4068
|
+
type GetBranchListVariables = {
|
4069
|
+
pathParams: GetBranchListPathParams;
|
3148
4070
|
} & DataPlaneFetcherExtraProps;
|
3149
|
-
|
3150
|
-
|
4071
|
+
/**
|
4072
|
+
* List all available Branches
|
4073
|
+
*/
|
4074
|
+
declare const getBranchList: (variables: GetBranchListVariables, signal?: AbortSignal) => Promise<ListBranchesResponse>;
|
4075
|
+
type GetDatabaseSettingsPathParams = {
|
3151
4076
|
/**
|
3152
|
-
* The
|
4077
|
+
* The Database Name
|
3153
4078
|
*/
|
3154
|
-
|
4079
|
+
dbName: DBName$1;
|
3155
4080
|
workspace: string;
|
3156
4081
|
region: string;
|
3157
4082
|
};
|
3158
|
-
type
|
4083
|
+
type GetDatabaseSettingsError = ErrorWrapper<{
|
3159
4084
|
status: 400;
|
3160
|
-
payload:
|
4085
|
+
payload: SimpleError$1;
|
3161
4086
|
} | {
|
3162
4087
|
status: 401;
|
3163
4088
|
payload: AuthError$1;
|
@@ -3165,11 +4090,14 @@ type PgRollMigrationHistoryError = ErrorWrapper<{
|
|
3165
4090
|
status: 404;
|
3166
4091
|
payload: SimpleError$1;
|
3167
4092
|
}>;
|
3168
|
-
type
|
3169
|
-
pathParams:
|
4093
|
+
type GetDatabaseSettingsVariables = {
|
4094
|
+
pathParams: GetDatabaseSettingsPathParams;
|
3170
4095
|
} & DataPlaneFetcherExtraProps;
|
3171
|
-
|
3172
|
-
|
4096
|
+
/**
|
4097
|
+
* Get database settings
|
4098
|
+
*/
|
4099
|
+
declare const getDatabaseSettings: (variables: GetDatabaseSettingsVariables, signal?: AbortSignal) => Promise<DatabaseSettings>;
|
4100
|
+
type UpdateDatabaseSettingsPathParams = {
|
3173
4101
|
/**
|
3174
4102
|
* The Database Name
|
3175
4103
|
*/
|
@@ -3177,9 +4105,9 @@ type GetBranchListPathParams = {
|
|
3177
4105
|
workspace: string;
|
3178
4106
|
region: string;
|
3179
4107
|
};
|
3180
|
-
type
|
4108
|
+
type UpdateDatabaseSettingsError = ErrorWrapper<{
|
3181
4109
|
status: 400;
|
3182
|
-
payload:
|
4110
|
+
payload: SimpleError$1;
|
3183
4111
|
} | {
|
3184
4112
|
status: 401;
|
3185
4113
|
payload: AuthError$1;
|
@@ -3187,13 +4115,17 @@ type GetBranchListError = ErrorWrapper<{
|
|
3187
4115
|
status: 404;
|
3188
4116
|
payload: SimpleError$1;
|
3189
4117
|
}>;
|
3190
|
-
type
|
3191
|
-
|
4118
|
+
type UpdateDatabaseSettingsRequestBody = {
|
4119
|
+
searchEnabled?: boolean;
|
4120
|
+
};
|
4121
|
+
type UpdateDatabaseSettingsVariables = {
|
4122
|
+
body?: UpdateDatabaseSettingsRequestBody;
|
4123
|
+
pathParams: UpdateDatabaseSettingsPathParams;
|
3192
4124
|
} & DataPlaneFetcherExtraProps;
|
3193
4125
|
/**
|
3194
|
-
*
|
4126
|
+
* Update database settings, this endpoint can be used to disable search
|
3195
4127
|
*/
|
3196
|
-
declare const
|
4128
|
+
declare const updateDatabaseSettings: (variables: UpdateDatabaseSettingsVariables, signal?: AbortSignal) => Promise<DatabaseSettings>;
|
3197
4129
|
type GetBranchDetailsPathParams = {
|
3198
4130
|
/**
|
3199
4131
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3321,12 +4253,37 @@ type GetSchemaError = ErrorWrapper<{
|
|
3321
4253
|
payload: SimpleError$1;
|
3322
4254
|
}>;
|
3323
4255
|
type GetSchemaResponse = {
|
3324
|
-
schema:
|
4256
|
+
schema: BranchSchema;
|
3325
4257
|
};
|
3326
4258
|
type GetSchemaVariables = {
|
3327
4259
|
pathParams: GetSchemaPathParams;
|
3328
4260
|
} & DataPlaneFetcherExtraProps;
|
3329
4261
|
declare const getSchema: (variables: GetSchemaVariables, signal?: AbortSignal) => Promise<GetSchemaResponse>;
|
4262
|
+
type GetSchemasPathParams = {
|
4263
|
+
/**
|
4264
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4265
|
+
*/
|
4266
|
+
dbBranchName: DBBranchName;
|
4267
|
+
workspace: string;
|
4268
|
+
region: string;
|
4269
|
+
};
|
4270
|
+
type GetSchemasError = ErrorWrapper<{
|
4271
|
+
status: 400;
|
4272
|
+
payload: BadRequestError$1;
|
4273
|
+
} | {
|
4274
|
+
status: 401;
|
4275
|
+
payload: AuthError$1;
|
4276
|
+
} | {
|
4277
|
+
status: 404;
|
4278
|
+
payload: SimpleError$1;
|
4279
|
+
}>;
|
4280
|
+
type GetSchemasResponse = {
|
4281
|
+
schemas: BranchSchema[];
|
4282
|
+
};
|
4283
|
+
type GetSchemasVariables = {
|
4284
|
+
pathParams: GetSchemasPathParams;
|
4285
|
+
} & DataPlaneFetcherExtraProps;
|
4286
|
+
declare const getSchemas: (variables: GetSchemasVariables, signal?: AbortSignal) => Promise<GetSchemasResponse>;
|
3330
4287
|
type CopyBranchPathParams = {
|
3331
4288
|
/**
|
3332
4289
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3357,6 +4314,73 @@ type CopyBranchVariables = {
|
|
3357
4314
|
* Create a copy of the branch
|
3358
4315
|
*/
|
3359
4316
|
declare const copyBranch: (variables: CopyBranchVariables, signal?: AbortSignal) => Promise<BranchWithCopyID>;
|
4317
|
+
type GetBranchMoveStatusPathParams = {
|
4318
|
+
/**
|
4319
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4320
|
+
*/
|
4321
|
+
dbBranchName: DBBranchName;
|
4322
|
+
workspace: string;
|
4323
|
+
region: string;
|
4324
|
+
};
|
4325
|
+
type GetBranchMoveStatusError = ErrorWrapper<{
|
4326
|
+
status: 400;
|
4327
|
+
payload: BadRequestError$1;
|
4328
|
+
} | {
|
4329
|
+
status: 401;
|
4330
|
+
payload: AuthError$1;
|
4331
|
+
} | {
|
4332
|
+
status: 404;
|
4333
|
+
payload: SimpleError$1;
|
4334
|
+
}>;
|
4335
|
+
type GetBranchMoveStatusResponse = {
|
4336
|
+
state: string;
|
4337
|
+
pendingBytes: number;
|
4338
|
+
};
|
4339
|
+
type GetBranchMoveStatusVariables = {
|
4340
|
+
pathParams: GetBranchMoveStatusPathParams;
|
4341
|
+
} & DataPlaneFetcherExtraProps;
|
4342
|
+
/**
|
4343
|
+
* Get the branch move status (if a move is happening)
|
4344
|
+
*/
|
4345
|
+
declare const getBranchMoveStatus: (variables: GetBranchMoveStatusVariables, signal?: AbortSignal) => Promise<GetBranchMoveStatusResponse>;
|
4346
|
+
type MoveBranchPathParams = {
|
4347
|
+
/**
|
4348
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4349
|
+
*/
|
4350
|
+
dbBranchName: DBBranchName;
|
4351
|
+
workspace: string;
|
4352
|
+
region: string;
|
4353
|
+
};
|
4354
|
+
type MoveBranchError = ErrorWrapper<{
|
4355
|
+
status: 400;
|
4356
|
+
payload: BadRequestError$1;
|
4357
|
+
} | {
|
4358
|
+
status: 401;
|
4359
|
+
payload: AuthError$1;
|
4360
|
+
} | {
|
4361
|
+
status: 404;
|
4362
|
+
payload: SimpleError$1;
|
4363
|
+
} | {
|
4364
|
+
status: 423;
|
4365
|
+
payload: SimpleError$1;
|
4366
|
+
}>;
|
4367
|
+
type MoveBranchResponse = {
|
4368
|
+
state: string;
|
4369
|
+
};
|
4370
|
+
type MoveBranchRequestBody = {
|
4371
|
+
/**
|
4372
|
+
* Select the cluster to move the branch to. Must be different from the current cluster.
|
4373
|
+
*
|
4374
|
+
* @minLength 1
|
4375
|
+
* @x-internal true
|
4376
|
+
*/
|
4377
|
+
to: string;
|
4378
|
+
};
|
4379
|
+
type MoveBranchVariables = {
|
4380
|
+
body: MoveBranchRequestBody;
|
4381
|
+
pathParams: MoveBranchPathParams;
|
4382
|
+
} & DataPlaneFetcherExtraProps;
|
4383
|
+
declare const moveBranch: (variables: MoveBranchVariables, signal?: AbortSignal) => Promise<MoveBranchResponse>;
|
3360
4384
|
type UpdateBranchMetadataPathParams = {
|
3361
4385
|
/**
|
3362
4386
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3545,7 +4569,7 @@ type RemoveGitBranchesEntryPathParams = {
|
|
3545
4569
|
};
|
3546
4570
|
type RemoveGitBranchesEntryQueryParams = {
|
3547
4571
|
/**
|
3548
|
-
* The
|
4572
|
+
* The git branch to remove from the mapping
|
3549
4573
|
*/
|
3550
4574
|
gitBranch: string;
|
3551
4575
|
};
|
@@ -3608,7 +4632,7 @@ type ResolveBranchVariables = {
|
|
3608
4632
|
} & DataPlaneFetcherExtraProps;
|
3609
4633
|
/**
|
3610
4634
|
* 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
|
4635
|
+
* * 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
4636
|
* * else, if a Xata branch with the exact same name as `gitBranch` exists, return it
|
3613
4637
|
* * else, if `fallbackBranch` is provided and a branch with that name exists, return it
|
3614
4638
|
* * else, return the default branch of the DB (`main` or the first branch)
|
@@ -5209,7 +6233,7 @@ type QueryTableVariables = {
|
|
5209
6233
|
* }
|
5210
6234
|
* ```
|
5211
6235
|
*
|
5212
|
-
* For usage, see also the [
|
6236
|
+
* For usage, see also the [Xata SDK documentation](https://xata.io/docs/sdk/get).
|
5213
6237
|
*
|
5214
6238
|
* ### Column selection
|
5215
6239
|
*
|
@@ -6081,7 +7105,7 @@ type SearchTableVariables = {
|
|
6081
7105
|
/**
|
6082
7106
|
* Run a free text search operation in a particular table.
|
6083
7107
|
*
|
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:
|
7108
|
+
* 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
7109
|
* * filters `$contains`, `$startsWith`, `$endsWith` don't work on columns of type `text`
|
6086
7110
|
* * filtering on columns of type `multiple` is currently unsupported
|
6087
7111
|
*/
|
@@ -6442,7 +7466,7 @@ type AggregateTableVariables = {
|
|
6442
7466
|
* store that is more appropriate for analytics, makes use of approximation algorithms
|
6443
7467
|
* (e.g for cardinality), and is generally faster and can do more complex aggregations.
|
6444
7468
|
*
|
6445
|
-
* For usage, see the [
|
7469
|
+
* For usage, see the [Aggregation documentation](https://xata.io/docs/sdk/aggregate).
|
6446
7470
|
*/
|
6447
7471
|
declare const aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal) => Promise<AggResponse>;
|
6448
7472
|
type FileAccessPathParams = {
|
@@ -6531,173 +7555,219 @@ type SqlQueryError = ErrorWrapper<{
|
|
6531
7555
|
status: 503;
|
6532
7556
|
payload: ServiceUnavailableError;
|
6533
7557
|
}>;
|
6534
|
-
type SqlQueryRequestBody = {
|
6535
|
-
|
6536
|
-
|
6537
|
-
|
6538
|
-
|
6539
|
-
|
6540
|
-
|
7558
|
+
type SqlQueryRequestBody = PreparedStatement & {
|
7559
|
+
consistency?: SQLConsistency;
|
7560
|
+
responseType?: SQLResponseType$1;
|
7561
|
+
};
|
7562
|
+
type SqlQueryVariables = {
|
7563
|
+
body: SqlQueryRequestBody;
|
7564
|
+
pathParams: SqlQueryPathParams;
|
7565
|
+
} & DataPlaneFetcherExtraProps;
|
7566
|
+
/**
|
7567
|
+
* Run an SQL query across the database branch.
|
7568
|
+
*/
|
7569
|
+
declare const sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<SQLResponse$1>;
|
7570
|
+
type SqlBatchQueryPathParams = {
|
6541
7571
|
/**
|
6542
|
-
* The
|
7572
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
6543
7573
|
*/
|
6544
|
-
|
7574
|
+
dbBranchName: DBBranchName;
|
7575
|
+
workspace: string;
|
7576
|
+
region: string;
|
7577
|
+
};
|
7578
|
+
type SqlBatchQueryError = ErrorWrapper<{
|
7579
|
+
status: 400;
|
7580
|
+
payload: BadRequestError$1;
|
7581
|
+
} | {
|
7582
|
+
status: 401;
|
7583
|
+
payload: AuthError$1;
|
7584
|
+
} | {
|
7585
|
+
status: 404;
|
7586
|
+
payload: SimpleError$1;
|
7587
|
+
} | {
|
7588
|
+
status: 503;
|
7589
|
+
payload: ServiceUnavailableError;
|
7590
|
+
}>;
|
7591
|
+
type SqlBatchQueryRequestBody = {
|
6545
7592
|
/**
|
6546
|
-
* The
|
7593
|
+
* The SQL statements.
|
6547
7594
|
*
|
6548
|
-
* @
|
7595
|
+
* @x-go-type []sqlproxy.PreparedStatement
|
6549
7596
|
*/
|
6550
|
-
|
7597
|
+
statements: PreparedStatement[];
|
7598
|
+
consistency?: SQLConsistency;
|
7599
|
+
responseType?: SQLResponseType$1;
|
6551
7600
|
};
|
6552
|
-
type
|
6553
|
-
body:
|
6554
|
-
pathParams:
|
7601
|
+
type SqlBatchQueryVariables = {
|
7602
|
+
body: SqlBatchQueryRequestBody;
|
7603
|
+
pathParams: SqlBatchQueryPathParams;
|
6555
7604
|
} & DataPlaneFetcherExtraProps;
|
6556
7605
|
/**
|
6557
|
-
* Run
|
7606
|
+
* Run multiple SQL queries across the database branch.
|
6558
7607
|
*/
|
6559
|
-
declare const
|
7608
|
+
declare const sqlBatchQuery: (variables: SqlBatchQueryVariables, signal?: AbortSignal) => Promise<SQLBatchResponse>;
|
6560
7609
|
|
6561
7610
|
declare const operationsByTag: {
|
6562
7611
|
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>;
|
7612
|
+
getBranchList: (variables: GetBranchListVariables, signal?: AbortSignal) => Promise<ListBranchesResponse>;
|
7613
|
+
getBranchDetails: (variables: GetBranchDetailsVariables, signal?: AbortSignal) => Promise<DBBranch>;
|
7614
|
+
createBranch: (variables: CreateBranchVariables, signal?: AbortSignal) => Promise<CreateBranchResponse>;
|
7615
|
+
deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal) => Promise<DeleteBranchResponse>;
|
7616
|
+
copyBranch: (variables: CopyBranchVariables, signal?: AbortSignal) => Promise<BranchWithCopyID>;
|
7617
|
+
getBranchMoveStatus: (variables: GetBranchMoveStatusVariables, signal?: AbortSignal) => Promise<GetBranchMoveStatusResponse>;
|
7618
|
+
moveBranch: (variables: MoveBranchVariables, signal?: AbortSignal) => Promise<MoveBranchResponse>;
|
7619
|
+
updateBranchMetadata: (variables: UpdateBranchMetadataVariables, signal?: AbortSignal) => Promise<undefined>;
|
7620
|
+
getBranchMetadata: (variables: GetBranchMetadataVariables, signal?: AbortSignal) => Promise<BranchMetadata$1>;
|
7621
|
+
getBranchStats: (variables: GetBranchStatsVariables, signal?: AbortSignal) => Promise<GetBranchStatsResponse>;
|
7622
|
+
getGitBranchesMapping: (variables: GetGitBranchesMappingVariables, signal?: AbortSignal) => Promise<ListGitBranchesResponse>;
|
7623
|
+
addGitBranchesEntry: (variables: AddGitBranchesEntryVariables, signal?: AbortSignal) => Promise<AddGitBranchesEntryResponse>;
|
7624
|
+
removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables, signal?: AbortSignal) => Promise<undefined>;
|
7625
|
+
resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal) => Promise<ResolveBranchResponse>;
|
6579
7626
|
};
|
6580
7627
|
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
|
-
|
7628
|
+
getWorkspacesList: (variables: GetWorkspacesListVariables, signal?: AbortSignal) => Promise<GetWorkspacesListResponse>;
|
7629
|
+
createWorkspace: (variables: CreateWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
7630
|
+
getWorkspace: (variables: GetWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
7631
|
+
updateWorkspace: (variables: UpdateWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
7632
|
+
deleteWorkspace: (variables: DeleteWorkspaceVariables, signal?: AbortSignal) => Promise<undefined>;
|
7633
|
+
getWorkspaceSettings: (variables: GetWorkspaceSettingsVariables, signal?: AbortSignal) => Promise<WorkspaceSettings>;
|
7634
|
+
updateWorkspaceSettings: (variables: UpdateWorkspaceSettingsVariables, signal?: AbortSignal) => Promise<WorkspaceSettings>;
|
7635
|
+
getWorkspaceMembersList: (variables: GetWorkspaceMembersListVariables, signal?: AbortSignal) => Promise<WorkspaceMembers>;
|
7636
|
+
updateWorkspaceMemberRole: (variables: UpdateWorkspaceMemberRoleVariables, signal?: AbortSignal) => Promise<undefined>;
|
7637
|
+
removeWorkspaceMember: (variables: RemoveWorkspaceMemberVariables, signal?: AbortSignal) => Promise<undefined>;
|
7638
|
+
};
|
7639
|
+
table: {
|
7640
|
+
createTable: (variables: CreateTableVariables, signal?: AbortSignal) => Promise<CreateTableResponse>;
|
7641
|
+
deleteTable: (variables: DeleteTableVariables, signal?: AbortSignal) => Promise<DeleteTableResponse>;
|
7642
|
+
updateTable: (variables: UpdateTableVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7643
|
+
getTableSchema: (variables: GetTableSchemaVariables, signal?: AbortSignal) => Promise<GetTableSchemaResponse>;
|
7644
|
+
setTableSchema: (variables: SetTableSchemaVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7645
|
+
getTableColumns: (variables: GetTableColumnsVariables, signal?: AbortSignal) => Promise<GetTableColumnsResponse>;
|
7646
|
+
addTableColumn: (variables: AddTableColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7647
|
+
getColumn: (variables: GetColumnVariables, signal?: AbortSignal) => Promise<Column>;
|
7648
|
+
updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7649
|
+
deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
6589
7650
|
};
|
6590
7651
|
migrations: {
|
6591
|
-
|
6592
|
-
|
6593
|
-
|
6594
|
-
|
6595
|
-
|
6596
|
-
|
6597
|
-
|
6598
|
-
|
6599
|
-
|
6600
|
-
|
6601
|
-
|
7652
|
+
applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
|
7653
|
+
startMigration: (variables: StartMigrationVariables, signal?: AbortSignal) => Promise<StartMigrationResponse>;
|
7654
|
+
completeMigration: (variables: CompleteMigrationVariables, signal?: AbortSignal) => Promise<CompleteMigrationResponse>;
|
7655
|
+
rollbackMigration: (variables: RollbackMigrationVariables, signal?: AbortSignal) => Promise<RollbackMigrationResponse>;
|
7656
|
+
adaptTable: (variables: AdaptTableVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
|
7657
|
+
adaptAllTables: (variables: AdaptAllTablesVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
|
7658
|
+
getBranchMigrationJobStatus: (variables: GetBranchMigrationJobStatusVariables, signal?: AbortSignal) => Promise<MigrationJobStatusResponse>;
|
7659
|
+
getMigrationJobs: (variables: GetMigrationJobsVariables, signal?: AbortSignal) => Promise<GetMigrationJobsResponse>;
|
7660
|
+
getMigrationJobStatus: (variables: GetMigrationJobStatusVariables, signal?: AbortSignal) => Promise<MigrationJobStatusResponse>;
|
7661
|
+
getMigrationHistory: (variables: GetMigrationHistoryVariables, signal?: AbortSignal) => Promise<MigrationHistoryResponse>;
|
7662
|
+
getSchema: (variables: GetSchemaVariables, signal?: AbortSignal) => Promise<GetSchemaResponse>;
|
7663
|
+
getSchemas: (variables: GetSchemasVariables, signal?: AbortSignal) => Promise<GetSchemasResponse>;
|
7664
|
+
getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal) => Promise<GetBranchMigrationHistoryResponse>;
|
7665
|
+
getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<BranchMigrationPlan>;
|
7666
|
+
executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7667
|
+
getBranchSchemaHistory: (variables: GetBranchSchemaHistoryVariables, signal?: AbortSignal) => Promise<GetBranchSchemaHistoryResponse>;
|
7668
|
+
compareBranchWithUserSchema: (variables: CompareBranchWithUserSchemaVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
7669
|
+
compareBranchSchemas: (variables: CompareBranchSchemasVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
7670
|
+
updateBranchSchema: (variables: UpdateBranchSchemaVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7671
|
+
previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables, signal?: AbortSignal) => Promise<PreviewBranchSchemaEditResponse>;
|
7672
|
+
applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7673
|
+
pushBranchMigrations: (variables: PushBranchMigrationsVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
6602
7674
|
};
|
6603
7675
|
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
|
7676
|
+
branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal) => Promise<TransactionSuccess>;
|
7677
|
+
insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
7678
|
+
getRecord: (variables: GetRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
|
7679
|
+
insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
7680
|
+
updateRecordWithID: (variables: UpdateRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
7681
|
+
upsertRecordWithID: (variables: UpsertRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
7682
|
+
deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
|
7683
|
+
bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal) => Promise<BulkInsertResponse>;
|
6612
7684
|
};
|
6613
|
-
|
6614
|
-
|
6615
|
-
|
6616
|
-
getMigrationRequest: (variables: GetMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<MigrationRequest>;
|
6617
|
-
updateMigrationRequest: (variables: UpdateMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
6618
|
-
listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables, signal?: AbortSignal | undefined) => Promise<ListMigrationRequestsCommitsResponse>;
|
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>;
|
7685
|
+
cluster: {
|
7686
|
+
listClusterBranches: (variables: ListClusterBranchesVariables, signal?: AbortSignal) => Promise<ListClusterBranchesResponse>;
|
7687
|
+
getClusterMetrics: (variables: GetClusterMetricsVariables, signal?: AbortSignal) => Promise<MetricsResponse>;
|
6622
7688
|
};
|
6623
|
-
|
6624
|
-
|
6625
|
-
|
6626
|
-
|
6627
|
-
|
6628
|
-
|
6629
|
-
|
6630
|
-
|
6631
|
-
|
6632
|
-
|
6633
|
-
|
7689
|
+
database: {
|
7690
|
+
getDatabaseSettings: (variables: GetDatabaseSettingsVariables, signal?: AbortSignal) => Promise<DatabaseSettings>;
|
7691
|
+
updateDatabaseSettings: (variables: UpdateDatabaseSettingsVariables, signal?: AbortSignal) => Promise<DatabaseSettings>;
|
7692
|
+
};
|
7693
|
+
migrationRequests: {
|
7694
|
+
queryMigrationRequests: (variables: QueryMigrationRequestsVariables, signal?: AbortSignal) => Promise<QueryMigrationRequestsResponse>;
|
7695
|
+
createMigrationRequest: (variables: CreateMigrationRequestVariables, signal?: AbortSignal) => Promise<CreateMigrationRequestResponse>;
|
7696
|
+
getMigrationRequest: (variables: GetMigrationRequestVariables, signal?: AbortSignal) => Promise<MigrationRequest>;
|
7697
|
+
updateMigrationRequest: (variables: UpdateMigrationRequestVariables, signal?: AbortSignal) => Promise<undefined>;
|
7698
|
+
listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables, signal?: AbortSignal) => Promise<ListMigrationRequestsCommitsResponse>;
|
7699
|
+
compareMigrationRequest: (variables: CompareMigrationRequestVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
7700
|
+
getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables, signal?: AbortSignal) => Promise<GetMigrationRequestIsMergedResponse>;
|
7701
|
+
mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal) => Promise<BranchOp>;
|
6634
7702
|
};
|
6635
7703
|
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
|
7704
|
+
getFileItem: (variables: GetFileItemVariables, signal?: AbortSignal) => Promise<Blob>;
|
7705
|
+
putFileItem: (variables: PutFileItemVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
7706
|
+
deleteFileItem: (variables: DeleteFileItemVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
7707
|
+
getFile: (variables: GetFileVariables, signal?: AbortSignal) => Promise<Blob>;
|
7708
|
+
putFile: (variables: PutFileVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
7709
|
+
deleteFile: (variables: DeleteFileVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
7710
|
+
fileAccess: (variables: FileAccessVariables, signal?: AbortSignal) => Promise<Blob>;
|
7711
|
+
fileUpload: (variables: FileUploadVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
6644
7712
|
};
|
6645
7713
|
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
|
7714
|
+
queryTable: (variables: QueryTableVariables, signal?: AbortSignal) => Promise<QueryResponse>;
|
7715
|
+
searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
7716
|
+
searchTable: (variables: SearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
7717
|
+
vectorSearchTable: (variables: VectorSearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
7718
|
+
askTable: (variables: AskTableVariables, signal?: AbortSignal) => Promise<AskTableResponse>;
|
7719
|
+
askTableSession: (variables: AskTableSessionVariables, signal?: AbortSignal) => Promise<AskTableSessionResponse>;
|
7720
|
+
summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal) => Promise<SummarizeResponse>;
|
7721
|
+
aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal) => Promise<AggResponse>;
|
6654
7722
|
};
|
6655
7723
|
sql: {
|
6656
|
-
sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal
|
7724
|
+
sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<SQLResponse$1>;
|
7725
|
+
sqlBatchQuery: (variables: SqlBatchQueryVariables, signal?: AbortSignal) => Promise<SQLBatchResponse>;
|
6657
7726
|
};
|
6658
7727
|
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
|
7728
|
+
getAuthorizationCode: (variables: GetAuthorizationCodeVariables, signal?: AbortSignal) => Promise<AuthorizationCodeResponse>;
|
7729
|
+
grantAuthorizationCode: (variables: GrantAuthorizationCodeVariables, signal?: AbortSignal) => Promise<AuthorizationCodeResponse>;
|
7730
|
+
getUserOAuthClients: (variables: GetUserOAuthClientsVariables, signal?: AbortSignal) => Promise<GetUserOAuthClientsResponse>;
|
7731
|
+
deleteUserOAuthClient: (variables: DeleteUserOAuthClientVariables, signal?: AbortSignal) => Promise<undefined>;
|
7732
|
+
getUserOAuthAccessTokens: (variables: GetUserOAuthAccessTokensVariables, signal?: AbortSignal) => Promise<GetUserOAuthAccessTokensResponse>;
|
7733
|
+
deleteOAuthAccessToken: (variables: DeleteOAuthAccessTokenVariables, signal?: AbortSignal) => Promise<undefined>;
|
7734
|
+
updateOAuthAccessToken: (variables: UpdateOAuthAccessTokenVariables, signal?: AbortSignal) => Promise<OAuthAccessToken>;
|
6666
7735
|
};
|
6667
7736
|
users: {
|
6668
|
-
getUser: (variables:
|
6669
|
-
updateUser: (variables: UpdateUserVariables, signal?: AbortSignal
|
6670
|
-
deleteUser: (variables:
|
7737
|
+
getUser: (variables: GetUserVariables, signal?: AbortSignal) => Promise<UserWithID>;
|
7738
|
+
updateUser: (variables: UpdateUserVariables, signal?: AbortSignal) => Promise<UserWithID>;
|
7739
|
+
deleteUser: (variables: DeleteUserVariables, signal?: AbortSignal) => Promise<undefined>;
|
6671
7740
|
};
|
6672
7741
|
authentication: {
|
6673
|
-
getUserAPIKeys: (variables:
|
6674
|
-
createUserAPIKey: (variables: CreateUserAPIKeyVariables, signal?: AbortSignal
|
6675
|
-
deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal
|
7742
|
+
getUserAPIKeys: (variables: GetUserAPIKeysVariables, signal?: AbortSignal) => Promise<GetUserAPIKeysResponse>;
|
7743
|
+
createUserAPIKey: (variables: CreateUserAPIKeyVariables, signal?: AbortSignal) => Promise<CreateUserAPIKeyResponse>;
|
7744
|
+
deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal) => Promise<undefined>;
|
6676
7745
|
};
|
6677
7746
|
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
|
7747
|
+
inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables, signal?: AbortSignal) => Promise<WorkspaceInvite>;
|
7748
|
+
updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<WorkspaceInvite>;
|
7749
|
+
cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
7750
|
+
acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
7751
|
+
resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
6683
7752
|
};
|
6684
7753
|
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
|
7754
|
+
listClusters: (variables: ListClustersVariables, signal?: AbortSignal) => Promise<ListClustersResponse>;
|
7755
|
+
createCluster: (variables: CreateClusterVariables, signal?: AbortSignal) => Promise<ClusterResponse>;
|
7756
|
+
getCluster: (variables: GetClusterVariables, signal?: AbortSignal) => Promise<ClusterMetadata>;
|
7757
|
+
updateCluster: (variables: UpdateClusterVariables, signal?: AbortSignal) => Promise<ClusterUpdateMetadata>;
|
7758
|
+
deleteCluster: (variables: DeleteClusterVariables, signal?: AbortSignal) => Promise<ClusterDeleteMetadata>;
|
6689
7759
|
};
|
6690
7760
|
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
|
7761
|
+
getDatabaseList: (variables: GetDatabaseListVariables, signal?: AbortSignal) => Promise<ListDatabasesResponse>;
|
7762
|
+
createDatabase: (variables: CreateDatabaseVariables, signal?: AbortSignal) => Promise<CreateDatabaseResponse>;
|
7763
|
+
deleteDatabase: (variables: DeleteDatabaseVariables, signal?: AbortSignal) => Promise<DeleteDatabaseResponse>;
|
7764
|
+
getDatabaseMetadata: (variables: GetDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
7765
|
+
updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
7766
|
+
renameDatabase: (variables: RenameDatabaseVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
7767
|
+
getDatabaseGithubSettings: (variables: GetDatabaseGithubSettingsVariables, signal?: AbortSignal) => Promise<DatabaseGithubSettings>;
|
7768
|
+
updateDatabaseGithubSettings: (variables: UpdateDatabaseGithubSettingsVariables, signal?: AbortSignal) => Promise<DatabaseGithubSettings>;
|
7769
|
+
deleteDatabaseGithubSettings: (variables: DeleteDatabaseGithubSettingsVariables, signal?: AbortSignal) => Promise<undefined>;
|
7770
|
+
listRegions: (variables: ListRegionsVariables, signal?: AbortSignal) => Promise<ListRegionsResponse>;
|
6701
7771
|
};
|
6702
7772
|
};
|
6703
7773
|
|
@@ -6715,9 +7785,32 @@ declare function buildProviderString(provider: HostProvider): string;
|
|
6715
7785
|
declare function parseWorkspacesUrlParts(url: string): {
|
6716
7786
|
workspace: string;
|
6717
7787
|
region: string;
|
7788
|
+
database: string;
|
7789
|
+
branch?: string;
|
6718
7790
|
host: HostAliases;
|
6719
7791
|
} | null;
|
6720
7792
|
|
7793
|
+
type ApiExtraProps = Omit<FetcherExtraProps, 'endpoint'>;
|
7794
|
+
interface XataApiClientOptions {
|
7795
|
+
fetch?: FetchImpl;
|
7796
|
+
apiKey?: string;
|
7797
|
+
host?: HostProvider;
|
7798
|
+
trace?: TraceFunction;
|
7799
|
+
clientName?: string;
|
7800
|
+
xataAgentExtra?: Record<string, string>;
|
7801
|
+
}
|
7802
|
+
type UserProps = {
|
7803
|
+
headers?: Record<string, unknown>;
|
7804
|
+
};
|
7805
|
+
type XataApiProxy = {
|
7806
|
+
[Tag in keyof typeof operationsByTag]: {
|
7807
|
+
[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;
|
7808
|
+
};
|
7809
|
+
};
|
7810
|
+
declare const XataApiClient_base: new (options?: XataApiClientOptions) => XataApiProxy;
|
7811
|
+
declare class XataApiClient extends XataApiClient_base {
|
7812
|
+
}
|
7813
|
+
|
6721
7814
|
type responses_AggResponse = AggResponse;
|
6722
7815
|
type responses_BranchMigrationPlan = BranchMigrationPlan;
|
6723
7816
|
type responses_BulkError = BulkError;
|
@@ -6727,6 +7820,7 @@ type responses_QueryResponse = QueryResponse;
|
|
6727
7820
|
type responses_RateLimitError = RateLimitError;
|
6728
7821
|
type responses_RecordResponse = RecordResponse;
|
6729
7822
|
type responses_RecordUpdateResponse = RecordUpdateResponse;
|
7823
|
+
type responses_SQLBatchResponse = SQLBatchResponse;
|
6730
7824
|
type responses_SQLResponse = SQLResponse;
|
6731
7825
|
type responses_SchemaCompareResponse = SchemaCompareResponse;
|
6732
7826
|
type responses_SchemaUpdateResponse = SchemaUpdateResponse;
|
@@ -6734,29 +7828,36 @@ type responses_SearchResponse = SearchResponse;
|
|
6734
7828
|
type responses_ServiceUnavailableError = ServiceUnavailableError;
|
6735
7829
|
type responses_SummarizeResponse = SummarizeResponse;
|
6736
7830
|
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 };
|
7831
|
+
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
7832
|
}
|
6739
7833
|
|
6740
7834
|
type schemas_APIKeyName = APIKeyName;
|
6741
7835
|
type schemas_AccessToken = AccessToken;
|
6742
7836
|
type schemas_AggExpression = AggExpression;
|
6743
7837
|
type schemas_AggExpressionMap = AggExpressionMap;
|
7838
|
+
type schemas_ApplyMigrationResponse = ApplyMigrationResponse;
|
6744
7839
|
type schemas_AuthorizationCodeRequest = AuthorizationCodeRequest;
|
6745
7840
|
type schemas_AuthorizationCodeResponse = AuthorizationCodeResponse;
|
6746
7841
|
type schemas_AutoscalingConfig = AutoscalingConfig;
|
7842
|
+
type schemas_AutoscalingConfigResponse = AutoscalingConfigResponse;
|
6747
7843
|
type schemas_AverageAgg = AverageAgg;
|
6748
7844
|
type schemas_BoosterExpression = BoosterExpression;
|
6749
7845
|
type schemas_Branch = Branch;
|
7846
|
+
type schemas_BranchDetails = BranchDetails;
|
6750
7847
|
type schemas_BranchMigration = BranchMigration;
|
6751
7848
|
type schemas_BranchOp = BranchOp;
|
7849
|
+
type schemas_BranchSchema = BranchSchema;
|
7850
|
+
type schemas_BranchState = BranchState;
|
6752
7851
|
type schemas_BranchWithCopyID = BranchWithCopyID;
|
6753
7852
|
type schemas_ClusterConfiguration = ClusterConfiguration;
|
7853
|
+
type schemas_ClusterConfigurationResponse = ClusterConfigurationResponse;
|
6754
7854
|
type schemas_ClusterCreateDetails = ClusterCreateDetails;
|
6755
|
-
type
|
7855
|
+
type schemas_ClusterDeleteMetadata = ClusterDeleteMetadata;
|
6756
7856
|
type schemas_ClusterMetadata = ClusterMetadata;
|
6757
7857
|
type schemas_ClusterResponse = ClusterResponse;
|
6758
7858
|
type schemas_ClusterShortMetadata = ClusterShortMetadata;
|
6759
7859
|
type schemas_ClusterUpdateDetails = ClusterUpdateDetails;
|
7860
|
+
type schemas_ClusterUpdateMetadata = ClusterUpdateMetadata;
|
6760
7861
|
type schemas_Column = Column;
|
6761
7862
|
type schemas_ColumnFile = ColumnFile;
|
6762
7863
|
type schemas_ColumnLink = ColumnLink;
|
@@ -6768,6 +7869,7 @@ type schemas_ColumnOpRename = ColumnOpRename;
|
|
6768
7869
|
type schemas_ColumnVector = ColumnVector;
|
6769
7870
|
type schemas_ColumnsProjection = ColumnsProjection;
|
6770
7871
|
type schemas_Commit = Commit;
|
7872
|
+
type schemas_CompleteMigrationResponse = CompleteMigrationResponse;
|
6771
7873
|
type schemas_CountAgg = CountAgg;
|
6772
7874
|
type schemas_DBBranch = DBBranch;
|
6773
7875
|
type schemas_DBBranchName = DBBranchName;
|
@@ -6775,6 +7877,7 @@ type schemas_DailyTimeWindow = DailyTimeWindow;
|
|
6775
7877
|
type schemas_DataInputRecord = DataInputRecord;
|
6776
7878
|
type schemas_DatabaseGithubSettings = DatabaseGithubSettings;
|
6777
7879
|
type schemas_DatabaseMetadata = DatabaseMetadata;
|
7880
|
+
type schemas_DatabaseSettings = DatabaseSettings;
|
6778
7881
|
type schemas_DateHistogramAgg = DateHistogramAgg;
|
6779
7882
|
type schemas_FileAccessID = FileAccessID;
|
6780
7883
|
type schemas_FileItemID = FileItemID;
|
@@ -6791,6 +7894,7 @@ type schemas_FilterPredicateRangeOp = FilterPredicateRangeOp;
|
|
6791
7894
|
type schemas_FilterRangeValue = FilterRangeValue;
|
6792
7895
|
type schemas_FilterValue = FilterValue;
|
6793
7896
|
type schemas_FuzzinessExpression = FuzzinessExpression;
|
7897
|
+
type schemas_GetMigrationJobsResponse = GetMigrationJobsResponse;
|
6794
7898
|
type schemas_HighlightExpression = HighlightExpression;
|
6795
7899
|
type schemas_InputFile = InputFile;
|
6796
7900
|
type schemas_InputFileArray = InputFileArray;
|
@@ -6798,22 +7902,37 @@ type schemas_InputFileEntry = InputFileEntry;
|
|
6798
7902
|
type schemas_InviteID = InviteID;
|
6799
7903
|
type schemas_InviteKey = InviteKey;
|
6800
7904
|
type schemas_ListBranchesResponse = ListBranchesResponse;
|
7905
|
+
type schemas_ListClusterBranchesResponse = ListClusterBranchesResponse;
|
6801
7906
|
type schemas_ListClustersResponse = ListClustersResponse;
|
6802
7907
|
type schemas_ListDatabasesResponse = ListDatabasesResponse;
|
6803
7908
|
type schemas_ListGitBranchesResponse = ListGitBranchesResponse;
|
6804
7909
|
type schemas_ListRegionsResponse = ListRegionsResponse;
|
6805
7910
|
type schemas_MaintenanceConfig = MaintenanceConfig;
|
7911
|
+
type schemas_MaintenanceConfigResponse = MaintenanceConfigResponse;
|
6806
7912
|
type schemas_MaxAgg = MaxAgg;
|
6807
7913
|
type schemas_MediaType = MediaType;
|
7914
|
+
type schemas_MetricData = MetricData;
|
7915
|
+
type schemas_MetricMessage = MetricMessage;
|
6808
7916
|
type schemas_MetricsDatapoint = MetricsDatapoint;
|
6809
7917
|
type schemas_MetricsLatency = MetricsLatency;
|
7918
|
+
type schemas_MetricsResponse = MetricsResponse;
|
6810
7919
|
type schemas_Migration = Migration;
|
6811
7920
|
type schemas_MigrationColumnOp = MigrationColumnOp;
|
7921
|
+
type schemas_MigrationDescription = MigrationDescription;
|
7922
|
+
type schemas_MigrationHistoryItem = MigrationHistoryItem;
|
7923
|
+
type schemas_MigrationHistoryResponse = MigrationHistoryResponse;
|
7924
|
+
type schemas_MigrationJobID = MigrationJobID;
|
7925
|
+
type schemas_MigrationJobItem = MigrationJobItem;
|
7926
|
+
type schemas_MigrationJobStatus = MigrationJobStatus;
|
7927
|
+
type schemas_MigrationJobStatusResponse = MigrationJobStatusResponse;
|
7928
|
+
type schemas_MigrationJobType = MigrationJobType;
|
6812
7929
|
type schemas_MigrationObject = MigrationObject;
|
6813
7930
|
type schemas_MigrationOp = MigrationOp;
|
7931
|
+
type schemas_MigrationOperationDescription = MigrationOperationDescription;
|
6814
7932
|
type schemas_MigrationRequest = MigrationRequest;
|
6815
7933
|
type schemas_MigrationRequestNumber = MigrationRequestNumber;
|
6816
7934
|
type schemas_MigrationTableOp = MigrationTableOp;
|
7935
|
+
type schemas_MigrationType = MigrationType;
|
6817
7936
|
type schemas_MinAgg = MinAgg;
|
6818
7937
|
type schemas_NumericHistogramAgg = NumericHistogramAgg;
|
6819
7938
|
type schemas_OAuthAccessToken = OAuthAccessToken;
|
@@ -6823,19 +7942,9 @@ type schemas_OAuthResponseType = OAuthResponseType;
|
|
6823
7942
|
type schemas_OAuthScope = OAuthScope;
|
6824
7943
|
type schemas_ObjectValue = ObjectValue;
|
6825
7944
|
type schemas_PageConfig = PageConfig;
|
6826
|
-
type schemas_PageResponse = PageResponse;
|
6827
|
-
type schemas_PageSize = PageSize;
|
6828
|
-
type schemas_PageToken = PageToken;
|
6829
7945
|
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
7946
|
type schemas_PrefixExpression = PrefixExpression;
|
7947
|
+
type schemas_PreparedStatement = PreparedStatement;
|
6839
7948
|
type schemas_ProjectionConfig = ProjectionConfig;
|
6840
7949
|
type schemas_QueryColumnsProjection = QueryColumnsProjection;
|
6841
7950
|
type schemas_RecordID = RecordID;
|
@@ -6844,12 +7953,18 @@ type schemas_RecordsMetadata = RecordsMetadata;
|
|
6844
7953
|
type schemas_Region = Region;
|
6845
7954
|
type schemas_RevLink = RevLink;
|
6846
7955
|
type schemas_Role = Role;
|
7956
|
+
type schemas_RollbackMigrationResponse = RollbackMigrationResponse;
|
7957
|
+
type schemas_SQLConsistency = SQLConsistency;
|
6847
7958
|
type schemas_SQLRecord = SQLRecord;
|
7959
|
+
type schemas_SQLResponseArray = SQLResponseArray;
|
7960
|
+
type schemas_SQLResponseBase = SQLResponseBase;
|
7961
|
+
type schemas_SQLResponseJSON = SQLResponseJSON;
|
6848
7962
|
type schemas_Schema = Schema;
|
6849
7963
|
type schemas_SchemaEditScript = SchemaEditScript;
|
6850
7964
|
type schemas_SearchPageConfig = SearchPageConfig;
|
6851
7965
|
type schemas_SortExpression = SortExpression;
|
6852
7966
|
type schemas_SortOrder = SortOrder;
|
7967
|
+
type schemas_StartMigrationResponse = StartMigrationResponse;
|
6853
7968
|
type schemas_StartedFromMetadata = StartedFromMetadata;
|
6854
7969
|
type schemas_SumAgg = SumAgg;
|
6855
7970
|
type schemas_SummaryExpression = SummaryExpression;
|
@@ -6887,753 +8002,14 @@ type schemas_WorkspaceMember = WorkspaceMember;
|
|
6887
8002
|
type schemas_WorkspaceMembers = WorkspaceMembers;
|
6888
8003
|
type schemas_WorkspaceMeta = WorkspaceMeta;
|
6889
8004
|
type schemas_WorkspacePlan = WorkspacePlan;
|
8005
|
+
type schemas_WorkspaceSettings = WorkspaceSettings;
|
6890
8006
|
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>>;
|
8007
|
+
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, 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_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_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 };
|
8008
|
+
}
|
8009
|
+
|
8010
|
+
declare class XataApiPlugin implements XataPlugin {
|
8011
|
+
build(options: XataPluginOptions): XataApiClient;
|
8012
|
+
}
|
7637
8013
|
|
7638
8014
|
interface ImageTransformations {
|
7639
8015
|
/**
|
@@ -7800,6 +8176,580 @@ interface ImageTransformations {
|
|
7800
8176
|
declare function transformImage(url: string, ...transformations: ImageTransformations[]): string;
|
7801
8177
|
declare function transformImage(url: string | undefined, ...transformations: ImageTransformations[]): string | undefined;
|
7802
8178
|
|
8179
|
+
declare class Buffer extends Uint8Array {
|
8180
|
+
/**
|
8181
|
+
* Allocates a new buffer containing the given `str`.
|
8182
|
+
*
|
8183
|
+
* @param str String to store in buffer.
|
8184
|
+
* @param encoding Encoding to use, optional. Default is `utf8`.
|
8185
|
+
*/
|
8186
|
+
constructor(str: string, encoding?: Encoding);
|
8187
|
+
/**
|
8188
|
+
* Allocates a new buffer of `size` octets.
|
8189
|
+
*
|
8190
|
+
* @param size Count of octets to allocate.
|
8191
|
+
*/
|
8192
|
+
constructor(size: number);
|
8193
|
+
/**
|
8194
|
+
* Allocates a new buffer containing the given `array` of octets.
|
8195
|
+
*
|
8196
|
+
* @param array The octets to store.
|
8197
|
+
*/
|
8198
|
+
constructor(array: Uint8Array);
|
8199
|
+
/**
|
8200
|
+
* Allocates a new buffer containing the given `array` of octet values.
|
8201
|
+
*
|
8202
|
+
* @param array
|
8203
|
+
*/
|
8204
|
+
constructor(array: number[]);
|
8205
|
+
/**
|
8206
|
+
* Allocates a new buffer containing the given `array` of octet values.
|
8207
|
+
*
|
8208
|
+
* @param array
|
8209
|
+
* @param encoding
|
8210
|
+
*/
|
8211
|
+
constructor(array: number[], encoding: Encoding);
|
8212
|
+
/**
|
8213
|
+
* Copies the passed `buffer` data onto a new `Buffer` instance.
|
8214
|
+
*
|
8215
|
+
* @param buffer
|
8216
|
+
*/
|
8217
|
+
constructor(buffer: Buffer);
|
8218
|
+
/**
|
8219
|
+
* When passed a reference to the .buffer property of a TypedArray instance, the newly created Buffer will share
|
8220
|
+
* the same allocated memory as the TypedArray. The optional `byteOffset` and `length` arguments specify a memory
|
8221
|
+
* range within the `arrayBuffer` that will be shared by the Buffer.
|
8222
|
+
*
|
8223
|
+
* @param buffer The .buffer property of a TypedArray or a new ArrayBuffer().
|
8224
|
+
* @param byteOffset
|
8225
|
+
* @param length
|
8226
|
+
*/
|
8227
|
+
constructor(buffer: ArrayBuffer, byteOffset?: number, length?: number);
|
8228
|
+
/**
|
8229
|
+
* Return JSON representation of the buffer.
|
8230
|
+
*/
|
8231
|
+
toJSON(): {
|
8232
|
+
type: 'Buffer';
|
8233
|
+
data: number[];
|
8234
|
+
};
|
8235
|
+
/**
|
8236
|
+
* Writes `string` to the buffer at `offset` according to the character encoding in `encoding`. The `length`
|
8237
|
+
* parameter is the number of bytes to write. If the buffer does not contain enough space to fit the entire string,
|
8238
|
+
* only part of `string` will be written. However, partially encoded characters will not be written.
|
8239
|
+
*
|
8240
|
+
* @param string String to write to `buf`.
|
8241
|
+
* @param encoding The character encoding of `string`. Default: `utf8`.
|
8242
|
+
*/
|
8243
|
+
write(string: string, encoding?: Encoding): number;
|
8244
|
+
/**
|
8245
|
+
* Writes `string` to the buffer at `offset` according to the character encoding in `encoding`. The `length`
|
8246
|
+
* parameter is the number of bytes to write. If the buffer does not contain enough space to fit the entire string,
|
8247
|
+
* only part of `string` will be written. However, partially encoded characters will not be written.
|
8248
|
+
*
|
8249
|
+
* @param string String to write to `buf`.
|
8250
|
+
* @param offset Number of bytes to skip before starting to write `string`. Default: `0`.
|
8251
|
+
* @param length Maximum number of bytes to write: Default: `buf.length - offset`.
|
8252
|
+
* @param encoding The character encoding of `string`. Default: `utf8`.
|
8253
|
+
*/
|
8254
|
+
write(string: string, offset?: number, length?: number, encoding?: Encoding): number;
|
8255
|
+
/**
|
8256
|
+
* Decodes the buffer to a string according to the specified character encoding.
|
8257
|
+
* Passing `start` and `end` will decode only a subset of the buffer.
|
8258
|
+
*
|
8259
|
+
* Note that if the encoding is `utf8` and a byte sequence in the input is not valid UTF-8, then each invalid byte
|
8260
|
+
* will be replaced with `U+FFFD`.
|
8261
|
+
*
|
8262
|
+
* @param encoding
|
8263
|
+
* @param start
|
8264
|
+
* @param end
|
8265
|
+
*/
|
8266
|
+
toString(encoding?: Encoding, start?: number, end?: number): string;
|
8267
|
+
/**
|
8268
|
+
* Returns true if this buffer's is equal to the provided buffer, meaning they share the same exact data.
|
8269
|
+
*
|
8270
|
+
* @param otherBuffer
|
8271
|
+
*/
|
8272
|
+
equals(otherBuffer: Buffer): boolean;
|
8273
|
+
/**
|
8274
|
+
* Compares the buffer with `otherBuffer` and returns a number indicating whether the buffer comes before, after,
|
8275
|
+
* or is the same as `otherBuffer` in sort order. Comparison is based on the actual sequence of bytes in each
|
8276
|
+
* buffer.
|
8277
|
+
*
|
8278
|
+
* - `0` is returned if `otherBuffer` is the same as this buffer.
|
8279
|
+
* - `1` is returned if `otherBuffer` should come before this buffer when sorted.
|
8280
|
+
* - `-1` is returned if `otherBuffer` should come after this buffer when sorted.
|
8281
|
+
*
|
8282
|
+
* @param otherBuffer The buffer to compare to.
|
8283
|
+
* @param targetStart The offset within `otherBuffer` at which to begin comparison.
|
8284
|
+
* @param targetEnd The offset within `otherBuffer` at which to end comparison (exclusive).
|
8285
|
+
* @param sourceStart The offset within this buffer at which to begin comparison.
|
8286
|
+
* @param sourceEnd The offset within this buffer at which to end the comparison (exclusive).
|
8287
|
+
*/
|
8288
|
+
compare(otherBuffer: Uint8Array, targetStart?: number, targetEnd?: number, sourceStart?: number, sourceEnd?: number): number;
|
8289
|
+
/**
|
8290
|
+
* Copies data from a region of this buffer to a region in `targetBuffer`, even if the `targetBuffer` memory
|
8291
|
+
* region overlaps with this buffer.
|
8292
|
+
*
|
8293
|
+
* @param targetBuffer The target buffer to copy into.
|
8294
|
+
* @param targetStart The offset within `targetBuffer` at which to begin writing.
|
8295
|
+
* @param sourceStart The offset within this buffer at which to begin copying.
|
8296
|
+
* @param sourceEnd The offset within this buffer at which to end copying (exclusive).
|
8297
|
+
*/
|
8298
|
+
copy(targetBuffer: Uint8Array, targetStart?: number, sourceStart?: number, sourceEnd?: number): number;
|
8299
|
+
/**
|
8300
|
+
* Returns a new `Buffer` that references the same memory as the original, but offset and cropped by the `start`
|
8301
|
+
* and `end` indices. This is the same behavior as `buf.subarray()`.
|
8302
|
+
*
|
8303
|
+
* This method is not compatible with the `Uint8Array.prototype.slice()`, which is a superclass of Buffer. To copy
|
8304
|
+
* the slice, use `Uint8Array.prototype.slice()`.
|
8305
|
+
*
|
8306
|
+
* @param start
|
8307
|
+
* @param end
|
8308
|
+
*/
|
8309
|
+
slice(start?: number, end?: number): Buffer;
|
8310
|
+
/**
|
8311
|
+
* Writes `byteLength` bytes of `value` to `buf` at the specified `offset` as little-endian. Supports up to 48 bits
|
8312
|
+
* of accuracy. Behavior is undefined when value is anything other than an unsigned integer.
|
8313
|
+
*
|
8314
|
+
* @param value Number to write.
|
8315
|
+
* @param offset Number of bytes to skip before starting to write.
|
8316
|
+
* @param byteLength Number of bytes to write, between 0 and 6.
|
8317
|
+
* @param noAssert
|
8318
|
+
* @returns `offset` plus the number of bytes written.
|
8319
|
+
*/
|
8320
|
+
writeUIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
|
8321
|
+
/**
|
8322
|
+
* Writes `byteLength` bytes of `value` to `buf` at the specified `offset` as big-endian. Supports up to 48 bits of
|
8323
|
+
* accuracy. Behavior is undefined when `value` is anything other than an unsigned integer.
|
8324
|
+
*
|
8325
|
+
* @param value Number to write.
|
8326
|
+
* @param offset Number of bytes to skip before starting to write.
|
8327
|
+
* @param byteLength Number of bytes to write, between 0 and 6.
|
8328
|
+
* @param noAssert
|
8329
|
+
* @returns `offset` plus the number of bytes written.
|
8330
|
+
*/
|
8331
|
+
writeUIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
|
8332
|
+
/**
|
8333
|
+
* Writes `byteLength` bytes of `value` to `buf` at the specified `offset` as little-endian. Supports up to 48 bits
|
8334
|
+
* of accuracy. Behavior is undefined when `value` is anything other than a signed integer.
|
8335
|
+
*
|
8336
|
+
* @param value Number to write.
|
8337
|
+
* @param offset Number of bytes to skip before starting to write.
|
8338
|
+
* @param byteLength Number of bytes to write, between 0 and 6.
|
8339
|
+
* @param noAssert
|
8340
|
+
* @returns `offset` plus the number of bytes written.
|
8341
|
+
*/
|
8342
|
+
writeIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
|
8343
|
+
/**
|
8344
|
+
* Writes `byteLength` bytes of `value` to `buf` at the specified `offset` as big-endian. Supports up to 48 bits
|
8345
|
+
* of accuracy. Behavior is undefined when `value` is anything other than a signed integer.
|
8346
|
+
*
|
8347
|
+
* @param value Number to write.
|
8348
|
+
* @param offset Number of bytes to skip before starting to write.
|
8349
|
+
* @param byteLength Number of bytes to write, between 0 and 6.
|
8350
|
+
* @param noAssert
|
8351
|
+
* @returns `offset` plus the number of bytes written.
|
8352
|
+
*/
|
8353
|
+
writeIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
|
8354
|
+
/**
|
8355
|
+
* Reads `byteLength` number of bytes from `buf` at the specified `offset` and interprets the result as an
|
8356
|
+
* unsigned, little-endian integer supporting up to 48 bits of accuracy.
|
8357
|
+
*
|
8358
|
+
* @param offset Number of bytes to skip before starting to read.
|
8359
|
+
* @param byteLength Number of bytes to read, between 0 and 6.
|
8360
|
+
* @param noAssert
|
8361
|
+
*/
|
8362
|
+
readUIntLE(offset: number, byteLength: number, noAssert?: boolean): number;
|
8363
|
+
/**
|
8364
|
+
* Reads `byteLength` number of bytes from `buf` at the specified `offset` and interprets the result as an
|
8365
|
+
* unsigned, big-endian integer supporting up to 48 bits of accuracy.
|
8366
|
+
*
|
8367
|
+
* @param offset Number of bytes to skip before starting to read.
|
8368
|
+
* @param byteLength Number of bytes to read, between 0 and 6.
|
8369
|
+
* @param noAssert
|
8370
|
+
*/
|
8371
|
+
readUIntBE(offset: number, byteLength: number, noAssert?: boolean): number;
|
8372
|
+
/**
|
8373
|
+
* Reads `byteLength` number of bytes from `buf` at the specified `offset` and interprets the result as a
|
8374
|
+
* little-endian, two's complement signed value supporting up to 48 bits of accuracy.
|
8375
|
+
*
|
8376
|
+
* @param offset Number of bytes to skip before starting to read.
|
8377
|
+
* @param byteLength Number of bytes to read, between 0 and 6.
|
8378
|
+
* @param noAssert
|
8379
|
+
*/
|
8380
|
+
readIntLE(offset: number, byteLength: number, noAssert?: boolean): number;
|
8381
|
+
/**
|
8382
|
+
* Reads `byteLength` number of bytes from `buf` at the specified `offset` and interprets the result as a
|
8383
|
+
* big-endian, two's complement signed value supporting up to 48 bits of accuracy.
|
8384
|
+
*
|
8385
|
+
* @param offset Number of bytes to skip before starting to read.
|
8386
|
+
* @param byteLength Number of bytes to read, between 0 and 6.
|
8387
|
+
* @param noAssert
|
8388
|
+
*/
|
8389
|
+
readIntBE(offset: number, byteLength: number, noAssert?: boolean): number;
|
8390
|
+
/**
|
8391
|
+
* Reads an unsigned 8-bit integer from `buf` at the specified `offset`.
|
8392
|
+
*
|
8393
|
+
* @param offset Number of bytes to skip before starting to read.
|
8394
|
+
* @param noAssert
|
8395
|
+
*/
|
8396
|
+
readUInt8(offset: number, noAssert?: boolean): number;
|
8397
|
+
/**
|
8398
|
+
* Reads an unsigned, little-endian 16-bit integer from `buf` at the specified `offset`.
|
8399
|
+
*
|
8400
|
+
* @param offset Number of bytes to skip before starting to read.
|
8401
|
+
* @param noAssert
|
8402
|
+
*/
|
8403
|
+
readUInt16LE(offset: number, noAssert?: boolean): number;
|
8404
|
+
/**
|
8405
|
+
* Reads an unsigned, big-endian 16-bit integer from `buf` at the specified `offset`.
|
8406
|
+
*
|
8407
|
+
* @param offset Number of bytes to skip before starting to read.
|
8408
|
+
* @param noAssert
|
8409
|
+
*/
|
8410
|
+
readUInt16BE(offset: number, noAssert?: boolean): number;
|
8411
|
+
/**
|
8412
|
+
* Reads an unsigned, little-endian 32-bit integer from `buf` at the specified `offset`.
|
8413
|
+
*
|
8414
|
+
* @param offset Number of bytes to skip before starting to read.
|
8415
|
+
* @param noAssert
|
8416
|
+
*/
|
8417
|
+
readUInt32LE(offset: number, noAssert?: boolean): number;
|
8418
|
+
/**
|
8419
|
+
* Reads an unsigned, big-endian 32-bit integer from `buf` at the specified `offset`.
|
8420
|
+
*
|
8421
|
+
* @param offset Number of bytes to skip before starting to read.
|
8422
|
+
* @param noAssert
|
8423
|
+
*/
|
8424
|
+
readUInt32BE(offset: number, noAssert?: boolean): number;
|
8425
|
+
/**
|
8426
|
+
* Reads a signed 8-bit integer from `buf` at the specified `offset`. Integers read from a `Buffer` are interpreted
|
8427
|
+
* as two's complement signed values.
|
8428
|
+
*
|
8429
|
+
* @param offset Number of bytes to skip before starting to read.
|
8430
|
+
* @param noAssert
|
8431
|
+
*/
|
8432
|
+
readInt8(offset: number, noAssert?: boolean): number;
|
8433
|
+
/**
|
8434
|
+
* Reads a signed, little-endian 16-bit integer from `buf` at the specified `offset`. Integers read from a `Buffer`
|
8435
|
+
* are interpreted as two's complement signed values.
|
8436
|
+
*
|
8437
|
+
* @param offset Number of bytes to skip before starting to read.
|
8438
|
+
* @param noAssert
|
8439
|
+
*/
|
8440
|
+
readInt16LE(offset: number, noAssert?: boolean): number;
|
8441
|
+
/**
|
8442
|
+
* Reads a signed, big-endian 16-bit integer from `buf` at the specified `offset`. Integers read from a `Buffer`
|
8443
|
+
* are interpreted as two's complement signed values.
|
8444
|
+
*
|
8445
|
+
* @param offset Number of bytes to skip before starting to read.
|
8446
|
+
* @param noAssert
|
8447
|
+
*/
|
8448
|
+
readInt16BE(offset: number, noAssert?: boolean): number;
|
8449
|
+
/**
|
8450
|
+
* Reads a signed, little-endian 32-bit integer from `buf` at the specified `offset`. Integers read from a `Buffer`
|
8451
|
+
* are interpreted as two's complement signed values.
|
8452
|
+
*
|
8453
|
+
* @param offset Number of bytes to skip before starting to read.
|
8454
|
+
* @param noAssert
|
8455
|
+
*/
|
8456
|
+
readInt32LE(offset: number, noAssert?: boolean): number;
|
8457
|
+
/**
|
8458
|
+
* Reads a signed, big-endian 32-bit integer from `buf` at the specified `offset`. Integers read from a `Buffer`
|
8459
|
+
* are interpreted as two's complement signed values.
|
8460
|
+
*
|
8461
|
+
* @param offset Number of bytes to skip before starting to read.
|
8462
|
+
* @param noAssert
|
8463
|
+
*/
|
8464
|
+
readInt32BE(offset: number, noAssert?: boolean): number;
|
8465
|
+
/**
|
8466
|
+
* Interprets `buf` as an array of unsigned 16-bit integers and swaps the byte order in-place.
|
8467
|
+
* Throws a `RangeError` if `buf.length` is not a multiple of 2.
|
8468
|
+
*/
|
8469
|
+
swap16(): Buffer;
|
8470
|
+
/**
|
8471
|
+
* Interprets `buf` as an array of unsigned 32-bit integers and swaps the byte order in-place.
|
8472
|
+
* Throws a `RangeError` if `buf.length` is not a multiple of 4.
|
8473
|
+
*/
|
8474
|
+
swap32(): Buffer;
|
8475
|
+
/**
|
8476
|
+
* Interprets `buf` as an array of unsigned 64-bit integers and swaps the byte order in-place.
|
8477
|
+
* Throws a `RangeError` if `buf.length` is not a multiple of 8.
|
8478
|
+
*/
|
8479
|
+
swap64(): Buffer;
|
8480
|
+
/**
|
8481
|
+
* Swaps two octets.
|
8482
|
+
*
|
8483
|
+
* @param b
|
8484
|
+
* @param n
|
8485
|
+
* @param m
|
8486
|
+
*/
|
8487
|
+
private _swap;
|
8488
|
+
/**
|
8489
|
+
* Writes `value` to `buf` at the specified `offset`. The `value` must be a valid unsigned 8-bit integer.
|
8490
|
+
* Behavior is undefined when `value` is anything other than an unsigned 8-bit integer.
|
8491
|
+
*
|
8492
|
+
* @param value Number to write.
|
8493
|
+
* @param offset Number of bytes to skip before starting to write.
|
8494
|
+
* @param noAssert
|
8495
|
+
* @returns `offset` plus the number of bytes written.
|
8496
|
+
*/
|
8497
|
+
writeUInt8(value: number, offset: number, noAssert?: boolean): number;
|
8498
|
+
/**
|
8499
|
+
* Writes `value` to `buf` at the specified `offset` as little-endian. The `value` must be a valid unsigned 16-bit
|
8500
|
+
* integer. Behavior is undefined when `value` is anything other than an unsigned 16-bit integer.
|
8501
|
+
*
|
8502
|
+
* @param value Number to write.
|
8503
|
+
* @param offset Number of bytes to skip before starting to write.
|
8504
|
+
* @param noAssert
|
8505
|
+
* @returns `offset` plus the number of bytes written.
|
8506
|
+
*/
|
8507
|
+
writeUInt16LE(value: number | string, offset: number, noAssert?: boolean): number;
|
8508
|
+
/**
|
8509
|
+
* Writes `value` to `buf` at the specified `offset` as big-endian. The `value` must be a valid unsigned 16-bit
|
8510
|
+
* integer. Behavior is undefined when `value` is anything other than an unsigned 16-bit integer.
|
8511
|
+
*
|
8512
|
+
* @param value Number to write.
|
8513
|
+
* @param offset Number of bytes to skip before starting to write.
|
8514
|
+
* @param noAssert
|
8515
|
+
* @returns `offset` plus the number of bytes written.
|
8516
|
+
*/
|
8517
|
+
writeUInt16BE(value: number, offset: number, noAssert?: boolean): number;
|
8518
|
+
/**
|
8519
|
+
* Writes `value` to `buf` at the specified `offset` as little-endian. The `value` must be a valid unsigned 32-bit
|
8520
|
+
* integer. Behavior is undefined when `value` is anything other than an unsigned 32-bit integer.
|
8521
|
+
*
|
8522
|
+
* @param value Number to write.
|
8523
|
+
* @param offset Number of bytes to skip before starting to write.
|
8524
|
+
* @param noAssert
|
8525
|
+
* @returns `offset` plus the number of bytes written.
|
8526
|
+
*/
|
8527
|
+
writeUInt32LE(value: number, offset: number, noAssert?: boolean): number;
|
8528
|
+
/**
|
8529
|
+
* Writes `value` to `buf` at the specified `offset` as big-endian. The `value` must be a valid unsigned 32-bit
|
8530
|
+
* integer. Behavior is undefined when `value` is anything other than an unsigned 32-bit integer.
|
8531
|
+
*
|
8532
|
+
* @param value Number to write.
|
8533
|
+
* @param offset Number of bytes to skip before starting to write.
|
8534
|
+
* @param noAssert
|
8535
|
+
* @returns `offset` plus the number of bytes written.
|
8536
|
+
*/
|
8537
|
+
writeUInt32BE(value: number, offset: number, noAssert?: boolean): number;
|
8538
|
+
/**
|
8539
|
+
* Writes `value` to `buf` at the specified `offset`. The `value` must be a valid signed 8-bit integer.
|
8540
|
+
* Behavior is undefined when `value` is anything other than a signed 8-bit integer.
|
8541
|
+
*
|
8542
|
+
* @param value Number to write.
|
8543
|
+
* @param offset Number of bytes to skip before starting to write.
|
8544
|
+
* @param noAssert
|
8545
|
+
* @returns `offset` plus the number of bytes written.
|
8546
|
+
*/
|
8547
|
+
writeInt8(value: number, offset: number, noAssert?: boolean): number;
|
8548
|
+
/**
|
8549
|
+
* Writes `value` to `buf` at the specified `offset` as little-endian. The `value` must be a valid signed 16-bit
|
8550
|
+
* integer. Behavior is undefined when `value` is anything other than a signed 16-bit integer.
|
8551
|
+
*
|
8552
|
+
* @param value Number to write.
|
8553
|
+
* @param offset Number of bytes to skip before starting to write.
|
8554
|
+
* @param noAssert
|
8555
|
+
* @returns `offset` plus the number of bytes written.
|
8556
|
+
*/
|
8557
|
+
writeInt16LE(value: number, offset: number, noAssert?: boolean): number;
|
8558
|
+
/**
|
8559
|
+
* Writes `value` to `buf` at the specified `offset` as big-endian. The `value` must be a valid signed 16-bit
|
8560
|
+
* integer. Behavior is undefined when `value` is anything other than a signed 16-bit integer.
|
8561
|
+
*
|
8562
|
+
* @param value Number to write.
|
8563
|
+
* @param offset Number of bytes to skip before starting to write.
|
8564
|
+
* @param noAssert
|
8565
|
+
* @returns `offset` plus the number of bytes written.
|
8566
|
+
*/
|
8567
|
+
writeInt16BE(value: number, offset: number, noAssert?: boolean): number;
|
8568
|
+
/**
|
8569
|
+
* Writes `value` to `buf` at the specified `offset` as little-endian. The `value` must be a valid signed 32-bit
|
8570
|
+
* integer. Behavior is undefined when `value` is anything other than a signed 32-bit integer.
|
8571
|
+
*
|
8572
|
+
* @param value Number to write.
|
8573
|
+
* @param offset Number of bytes to skip before starting to write.
|
8574
|
+
* @param noAssert
|
8575
|
+
* @returns `offset` plus the number of bytes written.
|
8576
|
+
*/
|
8577
|
+
writeInt32LE(value: number, offset: number, noAssert?: boolean): number;
|
8578
|
+
/**
|
8579
|
+
* Writes `value` to `buf` at the specified `offset` as big-endian. The `value` must be a valid signed 32-bit
|
8580
|
+
* integer. Behavior is undefined when `value` is anything other than a signed 32-bit integer.
|
8581
|
+
*
|
8582
|
+
* @param value Number to write.
|
8583
|
+
* @param offset Number of bytes to skip before starting to write.
|
8584
|
+
* @param noAssert
|
8585
|
+
* @returns `offset` plus the number of bytes written.
|
8586
|
+
*/
|
8587
|
+
writeInt32BE(value: number, offset: number, noAssert?: boolean): number;
|
8588
|
+
/**
|
8589
|
+
* Fills `buf` with the specified `value`. If the `offset` and `end` are not given, the entire `buf` will be
|
8590
|
+
* filled. The `value` is coerced to a `uint32` value if it is not a string, `Buffer`, or integer. If the resulting
|
8591
|
+
* integer is greater than `255` (decimal), then `buf` will be filled with `value & 255`.
|
8592
|
+
*
|
8593
|
+
* If the final write of a `fill()` operation falls on a multi-byte character, then only the bytes of that
|
8594
|
+
* character that fit into `buf` are written.
|
8595
|
+
*
|
8596
|
+
* If `value` contains invalid characters, it is truncated; if no valid fill data remains, an exception is thrown.
|
8597
|
+
*
|
8598
|
+
* @param value
|
8599
|
+
* @param encoding
|
8600
|
+
*/
|
8601
|
+
fill(value: any, offset?: number, end?: number, encoding?: Encoding): this;
|
8602
|
+
/**
|
8603
|
+
* Returns the index of the specified value.
|
8604
|
+
*
|
8605
|
+
* If `value` is:
|
8606
|
+
* - a string, `value` is interpreted according to the character encoding in `encoding`.
|
8607
|
+
* - a `Buffer` or `Uint8Array`, `value` will be used in its entirety. To compare a partial Buffer, use `slice()`.
|
8608
|
+
* - a number, `value` will be interpreted as an unsigned 8-bit integer value between `0` and `255`.
|
8609
|
+
*
|
8610
|
+
* Any other types will throw a `TypeError`.
|
8611
|
+
*
|
8612
|
+
* @param value What to search for.
|
8613
|
+
* @param byteOffset Where to begin searching in `buf`. If negative, then calculated from the end.
|
8614
|
+
* @param encoding If `value` is a string, this is the encoding used to search.
|
8615
|
+
* @returns The index of the first occurrence of `value` in `buf`, or `-1` if not found.
|
8616
|
+
*/
|
8617
|
+
indexOf(value: string | number | Buffer, byteOffset?: number, encoding?: Encoding): number;
|
8618
|
+
/**
|
8619
|
+
* Gets the last index of the specified value.
|
8620
|
+
*
|
8621
|
+
* @see indexOf()
|
8622
|
+
* @param value
|
8623
|
+
* @param byteOffset
|
8624
|
+
* @param encoding
|
8625
|
+
*/
|
8626
|
+
lastIndexOf(value: string | number | Buffer, byteOffset?: number, encoding?: Encoding): number;
|
8627
|
+
private _bidirectionalIndexOf;
|
8628
|
+
/**
|
8629
|
+
* Equivalent to `buf.indexOf() !== -1`.
|
8630
|
+
*
|
8631
|
+
* @param value
|
8632
|
+
* @param byteOffset
|
8633
|
+
* @param encoding
|
8634
|
+
*/
|
8635
|
+
includes(value: string | number | Buffer, byteOffset?: number, encoding?: Encoding): boolean;
|
8636
|
+
/**
|
8637
|
+
* Allocates a new Buffer using an `array` of octet values.
|
8638
|
+
*
|
8639
|
+
* @param array
|
8640
|
+
*/
|
8641
|
+
static from(array: number[]): Buffer;
|
8642
|
+
/**
|
8643
|
+
* When passed a reference to the .buffer property of a TypedArray instance, the newly created Buffer will share
|
8644
|
+
* the same allocated memory as the TypedArray. The optional `byteOffset` and `length` arguments specify a memory
|
8645
|
+
* range within the `arrayBuffer` that will be shared by the Buffer.
|
8646
|
+
*
|
8647
|
+
* @param buffer The .buffer property of a TypedArray or a new ArrayBuffer().
|
8648
|
+
* @param byteOffset
|
8649
|
+
* @param length
|
8650
|
+
*/
|
8651
|
+
static from(buffer: ArrayBuffer, byteOffset?: number, length?: number): Buffer;
|
8652
|
+
/**
|
8653
|
+
* Copies the passed `buffer` data onto a new Buffer instance.
|
8654
|
+
*
|
8655
|
+
* @param buffer
|
8656
|
+
*/
|
8657
|
+
static from(buffer: Buffer | Uint8Array): Buffer;
|
8658
|
+
/**
|
8659
|
+
* Creates a new Buffer containing the given string `str`. If provided, the `encoding` parameter identifies the
|
8660
|
+
* character encoding.
|
8661
|
+
*
|
8662
|
+
* @param str String to store in buffer.
|
8663
|
+
* @param encoding Encoding to use, optional. Default is `utf8`.
|
8664
|
+
*/
|
8665
|
+
static from(str: string, encoding?: Encoding): Buffer;
|
8666
|
+
/**
|
8667
|
+
* Returns true if `obj` is a Buffer.
|
8668
|
+
*
|
8669
|
+
* @param obj
|
8670
|
+
*/
|
8671
|
+
static isBuffer(obj: any): obj is Buffer;
|
8672
|
+
/**
|
8673
|
+
* Returns true if `encoding` is a supported encoding.
|
8674
|
+
*
|
8675
|
+
* @param encoding
|
8676
|
+
*/
|
8677
|
+
static isEncoding(encoding: string): encoding is Encoding;
|
8678
|
+
/**
|
8679
|
+
* Gives the actual byte length of a string for an encoding. This is not the same as `string.length` since that
|
8680
|
+
* returns the number of characters in the string.
|
8681
|
+
*
|
8682
|
+
* @param string The string to test.
|
8683
|
+
* @param encoding The encoding to use for calculation. Defaults is `utf8`.
|
8684
|
+
*/
|
8685
|
+
static byteLength(string: string | Buffer | ArrayBuffer, encoding?: Encoding): number;
|
8686
|
+
/**
|
8687
|
+
* Returns a Buffer which is the result of concatenating all the buffers in the list together.
|
8688
|
+
*
|
8689
|
+
* - If the list has no items, or if the `totalLength` is 0, then it returns a zero-length buffer.
|
8690
|
+
* - If the list has exactly one item, then the first item is returned.
|
8691
|
+
* - If the list has more than one item, then a new buffer is created.
|
8692
|
+
*
|
8693
|
+
* It is faster to provide the `totalLength` if it is known. However, it will be calculated if not provided at
|
8694
|
+
* a small computational expense.
|
8695
|
+
*
|
8696
|
+
* @param list An array of Buffer objects to concatenate.
|
8697
|
+
* @param totalLength Total length of the buffers when concatenated.
|
8698
|
+
*/
|
8699
|
+
static concat(list: Uint8Array[], totalLength?: number): Buffer;
|
8700
|
+
/**
|
8701
|
+
* The same as `buf1.compare(buf2)`.
|
8702
|
+
*/
|
8703
|
+
static compare(buf1: Uint8Array, buf2: Uint8Array): number;
|
8704
|
+
/**
|
8705
|
+
* Allocates a new buffer of `size` octets.
|
8706
|
+
*
|
8707
|
+
* @param size The number of octets to allocate.
|
8708
|
+
* @param fill If specified, the buffer will be initialized by calling `buf.fill(fill)`, or with zeroes otherwise.
|
8709
|
+
* @param encoding The encoding used for the call to `buf.fill()` while initializing.
|
8710
|
+
*/
|
8711
|
+
static alloc(size: number, fill?: string | Buffer | number, encoding?: Encoding): Buffer;
|
8712
|
+
/**
|
8713
|
+
* Allocates a new buffer of `size` octets without initializing memory. The contents of the buffer are unknown.
|
8714
|
+
*
|
8715
|
+
* @param size
|
8716
|
+
*/
|
8717
|
+
static allocUnsafe(size: number): Buffer;
|
8718
|
+
/**
|
8719
|
+
* Returns true if the given `obj` is an instance of `type`.
|
8720
|
+
*
|
8721
|
+
* @param obj
|
8722
|
+
* @param type
|
8723
|
+
*/
|
8724
|
+
private static _isInstance;
|
8725
|
+
private static _checked;
|
8726
|
+
private static _blitBuffer;
|
8727
|
+
private static _utf8Write;
|
8728
|
+
private static _asciiWrite;
|
8729
|
+
private static _base64Write;
|
8730
|
+
private static _ucs2Write;
|
8731
|
+
private static _hexWrite;
|
8732
|
+
private static _utf8ToBytes;
|
8733
|
+
private static _base64ToBytes;
|
8734
|
+
private static _asciiToBytes;
|
8735
|
+
private static _utf16leToBytes;
|
8736
|
+
private static _hexSlice;
|
8737
|
+
private static _base64Slice;
|
8738
|
+
private static _utf8Slice;
|
8739
|
+
private static _decodeCodePointsArray;
|
8740
|
+
private static _asciiSlice;
|
8741
|
+
private static _latin1Slice;
|
8742
|
+
private static _utf16leSlice;
|
8743
|
+
private static _arrayIndexOf;
|
8744
|
+
private static _checkOffset;
|
8745
|
+
private static _checkInt;
|
8746
|
+
private static _getEncoding;
|
8747
|
+
}
|
8748
|
+
/**
|
8749
|
+
* The encodings that are supported in both native and polyfilled `Buffer` instances.
|
8750
|
+
*/
|
8751
|
+
type Encoding = 'ascii' | 'utf8' | 'utf16le' | 'ucs2' | 'binary' | 'hex' | 'latin1' | 'base64';
|
8752
|
+
|
7803
8753
|
type XataFileEditableFields = Partial<Pick<XataArrayFile, keyof InputFileEntry>>;
|
7804
8754
|
type XataFileFields = Partial<Pick<XataArrayFile, {
|
7805
8755
|
[K in StringKeys<XataArrayFile>]: XataArrayFile[K] extends Function ? never : K;
|
@@ -8320,10 +9270,11 @@ type SearchPluginResult<Schemas extends Record<string, BaseData>> = {
|
|
8320
9270
|
declare class SearchPlugin<Schemas extends Record<string, XataRecord>> extends XataPlugin {
|
8321
9271
|
#private;
|
8322
9272
|
private db;
|
8323
|
-
constructor(db: SchemaPluginResult<Schemas
|
9273
|
+
constructor(db: SchemaPluginResult<Schemas>);
|
8324
9274
|
build(pluginOptions: XataPluginOptions): SearchPluginResult<Schemas>;
|
8325
9275
|
}
|
8326
|
-
type SearchXataRecord<Record extends XataRecord> = Omit<Record, 'getMetadata'> & {
|
9276
|
+
type SearchXataRecord<Record extends XataRecord> = Omit<Record, 'getMetadata' | 'xata'> & {
|
9277
|
+
xata: XataRecordMetadata & SearchExtraProperties;
|
8327
9278
|
getMetadata: () => XataRecordMetadata & SearchExtraProperties;
|
8328
9279
|
};
|
8329
9280
|
type SearchExtraProperties = {
|
@@ -8644,7 +9595,7 @@ type QueryOptions<T extends XataRecord> = BaseOptions<T> & (CursorQueryOptions |
|
|
8644
9595
|
declare class Query<Record extends XataRecord, Result extends XataRecord = Record> implements Paginable<Record, Result> {
|
8645
9596
|
#private;
|
8646
9597
|
readonly meta: PaginationQueryMeta;
|
8647
|
-
readonly records:
|
9598
|
+
readonly records: PageRecordArray<Result>;
|
8648
9599
|
constructor(repository: RestRepository<Record> | null, table: {
|
8649
9600
|
name: string;
|
8650
9601
|
schema?: Table;
|
@@ -8772,25 +9723,25 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
8772
9723
|
* Performs the query in the database and returns a set of results.
|
8773
9724
|
* @returns An array of records from the database.
|
8774
9725
|
*/
|
8775
|
-
getMany(): Promise<
|
9726
|
+
getMany(): Promise<PageRecordArray<Result>>;
|
8776
9727
|
/**
|
8777
9728
|
* Performs the query in the database and returns a set of results.
|
8778
9729
|
* @param options Additional options to be used when performing the query.
|
8779
9730
|
* @returns An array of records from the database.
|
8780
9731
|
*/
|
8781
|
-
getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<
|
9732
|
+
getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<PageRecordArray<SelectedPick<Record, (typeof options)['columns']>>>;
|
8782
9733
|
/**
|
8783
9734
|
* Performs the query in the database and returns a set of results.
|
8784
9735
|
* @param options Additional options to be used when performing the query.
|
8785
9736
|
* @returns An array of records from the database.
|
8786
9737
|
*/
|
8787
|
-
getMany(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<
|
9738
|
+
getMany(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<PageRecordArray<Result>>;
|
8788
9739
|
/**
|
8789
9740
|
* Performs the query in the database and returns all the results.
|
8790
9741
|
* Warning: If there are a large number of results, this method can have performance implications.
|
8791
9742
|
* @returns An array of records from the database.
|
8792
9743
|
*/
|
8793
|
-
getAll(): Promise<Result
|
9744
|
+
getAll(): Promise<RecordArray<Result>>;
|
8794
9745
|
/**
|
8795
9746
|
* Performs the query in the database and returns all the results.
|
8796
9747
|
* Warning: If there are a large number of results, this method can have performance implications.
|
@@ -8799,7 +9750,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
8799
9750
|
*/
|
8800
9751
|
getAll<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
|
8801
9752
|
batchSize?: number;
|
8802
|
-
}>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']
|
9753
|
+
}>(options: Options): Promise<RecordArray<SelectedPick<Record, (typeof options)['columns']>>>;
|
8803
9754
|
/**
|
8804
9755
|
* Performs the query in the database and returns all the results.
|
8805
9756
|
* Warning: If there are a large number of results, this method can have performance implications.
|
@@ -8808,7 +9759,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
8808
9759
|
*/
|
8809
9760
|
getAll(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'> & {
|
8810
9761
|
batchSize?: number;
|
8811
|
-
}): Promise<Result
|
9762
|
+
}): Promise<RecordArray<Result>>;
|
8812
9763
|
/**
|
8813
9764
|
* Performs the query in the database and returns the first result.
|
8814
9765
|
* @returns The first record that matches the query, or null if no record matched the query.
|
@@ -8892,7 +9843,7 @@ type PaginationQueryMeta = {
|
|
8892
9843
|
};
|
8893
9844
|
interface Paginable<Record extends XataRecord, Result extends XataRecord = Record> {
|
8894
9845
|
meta: PaginationQueryMeta;
|
8895
|
-
records:
|
9846
|
+
records: PageRecordArray<Result>;
|
8896
9847
|
nextPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
8897
9848
|
previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
8898
9849
|
startPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
@@ -8912,7 +9863,7 @@ declare class Page<Record extends XataRecord, Result extends XataRecord = Record
|
|
8912
9863
|
/**
|
8913
9864
|
* The set of results for this page.
|
8914
9865
|
*/
|
8915
|
-
readonly records:
|
9866
|
+
readonly records: PageRecordArray<Result>;
|
8916
9867
|
constructor(query: Query<Record, Result>, meta: PaginationQueryMeta, records?: Result[]);
|
8917
9868
|
/**
|
8918
9869
|
* Retrieves the next page of results.
|
@@ -8966,6 +9917,14 @@ declare const PAGINATION_MAX_OFFSET = 49000;
|
|
8966
9917
|
declare const PAGINATION_DEFAULT_OFFSET = 0;
|
8967
9918
|
declare function isCursorPaginationOptions(options: Record<string, unknown> | undefined | null): options is CursorNavigationOptions;
|
8968
9919
|
declare class RecordArray<Result extends XataRecord> extends Array<Result> {
|
9920
|
+
constructor(overrideRecords?: Result[]);
|
9921
|
+
static parseConstructorParams(...args: any[]): any[];
|
9922
|
+
toArray(): Result[];
|
9923
|
+
toSerializable(): JSONData<Result>[];
|
9924
|
+
toString(): string;
|
9925
|
+
map<U>(callbackfn: (value: Result, index: number, array: Result[]) => U, thisArg?: any): U[];
|
9926
|
+
}
|
9927
|
+
declare class PageRecordArray<Result extends XataRecord> extends Array<Result> {
|
8969
9928
|
#private;
|
8970
9929
|
constructor(page: Paginable<any, Result>, overrideRecords?: Result[]);
|
8971
9930
|
static parseConstructorParams(...args: any[]): any[];
|
@@ -8978,25 +9937,25 @@ declare class RecordArray<Result extends XataRecord> extends Array<Result> {
|
|
8978
9937
|
*
|
8979
9938
|
* @returns A new array of objects
|
8980
9939
|
*/
|
8981
|
-
nextPage(size?: number, offset?: number): Promise<
|
9940
|
+
nextPage(size?: number, offset?: number): Promise<PageRecordArray<Result>>;
|
8982
9941
|
/**
|
8983
9942
|
* Retrieve previous page of records
|
8984
9943
|
*
|
8985
9944
|
* @returns A new array of objects
|
8986
9945
|
*/
|
8987
|
-
previousPage(size?: number, offset?: number): Promise<
|
9946
|
+
previousPage(size?: number, offset?: number): Promise<PageRecordArray<Result>>;
|
8988
9947
|
/**
|
8989
9948
|
* Retrieve start page of records
|
8990
9949
|
*
|
8991
9950
|
* @returns A new array of objects
|
8992
9951
|
*/
|
8993
|
-
startPage(size?: number, offset?: number): Promise<
|
9952
|
+
startPage(size?: number, offset?: number): Promise<PageRecordArray<Result>>;
|
8994
9953
|
/**
|
8995
9954
|
* Retrieve end page of records
|
8996
9955
|
*
|
8997
9956
|
* @returns A new array of objects
|
8998
9957
|
*/
|
8999
|
-
endPage(size?: number, offset?: number): Promise<
|
9958
|
+
endPage(size?: number, offset?: number): Promise<PageRecordArray<Result>>;
|
9000
9959
|
/**
|
9001
9960
|
* @returns Boolean indicating if there is a next page
|
9002
9961
|
*/
|
@@ -9733,7 +10692,7 @@ type PropertyType<Tables, Properties, PropertyName extends PropertyKey> = Proper
|
|
9733
10692
|
} : {
|
9734
10693
|
[K in PropertyName]?: InnerType<Type, Tables, LinkedTable> | null;
|
9735
10694
|
} : 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 :
|
10695
|
+
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
10696
|
|
9738
10697
|
/**
|
9739
10698
|
* Operator to restrict results to only values that are greater than the given value.
|
@@ -9786,11 +10745,11 @@ declare const le: <T extends ComparableType>(value: T) => ComparableTypeFilter<T
|
|
9786
10745
|
/**
|
9787
10746
|
* Operator to restrict results to only values that are not null.
|
9788
10747
|
*/
|
9789
|
-
declare const exists: <T>(column?: FilterColumns<T>
|
10748
|
+
declare const exists: <T>(column?: FilterColumns<T>) => ExistanceFilter<T>;
|
9790
10749
|
/**
|
9791
10750
|
* Operator to restrict results to only values that are null.
|
9792
10751
|
*/
|
9793
|
-
declare const notExists: <T>(column?: FilterColumns<T>
|
10752
|
+
declare const notExists: <T>(column?: FilterColumns<T>) => ExistanceFilter<T>;
|
9794
10753
|
/**
|
9795
10754
|
* Operator to restrict results to only values that start with the given prefix.
|
9796
10755
|
*/
|
@@ -9852,7 +10811,7 @@ type SchemaPluginResult<Schemas extends Record<string, XataRecord>> = {
|
|
9852
10811
|
};
|
9853
10812
|
declare class SchemaPlugin<Schemas extends Record<string, XataRecord>> extends XataPlugin {
|
9854
10813
|
#private;
|
9855
|
-
constructor(
|
10814
|
+
constructor();
|
9856
10815
|
build(pluginOptions: XataPluginOptions): SchemaPluginResult<Schemas>;
|
9857
10816
|
}
|
9858
10817
|
|
@@ -9893,18 +10852,112 @@ declare class FilesPlugin<Schemas extends Record<string, XataRecord>> extends Xa
|
|
9893
10852
|
}
|
9894
10853
|
|
9895
10854
|
type SQLQueryParams<T = any[]> = {
|
10855
|
+
/**
|
10856
|
+
* The SQL statement to execute.
|
10857
|
+
* @example
|
10858
|
+
* ```ts
|
10859
|
+
* const { records } = await xata.sql<TeamsRecord>({
|
10860
|
+
* statement: `SELECT * FROM teams WHERE name = $1`,
|
10861
|
+
* params: ['A name']
|
10862
|
+
* });
|
10863
|
+
* ```
|
10864
|
+
*
|
10865
|
+
* Be careful when using this with user input and use parametrized statements to avoid SQL injection.
|
10866
|
+
*/
|
9896
10867
|
statement: string;
|
10868
|
+
/**
|
10869
|
+
* The parameters to pass to the SQL statement.
|
10870
|
+
*/
|
9897
10871
|
params?: T;
|
10872
|
+
/**
|
10873
|
+
* The consistency level to use when executing the query.
|
10874
|
+
* @default 'strong'
|
10875
|
+
*/
|
10876
|
+
consistency?: 'strong' | 'eventual';
|
10877
|
+
/**
|
10878
|
+
* The response type to use when executing the query.
|
10879
|
+
* @default 'json'
|
10880
|
+
*/
|
10881
|
+
responseType?: 'json' | 'array';
|
10882
|
+
};
|
10883
|
+
type SQLBatchQuery = {
|
10884
|
+
/**
|
10885
|
+
* The SQL statements to execute.
|
10886
|
+
*/
|
10887
|
+
statements: {
|
10888
|
+
/**
|
10889
|
+
* The SQL statement to execute.
|
10890
|
+
*/
|
10891
|
+
statement: string;
|
10892
|
+
/**
|
10893
|
+
* The parameters to pass to the SQL statement.
|
10894
|
+
*/
|
10895
|
+
params?: any[];
|
10896
|
+
}[];
|
10897
|
+
/**
|
10898
|
+
* The consistency level to use when executing the queries.
|
10899
|
+
* @default 'strong'
|
10900
|
+
*/
|
9898
10901
|
consistency?: 'strong' | 'eventual';
|
10902
|
+
/**
|
10903
|
+
* The response type to use when executing the queries.
|
10904
|
+
* @default 'json'
|
10905
|
+
*/
|
10906
|
+
responseType?: 'json' | 'array';
|
9899
10907
|
};
|
9900
|
-
type SQLQuery = TemplateStringsArray | SQLQueryParams
|
9901
|
-
type
|
10908
|
+
type SQLQuery = TemplateStringsArray | SQLQueryParams;
|
10909
|
+
type SQLResponseType = 'json' | 'array';
|
10910
|
+
type SQLQueryResultJSON<T> = {
|
10911
|
+
/**
|
10912
|
+
* The records returned by the query.
|
10913
|
+
*/
|
9902
10914
|
records: T[];
|
9903
|
-
|
9904
|
-
|
10915
|
+
/**
|
10916
|
+
* The columns metadata returned by the query.
|
10917
|
+
*/
|
10918
|
+
columns: Array<{
|
10919
|
+
name: string;
|
10920
|
+
type: string;
|
9905
10921
|
}>;
|
10922
|
+
/**
|
10923
|
+
* Optional warning message returned by the query.
|
10924
|
+
*/
|
9906
10925
|
warning?: string;
|
9907
|
-
}
|
10926
|
+
};
|
10927
|
+
type SQLQueryResultArray = {
|
10928
|
+
/**
|
10929
|
+
* The records returned by the query.
|
10930
|
+
*/
|
10931
|
+
rows: any[][];
|
10932
|
+
/**
|
10933
|
+
* The columns metadata returned by the query.
|
10934
|
+
*/
|
10935
|
+
columns: Array<{
|
10936
|
+
name: string;
|
10937
|
+
type: string;
|
10938
|
+
}>;
|
10939
|
+
/**
|
10940
|
+
* Optional warning message returned by the query.
|
10941
|
+
*/
|
10942
|
+
warning?: string;
|
10943
|
+
};
|
10944
|
+
type SQLQueryResult<T, Mode extends SQLResponseType = 'json'> = Mode extends 'json' ? SQLQueryResultJSON<T> : Mode extends 'array' ? SQLQueryResultArray : never;
|
10945
|
+
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'>>;
|
10946
|
+
type SQLPluginResult = SQLPluginFunction & {
|
10947
|
+
/**
|
10948
|
+
* Connection string to use when connecting to the database.
|
10949
|
+
* It includes the workspace, region, database and branch.
|
10950
|
+
* Connects with the same credentials as the Xata client.
|
10951
|
+
*/
|
10952
|
+
connectionString: string;
|
10953
|
+
/**
|
10954
|
+
* Executes a batch of SQL statements.
|
10955
|
+
* @param query The batch of SQL statements to execute.
|
10956
|
+
*/
|
10957
|
+
batch: <Query extends SQLBatchQuery = SQLBatchQuery>(query: Query) => Promise<{
|
10958
|
+
results: Array<SQLQueryResult<any, Query extends SQLBatchQuery ? Query['responseType'] extends SQLResponseType ? NonNullable<Query['responseType']> : 'json' : 'json'>>;
|
10959
|
+
}>;
|
10960
|
+
};
|
9908
10961
|
declare class SQLPlugin extends XataPlugin {
|
9909
10962
|
build(pluginOptions: XataPluginOptions): SQLPluginResult;
|
9910
10963
|
}
|
@@ -10020,7 +11073,7 @@ type BaseClientOptions = {
|
|
10020
11073
|
clientName?: string;
|
10021
11074
|
xataAgentExtra?: Record<string, string>;
|
10022
11075
|
};
|
10023
|
-
declare const buildClient: <Plugins extends Record<string, XataPlugin> = {}>(plugins?: Plugins
|
11076
|
+
declare const buildClient: <Plugins extends Record<string, XataPlugin> = {}>(plugins?: Plugins) => ClientConstructor<Plugins>;
|
10024
11077
|
interface ClientConstructor<Plugins extends Record<string, XataPlugin>> {
|
10025
11078
|
new <Schemas extends Record<string, XataRecord> = {}>(options?: Partial<BaseClientOptions>, schemaTables?: readonly BaseSchema[]): Omit<{
|
10026
11079
|
db: Awaited<ReturnType<SchemaPlugin<Schemas>['build']>>;
|
@@ -10071,4 +11124,4 @@ declare class XataError extends Error {
|
|
10071
11124
|
constructor(message: string, status: number);
|
10072
11125
|
}
|
10073
11126
|
|
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 };
|
11127
|
+
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 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 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 InviteWorkspaceMemberError, type InviteWorkspaceMemberPathParams, type InviteWorkspaceMemberRequestBody, type InviteWorkspaceMemberVariables, type JSONData, type KeywordAskOptions, type Link, type ListClusterBranchesError, type ListClusterBranchesPathParams, type ListClusterBranchesQueryParams, type ListClusterBranchesVariables, 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 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 UpdateWorkspaceSettingsRequestBody, 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, 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, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isValidExpandedColumn, isValidSelectableColumns, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listClusterBranches, 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 };
|