@xata.io/client 0.0.0-alpha.vfc037e5fcc7638c56843d5834ef8a7d04c8d451b → 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/dist/index.d.ts CHANGED
@@ -1,9 +1,35 @@
1
+ interface CacheImpl {
2
+ defaultQueryTTL: number;
3
+ getAll(): Promise<Record<string, unknown>>;
4
+ get: <T>(key: string) => Promise<T | null>;
5
+ set: <T>(key: string, value: T) => Promise<void>;
6
+ delete: (key: string) => Promise<void>;
7
+ clear: () => Promise<void>;
8
+ }
9
+ interface SimpleCacheOptions {
10
+ max?: number;
11
+ defaultQueryTTL?: number;
12
+ }
13
+ declare class SimpleCache implements CacheImpl {
14
+ #private;
15
+ capacity: number;
16
+ defaultQueryTTL: number;
17
+ constructor(options?: SimpleCacheOptions);
18
+ getAll(): Promise<Record<string, unknown>>;
19
+ get<T>(key: string): Promise<T | null>;
20
+ set<T>(key: string, value: T): Promise<void>;
21
+ delete(key: string): Promise<void>;
22
+ clear(): Promise<void>;
23
+ }
24
+
1
25
  declare abstract class XataPlugin {
2
26
  abstract build(options: XataPluginOptions): unknown;
3
27
  }
4
28
  type XataPluginOptions = ApiExtraProps & {
29
+ cache: CacheImpl;
5
30
  host: HostProvider;
6
31
  tables: Table[];
32
+ branch: string;
7
33
  };
8
34
 
9
35
  type AttributeDictionary = Record<string, string | number | boolean | undefined>;
@@ -72,6 +98,139 @@ type RequiredKeys<T> = {
72
98
  *
73
99
  * @version 1.0
74
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
+ };
75
234
  /**
76
235
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
77
236
  *
@@ -86,6 +245,24 @@ type ApplyMigrationResponse = {
86
245
  */
87
246
  jobID: string;
88
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
+ };
89
266
  /**
90
267
  * @maxLength 255
91
268
  * @minLength 1
@@ -94,6 +271,95 @@ type ApplyMigrationResponse = {
94
271
  type TableName = string;
95
272
  type MigrationJobType = 'apply' | 'start' | 'complete' | 'rollback';
96
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[];
97
363
  type MigrationJobStatusResponse = {
98
364
  /**
99
365
  * The id of the migration job
@@ -107,11 +373,69 @@ type MigrationJobStatusResponse = {
107
373
  * The status of the migration job
108
374
  */
109
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;
390
+ };
391
+ type MigrationJobItem = {
392
+ /**
393
+ * The id of the migration job
394
+ */
395
+ jobID: string;
396
+ /**
397
+ * The type of the migration job
398
+ */
399
+ type: MigrationJobType;
400
+ /**
401
+ * The status of the migration job
402
+ */
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;
110
424
  /**
111
425
  * The error message associated with the migration job
112
426
  */
113
427
  error?: string;
114
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
+ };
115
439
  /**
116
440
  * @maxLength 255
117
441
  * @minLength 1
@@ -124,6 +448,10 @@ type MigrationHistoryItem = {
124
448
  * The name of the migration
125
449
  */
126
450
  name: string;
451
+ /**
452
+ * The schema in which the migration was applied
453
+ */
454
+ schema: string;
127
455
  /**
128
456
  * The pgroll migration that was applied
129
457
  */
@@ -152,6 +480,10 @@ type MigrationHistoryResponse = {
152
480
  * The migrations that have been applied to the branch
153
481
  */
154
482
  migrations: MigrationHistoryItem[];
483
+ /**
484
+ * The cursor (timestamp) for the next page of results
485
+ */
486
+ cursor?: string;
155
487
  };
156
488
  /**
157
489
  * @maxLength 255
@@ -160,27 +492,28 @@ type MigrationHistoryResponse = {
160
492
  */
161
493
  type DBName$1 = string;
162
494
  /**
163
- * @format date-time
164
- * @x-go-type string
495
+ * Represent the state of the branch, used for branch lifecycle management
165
496
  */
166
- type DateTime$1 = string;
497
+ type BranchState = 'active' | 'move_scheduled' | 'moving';
167
498
  type Branch = {
168
499
  name: string;
169
500
  /**
170
501
  * The cluster where this branch resides. Value of 'shared-cluster' for branches in shared clusters
171
502
  *
172
503
  * @minLength 1
173
- * @x-internal true
174
504
  */
175
505
  clusterID?: string;
506
+ state: BranchState;
176
507
  createdAt: DateTime$1;
508
+ searchDisabled?: boolean;
509
+ inactiveSharedCluster?: boolean;
177
510
  };
178
511
  type ListBranchesResponse = {
179
512
  databaseName: string;
180
513
  branches: Branch[];
181
514
  };
182
515
  type DatabaseSettings = {
183
- search_enabled: boolean;
516
+ searchEnabled: boolean;
184
517
  };
185
518
  /**
186
519
  * @maxLength 255
@@ -204,6 +537,12 @@ type BranchMetadata$1 = {
204
537
  stage?: string;
205
538
  labels?: string[];
206
539
  };
540
+ type CreateBranchResponse$1 = {
541
+ /**
542
+ * The id of the branch creation task
543
+ */
544
+ taskID: string;
545
+ };
207
546
  type StartedFromMetadata = {
208
547
  branchName: BranchName$1;
209
548
  dbBranchID: string;
@@ -224,7 +563,7 @@ type ColumnFile = {
224
563
  };
225
564
  type Column = {
226
565
  name: string;
227
- type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'datetime' | 'vector' | 'file[]' | 'file' | 'json';
566
+ type: string;
228
567
  link?: ColumnLink;
229
568
  vector?: ColumnVector;
230
569
  file?: ColumnFile;
@@ -263,6 +602,7 @@ type DBBranch = {
263
602
  */
264
603
  clusterID?: string;
265
604
  version: number;
605
+ state: BranchState;
266
606
  lastMigrationID: string;
267
607
  metadata?: BranchMetadata$1;
268
608
  startedFrom?: StartedFromMetadata;
@@ -1498,6 +1838,57 @@ type FileSignature = string;
1498
1838
  type SQLRecord = {
1499
1839
  [key: string]: any;
1500
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;
1501
1892
  /**
1502
1893
  * Xata Table Record Metadata
1503
1894
  */
@@ -1600,21 +1991,9 @@ type AggResponse = {
1600
1991
  [key: string]: AggResponse$1;
1601
1992
  };
1602
1993
  };
1603
- type SQLResponse = {
1604
- records?: SQLRecord[];
1605
- rows?: any[][];
1606
- /**
1607
- * Name of the column and its PostgreSQL type
1608
- */
1609
- columns?: {
1610
- name?: string;
1611
- type?: string;
1612
- }[];
1613
- /**
1614
- * Number of selected columns
1615
- */
1616
- total?: number;
1617
- warning?: string;
1994
+ type SQLResponse = SQLResponse$1;
1995
+ type SQLBatchResponse = {
1996
+ results: SQLResponse$1[];
1618
1997
  };
1619
1998
 
1620
1999
  /**
@@ -1710,6 +2089,9 @@ type Workspace = WorkspaceMeta & {
1710
2089
  memberCount: number;
1711
2090
  plan: WorkspacePlan;
1712
2091
  };
2092
+ type WorkspaceSettings = {
2093
+ dedicatedClusters: boolean;
2094
+ };
1713
2095
  type WorkspaceMember = {
1714
2096
  userId: UserID;
1715
2097
  fullname: string;
@@ -1776,6 +2158,8 @@ type ClusterShortMetadata = {
1776
2158
  * @format int64
1777
2159
  */
1778
2160
  branches: number;
2161
+ createdAt: DateTime;
2162
+ terminatedAt?: DateTime;
1779
2163
  };
1780
2164
  /**
1781
2165
  * @x-internal true
@@ -1873,6 +2257,13 @@ type ClusterConfiguration = {
1873
2257
  * @format int64
1874
2258
  */
1875
2259
  replicas?: number;
2260
+ /**
2261
+ * @format int64
2262
+ * @default 1
2263
+ * @maximum 3
2264
+ * @minimum 1
2265
+ */
2266
+ instanceCount?: number;
1876
2267
  /**
1877
2268
  * @default false
1878
2269
  */
@@ -1891,7 +2282,7 @@ type ClusterCreateDetails = {
1891
2282
  /**
1892
2283
  * @maxLength 63
1893
2284
  * @minLength 1
1894
- * @pattern [a-zA-Z0-9_-~:]+
2285
+ * @pattern [a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*
1895
2286
  */
1896
2287
  name: string;
1897
2288
  configuration: ClusterConfiguration;
@@ -1943,6 +2334,10 @@ type ClusterConfigurationResponse = {
1943
2334
  * @format int64
1944
2335
  */
1945
2336
  replicas: number;
2337
+ /**
2338
+ * @format int64
2339
+ */
2340
+ instanceCount: number;
1946
2341
  /**
1947
2342
  * @default false
1948
2343
  */
@@ -1964,10 +2359,26 @@ type ClusterMetadata = {
1964
2359
  branches: number;
1965
2360
  configuration: ClusterConfigurationResponse;
1966
2361
  };
2362
+ /**
2363
+ * @x-internal true
2364
+ */
2365
+ type ClusterDeleteMetadata = {
2366
+ id: ClusterID;
2367
+ state: string;
2368
+ region: string;
2369
+ name: string;
2370
+ /**
2371
+ * @format int64
2372
+ */
2373
+ branches: number;
2374
+ };
1967
2375
  /**
1968
2376
  * @x-internal true
1969
2377
  */
1970
2378
  type ClusterUpdateDetails = {
2379
+ /**
2380
+ * @pattern ^[Ss][Tt][Oo][Pp]|[Ss][Tt][Aa][Rr][Tt]$
2381
+ */
1971
2382
  command: string;
1972
2383
  };
1973
2384
  /**
@@ -1998,9 +2409,13 @@ type DatabaseMetadata = {
1998
2409
  */
1999
2410
  newMigrations?: boolean;
2000
2411
  /**
2001
- * @x-internal true
2412
+ * The default cluster ID where branches from this database reside. Value of 'shared-cluster' for branches in shared clusters.
2002
2413
  */
2003
2414
  defaultClusterID?: string;
2415
+ /**
2416
+ * The database is accessible via the Postgres protocol
2417
+ */
2418
+ postgresEnabled?: boolean;
2004
2419
  /**
2005
2420
  * Metadata about the database for display in Xata user interfaces
2006
2421
  */
@@ -2434,6 +2849,7 @@ type GetWorkspacesListError = ErrorWrapper$1<{
2434
2849
  type GetWorkspacesListResponse = {
2435
2850
  workspaces: {
2436
2851
  id: WorkspaceID;
2852
+ unique_id: string;
2437
2853
  name: string;
2438
2854
  slug: string;
2439
2855
  role: Role;
@@ -2541,6 +2957,59 @@ type DeleteWorkspaceVariables = {
2541
2957
  * Delete the workspace with the provided ID
2542
2958
  */
2543
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>;
2544
3013
  type GetWorkspaceMembersListPathParams = {
2545
3014
  /**
2546
3015
  * Workspace ID
@@ -2899,6 +3368,30 @@ type UpdateClusterVariables = {
2899
3368
  * Update cluster for given cluster ID
2900
3369
  */
2901
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>;
2902
3395
  type GetDatabaseListPathParams = {
2903
3396
  /**
2904
3397
  * Workspace ID
@@ -3247,15 +3740,11 @@ type ErrorWrapper<TError> = TError | {
3247
3740
  * @version 1.0
3248
3741
  */
3249
3742
 
3250
- type ApplyMigrationPathParams = {
3251
- /**
3252
- * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3253
- */
3254
- dbBranchName: DBBranchName;
3743
+ type GetTasksPathParams = {
3255
3744
  workspace: string;
3256
3745
  region: string;
3257
3746
  };
3258
- type ApplyMigrationError = ErrorWrapper<{
3747
+ type GetTasksError = ErrorWrapper<{
3259
3748
  status: 400;
3260
3749
  payload: BadRequestError$1;
3261
3750
  } | {
@@ -3265,36 +3754,20 @@ type ApplyMigrationError = ErrorWrapper<{
3265
3754
  status: 404;
3266
3755
  payload: SimpleError$1;
3267
3756
  }>;
3268
- type ApplyMigrationRequestBody = {
3269
- /**
3270
- * Migration name
3271
- */
3272
- name?: string;
3273
- operations: {
3274
- [key: string]: any;
3275
- }[];
3276
- };
3277
- type ApplyMigrationVariables = {
3278
- body: ApplyMigrationRequestBody;
3279
- pathParams: ApplyMigrationPathParams;
3757
+ type GetTasksResponse = TaskStatusResponse[];
3758
+ type GetTasksVariables = {
3759
+ pathParams: GetTasksPathParams;
3280
3760
  } & DataPlaneFetcherExtraProps;
3281
- /**
3282
- * Applies a pgroll migration to the specified database.
3283
- */
3284
- declare const applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
3285
- type AdaptTablePathParams = {
3286
- /**
3287
- * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3288
- */
3289
- dbBranchName: DBBranchName;
3761
+ declare const getTasks: (variables: GetTasksVariables, signal?: AbortSignal) => Promise<GetTasksResponse>;
3762
+ type GetTaskStatusPathParams = {
3290
3763
  /**
3291
- * The Table name
3764
+ * The id of the branch creation task
3292
3765
  */
3293
- tableName: TableName;
3766
+ taskId: TaskID;
3294
3767
  workspace: string;
3295
3768
  region: string;
3296
3769
  };
3297
- type AdaptTableError = ErrorWrapper<{
3770
+ type GetTaskStatusError = ErrorWrapper<{
3298
3771
  status: 400;
3299
3772
  payload: BadRequestError$1;
3300
3773
  } | {
@@ -3304,119 +3777,163 @@ type AdaptTableError = ErrorWrapper<{
3304
3777
  status: 404;
3305
3778
  payload: SimpleError$1;
3306
3779
  }>;
3307
- type AdaptTableVariables = {
3308
- pathParams: AdaptTablePathParams;
3780
+ type GetTaskStatusVariables = {
3781
+ pathParams: GetTaskStatusPathParams;
3309
3782
  } & DataPlaneFetcherExtraProps;
3310
- /**
3311
- * 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.
3312
- */
3313
- declare const adaptTable: (variables: AdaptTableVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
3314
- type GetBranchMigrationJobStatusPathParams = {
3783
+ declare const getTaskStatus: (variables: GetTaskStatusVariables, signal?: AbortSignal) => Promise<TaskStatusResponse>;
3784
+ type ListClusterBranchesPathParams = {
3315
3785
  /**
3316
- * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3786
+ * Cluster ID
3317
3787
  */
3318
- dbBranchName: DBBranchName;
3788
+ clusterId: ClusterID$1;
3319
3789
  workspace: string;
3320
3790
  region: string;
3321
3791
  };
3322
- type GetBranchMigrationJobStatusError = ErrorWrapper<{
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<{
3323
3803
  status: 400;
3324
3804
  payload: BadRequestError$1;
3325
3805
  } | {
3326
3806
  status: 401;
3327
3807
  payload: AuthError$1;
3328
- } | {
3329
- status: 404;
3330
- payload: SimpleError$1;
3331
3808
  }>;
3332
- type GetBranchMigrationJobStatusVariables = {
3333
- pathParams: GetBranchMigrationJobStatusPathParams;
3809
+ type ListClusterBranchesVariables = {
3810
+ pathParams: ListClusterBranchesPathParams;
3811
+ queryParams?: ListClusterBranchesQueryParams;
3334
3812
  } & DataPlaneFetcherExtraProps;
3335
- declare const getBranchMigrationJobStatus: (variables: GetBranchMigrationJobStatusVariables, signal?: AbortSignal) => Promise<MigrationJobStatusResponse>;
3336
- type GetMigrationJobStatusPathParams = {
3337
- /**
3338
- * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3339
- */
3340
- dbBranchName: DBBranchName;
3813
+ /**
3814
+ * Retrieve branches for given cluster ID
3815
+ */
3816
+ declare const listClusterBranches: (variables: ListClusterBranchesVariables, signal?: AbortSignal) => Promise<ListClusterBranchesResponse>;
3817
+ type ListClusterExtensionsPathParams = {
3341
3818
  /**
3342
- * The id of the migration job
3819
+ * Cluster ID
3343
3820
  */
3344
- jobId: MigrationJobID;
3821
+ clusterId: ClusterID$1;
3345
3822
  workspace: string;
3346
3823
  region: string;
3347
3824
  };
3348
- type GetMigrationJobStatusError = ErrorWrapper<{
3825
+ type ListClusterExtensionsQueryParams = {
3826
+ extensionType: 'available' | 'installed';
3827
+ };
3828
+ type ListClusterExtensionsError = ErrorWrapper<{
3349
3829
  status: 400;
3350
3830
  payload: BadRequestError$1;
3351
3831
  } | {
3352
3832
  status: 401;
3353
3833
  payload: AuthError$1;
3354
- } | {
3355
- status: 404;
3356
- payload: SimpleError$1;
3357
3834
  }>;
3358
- type GetMigrationJobStatusVariables = {
3359
- pathParams: GetMigrationJobStatusPathParams;
3835
+ type ListClusterExtensionsVariables = {
3836
+ pathParams: ListClusterExtensionsPathParams;
3837
+ queryParams: ListClusterExtensionsQueryParams;
3360
3838
  } & DataPlaneFetcherExtraProps;
3361
- declare const getMigrationJobStatus: (variables: GetMigrationJobStatusVariables, signal?: AbortSignal) => Promise<MigrationJobStatusResponse>;
3362
- type GetMigrationHistoryPathParams = {
3839
+ /**
3840
+ * Retrieve extensions for given cluster ID
3841
+ */
3842
+ declare const listClusterExtensions: (variables: ListClusterExtensionsVariables, signal?: AbortSignal) => Promise<ListClusterExtensionsResponse>;
3843
+ type InstallClusterExtensionPathParams = {
3363
3844
  /**
3364
- * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3845
+ * Cluster ID
3365
3846
  */
3366
- dbBranchName: DBBranchName;
3847
+ clusterId: ClusterID$1;
3367
3848
  workspace: string;
3368
3849
  region: string;
3369
3850
  };
3370
- type GetMigrationHistoryError = ErrorWrapper<{
3851
+ type InstallClusterExtensionError = ErrorWrapper<{
3371
3852
  status: 400;
3372
3853
  payload: BadRequestError$1;
3373
3854
  } | {
3374
3855
  status: 401;
3375
3856
  payload: AuthError$1;
3376
- } | {
3377
- status: 404;
3378
- payload: SimpleError$1;
3379
3857
  }>;
3380
- type GetMigrationHistoryVariables = {
3381
- pathParams: GetMigrationHistoryPathParams;
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;
3382
3875
  } & DataPlaneFetcherExtraProps;
3383
- declare const getMigrationHistory: (variables: GetMigrationHistoryVariables, signal?: AbortSignal) => Promise<MigrationHistoryResponse>;
3384
- type GetBranchListPathParams = {
3876
+ /**
3877
+ * Install an extension for given cluster ID
3878
+ */
3879
+ declare const installClusterExtension: (variables: InstallClusterExtensionVariables, signal?: AbortSignal) => Promise<ClusterExtensionInstallationResponse>;
3880
+ type DropClusterExtensionPathParams = {
3385
3881
  /**
3386
- * The Database Name
3882
+ * Cluster ID
3387
3883
  */
3388
- dbName: DBName$1;
3884
+ clusterId: ClusterID$1;
3389
3885
  workspace: string;
3390
3886
  region: string;
3391
3887
  };
3392
- type GetBranchListError = ErrorWrapper<{
3888
+ type DropClusterExtensionError = ErrorWrapper<{
3393
3889
  status: 400;
3394
3890
  payload: BadRequestError$1;
3395
3891
  } | {
3396
3892
  status: 401;
3397
3893
  payload: AuthError$1;
3398
- } | {
3399
- status: 404;
3400
- payload: SimpleError$1;
3401
3894
  }>;
3402
- type GetBranchListVariables = {
3403
- pathParams: GetBranchListPathParams;
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;
3404
3908
  } & DataPlaneFetcherExtraProps;
3405
3909
  /**
3406
- * List all available Branches
3910
+ * Drop an extension for given cluster ID
3407
3911
  */
3408
- declare const getBranchList: (variables: GetBranchListVariables, signal?: AbortSignal) => Promise<ListBranchesResponse>;
3409
- type GetDatabaseSettingsPathParams = {
3912
+ declare const dropClusterExtension: (variables: DropClusterExtensionVariables, signal?: AbortSignal) => Promise<undefined>;
3913
+ type GetClusterMetricsPathParams = {
3410
3914
  /**
3411
- * The Database Name
3915
+ * Cluster ID
3412
3916
  */
3413
- dbName: DBName$1;
3917
+ clusterId: ClusterID$1;
3414
3918
  workspace: string;
3415
3919
  region: string;
3416
3920
  };
3417
- type GetDatabaseSettingsError = ErrorWrapper<{
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<{
3418
3935
  status: 400;
3419
- payload: SimpleError$1;
3936
+ payload: BadRequestError$1;
3420
3937
  } | {
3421
3938
  status: 401;
3422
3939
  payload: AuthError$1;
@@ -3424,24 +3941,25 @@ type GetDatabaseSettingsError = ErrorWrapper<{
3424
3941
  status: 404;
3425
3942
  payload: SimpleError$1;
3426
3943
  }>;
3427
- type GetDatabaseSettingsVariables = {
3428
- pathParams: GetDatabaseSettingsPathParams;
3944
+ type GetClusterMetricsVariables = {
3945
+ pathParams: GetClusterMetricsPathParams;
3946
+ queryParams: GetClusterMetricsQueryParams;
3429
3947
  } & DataPlaneFetcherExtraProps;
3430
3948
  /**
3431
- * Get database settings
3949
+ * retrieve a standard set of RDS cluster metrics
3432
3950
  */
3433
- declare const getDatabaseSettings: (variables: GetDatabaseSettingsVariables, signal?: AbortSignal) => Promise<DatabaseSettings>;
3434
- type UpdateDatabaseSettingsPathParams = {
3951
+ declare const getClusterMetrics: (variables: GetClusterMetricsVariables, signal?: AbortSignal) => Promise<MetricsResponse>;
3952
+ type ApplyMigrationPathParams = {
3435
3953
  /**
3436
- * The Database Name
3954
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3437
3955
  */
3438
- dbName: DBName$1;
3956
+ dbBranchName: DBBranchName;
3439
3957
  workspace: string;
3440
3958
  region: string;
3441
3959
  };
3442
- type UpdateDatabaseSettingsError = ErrorWrapper<{
3960
+ type ApplyMigrationError = ErrorWrapper<{
3443
3961
  status: 400;
3444
- payload: SimpleError$1;
3962
+ payload: BadRequestError$1;
3445
3963
  } | {
3446
3964
  status: 401;
3447
3965
  payload: AuthError$1;
@@ -3449,15 +3967,31 @@ type UpdateDatabaseSettingsError = ErrorWrapper<{
3449
3967
  status: 404;
3450
3968
  payload: SimpleError$1;
3451
3969
  }>;
3452
- type UpdateDatabaseSettingsVariables = {
3453
- body: DatabaseSettings;
3454
- pathParams: UpdateDatabaseSettingsPathParams;
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;
3455
3989
  } & DataPlaneFetcherExtraProps;
3456
3990
  /**
3457
- * Update database settings, this endpoint can be used to disable search
3991
+ * Applies a pgroll migration to the specified database.
3458
3992
  */
3459
- declare const updateDatabaseSettings: (variables: UpdateDatabaseSettingsVariables, signal?: AbortSignal) => Promise<DatabaseSettings>;
3460
- type GetBranchDetailsPathParams = {
3993
+ declare const applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
3994
+ type StartMigrationPathParams = {
3461
3995
  /**
3462
3996
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3463
3997
  */
@@ -3465,7 +3999,7 @@ type GetBranchDetailsPathParams = {
3465
3999
  workspace: string;
3466
4000
  region: string;
3467
4001
  };
3468
- type GetBranchDetailsError = ErrorWrapper<{
4002
+ type StartMigrationError = ErrorWrapper<{
3469
4003
  status: 400;
3470
4004
  payload: BadRequestError$1;
3471
4005
  } | {
@@ -3475,9 +4009,412 @@ type GetBranchDetailsError = ErrorWrapper<{
3475
4009
  status: 404;
3476
4010
  payload: SimpleError$1;
3477
4011
  }>;
3478
- type GetBranchDetailsVariables = {
3479
- pathParams: GetBranchDetailsPathParams;
3480
- } & DataPlaneFetcherExtraProps;
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 = {
4104
+ /**
4105
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4106
+ */
4107
+ dbBranchName: DBBranchName;
4108
+ /**
4109
+ * The Table name
4110
+ */
4111
+ tableName: TableName;
4112
+ workspace: string;
4113
+ region: string;
4114
+ };
4115
+ type AdaptTableError = ErrorWrapper<{
4116
+ status: 400;
4117
+ payload: BadRequestError$1;
4118
+ } | {
4119
+ status: 401;
4120
+ payload: AuthError$1;
4121
+ } | {
4122
+ status: 404;
4123
+ payload: SimpleError$1;
4124
+ }>;
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 = {
4133
+ /**
4134
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4135
+ */
4136
+ dbBranchName: DBBranchName;
4137
+ workspace: string;
4138
+ region: string;
4139
+ };
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;
4152
+ } & DataPlaneFetcherExtraProps;
4153
+ /**
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.
4155
+ */
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 = {
4180
+ /**
4181
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4182
+ */
4183
+ dbBranchName: DBBranchName;
4184
+ workspace: string;
4185
+ region: string;
4186
+ };
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<{
4198
+ status: 400;
4199
+ payload: BadRequestError$1;
4200
+ } | {
4201
+ status: 401;
4202
+ payload: AuthError$1;
4203
+ } | {
4204
+ status: 404;
4205
+ payload: SimpleError$1;
4206
+ }>;
4207
+ type GetMigrationJobsVariables = {
4208
+ pathParams: GetMigrationJobsPathParams;
4209
+ queryParams?: GetMigrationJobsQueryParams;
4210
+ } & DataPlaneFetcherExtraProps;
4211
+ declare const getMigrationJobs: (variables: GetMigrationJobsVariables, signal?: AbortSignal) => Promise<GetMigrationJobsResponse>;
4212
+ type GetMigrationJobStatusPathParams = {
4213
+ /**
4214
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4215
+ */
4216
+ dbBranchName: DBBranchName;
4217
+ /**
4218
+ * The id of the migration job
4219
+ */
4220
+ jobId: MigrationJobID;
4221
+ workspace: string;
4222
+ region: string;
4223
+ };
4224
+ type GetMigrationJobStatusError = ErrorWrapper<{
4225
+ status: 400;
4226
+ payload: BadRequestError$1;
4227
+ } | {
4228
+ status: 401;
4229
+ payload: AuthError$1;
4230
+ } | {
4231
+ status: 404;
4232
+ payload: SimpleError$1;
4233
+ }>;
4234
+ type GetMigrationJobStatusVariables = {
4235
+ pathParams: GetMigrationJobStatusPathParams;
4236
+ } & DataPlaneFetcherExtraProps;
4237
+ declare const getMigrationJobStatus: (variables: GetMigrationJobStatusVariables, signal?: AbortSignal) => Promise<MigrationJobStatusResponse>;
4238
+ type GetMigrationHistoryPathParams = {
4239
+ /**
4240
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4241
+ */
4242
+ dbBranchName: DBBranchName;
4243
+ workspace: string;
4244
+ region: string;
4245
+ };
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<{
4257
+ status: 400;
4258
+ payload: BadRequestError$1;
4259
+ } | {
4260
+ status: 401;
4261
+ payload: AuthError$1;
4262
+ } | {
4263
+ status: 404;
4264
+ payload: SimpleError$1;
4265
+ }>;
4266
+ type GetMigrationHistoryVariables = {
4267
+ pathParams: GetMigrationHistoryPathParams;
4268
+ queryParams?: GetMigrationHistoryQueryParams;
4269
+ } & DataPlaneFetcherExtraProps;
4270
+ declare const getMigrationHistory: (variables: GetMigrationHistoryVariables, signal?: AbortSignal) => Promise<MigrationHistoryResponse>;
4271
+ type GetBranchListPathParams = {
4272
+ /**
4273
+ * The Database Name
4274
+ */
4275
+ dbName: DBName$1;
4276
+ workspace: string;
4277
+ region: string;
4278
+ };
4279
+ type GetBranchListError = ErrorWrapper<{
4280
+ status: 400;
4281
+ payload: BadRequestError$1;
4282
+ } | {
4283
+ status: 401;
4284
+ payload: AuthError$1;
4285
+ } | {
4286
+ status: 404;
4287
+ payload: SimpleError$1;
4288
+ }>;
4289
+ type GetBranchListVariables = {
4290
+ pathParams: GetBranchListPathParams;
4291
+ } & DataPlaneFetcherExtraProps;
4292
+ /**
4293
+ * List all available Branches
4294
+ */
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>;
4397
+ type GetBranchDetailsPathParams = {
4398
+ /**
4399
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4400
+ */
4401
+ dbBranchName: DBBranchName;
4402
+ workspace: string;
4403
+ region: string;
4404
+ };
4405
+ type GetBranchDetailsError = ErrorWrapper<{
4406
+ status: 400;
4407
+ payload: BadRequestError$1;
4408
+ } | {
4409
+ status: 401;
4410
+ payload: AuthError$1;
4411
+ } | {
4412
+ status: 404;
4413
+ payload: SimpleError$1;
4414
+ }>;
4415
+ type GetBranchDetailsVariables = {
4416
+ pathParams: GetBranchDetailsPathParams;
4417
+ } & DataPlaneFetcherExtraProps;
3481
4418
  declare const getBranchDetails: (variables: GetBranchDetailsVariables, signal?: AbortSignal) => Promise<DBBranch>;
3482
4419
  type CreateBranchPathParams = {
3483
4420
  /**
@@ -3590,6 +4527,31 @@ type GetSchemaVariables = {
3590
4527
  pathParams: GetSchemaPathParams;
3591
4528
  } & DataPlaneFetcherExtraProps;
3592
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>;
3593
4555
  type CopyBranchPathParams = {
3594
4556
  /**
3595
4557
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -3620,6 +4582,73 @@ type CopyBranchVariables = {
3620
4582
  * Create a copy of the branch
3621
4583
  */
3622
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>;
3623
4652
  type UpdateBranchMetadataPathParams = {
3624
4653
  /**
3625
4654
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -6794,184 +7823,227 @@ type SqlQueryError = ErrorWrapper<{
6794
7823
  status: 503;
6795
7824
  payload: ServiceUnavailableError;
6796
7825
  }>;
6797
- type SqlQueryRequestBody = {
6798
- /**
6799
- * The SQL statement.
6800
- *
6801
- * @minLength 1
6802
- */
6803
- statement: string;
6804
- /**
6805
- * The query parameter list.
6806
- */
6807
- params?: any[] | null;
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 = {
6808
7839
  /**
6809
- * The consistency level for this request.
6810
- *
6811
- * @default strong
7840
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
6812
7841
  */
6813
- consistency?: 'strong' | 'eventual';
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 = {
6814
7860
  /**
6815
- * The response type.
7861
+ * The SQL statements.
6816
7862
  *
6817
- * @default json
7863
+ * @x-go-type []sqlproxy.PreparedStatement
6818
7864
  */
6819
- responseType?: 'json' | 'array';
7865
+ statements: PreparedStatement[];
7866
+ consistency?: SQLConsistency;
7867
+ responseType?: SQLResponseType$1;
6820
7868
  };
6821
- type SqlQueryVariables = {
6822
- body: SqlQueryRequestBody;
6823
- pathParams: SqlQueryPathParams;
7869
+ type SqlBatchQueryVariables = {
7870
+ body: SqlBatchQueryRequestBody;
7871
+ pathParams: SqlBatchQueryPathParams;
6824
7872
  } & DataPlaneFetcherExtraProps;
6825
7873
  /**
6826
- * Run an SQL query across the database branch.
7874
+ * Run multiple SQL queries across the database branch.
6827
7875
  */
6828
- declare const sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<SQLResponse>;
7876
+ declare const sqlBatchQuery: (variables: SqlBatchQueryVariables, signal?: AbortSignal) => Promise<SQLBatchResponse>;
6829
7877
 
6830
7878
  declare const operationsByTag: {
6831
7879
  branch: {
6832
- getBranchList: (variables: GetBranchListVariables, signal?: AbortSignal | undefined) => Promise<ListBranchesResponse>;
6833
- getBranchDetails: (variables: GetBranchDetailsVariables, signal?: AbortSignal | undefined) => Promise<DBBranch>;
6834
- createBranch: (variables: CreateBranchVariables, signal?: AbortSignal | undefined) => Promise<CreateBranchResponse>;
6835
- deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal | undefined) => Promise<DeleteBranchResponse>;
6836
- copyBranch: (variables: CopyBranchVariables, signal?: AbortSignal | undefined) => Promise<BranchWithCopyID>;
6837
- updateBranchMetadata: (variables: UpdateBranchMetadataVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
6838
- getBranchMetadata: (variables: GetBranchMetadataVariables, signal?: AbortSignal | undefined) => Promise<BranchMetadata$1>;
6839
- getBranchStats: (variables: GetBranchStatsVariables, signal?: AbortSignal | undefined) => Promise<GetBranchStatsResponse>;
6840
- getGitBranchesMapping: (variables: GetGitBranchesMappingVariables, signal?: AbortSignal | undefined) => Promise<ListGitBranchesResponse>;
6841
- addGitBranchesEntry: (variables: AddGitBranchesEntryVariables, signal?: AbortSignal | undefined) => Promise<AddGitBranchesEntryResponse>;
6842
- removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
6843
- 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>;
6844
7895
  };
6845
7896
  workspaces: {
6846
- getWorkspacesList: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetWorkspacesListResponse>;
6847
- createWorkspace: (variables: CreateWorkspaceVariables, signal?: AbortSignal | undefined) => Promise<Workspace>;
6848
- getWorkspace: (variables: GetWorkspaceVariables, signal?: AbortSignal | undefined) => Promise<Workspace>;
6849
- updateWorkspace: (variables: UpdateWorkspaceVariables, signal?: AbortSignal | undefined) => Promise<Workspace>;
6850
- deleteWorkspace: (variables: DeleteWorkspaceVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
6851
- getWorkspaceMembersList: (variables: GetWorkspaceMembersListVariables, signal?: AbortSignal | undefined) => Promise<WorkspaceMembers>;
6852
- updateWorkspaceMemberRole: (variables: UpdateWorkspaceMemberRoleVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
6853
- removeWorkspaceMember: (variables: RemoveWorkspaceMemberVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
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>;
6854
7919
  };
6855
7920
  migrations: {
6856
- applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal | undefined) => Promise<ApplyMigrationResponse>;
6857
- adaptTable: (variables: AdaptTableVariables, signal?: AbortSignal | undefined) => Promise<ApplyMigrationResponse>;
6858
- getBranchMigrationJobStatus: (variables: GetBranchMigrationJobStatusVariables, signal?: AbortSignal | undefined) => Promise<MigrationJobStatusResponse>;
6859
- getMigrationJobStatus: (variables: GetMigrationJobStatusVariables, signal?: AbortSignal | undefined) => Promise<MigrationJobStatusResponse>;
6860
- getMigrationHistory: (variables: GetMigrationHistoryVariables, signal?: AbortSignal | undefined) => Promise<MigrationHistoryResponse>;
6861
- getSchema: (variables: GetSchemaVariables, signal?: AbortSignal | undefined) => Promise<GetSchemaResponse>;
6862
- getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal | undefined) => Promise<GetBranchMigrationHistoryResponse>;
6863
- getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables, signal?: AbortSignal | undefined) => Promise<BranchMigrationPlan>;
6864
- executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
6865
- getBranchSchemaHistory: (variables: GetBranchSchemaHistoryVariables, signal?: AbortSignal | undefined) => Promise<GetBranchSchemaHistoryResponse>;
6866
- compareBranchWithUserSchema: (variables: CompareBranchWithUserSchemaVariables, signal?: AbortSignal | undefined) => Promise<SchemaCompareResponse>;
6867
- compareBranchSchemas: (variables: CompareBranchSchemasVariables, signal?: AbortSignal | undefined) => Promise<SchemaCompareResponse>;
6868
- updateBranchSchema: (variables: UpdateBranchSchemaVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
6869
- previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables, signal?: AbortSignal | undefined) => Promise<PreviewBranchSchemaEditResponse>;
6870
- applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
6871
- pushBranchMigrations: (variables: PushBranchMigrationsVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
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>;
6872
7957
  };
6873
- records: {
6874
- branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal | undefined) => Promise<TransactionSuccess>;
6875
- insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
6876
- getRecord: (variables: GetRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
6877
- insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
6878
- updateRecordWithID: (variables: UpdateRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
6879
- upsertRecordWithID: (variables: UpsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
6880
- deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
6881
- bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal | undefined) => Promise<BulkInsertResponse>;
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>;
6882
7964
  };
6883
7965
  database: {
6884
- getDatabaseSettings: (variables: GetDatabaseSettingsVariables, signal?: AbortSignal | undefined) => Promise<DatabaseSettings>;
6885
- updateDatabaseSettings: (variables: UpdateDatabaseSettingsVariables, signal?: AbortSignal | undefined) => Promise<DatabaseSettings>;
7966
+ getDatabaseSettings: (variables: GetDatabaseSettingsVariables, signal?: AbortSignal) => Promise<DatabaseSettings>;
7967
+ updateDatabaseSettings: (variables: UpdateDatabaseSettingsVariables, signal?: AbortSignal) => Promise<DatabaseSettings>;
6886
7968
  };
6887
7969
  migrationRequests: {
6888
- queryMigrationRequests: (variables: QueryMigrationRequestsVariables, signal?: AbortSignal | undefined) => Promise<QueryMigrationRequestsResponse>;
6889
- createMigrationRequest: (variables: CreateMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<CreateMigrationRequestResponse>;
6890
- getMigrationRequest: (variables: GetMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<MigrationRequest>;
6891
- updateMigrationRequest: (variables: UpdateMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
6892
- listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables, signal?: AbortSignal | undefined) => Promise<ListMigrationRequestsCommitsResponse>;
6893
- compareMigrationRequest: (variables: CompareMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<SchemaCompareResponse>;
6894
- getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables, signal?: AbortSignal | undefined) => Promise<GetMigrationRequestIsMergedResponse>;
6895
- mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<BranchOp>;
6896
- };
6897
- table: {
6898
- createTable: (variables: CreateTableVariables, signal?: AbortSignal | undefined) => Promise<CreateTableResponse>;
6899
- deleteTable: (variables: DeleteTableVariables, signal?: AbortSignal | undefined) => Promise<DeleteTableResponse>;
6900
- updateTable: (variables: UpdateTableVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
6901
- getTableSchema: (variables: GetTableSchemaVariables, signal?: AbortSignal | undefined) => Promise<GetTableSchemaResponse>;
6902
- setTableSchema: (variables: SetTableSchemaVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
6903
- getTableColumns: (variables: GetTableColumnsVariables, signal?: AbortSignal | undefined) => Promise<GetTableColumnsResponse>;
6904
- addTableColumn: (variables: AddTableColumnVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
6905
- getColumn: (variables: GetColumnVariables, signal?: AbortSignal | undefined) => Promise<Column>;
6906
- updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
6907
- 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>;
6908
7978
  };
6909
7979
  files: {
6910
- getFileItem: (variables: GetFileItemVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
6911
- putFileItem: (variables: PutFileItemVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
6912
- deleteFileItem: (variables: DeleteFileItemVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
6913
- getFile: (variables: GetFileVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
6914
- putFile: (variables: PutFileVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
6915
- deleteFile: (variables: DeleteFileVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
6916
- fileAccess: (variables: FileAccessVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
6917
- fileUpload: (variables: FileUploadVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
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>;
6918
7988
  };
6919
7989
  searchAndFilter: {
6920
- queryTable: (variables: QueryTableVariables, signal?: AbortSignal | undefined) => Promise<QueryResponse>;
6921
- searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
6922
- searchTable: (variables: SearchTableVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
6923
- vectorSearchTable: (variables: VectorSearchTableVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
6924
- askTable: (variables: AskTableVariables, signal?: AbortSignal | undefined) => Promise<AskTableResponse>;
6925
- askTableSession: (variables: AskTableSessionVariables, signal?: AbortSignal | undefined) => Promise<AskTableSessionResponse>;
6926
- summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal | undefined) => Promise<SummarizeResponse>;
6927
- aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal | undefined) => Promise<AggResponse>;
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>;
6928
7998
  };
6929
7999
  sql: {
6930
- sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal | undefined) => Promise<SQLResponse>;
8000
+ sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<SQLResponse$1>;
8001
+ sqlBatchQuery: (variables: SqlBatchQueryVariables, signal?: AbortSignal) => Promise<SQLBatchResponse>;
6931
8002
  };
6932
8003
  oAuth: {
6933
- getAuthorizationCode: (variables: GetAuthorizationCodeVariables, signal?: AbortSignal | undefined) => Promise<AuthorizationCodeResponse>;
6934
- grantAuthorizationCode: (variables: GrantAuthorizationCodeVariables, signal?: AbortSignal | undefined) => Promise<AuthorizationCodeResponse>;
6935
- getUserOAuthClients: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetUserOAuthClientsResponse>;
6936
- deleteUserOAuthClient: (variables: DeleteUserOAuthClientVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
6937
- getUserOAuthAccessTokens: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetUserOAuthAccessTokensResponse>;
6938
- deleteOAuthAccessToken: (variables: DeleteOAuthAccessTokenVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
6939
- updateOAuthAccessToken: (variables: UpdateOAuthAccessTokenVariables, signal?: AbortSignal | undefined) => Promise<OAuthAccessToken>;
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>;
6940
8011
  };
6941
8012
  users: {
6942
- getUser: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<UserWithID>;
6943
- updateUser: (variables: UpdateUserVariables, signal?: AbortSignal | undefined) => Promise<UserWithID>;
6944
- deleteUser: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<undefined>;
8013
+ getUser: (variables: GetUserVariables, signal?: AbortSignal) => Promise<UserWithID>;
8014
+ updateUser: (variables: UpdateUserVariables, signal?: AbortSignal) => Promise<UserWithID>;
8015
+ deleteUser: (variables: DeleteUserVariables, signal?: AbortSignal) => Promise<undefined>;
6945
8016
  };
6946
8017
  authentication: {
6947
- getUserAPIKeys: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetUserAPIKeysResponse>;
6948
- createUserAPIKey: (variables: CreateUserAPIKeyVariables, signal?: AbortSignal | undefined) => Promise<CreateUserAPIKeyResponse>;
6949
- deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
8018
+ getUserAPIKeys: (variables: GetUserAPIKeysVariables, signal?: AbortSignal) => Promise<GetUserAPIKeysResponse>;
8019
+ createUserAPIKey: (variables: CreateUserAPIKeyVariables, signal?: AbortSignal) => Promise<CreateUserAPIKeyResponse>;
8020
+ deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal) => Promise<undefined>;
6950
8021
  };
6951
8022
  invites: {
6952
- inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables, signal?: AbortSignal | undefined) => Promise<WorkspaceInvite>;
6953
- updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables, signal?: AbortSignal | undefined) => Promise<WorkspaceInvite>;
6954
- cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
6955
- acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
6956
- resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
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>;
6957
8028
  };
6958
8029
  xbcontrolOther: {
6959
- listClusters: (variables: ListClustersVariables, signal?: AbortSignal | undefined) => Promise<ListClustersResponse>;
6960
- createCluster: (variables: CreateClusterVariables, signal?: AbortSignal | undefined) => Promise<ClusterResponse>;
6961
- getCluster: (variables: GetClusterVariables, signal?: AbortSignal | undefined) => Promise<ClusterMetadata>;
6962
- updateCluster: (variables: UpdateClusterVariables, signal?: AbortSignal | undefined) => Promise<ClusterUpdateMetadata>;
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>;
6963
8035
  };
6964
8036
  databases: {
6965
- getDatabaseList: (variables: GetDatabaseListVariables, signal?: AbortSignal | undefined) => Promise<ListDatabasesResponse>;
6966
- createDatabase: (variables: CreateDatabaseVariables, signal?: AbortSignal | undefined) => Promise<CreateDatabaseResponse>;
6967
- deleteDatabase: (variables: DeleteDatabaseVariables, signal?: AbortSignal | undefined) => Promise<DeleteDatabaseResponse>;
6968
- getDatabaseMetadata: (variables: GetDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
6969
- updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
6970
- renameDatabase: (variables: RenameDatabaseVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
6971
- getDatabaseGithubSettings: (variables: GetDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<DatabaseGithubSettings>;
6972
- updateDatabaseGithubSettings: (variables: UpdateDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<DatabaseGithubSettings>;
6973
- deleteDatabaseGithubSettings: (variables: DeleteDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
6974
- listRegions: (variables: ListRegionsVariables, signal?: AbortSignal | undefined) => Promise<ListRegionsResponse>;
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>;
6975
8047
  };
6976
8048
  };
6977
8049
 
@@ -6989,6 +8061,8 @@ declare function buildProviderString(provider: HostProvider): string;
6989
8061
  declare function parseWorkspacesUrlParts(url: string): {
6990
8062
  workspace: string;
6991
8063
  region: string;
8064
+ database: string;
8065
+ branch?: string;
6992
8066
  host: HostAliases;
6993
8067
  } | null;
6994
8068
 
@@ -7009,7 +8083,7 @@ type XataApiProxy = {
7009
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;
7010
8084
  };
7011
8085
  };
7012
- declare const XataApiClient_base: new (options?: XataApiClientOptions | undefined) => XataApiProxy;
8086
+ declare const XataApiClient_base: new (options?: XataApiClientOptions) => XataApiProxy;
7013
8087
  declare class XataApiClient extends XataApiClient_base {
7014
8088
  }
7015
8089
 
@@ -7022,6 +8096,7 @@ type responses_QueryResponse = QueryResponse;
7022
8096
  type responses_RateLimitError = RateLimitError;
7023
8097
  type responses_RecordResponse = RecordResponse;
7024
8098
  type responses_RecordUpdateResponse = RecordUpdateResponse;
8099
+ type responses_SQLBatchResponse = SQLBatchResponse;
7025
8100
  type responses_SQLResponse = SQLResponse;
7026
8101
  type responses_SchemaCompareResponse = SchemaCompareResponse;
7027
8102
  type responses_SchemaUpdateResponse = SchemaUpdateResponse;
@@ -7029,7 +8104,7 @@ type responses_SearchResponse = SearchResponse;
7029
8104
  type responses_ServiceUnavailableError = ServiceUnavailableError;
7030
8105
  type responses_SummarizeResponse = SummarizeResponse;
7031
8106
  declare namespace responses {
7032
- 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 };
7033
8108
  }
7034
8109
 
7035
8110
  type schemas_APIKeyName = APIKeyName;
@@ -7044,14 +8119,17 @@ type schemas_AutoscalingConfigResponse = AutoscalingConfigResponse;
7044
8119
  type schemas_AverageAgg = AverageAgg;
7045
8120
  type schemas_BoosterExpression = BoosterExpression;
7046
8121
  type schemas_Branch = Branch;
8122
+ type schemas_BranchDetails = BranchDetails;
7047
8123
  type schemas_BranchMigration = BranchMigration;
7048
8124
  type schemas_BranchOp = BranchOp;
7049
8125
  type schemas_BranchSchema = BranchSchema;
8126
+ type schemas_BranchState = BranchState;
7050
8127
  type schemas_BranchWithCopyID = BranchWithCopyID;
7051
8128
  type schemas_ClusterConfiguration = ClusterConfiguration;
7052
8129
  type schemas_ClusterConfigurationResponse = ClusterConfigurationResponse;
7053
8130
  type schemas_ClusterCreateDetails = ClusterCreateDetails;
7054
- type schemas_ClusterID = ClusterID;
8131
+ type schemas_ClusterDeleteMetadata = ClusterDeleteMetadata;
8132
+ type schemas_ClusterExtensionInstallationResponse = ClusterExtensionInstallationResponse;
7055
8133
  type schemas_ClusterMetadata = ClusterMetadata;
7056
8134
  type schemas_ClusterResponse = ClusterResponse;
7057
8135
  type schemas_ClusterShortMetadata = ClusterShortMetadata;
@@ -7068,6 +8146,7 @@ type schemas_ColumnOpRename = ColumnOpRename;
7068
8146
  type schemas_ColumnVector = ColumnVector;
7069
8147
  type schemas_ColumnsProjection = ColumnsProjection;
7070
8148
  type schemas_Commit = Commit;
8149
+ type schemas_CompleteMigrationResponse = CompleteMigrationResponse;
7071
8150
  type schemas_CountAgg = CountAgg;
7072
8151
  type schemas_DBBranch = DBBranch;
7073
8152
  type schemas_DBBranchName = DBBranchName;
@@ -7077,6 +8156,7 @@ type schemas_DatabaseGithubSettings = DatabaseGithubSettings;
7077
8156
  type schemas_DatabaseMetadata = DatabaseMetadata;
7078
8157
  type schemas_DatabaseSettings = DatabaseSettings;
7079
8158
  type schemas_DateHistogramAgg = DateHistogramAgg;
8159
+ type schemas_ExtensionDetails = ExtensionDetails;
7080
8160
  type schemas_FileAccessID = FileAccessID;
7081
8161
  type schemas_FileItemID = FileItemID;
7082
8162
  type schemas_FileName = FileName;
@@ -7092,6 +8172,7 @@ type schemas_FilterPredicateRangeOp = FilterPredicateRangeOp;
7092
8172
  type schemas_FilterRangeValue = FilterRangeValue;
7093
8173
  type schemas_FilterValue = FilterValue;
7094
8174
  type schemas_FuzzinessExpression = FuzzinessExpression;
8175
+ type schemas_GetMigrationJobsResponse = GetMigrationJobsResponse;
7095
8176
  type schemas_HighlightExpression = HighlightExpression;
7096
8177
  type schemas_InputFile = InputFile;
7097
8178
  type schemas_InputFileArray = InputFileArray;
@@ -7099,6 +8180,8 @@ type schemas_InputFileEntry = InputFileEntry;
7099
8180
  type schemas_InviteID = InviteID;
7100
8181
  type schemas_InviteKey = InviteKey;
7101
8182
  type schemas_ListBranchesResponse = ListBranchesResponse;
8183
+ type schemas_ListClusterBranchesResponse = ListClusterBranchesResponse;
8184
+ type schemas_ListClusterExtensionsResponse = ListClusterExtensionsResponse;
7102
8185
  type schemas_ListClustersResponse = ListClustersResponse;
7103
8186
  type schemas_ListDatabasesResponse = ListDatabasesResponse;
7104
8187
  type schemas_ListGitBranchesResponse = ListGitBranchesResponse;
@@ -7107,18 +8190,24 @@ type schemas_MaintenanceConfig = MaintenanceConfig;
7107
8190
  type schemas_MaintenanceConfigResponse = MaintenanceConfigResponse;
7108
8191
  type schemas_MaxAgg = MaxAgg;
7109
8192
  type schemas_MediaType = MediaType;
8193
+ type schemas_MetricData = MetricData;
8194
+ type schemas_MetricMessage = MetricMessage;
7110
8195
  type schemas_MetricsDatapoint = MetricsDatapoint;
7111
8196
  type schemas_MetricsLatency = MetricsLatency;
8197
+ type schemas_MetricsResponse = MetricsResponse;
7112
8198
  type schemas_Migration = Migration;
7113
8199
  type schemas_MigrationColumnOp = MigrationColumnOp;
8200
+ type schemas_MigrationDescription = MigrationDescription;
7114
8201
  type schemas_MigrationHistoryItem = MigrationHistoryItem;
7115
8202
  type schemas_MigrationHistoryResponse = MigrationHistoryResponse;
7116
8203
  type schemas_MigrationJobID = MigrationJobID;
8204
+ type schemas_MigrationJobItem = MigrationJobItem;
7117
8205
  type schemas_MigrationJobStatus = MigrationJobStatus;
7118
8206
  type schemas_MigrationJobStatusResponse = MigrationJobStatusResponse;
7119
8207
  type schemas_MigrationJobType = MigrationJobType;
7120
8208
  type schemas_MigrationObject = MigrationObject;
7121
8209
  type schemas_MigrationOp = MigrationOp;
8210
+ type schemas_MigrationOperationDescription = MigrationOperationDescription;
7122
8211
  type schemas_MigrationRequest = MigrationRequest;
7123
8212
  type schemas_MigrationRequestNumber = MigrationRequestNumber;
7124
8213
  type schemas_MigrationTableOp = MigrationTableOp;
@@ -7132,11 +8221,9 @@ type schemas_OAuthResponseType = OAuthResponseType;
7132
8221
  type schemas_OAuthScope = OAuthScope;
7133
8222
  type schemas_ObjectValue = ObjectValue;
7134
8223
  type schemas_PageConfig = PageConfig;
7135
- type schemas_PageResponse = PageResponse;
7136
- type schemas_PageSize = PageSize;
7137
- type schemas_PageToken = PageToken;
7138
8224
  type schemas_PercentilesAgg = PercentilesAgg;
7139
8225
  type schemas_PrefixExpression = PrefixExpression;
8226
+ type schemas_PreparedStatement = PreparedStatement;
7140
8227
  type schemas_ProjectionConfig = ProjectionConfig;
7141
8228
  type schemas_QueryColumnsProjection = QueryColumnsProjection;
7142
8229
  type schemas_RecordID = RecordID;
@@ -7145,12 +8232,18 @@ type schemas_RecordsMetadata = RecordsMetadata;
7145
8232
  type schemas_Region = Region;
7146
8233
  type schemas_RevLink = RevLink;
7147
8234
  type schemas_Role = Role;
8235
+ type schemas_RollbackMigrationResponse = RollbackMigrationResponse;
8236
+ type schemas_SQLConsistency = SQLConsistency;
7148
8237
  type schemas_SQLRecord = SQLRecord;
8238
+ type schemas_SQLResponseArray = SQLResponseArray;
8239
+ type schemas_SQLResponseBase = SQLResponseBase;
8240
+ type schemas_SQLResponseJSON = SQLResponseJSON;
7149
8241
  type schemas_Schema = Schema;
7150
8242
  type schemas_SchemaEditScript = SchemaEditScript;
7151
8243
  type schemas_SearchPageConfig = SearchPageConfig;
7152
8244
  type schemas_SortExpression = SortExpression;
7153
8245
  type schemas_SortOrder = SortOrder;
8246
+ type schemas_StartMigrationResponse = StartMigrationResponse;
7154
8247
  type schemas_StartedFromMetadata = StartedFromMetadata;
7155
8248
  type schemas_SumAgg = SumAgg;
7156
8249
  type schemas_SummaryExpression = SummaryExpression;
@@ -7163,6 +8256,9 @@ type schemas_TableOpRemove = TableOpRemove;
7163
8256
  type schemas_TableOpRename = TableOpRename;
7164
8257
  type schemas_TableRename = TableRename;
7165
8258
  type schemas_TargetExpression = TargetExpression;
8259
+ type schemas_TaskID = TaskID;
8260
+ type schemas_TaskStatus = TaskStatus;
8261
+ type schemas_TaskStatusResponse = TaskStatusResponse;
7166
8262
  type schemas_TopValuesAgg = TopValuesAgg;
7167
8263
  type schemas_TransactionDeleteOp = TransactionDeleteOp;
7168
8264
  type schemas_TransactionError = TransactionError;
@@ -7188,8 +8284,9 @@ type schemas_WorkspaceMember = WorkspaceMember;
7188
8284
  type schemas_WorkspaceMembers = WorkspaceMembers;
7189
8285
  type schemas_WorkspaceMeta = WorkspaceMeta;
7190
8286
  type schemas_WorkspacePlan = WorkspacePlan;
8287
+ type schemas_WorkspaceSettings = WorkspaceSettings;
7191
8288
  declare namespace schemas {
7192
- 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, BranchMetadata$1 as BranchMetadata, schemas_BranchMigration as BranchMigration, BranchName$1 as BranchName, schemas_BranchOp as BranchOp, schemas_BranchSchema as BranchSchema, schemas_BranchWithCopyID as BranchWithCopyID, schemas_ClusterConfiguration as ClusterConfiguration, schemas_ClusterConfigurationResponse as ClusterConfigurationResponse, schemas_ClusterCreateDetails as ClusterCreateDetails, schemas_ClusterID 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_CountAgg as CountAgg, schemas_DBBranch as DBBranch, schemas_DBBranchName as DBBranchName, DBName$1 as DBName, schemas_DailyTimeWindow as DailyTimeWindow, schemas_DataInputRecord as DataInputRecord, schemas_DatabaseGithubSettings as DatabaseGithubSettings, schemas_DatabaseMetadata as DatabaseMetadata, schemas_DatabaseSettings as DatabaseSettings, DateBooster$1 as DateBooster, schemas_DateHistogramAgg as DateHistogramAgg, DateTime$1 as DateTime, schemas_FileAccessID as FileAccessID, schemas_FileItemID as FileItemID, schemas_FileName as FileName, schemas_FileResponse as FileResponse, schemas_FileSignature as FileSignature, schemas_FilterColumn as FilterColumn, schemas_FilterColumnIncludes as FilterColumnIncludes, schemas_FilterExpression as FilterExpression, schemas_FilterList as FilterList, schemas_FilterPredicate as FilterPredicate, schemas_FilterPredicateOp as FilterPredicateOp, schemas_FilterPredicateRangeOp as FilterPredicateRangeOp, schemas_FilterRangeValue as FilterRangeValue, schemas_FilterValue as FilterValue, schemas_FuzzinessExpression as FuzzinessExpression, schemas_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_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_MetricsDatapoint as MetricsDatapoint, schemas_MetricsLatency as MetricsLatency, schemas_Migration as Migration, schemas_MigrationColumnOp as MigrationColumnOp, schemas_MigrationHistoryItem as MigrationHistoryItem, schemas_MigrationHistoryResponse as MigrationHistoryResponse, schemas_MigrationJobID as MigrationJobID, schemas_MigrationJobStatus as MigrationJobStatus, schemas_MigrationJobStatusResponse as MigrationJobStatusResponse, schemas_MigrationJobType as MigrationJobType, schemas_MigrationObject as MigrationObject, schemas_MigrationOp as MigrationOp, 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, schemas_PageResponse as PageResponse, schemas_PageSize as PageSize, schemas_PageToken as PageToken, schemas_PercentilesAgg as PercentilesAgg, schemas_PrefixExpression as PrefixExpression, 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_SQLRecord as SQLRecord, schemas_Schema as Schema, schemas_SchemaEditScript as SchemaEditScript, schemas_SearchPageConfig as SearchPageConfig, schemas_SortExpression as SortExpression, schemas_SortOrder as SortOrder, schemas_StartedFromMetadata as StartedFromMetadata, schemas_SumAgg as SumAgg, schemas_SummaryExpression as SummaryExpression, schemas_SummaryExpressionList as SummaryExpressionList, schemas_Table as Table, schemas_TableMigration as TableMigration, schemas_TableName as TableName, schemas_TableOpAdd as TableOpAdd, schemas_TableOpRemove as TableOpRemove, schemas_TableOpRename as TableOpRename, schemas_TableRename as TableRename, schemas_TargetExpression as TargetExpression, schemas_TopValuesAgg as TopValuesAgg, schemas_TransactionDeleteOp as TransactionDeleteOp, schemas_TransactionError as TransactionError, schemas_TransactionFailure as TransactionFailure, schemas_TransactionGetOp as TransactionGetOp, schemas_TransactionInsertOp as TransactionInsertOp, TransactionOperation$1 as TransactionOperation, schemas_TransactionResultColumns as TransactionResultColumns, schemas_TransactionResultDelete as TransactionResultDelete, schemas_TransactionResultGet as TransactionResultGet, schemas_TransactionResultInsert as TransactionResultInsert, schemas_TransactionResultUpdate as TransactionResultUpdate, schemas_TransactionSuccess as TransactionSuccess, schemas_TransactionUpdateOp as TransactionUpdateOp, schemas_UniqueCountAgg as UniqueCountAgg, schemas_User as User, schemas_UserID as UserID, schemas_UserWithID as UserWithID, ValueBooster$1 as ValueBooster, schemas_WeeklyTimeWindow as WeeklyTimeWindow, schemas_Workspace as Workspace, schemas_WorkspaceID as WorkspaceID, schemas_WorkspaceInvite as WorkspaceInvite, schemas_WorkspaceMember as WorkspaceMember, schemas_WorkspaceMembers as WorkspaceMembers, schemas_WorkspaceMeta as WorkspaceMeta, schemas_WorkspacePlan as WorkspacePlan, XataRecord$1 as XataRecord };
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 };
7193
8290
  }
7194
8291
 
7195
8292
  declare class XataApiPlugin implements XataPlugin {
@@ -7198,168 +8295,742 @@ declare class XataApiPlugin implements XataPlugin {
7198
8295
 
7199
8296
  interface ImageTransformations {
7200
8297
  /**
7201
- * Whether to preserve animation frames from input files. Default is true.
7202
- * Setting it to false reduces animations to still images. This setting is
7203
- * recommended when enlarging images or processing arbitrary user content,
7204
- * because large GIF animations can weigh tens or even hundreds of megabytes.
7205
- * It is also useful to set anim:false when using format:"json" to get the
7206
- * response quicker without the number of frames.
8298
+ * Whether to preserve animation frames from input files. Default is true.
8299
+ * Setting it to false reduces animations to still images. This setting is
8300
+ * recommended when enlarging images or processing arbitrary user content,
8301
+ * because large GIF animations can weigh tens or even hundreds of megabytes.
8302
+ * It is also useful to set anim:false when using format:"json" to get the
8303
+ * response quicker without the number of frames.
8304
+ */
8305
+ anim?: boolean;
8306
+ /**
8307
+ * Background color to add underneath the image. Applies only to images with
8308
+ * transparency (such as PNG). Accepts any CSS color (#RRGGBB, rgba(…),
8309
+ * hsl(…), etc.)
8310
+ */
8311
+ background?: string;
8312
+ /**
8313
+ * Radius of a blur filter (approximate gaussian). Maximum supported radius
8314
+ * is 250.
8315
+ */
8316
+ blur?: number;
8317
+ /**
8318
+ * Increase brightness by a factor. A value of 1.0 equals no change, a value
8319
+ * of 0.5 equals half brightness, and a value of 2.0 equals twice as bright.
8320
+ * 0 is ignored.
8321
+ */
8322
+ brightness?: number;
8323
+ /**
8324
+ * Slightly reduces latency on a cache miss by selecting a
8325
+ * quickest-to-compress file format, at a cost of increased file size and
8326
+ * lower image quality. It will usually override the format option and choose
8327
+ * JPEG over WebP or AVIF. We do not recommend using this option, except in
8328
+ * unusual circumstances like resizing uncacheable dynamically-generated
8329
+ * images.
8330
+ */
8331
+ compression?: 'fast';
8332
+ /**
8333
+ * Increase contrast by a factor. A value of 1.0 equals no change, a value of
8334
+ * 0.5 equals low contrast, and a value of 2.0 equals high contrast. 0 is
8335
+ * ignored.
8336
+ */
8337
+ contrast?: number;
8338
+ /**
8339
+ * Download file. Forces browser to download the image.
8340
+ * Value is used for the download file name. Extension is optional.
8341
+ */
8342
+ download?: string;
8343
+ /**
8344
+ * Device Pixel Ratio. Default 1. Multiplier for width/height that makes it
8345
+ * easier to specify higher-DPI sizes in <img srcset>.
8346
+ */
8347
+ dpr?: number;
8348
+ /**
8349
+ * Resizing mode as a string. It affects interpretation of width and height
8350
+ * options:
8351
+ * - scale-down: Similar to contain, but the image is never enlarged. If
8352
+ * the image is larger than given width or height, it will be resized.
8353
+ * Otherwise its original size will be kept.
8354
+ * - contain: Resizes to maximum size that fits within the given width and
8355
+ * height. If only a single dimension is given (e.g. only width), the
8356
+ * image will be shrunk or enlarged to exactly match that dimension.
8357
+ * Aspect ratio is always preserved.
8358
+ * - cover: Resizes (shrinks or enlarges) to fill the entire area of width
8359
+ * and height. If the image has an aspect ratio different from the ratio
8360
+ * of width and height, it will be cropped to fit.
8361
+ * - crop: The image will be shrunk and cropped to fit within the area
8362
+ * specified by width and height. The image will not be enlarged. For images
8363
+ * smaller than the given dimensions it's the same as scale-down. For
8364
+ * images larger than the given dimensions, it's the same as cover.
8365
+ * See also trim.
8366
+ * - pad: Resizes to the maximum size that fits within the given width and
8367
+ * height, and then fills the remaining area with a background color
8368
+ * (white by default). Use of this mode is not recommended, as the same
8369
+ * effect can be more efficiently achieved with the contain mode and the
8370
+ * CSS object-fit: contain property.
8371
+ */
8372
+ fit?: 'scale-down' | 'contain' | 'cover' | 'crop' | 'pad';
8373
+ /**
8374
+ * Output format to generate. It can be:
8375
+ * - avif: generate images in AVIF format.
8376
+ * - webp: generate images in Google WebP format. Set quality to 100 to get
8377
+ * the WebP-lossless format.
8378
+ * - json: instead of generating an image, outputs information about the
8379
+ * image, in JSON format. The JSON object will contain image size
8380
+ * (before and after resizing), source image’s MIME type, file size, etc.
8381
+ * - jpeg: generate images in JPEG format.
8382
+ * - png: generate images in PNG format.
8383
+ */
8384
+ format?: 'auto' | 'avif' | 'webp' | 'json' | 'jpeg' | 'png';
8385
+ /**
8386
+ * Increase exposure by a factor. A value of 1.0 equals no change, a value of
8387
+ * 0.5 darkens the image, and a value of 2.0 lightens the image. 0 is ignored.
8388
+ */
8389
+ gamma?: number;
8390
+ /**
8391
+ * When cropping with fit: "cover", this defines the side or point that should
8392
+ * be left uncropped. The value is either a string
8393
+ * "left", "right", "top", "bottom", "auto", or "center" (the default),
8394
+ * or an object {x, y} containing focal point coordinates in the original
8395
+ * image expressed as fractions ranging from 0.0 (top or left) to 1.0
8396
+ * (bottom or right), 0.5 being the center. {fit: "cover", gravity: "top"} will
8397
+ * crop bottom or left and right sides as necessary, but won’t crop anything
8398
+ * from the top. {fit: "cover", gravity: {x:0.5, y:0.2}} will crop each side to
8399
+ * preserve as much as possible around a point at 20% of the height of the
8400
+ * source image.
8401
+ */
8402
+ gravity?: 'left' | 'right' | 'top' | 'bottom' | 'center' | 'auto' | {
8403
+ x: number;
8404
+ y: number;
8405
+ };
8406
+ /**
8407
+ * Maximum height in image pixels. The value must be an integer.
8408
+ */
8409
+ height?: number;
8410
+ /**
8411
+ * What EXIF data should be preserved in the output image. Note that EXIF
8412
+ * rotation and embedded color profiles are always applied ("baked in" into
8413
+ * the image), and aren't affected by this option. Note that if the Polish
8414
+ * feature is enabled, all metadata may have been removed already and this
8415
+ * option may have no effect.
8416
+ * - keep: Preserve most of EXIF metadata, including GPS location if there's
8417
+ * any.
8418
+ * - copyright: Only keep the copyright tag, and discard everything else.
8419
+ * This is the default behavior for JPEG files.
8420
+ * - none: Discard all invisible EXIF metadata. Currently WebP and PNG
8421
+ * output formats always discard metadata.
8422
+ */
8423
+ metadata?: 'keep' | 'copyright' | 'none';
8424
+ /**
8425
+ * Quality setting from 1-100 (useful values are in 60-90 range). Lower values
8426
+ * make images look worse, but load faster. The default is 85. It applies only
8427
+ * to JPEG and WebP images. It doesn’t have any effect on PNG.
8428
+ */
8429
+ quality?: number;
8430
+ /**
8431
+ * Number of degrees (90, 180, 270) to rotate the image by. width and height
8432
+ * options refer to axes after rotation.
8433
+ */
8434
+ rotate?: 0 | 90 | 180 | 270 | 360;
8435
+ /**
8436
+ * Strength of sharpening filter to apply to the image. Floating-point
8437
+ * number between 0 (no sharpening, default) and 10 (maximum). 1.0 is a
8438
+ * recommended value for downscaled images.
8439
+ */
8440
+ sharpen?: number;
8441
+ /**
8442
+ * An object with four properties {left, top, right, bottom} that specify
8443
+ * a number of pixels to cut off on each side. Allows removal of borders
8444
+ * or cutting out a specific fragment of an image. Trimming is performed
8445
+ * before resizing or rotation. Takes dpr into account.
8446
+ */
8447
+ trim?: {
8448
+ left?: number;
8449
+ top?: number;
8450
+ right?: number;
8451
+ bottom?: number;
8452
+ };
8453
+ /**
8454
+ * Maximum width in image pixels. The value must be an integer.
8455
+ */
8456
+ width?: number;
8457
+ }
8458
+ declare function transformImage(url: string, ...transformations: ImageTransformations[]): string;
8459
+ declare function transformImage(url: string | undefined, ...transformations: ImageTransformations[]): string | undefined;
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
7207
8721
  */
7208
- anim?: boolean;
8722
+ readInt16LE(offset: number, noAssert?: boolean): number;
7209
8723
  /**
7210
- * Background color to add underneath the image. Applies only to images with
7211
- * transparency (such as PNG). Accepts any CSS color (#RRGGBB, rgba(…),
7212
- * hsl(…), etc.)
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
7213
8729
  */
7214
- background?: string;
8730
+ readInt16BE(offset: number, noAssert?: boolean): number;
7215
8731
  /**
7216
- * Radius of a blur filter (approximate gaussian). Maximum supported radius
7217
- * is 250.
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
7218
8737
  */
7219
- blur?: number;
8738
+ readInt32LE(offset: number, noAssert?: boolean): number;
7220
8739
  /**
7221
- * Increase brightness by a factor. A value of 1.0 equals no change, a value
7222
- * of 0.5 equals half brightness, and a value of 2.0 equals twice as bright.
7223
- * 0 is ignored.
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
7224
8745
  */
7225
- brightness?: number;
8746
+ readInt32BE(offset: number, noAssert?: boolean): number;
7226
8747
  /**
7227
- * Slightly reduces latency on a cache miss by selecting a
7228
- * quickest-to-compress file format, at a cost of increased file size and
7229
- * lower image quality. It will usually override the format option and choose
7230
- * JPEG over WebP or AVIF. We do not recommend using this option, except in
7231
- * unusual circumstances like resizing uncacheable dynamically-generated
7232
- * images.
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.
7233
8750
  */
7234
- compression?: 'fast';
8751
+ swap16(): Buffer;
7235
8752
  /**
7236
- * Increase contrast by a factor. A value of 1.0 equals no change, a value of
7237
- * 0.5 equals low contrast, and a value of 2.0 equals high contrast. 0 is
7238
- * ignored.
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.
7239
8755
  */
7240
- contrast?: number;
8756
+ swap32(): Buffer;
7241
8757
  /**
7242
- * Download file. Forces browser to download the image.
7243
- * Value is used for the download file name. Extension is optional.
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.
7244
8760
  */
7245
- download?: string;
8761
+ swap64(): Buffer;
7246
8762
  /**
7247
- * Device Pixel Ratio. Default 1. Multiplier for width/height that makes it
7248
- * easier to specify higher-DPI sizes in <img srcset>.
8763
+ * Swaps two octets.
8764
+ *
8765
+ * @param b
8766
+ * @param n
8767
+ * @param m
7249
8768
  */
7250
- dpr?: number;
8769
+ private _swap;
7251
8770
  /**
7252
- * Resizing mode as a string. It affects interpretation of width and height
7253
- * options:
7254
- * - scale-down: Similar to contain, but the image is never enlarged. If
7255
- * the image is larger than given width or height, it will be resized.
7256
- * Otherwise its original size will be kept.
7257
- * - contain: Resizes to maximum size that fits within the given width and
7258
- * height. If only a single dimension is given (e.g. only width), the
7259
- * image will be shrunk or enlarged to exactly match that dimension.
7260
- * Aspect ratio is always preserved.
7261
- * - cover: Resizes (shrinks or enlarges) to fill the entire area of width
7262
- * and height. If the image has an aspect ratio different from the ratio
7263
- * of width and height, it will be cropped to fit.
7264
- * - crop: The image will be shrunk and cropped to fit within the area
7265
- * specified by width and height. The image will not be enlarged. For images
7266
- * smaller than the given dimensions it's the same as scale-down. For
7267
- * images larger than the given dimensions, it's the same as cover.
7268
- * See also trim.
7269
- * - pad: Resizes to the maximum size that fits within the given width and
7270
- * height, and then fills the remaining area with a background color
7271
- * (white by default). Use of this mode is not recommended, as the same
7272
- * effect can be more efficiently achieved with the contain mode and the
7273
- * CSS object-fit: contain property.
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.
7274
8778
  */
7275
- fit?: 'scale-down' | 'contain' | 'cover' | 'crop' | 'pad';
8779
+ writeUInt8(value: number, offset: number, noAssert?: boolean): number;
7276
8780
  /**
7277
- * Output format to generate. It can be:
7278
- * - avif: generate images in AVIF format.
7279
- * - webp: generate images in Google WebP format. Set quality to 100 to get
7280
- * the WebP-lossless format.
7281
- * - json: instead of generating an image, outputs information about the
7282
- * image, in JSON format. The JSON object will contain image size
7283
- * (before and after resizing), source image’s MIME type, file size, etc.
7284
- * - jpeg: generate images in JPEG format.
7285
- * - png: generate images in PNG format.
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.
7286
8788
  */
7287
- format?: 'auto' | 'avif' | 'webp' | 'json' | 'jpeg' | 'png';
8789
+ writeUInt16LE(value: number | string, offset: number, noAssert?: boolean): number;
7288
8790
  /**
7289
- * Increase exposure by a factor. A value of 1.0 equals no change, a value of
7290
- * 0.5 darkens the image, and a value of 2.0 lightens the image. 0 is ignored.
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.
7291
8798
  */
7292
- gamma?: number;
8799
+ writeUInt16BE(value: number, offset: number, noAssert?: boolean): number;
7293
8800
  /**
7294
- * When cropping with fit: "cover", this defines the side or point that should
7295
- * be left uncropped. The value is either a string
7296
- * "left", "right", "top", "bottom", "auto", or "center" (the default),
7297
- * or an object {x, y} containing focal point coordinates in the original
7298
- * image expressed as fractions ranging from 0.0 (top or left) to 1.0
7299
- * (bottom or right), 0.5 being the center. {fit: "cover", gravity: "top"} will
7300
- * crop bottom or left and right sides as necessary, but won’t crop anything
7301
- * from the top. {fit: "cover", gravity: {x:0.5, y:0.2}} will crop each side to
7302
- * preserve as much as possible around a point at 20% of the height of the
7303
- * source image.
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.
7304
8808
  */
7305
- gravity?: 'left' | 'right' | 'top' | 'bottom' | 'center' | 'auto' | {
7306
- x: number;
7307
- y: number;
7308
- };
8809
+ writeUInt32LE(value: number, offset: number, noAssert?: boolean): number;
7309
8810
  /**
7310
- * Maximum height in image pixels. The value must be an integer.
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.
7311
8818
  */
7312
- height?: number;
8819
+ writeUInt32BE(value: number, offset: number, noAssert?: boolean): number;
7313
8820
  /**
7314
- * What EXIF data should be preserved in the output image. Note that EXIF
7315
- * rotation and embedded color profiles are always applied ("baked in" into
7316
- * the image), and aren't affected by this option. Note that if the Polish
7317
- * feature is enabled, all metadata may have been removed already and this
7318
- * option may have no effect.
7319
- * - keep: Preserve most of EXIF metadata, including GPS location if there's
7320
- * any.
7321
- * - copyright: Only keep the copyright tag, and discard everything else.
7322
- * This is the default behavior for JPEG files.
7323
- * - none: Discard all invisible EXIF metadata. Currently WebP and PNG
7324
- * output formats always discard metadata.
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.
7325
8828
  */
7326
- metadata?: 'keep' | 'copyright' | 'none';
8829
+ writeInt8(value: number, offset: number, noAssert?: boolean): number;
7327
8830
  /**
7328
- * Quality setting from 1-100 (useful values are in 60-90 range). Lower values
7329
- * make images look worse, but load faster. The default is 85. It applies only
7330
- * to JPEG and WebP images. It doesn’t have any effect on PNG.
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.
7331
8838
  */
7332
- quality?: number;
8839
+ writeInt16LE(value: number, offset: number, noAssert?: boolean): number;
7333
8840
  /**
7334
- * Number of degrees (90, 180, 270) to rotate the image by. width and height
7335
- * options refer to axes after rotation.
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.
7336
8848
  */
7337
- rotate?: 0 | 90 | 180 | 270 | 360;
8849
+ writeInt16BE(value: number, offset: number, noAssert?: boolean): number;
7338
8850
  /**
7339
- * Strength of sharpening filter to apply to the image. Floating-point
7340
- * number between 0 (no sharpening, default) and 10 (maximum). 1.0 is a
7341
- * recommended value for downscaled images.
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.
7342
8858
  */
7343
- sharpen?: number;
8859
+ writeInt32LE(value: number, offset: number, noAssert?: boolean): number;
7344
8860
  /**
7345
- * An object with four properties {left, top, right, bottom} that specify
7346
- * a number of pixels to cut off on each side. Allows removal of borders
7347
- * or cutting out a specific fragment of an image. Trimming is performed
7348
- * before resizing or rotation. Takes dpr into account.
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.
7349
8868
  */
7350
- trim?: {
7351
- left?: number;
7352
- top?: number;
7353
- right?: number;
7354
- bottom?: number;
7355
- };
8869
+ writeInt32BE(value: number, offset: number, noAssert?: boolean): number;
7356
8870
  /**
7357
- * Maximum width in image pixels. The value must be an integer.
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
7358
8882
  */
7359
- width?: number;
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;
7360
9029
  }
7361
- declare function transformImage(url: string, ...transformations: ImageTransformations[]): string;
7362
- declare function transformImage(url: string | undefined, ...transformations: ImageTransformations[]): string | undefined;
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';
7363
9034
 
7364
9035
  type XataFileEditableFields = Partial<Pick<XataArrayFile, keyof InputFileEntry>>;
7365
9036
  type XataFileFields = Partial<Pick<XataArrayFile, {
@@ -7440,7 +9111,7 @@ declare class XataFile {
7440
9111
  }
7441
9112
  type XataArrayFile = Identifiable & XataFile;
7442
9113
 
7443
- type SelectableColumn<O, RecursivePath extends any[] = []> = '*' | DataProps<O> | NestedColumns<O, RecursivePath>;
9114
+ type SelectableColumn<O, RecursivePath extends any[] = []> = '*' | 'id' | `xata.${'version' | 'createdAt' | 'updatedAt'}` | DataProps<O> | NestedColumns<O, RecursivePath>;
7444
9115
  type ExpandedColumnNotation = {
7445
9116
  name: string;
7446
9117
  columns?: SelectableColumn<any>[];
@@ -7474,19 +9145,19 @@ type SelectedPick<O extends XataRecord, Key extends SelectableColumnWithObjectNo
7474
9145
  };
7475
9146
  };
7476
9147
  }>>;
7477
- type ValueAtColumn<Object, Key, RecursivePath extends any[] = []> = RecursivePath['length'] extends MAX_RECURSION ? never : Key extends '*' ? Values<Object> : Key extends keyof Object ? Object[Key] : Key extends `${infer K}.${infer V}` ? K extends keyof Object ? Values<NonNullable<Object[K]> extends infer Item ? Item extends Record<string, any> ? V extends SelectableColumn<Item> ? {
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> ? {
7478
9149
  V: ValueAtColumn<Item, V, [...RecursivePath, Item]>;
7479
- } : never : Object[K] : never> : never : never;
9150
+ } : never : Obj[K] : never> : never : never;
7480
9151
  type MAX_RECURSION = 3;
7481
9152
  type NestedColumns<O, RecursivePath extends any[]> = RecursivePath['length'] extends MAX_RECURSION ? never : If<IsObject<O>, Values<{
7482
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
7483
9154
  K>> : never;
7484
9155
  }>, never>;
7485
- type DataProps<O> = Exclude<StringKeys<O>, StringKeys<Omit<XataRecord, 'xata_id'>>>;
9156
+ type DataProps<O> = Exclude<StringKeys<O>, StringKeys<XataRecord>>;
7486
9157
  type NestedValueAtColumn<O, Key extends SelectableColumn<O>> = Key extends `${infer N}.${infer M}` ? N extends DataProps<O> ? {
7487
9158
  [K in N]: M extends SelectableColumn<NonNullable<O[K]>> ? NonNullable<O[K]> extends XataFile ? ForwardNullable<O[K], XataFile> : NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M> & XataRecord> : ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M>> : NonNullable<O[K]> extends (infer ArrayType)[] ? ArrayType extends XataArrayFile ? ForwardNullable<O[K], XataArrayFile[]> : M extends SelectableColumn<NonNullable<ArrayType>> ? ForwardNullable<O[K], NestedValueAtColumn<NonNullable<ArrayType>, M>[]> : unknown : unknown;
7488
9159
  } : unknown : Key extends DataProps<O> ? {
7489
- [K in Key]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], SelectedPick<NonNullable<O[K]>, ['*']>> : O[K];
9160
+ [K in Key]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], Omit<SelectedPick<NonNullable<O[K]>, ['*']>, 'xata' | 'getMetadata'>> : O[K];
7490
9161
  } : Key extends '*' ? {
7491
9162
  [K in StringKeys<O>]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], Link<NonNullable<O[K]>>> : O[K];
7492
9163
  } : unknown;
@@ -7501,7 +9172,7 @@ interface Identifiable {
7501
9172
  /**
7502
9173
  * Unique id of this record.
7503
9174
  */
7504
- xata_id: Identifier;
9175
+ id: Identifier;
7505
9176
  }
7506
9177
  interface BaseData {
7507
9178
  [key: string]: any;
@@ -7510,6 +9181,15 @@ interface BaseData {
7510
9181
  * Represents a persisted record from the database.
7511
9182
  */
7512
9183
  interface XataRecord<OriginalRecord extends XataRecord<any> = XataRecord<any>> extends Identifiable {
9184
+ /**
9185
+ * Metadata of this record.
9186
+ */
9187
+ xata: XataRecordMetadata;
9188
+ /**
9189
+ * Get metadata of this record.
9190
+ * @deprecated Use `xata` property instead.
9191
+ */
9192
+ getMetadata(): XataRecordMetadata;
7513
9193
  /**
7514
9194
  * Get an object representation of this record.
7515
9195
  */
@@ -7581,21 +9261,36 @@ interface XataRecord<OriginalRecord extends XataRecord<any> = XataRecord<any>> e
7581
9261
  delete(): Promise<Readonly<SelectedPick<OriginalRecord, ['*']>> | null>;
7582
9262
  }
7583
9263
  type Link<Record extends XataRecord> = XataRecord<Record>;
9264
+ type XataRecordMetadata = {
9265
+ /**
9266
+ * Number that is increased every time the record is updated.
9267
+ */
9268
+ version: number;
9269
+ /**
9270
+ * Timestamp when the record was created.
9271
+ */
9272
+ createdAt: Date;
9273
+ /**
9274
+ * Timestamp when the record was last updated.
9275
+ */
9276
+ updatedAt: Date;
9277
+ };
7584
9278
  declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
9279
+ declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;
7585
9280
  type NumericOperator = ExclusiveOr<{
7586
- $increment?: number;
9281
+ $increment: number;
7587
9282
  }, ExclusiveOr<{
7588
- $decrement?: number;
9283
+ $decrement: number;
7589
9284
  }, ExclusiveOr<{
7590
- $multiply?: number;
9285
+ $multiply: number;
7591
9286
  }, {
7592
- $divide?: number;
9287
+ $divide: number;
7593
9288
  }>>>;
7594
9289
  type InputXataFile = Partial<XataArrayFile> | Promise<Partial<XataArrayFile>>;
7595
9290
  type EditableDataFields<T> = T extends XataRecord ? {
7596
- xata_id: Identifier;
9291
+ id: Identifier;
7597
9292
  } | Identifier : NonNullable<T> extends XataRecord ? {
7598
- xata_id: Identifier;
9293
+ id: Identifier;
7599
9294
  } | Identifier | null | undefined : T extends Date ? string | Date : NonNullable<T> extends Date ? string | Date | null | undefined : T extends XataFile ? InputXataFile : T extends XataFile[] ? InputXataFile[] : T extends number ? number | NumericOperator : T;
7600
9295
  type EditableData<O extends XataRecord> = Identifiable & Partial<Omit<{
7601
9296
  [K in keyof O]: EditableDataFields<O[K]>;
@@ -7606,17 +9301,22 @@ type JSONDataFile = {
7606
9301
  type JSONDataFields<T> = T extends XataFile ? JSONDataFile : NonNullable<T> extends XataFile ? JSONDataFile | null | undefined : T extends XataRecord ? JSONData<T> : NonNullable<T> extends XataRecord ? JSONData<T> | null | undefined : T extends Date ? string : NonNullable<T> extends Date ? string | null | undefined : T;
7607
9302
  type JSONDataBase = Identifiable & {
7608
9303
  /**
7609
- * Timestamp when the record was created.
7610
- */
7611
- xata_createdat: string;
7612
- /**
7613
- * Timestamp when the record was last updated.
7614
- */
7615
- xata_updatedat: string;
7616
- /**
7617
- * Number that is increased every time the record is updated.
9304
+ * Metadata about the record.
7618
9305
  */
7619
- xata_version: number;
9306
+ xata: {
9307
+ /**
9308
+ * Timestamp when the record was created.
9309
+ */
9310
+ createdAt: string;
9311
+ /**
9312
+ * Timestamp when the record was last updated.
9313
+ */
9314
+ updatedAt: string;
9315
+ /**
9316
+ * Number that is increased every time the record is updated.
9317
+ */
9318
+ version: number;
9319
+ };
7620
9320
  };
7621
9321
  type JSONData<O> = JSONDataBase & Partial<Omit<{
7622
9322
  [K in keyof O]: JSONDataFields<O[K]>;
@@ -7629,7 +9329,7 @@ type JSONValue<Value> = Value & {
7629
9329
  type JSONFilterColumns<Record> = Values<{
7630
9330
  [K in keyof Record]: NonNullable<Record[K]> extends JSONValue<any> ? K extends string ? `${K}->${string}` : never : never;
7631
9331
  }>;
7632
- type FilterColumns<T> = ColumnsByValue<T, any>;
9332
+ type FilterColumns<T> = ColumnsByValue<T, any> | `xata.${keyof XataRecordMetadata}`;
7633
9333
  type FilterValueAtColumn<Record, F> = NonNullable<ValueAtColumn<Record, F>> extends JSONValue<any> ? PropertyFilter<any> : Filter<NonNullable<ValueAtColumn<Record, F>>>;
7634
9334
  /**
7635
9335
  * PropertyMatchFilter
@@ -7855,15 +9555,18 @@ declare class SearchPlugin<Schemas extends Record<string, XataRecord>> extends X
7855
9555
  constructor(db: SchemaPluginResult<Schemas>);
7856
9556
  build(pluginOptions: XataPluginOptions): SearchPluginResult<Schemas>;
7857
9557
  }
7858
- type SearchXataRecord<Record extends XataRecord> = Record & SearchExtraProperties;
9558
+ type SearchXataRecord<Record extends XataRecord> = Omit<Record, 'getMetadata' | 'xata'> & {
9559
+ xata: XataRecordMetadata & SearchExtraProperties;
9560
+ getMetadata: () => XataRecordMetadata & SearchExtraProperties;
9561
+ };
7859
9562
  type SearchExtraProperties = {
7860
- xata_table: string;
7861
- xata_highlight?: {
9563
+ table: string;
9564
+ highlight?: {
7862
9565
  [key: string]: string[] | {
7863
9566
  [key: string]: any;
7864
9567
  };
7865
9568
  };
7866
- xata_score?: number;
9569
+ score?: number;
7867
9570
  };
7868
9571
  type ReturnTable<Table, Tables> = Table extends Tables ? Table : never;
7869
9572
  type ExtractTables<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>, TableOptions extends GetArrayInnerType<NonNullable<NonNullable<SearchOptions<Schemas, Tables>>['tables']>>> = TableOptions extends `${infer Table}` ? ReturnTable<Table, Tables> : TableOptions extends {
@@ -8101,7 +9804,7 @@ type RandomFilterExtended = {
8101
9804
  column: '*';
8102
9805
  direction: 'random';
8103
9806
  };
8104
- type SortColumns<T extends XataRecord> = ColumnsByValue<T, any>;
9807
+ type SortColumns<T extends XataRecord> = ColumnsByValue<T, any> | `xata.${keyof XataRecordMetadata}`;
8105
9808
  type SortFilterExtended<T extends XataRecord, Columns extends string = SortColumns<T>> = RandomFilterExtended | {
8106
9809
  column: Columns;
8107
9810
  direction?: SortDirection;
@@ -8151,6 +9854,7 @@ type SummarizeResultItem<Record extends XataRecord, Expression extends Dictionar
8151
9854
  type BaseOptions<T extends XataRecord> = {
8152
9855
  columns?: SelectableColumnWithObjectNotation<T>[];
8153
9856
  consistency?: 'strong' | 'eventual';
9857
+ cache?: number;
8154
9858
  fetchOptions?: Record<string, unknown>;
8155
9859
  };
8156
9860
  type CursorQueryOptions = {
@@ -8376,6 +10080,12 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
8376
10080
  */
8377
10081
  getFirstOrThrow(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'>): Promise<Result>;
8378
10082
  summarize<Expression extends Dictionary<SummarizeExpression<Record>>, Columns extends SelectableColumn<Record>[]>(params?: SummarizeParams<Record, Expression, Columns>): Promise<SummarizeResult<Record, Expression, Columns>>;
10083
+ /**
10084
+ * Builds a new query object adding a cache TTL in milliseconds.
10085
+ * @param ttl The cache TTL in milliseconds.
10086
+ * @returns A new Query object.
10087
+ */
10088
+ cache(ttl: number): Query<Record, Result>;
8379
10089
  /**
8380
10090
  * Retrieve next page of records
8381
10091
  *
@@ -8538,10 +10248,10 @@ declare class PageRecordArray<Result extends XataRecord> extends Array<Result> {
8538
10248
  * Common interface for performing operations on a table.
8539
10249
  */
8540
10250
  declare abstract class Repository<Record extends XataRecord> extends Query<Record, Readonly<SelectedPick<Record, ['*']>>> {
8541
- abstract create<K extends SelectableColumn<Record>>(object: Omit<EditableData<Record>, 'xata_id'> & Partial<Identifiable>, columns: K[], options?: {
10251
+ abstract create<K extends SelectableColumn<Record>>(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, columns: K[], options?: {
8542
10252
  ifVersion?: number;
8543
10253
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
8544
- abstract create(object: Omit<EditableData<Record>, 'xata_id'> & Partial<Identifiable>, options?: {
10254
+ abstract create(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, options?: {
8545
10255
  ifVersion?: number;
8546
10256
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
8547
10257
  /**
@@ -8551,7 +10261,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
8551
10261
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
8552
10262
  * @returns The full persisted record.
8553
10263
  */
8554
- abstract create<K extends SelectableColumn<Record>>(id: Identifier, object: Omit<EditableData<Record>, 'xata_id'>, columns: K[], options?: {
10264
+ abstract create<K extends SelectableColumn<Record>>(id: Identifier, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
8555
10265
  ifVersion?: number;
8556
10266
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
8557
10267
  /**
@@ -8560,7 +10270,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
8560
10270
  * @param object Object containing the column names with their values to be stored in the table.
8561
10271
  * @returns The full persisted record.
8562
10272
  */
8563
- abstract create(id: Identifier, object: Omit<EditableData<Record>, 'xata_id'>, options?: {
10273
+ abstract create(id: Identifier, object: Omit<EditableData<Record>, 'id'>, options?: {
8564
10274
  ifVersion?: number;
8565
10275
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
8566
10276
  /**
@@ -8569,13 +10279,13 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
8569
10279
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
8570
10280
  * @returns Array of the persisted records in order.
8571
10281
  */
8572
- abstract create<K extends SelectableColumn<Record>>(objects: Array<Omit<EditableData<Record>, 'xata_id'> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
10282
+ abstract create<K extends SelectableColumn<Record>>(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
8573
10283
  /**
8574
10284
  * Creates multiple records in the table.
8575
10285
  * @param objects Array of objects with the column names and the values to be stored in the table.
8576
10286
  * @returns Array of the persisted records in order.
8577
10287
  */
8578
- abstract create(objects: Array<Omit<EditableData<Record>, 'xata_id'> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
10288
+ abstract create(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
8579
10289
  /**
8580
10290
  * Queries a single record from the table given its unique id.
8581
10291
  * @param id The unique id.
@@ -8799,7 +10509,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
8799
10509
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
8800
10510
  * @returns The full persisted record.
8801
10511
  */
8802
- abstract createOrUpdate<K extends SelectableColumn<Record>>(object: Omit<EditableData<Record>, 'xata_id'> & Partial<Identifiable>, columns: K[], options?: {
10512
+ abstract createOrUpdate<K extends SelectableColumn<Record>>(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, columns: K[], options?: {
8803
10513
  ifVersion?: number;
8804
10514
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
8805
10515
  /**
@@ -8808,7 +10518,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
8808
10518
  * @param object Object containing the column names with their values to be persisted in the table.
8809
10519
  * @returns The full persisted record.
8810
10520
  */
8811
- abstract createOrUpdate(object: Omit<EditableData<Record>, 'xata_id'> & Partial<Identifiable>, options?: {
10521
+ abstract createOrUpdate(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, options?: {
8812
10522
  ifVersion?: number;
8813
10523
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
8814
10524
  /**
@@ -8819,7 +10529,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
8819
10529
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
8820
10530
  * @returns The full persisted record.
8821
10531
  */
8822
- abstract createOrUpdate<K extends SelectableColumn<Record>>(id: Identifier | undefined, object: Omit<EditableData<Record>, 'xata_id'>, columns: K[], options?: {
10532
+ abstract createOrUpdate<K extends SelectableColumn<Record>>(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
8823
10533
  ifVersion?: number;
8824
10534
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
8825
10535
  /**
@@ -8829,7 +10539,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
8829
10539
  * @param object The column names and the values to be persisted.
8830
10540
  * @returns The full persisted record.
8831
10541
  */
8832
- abstract createOrUpdate(id: Identifier | undefined, object: Omit<EditableData<Record>, 'xata_id'>, options?: {
10542
+ abstract createOrUpdate(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, options?: {
8833
10543
  ifVersion?: number;
8834
10544
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
8835
10545
  /**
@@ -8839,14 +10549,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
8839
10549
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
8840
10550
  * @returns Array of the persisted records.
8841
10551
  */
8842
- abstract createOrUpdate<K extends SelectableColumn<Record>>(objects: Array<Omit<EditableData<Record>, 'xata_id'> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
10552
+ abstract createOrUpdate<K extends SelectableColumn<Record>>(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
8843
10553
  /**
8844
10554
  * Creates or updates a single record. If a record exists with the given id,
8845
10555
  * it will be partially updated, otherwise a new record will be created.
8846
10556
  * @param objects Array of objects with the column names and the values to be stored in the table.
8847
10557
  * @returns Array of the persisted records.
8848
10558
  */
8849
- abstract createOrUpdate(objects: Array<Omit<EditableData<Record>, 'xata_id'> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
10559
+ abstract createOrUpdate(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
8850
10560
  /**
8851
10561
  * Creates or replaces a single record. If a record exists with the given id,
8852
10562
  * it will be replaced, otherwise a new record will be created.
@@ -8854,7 +10564,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
8854
10564
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
8855
10565
  * @returns The full persisted record.
8856
10566
  */
8857
- abstract createOrReplace<K extends SelectableColumn<Record>>(object: Omit<EditableData<Record>, 'xata_id'> & Partial<Identifiable>, columns: K[], options?: {
10567
+ abstract createOrReplace<K extends SelectableColumn<Record>>(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, columns: K[], options?: {
8858
10568
  ifVersion?: number;
8859
10569
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
8860
10570
  /**
@@ -8863,7 +10573,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
8863
10573
  * @param object Object containing the column names with their values to be persisted in the table.
8864
10574
  * @returns The full persisted record.
8865
10575
  */
8866
- abstract createOrReplace(object: Omit<EditableData<Record>, 'xata_id'> & Partial<Identifiable>, options?: {
10576
+ abstract createOrReplace(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, options?: {
8867
10577
  ifVersion?: number;
8868
10578
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
8869
10579
  /**
@@ -8874,7 +10584,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
8874
10584
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
8875
10585
  * @returns The full persisted record.
8876
10586
  */
8877
- abstract createOrReplace<K extends SelectableColumn<Record>>(id: Identifier | undefined, object: Omit<EditableData<Record>, 'xata_id'>, columns: K[], options?: {
10587
+ abstract createOrReplace<K extends SelectableColumn<Record>>(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
8878
10588
  ifVersion?: number;
8879
10589
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
8880
10590
  /**
@@ -8884,7 +10594,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
8884
10594
  * @param object The column names and the values to be persisted.
8885
10595
  * @returns The full persisted record.
8886
10596
  */
8887
- abstract createOrReplace(id: Identifier | undefined, object: Omit<EditableData<Record>, 'xata_id'>, options?: {
10597
+ abstract createOrReplace(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, options?: {
8888
10598
  ifVersion?: number;
8889
10599
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
8890
10600
  /**
@@ -8894,14 +10604,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
8894
10604
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
8895
10605
  * @returns Array of the persisted records.
8896
10606
  */
8897
- abstract createOrReplace<K extends SelectableColumn<Record>>(objects: Array<Omit<EditableData<Record>, 'xata_id'> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
10607
+ abstract createOrReplace<K extends SelectableColumn<Record>>(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
8898
10608
  /**
8899
10609
  * Creates or replaces a single record. If a record exists with the given id,
8900
10610
  * it will be replaced, otherwise a new record will be created.
8901
10611
  * @param objects Array of objects with the column names and the values to be stored in the table.
8902
10612
  * @returns Array of the persisted records.
8903
10613
  */
8904
- abstract createOrReplace(objects: Array<Omit<EditableData<Record>, 'xata_id'> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
10614
+ abstract createOrReplace(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
8905
10615
  /**
8906
10616
  * Deletes a record given its unique id.
8907
10617
  * @param object An object with a unique id.
@@ -9152,10 +10862,10 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
9152
10862
  createOrUpdate(object: EditableData<Record> & Partial<Identifiable>, options?: {
9153
10863
  ifVersion?: number;
9154
10864
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
9155
- createOrUpdate<K extends SelectableColumn<Record>>(id: Identifier, object: Omit<EditableData<Record>, 'xata_id'>, columns: K[], options?: {
10865
+ createOrUpdate<K extends SelectableColumn<Record>>(id: Identifier, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
9156
10866
  ifVersion?: number;
9157
10867
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
9158
- createOrUpdate(id: Identifier, object: Omit<EditableData<Record>, 'xata_id'>, options?: {
10868
+ createOrUpdate(id: Identifier, object: Omit<EditableData<Record>, 'id'>, options?: {
9159
10869
  ifVersion?: number;
9160
10870
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
9161
10871
  createOrUpdate<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
@@ -9166,10 +10876,10 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
9166
10876
  createOrReplace(object: EditableData<Record> & Partial<Identifiable>, options?: {
9167
10877
  ifVersion?: number;
9168
10878
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
9169
- createOrReplace<K extends SelectableColumn<Record>>(id: Identifier | undefined, object: Omit<EditableData<Record>, 'xata_id'>, columns: K[], options?: {
10879
+ createOrReplace<K extends SelectableColumn<Record>>(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
9170
10880
  ifVersion?: number;
9171
10881
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
9172
- createOrReplace(id: Identifier | undefined, object: Omit<EditableData<Record>, 'xata_id'>, options?: {
10882
+ createOrReplace(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, options?: {
9173
10883
  ifVersion?: number;
9174
10884
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
9175
10885
  createOrReplace<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
@@ -9264,7 +10974,7 @@ type PropertyType<Tables, Properties, PropertyName extends PropertyKey> = Proper
9264
10974
  } : {
9265
10975
  [K in PropertyName]?: InnerType<Type, Tables, LinkedTable> | null;
9266
10976
  } : never : never;
9267
- 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 : never;
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;
9268
10978
 
9269
10979
  /**
9270
10980
  * Operator to restrict results to only values that are greater than the given value.
@@ -9317,11 +11027,11 @@ declare const le: <T extends ComparableType>(value: T) => ComparableTypeFilter<T
9317
11027
  /**
9318
11028
  * Operator to restrict results to only values that are not null.
9319
11029
  */
9320
- declare const exists: <T>(column?: FilterColumns<T> | undefined) => ExistanceFilter<T>;
11030
+ declare const exists: <T>(column?: FilterColumns<T>) => ExistanceFilter<T>;
9321
11031
  /**
9322
11032
  * Operator to restrict results to only values that are null.
9323
11033
  */
9324
- declare const notExists: <T>(column?: FilterColumns<T> | undefined) => ExistanceFilter<T>;
11034
+ declare const notExists: <T>(column?: FilterColumns<T>) => ExistanceFilter<T>;
9325
11035
  /**
9326
11036
  * Operator to restrict results to only values that start with the given prefix.
9327
11037
  */
@@ -9443,10 +11153,37 @@ type SQLQueryParams<T = any[]> = {
9443
11153
  params?: T;
9444
11154
  /**
9445
11155
  * The consistency level to use when executing the query.
11156
+ * @default 'strong'
9446
11157
  */
9447
11158
  consistency?: 'strong' | 'eventual';
9448
11159
  /**
9449
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
+ */
11183
+ consistency?: 'strong' | 'eventual';
11184
+ /**
11185
+ * The response type to use when executing the queries.
11186
+ * @default 'json'
9450
11187
  */
9451
11188
  responseType?: 'json' | 'array';
9452
11189
  };
@@ -9487,7 +11224,22 @@ type SQLQueryResultArray = {
9487
11224
  warning?: string;
9488
11225
  };
9489
11226
  type SQLQueryResult<T, Mode extends SQLResponseType = 'json'> = Mode extends 'json' ? SQLQueryResultJSON<T> : Mode extends 'array' ? SQLQueryResultArray : never;
9490
- type SQLPluginResult = <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'>>;
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
+ };
9491
11243
  declare class SQLPlugin extends XataPlugin {
9492
11244
  build(pluginOptions: XataPluginOptions): SQLPluginResult;
9493
11245
  }
@@ -9597,12 +11349,13 @@ type BaseClientOptions = {
9597
11349
  apiKey?: string;
9598
11350
  databaseURL?: string;
9599
11351
  branch?: string;
11352
+ cache?: CacheImpl;
9600
11353
  trace?: TraceFunction;
9601
11354
  enableBrowser?: boolean;
9602
11355
  clientName?: string;
9603
11356
  xataAgentExtra?: Record<string, string>;
9604
11357
  };
9605
- declare const buildClient: <Plugins extends Record<string, XataPlugin> = {}>(plugins?: Plugins | undefined) => ClientConstructor<Plugins>;
11358
+ declare const buildClient: <Plugins extends Record<string, XataPlugin> = {}>(plugins?: Plugins) => ClientConstructor<Plugins>;
9606
11359
  interface ClientConstructor<Plugins extends Record<string, XataPlugin>> {
9607
11360
  new <Schemas extends Record<string, XataRecord> = {}>(options?: Partial<BaseClientOptions>, schemaTables?: readonly BaseSchema[]): Omit<{
9608
11361
  db: Awaited<ReturnType<SchemaPlugin<Schemas>['build']>>;
@@ -9653,4 +11406,4 @@ declare class XataError extends Error {
9653
11406
  constructor(message: string, status: number);
9654
11407
  }
9655
11408
 
9656
- export { type AcceptWorkspaceMemberInviteError, type AcceptWorkspaceMemberInvitePathParams, type AcceptWorkspaceMemberInviteVariables, 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, type BulkInsertTableRecordsError, type BulkInsertTableRecordsPathParams, type BulkInsertTableRecordsQueryParams, type BulkInsertTableRecordsRequestBody, type BulkInsertTableRecordsVariables, 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 GetBranchMigrationJobStatusError, type GetBranchMigrationJobStatusPathParams, type GetBranchMigrationJobStatusVariables, 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 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 GetMigrationHistoryVariables, type GetMigrationJobStatusError, type GetMigrationJobStatusPathParams, type GetMigrationJobStatusVariables, 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, 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, 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, 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 UpdateDatabaseSettingsError, type UpdateDatabaseSettingsPathParams, 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 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, adaptTable, 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, getBranchMigrationJobStatus, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getCluster, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseSettings, getDatabaseURL, getFile, getFileItem, getGitBranchesMapping, getHostUrl, getMigrationHistory, getMigrationJobStatus, 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, le, lessEquals, lessThan, lessThanEquals, listClusters, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, 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, updateDatabaseSettings, 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 };