@xata.io/client 0.0.0-alpha.vfc08a49f5b2f1e93114c76b97e7da90408e84709 → 0.0.0-alpha.vfc2160d20dff569d0f4b3272a1273ca130158619
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-add-version.log +1 -1
- package/.turbo/turbo-build.log +3 -3
- package/CHANGELOG.md +52 -6
- package/dist/index.cjs +2752 -657
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +2279 -261
- package/dist/index.mjs +2725 -655
- 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>;
|
@@ -96,6 +98,139 @@ type RequiredKeys<T> = {
|
|
96
98
|
*
|
97
99
|
* @version 1.0
|
98
100
|
*/
|
101
|
+
type TaskStatus = 'scheduled' | 'pending' | 'active' | 'retry' | 'archived' | 'completed';
|
102
|
+
type TaskStatusResponse = {
|
103
|
+
/**
|
104
|
+
* The id of the task
|
105
|
+
*/
|
106
|
+
taskID: string;
|
107
|
+
/**
|
108
|
+
* The type of the task
|
109
|
+
*/
|
110
|
+
type: string;
|
111
|
+
/**
|
112
|
+
* The status of the task
|
113
|
+
*/
|
114
|
+
status: TaskStatus;
|
115
|
+
/**
|
116
|
+
* Any error message associated with the task
|
117
|
+
*/
|
118
|
+
error?: string;
|
119
|
+
};
|
120
|
+
/**
|
121
|
+
* @maxLength 255
|
122
|
+
* @minLength 1
|
123
|
+
* @pattern [a-zA-Z0-9_\-~]+
|
124
|
+
*/
|
125
|
+
type TaskID = string;
|
126
|
+
/**
|
127
|
+
* @x-internal true
|
128
|
+
* @pattern [a-zA-Z0-9_-~:]+
|
129
|
+
*/
|
130
|
+
type ClusterID$1 = string;
|
131
|
+
/**
|
132
|
+
* Page size.
|
133
|
+
*
|
134
|
+
* @x-internal true
|
135
|
+
* @default 25
|
136
|
+
* @minimum 0
|
137
|
+
*/
|
138
|
+
type PageSize$1 = number;
|
139
|
+
/**
|
140
|
+
* Page token
|
141
|
+
*
|
142
|
+
* @x-internal true
|
143
|
+
* @maxLength 255
|
144
|
+
* @minLength 24
|
145
|
+
*/
|
146
|
+
type PageToken$1 = string;
|
147
|
+
/**
|
148
|
+
* @format date-time
|
149
|
+
* @x-go-type string
|
150
|
+
*/
|
151
|
+
type DateTime$1 = string;
|
152
|
+
/**
|
153
|
+
* @x-internal true
|
154
|
+
*/
|
155
|
+
type BranchDetails = {
|
156
|
+
name: string;
|
157
|
+
id: string;
|
158
|
+
/**
|
159
|
+
* The cluster where this branch resides.
|
160
|
+
*
|
161
|
+
* @minLength 1
|
162
|
+
*/
|
163
|
+
clusterID: string;
|
164
|
+
state: string;
|
165
|
+
createdAt: DateTime$1;
|
166
|
+
databaseName: string;
|
167
|
+
databaseID: string;
|
168
|
+
};
|
169
|
+
/**
|
170
|
+
* @x-internal true
|
171
|
+
*/
|
172
|
+
type PageResponse$1 = {
|
173
|
+
size: number;
|
174
|
+
hasMore: boolean;
|
175
|
+
token?: string;
|
176
|
+
};
|
177
|
+
/**
|
178
|
+
* @x-internal true
|
179
|
+
*/
|
180
|
+
type ListClusterBranchesResponse = {
|
181
|
+
branches: BranchDetails[];
|
182
|
+
page?: PageResponse$1;
|
183
|
+
};
|
184
|
+
/**
|
185
|
+
* @x-internal true
|
186
|
+
*/
|
187
|
+
type ExtensionDetails = {
|
188
|
+
name: string;
|
189
|
+
description: string;
|
190
|
+
builtIn: boolean;
|
191
|
+
status: 'installed' | 'not_installed';
|
192
|
+
version: string;
|
193
|
+
};
|
194
|
+
/**
|
195
|
+
* @x-internal true
|
196
|
+
*/
|
197
|
+
type ListClusterExtensionsResponse = {
|
198
|
+
extensions: ExtensionDetails[];
|
199
|
+
};
|
200
|
+
/**
|
201
|
+
* @x-internal true
|
202
|
+
*/
|
203
|
+
type ClusterExtensionInstallationResponse = {
|
204
|
+
extension: string;
|
205
|
+
status: 'success' | 'failure';
|
206
|
+
reason?: string;
|
207
|
+
};
|
208
|
+
/**
|
209
|
+
* @x-internal true
|
210
|
+
*/
|
211
|
+
type MetricMessage = {
|
212
|
+
code?: string;
|
213
|
+
value?: string;
|
214
|
+
};
|
215
|
+
/**
|
216
|
+
* @x-internal true
|
217
|
+
*/
|
218
|
+
type MetricData = {
|
219
|
+
id?: string;
|
220
|
+
label?: string;
|
221
|
+
messages?: MetricMessage[] | null;
|
222
|
+
status: 'complete' | 'error' | 'partial' | 'forbidden';
|
223
|
+
timestamps: string[];
|
224
|
+
values: number[];
|
225
|
+
};
|
226
|
+
/**
|
227
|
+
* @x-internal true
|
228
|
+
*/
|
229
|
+
type MetricsResponse = {
|
230
|
+
metrics: MetricData[];
|
231
|
+
messages: MetricMessage[];
|
232
|
+
page?: PageResponse$1;
|
233
|
+
};
|
99
234
|
/**
|
100
235
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
101
236
|
*
|
@@ -104,15 +239,156 @@ type RequiredKeys<T> = {
|
|
104
239
|
* @pattern [a-zA-Z0-9_\-~]+:[a-zA-Z0-9_\-~]+
|
105
240
|
*/
|
106
241
|
type DBBranchName = string;
|
107
|
-
type
|
242
|
+
type ApplyMigrationResponse = {
|
243
|
+
/**
|
244
|
+
* The id of the migration job
|
245
|
+
*/
|
246
|
+
jobID: string;
|
247
|
+
};
|
248
|
+
type StartMigrationResponse = {
|
249
|
+
/**
|
250
|
+
* The id of the migration job
|
251
|
+
*/
|
252
|
+
jobID: string;
|
253
|
+
};
|
254
|
+
type CompleteMigrationResponse = {
|
255
|
+
/**
|
256
|
+
* The id of the migration job
|
257
|
+
*/
|
258
|
+
jobID: string;
|
259
|
+
};
|
260
|
+
type RollbackMigrationResponse = {
|
261
|
+
/**
|
262
|
+
* The id of the migration job
|
263
|
+
*/
|
264
|
+
jobID: string;
|
265
|
+
};
|
266
|
+
/**
|
267
|
+
* @maxLength 255
|
268
|
+
* @minLength 1
|
269
|
+
* @pattern [a-zA-Z0-9_\-~]+
|
270
|
+
*/
|
271
|
+
type TableName = string;
|
272
|
+
type MigrationJobType = 'apply' | 'start' | 'complete' | 'rollback';
|
273
|
+
type MigrationJobStatus = 'pending' | 'in_progress' | 'completed' | 'failed';
|
274
|
+
/**
|
275
|
+
* The effect of a migration operation in terms of CRUD operations on the underlying schema
|
276
|
+
*/
|
277
|
+
type MigrationOperationDescription = {
|
278
|
+
/**
|
279
|
+
* A new database object created by the operation
|
280
|
+
*/
|
281
|
+
create?: {
|
282
|
+
/**
|
283
|
+
* The type of object created
|
284
|
+
*/
|
285
|
+
type: 'table' | 'column' | 'index';
|
286
|
+
/**
|
287
|
+
* The name of the object created
|
288
|
+
*/
|
289
|
+
name: string;
|
290
|
+
/**
|
291
|
+
* The name of the table on which the object is created, if applicable
|
292
|
+
*/
|
293
|
+
table?: string;
|
294
|
+
/**
|
295
|
+
* The mapping between the virtual and physical name of the new object, if applicable
|
296
|
+
*/
|
297
|
+
mapping?: Record<string, any>;
|
298
|
+
};
|
299
|
+
/**
|
300
|
+
* A database object updated by the operation
|
301
|
+
*/
|
302
|
+
update?: {
|
303
|
+
/**
|
304
|
+
* The type of updated object
|
305
|
+
*/
|
306
|
+
type: 'table' | 'column';
|
307
|
+
/**
|
308
|
+
* The name of the updated object
|
309
|
+
*/
|
310
|
+
name: string;
|
311
|
+
/**
|
312
|
+
* The name of the table on which the object is updated, if applicable
|
313
|
+
*/
|
314
|
+
table?: string;
|
315
|
+
/**
|
316
|
+
* The mapping between the virtual and physical name of the updated object, if applicable
|
317
|
+
*/
|
318
|
+
mapping?: Record<string, any>;
|
319
|
+
};
|
320
|
+
/**
|
321
|
+
* A database object renamed by the operation
|
322
|
+
*/
|
323
|
+
rename?: {
|
324
|
+
/**
|
325
|
+
* The type of the renamed object
|
326
|
+
*/
|
327
|
+
type: 'table' | 'column' | 'constraint';
|
328
|
+
/**
|
329
|
+
* The name of the table on which the object is renamed, if applicable
|
330
|
+
*/
|
331
|
+
table?: string;
|
332
|
+
/**
|
333
|
+
* The old name of the renamed object
|
334
|
+
*/
|
335
|
+
from: string;
|
336
|
+
/**
|
337
|
+
* The new name of the renamed object
|
338
|
+
*/
|
339
|
+
to: string;
|
340
|
+
};
|
341
|
+
/**
|
342
|
+
* A database object deleted by the operation
|
343
|
+
*/
|
344
|
+
['delete']?: {
|
345
|
+
/**
|
346
|
+
* The type of the deleted object
|
347
|
+
*/
|
348
|
+
type: 'table' | 'column' | 'constraint' | 'index';
|
349
|
+
/**
|
350
|
+
* The name of the deleted object
|
351
|
+
*/
|
352
|
+
name: string;
|
353
|
+
/**
|
354
|
+
* The name of the table on which the object is deleted, if applicable
|
355
|
+
*/
|
356
|
+
table: string;
|
357
|
+
};
|
358
|
+
};
|
359
|
+
/**
|
360
|
+
* @minItems 1
|
361
|
+
*/
|
362
|
+
type MigrationDescription = MigrationOperationDescription[];
|
363
|
+
type MigrationJobStatusResponse = {
|
108
364
|
/**
|
109
365
|
* The id of the migration job
|
110
366
|
*/
|
111
367
|
jobID: string;
|
368
|
+
/**
|
369
|
+
* The type of the migration job
|
370
|
+
*/
|
371
|
+
type: MigrationJobType;
|
372
|
+
/**
|
373
|
+
* The status of the migration job
|
374
|
+
*/
|
375
|
+
status: MigrationJobStatus;
|
376
|
+
/**
|
377
|
+
* The effect of any active migration on the schema
|
378
|
+
*/
|
379
|
+
description?: MigrationDescription;
|
380
|
+
/**
|
381
|
+
* The timestamp at which the migration job completed or failed
|
382
|
+
*
|
383
|
+
* @format date-time
|
384
|
+
*/
|
385
|
+
completedAt?: string;
|
386
|
+
/**
|
387
|
+
* The error message associated with the migration job
|
388
|
+
*/
|
389
|
+
error?: string;
|
112
390
|
};
|
113
|
-
type
|
114
|
-
type PgRollJobStatus = 'pending' | 'in_progress' | 'completed' | 'failed';
|
115
|
-
type PgRollJobStatusResponse = {
|
391
|
+
type MigrationJobItem = {
|
116
392
|
/**
|
117
393
|
* The id of the migration job
|
118
394
|
*/
|
@@ -120,28 +396,62 @@ type PgRollJobStatusResponse = {
|
|
120
396
|
/**
|
121
397
|
* The type of the migration job
|
122
398
|
*/
|
123
|
-
type:
|
399
|
+
type: MigrationJobType;
|
124
400
|
/**
|
125
401
|
* The status of the migration job
|
126
402
|
*/
|
127
|
-
status:
|
403
|
+
status: MigrationJobStatus;
|
404
|
+
/**
|
405
|
+
* The pgroll migration that was applied
|
406
|
+
*/
|
407
|
+
migration?: string;
|
408
|
+
/**
|
409
|
+
* The effect of any active migration on the schema
|
410
|
+
*/
|
411
|
+
description?: MigrationDescription;
|
412
|
+
/**
|
413
|
+
* The timestamp at which the migration job was enqueued
|
414
|
+
*
|
415
|
+
* @format date-time
|
416
|
+
*/
|
417
|
+
enqueuedAt: string;
|
418
|
+
/**
|
419
|
+
* The timestamp at which the migration job completed or failed
|
420
|
+
*
|
421
|
+
* @format date-time
|
422
|
+
*/
|
423
|
+
completedAt?: string;
|
128
424
|
/**
|
129
425
|
* The error message associated with the migration job
|
130
426
|
*/
|
131
427
|
error?: string;
|
132
428
|
};
|
429
|
+
type GetMigrationJobsResponse = {
|
430
|
+
/**
|
431
|
+
* The list of migration jobs
|
432
|
+
*/
|
433
|
+
jobs: MigrationJobItem[];
|
434
|
+
/**
|
435
|
+
* The cursor (timestamp) for the next page of results
|
436
|
+
*/
|
437
|
+
cursor?: string;
|
438
|
+
};
|
133
439
|
/**
|
134
440
|
* @maxLength 255
|
135
441
|
* @minLength 1
|
136
442
|
* @pattern [a-zA-Z0-9_\-~]+
|
137
443
|
*/
|
138
|
-
type
|
139
|
-
type
|
140
|
-
type
|
444
|
+
type MigrationJobID = string;
|
445
|
+
type MigrationType = 'pgroll' | 'inferred';
|
446
|
+
type MigrationHistoryItem = {
|
141
447
|
/**
|
142
448
|
* The name of the migration
|
143
449
|
*/
|
144
450
|
name: string;
|
451
|
+
/**
|
452
|
+
* The schema in which the migration was applied
|
453
|
+
*/
|
454
|
+
schema: string;
|
145
455
|
/**
|
146
456
|
* The pgroll migration that was applied
|
147
457
|
*/
|
@@ -163,13 +473,17 @@ type PgRollMigrationHistoryItem = {
|
|
163
473
|
/**
|
164
474
|
* The type of the migration
|
165
475
|
*/
|
166
|
-
migrationType:
|
476
|
+
migrationType: MigrationType;
|
167
477
|
};
|
168
|
-
type
|
478
|
+
type MigrationHistoryResponse = {
|
169
479
|
/**
|
170
480
|
* The migrations that have been applied to the branch
|
171
481
|
*/
|
172
|
-
migrations:
|
482
|
+
migrations: MigrationHistoryItem[];
|
483
|
+
/**
|
484
|
+
* The cursor (timestamp) for the next page of results
|
485
|
+
*/
|
486
|
+
cursor?: string;
|
173
487
|
};
|
174
488
|
/**
|
175
489
|
* @maxLength 255
|
@@ -178,25 +492,29 @@ type PgRollMigrationHistoryResponse = {
|
|
178
492
|
*/
|
179
493
|
type DBName$1 = string;
|
180
494
|
/**
|
181
|
-
*
|
182
|
-
* @x-go-type string
|
495
|
+
* Represent the state of the branch, used for branch lifecycle management
|
183
496
|
*/
|
184
|
-
type
|
497
|
+
type BranchState = 'active' | 'move_scheduled' | 'moving';
|
185
498
|
type Branch = {
|
186
499
|
name: string;
|
187
500
|
/**
|
188
501
|
* The cluster where this branch resides. Value of 'shared-cluster' for branches in shared clusters
|
189
502
|
*
|
190
503
|
* @minLength 1
|
191
|
-
* @x-internal true
|
192
504
|
*/
|
193
505
|
clusterID?: string;
|
506
|
+
state: BranchState;
|
194
507
|
createdAt: DateTime$1;
|
508
|
+
searchDisabled?: boolean;
|
509
|
+
inactiveSharedCluster?: boolean;
|
195
510
|
};
|
196
511
|
type ListBranchesResponse = {
|
197
512
|
databaseName: string;
|
198
513
|
branches: Branch[];
|
199
514
|
};
|
515
|
+
type DatabaseSettings = {
|
516
|
+
searchEnabled: boolean;
|
517
|
+
};
|
200
518
|
/**
|
201
519
|
* @maxLength 255
|
202
520
|
* @minLength 1
|
@@ -219,17 +537,17 @@ type BranchMetadata$1 = {
|
|
219
537
|
stage?: string;
|
220
538
|
labels?: string[];
|
221
539
|
};
|
540
|
+
type CreateBranchResponse$1 = {
|
541
|
+
/**
|
542
|
+
* The id of the branch creation task
|
543
|
+
*/
|
544
|
+
taskID: string;
|
545
|
+
};
|
222
546
|
type StartedFromMetadata = {
|
223
547
|
branchName: BranchName$1;
|
224
548
|
dbBranchID: string;
|
225
549
|
migrationID: string;
|
226
550
|
};
|
227
|
-
/**
|
228
|
-
* @maxLength 255
|
229
|
-
* @minLength 1
|
230
|
-
* @pattern [a-zA-Z0-9_\-~]+
|
231
|
-
*/
|
232
|
-
type TableName = string;
|
233
551
|
type ColumnLink = {
|
234
552
|
table: string;
|
235
553
|
};
|
@@ -245,7 +563,7 @@ type ColumnFile = {
|
|
245
563
|
};
|
246
564
|
type Column = {
|
247
565
|
name: string;
|
248
|
-
type:
|
566
|
+
type: string;
|
249
567
|
link?: ColumnLink;
|
250
568
|
vector?: ColumnVector;
|
251
569
|
file?: ColumnFile;
|
@@ -284,12 +602,63 @@ type DBBranch = {
|
|
284
602
|
*/
|
285
603
|
clusterID?: string;
|
286
604
|
version: number;
|
605
|
+
state: BranchState;
|
287
606
|
lastMigrationID: string;
|
288
607
|
metadata?: BranchMetadata$1;
|
289
608
|
startedFrom?: StartedFromMetadata;
|
290
609
|
schema: Schema;
|
291
610
|
};
|
292
611
|
type MigrationStatus$1 = 'completed' | 'pending' | 'failed';
|
612
|
+
type BranchSchema = {
|
613
|
+
name: string;
|
614
|
+
tables: {
|
615
|
+
[key: string]: {
|
616
|
+
oid: string;
|
617
|
+
name: string;
|
618
|
+
xataCompatible: boolean;
|
619
|
+
comment: string;
|
620
|
+
columns: {
|
621
|
+
[key: string]: {
|
622
|
+
name: string;
|
623
|
+
type: string;
|
624
|
+
['default']: string | null;
|
625
|
+
nullable: boolean;
|
626
|
+
unique: boolean;
|
627
|
+
comment: string;
|
628
|
+
};
|
629
|
+
};
|
630
|
+
indexes: {
|
631
|
+
[key: string]: {
|
632
|
+
name: string;
|
633
|
+
unique: boolean;
|
634
|
+
columns: string[];
|
635
|
+
};
|
636
|
+
};
|
637
|
+
primaryKey: string[];
|
638
|
+
foreignKeys: {
|
639
|
+
[key: string]: {
|
640
|
+
name: string;
|
641
|
+
columns: string[];
|
642
|
+
referencedTable: string;
|
643
|
+
referencedColumns: string[];
|
644
|
+
};
|
645
|
+
};
|
646
|
+
checkConstraints: {
|
647
|
+
[key: string]: {
|
648
|
+
name: string;
|
649
|
+
columns: string[];
|
650
|
+
definition: string;
|
651
|
+
};
|
652
|
+
};
|
653
|
+
uniqueConstraints: {
|
654
|
+
[key: string]: {
|
655
|
+
name: string;
|
656
|
+
columns: string[];
|
657
|
+
};
|
658
|
+
};
|
659
|
+
};
|
660
|
+
};
|
661
|
+
};
|
293
662
|
type BranchWithCopyID = {
|
294
663
|
branchName: BranchName$1;
|
295
664
|
dbBranchID: string;
|
@@ -942,6 +1311,40 @@ type RecordMeta = {
|
|
942
1311
|
*/
|
943
1312
|
warnings?: string[];
|
944
1313
|
};
|
1314
|
+
} | {
|
1315
|
+
xata_id: RecordID;
|
1316
|
+
/**
|
1317
|
+
* The record's version. Can be used for optimistic concurrency control.
|
1318
|
+
*/
|
1319
|
+
xata_version: number;
|
1320
|
+
/**
|
1321
|
+
* The time when the record was created.
|
1322
|
+
*/
|
1323
|
+
xata_createdat?: string;
|
1324
|
+
/**
|
1325
|
+
* The time when the record was last updated.
|
1326
|
+
*/
|
1327
|
+
xata_updatedat?: string;
|
1328
|
+
/**
|
1329
|
+
* The record's table name. APIs that return records from multiple tables will set this field accordingly.
|
1330
|
+
*/
|
1331
|
+
xata_table?: string;
|
1332
|
+
/**
|
1333
|
+
* Highlights of the record. This is used by the search APIs to indicate which fields and parts of the fields have matched the search.
|
1334
|
+
*/
|
1335
|
+
xata_highlight?: {
|
1336
|
+
[key: string]: string[] | {
|
1337
|
+
[key: string]: any;
|
1338
|
+
};
|
1339
|
+
};
|
1340
|
+
/**
|
1341
|
+
* The record's relevancy score. This is returned by the search APIs.
|
1342
|
+
*/
|
1343
|
+
xata_score?: number;
|
1344
|
+
/**
|
1345
|
+
* Encoding/Decoding errors
|
1346
|
+
*/
|
1347
|
+
xata_warnings?: string[];
|
945
1348
|
};
|
946
1349
|
/**
|
947
1350
|
* File metadata
|
@@ -951,13 +1354,43 @@ type FileResponse = {
|
|
951
1354
|
name: FileName;
|
952
1355
|
mediaType: MediaType;
|
953
1356
|
/**
|
954
|
-
*
|
1357
|
+
* Enable public access to the file
|
1358
|
+
*/
|
1359
|
+
enablePublicUrl: boolean;
|
1360
|
+
/**
|
1361
|
+
* Time to live for signed URLs
|
1362
|
+
*/
|
1363
|
+
signedUrlTimeout: number;
|
1364
|
+
/**
|
1365
|
+
* Time to live for signed URLs
|
1366
|
+
*/
|
1367
|
+
uploadUrlTimeout: number;
|
1368
|
+
/**
|
1369
|
+
* @format int64
|
955
1370
|
*/
|
956
1371
|
size: number;
|
957
1372
|
/**
|
958
1373
|
* @format int64
|
959
1374
|
*/
|
960
1375
|
version: number;
|
1376
|
+
/**
|
1377
|
+
* File access URL
|
1378
|
+
*
|
1379
|
+
* @format uri
|
1380
|
+
*/
|
1381
|
+
url: string;
|
1382
|
+
/**
|
1383
|
+
* Signed file access URL
|
1384
|
+
*
|
1385
|
+
* @format uri
|
1386
|
+
*/
|
1387
|
+
signedUrl: string;
|
1388
|
+
/**
|
1389
|
+
* Upload file URL
|
1390
|
+
*
|
1391
|
+
* @format uri
|
1392
|
+
*/
|
1393
|
+
uploadUrl: string;
|
961
1394
|
attributes?: Record<string, any>;
|
962
1395
|
};
|
963
1396
|
type QueryColumnsProjection = (string | ProjectionConfig)[];
|
@@ -1405,6 +1838,57 @@ type FileSignature = string;
|
|
1405
1838
|
type SQLRecord = {
|
1406
1839
|
[key: string]: any;
|
1407
1840
|
};
|
1841
|
+
/**
|
1842
|
+
* @default strong
|
1843
|
+
*/
|
1844
|
+
type SQLConsistency = 'strong' | 'eventual';
|
1845
|
+
/**
|
1846
|
+
* @default json
|
1847
|
+
*/
|
1848
|
+
type SQLResponseType$1 = 'json' | 'array';
|
1849
|
+
type PreparedStatement = {
|
1850
|
+
/**
|
1851
|
+
* The SQL statement.
|
1852
|
+
*
|
1853
|
+
* @minLength 1
|
1854
|
+
*/
|
1855
|
+
statement: string;
|
1856
|
+
/**
|
1857
|
+
* The query parameter list.
|
1858
|
+
*
|
1859
|
+
* @x-go-type []any
|
1860
|
+
*/
|
1861
|
+
params?: any[] | null;
|
1862
|
+
};
|
1863
|
+
type SQLResponseBase = {
|
1864
|
+
/**
|
1865
|
+
* Name of the column and its PostgreSQL type
|
1866
|
+
*
|
1867
|
+
* @x-go-type []sqlproxy.ColumnMeta
|
1868
|
+
*/
|
1869
|
+
columns: {
|
1870
|
+
name: string;
|
1871
|
+
type: string;
|
1872
|
+
}[];
|
1873
|
+
/**
|
1874
|
+
* Number of selected columns
|
1875
|
+
*/
|
1876
|
+
total: number;
|
1877
|
+
warning?: string;
|
1878
|
+
};
|
1879
|
+
type SQLResponseJSON = SQLResponseBase & {
|
1880
|
+
/**
|
1881
|
+
* @x-go-type []xata.Record
|
1882
|
+
*/
|
1883
|
+
records: SQLRecord[];
|
1884
|
+
};
|
1885
|
+
type SQLResponseArray = SQLResponseBase & {
|
1886
|
+
/**
|
1887
|
+
* @x-go-type []xata.Row
|
1888
|
+
*/
|
1889
|
+
rows: any[][];
|
1890
|
+
};
|
1891
|
+
type SQLResponse$1 = SQLResponseJSON | SQLResponseArray;
|
1408
1892
|
/**
|
1409
1893
|
* Xata Table Record Metadata
|
1410
1894
|
*/
|
@@ -1461,6 +1945,11 @@ type RecordUpdateResponse = XataRecord$1 | {
|
|
1461
1945
|
createdAt: string;
|
1462
1946
|
updatedAt: string;
|
1463
1947
|
};
|
1948
|
+
} | {
|
1949
|
+
xata_id: string;
|
1950
|
+
xata_version: number;
|
1951
|
+
xata_createdat: string;
|
1952
|
+
xata_updatedat: string;
|
1464
1953
|
};
|
1465
1954
|
type PutFileResponse = FileResponse;
|
1466
1955
|
type RecordResponse = XataRecord$1;
|
@@ -1502,17 +1991,9 @@ type AggResponse = {
|
|
1502
1991
|
[key: string]: AggResponse$1;
|
1503
1992
|
};
|
1504
1993
|
};
|
1505
|
-
type SQLResponse =
|
1506
|
-
|
1507
|
-
|
1508
|
-
* Name of the column and its PostgreSQL type
|
1509
|
-
*/
|
1510
|
-
columns?: Record<string, any>;
|
1511
|
-
/**
|
1512
|
-
* Number of selected columns
|
1513
|
-
*/
|
1514
|
-
total?: number;
|
1515
|
-
warning?: string;
|
1994
|
+
type SQLResponse = SQLResponse$1;
|
1995
|
+
type SQLBatchResponse = {
|
1996
|
+
results: SQLResponse$1[];
|
1516
1997
|
};
|
1517
1998
|
|
1518
1999
|
/**
|
@@ -1608,6 +2089,9 @@ type Workspace = WorkspaceMeta & {
|
|
1608
2089
|
memberCount: number;
|
1609
2090
|
plan: WorkspacePlan;
|
1610
2091
|
};
|
2092
|
+
type WorkspaceSettings = {
|
2093
|
+
dedicatedClusters: boolean;
|
2094
|
+
};
|
1611
2095
|
type WorkspaceMember = {
|
1612
2096
|
userId: UserID;
|
1613
2097
|
fullname: string;
|
@@ -1674,6 +2158,8 @@ type ClusterShortMetadata = {
|
|
1674
2158
|
* @format int64
|
1675
2159
|
*/
|
1676
2160
|
branches: number;
|
2161
|
+
createdAt: DateTime;
|
2162
|
+
terminatedAt?: DateTime;
|
1677
2163
|
};
|
1678
2164
|
/**
|
1679
2165
|
* @x-internal true
|
@@ -1771,6 +2257,13 @@ type ClusterConfiguration = {
|
|
1771
2257
|
* @format int64
|
1772
2258
|
*/
|
1773
2259
|
replicas?: number;
|
2260
|
+
/**
|
2261
|
+
* @format int64
|
2262
|
+
* @default 1
|
2263
|
+
* @maximum 3
|
2264
|
+
* @minimum 1
|
2265
|
+
*/
|
2266
|
+
instanceCount?: number;
|
1774
2267
|
/**
|
1775
2268
|
* @default false
|
1776
2269
|
*/
|
@@ -1789,7 +2282,7 @@ type ClusterCreateDetails = {
|
|
1789
2282
|
/**
|
1790
2283
|
* @maxLength 63
|
1791
2284
|
* @minLength 1
|
1792
|
-
* @pattern [a-
|
2285
|
+
* @pattern [a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*
|
1793
2286
|
*/
|
1794
2287
|
name: string;
|
1795
2288
|
configuration: ClusterConfiguration;
|
@@ -1801,6 +2294,57 @@ type ClusterResponse = {
|
|
1801
2294
|
state: string;
|
1802
2295
|
clusterID: string;
|
1803
2296
|
};
|
2297
|
+
/**
|
2298
|
+
* @x-internal true
|
2299
|
+
*/
|
2300
|
+
type AutoscalingConfigResponse = {
|
2301
|
+
/**
|
2302
|
+
* @format double
|
2303
|
+
* @default 0.5
|
2304
|
+
*/
|
2305
|
+
minCapacity: number;
|
2306
|
+
/**
|
2307
|
+
* @format double
|
2308
|
+
* @default 4
|
2309
|
+
*/
|
2310
|
+
maxCapacity: number;
|
2311
|
+
};
|
2312
|
+
/**
|
2313
|
+
* @x-internal true
|
2314
|
+
*/
|
2315
|
+
type MaintenanceConfigResponse = {
|
2316
|
+
/**
|
2317
|
+
* @default false
|
2318
|
+
*/
|
2319
|
+
autoMinorVersionUpgrade: boolean;
|
2320
|
+
/**
|
2321
|
+
* @default false
|
2322
|
+
*/
|
2323
|
+
applyImmediately: boolean;
|
2324
|
+
maintenanceWindow: WeeklyTimeWindow;
|
2325
|
+
backupWindow: DailyTimeWindow;
|
2326
|
+
};
|
2327
|
+
/**
|
2328
|
+
* @x-internal true
|
2329
|
+
*/
|
2330
|
+
type ClusterConfigurationResponse = {
|
2331
|
+
engineVersion: string;
|
2332
|
+
instanceType: string;
|
2333
|
+
/**
|
2334
|
+
* @format int64
|
2335
|
+
*/
|
2336
|
+
replicas: number;
|
2337
|
+
/**
|
2338
|
+
* @format int64
|
2339
|
+
*/
|
2340
|
+
instanceCount: number;
|
2341
|
+
/**
|
2342
|
+
* @default false
|
2343
|
+
*/
|
2344
|
+
deletionProtection: boolean;
|
2345
|
+
autoscaling?: AutoscalingConfigResponse;
|
2346
|
+
maintenance: MaintenanceConfigResponse;
|
2347
|
+
};
|
1804
2348
|
/**
|
1805
2349
|
* @x-internal true
|
1806
2350
|
*/
|
@@ -1813,22 +2357,36 @@ type ClusterMetadata = {
|
|
1813
2357
|
* @format int64
|
1814
2358
|
*/
|
1815
2359
|
branches: number;
|
1816
|
-
configuration
|
2360
|
+
configuration: ClusterConfigurationResponse;
|
1817
2361
|
};
|
1818
2362
|
/**
|
1819
2363
|
* @x-internal true
|
1820
2364
|
*/
|
1821
|
-
type
|
2365
|
+
type ClusterDeleteMetadata = {
|
1822
2366
|
id: ClusterID;
|
2367
|
+
state: string;
|
2368
|
+
region: string;
|
2369
|
+
name: string;
|
1823
2370
|
/**
|
1824
|
-
* @
|
1825
|
-
* @minLength 1
|
1826
|
-
* @pattern [a-zA-Z0-9_-~:]+
|
2371
|
+
* @format int64
|
1827
2372
|
*/
|
1828
|
-
|
1829
|
-
|
1830
|
-
|
1831
|
-
|
2373
|
+
branches: number;
|
2374
|
+
};
|
2375
|
+
/**
|
2376
|
+
* @x-internal true
|
2377
|
+
*/
|
2378
|
+
type ClusterUpdateDetails = {
|
2379
|
+
/**
|
2380
|
+
* @pattern ^[Ss][Tt][Oo][Pp]|[Ss][Tt][Aa][Rr][Tt]$
|
2381
|
+
*/
|
2382
|
+
command: string;
|
2383
|
+
};
|
2384
|
+
/**
|
2385
|
+
* @x-internal true
|
2386
|
+
*/
|
2387
|
+
type ClusterUpdateMetadata = {
|
2388
|
+
id: ClusterID;
|
2389
|
+
state: string;
|
1832
2390
|
};
|
1833
2391
|
/**
|
1834
2392
|
* Metadata of databases
|
@@ -1851,9 +2409,13 @@ type DatabaseMetadata = {
|
|
1851
2409
|
*/
|
1852
2410
|
newMigrations?: boolean;
|
1853
2411
|
/**
|
1854
|
-
*
|
2412
|
+
* The default cluster ID where branches from this database reside. Value of 'shared-cluster' for branches in shared clusters.
|
1855
2413
|
*/
|
1856
2414
|
defaultClusterID?: string;
|
2415
|
+
/**
|
2416
|
+
* The database is accessible via the Postgres protocol
|
2417
|
+
*/
|
2418
|
+
postgresEnabled?: boolean;
|
1857
2419
|
/**
|
1858
2420
|
* Metadata about the database for display in Xata user interfaces
|
1859
2421
|
*/
|
@@ -2287,6 +2849,7 @@ type GetWorkspacesListError = ErrorWrapper$1<{
|
|
2287
2849
|
type GetWorkspacesListResponse = {
|
2288
2850
|
workspaces: {
|
2289
2851
|
id: WorkspaceID;
|
2852
|
+
unique_id: string;
|
2290
2853
|
name: string;
|
2291
2854
|
slug: string;
|
2292
2855
|
role: Role;
|
@@ -2394,6 +2957,59 @@ type DeleteWorkspaceVariables = {
|
|
2394
2957
|
* Delete the workspace with the provided ID
|
2395
2958
|
*/
|
2396
2959
|
declare const deleteWorkspace: (variables: DeleteWorkspaceVariables, signal?: AbortSignal) => Promise<undefined>;
|
2960
|
+
type GetWorkspaceSettingsPathParams = {
|
2961
|
+
/**
|
2962
|
+
* Workspace ID
|
2963
|
+
*/
|
2964
|
+
workspaceId: WorkspaceID;
|
2965
|
+
};
|
2966
|
+
type GetWorkspaceSettingsError = ErrorWrapper$1<{
|
2967
|
+
status: 400;
|
2968
|
+
payload: BadRequestError;
|
2969
|
+
} | {
|
2970
|
+
status: 401;
|
2971
|
+
payload: AuthError;
|
2972
|
+
} | {
|
2973
|
+
status: 403;
|
2974
|
+
payload: AuthError;
|
2975
|
+
} | {
|
2976
|
+
status: 404;
|
2977
|
+
payload: SimpleError;
|
2978
|
+
}>;
|
2979
|
+
type GetWorkspaceSettingsVariables = {
|
2980
|
+
pathParams: GetWorkspaceSettingsPathParams;
|
2981
|
+
} & ControlPlaneFetcherExtraProps;
|
2982
|
+
/**
|
2983
|
+
* Retrieve workspace settings from a workspace ID
|
2984
|
+
*/
|
2985
|
+
declare const getWorkspaceSettings: (variables: GetWorkspaceSettingsVariables, signal?: AbortSignal) => Promise<WorkspaceSettings>;
|
2986
|
+
type UpdateWorkspaceSettingsPathParams = {
|
2987
|
+
/**
|
2988
|
+
* Workspace ID
|
2989
|
+
*/
|
2990
|
+
workspaceId: WorkspaceID;
|
2991
|
+
};
|
2992
|
+
type UpdateWorkspaceSettingsError = ErrorWrapper$1<{
|
2993
|
+
status: 400;
|
2994
|
+
payload: BadRequestError;
|
2995
|
+
} | {
|
2996
|
+
status: 401;
|
2997
|
+
payload: AuthError;
|
2998
|
+
} | {
|
2999
|
+
status: 403;
|
3000
|
+
payload: AuthError;
|
3001
|
+
} | {
|
3002
|
+
status: 404;
|
3003
|
+
payload: SimpleError;
|
3004
|
+
}>;
|
3005
|
+
type UpdateWorkspaceSettingsVariables = {
|
3006
|
+
body?: Record<string, any>;
|
3007
|
+
pathParams: UpdateWorkspaceSettingsPathParams;
|
3008
|
+
} & ControlPlaneFetcherExtraProps;
|
3009
|
+
/**
|
3010
|
+
* Update workspace settings
|
3011
|
+
*/
|
3012
|
+
declare const updateWorkspaceSettings: (variables: UpdateWorkspaceSettingsVariables, signal?: AbortSignal) => Promise<WorkspaceSettings>;
|
2397
3013
|
type GetWorkspaceMembersListPathParams = {
|
2398
3014
|
/**
|
2399
3015
|
* Workspace ID
|
@@ -2751,7 +3367,31 @@ type UpdateClusterVariables = {
|
|
2751
3367
|
/**
|
2752
3368
|
* Update cluster for given cluster ID
|
2753
3369
|
*/
|
2754
|
-
declare const updateCluster: (variables: UpdateClusterVariables, signal?: AbortSignal) => Promise<
|
3370
|
+
declare const updateCluster: (variables: UpdateClusterVariables, signal?: AbortSignal) => Promise<ClusterUpdateMetadata>;
|
3371
|
+
type DeleteClusterPathParams = {
|
3372
|
+
/**
|
3373
|
+
* Workspace ID
|
3374
|
+
*/
|
3375
|
+
workspaceId: WorkspaceID;
|
3376
|
+
/**
|
3377
|
+
* Cluster ID
|
3378
|
+
*/
|
3379
|
+
clusterId: ClusterID;
|
3380
|
+
};
|
3381
|
+
type DeleteClusterError = ErrorWrapper$1<{
|
3382
|
+
status: 400;
|
3383
|
+
payload: BadRequestError;
|
3384
|
+
} | {
|
3385
|
+
status: 401;
|
3386
|
+
payload: AuthError;
|
3387
|
+
}>;
|
3388
|
+
type DeleteClusterVariables = {
|
3389
|
+
pathParams: DeleteClusterPathParams;
|
3390
|
+
} & ControlPlaneFetcherExtraProps;
|
3391
|
+
/**
|
3392
|
+
* Delete cluster with given cluster ID
|
3393
|
+
*/
|
3394
|
+
declare const deleteCluster: (variables: DeleteClusterVariables, signal?: AbortSignal) => Promise<ClusterDeleteMetadata>;
|
2755
3395
|
type GetDatabaseListPathParams = {
|
2756
3396
|
/**
|
2757
3397
|
* Workspace ID
|
@@ -3099,16 +3739,380 @@ type ErrorWrapper<TError> = TError | {
|
|
3099
3739
|
*
|
3100
3740
|
* @version 1.0
|
3101
3741
|
*/
|
3102
|
-
|
3103
|
-
type
|
3742
|
+
|
3743
|
+
type GetTasksPathParams = {
|
3744
|
+
workspace: string;
|
3745
|
+
region: string;
|
3746
|
+
};
|
3747
|
+
type GetTasksError = ErrorWrapper<{
|
3748
|
+
status: 400;
|
3749
|
+
payload: BadRequestError$1;
|
3750
|
+
} | {
|
3751
|
+
status: 401;
|
3752
|
+
payload: AuthError$1;
|
3753
|
+
} | {
|
3754
|
+
status: 404;
|
3755
|
+
payload: SimpleError$1;
|
3756
|
+
}>;
|
3757
|
+
type GetTasksResponse = TaskStatusResponse[];
|
3758
|
+
type GetTasksVariables = {
|
3759
|
+
pathParams: GetTasksPathParams;
|
3760
|
+
} & DataPlaneFetcherExtraProps;
|
3761
|
+
declare const getTasks: (variables: GetTasksVariables, signal?: AbortSignal) => Promise<GetTasksResponse>;
|
3762
|
+
type GetTaskStatusPathParams = {
|
3763
|
+
/**
|
3764
|
+
* The id of the branch creation task
|
3765
|
+
*/
|
3766
|
+
taskId: TaskID;
|
3767
|
+
workspace: string;
|
3768
|
+
region: string;
|
3769
|
+
};
|
3770
|
+
type GetTaskStatusError = ErrorWrapper<{
|
3771
|
+
status: 400;
|
3772
|
+
payload: BadRequestError$1;
|
3773
|
+
} | {
|
3774
|
+
status: 401;
|
3775
|
+
payload: AuthError$1;
|
3776
|
+
} | {
|
3777
|
+
status: 404;
|
3778
|
+
payload: SimpleError$1;
|
3779
|
+
}>;
|
3780
|
+
type GetTaskStatusVariables = {
|
3781
|
+
pathParams: GetTaskStatusPathParams;
|
3782
|
+
} & DataPlaneFetcherExtraProps;
|
3783
|
+
declare const getTaskStatus: (variables: GetTaskStatusVariables, signal?: AbortSignal) => Promise<TaskStatusResponse>;
|
3784
|
+
type ListClusterBranchesPathParams = {
|
3785
|
+
/**
|
3786
|
+
* Cluster ID
|
3787
|
+
*/
|
3788
|
+
clusterId: ClusterID$1;
|
3789
|
+
workspace: string;
|
3790
|
+
region: string;
|
3791
|
+
};
|
3792
|
+
type ListClusterBranchesQueryParams = {
|
3793
|
+
/**
|
3794
|
+
* Page size
|
3795
|
+
*/
|
3796
|
+
page?: PageSize$1;
|
3797
|
+
/**
|
3798
|
+
* Page token
|
3799
|
+
*/
|
3800
|
+
token?: PageToken$1;
|
3801
|
+
};
|
3802
|
+
type ListClusterBranchesError = ErrorWrapper<{
|
3803
|
+
status: 400;
|
3804
|
+
payload: BadRequestError$1;
|
3805
|
+
} | {
|
3806
|
+
status: 401;
|
3807
|
+
payload: AuthError$1;
|
3808
|
+
}>;
|
3809
|
+
type ListClusterBranchesVariables = {
|
3810
|
+
pathParams: ListClusterBranchesPathParams;
|
3811
|
+
queryParams?: ListClusterBranchesQueryParams;
|
3812
|
+
} & DataPlaneFetcherExtraProps;
|
3813
|
+
/**
|
3814
|
+
* Retrieve branches for given cluster ID
|
3815
|
+
*/
|
3816
|
+
declare const listClusterBranches: (variables: ListClusterBranchesVariables, signal?: AbortSignal) => Promise<ListClusterBranchesResponse>;
|
3817
|
+
type ListClusterExtensionsPathParams = {
|
3818
|
+
/**
|
3819
|
+
* Cluster ID
|
3820
|
+
*/
|
3821
|
+
clusterId: ClusterID$1;
|
3822
|
+
workspace: string;
|
3823
|
+
region: string;
|
3824
|
+
};
|
3825
|
+
type ListClusterExtensionsQueryParams = {
|
3826
|
+
extensionType: 'available' | 'installed';
|
3827
|
+
};
|
3828
|
+
type ListClusterExtensionsError = ErrorWrapper<{
|
3829
|
+
status: 400;
|
3830
|
+
payload: BadRequestError$1;
|
3831
|
+
} | {
|
3832
|
+
status: 401;
|
3833
|
+
payload: AuthError$1;
|
3834
|
+
}>;
|
3835
|
+
type ListClusterExtensionsVariables = {
|
3836
|
+
pathParams: ListClusterExtensionsPathParams;
|
3837
|
+
queryParams: ListClusterExtensionsQueryParams;
|
3838
|
+
} & DataPlaneFetcherExtraProps;
|
3839
|
+
/**
|
3840
|
+
* Retrieve extensions for given cluster ID
|
3841
|
+
*/
|
3842
|
+
declare const listClusterExtensions: (variables: ListClusterExtensionsVariables, signal?: AbortSignal) => Promise<ListClusterExtensionsResponse>;
|
3843
|
+
type InstallClusterExtensionPathParams = {
|
3844
|
+
/**
|
3845
|
+
* Cluster ID
|
3846
|
+
*/
|
3847
|
+
clusterId: ClusterID$1;
|
3848
|
+
workspace: string;
|
3849
|
+
region: string;
|
3850
|
+
};
|
3851
|
+
type InstallClusterExtensionError = ErrorWrapper<{
|
3852
|
+
status: 400;
|
3853
|
+
payload: BadRequestError$1;
|
3854
|
+
} | {
|
3855
|
+
status: 401;
|
3856
|
+
payload: AuthError$1;
|
3857
|
+
}>;
|
3858
|
+
type InstallClusterExtensionRequestBody = {
|
3859
|
+
/**
|
3860
|
+
* Extension name
|
3861
|
+
*/
|
3862
|
+
extension: string;
|
3863
|
+
/**
|
3864
|
+
* Schema name
|
3865
|
+
*/
|
3866
|
+
schema?: string;
|
3867
|
+
/**
|
3868
|
+
* install with cascade option
|
3869
|
+
*/
|
3870
|
+
cascade?: boolean;
|
3871
|
+
};
|
3872
|
+
type InstallClusterExtensionVariables = {
|
3873
|
+
body: InstallClusterExtensionRequestBody;
|
3874
|
+
pathParams: InstallClusterExtensionPathParams;
|
3875
|
+
} & DataPlaneFetcherExtraProps;
|
3876
|
+
/**
|
3877
|
+
* Install an extension for given cluster ID
|
3878
|
+
*/
|
3879
|
+
declare const installClusterExtension: (variables: InstallClusterExtensionVariables, signal?: AbortSignal) => Promise<ClusterExtensionInstallationResponse>;
|
3880
|
+
type DropClusterExtensionPathParams = {
|
3881
|
+
/**
|
3882
|
+
* Cluster ID
|
3883
|
+
*/
|
3884
|
+
clusterId: ClusterID$1;
|
3885
|
+
workspace: string;
|
3886
|
+
region: string;
|
3887
|
+
};
|
3888
|
+
type DropClusterExtensionError = ErrorWrapper<{
|
3889
|
+
status: 400;
|
3890
|
+
payload: BadRequestError$1;
|
3891
|
+
} | {
|
3892
|
+
status: 401;
|
3893
|
+
payload: AuthError$1;
|
3894
|
+
}>;
|
3895
|
+
type DropClusterExtensionRequestBody = {
|
3896
|
+
/**
|
3897
|
+
* Extension name
|
3898
|
+
*/
|
3899
|
+
extension: string;
|
3900
|
+
/**
|
3901
|
+
* drop with cascade option, true by default
|
3902
|
+
*/
|
3903
|
+
cascade?: boolean;
|
3904
|
+
};
|
3905
|
+
type DropClusterExtensionVariables = {
|
3906
|
+
body: DropClusterExtensionRequestBody;
|
3907
|
+
pathParams: DropClusterExtensionPathParams;
|
3908
|
+
} & DataPlaneFetcherExtraProps;
|
3909
|
+
/**
|
3910
|
+
* Drop an extension for given cluster ID
|
3911
|
+
*/
|
3912
|
+
declare const dropClusterExtension: (variables: DropClusterExtensionVariables, signal?: AbortSignal) => Promise<undefined>;
|
3913
|
+
type GetClusterMetricsPathParams = {
|
3914
|
+
/**
|
3915
|
+
* Cluster ID
|
3916
|
+
*/
|
3917
|
+
clusterId: ClusterID$1;
|
3918
|
+
workspace: string;
|
3919
|
+
region: string;
|
3920
|
+
};
|
3921
|
+
type GetClusterMetricsQueryParams = {
|
3922
|
+
startTime: string;
|
3923
|
+
endTime: string;
|
3924
|
+
period: '5min' | '15min' | '1hour';
|
3925
|
+
/**
|
3926
|
+
* Page size
|
3927
|
+
*/
|
3928
|
+
page?: PageSize$1;
|
3929
|
+
/**
|
3930
|
+
* Page token
|
3931
|
+
*/
|
3932
|
+
token?: PageToken$1;
|
3933
|
+
};
|
3934
|
+
type GetClusterMetricsError = ErrorWrapper<{
|
3935
|
+
status: 400;
|
3936
|
+
payload: BadRequestError$1;
|
3937
|
+
} | {
|
3938
|
+
status: 401;
|
3939
|
+
payload: AuthError$1;
|
3940
|
+
} | {
|
3941
|
+
status: 404;
|
3942
|
+
payload: SimpleError$1;
|
3943
|
+
}>;
|
3944
|
+
type GetClusterMetricsVariables = {
|
3945
|
+
pathParams: GetClusterMetricsPathParams;
|
3946
|
+
queryParams: GetClusterMetricsQueryParams;
|
3947
|
+
} & DataPlaneFetcherExtraProps;
|
3948
|
+
/**
|
3949
|
+
* retrieve a standard set of RDS cluster metrics
|
3950
|
+
*/
|
3951
|
+
declare const getClusterMetrics: (variables: GetClusterMetricsVariables, signal?: AbortSignal) => Promise<MetricsResponse>;
|
3952
|
+
type ApplyMigrationPathParams = {
|
3953
|
+
/**
|
3954
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3955
|
+
*/
|
3956
|
+
dbBranchName: DBBranchName;
|
3957
|
+
workspace: string;
|
3958
|
+
region: string;
|
3959
|
+
};
|
3960
|
+
type ApplyMigrationError = ErrorWrapper<{
|
3961
|
+
status: 400;
|
3962
|
+
payload: BadRequestError$1;
|
3963
|
+
} | {
|
3964
|
+
status: 401;
|
3965
|
+
payload: AuthError$1;
|
3966
|
+
} | {
|
3967
|
+
status: 404;
|
3968
|
+
payload: SimpleError$1;
|
3969
|
+
}>;
|
3970
|
+
type ApplyMigrationRequestBody = {
|
3971
|
+
/**
|
3972
|
+
* Migration name
|
3973
|
+
*/
|
3974
|
+
name?: string;
|
3975
|
+
operations: {
|
3976
|
+
[key: string]: any;
|
3977
|
+
}[];
|
3978
|
+
/**
|
3979
|
+
* The schema in which the migration should be applied
|
3980
|
+
*
|
3981
|
+
* @default public
|
3982
|
+
*/
|
3983
|
+
schema?: string;
|
3984
|
+
adaptTables?: boolean;
|
3985
|
+
};
|
3986
|
+
type ApplyMigrationVariables = {
|
3987
|
+
body: ApplyMigrationRequestBody;
|
3988
|
+
pathParams: ApplyMigrationPathParams;
|
3989
|
+
} & DataPlaneFetcherExtraProps;
|
3990
|
+
/**
|
3991
|
+
* Applies a pgroll migration to the specified database.
|
3992
|
+
*/
|
3993
|
+
declare const applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
|
3994
|
+
type StartMigrationPathParams = {
|
3995
|
+
/**
|
3996
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3997
|
+
*/
|
3998
|
+
dbBranchName: DBBranchName;
|
3999
|
+
workspace: string;
|
4000
|
+
region: string;
|
4001
|
+
};
|
4002
|
+
type StartMigrationError = ErrorWrapper<{
|
4003
|
+
status: 400;
|
4004
|
+
payload: BadRequestError$1;
|
4005
|
+
} | {
|
4006
|
+
status: 401;
|
4007
|
+
payload: AuthError$1;
|
4008
|
+
} | {
|
4009
|
+
status: 404;
|
4010
|
+
payload: SimpleError$1;
|
4011
|
+
}>;
|
4012
|
+
type StartMigrationRequestBody = {
|
4013
|
+
/**
|
4014
|
+
* Migration name
|
4015
|
+
*/
|
4016
|
+
name?: string;
|
4017
|
+
operations: {
|
4018
|
+
[key: string]: any;
|
4019
|
+
}[];
|
4020
|
+
/**
|
4021
|
+
* The schema in which the migration should be started
|
4022
|
+
*
|
4023
|
+
* @default public
|
4024
|
+
*/
|
4025
|
+
schema?: string;
|
4026
|
+
};
|
4027
|
+
type StartMigrationVariables = {
|
4028
|
+
body: StartMigrationRequestBody;
|
4029
|
+
pathParams: StartMigrationPathParams;
|
4030
|
+
} & DataPlaneFetcherExtraProps;
|
4031
|
+
/**
|
4032
|
+
* Starts a pgroll migration on the specified database.
|
4033
|
+
*/
|
4034
|
+
declare const startMigration: (variables: StartMigrationVariables, signal?: AbortSignal) => Promise<StartMigrationResponse>;
|
4035
|
+
type CompleteMigrationPathParams = {
|
4036
|
+
/**
|
4037
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4038
|
+
*/
|
4039
|
+
dbBranchName: DBBranchName;
|
4040
|
+
workspace: string;
|
4041
|
+
region: string;
|
4042
|
+
};
|
4043
|
+
type CompleteMigrationError = ErrorWrapper<{
|
4044
|
+
status: 400;
|
4045
|
+
payload: BadRequestError$1;
|
4046
|
+
} | {
|
4047
|
+
status: 401;
|
4048
|
+
payload: AuthError$1;
|
4049
|
+
} | {
|
4050
|
+
status: 404;
|
4051
|
+
payload: SimpleError$1;
|
4052
|
+
}>;
|
4053
|
+
type CompleteMigrationRequestBody = {
|
4054
|
+
/**
|
4055
|
+
* The schema in which the migration should be completed
|
4056
|
+
*
|
4057
|
+
* @default public
|
4058
|
+
*/
|
4059
|
+
schema?: string;
|
4060
|
+
};
|
4061
|
+
type CompleteMigrationVariables = {
|
4062
|
+
body?: CompleteMigrationRequestBody;
|
4063
|
+
pathParams: CompleteMigrationPathParams;
|
4064
|
+
} & DataPlaneFetcherExtraProps;
|
4065
|
+
/**
|
4066
|
+
* Complete an active migration on the specified database
|
4067
|
+
*/
|
4068
|
+
declare const completeMigration: (variables: CompleteMigrationVariables, signal?: AbortSignal) => Promise<CompleteMigrationResponse>;
|
4069
|
+
type RollbackMigrationPathParams = {
|
4070
|
+
/**
|
4071
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4072
|
+
*/
|
4073
|
+
dbBranchName: DBBranchName;
|
4074
|
+
workspace: string;
|
4075
|
+
region: string;
|
4076
|
+
};
|
4077
|
+
type RollbackMigrationError = ErrorWrapper<{
|
4078
|
+
status: 400;
|
4079
|
+
payload: BadRequestError$1;
|
4080
|
+
} | {
|
4081
|
+
status: 401;
|
4082
|
+
payload: AuthError$1;
|
4083
|
+
} | {
|
4084
|
+
status: 404;
|
4085
|
+
payload: SimpleError$1;
|
4086
|
+
}>;
|
4087
|
+
type RollbackMigrationRequestBody = {
|
4088
|
+
/**
|
4089
|
+
* The schema in which the migration should be rolled back
|
4090
|
+
*
|
4091
|
+
* @default public
|
4092
|
+
*/
|
4093
|
+
schema?: string;
|
4094
|
+
};
|
4095
|
+
type RollbackMigrationVariables = {
|
4096
|
+
body?: RollbackMigrationRequestBody;
|
4097
|
+
pathParams: RollbackMigrationPathParams;
|
4098
|
+
} & DataPlaneFetcherExtraProps;
|
4099
|
+
/**
|
4100
|
+
* Roll back an active migration on the specified database
|
4101
|
+
*/
|
4102
|
+
declare const rollbackMigration: (variables: RollbackMigrationVariables, signal?: AbortSignal) => Promise<RollbackMigrationResponse>;
|
4103
|
+
type AdaptTablePathParams = {
|
3104
4104
|
/**
|
3105
4105
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3106
4106
|
*/
|
3107
4107
|
dbBranchName: DBBranchName;
|
4108
|
+
/**
|
4109
|
+
* The Table name
|
4110
|
+
*/
|
4111
|
+
tableName: TableName;
|
3108
4112
|
workspace: string;
|
3109
4113
|
region: string;
|
3110
4114
|
};
|
3111
|
-
type
|
4115
|
+
type AdaptTableError = ErrorWrapper<{
|
3112
4116
|
status: 400;
|
3113
4117
|
payload: BadRequestError$1;
|
3114
4118
|
} | {
|
@@ -3118,24 +4122,61 @@ type ApplyMigrationError = ErrorWrapper<{
|
|
3118
4122
|
status: 404;
|
3119
4123
|
payload: SimpleError$1;
|
3120
4124
|
}>;
|
3121
|
-
type
|
4125
|
+
type AdaptTableVariables = {
|
4126
|
+
pathParams: AdaptTablePathParams;
|
4127
|
+
} & DataPlaneFetcherExtraProps;
|
4128
|
+
/**
|
4129
|
+
* 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.
|
4130
|
+
*/
|
4131
|
+
declare const adaptTable: (variables: AdaptTableVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
|
4132
|
+
type AdaptAllTablesPathParams = {
|
3122
4133
|
/**
|
3123
|
-
*
|
4134
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3124
4135
|
*/
|
3125
|
-
|
3126
|
-
|
3127
|
-
|
3128
|
-
}[];
|
4136
|
+
dbBranchName: DBBranchName;
|
4137
|
+
workspace: string;
|
4138
|
+
region: string;
|
3129
4139
|
};
|
3130
|
-
type
|
3131
|
-
|
3132
|
-
|
4140
|
+
type AdaptAllTablesError = ErrorWrapper<{
|
4141
|
+
status: 400;
|
4142
|
+
payload: BadRequestError$1;
|
4143
|
+
} | {
|
4144
|
+
status: 401;
|
4145
|
+
payload: AuthError$1;
|
4146
|
+
} | {
|
4147
|
+
status: 404;
|
4148
|
+
payload: SimpleError$1;
|
4149
|
+
}>;
|
4150
|
+
type AdaptAllTablesVariables = {
|
4151
|
+
pathParams: AdaptAllTablesPathParams;
|
3133
4152
|
} & DataPlaneFetcherExtraProps;
|
3134
4153
|
/**
|
3135
|
-
*
|
4154
|
+
* 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.
|
3136
4155
|
*/
|
3137
|
-
declare const
|
3138
|
-
type
|
4156
|
+
declare const adaptAllTables: (variables: AdaptAllTablesVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
|
4157
|
+
type GetBranchMigrationJobStatusPathParams = {
|
4158
|
+
/**
|
4159
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4160
|
+
*/
|
4161
|
+
dbBranchName: DBBranchName;
|
4162
|
+
workspace: string;
|
4163
|
+
region: string;
|
4164
|
+
};
|
4165
|
+
type GetBranchMigrationJobStatusError = ErrorWrapper<{
|
4166
|
+
status: 400;
|
4167
|
+
payload: BadRequestError$1;
|
4168
|
+
} | {
|
4169
|
+
status: 401;
|
4170
|
+
payload: AuthError$1;
|
4171
|
+
} | {
|
4172
|
+
status: 404;
|
4173
|
+
payload: SimpleError$1;
|
4174
|
+
}>;
|
4175
|
+
type GetBranchMigrationJobStatusVariables = {
|
4176
|
+
pathParams: GetBranchMigrationJobStatusPathParams;
|
4177
|
+
} & DataPlaneFetcherExtraProps;
|
4178
|
+
declare const getBranchMigrationJobStatus: (variables: GetBranchMigrationJobStatusVariables, signal?: AbortSignal) => Promise<MigrationJobStatusResponse>;
|
4179
|
+
type GetMigrationJobsPathParams = {
|
3139
4180
|
/**
|
3140
4181
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3141
4182
|
*/
|
@@ -3143,7 +4184,17 @@ type PgRollStatusPathParams = {
|
|
3143
4184
|
workspace: string;
|
3144
4185
|
region: string;
|
3145
4186
|
};
|
3146
|
-
type
|
4187
|
+
type GetMigrationJobsQueryParams = {
|
4188
|
+
/**
|
4189
|
+
* @format date-time
|
4190
|
+
*/
|
4191
|
+
cursor?: string;
|
4192
|
+
/**
|
4193
|
+
* Page size
|
4194
|
+
*/
|
4195
|
+
limit?: PageSize$1;
|
4196
|
+
};
|
4197
|
+
type GetMigrationJobsError = ErrorWrapper<{
|
3147
4198
|
status: 400;
|
3148
4199
|
payload: BadRequestError$1;
|
3149
4200
|
} | {
|
@@ -3153,11 +4204,12 @@ type PgRollStatusError = ErrorWrapper<{
|
|
3153
4204
|
status: 404;
|
3154
4205
|
payload: SimpleError$1;
|
3155
4206
|
}>;
|
3156
|
-
type
|
3157
|
-
pathParams:
|
4207
|
+
type GetMigrationJobsVariables = {
|
4208
|
+
pathParams: GetMigrationJobsPathParams;
|
4209
|
+
queryParams?: GetMigrationJobsQueryParams;
|
3158
4210
|
} & DataPlaneFetcherExtraProps;
|
3159
|
-
declare const
|
3160
|
-
type
|
4211
|
+
declare const getMigrationJobs: (variables: GetMigrationJobsVariables, signal?: AbortSignal) => Promise<GetMigrationJobsResponse>;
|
4212
|
+
type GetMigrationJobStatusPathParams = {
|
3161
4213
|
/**
|
3162
4214
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3163
4215
|
*/
|
@@ -3165,11 +4217,11 @@ type PgRollJobStatusPathParams = {
|
|
3165
4217
|
/**
|
3166
4218
|
* The id of the migration job
|
3167
4219
|
*/
|
3168
|
-
jobId:
|
4220
|
+
jobId: MigrationJobID;
|
3169
4221
|
workspace: string;
|
3170
4222
|
region: string;
|
3171
4223
|
};
|
3172
|
-
type
|
4224
|
+
type GetMigrationJobStatusError = ErrorWrapper<{
|
3173
4225
|
status: 400;
|
3174
4226
|
payload: BadRequestError$1;
|
3175
4227
|
} | {
|
@@ -3179,11 +4231,11 @@ type PgRollJobStatusError = ErrorWrapper<{
|
|
3179
4231
|
status: 404;
|
3180
4232
|
payload: SimpleError$1;
|
3181
4233
|
}>;
|
3182
|
-
type
|
3183
|
-
pathParams:
|
4234
|
+
type GetMigrationJobStatusVariables = {
|
4235
|
+
pathParams: GetMigrationJobStatusPathParams;
|
3184
4236
|
} & DataPlaneFetcherExtraProps;
|
3185
|
-
declare const
|
3186
|
-
type
|
4237
|
+
declare const getMigrationJobStatus: (variables: GetMigrationJobStatusVariables, signal?: AbortSignal) => Promise<MigrationJobStatusResponse>;
|
4238
|
+
type GetMigrationHistoryPathParams = {
|
3187
4239
|
/**
|
3188
4240
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3189
4241
|
*/
|
@@ -3191,7 +4243,17 @@ type PgRollMigrationHistoryPathParams = {
|
|
3191
4243
|
workspace: string;
|
3192
4244
|
region: string;
|
3193
4245
|
};
|
3194
|
-
type
|
4246
|
+
type GetMigrationHistoryQueryParams = {
|
4247
|
+
/**
|
4248
|
+
* @format date-time
|
4249
|
+
*/
|
4250
|
+
cursor?: string;
|
4251
|
+
/**
|
4252
|
+
* Page size
|
4253
|
+
*/
|
4254
|
+
limit?: PageSize$1;
|
4255
|
+
};
|
4256
|
+
type GetMigrationHistoryError = ErrorWrapper<{
|
3195
4257
|
status: 400;
|
3196
4258
|
payload: BadRequestError$1;
|
3197
4259
|
} | {
|
@@ -3201,10 +4263,11 @@ type PgRollMigrationHistoryError = ErrorWrapper<{
|
|
3201
4263
|
status: 404;
|
3202
4264
|
payload: SimpleError$1;
|
3203
4265
|
}>;
|
3204
|
-
type
|
3205
|
-
pathParams:
|
4266
|
+
type GetMigrationHistoryVariables = {
|
4267
|
+
pathParams: GetMigrationHistoryPathParams;
|
4268
|
+
queryParams?: GetMigrationHistoryQueryParams;
|
3206
4269
|
} & DataPlaneFetcherExtraProps;
|
3207
|
-
declare const
|
4270
|
+
declare const getMigrationHistory: (variables: GetMigrationHistoryVariables, signal?: AbortSignal) => Promise<MigrationHistoryResponse>;
|
3208
4271
|
type GetBranchListPathParams = {
|
3209
4272
|
/**
|
3210
4273
|
* The Database Name
|
@@ -3230,6 +4293,107 @@ type GetBranchListVariables = {
|
|
3230
4293
|
* List all available Branches
|
3231
4294
|
*/
|
3232
4295
|
declare const getBranchList: (variables: GetBranchListVariables, signal?: AbortSignal) => Promise<ListBranchesResponse>;
|
4296
|
+
type GetDatabaseSettingsPathParams = {
|
4297
|
+
/**
|
4298
|
+
* The Database Name
|
4299
|
+
*/
|
4300
|
+
dbName: DBName$1;
|
4301
|
+
workspace: string;
|
4302
|
+
region: string;
|
4303
|
+
};
|
4304
|
+
type GetDatabaseSettingsError = ErrorWrapper<{
|
4305
|
+
status: 400;
|
4306
|
+
payload: SimpleError$1;
|
4307
|
+
} | {
|
4308
|
+
status: 401;
|
4309
|
+
payload: AuthError$1;
|
4310
|
+
} | {
|
4311
|
+
status: 404;
|
4312
|
+
payload: SimpleError$1;
|
4313
|
+
}>;
|
4314
|
+
type GetDatabaseSettingsVariables = {
|
4315
|
+
pathParams: GetDatabaseSettingsPathParams;
|
4316
|
+
} & DataPlaneFetcherExtraProps;
|
4317
|
+
/**
|
4318
|
+
* Get database settings
|
4319
|
+
*/
|
4320
|
+
declare const getDatabaseSettings: (variables: GetDatabaseSettingsVariables, signal?: AbortSignal) => Promise<DatabaseSettings>;
|
4321
|
+
type UpdateDatabaseSettingsPathParams = {
|
4322
|
+
/**
|
4323
|
+
* The Database Name
|
4324
|
+
*/
|
4325
|
+
dbName: DBName$1;
|
4326
|
+
workspace: string;
|
4327
|
+
region: string;
|
4328
|
+
};
|
4329
|
+
type UpdateDatabaseSettingsError = ErrorWrapper<{
|
4330
|
+
status: 400;
|
4331
|
+
payload: SimpleError$1;
|
4332
|
+
} | {
|
4333
|
+
status: 401;
|
4334
|
+
payload: AuthError$1;
|
4335
|
+
} | {
|
4336
|
+
status: 404;
|
4337
|
+
payload: SimpleError$1;
|
4338
|
+
}>;
|
4339
|
+
type UpdateDatabaseSettingsRequestBody = {
|
4340
|
+
searchEnabled?: boolean;
|
4341
|
+
};
|
4342
|
+
type UpdateDatabaseSettingsVariables = {
|
4343
|
+
body?: UpdateDatabaseSettingsRequestBody;
|
4344
|
+
pathParams: UpdateDatabaseSettingsPathParams;
|
4345
|
+
} & DataPlaneFetcherExtraProps;
|
4346
|
+
/**
|
4347
|
+
* Update database settings, this endpoint can be used to disable search
|
4348
|
+
*/
|
4349
|
+
declare const updateDatabaseSettings: (variables: UpdateDatabaseSettingsVariables, signal?: AbortSignal) => Promise<DatabaseSettings>;
|
4350
|
+
type CreateBranchAsyncPathParams = {
|
4351
|
+
/**
|
4352
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4353
|
+
*/
|
4354
|
+
dbBranchName: DBBranchName;
|
4355
|
+
workspace: string;
|
4356
|
+
region: string;
|
4357
|
+
};
|
4358
|
+
type CreateBranchAsyncQueryParams = {
|
4359
|
+
/**
|
4360
|
+
* Name of source branch to branch the new schema from
|
4361
|
+
*/
|
4362
|
+
from?: string;
|
4363
|
+
};
|
4364
|
+
type CreateBranchAsyncError = ErrorWrapper<{
|
4365
|
+
status: 400;
|
4366
|
+
payload: BadRequestError$1;
|
4367
|
+
} | {
|
4368
|
+
status: 401;
|
4369
|
+
payload: AuthError$1;
|
4370
|
+
} | {
|
4371
|
+
status: 404;
|
4372
|
+
payload: SimpleError$1;
|
4373
|
+
} | {
|
4374
|
+
status: 423;
|
4375
|
+
payload: SimpleError$1;
|
4376
|
+
}>;
|
4377
|
+
type CreateBranchAsyncRequestBody = {
|
4378
|
+
/**
|
4379
|
+
* Select the branch to fork from. Defaults to 'main'
|
4380
|
+
*/
|
4381
|
+
from?: string;
|
4382
|
+
/**
|
4383
|
+
* Select the dedicated cluster to create on. Defaults to 'xata-cloud'
|
4384
|
+
*
|
4385
|
+
* @minLength 1
|
4386
|
+
* @x-internal true
|
4387
|
+
*/
|
4388
|
+
clusterID?: string;
|
4389
|
+
metadata?: BranchMetadata$1;
|
4390
|
+
};
|
4391
|
+
type CreateBranchAsyncVariables = {
|
4392
|
+
body?: CreateBranchAsyncRequestBody;
|
4393
|
+
pathParams: CreateBranchAsyncPathParams;
|
4394
|
+
queryParams?: CreateBranchAsyncQueryParams;
|
4395
|
+
} & DataPlaneFetcherExtraProps;
|
4396
|
+
declare const createBranchAsync: (variables: CreateBranchAsyncVariables, signal?: AbortSignal) => Promise<CreateBranchResponse$1>;
|
3233
4397
|
type GetBranchDetailsPathParams = {
|
3234
4398
|
/**
|
3235
4399
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3357,12 +4521,37 @@ type GetSchemaError = ErrorWrapper<{
|
|
3357
4521
|
payload: SimpleError$1;
|
3358
4522
|
}>;
|
3359
4523
|
type GetSchemaResponse = {
|
3360
|
-
schema:
|
4524
|
+
schema: BranchSchema;
|
3361
4525
|
};
|
3362
4526
|
type GetSchemaVariables = {
|
3363
4527
|
pathParams: GetSchemaPathParams;
|
3364
4528
|
} & DataPlaneFetcherExtraProps;
|
3365
4529
|
declare const getSchema: (variables: GetSchemaVariables, signal?: AbortSignal) => Promise<GetSchemaResponse>;
|
4530
|
+
type GetSchemasPathParams = {
|
4531
|
+
/**
|
4532
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4533
|
+
*/
|
4534
|
+
dbBranchName: DBBranchName;
|
4535
|
+
workspace: string;
|
4536
|
+
region: string;
|
4537
|
+
};
|
4538
|
+
type GetSchemasError = ErrorWrapper<{
|
4539
|
+
status: 400;
|
4540
|
+
payload: BadRequestError$1;
|
4541
|
+
} | {
|
4542
|
+
status: 401;
|
4543
|
+
payload: AuthError$1;
|
4544
|
+
} | {
|
4545
|
+
status: 404;
|
4546
|
+
payload: SimpleError$1;
|
4547
|
+
}>;
|
4548
|
+
type GetSchemasResponse = {
|
4549
|
+
schemas: BranchSchema[];
|
4550
|
+
};
|
4551
|
+
type GetSchemasVariables = {
|
4552
|
+
pathParams: GetSchemasPathParams;
|
4553
|
+
} & DataPlaneFetcherExtraProps;
|
4554
|
+
declare const getSchemas: (variables: GetSchemasVariables, signal?: AbortSignal) => Promise<GetSchemasResponse>;
|
3366
4555
|
type CopyBranchPathParams = {
|
3367
4556
|
/**
|
3368
4557
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3393,6 +4582,73 @@ type CopyBranchVariables = {
|
|
3393
4582
|
* Create a copy of the branch
|
3394
4583
|
*/
|
3395
4584
|
declare const copyBranch: (variables: CopyBranchVariables, signal?: AbortSignal) => Promise<BranchWithCopyID>;
|
4585
|
+
type GetBranchMoveStatusPathParams = {
|
4586
|
+
/**
|
4587
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4588
|
+
*/
|
4589
|
+
dbBranchName: DBBranchName;
|
4590
|
+
workspace: string;
|
4591
|
+
region: string;
|
4592
|
+
};
|
4593
|
+
type GetBranchMoveStatusError = ErrorWrapper<{
|
4594
|
+
status: 400;
|
4595
|
+
payload: BadRequestError$1;
|
4596
|
+
} | {
|
4597
|
+
status: 401;
|
4598
|
+
payload: AuthError$1;
|
4599
|
+
} | {
|
4600
|
+
status: 404;
|
4601
|
+
payload: SimpleError$1;
|
4602
|
+
}>;
|
4603
|
+
type GetBranchMoveStatusResponse = {
|
4604
|
+
state: string;
|
4605
|
+
pendingBytes: number;
|
4606
|
+
};
|
4607
|
+
type GetBranchMoveStatusVariables = {
|
4608
|
+
pathParams: GetBranchMoveStatusPathParams;
|
4609
|
+
} & DataPlaneFetcherExtraProps;
|
4610
|
+
/**
|
4611
|
+
* Get the branch move status (if a move is happening)
|
4612
|
+
*/
|
4613
|
+
declare const getBranchMoveStatus: (variables: GetBranchMoveStatusVariables, signal?: AbortSignal) => Promise<GetBranchMoveStatusResponse>;
|
4614
|
+
type MoveBranchPathParams = {
|
4615
|
+
/**
|
4616
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4617
|
+
*/
|
4618
|
+
dbBranchName: DBBranchName;
|
4619
|
+
workspace: string;
|
4620
|
+
region: string;
|
4621
|
+
};
|
4622
|
+
type MoveBranchError = ErrorWrapper<{
|
4623
|
+
status: 400;
|
4624
|
+
payload: BadRequestError$1;
|
4625
|
+
} | {
|
4626
|
+
status: 401;
|
4627
|
+
payload: AuthError$1;
|
4628
|
+
} | {
|
4629
|
+
status: 404;
|
4630
|
+
payload: SimpleError$1;
|
4631
|
+
} | {
|
4632
|
+
status: 423;
|
4633
|
+
payload: SimpleError$1;
|
4634
|
+
}>;
|
4635
|
+
type MoveBranchResponse = {
|
4636
|
+
state: string;
|
4637
|
+
};
|
4638
|
+
type MoveBranchRequestBody = {
|
4639
|
+
/**
|
4640
|
+
* Select the cluster to move the branch to. Must be different from the current cluster.
|
4641
|
+
*
|
4642
|
+
* @minLength 1
|
4643
|
+
* @x-internal true
|
4644
|
+
*/
|
4645
|
+
to: string;
|
4646
|
+
};
|
4647
|
+
type MoveBranchVariables = {
|
4648
|
+
body: MoveBranchRequestBody;
|
4649
|
+
pathParams: MoveBranchPathParams;
|
4650
|
+
} & DataPlaneFetcherExtraProps;
|
4651
|
+
declare const moveBranch: (variables: MoveBranchVariables, signal?: AbortSignal) => Promise<MoveBranchResponse>;
|
3396
4652
|
type UpdateBranchMetadataPathParams = {
|
3397
4653
|
/**
|
3398
4654
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3581,7 +4837,7 @@ type RemoveGitBranchesEntryPathParams = {
|
|
3581
4837
|
};
|
3582
4838
|
type RemoveGitBranchesEntryQueryParams = {
|
3583
4839
|
/**
|
3584
|
-
* The
|
4840
|
+
* The git branch to remove from the mapping
|
3585
4841
|
*/
|
3586
4842
|
gitBranch: string;
|
3587
4843
|
};
|
@@ -3644,7 +4900,7 @@ type ResolveBranchVariables = {
|
|
3644
4900
|
} & DataPlaneFetcherExtraProps;
|
3645
4901
|
/**
|
3646
4902
|
* In order to resolve the database branch, the following algorithm is used:
|
3647
|
-
* * 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
|
4903
|
+
* * 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
|
3648
4904
|
* * else, if a Xata branch with the exact same name as `gitBranch` exists, return it
|
3649
4905
|
* * else, if `fallbackBranch` is provided and a branch with that name exists, return it
|
3650
4906
|
* * else, return the default branch of the DB (`main` or the first branch)
|
@@ -5245,7 +6501,7 @@ type QueryTableVariables = {
|
|
5245
6501
|
* }
|
5246
6502
|
* ```
|
5247
6503
|
*
|
5248
|
-
* For usage, see also the [
|
6504
|
+
* For usage, see also the [Xata SDK documentation](https://xata.io/docs/sdk/get).
|
5249
6505
|
*
|
5250
6506
|
* ### Column selection
|
5251
6507
|
*
|
@@ -6117,7 +7373,7 @@ type SearchTableVariables = {
|
|
6117
7373
|
/**
|
6118
7374
|
* Run a free text search operation in a particular table.
|
6119
7375
|
*
|
6120
|
-
* 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:
|
7376
|
+
* 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:
|
6121
7377
|
* * filters `$contains`, `$startsWith`, `$endsWith` don't work on columns of type `text`
|
6122
7378
|
* * filtering on columns of type `multiple` is currently unsupported
|
6123
7379
|
*/
|
@@ -6478,7 +7734,7 @@ type AggregateTableVariables = {
|
|
6478
7734
|
* store that is more appropriate for analytics, makes use of approximation algorithms
|
6479
7735
|
* (e.g for cardinality), and is generally faster and can do more complex aggregations.
|
6480
7736
|
*
|
6481
|
-
* For usage, see the [
|
7737
|
+
* For usage, see the [Aggregation documentation](https://xata.io/docs/sdk/aggregate).
|
6482
7738
|
*/
|
6483
7739
|
declare const aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal) => Promise<AggResponse>;
|
6484
7740
|
type FileAccessPathParams = {
|
@@ -6567,173 +7823,227 @@ type SqlQueryError = ErrorWrapper<{
|
|
6567
7823
|
status: 503;
|
6568
7824
|
payload: ServiceUnavailableError;
|
6569
7825
|
}>;
|
6570
|
-
type SqlQueryRequestBody = {
|
6571
|
-
|
6572
|
-
|
6573
|
-
|
6574
|
-
|
6575
|
-
|
6576
|
-
|
7826
|
+
type SqlQueryRequestBody = PreparedStatement & {
|
7827
|
+
consistency?: SQLConsistency;
|
7828
|
+
responseType?: SQLResponseType$1;
|
7829
|
+
};
|
7830
|
+
type SqlQueryVariables = {
|
7831
|
+
body: SqlQueryRequestBody;
|
7832
|
+
pathParams: SqlQueryPathParams;
|
7833
|
+
} & DataPlaneFetcherExtraProps;
|
7834
|
+
/**
|
7835
|
+
* Run an SQL query across the database branch.
|
7836
|
+
*/
|
7837
|
+
declare const sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<SQLResponse$1>;
|
7838
|
+
type SqlBatchQueryPathParams = {
|
6577
7839
|
/**
|
6578
|
-
* The
|
7840
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
6579
7841
|
*/
|
6580
|
-
|
7842
|
+
dbBranchName: DBBranchName;
|
7843
|
+
workspace: string;
|
7844
|
+
region: string;
|
7845
|
+
};
|
7846
|
+
type SqlBatchQueryError = ErrorWrapper<{
|
7847
|
+
status: 400;
|
7848
|
+
payload: BadRequestError$1;
|
7849
|
+
} | {
|
7850
|
+
status: 401;
|
7851
|
+
payload: AuthError$1;
|
7852
|
+
} | {
|
7853
|
+
status: 404;
|
7854
|
+
payload: SimpleError$1;
|
7855
|
+
} | {
|
7856
|
+
status: 503;
|
7857
|
+
payload: ServiceUnavailableError;
|
7858
|
+
}>;
|
7859
|
+
type SqlBatchQueryRequestBody = {
|
6581
7860
|
/**
|
6582
|
-
* The
|
7861
|
+
* The SQL statements.
|
6583
7862
|
*
|
6584
|
-
* @
|
7863
|
+
* @x-go-type []sqlproxy.PreparedStatement
|
6585
7864
|
*/
|
6586
|
-
|
7865
|
+
statements: PreparedStatement[];
|
7866
|
+
consistency?: SQLConsistency;
|
7867
|
+
responseType?: SQLResponseType$1;
|
6587
7868
|
};
|
6588
|
-
type
|
6589
|
-
body:
|
6590
|
-
pathParams:
|
7869
|
+
type SqlBatchQueryVariables = {
|
7870
|
+
body: SqlBatchQueryRequestBody;
|
7871
|
+
pathParams: SqlBatchQueryPathParams;
|
6591
7872
|
} & DataPlaneFetcherExtraProps;
|
6592
7873
|
/**
|
6593
|
-
* Run
|
7874
|
+
* Run multiple SQL queries across the database branch.
|
6594
7875
|
*/
|
6595
|
-
declare const
|
7876
|
+
declare const sqlBatchQuery: (variables: SqlBatchQueryVariables, signal?: AbortSignal) => Promise<SQLBatchResponse>;
|
6596
7877
|
|
6597
7878
|
declare const operationsByTag: {
|
6598
7879
|
branch: {
|
6599
|
-
|
6600
|
-
|
6601
|
-
|
6602
|
-
|
6603
|
-
|
6604
|
-
|
6605
|
-
|
6606
|
-
|
6607
|
-
|
6608
|
-
|
6609
|
-
|
6610
|
-
|
6611
|
-
|
6612
|
-
|
6613
|
-
|
6614
|
-
resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal | undefined) => Promise<ResolveBranchResponse>;
|
7880
|
+
getBranchList: (variables: GetBranchListVariables, signal?: AbortSignal) => Promise<ListBranchesResponse>;
|
7881
|
+
createBranchAsync: (variables: CreateBranchAsyncVariables, signal?: AbortSignal) => Promise<CreateBranchResponse$1>;
|
7882
|
+
getBranchDetails: (variables: GetBranchDetailsVariables, signal?: AbortSignal) => Promise<DBBranch>;
|
7883
|
+
createBranch: (variables: CreateBranchVariables, signal?: AbortSignal) => Promise<CreateBranchResponse>;
|
7884
|
+
deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal) => Promise<DeleteBranchResponse>;
|
7885
|
+
copyBranch: (variables: CopyBranchVariables, signal?: AbortSignal) => Promise<BranchWithCopyID>;
|
7886
|
+
getBranchMoveStatus: (variables: GetBranchMoveStatusVariables, signal?: AbortSignal) => Promise<GetBranchMoveStatusResponse>;
|
7887
|
+
moveBranch: (variables: MoveBranchVariables, signal?: AbortSignal) => Promise<MoveBranchResponse>;
|
7888
|
+
updateBranchMetadata: (variables: UpdateBranchMetadataVariables, signal?: AbortSignal) => Promise<undefined>;
|
7889
|
+
getBranchMetadata: (variables: GetBranchMetadataVariables, signal?: AbortSignal) => Promise<BranchMetadata$1>;
|
7890
|
+
getBranchStats: (variables: GetBranchStatsVariables, signal?: AbortSignal) => Promise<GetBranchStatsResponse>;
|
7891
|
+
getGitBranchesMapping: (variables: GetGitBranchesMappingVariables, signal?: AbortSignal) => Promise<ListGitBranchesResponse>;
|
7892
|
+
addGitBranchesEntry: (variables: AddGitBranchesEntryVariables, signal?: AbortSignal) => Promise<AddGitBranchesEntryResponse>;
|
7893
|
+
removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables, signal?: AbortSignal) => Promise<undefined>;
|
7894
|
+
resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal) => Promise<ResolveBranchResponse>;
|
6615
7895
|
};
|
6616
7896
|
workspaces: {
|
6617
|
-
getWorkspacesList: (variables:
|
6618
|
-
createWorkspace: (variables: CreateWorkspaceVariables, signal?: AbortSignal
|
6619
|
-
getWorkspace: (variables: GetWorkspaceVariables, signal?: AbortSignal
|
6620
|
-
updateWorkspace: (variables: UpdateWorkspaceVariables, signal?: AbortSignal
|
6621
|
-
deleteWorkspace: (variables: DeleteWorkspaceVariables, signal?: AbortSignal
|
6622
|
-
|
6623
|
-
|
6624
|
-
|
7897
|
+
getWorkspacesList: (variables: GetWorkspacesListVariables, signal?: AbortSignal) => Promise<GetWorkspacesListResponse>;
|
7898
|
+
createWorkspace: (variables: CreateWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
7899
|
+
getWorkspace: (variables: GetWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
7900
|
+
updateWorkspace: (variables: UpdateWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
7901
|
+
deleteWorkspace: (variables: DeleteWorkspaceVariables, signal?: AbortSignal) => Promise<undefined>;
|
7902
|
+
getWorkspaceSettings: (variables: GetWorkspaceSettingsVariables, signal?: AbortSignal) => Promise<WorkspaceSettings>;
|
7903
|
+
updateWorkspaceSettings: (variables: UpdateWorkspaceSettingsVariables, signal?: AbortSignal) => Promise<WorkspaceSettings>;
|
7904
|
+
getWorkspaceMembersList: (variables: GetWorkspaceMembersListVariables, signal?: AbortSignal) => Promise<WorkspaceMembers>;
|
7905
|
+
updateWorkspaceMemberRole: (variables: UpdateWorkspaceMemberRoleVariables, signal?: AbortSignal) => Promise<undefined>;
|
7906
|
+
removeWorkspaceMember: (variables: RemoveWorkspaceMemberVariables, signal?: AbortSignal) => Promise<undefined>;
|
7907
|
+
};
|
7908
|
+
table: {
|
7909
|
+
createTable: (variables: CreateTableVariables, signal?: AbortSignal) => Promise<CreateTableResponse>;
|
7910
|
+
deleteTable: (variables: DeleteTableVariables, signal?: AbortSignal) => Promise<DeleteTableResponse>;
|
7911
|
+
updateTable: (variables: UpdateTableVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7912
|
+
getTableSchema: (variables: GetTableSchemaVariables, signal?: AbortSignal) => Promise<GetTableSchemaResponse>;
|
7913
|
+
setTableSchema: (variables: SetTableSchemaVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7914
|
+
getTableColumns: (variables: GetTableColumnsVariables, signal?: AbortSignal) => Promise<GetTableColumnsResponse>;
|
7915
|
+
addTableColumn: (variables: AddTableColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7916
|
+
getColumn: (variables: GetColumnVariables, signal?: AbortSignal) => Promise<Column>;
|
7917
|
+
updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7918
|
+
deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7919
|
+
};
|
7920
|
+
migrations: {
|
7921
|
+
applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
|
7922
|
+
startMigration: (variables: StartMigrationVariables, signal?: AbortSignal) => Promise<StartMigrationResponse>;
|
7923
|
+
completeMigration: (variables: CompleteMigrationVariables, signal?: AbortSignal) => Promise<CompleteMigrationResponse>;
|
7924
|
+
rollbackMigration: (variables: RollbackMigrationVariables, signal?: AbortSignal) => Promise<RollbackMigrationResponse>;
|
7925
|
+
adaptTable: (variables: AdaptTableVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
|
7926
|
+
adaptAllTables: (variables: AdaptAllTablesVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
|
7927
|
+
getBranchMigrationJobStatus: (variables: GetBranchMigrationJobStatusVariables, signal?: AbortSignal) => Promise<MigrationJobStatusResponse>;
|
7928
|
+
getMigrationJobs: (variables: GetMigrationJobsVariables, signal?: AbortSignal) => Promise<GetMigrationJobsResponse>;
|
7929
|
+
getMigrationJobStatus: (variables: GetMigrationJobStatusVariables, signal?: AbortSignal) => Promise<MigrationJobStatusResponse>;
|
7930
|
+
getMigrationHistory: (variables: GetMigrationHistoryVariables, signal?: AbortSignal) => Promise<MigrationHistoryResponse>;
|
7931
|
+
getSchema: (variables: GetSchemaVariables, signal?: AbortSignal) => Promise<GetSchemaResponse>;
|
7932
|
+
getSchemas: (variables: GetSchemasVariables, signal?: AbortSignal) => Promise<GetSchemasResponse>;
|
7933
|
+
getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal) => Promise<GetBranchMigrationHistoryResponse>;
|
7934
|
+
getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<BranchMigrationPlan>;
|
7935
|
+
executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7936
|
+
getBranchSchemaHistory: (variables: GetBranchSchemaHistoryVariables, signal?: AbortSignal) => Promise<GetBranchSchemaHistoryResponse>;
|
7937
|
+
compareBranchWithUserSchema: (variables: CompareBranchWithUserSchemaVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
7938
|
+
compareBranchSchemas: (variables: CompareBranchSchemasVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
7939
|
+
updateBranchSchema: (variables: UpdateBranchSchemaVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7940
|
+
previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables, signal?: AbortSignal) => Promise<PreviewBranchSchemaEditResponse>;
|
7941
|
+
applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7942
|
+
pushBranchMigrations: (variables: PushBranchMigrationsVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
7943
|
+
};
|
7944
|
+
records: {
|
7945
|
+
branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal) => Promise<TransactionSuccess>;
|
7946
|
+
insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
7947
|
+
getRecord: (variables: GetRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
|
7948
|
+
insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
7949
|
+
updateRecordWithID: (variables: UpdateRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
7950
|
+
upsertRecordWithID: (variables: UpsertRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
7951
|
+
deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
|
7952
|
+
bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal) => Promise<BulkInsertResponse>;
|
7953
|
+
};
|
7954
|
+
tasks: {
|
7955
|
+
getTasks: (variables: GetTasksVariables, signal?: AbortSignal) => Promise<GetTasksResponse>;
|
7956
|
+
getTaskStatus: (variables: GetTaskStatusVariables, signal?: AbortSignal) => Promise<TaskStatusResponse>;
|
6625
7957
|
};
|
6626
|
-
|
6627
|
-
|
6628
|
-
|
6629
|
-
|
6630
|
-
|
6631
|
-
|
6632
|
-
compareBranchWithUserSchema: (variables: CompareBranchWithUserSchemaVariables, signal?: AbortSignal | undefined) => Promise<SchemaCompareResponse>;
|
6633
|
-
compareBranchSchemas: (variables: CompareBranchSchemasVariables, signal?: AbortSignal | undefined) => Promise<SchemaCompareResponse>;
|
6634
|
-
updateBranchSchema: (variables: UpdateBranchSchemaVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
6635
|
-
previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables, signal?: AbortSignal | undefined) => Promise<PreviewBranchSchemaEditResponse>;
|
6636
|
-
applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
6637
|
-
pushBranchMigrations: (variables: PushBranchMigrationsVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
7958
|
+
cluster: {
|
7959
|
+
listClusterBranches: (variables: ListClusterBranchesVariables, signal?: AbortSignal) => Promise<ListClusterBranchesResponse>;
|
7960
|
+
listClusterExtensions: (variables: ListClusterExtensionsVariables, signal?: AbortSignal) => Promise<ListClusterExtensionsResponse>;
|
7961
|
+
installClusterExtension: (variables: InstallClusterExtensionVariables, signal?: AbortSignal) => Promise<ClusterExtensionInstallationResponse>;
|
7962
|
+
dropClusterExtension: (variables: DropClusterExtensionVariables, signal?: AbortSignal) => Promise<undefined>;
|
7963
|
+
getClusterMetrics: (variables: GetClusterMetricsVariables, signal?: AbortSignal) => Promise<MetricsResponse>;
|
6638
7964
|
};
|
6639
|
-
|
6640
|
-
|
6641
|
-
|
6642
|
-
getRecord: (variables: GetRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
|
6643
|
-
insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
6644
|
-
updateRecordWithID: (variables: UpdateRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
6645
|
-
upsertRecordWithID: (variables: UpsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
6646
|
-
deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
|
6647
|
-
bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal | undefined) => Promise<BulkInsertResponse>;
|
7965
|
+
database: {
|
7966
|
+
getDatabaseSettings: (variables: GetDatabaseSettingsVariables, signal?: AbortSignal) => Promise<DatabaseSettings>;
|
7967
|
+
updateDatabaseSettings: (variables: UpdateDatabaseSettingsVariables, signal?: AbortSignal) => Promise<DatabaseSettings>;
|
6648
7968
|
};
|
6649
7969
|
migrationRequests: {
|
6650
|
-
queryMigrationRequests: (variables: QueryMigrationRequestsVariables, signal?: AbortSignal
|
6651
|
-
createMigrationRequest: (variables: CreateMigrationRequestVariables, signal?: AbortSignal
|
6652
|
-
getMigrationRequest: (variables: GetMigrationRequestVariables, signal?: AbortSignal
|
6653
|
-
updateMigrationRequest: (variables: UpdateMigrationRequestVariables, signal?: AbortSignal
|
6654
|
-
listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables, signal?: AbortSignal
|
6655
|
-
compareMigrationRequest: (variables: CompareMigrationRequestVariables, signal?: AbortSignal
|
6656
|
-
getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables, signal?: AbortSignal
|
6657
|
-
mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal
|
6658
|
-
};
|
6659
|
-
table: {
|
6660
|
-
createTable: (variables: CreateTableVariables, signal?: AbortSignal | undefined) => Promise<CreateTableResponse>;
|
6661
|
-
deleteTable: (variables: DeleteTableVariables, signal?: AbortSignal | undefined) => Promise<DeleteTableResponse>;
|
6662
|
-
updateTable: (variables: UpdateTableVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
6663
|
-
getTableSchema: (variables: GetTableSchemaVariables, signal?: AbortSignal | undefined) => Promise<GetTableSchemaResponse>;
|
6664
|
-
setTableSchema: (variables: SetTableSchemaVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
6665
|
-
getTableColumns: (variables: GetTableColumnsVariables, signal?: AbortSignal | undefined) => Promise<GetTableColumnsResponse>;
|
6666
|
-
addTableColumn: (variables: AddTableColumnVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
6667
|
-
getColumn: (variables: GetColumnVariables, signal?: AbortSignal | undefined) => Promise<Column>;
|
6668
|
-
updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
6669
|
-
deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
7970
|
+
queryMigrationRequests: (variables: QueryMigrationRequestsVariables, signal?: AbortSignal) => Promise<QueryMigrationRequestsResponse>;
|
7971
|
+
createMigrationRequest: (variables: CreateMigrationRequestVariables, signal?: AbortSignal) => Promise<CreateMigrationRequestResponse>;
|
7972
|
+
getMigrationRequest: (variables: GetMigrationRequestVariables, signal?: AbortSignal) => Promise<MigrationRequest>;
|
7973
|
+
updateMigrationRequest: (variables: UpdateMigrationRequestVariables, signal?: AbortSignal) => Promise<undefined>;
|
7974
|
+
listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables, signal?: AbortSignal) => Promise<ListMigrationRequestsCommitsResponse>;
|
7975
|
+
compareMigrationRequest: (variables: CompareMigrationRequestVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
7976
|
+
getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables, signal?: AbortSignal) => Promise<GetMigrationRequestIsMergedResponse>;
|
7977
|
+
mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal) => Promise<BranchOp>;
|
6670
7978
|
};
|
6671
7979
|
files: {
|
6672
|
-
getFileItem: (variables: GetFileItemVariables, signal?: AbortSignal
|
6673
|
-
putFileItem: (variables: PutFileItemVariables, signal?: AbortSignal
|
6674
|
-
deleteFileItem: (variables: DeleteFileItemVariables, signal?: AbortSignal
|
6675
|
-
getFile: (variables: GetFileVariables, signal?: AbortSignal
|
6676
|
-
putFile: (variables: PutFileVariables, signal?: AbortSignal
|
6677
|
-
deleteFile: (variables: DeleteFileVariables, signal?: AbortSignal
|
6678
|
-
fileAccess: (variables: FileAccessVariables, signal?: AbortSignal
|
6679
|
-
fileUpload: (variables: FileUploadVariables, signal?: AbortSignal
|
7980
|
+
getFileItem: (variables: GetFileItemVariables, signal?: AbortSignal) => Promise<Blob>;
|
7981
|
+
putFileItem: (variables: PutFileItemVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
7982
|
+
deleteFileItem: (variables: DeleteFileItemVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
7983
|
+
getFile: (variables: GetFileVariables, signal?: AbortSignal) => Promise<Blob>;
|
7984
|
+
putFile: (variables: PutFileVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
7985
|
+
deleteFile: (variables: DeleteFileVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
7986
|
+
fileAccess: (variables: FileAccessVariables, signal?: AbortSignal) => Promise<Blob>;
|
7987
|
+
fileUpload: (variables: FileUploadVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
6680
7988
|
};
|
6681
7989
|
searchAndFilter: {
|
6682
|
-
queryTable: (variables: QueryTableVariables, signal?: AbortSignal
|
6683
|
-
searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal
|
6684
|
-
searchTable: (variables: SearchTableVariables, signal?: AbortSignal
|
6685
|
-
vectorSearchTable: (variables: VectorSearchTableVariables, signal?: AbortSignal
|
6686
|
-
askTable: (variables: AskTableVariables, signal?: AbortSignal
|
6687
|
-
askTableSession: (variables: AskTableSessionVariables, signal?: AbortSignal
|
6688
|
-
summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal
|
6689
|
-
aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal
|
7990
|
+
queryTable: (variables: QueryTableVariables, signal?: AbortSignal) => Promise<QueryResponse>;
|
7991
|
+
searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
7992
|
+
searchTable: (variables: SearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
7993
|
+
vectorSearchTable: (variables: VectorSearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
7994
|
+
askTable: (variables: AskTableVariables, signal?: AbortSignal) => Promise<AskTableResponse>;
|
7995
|
+
askTableSession: (variables: AskTableSessionVariables, signal?: AbortSignal) => Promise<AskTableSessionResponse>;
|
7996
|
+
summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal) => Promise<SummarizeResponse>;
|
7997
|
+
aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal) => Promise<AggResponse>;
|
6690
7998
|
};
|
6691
7999
|
sql: {
|
6692
|
-
sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal
|
8000
|
+
sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<SQLResponse$1>;
|
8001
|
+
sqlBatchQuery: (variables: SqlBatchQueryVariables, signal?: AbortSignal) => Promise<SQLBatchResponse>;
|
6693
8002
|
};
|
6694
8003
|
oAuth: {
|
6695
|
-
getAuthorizationCode: (variables: GetAuthorizationCodeVariables, signal?: AbortSignal
|
6696
|
-
grantAuthorizationCode: (variables: GrantAuthorizationCodeVariables, signal?: AbortSignal
|
6697
|
-
getUserOAuthClients: (variables:
|
6698
|
-
deleteUserOAuthClient: (variables: DeleteUserOAuthClientVariables, signal?: AbortSignal
|
6699
|
-
getUserOAuthAccessTokens: (variables:
|
6700
|
-
deleteOAuthAccessToken: (variables: DeleteOAuthAccessTokenVariables, signal?: AbortSignal
|
6701
|
-
updateOAuthAccessToken: (variables: UpdateOAuthAccessTokenVariables, signal?: AbortSignal
|
8004
|
+
getAuthorizationCode: (variables: GetAuthorizationCodeVariables, signal?: AbortSignal) => Promise<AuthorizationCodeResponse>;
|
8005
|
+
grantAuthorizationCode: (variables: GrantAuthorizationCodeVariables, signal?: AbortSignal) => Promise<AuthorizationCodeResponse>;
|
8006
|
+
getUserOAuthClients: (variables: GetUserOAuthClientsVariables, signal?: AbortSignal) => Promise<GetUserOAuthClientsResponse>;
|
8007
|
+
deleteUserOAuthClient: (variables: DeleteUserOAuthClientVariables, signal?: AbortSignal) => Promise<undefined>;
|
8008
|
+
getUserOAuthAccessTokens: (variables: GetUserOAuthAccessTokensVariables, signal?: AbortSignal) => Promise<GetUserOAuthAccessTokensResponse>;
|
8009
|
+
deleteOAuthAccessToken: (variables: DeleteOAuthAccessTokenVariables, signal?: AbortSignal) => Promise<undefined>;
|
8010
|
+
updateOAuthAccessToken: (variables: UpdateOAuthAccessTokenVariables, signal?: AbortSignal) => Promise<OAuthAccessToken>;
|
6702
8011
|
};
|
6703
8012
|
users: {
|
6704
|
-
getUser: (variables:
|
6705
|
-
updateUser: (variables: UpdateUserVariables, signal?: AbortSignal
|
6706
|
-
deleteUser: (variables:
|
8013
|
+
getUser: (variables: GetUserVariables, signal?: AbortSignal) => Promise<UserWithID>;
|
8014
|
+
updateUser: (variables: UpdateUserVariables, signal?: AbortSignal) => Promise<UserWithID>;
|
8015
|
+
deleteUser: (variables: DeleteUserVariables, signal?: AbortSignal) => Promise<undefined>;
|
6707
8016
|
};
|
6708
8017
|
authentication: {
|
6709
|
-
getUserAPIKeys: (variables:
|
6710
|
-
createUserAPIKey: (variables: CreateUserAPIKeyVariables, signal?: AbortSignal
|
6711
|
-
deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal
|
8018
|
+
getUserAPIKeys: (variables: GetUserAPIKeysVariables, signal?: AbortSignal) => Promise<GetUserAPIKeysResponse>;
|
8019
|
+
createUserAPIKey: (variables: CreateUserAPIKeyVariables, signal?: AbortSignal) => Promise<CreateUserAPIKeyResponse>;
|
8020
|
+
deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal) => Promise<undefined>;
|
6712
8021
|
};
|
6713
8022
|
invites: {
|
6714
|
-
inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables, signal?: AbortSignal
|
6715
|
-
updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables, signal?: AbortSignal
|
6716
|
-
cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables, signal?: AbortSignal
|
6717
|
-
acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables, signal?: AbortSignal
|
6718
|
-
resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal
|
8023
|
+
inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables, signal?: AbortSignal) => Promise<WorkspaceInvite>;
|
8024
|
+
updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<WorkspaceInvite>;
|
8025
|
+
cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
8026
|
+
acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
8027
|
+
resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
6719
8028
|
};
|
6720
8029
|
xbcontrolOther: {
|
6721
|
-
listClusters: (variables: ListClustersVariables, signal?: AbortSignal
|
6722
|
-
createCluster: (variables: CreateClusterVariables, signal?: AbortSignal
|
6723
|
-
getCluster: (variables: GetClusterVariables, signal?: AbortSignal
|
6724
|
-
updateCluster: (variables: UpdateClusterVariables, signal?: AbortSignal
|
8030
|
+
listClusters: (variables: ListClustersVariables, signal?: AbortSignal) => Promise<ListClustersResponse>;
|
8031
|
+
createCluster: (variables: CreateClusterVariables, signal?: AbortSignal) => Promise<ClusterResponse>;
|
8032
|
+
getCluster: (variables: GetClusterVariables, signal?: AbortSignal) => Promise<ClusterMetadata>;
|
8033
|
+
updateCluster: (variables: UpdateClusterVariables, signal?: AbortSignal) => Promise<ClusterUpdateMetadata>;
|
8034
|
+
deleteCluster: (variables: DeleteClusterVariables, signal?: AbortSignal) => Promise<ClusterDeleteMetadata>;
|
6725
8035
|
};
|
6726
8036
|
databases: {
|
6727
|
-
getDatabaseList: (variables: GetDatabaseListVariables, signal?: AbortSignal
|
6728
|
-
createDatabase: (variables: CreateDatabaseVariables, signal?: AbortSignal
|
6729
|
-
deleteDatabase: (variables: DeleteDatabaseVariables, signal?: AbortSignal
|
6730
|
-
getDatabaseMetadata: (variables: GetDatabaseMetadataVariables, signal?: AbortSignal
|
6731
|
-
updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal
|
6732
|
-
renameDatabase: (variables: RenameDatabaseVariables, signal?: AbortSignal
|
6733
|
-
getDatabaseGithubSettings: (variables: GetDatabaseGithubSettingsVariables, signal?: AbortSignal
|
6734
|
-
updateDatabaseGithubSettings: (variables: UpdateDatabaseGithubSettingsVariables, signal?: AbortSignal
|
6735
|
-
deleteDatabaseGithubSettings: (variables: DeleteDatabaseGithubSettingsVariables, signal?: AbortSignal
|
6736
|
-
listRegions: (variables: ListRegionsVariables, signal?: AbortSignal
|
8037
|
+
getDatabaseList: (variables: GetDatabaseListVariables, signal?: AbortSignal) => Promise<ListDatabasesResponse>;
|
8038
|
+
createDatabase: (variables: CreateDatabaseVariables, signal?: AbortSignal) => Promise<CreateDatabaseResponse>;
|
8039
|
+
deleteDatabase: (variables: DeleteDatabaseVariables, signal?: AbortSignal) => Promise<DeleteDatabaseResponse>;
|
8040
|
+
getDatabaseMetadata: (variables: GetDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
8041
|
+
updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
8042
|
+
renameDatabase: (variables: RenameDatabaseVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
8043
|
+
getDatabaseGithubSettings: (variables: GetDatabaseGithubSettingsVariables, signal?: AbortSignal) => Promise<DatabaseGithubSettings>;
|
8044
|
+
updateDatabaseGithubSettings: (variables: UpdateDatabaseGithubSettingsVariables, signal?: AbortSignal) => Promise<DatabaseGithubSettings>;
|
8045
|
+
deleteDatabaseGithubSettings: (variables: DeleteDatabaseGithubSettingsVariables, signal?: AbortSignal) => Promise<undefined>;
|
8046
|
+
listRegions: (variables: ListRegionsVariables, signal?: AbortSignal) => Promise<ListRegionsResponse>;
|
6737
8047
|
};
|
6738
8048
|
};
|
6739
8049
|
|
@@ -6751,6 +8061,8 @@ declare function buildProviderString(provider: HostProvider): string;
|
|
6751
8061
|
declare function parseWorkspacesUrlParts(url: string): {
|
6752
8062
|
workspace: string;
|
6753
8063
|
region: string;
|
8064
|
+
database: string;
|
8065
|
+
branch?: string;
|
6754
8066
|
host: HostAliases;
|
6755
8067
|
} | null;
|
6756
8068
|
|
@@ -6771,7 +8083,7 @@ type XataApiProxy = {
|
|
6771
8083
|
[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;
|
6772
8084
|
};
|
6773
8085
|
};
|
6774
|
-
declare const XataApiClient_base: new (options?: XataApiClientOptions
|
8086
|
+
declare const XataApiClient_base: new (options?: XataApiClientOptions) => XataApiProxy;
|
6775
8087
|
declare class XataApiClient extends XataApiClient_base {
|
6776
8088
|
}
|
6777
8089
|
|
@@ -6784,6 +8096,7 @@ type responses_QueryResponse = QueryResponse;
|
|
6784
8096
|
type responses_RateLimitError = RateLimitError;
|
6785
8097
|
type responses_RecordResponse = RecordResponse;
|
6786
8098
|
type responses_RecordUpdateResponse = RecordUpdateResponse;
|
8099
|
+
type responses_SQLBatchResponse = SQLBatchResponse;
|
6787
8100
|
type responses_SQLResponse = SQLResponse;
|
6788
8101
|
type responses_SchemaCompareResponse = SchemaCompareResponse;
|
6789
8102
|
type responses_SchemaUpdateResponse = SchemaUpdateResponse;
|
@@ -6791,29 +8104,37 @@ type responses_SearchResponse = SearchResponse;
|
|
6791
8104
|
type responses_ServiceUnavailableError = ServiceUnavailableError;
|
6792
8105
|
type responses_SummarizeResponse = SummarizeResponse;
|
6793
8106
|
declare namespace responses {
|
6794
|
-
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 };
|
8107
|
+
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 };
|
6795
8108
|
}
|
6796
8109
|
|
6797
8110
|
type schemas_APIKeyName = APIKeyName;
|
6798
8111
|
type schemas_AccessToken = AccessToken;
|
6799
8112
|
type schemas_AggExpression = AggExpression;
|
6800
8113
|
type schemas_AggExpressionMap = AggExpressionMap;
|
8114
|
+
type schemas_ApplyMigrationResponse = ApplyMigrationResponse;
|
6801
8115
|
type schemas_AuthorizationCodeRequest = AuthorizationCodeRequest;
|
6802
8116
|
type schemas_AuthorizationCodeResponse = AuthorizationCodeResponse;
|
6803
8117
|
type schemas_AutoscalingConfig = AutoscalingConfig;
|
8118
|
+
type schemas_AutoscalingConfigResponse = AutoscalingConfigResponse;
|
6804
8119
|
type schemas_AverageAgg = AverageAgg;
|
6805
8120
|
type schemas_BoosterExpression = BoosterExpression;
|
6806
8121
|
type schemas_Branch = Branch;
|
8122
|
+
type schemas_BranchDetails = BranchDetails;
|
6807
8123
|
type schemas_BranchMigration = BranchMigration;
|
6808
8124
|
type schemas_BranchOp = BranchOp;
|
8125
|
+
type schemas_BranchSchema = BranchSchema;
|
8126
|
+
type schemas_BranchState = BranchState;
|
6809
8127
|
type schemas_BranchWithCopyID = BranchWithCopyID;
|
6810
8128
|
type schemas_ClusterConfiguration = ClusterConfiguration;
|
8129
|
+
type schemas_ClusterConfigurationResponse = ClusterConfigurationResponse;
|
6811
8130
|
type schemas_ClusterCreateDetails = ClusterCreateDetails;
|
6812
|
-
type
|
8131
|
+
type schemas_ClusterDeleteMetadata = ClusterDeleteMetadata;
|
8132
|
+
type schemas_ClusterExtensionInstallationResponse = ClusterExtensionInstallationResponse;
|
6813
8133
|
type schemas_ClusterMetadata = ClusterMetadata;
|
6814
8134
|
type schemas_ClusterResponse = ClusterResponse;
|
6815
8135
|
type schemas_ClusterShortMetadata = ClusterShortMetadata;
|
6816
8136
|
type schemas_ClusterUpdateDetails = ClusterUpdateDetails;
|
8137
|
+
type schemas_ClusterUpdateMetadata = ClusterUpdateMetadata;
|
6817
8138
|
type schemas_Column = Column;
|
6818
8139
|
type schemas_ColumnFile = ColumnFile;
|
6819
8140
|
type schemas_ColumnLink = ColumnLink;
|
@@ -6825,6 +8146,7 @@ type schemas_ColumnOpRename = ColumnOpRename;
|
|
6825
8146
|
type schemas_ColumnVector = ColumnVector;
|
6826
8147
|
type schemas_ColumnsProjection = ColumnsProjection;
|
6827
8148
|
type schemas_Commit = Commit;
|
8149
|
+
type schemas_CompleteMigrationResponse = CompleteMigrationResponse;
|
6828
8150
|
type schemas_CountAgg = CountAgg;
|
6829
8151
|
type schemas_DBBranch = DBBranch;
|
6830
8152
|
type schemas_DBBranchName = DBBranchName;
|
@@ -6832,7 +8154,9 @@ type schemas_DailyTimeWindow = DailyTimeWindow;
|
|
6832
8154
|
type schemas_DataInputRecord = DataInputRecord;
|
6833
8155
|
type schemas_DatabaseGithubSettings = DatabaseGithubSettings;
|
6834
8156
|
type schemas_DatabaseMetadata = DatabaseMetadata;
|
8157
|
+
type schemas_DatabaseSettings = DatabaseSettings;
|
6835
8158
|
type schemas_DateHistogramAgg = DateHistogramAgg;
|
8159
|
+
type schemas_ExtensionDetails = ExtensionDetails;
|
6836
8160
|
type schemas_FileAccessID = FileAccessID;
|
6837
8161
|
type schemas_FileItemID = FileItemID;
|
6838
8162
|
type schemas_FileName = FileName;
|
@@ -6848,6 +8172,7 @@ type schemas_FilterPredicateRangeOp = FilterPredicateRangeOp;
|
|
6848
8172
|
type schemas_FilterRangeValue = FilterRangeValue;
|
6849
8173
|
type schemas_FilterValue = FilterValue;
|
6850
8174
|
type schemas_FuzzinessExpression = FuzzinessExpression;
|
8175
|
+
type schemas_GetMigrationJobsResponse = GetMigrationJobsResponse;
|
6851
8176
|
type schemas_HighlightExpression = HighlightExpression;
|
6852
8177
|
type schemas_InputFile = InputFile;
|
6853
8178
|
type schemas_InputFileArray = InputFileArray;
|
@@ -6855,22 +8180,38 @@ type schemas_InputFileEntry = InputFileEntry;
|
|
6855
8180
|
type schemas_InviteID = InviteID;
|
6856
8181
|
type schemas_InviteKey = InviteKey;
|
6857
8182
|
type schemas_ListBranchesResponse = ListBranchesResponse;
|
8183
|
+
type schemas_ListClusterBranchesResponse = ListClusterBranchesResponse;
|
8184
|
+
type schemas_ListClusterExtensionsResponse = ListClusterExtensionsResponse;
|
6858
8185
|
type schemas_ListClustersResponse = ListClustersResponse;
|
6859
8186
|
type schemas_ListDatabasesResponse = ListDatabasesResponse;
|
6860
8187
|
type schemas_ListGitBranchesResponse = ListGitBranchesResponse;
|
6861
8188
|
type schemas_ListRegionsResponse = ListRegionsResponse;
|
6862
8189
|
type schemas_MaintenanceConfig = MaintenanceConfig;
|
8190
|
+
type schemas_MaintenanceConfigResponse = MaintenanceConfigResponse;
|
6863
8191
|
type schemas_MaxAgg = MaxAgg;
|
6864
8192
|
type schemas_MediaType = MediaType;
|
8193
|
+
type schemas_MetricData = MetricData;
|
8194
|
+
type schemas_MetricMessage = MetricMessage;
|
6865
8195
|
type schemas_MetricsDatapoint = MetricsDatapoint;
|
6866
8196
|
type schemas_MetricsLatency = MetricsLatency;
|
8197
|
+
type schemas_MetricsResponse = MetricsResponse;
|
6867
8198
|
type schemas_Migration = Migration;
|
6868
8199
|
type schemas_MigrationColumnOp = MigrationColumnOp;
|
8200
|
+
type schemas_MigrationDescription = MigrationDescription;
|
8201
|
+
type schemas_MigrationHistoryItem = MigrationHistoryItem;
|
8202
|
+
type schemas_MigrationHistoryResponse = MigrationHistoryResponse;
|
8203
|
+
type schemas_MigrationJobID = MigrationJobID;
|
8204
|
+
type schemas_MigrationJobItem = MigrationJobItem;
|
8205
|
+
type schemas_MigrationJobStatus = MigrationJobStatus;
|
8206
|
+
type schemas_MigrationJobStatusResponse = MigrationJobStatusResponse;
|
8207
|
+
type schemas_MigrationJobType = MigrationJobType;
|
6869
8208
|
type schemas_MigrationObject = MigrationObject;
|
6870
8209
|
type schemas_MigrationOp = MigrationOp;
|
8210
|
+
type schemas_MigrationOperationDescription = MigrationOperationDescription;
|
6871
8211
|
type schemas_MigrationRequest = MigrationRequest;
|
6872
8212
|
type schemas_MigrationRequestNumber = MigrationRequestNumber;
|
6873
8213
|
type schemas_MigrationTableOp = MigrationTableOp;
|
8214
|
+
type schemas_MigrationType = MigrationType;
|
6874
8215
|
type schemas_MinAgg = MinAgg;
|
6875
8216
|
type schemas_NumericHistogramAgg = NumericHistogramAgg;
|
6876
8217
|
type schemas_OAuthAccessToken = OAuthAccessToken;
|
@@ -6880,19 +8221,9 @@ type schemas_OAuthResponseType = OAuthResponseType;
|
|
6880
8221
|
type schemas_OAuthScope = OAuthScope;
|
6881
8222
|
type schemas_ObjectValue = ObjectValue;
|
6882
8223
|
type schemas_PageConfig = PageConfig;
|
6883
|
-
type schemas_PageResponse = PageResponse;
|
6884
|
-
type schemas_PageSize = PageSize;
|
6885
|
-
type schemas_PageToken = PageToken;
|
6886
8224
|
type schemas_PercentilesAgg = PercentilesAgg;
|
6887
|
-
type schemas_PgRollApplyMigrationResponse = PgRollApplyMigrationResponse;
|
6888
|
-
type schemas_PgRollJobStatus = PgRollJobStatus;
|
6889
|
-
type schemas_PgRollJobStatusResponse = PgRollJobStatusResponse;
|
6890
|
-
type schemas_PgRollJobType = PgRollJobType;
|
6891
|
-
type schemas_PgRollMigrationHistoryItem = PgRollMigrationHistoryItem;
|
6892
|
-
type schemas_PgRollMigrationHistoryResponse = PgRollMigrationHistoryResponse;
|
6893
|
-
type schemas_PgRollMigrationJobID = PgRollMigrationJobID;
|
6894
|
-
type schemas_PgRollMigrationType = PgRollMigrationType;
|
6895
8225
|
type schemas_PrefixExpression = PrefixExpression;
|
8226
|
+
type schemas_PreparedStatement = PreparedStatement;
|
6896
8227
|
type schemas_ProjectionConfig = ProjectionConfig;
|
6897
8228
|
type schemas_QueryColumnsProjection = QueryColumnsProjection;
|
6898
8229
|
type schemas_RecordID = RecordID;
|
@@ -6901,12 +8232,18 @@ type schemas_RecordsMetadata = RecordsMetadata;
|
|
6901
8232
|
type schemas_Region = Region;
|
6902
8233
|
type schemas_RevLink = RevLink;
|
6903
8234
|
type schemas_Role = Role;
|
8235
|
+
type schemas_RollbackMigrationResponse = RollbackMigrationResponse;
|
8236
|
+
type schemas_SQLConsistency = SQLConsistency;
|
6904
8237
|
type schemas_SQLRecord = SQLRecord;
|
8238
|
+
type schemas_SQLResponseArray = SQLResponseArray;
|
8239
|
+
type schemas_SQLResponseBase = SQLResponseBase;
|
8240
|
+
type schemas_SQLResponseJSON = SQLResponseJSON;
|
6905
8241
|
type schemas_Schema = Schema;
|
6906
8242
|
type schemas_SchemaEditScript = SchemaEditScript;
|
6907
8243
|
type schemas_SearchPageConfig = SearchPageConfig;
|
6908
8244
|
type schemas_SortExpression = SortExpression;
|
6909
8245
|
type schemas_SortOrder = SortOrder;
|
8246
|
+
type schemas_StartMigrationResponse = StartMigrationResponse;
|
6910
8247
|
type schemas_StartedFromMetadata = StartedFromMetadata;
|
6911
8248
|
type schemas_SumAgg = SumAgg;
|
6912
8249
|
type schemas_SummaryExpression = SummaryExpression;
|
@@ -6919,6 +8256,9 @@ type schemas_TableOpRemove = TableOpRemove;
|
|
6919
8256
|
type schemas_TableOpRename = TableOpRename;
|
6920
8257
|
type schemas_TableRename = TableRename;
|
6921
8258
|
type schemas_TargetExpression = TargetExpression;
|
8259
|
+
type schemas_TaskID = TaskID;
|
8260
|
+
type schemas_TaskStatus = TaskStatus;
|
8261
|
+
type schemas_TaskStatusResponse = TaskStatusResponse;
|
6922
8262
|
type schemas_TopValuesAgg = TopValuesAgg;
|
6923
8263
|
type schemas_TransactionDeleteOp = TransactionDeleteOp;
|
6924
8264
|
type schemas_TransactionError = TransactionError;
|
@@ -6944,8 +8284,9 @@ type schemas_WorkspaceMember = WorkspaceMember;
|
|
6944
8284
|
type schemas_WorkspaceMembers = WorkspaceMembers;
|
6945
8285
|
type schemas_WorkspaceMeta = WorkspaceMeta;
|
6946
8286
|
type schemas_WorkspacePlan = WorkspacePlan;
|
8287
|
+
type schemas_WorkspaceSettings = WorkspaceSettings;
|
6947
8288
|
declare namespace schemas {
|
6948
|
-
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,
|
8289
|
+
export type { schemas_APIKeyName as APIKeyName, schemas_AccessToken as AccessToken, schemas_AggExpression as AggExpression, schemas_AggExpressionMap as AggExpressionMap, AggResponse$1 as AggResponse, schemas_ApplyMigrationResponse as ApplyMigrationResponse, schemas_AuthorizationCodeRequest as AuthorizationCodeRequest, schemas_AuthorizationCodeResponse as AuthorizationCodeResponse, schemas_AutoscalingConfig as AutoscalingConfig, schemas_AutoscalingConfigResponse as AutoscalingConfigResponse, schemas_AverageAgg as AverageAgg, schemas_BoosterExpression as BoosterExpression, schemas_Branch as Branch, schemas_BranchDetails as BranchDetails, BranchMetadata$1 as BranchMetadata, schemas_BranchMigration as BranchMigration, BranchName$1 as BranchName, schemas_BranchOp as BranchOp, schemas_BranchSchema as BranchSchema, schemas_BranchState as BranchState, schemas_BranchWithCopyID as BranchWithCopyID, schemas_ClusterConfiguration as ClusterConfiguration, schemas_ClusterConfigurationResponse as ClusterConfigurationResponse, schemas_ClusterCreateDetails as ClusterCreateDetails, schemas_ClusterDeleteMetadata as ClusterDeleteMetadata, schemas_ClusterExtensionInstallationResponse as ClusterExtensionInstallationResponse, ClusterID$1 as ClusterID, schemas_ClusterMetadata as ClusterMetadata, schemas_ClusterResponse as ClusterResponse, schemas_ClusterShortMetadata as ClusterShortMetadata, schemas_ClusterUpdateDetails as ClusterUpdateDetails, schemas_ClusterUpdateMetadata as ClusterUpdateMetadata, schemas_Column as Column, schemas_ColumnFile as ColumnFile, schemas_ColumnLink as ColumnLink, schemas_ColumnMigration as ColumnMigration, schemas_ColumnName as ColumnName, schemas_ColumnOpAdd as ColumnOpAdd, schemas_ColumnOpRemove as ColumnOpRemove, schemas_ColumnOpRename as ColumnOpRename, schemas_ColumnVector as ColumnVector, schemas_ColumnsProjection as ColumnsProjection, schemas_Commit as Commit, schemas_CompleteMigrationResponse as CompleteMigrationResponse, schemas_CountAgg as CountAgg, CreateBranchResponse$1 as CreateBranchResponse, schemas_DBBranch as DBBranch, schemas_DBBranchName as DBBranchName, DBName$1 as DBName, schemas_DailyTimeWindow as DailyTimeWindow, schemas_DataInputRecord as DataInputRecord, schemas_DatabaseGithubSettings as DatabaseGithubSettings, schemas_DatabaseMetadata as DatabaseMetadata, schemas_DatabaseSettings as DatabaseSettings, DateBooster$1 as DateBooster, schemas_DateHistogramAgg as DateHistogramAgg, DateTime$1 as DateTime, schemas_ExtensionDetails as ExtensionDetails, schemas_FileAccessID as FileAccessID, schemas_FileItemID as FileItemID, schemas_FileName as FileName, schemas_FileResponse as FileResponse, schemas_FileSignature as FileSignature, schemas_FilterColumn as FilterColumn, schemas_FilterColumnIncludes as FilterColumnIncludes, schemas_FilterExpression as FilterExpression, schemas_FilterList as FilterList, schemas_FilterPredicate as FilterPredicate, schemas_FilterPredicateOp as FilterPredicateOp, schemas_FilterPredicateRangeOp as FilterPredicateRangeOp, schemas_FilterRangeValue as FilterRangeValue, schemas_FilterValue as FilterValue, schemas_FuzzinessExpression as FuzzinessExpression, schemas_GetMigrationJobsResponse as GetMigrationJobsResponse, schemas_HighlightExpression as HighlightExpression, schemas_InputFile as InputFile, schemas_InputFileArray as InputFileArray, schemas_InputFileEntry as InputFileEntry, schemas_InviteID as InviteID, schemas_InviteKey as InviteKey, schemas_ListBranchesResponse as ListBranchesResponse, schemas_ListClusterBranchesResponse as ListClusterBranchesResponse, schemas_ListClusterExtensionsResponse as ListClusterExtensionsResponse, schemas_ListClustersResponse as ListClustersResponse, schemas_ListDatabasesResponse as ListDatabasesResponse, schemas_ListGitBranchesResponse as ListGitBranchesResponse, schemas_ListRegionsResponse as ListRegionsResponse, schemas_MaintenanceConfig as MaintenanceConfig, schemas_MaintenanceConfigResponse as MaintenanceConfigResponse, schemas_MaxAgg as MaxAgg, schemas_MediaType as MediaType, schemas_MetricData as MetricData, schemas_MetricMessage as MetricMessage, schemas_MetricsDatapoint as MetricsDatapoint, schemas_MetricsLatency as MetricsLatency, schemas_MetricsResponse as MetricsResponse, schemas_Migration as Migration, schemas_MigrationColumnOp as MigrationColumnOp, schemas_MigrationDescription as MigrationDescription, schemas_MigrationHistoryItem as MigrationHistoryItem, schemas_MigrationHistoryResponse as MigrationHistoryResponse, schemas_MigrationJobID as MigrationJobID, schemas_MigrationJobItem as MigrationJobItem, schemas_MigrationJobStatus as MigrationJobStatus, schemas_MigrationJobStatusResponse as MigrationJobStatusResponse, schemas_MigrationJobType as MigrationJobType, schemas_MigrationObject as MigrationObject, schemas_MigrationOp as MigrationOp, schemas_MigrationOperationDescription as MigrationOperationDescription, schemas_MigrationRequest as MigrationRequest, schemas_MigrationRequestNumber as MigrationRequestNumber, MigrationStatus$1 as MigrationStatus, schemas_MigrationTableOp as MigrationTableOp, schemas_MigrationType as MigrationType, schemas_MinAgg as MinAgg, NumericBooster$1 as NumericBooster, schemas_NumericHistogramAgg as NumericHistogramAgg, schemas_OAuthAccessToken as OAuthAccessToken, schemas_OAuthClientID as OAuthClientID, schemas_OAuthClientPublicDetails as OAuthClientPublicDetails, schemas_OAuthResponseType as OAuthResponseType, schemas_OAuthScope as OAuthScope, schemas_ObjectValue as ObjectValue, schemas_PageConfig as PageConfig, PageResponse$1 as PageResponse, PageSize$1 as PageSize, PageToken$1 as PageToken, schemas_PercentilesAgg as PercentilesAgg, schemas_PrefixExpression as PrefixExpression, schemas_PreparedStatement as PreparedStatement, schemas_ProjectionConfig as ProjectionConfig, schemas_QueryColumnsProjection as QueryColumnsProjection, schemas_RecordID as RecordID, schemas_RecordMeta as RecordMeta, schemas_RecordsMetadata as RecordsMetadata, schemas_Region as Region, schemas_RevLink as RevLink, schemas_Role as Role, schemas_RollbackMigrationResponse as RollbackMigrationResponse, schemas_SQLConsistency as SQLConsistency, schemas_SQLRecord as SQLRecord, SQLResponse$1 as SQLResponse, schemas_SQLResponseArray as SQLResponseArray, schemas_SQLResponseBase as SQLResponseBase, schemas_SQLResponseJSON as SQLResponseJSON, SQLResponseType$1 as SQLResponseType, schemas_Schema as Schema, schemas_SchemaEditScript as SchemaEditScript, schemas_SearchPageConfig as SearchPageConfig, schemas_SortExpression as SortExpression, schemas_SortOrder as SortOrder, schemas_StartMigrationResponse as StartMigrationResponse, schemas_StartedFromMetadata as StartedFromMetadata, schemas_SumAgg as SumAgg, schemas_SummaryExpression as SummaryExpression, schemas_SummaryExpressionList as SummaryExpressionList, schemas_Table as Table, schemas_TableMigration as TableMigration, schemas_TableName as TableName, schemas_TableOpAdd as TableOpAdd, schemas_TableOpRemove as TableOpRemove, schemas_TableOpRename as TableOpRename, schemas_TableRename as TableRename, schemas_TargetExpression as TargetExpression, schemas_TaskID as TaskID, schemas_TaskStatus as TaskStatus, schemas_TaskStatusResponse as TaskStatusResponse, 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 };
|
6949
8290
|
}
|
6950
8291
|
|
6951
8292
|
declare class XataApiPlugin implements XataPlugin {
|
@@ -7117,6 +8458,580 @@ interface ImageTransformations {
|
|
7117
8458
|
declare function transformImage(url: string, ...transformations: ImageTransformations[]): string;
|
7118
8459
|
declare function transformImage(url: string | undefined, ...transformations: ImageTransformations[]): string | undefined;
|
7119
8460
|
|
8461
|
+
declare class Buffer extends Uint8Array {
|
8462
|
+
/**
|
8463
|
+
* Allocates a new buffer containing the given `str`.
|
8464
|
+
*
|
8465
|
+
* @param str String to store in buffer.
|
8466
|
+
* @param encoding Encoding to use, optional. Default is `utf8`.
|
8467
|
+
*/
|
8468
|
+
constructor(str: string, encoding?: Encoding);
|
8469
|
+
/**
|
8470
|
+
* Allocates a new buffer of `size` octets.
|
8471
|
+
*
|
8472
|
+
* @param size Count of octets to allocate.
|
8473
|
+
*/
|
8474
|
+
constructor(size: number);
|
8475
|
+
/**
|
8476
|
+
* Allocates a new buffer containing the given `array` of octets.
|
8477
|
+
*
|
8478
|
+
* @param array The octets to store.
|
8479
|
+
*/
|
8480
|
+
constructor(array: Uint8Array);
|
8481
|
+
/**
|
8482
|
+
* Allocates a new buffer containing the given `array` of octet values.
|
8483
|
+
*
|
8484
|
+
* @param array
|
8485
|
+
*/
|
8486
|
+
constructor(array: number[]);
|
8487
|
+
/**
|
8488
|
+
* Allocates a new buffer containing the given `array` of octet values.
|
8489
|
+
*
|
8490
|
+
* @param array
|
8491
|
+
* @param encoding
|
8492
|
+
*/
|
8493
|
+
constructor(array: number[], encoding: Encoding);
|
8494
|
+
/**
|
8495
|
+
* Copies the passed `buffer` data onto a new `Buffer` instance.
|
8496
|
+
*
|
8497
|
+
* @param buffer
|
8498
|
+
*/
|
8499
|
+
constructor(buffer: Buffer);
|
8500
|
+
/**
|
8501
|
+
* When passed a reference to the .buffer property of a TypedArray instance, the newly created Buffer will share
|
8502
|
+
* the same allocated memory as the TypedArray. The optional `byteOffset` and `length` arguments specify a memory
|
8503
|
+
* range within the `arrayBuffer` that will be shared by the Buffer.
|
8504
|
+
*
|
8505
|
+
* @param buffer The .buffer property of a TypedArray or a new ArrayBuffer().
|
8506
|
+
* @param byteOffset
|
8507
|
+
* @param length
|
8508
|
+
*/
|
8509
|
+
constructor(buffer: ArrayBuffer, byteOffset?: number, length?: number);
|
8510
|
+
/**
|
8511
|
+
* Return JSON representation of the buffer.
|
8512
|
+
*/
|
8513
|
+
toJSON(): {
|
8514
|
+
type: 'Buffer';
|
8515
|
+
data: number[];
|
8516
|
+
};
|
8517
|
+
/**
|
8518
|
+
* Writes `string` to the buffer at `offset` according to the character encoding in `encoding`. The `length`
|
8519
|
+
* parameter is the number of bytes to write. If the buffer does not contain enough space to fit the entire string,
|
8520
|
+
* only part of `string` will be written. However, partially encoded characters will not be written.
|
8521
|
+
*
|
8522
|
+
* @param string String to write to `buf`.
|
8523
|
+
* @param encoding The character encoding of `string`. Default: `utf8`.
|
8524
|
+
*/
|
8525
|
+
write(string: string, encoding?: Encoding): number;
|
8526
|
+
/**
|
8527
|
+
* Writes `string` to the buffer at `offset` according to the character encoding in `encoding`. The `length`
|
8528
|
+
* parameter is the number of bytes to write. If the buffer does not contain enough space to fit the entire string,
|
8529
|
+
* only part of `string` will be written. However, partially encoded characters will not be written.
|
8530
|
+
*
|
8531
|
+
* @param string String to write to `buf`.
|
8532
|
+
* @param offset Number of bytes to skip before starting to write `string`. Default: `0`.
|
8533
|
+
* @param length Maximum number of bytes to write: Default: `buf.length - offset`.
|
8534
|
+
* @param encoding The character encoding of `string`. Default: `utf8`.
|
8535
|
+
*/
|
8536
|
+
write(string: string, offset?: number, length?: number, encoding?: Encoding): number;
|
8537
|
+
/**
|
8538
|
+
* Decodes the buffer to a string according to the specified character encoding.
|
8539
|
+
* Passing `start` and `end` will decode only a subset of the buffer.
|
8540
|
+
*
|
8541
|
+
* Note that if the encoding is `utf8` and a byte sequence in the input is not valid UTF-8, then each invalid byte
|
8542
|
+
* will be replaced with `U+FFFD`.
|
8543
|
+
*
|
8544
|
+
* @param encoding
|
8545
|
+
* @param start
|
8546
|
+
* @param end
|
8547
|
+
*/
|
8548
|
+
toString(encoding?: Encoding, start?: number, end?: number): string;
|
8549
|
+
/**
|
8550
|
+
* Returns true if this buffer's is equal to the provided buffer, meaning they share the same exact data.
|
8551
|
+
*
|
8552
|
+
* @param otherBuffer
|
8553
|
+
*/
|
8554
|
+
equals(otherBuffer: Buffer): boolean;
|
8555
|
+
/**
|
8556
|
+
* Compares the buffer with `otherBuffer` and returns a number indicating whether the buffer comes before, after,
|
8557
|
+
* or is the same as `otherBuffer` in sort order. Comparison is based on the actual sequence of bytes in each
|
8558
|
+
* buffer.
|
8559
|
+
*
|
8560
|
+
* - `0` is returned if `otherBuffer` is the same as this buffer.
|
8561
|
+
* - `1` is returned if `otherBuffer` should come before this buffer when sorted.
|
8562
|
+
* - `-1` is returned if `otherBuffer` should come after this buffer when sorted.
|
8563
|
+
*
|
8564
|
+
* @param otherBuffer The buffer to compare to.
|
8565
|
+
* @param targetStart The offset within `otherBuffer` at which to begin comparison.
|
8566
|
+
* @param targetEnd The offset within `otherBuffer` at which to end comparison (exclusive).
|
8567
|
+
* @param sourceStart The offset within this buffer at which to begin comparison.
|
8568
|
+
* @param sourceEnd The offset within this buffer at which to end the comparison (exclusive).
|
8569
|
+
*/
|
8570
|
+
compare(otherBuffer: Uint8Array, targetStart?: number, targetEnd?: number, sourceStart?: number, sourceEnd?: number): number;
|
8571
|
+
/**
|
8572
|
+
* Copies data from a region of this buffer to a region in `targetBuffer`, even if the `targetBuffer` memory
|
8573
|
+
* region overlaps with this buffer.
|
8574
|
+
*
|
8575
|
+
* @param targetBuffer The target buffer to copy into.
|
8576
|
+
* @param targetStart The offset within `targetBuffer` at which to begin writing.
|
8577
|
+
* @param sourceStart The offset within this buffer at which to begin copying.
|
8578
|
+
* @param sourceEnd The offset within this buffer at which to end copying (exclusive).
|
8579
|
+
*/
|
8580
|
+
copy(targetBuffer: Uint8Array, targetStart?: number, sourceStart?: number, sourceEnd?: number): number;
|
8581
|
+
/**
|
8582
|
+
* Returns a new `Buffer` that references the same memory as the original, but offset and cropped by the `start`
|
8583
|
+
* and `end` indices. This is the same behavior as `buf.subarray()`.
|
8584
|
+
*
|
8585
|
+
* This method is not compatible with the `Uint8Array.prototype.slice()`, which is a superclass of Buffer. To copy
|
8586
|
+
* the slice, use `Uint8Array.prototype.slice()`.
|
8587
|
+
*
|
8588
|
+
* @param start
|
8589
|
+
* @param end
|
8590
|
+
*/
|
8591
|
+
slice(start?: number, end?: number): Buffer;
|
8592
|
+
/**
|
8593
|
+
* Writes `byteLength` bytes of `value` to `buf` at the specified `offset` as little-endian. Supports up to 48 bits
|
8594
|
+
* of accuracy. Behavior is undefined when value is anything other than an unsigned integer.
|
8595
|
+
*
|
8596
|
+
* @param value Number to write.
|
8597
|
+
* @param offset Number of bytes to skip before starting to write.
|
8598
|
+
* @param byteLength Number of bytes to write, between 0 and 6.
|
8599
|
+
* @param noAssert
|
8600
|
+
* @returns `offset` plus the number of bytes written.
|
8601
|
+
*/
|
8602
|
+
writeUIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
|
8603
|
+
/**
|
8604
|
+
* Writes `byteLength` bytes of `value` to `buf` at the specified `offset` as big-endian. Supports up to 48 bits of
|
8605
|
+
* accuracy. Behavior is undefined when `value` is anything other than an unsigned integer.
|
8606
|
+
*
|
8607
|
+
* @param value Number to write.
|
8608
|
+
* @param offset Number of bytes to skip before starting to write.
|
8609
|
+
* @param byteLength Number of bytes to write, between 0 and 6.
|
8610
|
+
* @param noAssert
|
8611
|
+
* @returns `offset` plus the number of bytes written.
|
8612
|
+
*/
|
8613
|
+
writeUIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
|
8614
|
+
/**
|
8615
|
+
* Writes `byteLength` bytes of `value` to `buf` at the specified `offset` as little-endian. Supports up to 48 bits
|
8616
|
+
* of accuracy. Behavior is undefined when `value` is anything other than a signed integer.
|
8617
|
+
*
|
8618
|
+
* @param value Number to write.
|
8619
|
+
* @param offset Number of bytes to skip before starting to write.
|
8620
|
+
* @param byteLength Number of bytes to write, between 0 and 6.
|
8621
|
+
* @param noAssert
|
8622
|
+
* @returns `offset` plus the number of bytes written.
|
8623
|
+
*/
|
8624
|
+
writeIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
|
8625
|
+
/**
|
8626
|
+
* Writes `byteLength` bytes of `value` to `buf` at the specified `offset` as big-endian. Supports up to 48 bits
|
8627
|
+
* of accuracy. Behavior is undefined when `value` is anything other than a signed integer.
|
8628
|
+
*
|
8629
|
+
* @param value Number to write.
|
8630
|
+
* @param offset Number of bytes to skip before starting to write.
|
8631
|
+
* @param byteLength Number of bytes to write, between 0 and 6.
|
8632
|
+
* @param noAssert
|
8633
|
+
* @returns `offset` plus the number of bytes written.
|
8634
|
+
*/
|
8635
|
+
writeIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
|
8636
|
+
/**
|
8637
|
+
* Reads `byteLength` number of bytes from `buf` at the specified `offset` and interprets the result as an
|
8638
|
+
* unsigned, little-endian integer supporting up to 48 bits of accuracy.
|
8639
|
+
*
|
8640
|
+
* @param offset Number of bytes to skip before starting to read.
|
8641
|
+
* @param byteLength Number of bytes to read, between 0 and 6.
|
8642
|
+
* @param noAssert
|
8643
|
+
*/
|
8644
|
+
readUIntLE(offset: number, byteLength: number, noAssert?: boolean): number;
|
8645
|
+
/**
|
8646
|
+
* Reads `byteLength` number of bytes from `buf` at the specified `offset` and interprets the result as an
|
8647
|
+
* unsigned, big-endian integer supporting up to 48 bits of accuracy.
|
8648
|
+
*
|
8649
|
+
* @param offset Number of bytes to skip before starting to read.
|
8650
|
+
* @param byteLength Number of bytes to read, between 0 and 6.
|
8651
|
+
* @param noAssert
|
8652
|
+
*/
|
8653
|
+
readUIntBE(offset: number, byteLength: number, noAssert?: boolean): number;
|
8654
|
+
/**
|
8655
|
+
* Reads `byteLength` number of bytes from `buf` at the specified `offset` and interprets the result as a
|
8656
|
+
* little-endian, two's complement signed value supporting up to 48 bits of accuracy.
|
8657
|
+
*
|
8658
|
+
* @param offset Number of bytes to skip before starting to read.
|
8659
|
+
* @param byteLength Number of bytes to read, between 0 and 6.
|
8660
|
+
* @param noAssert
|
8661
|
+
*/
|
8662
|
+
readIntLE(offset: number, byteLength: number, noAssert?: boolean): number;
|
8663
|
+
/**
|
8664
|
+
* Reads `byteLength` number of bytes from `buf` at the specified `offset` and interprets the result as a
|
8665
|
+
* big-endian, two's complement signed value supporting up to 48 bits of accuracy.
|
8666
|
+
*
|
8667
|
+
* @param offset Number of bytes to skip before starting to read.
|
8668
|
+
* @param byteLength Number of bytes to read, between 0 and 6.
|
8669
|
+
* @param noAssert
|
8670
|
+
*/
|
8671
|
+
readIntBE(offset: number, byteLength: number, noAssert?: boolean): number;
|
8672
|
+
/**
|
8673
|
+
* Reads an unsigned 8-bit integer from `buf` at the specified `offset`.
|
8674
|
+
*
|
8675
|
+
* @param offset Number of bytes to skip before starting to read.
|
8676
|
+
* @param noAssert
|
8677
|
+
*/
|
8678
|
+
readUInt8(offset: number, noAssert?: boolean): number;
|
8679
|
+
/**
|
8680
|
+
* Reads an unsigned, little-endian 16-bit integer from `buf` at the specified `offset`.
|
8681
|
+
*
|
8682
|
+
* @param offset Number of bytes to skip before starting to read.
|
8683
|
+
* @param noAssert
|
8684
|
+
*/
|
8685
|
+
readUInt16LE(offset: number, noAssert?: boolean): number;
|
8686
|
+
/**
|
8687
|
+
* Reads an unsigned, big-endian 16-bit integer from `buf` at the specified `offset`.
|
8688
|
+
*
|
8689
|
+
* @param offset Number of bytes to skip before starting to read.
|
8690
|
+
* @param noAssert
|
8691
|
+
*/
|
8692
|
+
readUInt16BE(offset: number, noAssert?: boolean): number;
|
8693
|
+
/**
|
8694
|
+
* Reads an unsigned, little-endian 32-bit integer from `buf` at the specified `offset`.
|
8695
|
+
*
|
8696
|
+
* @param offset Number of bytes to skip before starting to read.
|
8697
|
+
* @param noAssert
|
8698
|
+
*/
|
8699
|
+
readUInt32LE(offset: number, noAssert?: boolean): number;
|
8700
|
+
/**
|
8701
|
+
* Reads an unsigned, big-endian 32-bit integer from `buf` at the specified `offset`.
|
8702
|
+
*
|
8703
|
+
* @param offset Number of bytes to skip before starting to read.
|
8704
|
+
* @param noAssert
|
8705
|
+
*/
|
8706
|
+
readUInt32BE(offset: number, noAssert?: boolean): number;
|
8707
|
+
/**
|
8708
|
+
* Reads a signed 8-bit integer from `buf` at the specified `offset`. Integers read from a `Buffer` are interpreted
|
8709
|
+
* as two's complement signed values.
|
8710
|
+
*
|
8711
|
+
* @param offset Number of bytes to skip before starting to read.
|
8712
|
+
* @param noAssert
|
8713
|
+
*/
|
8714
|
+
readInt8(offset: number, noAssert?: boolean): number;
|
8715
|
+
/**
|
8716
|
+
* Reads a signed, little-endian 16-bit integer from `buf` at the specified `offset`. Integers read from a `Buffer`
|
8717
|
+
* are interpreted as two's complement signed values.
|
8718
|
+
*
|
8719
|
+
* @param offset Number of bytes to skip before starting to read.
|
8720
|
+
* @param noAssert
|
8721
|
+
*/
|
8722
|
+
readInt16LE(offset: number, noAssert?: boolean): number;
|
8723
|
+
/**
|
8724
|
+
* Reads a signed, big-endian 16-bit integer from `buf` at the specified `offset`. Integers read from a `Buffer`
|
8725
|
+
* are interpreted as two's complement signed values.
|
8726
|
+
*
|
8727
|
+
* @param offset Number of bytes to skip before starting to read.
|
8728
|
+
* @param noAssert
|
8729
|
+
*/
|
8730
|
+
readInt16BE(offset: number, noAssert?: boolean): number;
|
8731
|
+
/**
|
8732
|
+
* Reads a signed, little-endian 32-bit integer from `buf` at the specified `offset`. Integers read from a `Buffer`
|
8733
|
+
* are interpreted as two's complement signed values.
|
8734
|
+
*
|
8735
|
+
* @param offset Number of bytes to skip before starting to read.
|
8736
|
+
* @param noAssert
|
8737
|
+
*/
|
8738
|
+
readInt32LE(offset: number, noAssert?: boolean): number;
|
8739
|
+
/**
|
8740
|
+
* Reads a signed, big-endian 32-bit integer from `buf` at the specified `offset`. Integers read from a `Buffer`
|
8741
|
+
* are interpreted as two's complement signed values.
|
8742
|
+
*
|
8743
|
+
* @param offset Number of bytes to skip before starting to read.
|
8744
|
+
* @param noAssert
|
8745
|
+
*/
|
8746
|
+
readInt32BE(offset: number, noAssert?: boolean): number;
|
8747
|
+
/**
|
8748
|
+
* Interprets `buf` as an array of unsigned 16-bit integers and swaps the byte order in-place.
|
8749
|
+
* Throws a `RangeError` if `buf.length` is not a multiple of 2.
|
8750
|
+
*/
|
8751
|
+
swap16(): Buffer;
|
8752
|
+
/**
|
8753
|
+
* Interprets `buf` as an array of unsigned 32-bit integers and swaps the byte order in-place.
|
8754
|
+
* Throws a `RangeError` if `buf.length` is not a multiple of 4.
|
8755
|
+
*/
|
8756
|
+
swap32(): Buffer;
|
8757
|
+
/**
|
8758
|
+
* Interprets `buf` as an array of unsigned 64-bit integers and swaps the byte order in-place.
|
8759
|
+
* Throws a `RangeError` if `buf.length` is not a multiple of 8.
|
8760
|
+
*/
|
8761
|
+
swap64(): Buffer;
|
8762
|
+
/**
|
8763
|
+
* Swaps two octets.
|
8764
|
+
*
|
8765
|
+
* @param b
|
8766
|
+
* @param n
|
8767
|
+
* @param m
|
8768
|
+
*/
|
8769
|
+
private _swap;
|
8770
|
+
/**
|
8771
|
+
* Writes `value` to `buf` at the specified `offset`. The `value` must be a valid unsigned 8-bit integer.
|
8772
|
+
* Behavior is undefined when `value` is anything other than an unsigned 8-bit integer.
|
8773
|
+
*
|
8774
|
+
* @param value Number to write.
|
8775
|
+
* @param offset Number of bytes to skip before starting to write.
|
8776
|
+
* @param noAssert
|
8777
|
+
* @returns `offset` plus the number of bytes written.
|
8778
|
+
*/
|
8779
|
+
writeUInt8(value: number, offset: number, noAssert?: boolean): number;
|
8780
|
+
/**
|
8781
|
+
* Writes `value` to `buf` at the specified `offset` as little-endian. The `value` must be a valid unsigned 16-bit
|
8782
|
+
* integer. Behavior is undefined when `value` is anything other than an unsigned 16-bit integer.
|
8783
|
+
*
|
8784
|
+
* @param value Number to write.
|
8785
|
+
* @param offset Number of bytes to skip before starting to write.
|
8786
|
+
* @param noAssert
|
8787
|
+
* @returns `offset` plus the number of bytes written.
|
8788
|
+
*/
|
8789
|
+
writeUInt16LE(value: number | string, offset: number, noAssert?: boolean): number;
|
8790
|
+
/**
|
8791
|
+
* Writes `value` to `buf` at the specified `offset` as big-endian. The `value` must be a valid unsigned 16-bit
|
8792
|
+
* integer. Behavior is undefined when `value` is anything other than an unsigned 16-bit integer.
|
8793
|
+
*
|
8794
|
+
* @param value Number to write.
|
8795
|
+
* @param offset Number of bytes to skip before starting to write.
|
8796
|
+
* @param noAssert
|
8797
|
+
* @returns `offset` plus the number of bytes written.
|
8798
|
+
*/
|
8799
|
+
writeUInt16BE(value: number, offset: number, noAssert?: boolean): number;
|
8800
|
+
/**
|
8801
|
+
* Writes `value` to `buf` at the specified `offset` as little-endian. The `value` must be a valid unsigned 32-bit
|
8802
|
+
* integer. Behavior is undefined when `value` is anything other than an unsigned 32-bit integer.
|
8803
|
+
*
|
8804
|
+
* @param value Number to write.
|
8805
|
+
* @param offset Number of bytes to skip before starting to write.
|
8806
|
+
* @param noAssert
|
8807
|
+
* @returns `offset` plus the number of bytes written.
|
8808
|
+
*/
|
8809
|
+
writeUInt32LE(value: number, offset: number, noAssert?: boolean): number;
|
8810
|
+
/**
|
8811
|
+
* Writes `value` to `buf` at the specified `offset` as big-endian. The `value` must be a valid unsigned 32-bit
|
8812
|
+
* integer. Behavior is undefined when `value` is anything other than an unsigned 32-bit integer.
|
8813
|
+
*
|
8814
|
+
* @param value Number to write.
|
8815
|
+
* @param offset Number of bytes to skip before starting to write.
|
8816
|
+
* @param noAssert
|
8817
|
+
* @returns `offset` plus the number of bytes written.
|
8818
|
+
*/
|
8819
|
+
writeUInt32BE(value: number, offset: number, noAssert?: boolean): number;
|
8820
|
+
/**
|
8821
|
+
* Writes `value` to `buf` at the specified `offset`. The `value` must be a valid signed 8-bit integer.
|
8822
|
+
* Behavior is undefined when `value` is anything other than a signed 8-bit integer.
|
8823
|
+
*
|
8824
|
+
* @param value Number to write.
|
8825
|
+
* @param offset Number of bytes to skip before starting to write.
|
8826
|
+
* @param noAssert
|
8827
|
+
* @returns `offset` plus the number of bytes written.
|
8828
|
+
*/
|
8829
|
+
writeInt8(value: number, offset: number, noAssert?: boolean): number;
|
8830
|
+
/**
|
8831
|
+
* Writes `value` to `buf` at the specified `offset` as little-endian. The `value` must be a valid signed 16-bit
|
8832
|
+
* integer. Behavior is undefined when `value` is anything other than a signed 16-bit integer.
|
8833
|
+
*
|
8834
|
+
* @param value Number to write.
|
8835
|
+
* @param offset Number of bytes to skip before starting to write.
|
8836
|
+
* @param noAssert
|
8837
|
+
* @returns `offset` plus the number of bytes written.
|
8838
|
+
*/
|
8839
|
+
writeInt16LE(value: number, offset: number, noAssert?: boolean): number;
|
8840
|
+
/**
|
8841
|
+
* Writes `value` to `buf` at the specified `offset` as big-endian. The `value` must be a valid signed 16-bit
|
8842
|
+
* integer. Behavior is undefined when `value` is anything other than a signed 16-bit integer.
|
8843
|
+
*
|
8844
|
+
* @param value Number to write.
|
8845
|
+
* @param offset Number of bytes to skip before starting to write.
|
8846
|
+
* @param noAssert
|
8847
|
+
* @returns `offset` plus the number of bytes written.
|
8848
|
+
*/
|
8849
|
+
writeInt16BE(value: number, offset: number, noAssert?: boolean): number;
|
8850
|
+
/**
|
8851
|
+
* Writes `value` to `buf` at the specified `offset` as little-endian. The `value` must be a valid signed 32-bit
|
8852
|
+
* integer. Behavior is undefined when `value` is anything other than a signed 32-bit integer.
|
8853
|
+
*
|
8854
|
+
* @param value Number to write.
|
8855
|
+
* @param offset Number of bytes to skip before starting to write.
|
8856
|
+
* @param noAssert
|
8857
|
+
* @returns `offset` plus the number of bytes written.
|
8858
|
+
*/
|
8859
|
+
writeInt32LE(value: number, offset: number, noAssert?: boolean): number;
|
8860
|
+
/**
|
8861
|
+
* Writes `value` to `buf` at the specified `offset` as big-endian. The `value` must be a valid signed 32-bit
|
8862
|
+
* integer. Behavior is undefined when `value` is anything other than a signed 32-bit integer.
|
8863
|
+
*
|
8864
|
+
* @param value Number to write.
|
8865
|
+
* @param offset Number of bytes to skip before starting to write.
|
8866
|
+
* @param noAssert
|
8867
|
+
* @returns `offset` plus the number of bytes written.
|
8868
|
+
*/
|
8869
|
+
writeInt32BE(value: number, offset: number, noAssert?: boolean): number;
|
8870
|
+
/**
|
8871
|
+
* Fills `buf` with the specified `value`. If the `offset` and `end` are not given, the entire `buf` will be
|
8872
|
+
* filled. The `value` is coerced to a `uint32` value if it is not a string, `Buffer`, or integer. If the resulting
|
8873
|
+
* integer is greater than `255` (decimal), then `buf` will be filled with `value & 255`.
|
8874
|
+
*
|
8875
|
+
* If the final write of a `fill()` operation falls on a multi-byte character, then only the bytes of that
|
8876
|
+
* character that fit into `buf` are written.
|
8877
|
+
*
|
8878
|
+
* If `value` contains invalid characters, it is truncated; if no valid fill data remains, an exception is thrown.
|
8879
|
+
*
|
8880
|
+
* @param value
|
8881
|
+
* @param encoding
|
8882
|
+
*/
|
8883
|
+
fill(value: any, offset?: number, end?: number, encoding?: Encoding): this;
|
8884
|
+
/**
|
8885
|
+
* Returns the index of the specified value.
|
8886
|
+
*
|
8887
|
+
* If `value` is:
|
8888
|
+
* - a string, `value` is interpreted according to the character encoding in `encoding`.
|
8889
|
+
* - a `Buffer` or `Uint8Array`, `value` will be used in its entirety. To compare a partial Buffer, use `slice()`.
|
8890
|
+
* - a number, `value` will be interpreted as an unsigned 8-bit integer value between `0` and `255`.
|
8891
|
+
*
|
8892
|
+
* Any other types will throw a `TypeError`.
|
8893
|
+
*
|
8894
|
+
* @param value What to search for.
|
8895
|
+
* @param byteOffset Where to begin searching in `buf`. If negative, then calculated from the end.
|
8896
|
+
* @param encoding If `value` is a string, this is the encoding used to search.
|
8897
|
+
* @returns The index of the first occurrence of `value` in `buf`, or `-1` if not found.
|
8898
|
+
*/
|
8899
|
+
indexOf(value: string | number | Buffer, byteOffset?: number, encoding?: Encoding): number;
|
8900
|
+
/**
|
8901
|
+
* Gets the last index of the specified value.
|
8902
|
+
*
|
8903
|
+
* @see indexOf()
|
8904
|
+
* @param value
|
8905
|
+
* @param byteOffset
|
8906
|
+
* @param encoding
|
8907
|
+
*/
|
8908
|
+
lastIndexOf(value: string | number | Buffer, byteOffset?: number, encoding?: Encoding): number;
|
8909
|
+
private _bidirectionalIndexOf;
|
8910
|
+
/**
|
8911
|
+
* Equivalent to `buf.indexOf() !== -1`.
|
8912
|
+
*
|
8913
|
+
* @param value
|
8914
|
+
* @param byteOffset
|
8915
|
+
* @param encoding
|
8916
|
+
*/
|
8917
|
+
includes(value: string | number | Buffer, byteOffset?: number, encoding?: Encoding): boolean;
|
8918
|
+
/**
|
8919
|
+
* Allocates a new Buffer using an `array` of octet values.
|
8920
|
+
*
|
8921
|
+
* @param array
|
8922
|
+
*/
|
8923
|
+
static from(array: number[]): Buffer;
|
8924
|
+
/**
|
8925
|
+
* When passed a reference to the .buffer property of a TypedArray instance, the newly created Buffer will share
|
8926
|
+
* the same allocated memory as the TypedArray. The optional `byteOffset` and `length` arguments specify a memory
|
8927
|
+
* range within the `arrayBuffer` that will be shared by the Buffer.
|
8928
|
+
*
|
8929
|
+
* @param buffer The .buffer property of a TypedArray or a new ArrayBuffer().
|
8930
|
+
* @param byteOffset
|
8931
|
+
* @param length
|
8932
|
+
*/
|
8933
|
+
static from(buffer: ArrayBuffer, byteOffset?: number, length?: number): Buffer;
|
8934
|
+
/**
|
8935
|
+
* Copies the passed `buffer` data onto a new Buffer instance.
|
8936
|
+
*
|
8937
|
+
* @param buffer
|
8938
|
+
*/
|
8939
|
+
static from(buffer: Buffer | Uint8Array): Buffer;
|
8940
|
+
/**
|
8941
|
+
* Creates a new Buffer containing the given string `str`. If provided, the `encoding` parameter identifies the
|
8942
|
+
* character encoding.
|
8943
|
+
*
|
8944
|
+
* @param str String to store in buffer.
|
8945
|
+
* @param encoding Encoding to use, optional. Default is `utf8`.
|
8946
|
+
*/
|
8947
|
+
static from(str: string, encoding?: Encoding): Buffer;
|
8948
|
+
/**
|
8949
|
+
* Returns true if `obj` is a Buffer.
|
8950
|
+
*
|
8951
|
+
* @param obj
|
8952
|
+
*/
|
8953
|
+
static isBuffer(obj: any): obj is Buffer;
|
8954
|
+
/**
|
8955
|
+
* Returns true if `encoding` is a supported encoding.
|
8956
|
+
*
|
8957
|
+
* @param encoding
|
8958
|
+
*/
|
8959
|
+
static isEncoding(encoding: string): encoding is Encoding;
|
8960
|
+
/**
|
8961
|
+
* Gives the actual byte length of a string for an encoding. This is not the same as `string.length` since that
|
8962
|
+
* returns the number of characters in the string.
|
8963
|
+
*
|
8964
|
+
* @param string The string to test.
|
8965
|
+
* @param encoding The encoding to use for calculation. Defaults is `utf8`.
|
8966
|
+
*/
|
8967
|
+
static byteLength(string: string | Buffer | ArrayBuffer, encoding?: Encoding): number;
|
8968
|
+
/**
|
8969
|
+
* Returns a Buffer which is the result of concatenating all the buffers in the list together.
|
8970
|
+
*
|
8971
|
+
* - If the list has no items, or if the `totalLength` is 0, then it returns a zero-length buffer.
|
8972
|
+
* - If the list has exactly one item, then the first item is returned.
|
8973
|
+
* - If the list has more than one item, then a new buffer is created.
|
8974
|
+
*
|
8975
|
+
* It is faster to provide the `totalLength` if it is known. However, it will be calculated if not provided at
|
8976
|
+
* a small computational expense.
|
8977
|
+
*
|
8978
|
+
* @param list An array of Buffer objects to concatenate.
|
8979
|
+
* @param totalLength Total length of the buffers when concatenated.
|
8980
|
+
*/
|
8981
|
+
static concat(list: Uint8Array[], totalLength?: number): Buffer;
|
8982
|
+
/**
|
8983
|
+
* The same as `buf1.compare(buf2)`.
|
8984
|
+
*/
|
8985
|
+
static compare(buf1: Uint8Array, buf2: Uint8Array): number;
|
8986
|
+
/**
|
8987
|
+
* Allocates a new buffer of `size` octets.
|
8988
|
+
*
|
8989
|
+
* @param size The number of octets to allocate.
|
8990
|
+
* @param fill If specified, the buffer will be initialized by calling `buf.fill(fill)`, or with zeroes otherwise.
|
8991
|
+
* @param encoding The encoding used for the call to `buf.fill()` while initializing.
|
8992
|
+
*/
|
8993
|
+
static alloc(size: number, fill?: string | Buffer | number, encoding?: Encoding): Buffer;
|
8994
|
+
/**
|
8995
|
+
* Allocates a new buffer of `size` octets without initializing memory. The contents of the buffer are unknown.
|
8996
|
+
*
|
8997
|
+
* @param size
|
8998
|
+
*/
|
8999
|
+
static allocUnsafe(size: number): Buffer;
|
9000
|
+
/**
|
9001
|
+
* Returns true if the given `obj` is an instance of `type`.
|
9002
|
+
*
|
9003
|
+
* @param obj
|
9004
|
+
* @param type
|
9005
|
+
*/
|
9006
|
+
private static _isInstance;
|
9007
|
+
private static _checked;
|
9008
|
+
private static _blitBuffer;
|
9009
|
+
private static _utf8Write;
|
9010
|
+
private static _asciiWrite;
|
9011
|
+
private static _base64Write;
|
9012
|
+
private static _ucs2Write;
|
9013
|
+
private static _hexWrite;
|
9014
|
+
private static _utf8ToBytes;
|
9015
|
+
private static _base64ToBytes;
|
9016
|
+
private static _asciiToBytes;
|
9017
|
+
private static _utf16leToBytes;
|
9018
|
+
private static _hexSlice;
|
9019
|
+
private static _base64Slice;
|
9020
|
+
private static _utf8Slice;
|
9021
|
+
private static _decodeCodePointsArray;
|
9022
|
+
private static _asciiSlice;
|
9023
|
+
private static _latin1Slice;
|
9024
|
+
private static _utf16leSlice;
|
9025
|
+
private static _arrayIndexOf;
|
9026
|
+
private static _checkOffset;
|
9027
|
+
private static _checkInt;
|
9028
|
+
private static _getEncoding;
|
9029
|
+
}
|
9030
|
+
/**
|
9031
|
+
* The encodings that are supported in both native and polyfilled `Buffer` instances.
|
9032
|
+
*/
|
9033
|
+
type Encoding = 'ascii' | 'utf8' | 'utf16le' | 'ucs2' | 'binary' | 'hex' | 'latin1' | 'base64';
|
9034
|
+
|
7120
9035
|
type XataFileEditableFields = Partial<Pick<XataArrayFile, keyof InputFileEntry>>;
|
7121
9036
|
type XataFileFields = Partial<Pick<XataArrayFile, {
|
7122
9037
|
[K in StringKeys<XataArrayFile>]: XataArrayFile[K] extends Function ? never : K;
|
@@ -7230,9 +9145,9 @@ type SelectedPick<O extends XataRecord, Key extends SelectableColumnWithObjectNo
|
|
7230
9145
|
};
|
7231
9146
|
};
|
7232
9147
|
}>>;
|
7233
|
-
type ValueAtColumn<
|
9148
|
+
type ValueAtColumn<Obj, Key, RecursivePath extends any[] = []> = RecursivePath['length'] extends MAX_RECURSION ? never : Key extends '*' ? Values<Obj> : Key extends 'id' ? string : Key extends 'xata.version' ? number : Key extends 'xata.createdAt' ? Date : Key extends 'xata.updatedAt' ? Date : Key extends keyof Obj ? Obj[Key] : Key extends `${infer K}.${infer V}` ? K extends keyof Obj ? Values<NonNullable<Obj[K]> extends infer Item ? Item extends Record<string, any> ? V extends SelectableColumn<Item> ? {
|
7234
9149
|
V: ValueAtColumn<Item, V, [...RecursivePath, Item]>;
|
7235
|
-
} : never :
|
9150
|
+
} : never : Obj[K] : never> : never : never;
|
7236
9151
|
type MAX_RECURSION = 3;
|
7237
9152
|
type NestedColumns<O, RecursivePath extends any[]> = RecursivePath['length'] extends MAX_RECURSION ? never : If<IsObject<O>, Values<{
|
7238
9153
|
[K in DataProps<O>]: NonNullable<O[K]> extends infer Item ? If<IsArray<Item>, Item extends (infer Type)[] ? Type extends XataArrayFile ? K | `${K}.${keyof XataFileFields | '*'}` : K | `${K}.${StringKeys<Type> | '*'}` : never, If<IsObject<Item>, Item extends XataRecord ? SelectableColumn<Item, [...RecursivePath, Item]> extends infer Column ? Column extends string ? K | `${K}.${Column}` : never : never : Item extends Date ? K : Item extends XataFile ? K | `${K}.${keyof XataFileFields | '*'}` : `${K}.${StringKeys<Item> | '*'}`, // This allows usage of objects that are not links
|
@@ -7363,13 +9278,13 @@ type XataRecordMetadata = {
|
|
7363
9278
|
declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
|
7364
9279
|
declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;
|
7365
9280
|
type NumericOperator = ExclusiveOr<{
|
7366
|
-
$increment
|
9281
|
+
$increment: number;
|
7367
9282
|
}, ExclusiveOr<{
|
7368
|
-
$decrement
|
9283
|
+
$decrement: number;
|
7369
9284
|
}, ExclusiveOr<{
|
7370
|
-
$multiply
|
9285
|
+
$multiply: number;
|
7371
9286
|
}, {
|
7372
|
-
$divide
|
9287
|
+
$divide: number;
|
7373
9288
|
}>>>;
|
7374
9289
|
type InputXataFile = Partial<XataArrayFile> | Promise<Partial<XataArrayFile>>;
|
7375
9290
|
type EditableDataFields<T> = T extends XataRecord ? {
|
@@ -7637,10 +9552,11 @@ type SearchPluginResult<Schemas extends Record<string, BaseData>> = {
|
|
7637
9552
|
declare class SearchPlugin<Schemas extends Record<string, XataRecord>> extends XataPlugin {
|
7638
9553
|
#private;
|
7639
9554
|
private db;
|
7640
|
-
constructor(db: SchemaPluginResult<Schemas
|
9555
|
+
constructor(db: SchemaPluginResult<Schemas>);
|
7641
9556
|
build(pluginOptions: XataPluginOptions): SearchPluginResult<Schemas>;
|
7642
9557
|
}
|
7643
|
-
type SearchXataRecord<Record extends XataRecord> = Omit<Record, 'getMetadata'> & {
|
9558
|
+
type SearchXataRecord<Record extends XataRecord> = Omit<Record, 'getMetadata' | 'xata'> & {
|
9559
|
+
xata: XataRecordMetadata & SearchExtraProperties;
|
7644
9560
|
getMetadata: () => XataRecordMetadata & SearchExtraProperties;
|
7645
9561
|
};
|
7646
9562
|
type SearchExtraProperties = {
|
@@ -7961,7 +9877,7 @@ type QueryOptions<T extends XataRecord> = BaseOptions<T> & (CursorQueryOptions |
|
|
7961
9877
|
declare class Query<Record extends XataRecord, Result extends XataRecord = Record> implements Paginable<Record, Result> {
|
7962
9878
|
#private;
|
7963
9879
|
readonly meta: PaginationQueryMeta;
|
7964
|
-
readonly records:
|
9880
|
+
readonly records: PageRecordArray<Result>;
|
7965
9881
|
constructor(repository: RestRepository<Record> | null, table: {
|
7966
9882
|
name: string;
|
7967
9883
|
schema?: Table;
|
@@ -8089,25 +10005,25 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
8089
10005
|
* Performs the query in the database and returns a set of results.
|
8090
10006
|
* @returns An array of records from the database.
|
8091
10007
|
*/
|
8092
|
-
getMany(): Promise<
|
10008
|
+
getMany(): Promise<PageRecordArray<Result>>;
|
8093
10009
|
/**
|
8094
10010
|
* Performs the query in the database and returns a set of results.
|
8095
10011
|
* @param options Additional options to be used when performing the query.
|
8096
10012
|
* @returns An array of records from the database.
|
8097
10013
|
*/
|
8098
|
-
getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<
|
10014
|
+
getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<PageRecordArray<SelectedPick<Record, (typeof options)['columns']>>>;
|
8099
10015
|
/**
|
8100
10016
|
* Performs the query in the database and returns a set of results.
|
8101
10017
|
* @param options Additional options to be used when performing the query.
|
8102
10018
|
* @returns An array of records from the database.
|
8103
10019
|
*/
|
8104
|
-
getMany(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<
|
10020
|
+
getMany(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<PageRecordArray<Result>>;
|
8105
10021
|
/**
|
8106
10022
|
* Performs the query in the database and returns all the results.
|
8107
10023
|
* Warning: If there are a large number of results, this method can have performance implications.
|
8108
10024
|
* @returns An array of records from the database.
|
8109
10025
|
*/
|
8110
|
-
getAll(): Promise<Result
|
10026
|
+
getAll(): Promise<RecordArray<Result>>;
|
8111
10027
|
/**
|
8112
10028
|
* Performs the query in the database and returns all the results.
|
8113
10029
|
* Warning: If there are a large number of results, this method can have performance implications.
|
@@ -8116,7 +10032,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
8116
10032
|
*/
|
8117
10033
|
getAll<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
|
8118
10034
|
batchSize?: number;
|
8119
|
-
}>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']
|
10035
|
+
}>(options: Options): Promise<RecordArray<SelectedPick<Record, (typeof options)['columns']>>>;
|
8120
10036
|
/**
|
8121
10037
|
* Performs the query in the database and returns all the results.
|
8122
10038
|
* Warning: If there are a large number of results, this method can have performance implications.
|
@@ -8125,7 +10041,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
8125
10041
|
*/
|
8126
10042
|
getAll(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'> & {
|
8127
10043
|
batchSize?: number;
|
8128
|
-
}): Promise<Result
|
10044
|
+
}): Promise<RecordArray<Result>>;
|
8129
10045
|
/**
|
8130
10046
|
* Performs the query in the database and returns the first result.
|
8131
10047
|
* @returns The first record that matches the query, or null if no record matched the query.
|
@@ -8209,7 +10125,7 @@ type PaginationQueryMeta = {
|
|
8209
10125
|
};
|
8210
10126
|
interface Paginable<Record extends XataRecord, Result extends XataRecord = Record> {
|
8211
10127
|
meta: PaginationQueryMeta;
|
8212
|
-
records:
|
10128
|
+
records: PageRecordArray<Result>;
|
8213
10129
|
nextPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
8214
10130
|
previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
8215
10131
|
startPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
@@ -8229,7 +10145,7 @@ declare class Page<Record extends XataRecord, Result extends XataRecord = Record
|
|
8229
10145
|
/**
|
8230
10146
|
* The set of results for this page.
|
8231
10147
|
*/
|
8232
|
-
readonly records:
|
10148
|
+
readonly records: PageRecordArray<Result>;
|
8233
10149
|
constructor(query: Query<Record, Result>, meta: PaginationQueryMeta, records?: Result[]);
|
8234
10150
|
/**
|
8235
10151
|
* Retrieves the next page of results.
|
@@ -8283,6 +10199,14 @@ declare const PAGINATION_MAX_OFFSET = 49000;
|
|
8283
10199
|
declare const PAGINATION_DEFAULT_OFFSET = 0;
|
8284
10200
|
declare function isCursorPaginationOptions(options: Record<string, unknown> | undefined | null): options is CursorNavigationOptions;
|
8285
10201
|
declare class RecordArray<Result extends XataRecord> extends Array<Result> {
|
10202
|
+
constructor(overrideRecords?: Result[]);
|
10203
|
+
static parseConstructorParams(...args: any[]): any[];
|
10204
|
+
toArray(): Result[];
|
10205
|
+
toSerializable(): JSONData<Result>[];
|
10206
|
+
toString(): string;
|
10207
|
+
map<U>(callbackfn: (value: Result, index: number, array: Result[]) => U, thisArg?: any): U[];
|
10208
|
+
}
|
10209
|
+
declare class PageRecordArray<Result extends XataRecord> extends Array<Result> {
|
8286
10210
|
#private;
|
8287
10211
|
constructor(page: Paginable<any, Result>, overrideRecords?: Result[]);
|
8288
10212
|
static parseConstructorParams(...args: any[]): any[];
|
@@ -8295,25 +10219,25 @@ declare class RecordArray<Result extends XataRecord> extends Array<Result> {
|
|
8295
10219
|
*
|
8296
10220
|
* @returns A new array of objects
|
8297
10221
|
*/
|
8298
|
-
nextPage(size?: number, offset?: number): Promise<
|
10222
|
+
nextPage(size?: number, offset?: number): Promise<PageRecordArray<Result>>;
|
8299
10223
|
/**
|
8300
10224
|
* Retrieve previous page of records
|
8301
10225
|
*
|
8302
10226
|
* @returns A new array of objects
|
8303
10227
|
*/
|
8304
|
-
previousPage(size?: number, offset?: number): Promise<
|
10228
|
+
previousPage(size?: number, offset?: number): Promise<PageRecordArray<Result>>;
|
8305
10229
|
/**
|
8306
10230
|
* Retrieve start page of records
|
8307
10231
|
*
|
8308
10232
|
* @returns A new array of objects
|
8309
10233
|
*/
|
8310
|
-
startPage(size?: number, offset?: number): Promise<
|
10234
|
+
startPage(size?: number, offset?: number): Promise<PageRecordArray<Result>>;
|
8311
10235
|
/**
|
8312
10236
|
* Retrieve end page of records
|
8313
10237
|
*
|
8314
10238
|
* @returns A new array of objects
|
8315
10239
|
*/
|
8316
|
-
endPage(size?: number, offset?: number): Promise<
|
10240
|
+
endPage(size?: number, offset?: number): Promise<PageRecordArray<Result>>;
|
8317
10241
|
/**
|
8318
10242
|
* @returns Boolean indicating if there is a next page
|
8319
10243
|
*/
|
@@ -9050,7 +10974,7 @@ type PropertyType<Tables, Properties, PropertyName extends PropertyKey> = Proper
|
|
9050
10974
|
} : {
|
9051
10975
|
[K in PropertyName]?: InnerType<Type, Tables, LinkedTable> | null;
|
9052
10976
|
} : never : never;
|
9053
|
-
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 :
|
10977
|
+
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;
|
9054
10978
|
|
9055
10979
|
/**
|
9056
10980
|
* Operator to restrict results to only values that are greater than the given value.
|
@@ -9103,11 +11027,11 @@ declare const le: <T extends ComparableType>(value: T) => ComparableTypeFilter<T
|
|
9103
11027
|
/**
|
9104
11028
|
* Operator to restrict results to only values that are not null.
|
9105
11029
|
*/
|
9106
|
-
declare const exists: <T>(column?: FilterColumns<T>
|
11030
|
+
declare const exists: <T>(column?: FilterColumns<T>) => ExistanceFilter<T>;
|
9107
11031
|
/**
|
9108
11032
|
* Operator to restrict results to only values that are null.
|
9109
11033
|
*/
|
9110
|
-
declare const notExists: <T>(column?: FilterColumns<T>
|
11034
|
+
declare const notExists: <T>(column?: FilterColumns<T>) => ExistanceFilter<T>;
|
9111
11035
|
/**
|
9112
11036
|
* Operator to restrict results to only values that start with the given prefix.
|
9113
11037
|
*/
|
@@ -9169,7 +11093,7 @@ type SchemaPluginResult<Schemas extends Record<string, XataRecord>> = {
|
|
9169
11093
|
};
|
9170
11094
|
declare class SchemaPlugin<Schemas extends Record<string, XataRecord>> extends XataPlugin {
|
9171
11095
|
#private;
|
9172
|
-
constructor(
|
11096
|
+
constructor();
|
9173
11097
|
build(pluginOptions: XataPluginOptions): SchemaPluginResult<Schemas>;
|
9174
11098
|
}
|
9175
11099
|
|
@@ -9210,18 +11134,112 @@ declare class FilesPlugin<Schemas extends Record<string, XataRecord>> extends Xa
|
|
9210
11134
|
}
|
9211
11135
|
|
9212
11136
|
type SQLQueryParams<T = any[]> = {
|
11137
|
+
/**
|
11138
|
+
* The SQL statement to execute.
|
11139
|
+
* @example
|
11140
|
+
* ```ts
|
11141
|
+
* const { records } = await xata.sql<TeamsRecord>({
|
11142
|
+
* statement: `SELECT * FROM teams WHERE name = $1`,
|
11143
|
+
* params: ['A name']
|
11144
|
+
* });
|
11145
|
+
* ```
|
11146
|
+
*
|
11147
|
+
* Be careful when using this with user input and use parametrized statements to avoid SQL injection.
|
11148
|
+
*/
|
9213
11149
|
statement: string;
|
11150
|
+
/**
|
11151
|
+
* The parameters to pass to the SQL statement.
|
11152
|
+
*/
|
9214
11153
|
params?: T;
|
11154
|
+
/**
|
11155
|
+
* The consistency level to use when executing the query.
|
11156
|
+
* @default 'strong'
|
11157
|
+
*/
|
11158
|
+
consistency?: 'strong' | 'eventual';
|
11159
|
+
/**
|
11160
|
+
* The response type to use when executing the query.
|
11161
|
+
* @default 'json'
|
11162
|
+
*/
|
11163
|
+
responseType?: 'json' | 'array';
|
11164
|
+
};
|
11165
|
+
type SQLBatchQuery = {
|
11166
|
+
/**
|
11167
|
+
* The SQL statements to execute.
|
11168
|
+
*/
|
11169
|
+
statements: {
|
11170
|
+
/**
|
11171
|
+
* The SQL statement to execute.
|
11172
|
+
*/
|
11173
|
+
statement: string;
|
11174
|
+
/**
|
11175
|
+
* The parameters to pass to the SQL statement.
|
11176
|
+
*/
|
11177
|
+
params?: any[];
|
11178
|
+
}[];
|
11179
|
+
/**
|
11180
|
+
* The consistency level to use when executing the queries.
|
11181
|
+
* @default 'strong'
|
11182
|
+
*/
|
9215
11183
|
consistency?: 'strong' | 'eventual';
|
11184
|
+
/**
|
11185
|
+
* The response type to use when executing the queries.
|
11186
|
+
* @default 'json'
|
11187
|
+
*/
|
11188
|
+
responseType?: 'json' | 'array';
|
9216
11189
|
};
|
9217
|
-
type SQLQuery = TemplateStringsArray | SQLQueryParams
|
9218
|
-
type
|
11190
|
+
type SQLQuery = TemplateStringsArray | SQLQueryParams;
|
11191
|
+
type SQLResponseType = 'json' | 'array';
|
11192
|
+
type SQLQueryResultJSON<T> = {
|
11193
|
+
/**
|
11194
|
+
* The records returned by the query.
|
11195
|
+
*/
|
9219
11196
|
records: T[];
|
9220
|
-
|
9221
|
-
|
11197
|
+
/**
|
11198
|
+
* The columns metadata returned by the query.
|
11199
|
+
*/
|
11200
|
+
columns: Array<{
|
11201
|
+
name: string;
|
11202
|
+
type: string;
|
9222
11203
|
}>;
|
11204
|
+
/**
|
11205
|
+
* Optional warning message returned by the query.
|
11206
|
+
*/
|
9223
11207
|
warning?: string;
|
9224
|
-
}
|
11208
|
+
};
|
11209
|
+
type SQLQueryResultArray = {
|
11210
|
+
/**
|
11211
|
+
* The records returned by the query.
|
11212
|
+
*/
|
11213
|
+
rows: any[][];
|
11214
|
+
/**
|
11215
|
+
* The columns metadata returned by the query.
|
11216
|
+
*/
|
11217
|
+
columns: Array<{
|
11218
|
+
name: string;
|
11219
|
+
type: string;
|
11220
|
+
}>;
|
11221
|
+
/**
|
11222
|
+
* Optional warning message returned by the query.
|
11223
|
+
*/
|
11224
|
+
warning?: string;
|
11225
|
+
};
|
11226
|
+
type SQLQueryResult<T, Mode extends SQLResponseType = 'json'> = Mode extends 'json' ? SQLQueryResultJSON<T> : Mode extends 'array' ? SQLQueryResultArray : never;
|
11227
|
+
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'>>;
|
11228
|
+
type SQLPluginResult = SQLPluginFunction & {
|
11229
|
+
/**
|
11230
|
+
* Connection string to use when connecting to the database.
|
11231
|
+
* It includes the workspace, region, database and branch.
|
11232
|
+
* Connects with the same credentials as the Xata client.
|
11233
|
+
*/
|
11234
|
+
connectionString: string;
|
11235
|
+
/**
|
11236
|
+
* Executes a batch of SQL statements.
|
11237
|
+
* @param query The batch of SQL statements to execute.
|
11238
|
+
*/
|
11239
|
+
batch: <Query extends SQLBatchQuery = SQLBatchQuery>(query: Query) => Promise<{
|
11240
|
+
results: Array<SQLQueryResult<any, Query extends SQLBatchQuery ? Query['responseType'] extends SQLResponseType ? NonNullable<Query['responseType']> : 'json' : 'json'>>;
|
11241
|
+
}>;
|
11242
|
+
};
|
9225
11243
|
declare class SQLPlugin extends XataPlugin {
|
9226
11244
|
build(pluginOptions: XataPluginOptions): SQLPluginResult;
|
9227
11245
|
}
|
@@ -9337,7 +11355,7 @@ type BaseClientOptions = {
|
|
9337
11355
|
clientName?: string;
|
9338
11356
|
xataAgentExtra?: Record<string, string>;
|
9339
11357
|
};
|
9340
|
-
declare const buildClient: <Plugins extends Record<string, XataPlugin> = {}>(plugins?: Plugins
|
11358
|
+
declare const buildClient: <Plugins extends Record<string, XataPlugin> = {}>(plugins?: Plugins) => ClientConstructor<Plugins>;
|
9341
11359
|
interface ClientConstructor<Plugins extends Record<string, XataPlugin>> {
|
9342
11360
|
new <Schemas extends Record<string, XataRecord> = {}>(options?: Partial<BaseClientOptions>, schemaTables?: readonly BaseSchema[]): Omit<{
|
9343
11361
|
db: Awaited<ReturnType<SchemaPlugin<Schemas>['build']>>;
|
@@ -9388,4 +11406,4 @@ declare class XataError extends Error {
|
|
9388
11406
|
constructor(message: string, status: number);
|
9389
11407
|
}
|
9390
11408
|
|
9391
|
-
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 };
|
11409
|
+
export { type AcceptWorkspaceMemberInviteError, type AcceptWorkspaceMemberInvitePathParams, type AcceptWorkspaceMemberInviteVariables, type AdaptAllTablesError, type AdaptAllTablesPathParams, type AdaptAllTablesVariables, type AdaptTableError, type AdaptTablePathParams, type AdaptTableVariables, type AddGitBranchesEntryError, type AddGitBranchesEntryPathParams, type AddGitBranchesEntryRequestBody, type AddGitBranchesEntryResponse, type AddGitBranchesEntryVariables, type AddTableColumnError, type AddTableColumnPathParams, type AddTableColumnVariables, type AggregateTableError, type AggregateTablePathParams, type AggregateTableRequestBody, type AggregateTableVariables, type ApiExtraProps, type ApplyBranchSchemaEditError, type ApplyBranchSchemaEditPathParams, type ApplyBranchSchemaEditRequestBody, type ApplyBranchSchemaEditVariables, type ApplyMigrationError, type ApplyMigrationPathParams, type ApplyMigrationRequestBody, type ApplyMigrationVariables, type AskOptions, type AskResult, type AskTableError, type AskTablePathParams, type AskTableRequestBody, type AskTableResponse, type AskTableSessionError, type AskTableSessionPathParams, type AskTableSessionRequestBody, type AskTableSessionResponse, type AskTableSessionVariables, type AskTableVariables, BaseClient, type BaseClientOptions, type BaseData, type BaseSchema, type BinaryFile, type BranchTransactionError, type BranchTransactionPathParams, type BranchTransactionRequestBody, type BranchTransactionVariables, Buffer, type BulkInsertTableRecordsError, type BulkInsertTableRecordsPathParams, type BulkInsertTableRecordsQueryParams, type BulkInsertTableRecordsRequestBody, type BulkInsertTableRecordsVariables, type CacheImpl, type CancelWorkspaceMemberInviteError, type CancelWorkspaceMemberInvitePathParams, type CancelWorkspaceMemberInviteVariables, type ClientConstructor, type ColumnsByValue, type CompareBranchSchemasError, type CompareBranchSchemasPathParams, type CompareBranchSchemasRequestBody, type CompareBranchSchemasVariables, type CompareBranchWithUserSchemaError, type CompareBranchWithUserSchemaPathParams, type CompareBranchWithUserSchemaRequestBody, type CompareBranchWithUserSchemaVariables, type CompareMigrationRequestError, type CompareMigrationRequestPathParams, type CompareMigrationRequestVariables, type CompleteMigrationError, type CompleteMigrationPathParams, type CompleteMigrationRequestBody, type CompleteMigrationVariables, type CopyBranchError, type CopyBranchPathParams, type CopyBranchRequestBody, type CopyBranchVariables, type CreateBranchAsyncError, type CreateBranchAsyncPathParams, type CreateBranchAsyncQueryParams, type CreateBranchAsyncRequestBody, type CreateBranchAsyncVariables, type CreateBranchError, type CreateBranchPathParams, type CreateBranchQueryParams, type CreateBranchRequestBody, type CreateBranchResponse, type CreateBranchVariables, type CreateClusterError, type CreateClusterPathParams, type CreateClusterVariables, type CreateDatabaseError, type CreateDatabasePathParams, type CreateDatabaseRequestBody, type CreateDatabaseResponse, type CreateDatabaseVariables, type CreateMigrationRequestError, type CreateMigrationRequestPathParams, type CreateMigrationRequestRequestBody, type CreateMigrationRequestResponse, type CreateMigrationRequestVariables, type CreateTableError, type CreateTablePathParams, type CreateTableResponse, type CreateTableVariables, type CreateUserAPIKeyError, type CreateUserAPIKeyPathParams, type CreateUserAPIKeyResponse, type CreateUserAPIKeyVariables, type CreateWorkspaceError, type CreateWorkspaceVariables, type CursorNavigationOptions, type DeleteBranchError, type DeleteBranchPathParams, type DeleteBranchResponse, type DeleteBranchVariables, type DeleteClusterError, type DeleteClusterPathParams, type DeleteClusterVariables, type DeleteColumnError, type DeleteColumnPathParams, type DeleteColumnVariables, type DeleteDatabaseError, type DeleteDatabaseGithubSettingsError, type DeleteDatabaseGithubSettingsPathParams, type DeleteDatabaseGithubSettingsVariables, type DeleteDatabasePathParams, type DeleteDatabaseResponse, type DeleteDatabaseVariables, type DeleteFileError, type DeleteFileItemError, type DeleteFileItemPathParams, type DeleteFileItemVariables, type DeleteFilePathParams, type DeleteFileVariables, type DeleteOAuthAccessTokenError, type DeleteOAuthAccessTokenPathParams, type DeleteOAuthAccessTokenVariables, type DeleteRecordError, type DeleteRecordPathParams, type DeleteRecordQueryParams, type DeleteRecordVariables, type DeleteTableError, type DeleteTablePathParams, type DeleteTableResponse, type DeleteTableVariables, type DeleteTransactionOperation, type DeleteUserAPIKeyError, type DeleteUserAPIKeyPathParams, type DeleteUserAPIKeyVariables, type DeleteUserError, type DeleteUserOAuthClientError, type DeleteUserOAuthClientPathParams, type DeleteUserOAuthClientVariables, type DeleteUserVariables, type DeleteWorkspaceError, type DeleteWorkspacePathParams, type DeleteWorkspaceVariables, type DeserializedType, type DownloadDestination, type DropClusterExtensionError, type DropClusterExtensionPathParams, type DropClusterExtensionRequestBody, type DropClusterExtensionVariables, type EditableData, type ExecuteBranchMigrationPlanError, type ExecuteBranchMigrationPlanPathParams, type ExecuteBranchMigrationPlanRequestBody, type ExecuteBranchMigrationPlanVariables, type FetchImpl, FetcherError, type FetcherExtraProps, type FileAccessError, type FileAccessPathParams, type FileAccessQueryParams, type FileAccessVariables, type FileUploadError, type FileUploadPathParams, type FileUploadQueryParams, type FileUploadVariables, FilesPlugin, type FilesPluginResult, type GetAuthorizationCodeError, type GetAuthorizationCodeQueryParams, type GetAuthorizationCodeVariables, type GetBranchDetailsError, type GetBranchDetailsPathParams, type GetBranchDetailsVariables, type GetBranchListError, type GetBranchListPathParams, type GetBranchListVariables, type GetBranchMetadataError, type GetBranchMetadataPathParams, type GetBranchMetadataVariables, type GetBranchMigrationHistoryError, type GetBranchMigrationHistoryPathParams, type GetBranchMigrationHistoryRequestBody, type GetBranchMigrationHistoryResponse, type GetBranchMigrationHistoryVariables, type GetBranchMigrationJobStatusError, type GetBranchMigrationJobStatusPathParams, type GetBranchMigrationJobStatusVariables, type GetBranchMigrationPlanError, type GetBranchMigrationPlanPathParams, type GetBranchMigrationPlanVariables, type GetBranchMoveStatusError, type GetBranchMoveStatusPathParams, type GetBranchMoveStatusResponse, type GetBranchMoveStatusVariables, type GetBranchSchemaHistoryError, type GetBranchSchemaHistoryPathParams, type GetBranchSchemaHistoryRequestBody, type GetBranchSchemaHistoryResponse, type GetBranchSchemaHistoryVariables, type GetBranchStatsError, type GetBranchStatsPathParams, type GetBranchStatsResponse, type GetBranchStatsVariables, type GetClusterError, type GetClusterMetricsError, type GetClusterMetricsPathParams, type GetClusterMetricsQueryParams, type GetClusterMetricsVariables, type GetClusterPathParams, type GetClusterVariables, type GetColumnError, type GetColumnPathParams, type GetColumnVariables, type GetDatabaseGithubSettingsError, type GetDatabaseGithubSettingsPathParams, type GetDatabaseGithubSettingsVariables, type GetDatabaseListError, type GetDatabaseListPathParams, type GetDatabaseListVariables, type GetDatabaseMetadataError, type GetDatabaseMetadataPathParams, type GetDatabaseMetadataVariables, type GetDatabaseSettingsError, type GetDatabaseSettingsPathParams, type GetDatabaseSettingsVariables, type GetFileError, type GetFileItemError, type GetFileItemPathParams, type GetFileItemVariables, type GetFilePathParams, type GetFileVariables, type GetGitBranchesMappingError, type GetGitBranchesMappingPathParams, type GetGitBranchesMappingVariables, type GetMigrationHistoryError, type GetMigrationHistoryPathParams, type GetMigrationHistoryQueryParams, type GetMigrationHistoryVariables, type GetMigrationJobStatusError, type GetMigrationJobStatusPathParams, type GetMigrationJobStatusVariables, type GetMigrationJobsError, type GetMigrationJobsPathParams, type GetMigrationJobsQueryParams, type GetMigrationJobsVariables, type GetMigrationRequestError, type GetMigrationRequestIsMergedError, type GetMigrationRequestIsMergedPathParams, type GetMigrationRequestIsMergedResponse, type GetMigrationRequestIsMergedVariables, type GetMigrationRequestPathParams, type GetMigrationRequestVariables, type GetRecordError, type GetRecordPathParams, type GetRecordQueryParams, type GetRecordVariables, type GetSchemaError, type GetSchemaPathParams, type GetSchemaResponse, type GetSchemaVariables, type GetSchemasError, type GetSchemasPathParams, type GetSchemasResponse, type GetSchemasVariables, type GetTableColumnsError, type GetTableColumnsPathParams, type GetTableColumnsResponse, type GetTableColumnsVariables, type GetTableSchemaError, type GetTableSchemaPathParams, type GetTableSchemaResponse, type GetTableSchemaVariables, type GetTaskStatusError, type GetTaskStatusPathParams, type GetTaskStatusVariables, type GetTasksError, type GetTasksPathParams, type GetTasksResponse, type GetTasksVariables, type GetTransactionOperation, type GetUserAPIKeysError, type GetUserAPIKeysResponse, type GetUserAPIKeysVariables, type GetUserError, type GetUserOAuthAccessTokensError, type GetUserOAuthAccessTokensResponse, type GetUserOAuthAccessTokensVariables, type GetUserOAuthClientsError, type GetUserOAuthClientsResponse, type GetUserOAuthClientsVariables, type GetUserVariables, type GetWorkspaceError, type GetWorkspaceMembersListError, type GetWorkspaceMembersListPathParams, type GetWorkspaceMembersListVariables, type GetWorkspacePathParams, type GetWorkspaceSettingsError, type GetWorkspaceSettingsPathParams, type GetWorkspaceSettingsVariables, type GetWorkspaceVariables, type GetWorkspacesListError, type GetWorkspacesListResponse, type GetWorkspacesListVariables, type GrantAuthorizationCodeError, type GrantAuthorizationCodeVariables, type HostProvider, type Identifiable, type ImageTransformations, type InsertRecordError, type InsertRecordPathParams, type InsertRecordQueryParams, type InsertRecordVariables, type InsertRecordWithIDError, type InsertRecordWithIDPathParams, type InsertRecordWithIDQueryParams, type InsertRecordWithIDVariables, type InsertTransactionOperation, type InstallClusterExtensionError, type InstallClusterExtensionPathParams, type InstallClusterExtensionRequestBody, type InstallClusterExtensionVariables, type InviteWorkspaceMemberError, type InviteWorkspaceMemberPathParams, type InviteWorkspaceMemberRequestBody, type InviteWorkspaceMemberVariables, type JSONData, type KeywordAskOptions, type Link, type ListClusterBranchesError, type ListClusterBranchesPathParams, type ListClusterBranchesQueryParams, type ListClusterBranchesVariables, type ListClusterExtensionsError, type ListClusterExtensionsPathParams, type ListClusterExtensionsQueryParams, type ListClusterExtensionsVariables, type ListClustersError, type ListClustersPathParams, type ListClustersQueryParams, type ListClustersVariables, type ListMigrationRequestsCommitsError, type ListMigrationRequestsCommitsPathParams, type ListMigrationRequestsCommitsRequestBody, type ListMigrationRequestsCommitsResponse, type ListMigrationRequestsCommitsVariables, type ListRegionsError, type ListRegionsPathParams, type ListRegionsVariables, type MergeMigrationRequestError, type MergeMigrationRequestPathParams, type MergeMigrationRequestVariables, type MoveBranchError, type MoveBranchPathParams, type MoveBranchRequestBody, type MoveBranchResponse, type MoveBranchVariables, type OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, PageRecordArray, type Paginable, type PaginationQueryMeta, type PreviewBranchSchemaEditError, type PreviewBranchSchemaEditPathParams, type PreviewBranchSchemaEditRequestBody, type PreviewBranchSchemaEditResponse, type PreviewBranchSchemaEditVariables, type PushBranchMigrationsError, type PushBranchMigrationsPathParams, type PushBranchMigrationsRequestBody, type PushBranchMigrationsVariables, type PutFileError, type PutFileItemError, type PutFileItemPathParams, type PutFileItemVariables, type PutFilePathParams, type PutFileVariables, Query, type QueryMigrationRequestsError, type QueryMigrationRequestsPathParams, type QueryMigrationRequestsRequestBody, type QueryMigrationRequestsResponse, type QueryMigrationRequestsVariables, type QueryTableError, type QueryTablePathParams, type QueryTableRequestBody, type QueryTableVariables, RecordArray, RecordColumnTypes, type RemoveGitBranchesEntryError, type RemoveGitBranchesEntryPathParams, type RemoveGitBranchesEntryQueryParams, type RemoveGitBranchesEntryVariables, type RemoveWorkspaceMemberError, type RemoveWorkspaceMemberPathParams, type RemoveWorkspaceMemberVariables, type RenameDatabaseError, type RenameDatabasePathParams, type RenameDatabaseRequestBody, type RenameDatabaseVariables, Repository, type ResendWorkspaceMemberInviteError, type ResendWorkspaceMemberInvitePathParams, type ResendWorkspaceMemberInviteVariables, type ResolveBranchError, type ResolveBranchPathParams, type ResolveBranchQueryParams, type ResolveBranchResponse, type ResolveBranchVariables, responses as Responses, RestRepository, type RollbackMigrationError, type RollbackMigrationPathParams, type RollbackMigrationRequestBody, type RollbackMigrationVariables, type SQLBatchQuery, SQLPlugin, type SQLPluginResult, type SQLQuery, type SQLQueryParams, type SQLQueryResult, type SchemaDefinition, type SchemaInference, SchemaPlugin, type SchemaPluginResult, schemas as Schemas, type SearchBranchError, type SearchBranchPathParams, type SearchBranchRequestBody, type SearchBranchVariables, type SearchOptions, SearchPlugin, type SearchPluginResult, type SearchTableError, type SearchTablePathParams, type SearchTableRequestBody, type SearchTableVariables, type SearchXataRecord, type SelectableColumn, type SelectableColumnWithObjectNotation, type SelectedPick, type SerializedString, Serializer, type SerializerResult, type SetTableSchemaError, type SetTableSchemaPathParams, type SetTableSchemaRequestBody, type SetTableSchemaVariables, SimpleCache, type SimpleCacheOptions, type SqlBatchQueryError, type SqlBatchQueryPathParams, type SqlBatchQueryRequestBody, type SqlBatchQueryVariables, type SqlQueryError, type SqlQueryPathParams, type SqlQueryRequestBody, type SqlQueryVariables, type StartMigrationError, type StartMigrationPathParams, type StartMigrationRequestBody, type StartMigrationVariables, type SummarizeTableError, type SummarizeTablePathParams, type SummarizeTableRequestBody, type SummarizeTableVariables, type TotalCount, type TransactionOperation, TransactionPlugin, type TransactionPluginResult, type TransactionResults, type UpdateBranchMetadataError, type UpdateBranchMetadataPathParams, type UpdateBranchMetadataVariables, type UpdateBranchSchemaError, type UpdateBranchSchemaPathParams, type UpdateBranchSchemaVariables, type UpdateClusterError, type UpdateClusterPathParams, type UpdateClusterVariables, type UpdateColumnError, type UpdateColumnPathParams, type UpdateColumnRequestBody, type UpdateColumnVariables, type UpdateDatabaseGithubSettingsError, type UpdateDatabaseGithubSettingsPathParams, type UpdateDatabaseGithubSettingsVariables, type UpdateDatabaseMetadataError, type UpdateDatabaseMetadataPathParams, type UpdateDatabaseMetadataRequestBody, type UpdateDatabaseMetadataVariables, type UpdateDatabaseSettingsError, type UpdateDatabaseSettingsPathParams, type UpdateDatabaseSettingsRequestBody, type UpdateDatabaseSettingsVariables, type UpdateMigrationRequestError, type UpdateMigrationRequestPathParams, type UpdateMigrationRequestRequestBody, type UpdateMigrationRequestVariables, type UpdateOAuthAccessTokenError, type UpdateOAuthAccessTokenPathParams, type UpdateOAuthAccessTokenRequestBody, type UpdateOAuthAccessTokenVariables, type UpdateRecordWithIDError, type UpdateRecordWithIDPathParams, type UpdateRecordWithIDQueryParams, type UpdateRecordWithIDVariables, type UpdateTableError, type UpdateTablePathParams, type UpdateTableRequestBody, type UpdateTableVariables, type UpdateTransactionOperation, type UpdateUserError, type UpdateUserVariables, type UpdateWorkspaceError, type UpdateWorkspaceMemberInviteError, type UpdateWorkspaceMemberInvitePathParams, type UpdateWorkspaceMemberInviteRequestBody, type UpdateWorkspaceMemberInviteVariables, type UpdateWorkspaceMemberRoleError, type UpdateWorkspaceMemberRolePathParams, type UpdateWorkspaceMemberRoleRequestBody, type UpdateWorkspaceMemberRoleVariables, type UpdateWorkspacePathParams, type UpdateWorkspaceSettingsError, type UpdateWorkspaceSettingsPathParams, type UpdateWorkspaceSettingsVariables, type UpdateWorkspaceVariables, type UploadDestination, type UpsertRecordWithIDError, type UpsertRecordWithIDPathParams, type UpsertRecordWithIDQueryParams, type UpsertRecordWithIDVariables, type ValueAtColumn, type VectorAskOptions, type VectorSearchTableError, type VectorSearchTablePathParams, type VectorSearchTableRequestBody, type VectorSearchTableVariables, XataApiClient, type XataApiClientOptions, XataApiPlugin, type XataArrayFile, XataError, XataFile, XataPlugin, type XataPluginOptions, type XataRecord, acceptWorkspaceMemberInvite, adaptAllTables, adaptTable, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, applyMigration, askTable, askTableSession, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, completeMigration, contains, copyBranch, createBranch, createBranchAsync, createCluster, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteCluster, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteFile, deleteFileItem, deleteOAuthAccessToken, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteUserOAuthClient, deleteWorkspace, deserialize, dropClusterExtension, endsWith, equals, executeBranchMigrationPlan, exists, fileAccess, fileUpload, ge, getAPIKey, getAuthorizationCode, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationJobStatus, getBranchMigrationPlan, getBranchMoveStatus, getBranchSchemaHistory, getBranchStats, getCluster, getClusterMetrics, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseSettings, getDatabaseURL, getFile, getFileItem, getGitBranchesMapping, getHostUrl, getMigrationHistory, getMigrationJobStatus, getMigrationJobs, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, getRecord, getSchema, getSchemas, getTableColumns, getTableSchema, getTaskStatus, getTasks, getUser, getUserAPIKeys, getUserOAuthAccessTokens, getUserOAuthClients, getWorkspace, getWorkspaceMembersList, getWorkspaceSettings, getWorkspacesList, grantAuthorizationCode, greaterEquals, greaterThan, greaterThanEquals, gt, gte, iContains, iPattern, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, installClusterExtension, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isValidExpandedColumn, isValidSelectableColumns, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listClusterBranches, listClusterExtensions, listClusters, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, moveBranch, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, pushBranchMigrations, putFile, putFileItem, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, renameDatabase, resendWorkspaceMemberInvite, resolveBranch, rollbackMigration, searchBranch, searchTable, serialize, setTableSchema, sqlBatchQuery, sqlQuery, startMigration, startsWith, summarizeTable, transformImage, updateBranchMetadata, updateBranchSchema, updateCluster, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateDatabaseSettings, updateMigrationRequest, updateOAuthAccessToken, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, updateWorkspaceSettings, upsertRecordWithID, vectorSearchTable };
|