@xata.io/client 0.0.0-alpha.vf3146932401a42c9c1237ca55ccf95a3026c8867 → 0.0.0-alpha.vf3266226539082e9f89714467487cab31bcdf147

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
@@ -57,11 +57,154 @@ type Response = {
57
57
  };
58
58
  type FetchImpl = (url: string, init?: RequestInit) => Promise<Response>;
59
59
 
60
+ type StringKeys<O> = Extract<keyof O, string>;
61
+ type Values<O> = O[StringKeys<O>];
62
+ type UnionToIntersection<T> = (T extends any ? (x: T) => any : never) extends (x: infer R) => any ? R : never;
63
+ type If<Condition, Then, Else> = Condition extends true ? Then : Else;
64
+ type IsObject<T> = T extends Record<string, any> ? true : false;
65
+ type IsArray<T> = T extends Array<any> ? true : false;
66
+ type RequiredBy<T, K extends keyof T> = T & {
67
+ [P in K]-?: NonNullable<T[P]>;
68
+ };
69
+ type GetArrayInnerType<T extends readonly any[]> = T[number];
70
+ type SingleOrArray<T> = T | T[];
71
+ type Dictionary<T> = Record<string, T>;
72
+ type OmitBy<T, K extends keyof T> = T extends any ? Omit<T, K> : never;
73
+ type Without<T, U> = {
74
+ [P in Exclude<keyof T, keyof U>]?: never;
75
+ };
76
+ type ExclusiveOr<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
77
+ type Explode<T> = keyof T extends infer K ? K extends unknown ? {
78
+ [I in keyof T]: I extends K ? T[I] : never;
79
+ } : never : never;
80
+ type AtMostOne<T> = Explode<Partial<T>>;
81
+ type AtLeastOne<T, U = {
82
+ [K in keyof T]: Pick<T, K>;
83
+ }> = Partial<T> & U[keyof U];
84
+ type ExactlyOne<T> = AtMostOne<T> & AtLeastOne<T>;
85
+ type Fn = (...args: any[]) => any;
86
+ type NarrowRaw<A> = (A extends [] ? [] : never) | (A extends Narrowable ? A : never) | {
87
+ [K in keyof A]: A[K] extends Fn ? A[K] : NarrowRaw<A[K]>;
88
+ };
89
+ type Narrowable = string | number | bigint | boolean;
90
+ type Try<A1, A2, Catch = never> = A1 extends A2 ? A1 : Catch;
91
+ type Narrow<A> = Try<A, [], NarrowRaw<A>>;
92
+ type RequiredKeys<T> = {
93
+ [K in keyof T]-?: {} extends Pick<T, K> ? never : K;
94
+ }[keyof T];
95
+
60
96
  /**
61
97
  * Generated by @openapi-codegen
62
98
  *
63
99
  * @version 1.0
64
100
  */
101
+ /**
102
+ * @x-internal true
103
+ * @pattern [a-zA-Z0-9_-~:]+
104
+ */
105
+ type ClusterID$1 = string;
106
+ /**
107
+ * Page size.
108
+ *
109
+ * @x-internal true
110
+ * @default 25
111
+ * @minimum 0
112
+ */
113
+ type PageSize$1 = number;
114
+ /**
115
+ * Page token
116
+ *
117
+ * @x-internal true
118
+ * @maxLength 255
119
+ * @minLength 24
120
+ */
121
+ type PageToken$1 = string;
122
+ /**
123
+ * @format date-time
124
+ * @x-go-type string
125
+ */
126
+ type DateTime$1 = string;
127
+ /**
128
+ * @x-internal true
129
+ */
130
+ type BranchDetails = {
131
+ name: string;
132
+ id: string;
133
+ /**
134
+ * The cluster where this branch resides.
135
+ *
136
+ * @minLength 1
137
+ */
138
+ clusterID: string;
139
+ state: string;
140
+ createdAt: DateTime$1;
141
+ databaseName: string;
142
+ databaseID: string;
143
+ };
144
+ /**
145
+ * @x-internal true
146
+ */
147
+ type PageResponse$1 = {
148
+ size: number;
149
+ hasMore: boolean;
150
+ token?: string;
151
+ };
152
+ /**
153
+ * @x-internal true
154
+ */
155
+ type ListClusterBranchesResponse = {
156
+ branches: BranchDetails[];
157
+ page?: PageResponse$1;
158
+ };
159
+ /**
160
+ * @x-internal true
161
+ */
162
+ type ExtensionDetails = {
163
+ name: string;
164
+ description: string;
165
+ status: 'installed' | 'not_installed';
166
+ version: string;
167
+ };
168
+ /**
169
+ * @x-internal true
170
+ */
171
+ type ListClusterExtensionsResponse = {
172
+ extensions: ExtensionDetails[];
173
+ };
174
+ /**
175
+ * @x-internal true
176
+ */
177
+ type ClusterExtensionInstallationResponse = {
178
+ extension: string;
179
+ status: 'success' | 'failure';
180
+ reason?: string;
181
+ };
182
+ /**
183
+ * @x-internal true
184
+ */
185
+ type MetricMessage = {
186
+ code?: string;
187
+ value?: string;
188
+ };
189
+ /**
190
+ * @x-internal true
191
+ */
192
+ type MetricData = {
193
+ id?: string;
194
+ label?: string;
195
+ messages?: MetricMessage[] | null;
196
+ status: 'complete' | 'error' | 'partial' | 'forbidden';
197
+ timestamps: string[];
198
+ values: number[];
199
+ };
200
+ /**
201
+ * @x-internal true
202
+ */
203
+ type MetricsResponse = {
204
+ metrics: MetricData[];
205
+ messages: MetricMessage[];
206
+ page?: PageResponse$1;
207
+ };
65
208
  /**
66
209
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
67
210
  *
@@ -76,6 +219,24 @@ type ApplyMigrationResponse = {
76
219
  */
77
220
  jobID: string;
78
221
  };
222
+ type StartMigrationResponse = {
223
+ /**
224
+ * The id of the migration job
225
+ */
226
+ jobID: string;
227
+ };
228
+ type CompleteMigrationResponse = {
229
+ /**
230
+ * The id of the migration job
231
+ */
232
+ jobID: string;
233
+ };
234
+ type RollbackMigrationResponse = {
235
+ /**
236
+ * The id of the migration job
237
+ */
238
+ jobID: string;
239
+ };
79
240
  /**
80
241
  * @maxLength 255
81
242
  * @minLength 1
@@ -84,6 +245,95 @@ type ApplyMigrationResponse = {
84
245
  type TableName = string;
85
246
  type MigrationJobType = 'apply' | 'start' | 'complete' | 'rollback';
86
247
  type MigrationJobStatus = 'pending' | 'in_progress' | 'completed' | 'failed';
248
+ /**
249
+ * The effect of a migration operation in terms of CRUD operations on the underlying schema
250
+ */
251
+ type MigrationOperationDescription = {
252
+ /**
253
+ * A new database object created by the operation
254
+ */
255
+ create?: {
256
+ /**
257
+ * The type of object created
258
+ */
259
+ type: 'table' | 'column' | 'index';
260
+ /**
261
+ * The name of the object created
262
+ */
263
+ name: string;
264
+ /**
265
+ * The name of the table on which the object is created, if applicable
266
+ */
267
+ table?: string;
268
+ /**
269
+ * The mapping between the virtual and physical name of the new object, if applicable
270
+ */
271
+ mapping?: Record<string, any>;
272
+ };
273
+ /**
274
+ * A database object updated by the operation
275
+ */
276
+ update?: {
277
+ /**
278
+ * The type of updated object
279
+ */
280
+ type: 'table' | 'column';
281
+ /**
282
+ * The name of the updated object
283
+ */
284
+ name: string;
285
+ /**
286
+ * The name of the table on which the object is updated, if applicable
287
+ */
288
+ table?: string;
289
+ /**
290
+ * The mapping between the virtual and physical name of the updated object, if applicable
291
+ */
292
+ mapping?: Record<string, any>;
293
+ };
294
+ /**
295
+ * A database object renamed by the operation
296
+ */
297
+ rename?: {
298
+ /**
299
+ * The type of the renamed object
300
+ */
301
+ type: 'table' | 'column' | 'constraint';
302
+ /**
303
+ * The name of the table on which the object is renamed, if applicable
304
+ */
305
+ table?: string;
306
+ /**
307
+ * The old name of the renamed object
308
+ */
309
+ from: string;
310
+ /**
311
+ * The new name of the renamed object
312
+ */
313
+ to: string;
314
+ };
315
+ /**
316
+ * A database object deleted by the operation
317
+ */
318
+ ['delete']?: {
319
+ /**
320
+ * The type of the deleted object
321
+ */
322
+ type: 'table' | 'column' | 'constraint' | 'index';
323
+ /**
324
+ * The name of the deleted object
325
+ */
326
+ name: string;
327
+ /**
328
+ * The name of the table on which the object is deleted, if applicable
329
+ */
330
+ table: string;
331
+ };
332
+ };
333
+ /**
334
+ * @minItems 1
335
+ */
336
+ type MigrationDescription = MigrationOperationDescription[];
87
337
  type MigrationJobStatusResponse = {
88
338
  /**
89
339
  * The id of the migration job
@@ -97,11 +347,69 @@ type MigrationJobStatusResponse = {
97
347
  * The status of the migration job
98
348
  */
99
349
  status: MigrationJobStatus;
350
+ /**
351
+ * The effect of any active migration on the schema
352
+ */
353
+ description?: MigrationDescription;
354
+ /**
355
+ * The timestamp at which the migration job completed or failed
356
+ *
357
+ * @format date-time
358
+ */
359
+ completedAt?: string;
360
+ /**
361
+ * The error message associated with the migration job
362
+ */
363
+ error?: string;
364
+ };
365
+ type MigrationJobItem = {
366
+ /**
367
+ * The id of the migration job
368
+ */
369
+ jobID: string;
370
+ /**
371
+ * The type of the migration job
372
+ */
373
+ type: MigrationJobType;
374
+ /**
375
+ * The status of the migration job
376
+ */
377
+ status: MigrationJobStatus;
378
+ /**
379
+ * The pgroll migration that was applied
380
+ */
381
+ migration?: string;
382
+ /**
383
+ * The effect of any active migration on the schema
384
+ */
385
+ description?: MigrationDescription;
386
+ /**
387
+ * The timestamp at which the migration job was enqueued
388
+ *
389
+ * @format date-time
390
+ */
391
+ enqueuedAt: string;
392
+ /**
393
+ * The timestamp at which the migration job completed or failed
394
+ *
395
+ * @format date-time
396
+ */
397
+ completedAt?: string;
100
398
  /**
101
399
  * The error message associated with the migration job
102
400
  */
103
401
  error?: string;
104
402
  };
403
+ type GetMigrationJobsResponse = {
404
+ /**
405
+ * The list of migration jobs
406
+ */
407
+ jobs: MigrationJobItem[];
408
+ /**
409
+ * The cursor (timestamp) for the next page of results
410
+ */
411
+ cursor?: string;
412
+ };
105
413
  /**
106
414
  * @maxLength 255
107
415
  * @minLength 1
@@ -114,6 +422,10 @@ type MigrationHistoryItem = {
114
422
  * The name of the migration
115
423
  */
116
424
  name: string;
425
+ /**
426
+ * The schema in which the migration was applied
427
+ */
428
+ schema: string;
117
429
  /**
118
430
  * The pgroll migration that was applied
119
431
  */
@@ -142,6 +454,10 @@ type MigrationHistoryResponse = {
142
454
  * The migrations that have been applied to the branch
143
455
  */
144
456
  migrations: MigrationHistoryItem[];
457
+ /**
458
+ * The cursor (timestamp) for the next page of results
459
+ */
460
+ cursor?: string;
145
461
  };
146
462
  /**
147
463
  * @maxLength 255
@@ -150,20 +466,21 @@ type MigrationHistoryResponse = {
150
466
  */
151
467
  type DBName$1 = string;
152
468
  /**
153
- * @format date-time
154
- * @x-go-type string
469
+ * Represent the state of the branch, used for branch lifecycle management
155
470
  */
156
- type DateTime$1 = string;
471
+ type BranchState = 'active' | 'move_scheduled' | 'moving';
157
472
  type Branch = {
158
473
  name: string;
159
474
  /**
160
475
  * The cluster where this branch resides. Value of 'shared-cluster' for branches in shared clusters
161
476
  *
162
477
  * @minLength 1
163
- * @x-internal true
164
478
  */
165
479
  clusterID?: string;
480
+ state: BranchState;
166
481
  createdAt: DateTime$1;
482
+ searchDisabled?: boolean;
483
+ inactiveSharedCluster?: boolean;
167
484
  };
168
485
  type ListBranchesResponse = {
169
486
  databaseName: string;
@@ -214,7 +531,7 @@ type ColumnFile = {
214
531
  };
215
532
  type Column = {
216
533
  name: string;
217
- type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'datetime' | 'vector' | 'file[]' | 'file' | 'json';
534
+ type: string;
218
535
  link?: ColumnLink;
219
536
  vector?: ColumnVector;
220
537
  file?: ColumnFile;
@@ -253,6 +570,7 @@ type DBBranch = {
253
570
  */
254
571
  clusterID?: string;
255
572
  version: number;
573
+ state: BranchState;
256
574
  lastMigrationID: string;
257
575
  metadata?: BranchMetadata$1;
258
576
  startedFrom?: StartedFromMetadata;
@@ -1488,6 +1806,57 @@ type FileSignature = string;
1488
1806
  type SQLRecord = {
1489
1807
  [key: string]: any;
1490
1808
  };
1809
+ /**
1810
+ * @default strong
1811
+ */
1812
+ type SQLConsistency = 'strong' | 'eventual';
1813
+ /**
1814
+ * @default json
1815
+ */
1816
+ type SQLResponseType$1 = 'json' | 'array';
1817
+ type PreparedStatement = {
1818
+ /**
1819
+ * The SQL statement.
1820
+ *
1821
+ * @minLength 1
1822
+ */
1823
+ statement: string;
1824
+ /**
1825
+ * The query parameter list.
1826
+ *
1827
+ * @x-go-type []any
1828
+ */
1829
+ params?: any[] | null;
1830
+ };
1831
+ type SQLResponseBase = {
1832
+ /**
1833
+ * Name of the column and its PostgreSQL type
1834
+ *
1835
+ * @x-go-type []sqlproxy.ColumnMeta
1836
+ */
1837
+ columns: {
1838
+ name: string;
1839
+ type: string;
1840
+ }[];
1841
+ /**
1842
+ * Number of selected columns
1843
+ */
1844
+ total: number;
1845
+ warning?: string;
1846
+ };
1847
+ type SQLResponseJSON = SQLResponseBase & {
1848
+ /**
1849
+ * @x-go-type []xata.Record
1850
+ */
1851
+ records: SQLRecord[];
1852
+ };
1853
+ type SQLResponseArray = SQLResponseBase & {
1854
+ /**
1855
+ * @x-go-type []xata.Row
1856
+ */
1857
+ rows: any[][];
1858
+ };
1859
+ type SQLResponse$1 = SQLResponseJSON | SQLResponseArray;
1491
1860
  /**
1492
1861
  * Xata Table Record Metadata
1493
1862
  */
@@ -1590,21 +1959,9 @@ type AggResponse = {
1590
1959
  [key: string]: AggResponse$1;
1591
1960
  };
1592
1961
  };
1593
- type SQLResponse = {
1594
- records?: SQLRecord[];
1595
- rows?: any[][];
1596
- /**
1597
- * Name of the column and its PostgreSQL type
1598
- */
1599
- columns?: {
1600
- name?: string;
1601
- type?: string;
1602
- }[];
1603
- /**
1604
- * Number of selected columns
1605
- */
1606
- total?: number;
1607
- warning?: string;
1962
+ type SQLResponse = SQLResponse$1;
1963
+ type SQLBatchResponse = {
1964
+ results: SQLResponse$1[];
1608
1965
  };
1609
1966
 
1610
1967
  /**
@@ -1701,7 +2058,7 @@ type Workspace = WorkspaceMeta & {
1701
2058
  plan: WorkspacePlan;
1702
2059
  };
1703
2060
  type WorkspaceSettings = {
1704
- postgresEnabled: boolean;
2061
+ dedicatedClusters: boolean;
1705
2062
  };
1706
2063
  type WorkspaceMember = {
1707
2064
  userId: UserID;
@@ -1769,6 +2126,8 @@ type ClusterShortMetadata = {
1769
2126
  * @format int64
1770
2127
  */
1771
2128
  branches: number;
2129
+ createdAt: DateTime;
2130
+ terminatedAt?: DateTime;
1772
2131
  };
1773
2132
  /**
1774
2133
  * @x-internal true
@@ -1866,6 +2225,13 @@ type ClusterConfiguration = {
1866
2225
  * @format int64
1867
2226
  */
1868
2227
  replicas?: number;
2228
+ /**
2229
+ * @format int64
2230
+ * @default 1
2231
+ * @maximum 3
2232
+ * @minimum 1
2233
+ */
2234
+ instanceCount?: number;
1869
2235
  /**
1870
2236
  * @default false
1871
2237
  */
@@ -1884,7 +2250,7 @@ type ClusterCreateDetails = {
1884
2250
  /**
1885
2251
  * @maxLength 63
1886
2252
  * @minLength 1
1887
- * @pattern [a-zA-Z0-9_-~:]+
2253
+ * @pattern [a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*
1888
2254
  */
1889
2255
  name: string;
1890
2256
  configuration: ClusterConfiguration;
@@ -1936,6 +2302,10 @@ type ClusterConfigurationResponse = {
1936
2302
  * @format int64
1937
2303
  */
1938
2304
  replicas: number;
2305
+ /**
2306
+ * @format int64
2307
+ */
2308
+ instanceCount: number;
1939
2309
  /**
1940
2310
  * @default false
1941
2311
  */
@@ -1957,6 +2327,19 @@ type ClusterMetadata = {
1957
2327
  branches: number;
1958
2328
  configuration: ClusterConfigurationResponse;
1959
2329
  };
2330
+ /**
2331
+ * @x-internal true
2332
+ */
2333
+ type ClusterDeleteMetadata = {
2334
+ id: ClusterID;
2335
+ state: string;
2336
+ region: string;
2337
+ name: string;
2338
+ /**
2339
+ * @format int64
2340
+ */
2341
+ branches: number;
2342
+ };
1960
2343
  /**
1961
2344
  * @x-internal true
1962
2345
  */
@@ -1994,7 +2377,7 @@ type DatabaseMetadata = {
1994
2377
  */
1995
2378
  newMigrations?: boolean;
1996
2379
  /**
1997
- * @x-internal true
2380
+ * The default cluster ID where branches from this database reside. Value of 'shared-cluster' for branches in shared clusters.
1998
2381
  */
1999
2382
  defaultClusterID?: string;
2000
2383
  /**
@@ -2434,6 +2817,7 @@ type GetWorkspacesListError = ErrorWrapper$1<{
2434
2817
  type GetWorkspacesListResponse = {
2435
2818
  workspaces: {
2436
2819
  id: WorkspaceID;
2820
+ unique_id: string;
2437
2821
  name: string;
2438
2822
  slug: string;
2439
2823
  role: Role;
@@ -2586,11 +2970,8 @@ type UpdateWorkspaceSettingsError = ErrorWrapper$1<{
2586
2970
  status: 404;
2587
2971
  payload: SimpleError;
2588
2972
  }>;
2589
- type UpdateWorkspaceSettingsRequestBody = {
2590
- postgresEnabled: boolean;
2591
- };
2592
2973
  type UpdateWorkspaceSettingsVariables = {
2593
- body: UpdateWorkspaceSettingsRequestBody;
2974
+ body?: Record<string, any>;
2594
2975
  pathParams: UpdateWorkspaceSettingsPathParams;
2595
2976
  } & ControlPlaneFetcherExtraProps;
2596
2977
  /**
@@ -2955,6 +3336,30 @@ type UpdateClusterVariables = {
2955
3336
  * Update cluster for given cluster ID
2956
3337
  */
2957
3338
  declare const updateCluster: (variables: UpdateClusterVariables, signal?: AbortSignal) => Promise<ClusterUpdateMetadata>;
3339
+ type DeleteClusterPathParams = {
3340
+ /**
3341
+ * Workspace ID
3342
+ */
3343
+ workspaceId: WorkspaceID;
3344
+ /**
3345
+ * Cluster ID
3346
+ */
3347
+ clusterId: ClusterID;
3348
+ };
3349
+ type DeleteClusterError = ErrorWrapper$1<{
3350
+ status: 400;
3351
+ payload: BadRequestError;
3352
+ } | {
3353
+ status: 401;
3354
+ payload: AuthError;
3355
+ }>;
3356
+ type DeleteClusterVariables = {
3357
+ pathParams: DeleteClusterPathParams;
3358
+ } & ControlPlaneFetcherExtraProps;
3359
+ /**
3360
+ * Delete cluster with given cluster ID
3361
+ */
3362
+ declare const deleteCluster: (variables: DeleteClusterVariables, signal?: AbortSignal) => Promise<ClusterDeleteMetadata>;
2958
3363
  type GetDatabaseListPathParams = {
2959
3364
  /**
2960
3365
  * Workspace ID
@@ -3303,6 +3708,174 @@ type ErrorWrapper<TError> = TError | {
3303
3708
  * @version 1.0
3304
3709
  */
3305
3710
 
3711
+ type ListClusterBranchesPathParams = {
3712
+ /**
3713
+ * Cluster ID
3714
+ */
3715
+ clusterId: ClusterID$1;
3716
+ workspace: string;
3717
+ region: string;
3718
+ };
3719
+ type ListClusterBranchesQueryParams = {
3720
+ /**
3721
+ * Page size
3722
+ */
3723
+ page?: PageSize$1;
3724
+ /**
3725
+ * Page token
3726
+ */
3727
+ token?: PageToken$1;
3728
+ };
3729
+ type ListClusterBranchesError = ErrorWrapper<{
3730
+ status: 400;
3731
+ payload: BadRequestError$1;
3732
+ } | {
3733
+ status: 401;
3734
+ payload: AuthError$1;
3735
+ }>;
3736
+ type ListClusterBranchesVariables = {
3737
+ pathParams: ListClusterBranchesPathParams;
3738
+ queryParams?: ListClusterBranchesQueryParams;
3739
+ } & DataPlaneFetcherExtraProps;
3740
+ /**
3741
+ * Retrieve branches for given cluster ID
3742
+ */
3743
+ declare const listClusterBranches: (variables: ListClusterBranchesVariables, signal?: AbortSignal) => Promise<ListClusterBranchesResponse>;
3744
+ type ListClusterExtensionsPathParams = {
3745
+ /**
3746
+ * Cluster ID
3747
+ */
3748
+ clusterId: ClusterID$1;
3749
+ workspace: string;
3750
+ region: string;
3751
+ };
3752
+ type ListClusterExtensionsQueryParams = {
3753
+ extensionType: 'available' | 'installed';
3754
+ };
3755
+ type ListClusterExtensionsError = ErrorWrapper<{
3756
+ status: 400;
3757
+ payload: BadRequestError$1;
3758
+ } | {
3759
+ status: 401;
3760
+ payload: AuthError$1;
3761
+ }>;
3762
+ type ListClusterExtensionsVariables = {
3763
+ pathParams: ListClusterExtensionsPathParams;
3764
+ queryParams: ListClusterExtensionsQueryParams;
3765
+ } & DataPlaneFetcherExtraProps;
3766
+ /**
3767
+ * Retrieve extensions for given cluster ID
3768
+ */
3769
+ declare const listClusterExtensions: (variables: ListClusterExtensionsVariables, signal?: AbortSignal) => Promise<ListClusterExtensionsResponse>;
3770
+ type InstallClusterExtensionPathParams = {
3771
+ /**
3772
+ * Cluster ID
3773
+ */
3774
+ clusterId: ClusterID$1;
3775
+ workspace: string;
3776
+ region: string;
3777
+ };
3778
+ type InstallClusterExtensionError = ErrorWrapper<{
3779
+ status: 400;
3780
+ payload: BadRequestError$1;
3781
+ } | {
3782
+ status: 401;
3783
+ payload: AuthError$1;
3784
+ }>;
3785
+ type InstallClusterExtensionRequestBody = {
3786
+ /**
3787
+ * Extension name
3788
+ */
3789
+ extension: string;
3790
+ /**
3791
+ * Schema name
3792
+ */
3793
+ schema?: string;
3794
+ /**
3795
+ * install with cascade option
3796
+ */
3797
+ cascade?: boolean;
3798
+ };
3799
+ type InstallClusterExtensionVariables = {
3800
+ body: InstallClusterExtensionRequestBody;
3801
+ pathParams: InstallClusterExtensionPathParams;
3802
+ } & DataPlaneFetcherExtraProps;
3803
+ /**
3804
+ * Install an extension for given cluster ID
3805
+ */
3806
+ declare const installClusterExtension: (variables: InstallClusterExtensionVariables, signal?: AbortSignal) => Promise<ClusterExtensionInstallationResponse>;
3807
+ type DropClusterExtensionPathParams = {
3808
+ /**
3809
+ * Cluster ID
3810
+ */
3811
+ clusterId: ClusterID$1;
3812
+ workspace: string;
3813
+ region: string;
3814
+ };
3815
+ type DropClusterExtensionError = ErrorWrapper<{
3816
+ status: 400;
3817
+ payload: BadRequestError$1;
3818
+ } | {
3819
+ status: 401;
3820
+ payload: AuthError$1;
3821
+ }>;
3822
+ type DropClusterExtensionRequestBody = {
3823
+ /**
3824
+ * Extension name
3825
+ */
3826
+ extension: string;
3827
+ /**
3828
+ * drop with cascade option, true by default
3829
+ */
3830
+ cascade?: boolean;
3831
+ };
3832
+ type DropClusterExtensionVariables = {
3833
+ body: DropClusterExtensionRequestBody;
3834
+ pathParams: DropClusterExtensionPathParams;
3835
+ } & DataPlaneFetcherExtraProps;
3836
+ /**
3837
+ * Drop an extension for given cluster ID
3838
+ */
3839
+ declare const dropClusterExtension: (variables: DropClusterExtensionVariables, signal?: AbortSignal) => Promise<undefined>;
3840
+ type GetClusterMetricsPathParams = {
3841
+ /**
3842
+ * Cluster ID
3843
+ */
3844
+ clusterId: ClusterID$1;
3845
+ workspace: string;
3846
+ region: string;
3847
+ };
3848
+ type GetClusterMetricsQueryParams = {
3849
+ startTime: string;
3850
+ endTime: string;
3851
+ period: '5min' | '15min' | '1hour';
3852
+ /**
3853
+ * Page size
3854
+ */
3855
+ page?: PageSize$1;
3856
+ /**
3857
+ * Page token
3858
+ */
3859
+ token?: PageToken$1;
3860
+ };
3861
+ type GetClusterMetricsError = ErrorWrapper<{
3862
+ status: 400;
3863
+ payload: BadRequestError$1;
3864
+ } | {
3865
+ status: 401;
3866
+ payload: AuthError$1;
3867
+ } | {
3868
+ status: 404;
3869
+ payload: SimpleError$1;
3870
+ }>;
3871
+ type GetClusterMetricsVariables = {
3872
+ pathParams: GetClusterMetricsPathParams;
3873
+ queryParams: GetClusterMetricsQueryParams;
3874
+ } & DataPlaneFetcherExtraProps;
3875
+ /**
3876
+ * retrieve a standard set of RDS cluster metrics
3877
+ */
3878
+ declare const getClusterMetrics: (variables: GetClusterMetricsVariables, signal?: AbortSignal) => Promise<MetricsResponse>;
3306
3879
  type ApplyMigrationPathParams = {
3307
3880
  /**
3308
3881
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -3329,16 +3902,131 @@ type ApplyMigrationRequestBody = {
3329
3902
  operations: {
3330
3903
  [key: string]: any;
3331
3904
  }[];
3905
+ /**
3906
+ * The schema in which the migration should be applied
3907
+ *
3908
+ * @default public
3909
+ */
3910
+ schema?: string;
3332
3911
  adaptTables?: boolean;
3333
3912
  };
3334
- type ApplyMigrationVariables = {
3335
- body: ApplyMigrationRequestBody;
3336
- pathParams: ApplyMigrationPathParams;
3913
+ type ApplyMigrationVariables = {
3914
+ body: ApplyMigrationRequestBody;
3915
+ pathParams: ApplyMigrationPathParams;
3916
+ } & DataPlaneFetcherExtraProps;
3917
+ /**
3918
+ * Applies a pgroll migration to the specified database.
3919
+ */
3920
+ declare const applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
3921
+ type StartMigrationPathParams = {
3922
+ /**
3923
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3924
+ */
3925
+ dbBranchName: DBBranchName;
3926
+ workspace: string;
3927
+ region: string;
3928
+ };
3929
+ type StartMigrationError = ErrorWrapper<{
3930
+ status: 400;
3931
+ payload: BadRequestError$1;
3932
+ } | {
3933
+ status: 401;
3934
+ payload: AuthError$1;
3935
+ } | {
3936
+ status: 404;
3937
+ payload: SimpleError$1;
3938
+ }>;
3939
+ type StartMigrationRequestBody = {
3940
+ /**
3941
+ * Migration name
3942
+ */
3943
+ name?: string;
3944
+ operations: {
3945
+ [key: string]: any;
3946
+ }[];
3947
+ /**
3948
+ * The schema in which the migration should be started
3949
+ *
3950
+ * @default public
3951
+ */
3952
+ schema?: string;
3953
+ };
3954
+ type StartMigrationVariables = {
3955
+ body: StartMigrationRequestBody;
3956
+ pathParams: StartMigrationPathParams;
3957
+ } & DataPlaneFetcherExtraProps;
3958
+ /**
3959
+ * Starts a pgroll migration on the specified database.
3960
+ */
3961
+ declare const startMigration: (variables: StartMigrationVariables, signal?: AbortSignal) => Promise<StartMigrationResponse>;
3962
+ type CompleteMigrationPathParams = {
3963
+ /**
3964
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3965
+ */
3966
+ dbBranchName: DBBranchName;
3967
+ workspace: string;
3968
+ region: string;
3969
+ };
3970
+ type CompleteMigrationError = ErrorWrapper<{
3971
+ status: 400;
3972
+ payload: BadRequestError$1;
3973
+ } | {
3974
+ status: 401;
3975
+ payload: AuthError$1;
3976
+ } | {
3977
+ status: 404;
3978
+ payload: SimpleError$1;
3979
+ }>;
3980
+ type CompleteMigrationRequestBody = {
3981
+ /**
3982
+ * The schema in which the migration should be completed
3983
+ *
3984
+ * @default public
3985
+ */
3986
+ schema?: string;
3987
+ };
3988
+ type CompleteMigrationVariables = {
3989
+ body?: CompleteMigrationRequestBody;
3990
+ pathParams: CompleteMigrationPathParams;
3991
+ } & DataPlaneFetcherExtraProps;
3992
+ /**
3993
+ * Complete an active migration on the specified database
3994
+ */
3995
+ declare const completeMigration: (variables: CompleteMigrationVariables, signal?: AbortSignal) => Promise<CompleteMigrationResponse>;
3996
+ type RollbackMigrationPathParams = {
3997
+ /**
3998
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3999
+ */
4000
+ dbBranchName: DBBranchName;
4001
+ workspace: string;
4002
+ region: string;
4003
+ };
4004
+ type RollbackMigrationError = ErrorWrapper<{
4005
+ status: 400;
4006
+ payload: BadRequestError$1;
4007
+ } | {
4008
+ status: 401;
4009
+ payload: AuthError$1;
4010
+ } | {
4011
+ status: 404;
4012
+ payload: SimpleError$1;
4013
+ }>;
4014
+ type RollbackMigrationRequestBody = {
4015
+ /**
4016
+ * The schema in which the migration should be rolled back
4017
+ *
4018
+ * @default public
4019
+ */
4020
+ schema?: string;
4021
+ };
4022
+ type RollbackMigrationVariables = {
4023
+ body?: RollbackMigrationRequestBody;
4024
+ pathParams: RollbackMigrationPathParams;
3337
4025
  } & DataPlaneFetcherExtraProps;
3338
4026
  /**
3339
- * Applies a pgroll migration to the specified database.
4027
+ * Roll back an active migration on the specified database
3340
4028
  */
3341
- declare const applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
4029
+ declare const rollbackMigration: (variables: RollbackMigrationVariables, signal?: AbortSignal) => Promise<RollbackMigrationResponse>;
3342
4030
  type AdaptTablePathParams = {
3343
4031
  /**
3344
4032
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -3368,6 +4056,31 @@ type AdaptTableVariables = {
3368
4056
  * Adapt a table to be used from Xata, this will add the Xata metadata fields to the table, making it accessible through the data API.
3369
4057
  */
3370
4058
  declare const adaptTable: (variables: AdaptTableVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
4059
+ type AdaptAllTablesPathParams = {
4060
+ /**
4061
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4062
+ */
4063
+ dbBranchName: DBBranchName;
4064
+ workspace: string;
4065
+ region: string;
4066
+ };
4067
+ type AdaptAllTablesError = ErrorWrapper<{
4068
+ status: 400;
4069
+ payload: BadRequestError$1;
4070
+ } | {
4071
+ status: 401;
4072
+ payload: AuthError$1;
4073
+ } | {
4074
+ status: 404;
4075
+ payload: SimpleError$1;
4076
+ }>;
4077
+ type AdaptAllTablesVariables = {
4078
+ pathParams: AdaptAllTablesPathParams;
4079
+ } & DataPlaneFetcherExtraProps;
4080
+ /**
4081
+ * Adapt all xata incompatible tables present in the branch, this will add the Xata metadata fields to the table, making them accessible through the data API.
4082
+ */
4083
+ declare const adaptAllTables: (variables: AdaptAllTablesVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
3371
4084
  type GetBranchMigrationJobStatusPathParams = {
3372
4085
  /**
3373
4086
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -3390,6 +4103,39 @@ type GetBranchMigrationJobStatusVariables = {
3390
4103
  pathParams: GetBranchMigrationJobStatusPathParams;
3391
4104
  } & DataPlaneFetcherExtraProps;
3392
4105
  declare const getBranchMigrationJobStatus: (variables: GetBranchMigrationJobStatusVariables, signal?: AbortSignal) => Promise<MigrationJobStatusResponse>;
4106
+ type GetMigrationJobsPathParams = {
4107
+ /**
4108
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4109
+ */
4110
+ dbBranchName: DBBranchName;
4111
+ workspace: string;
4112
+ region: string;
4113
+ };
4114
+ type GetMigrationJobsQueryParams = {
4115
+ /**
4116
+ * @format date-time
4117
+ */
4118
+ cursor?: string;
4119
+ /**
4120
+ * Page size
4121
+ */
4122
+ limit?: PageSize$1;
4123
+ };
4124
+ type GetMigrationJobsError = ErrorWrapper<{
4125
+ status: 400;
4126
+ payload: BadRequestError$1;
4127
+ } | {
4128
+ status: 401;
4129
+ payload: AuthError$1;
4130
+ } | {
4131
+ status: 404;
4132
+ payload: SimpleError$1;
4133
+ }>;
4134
+ type GetMigrationJobsVariables = {
4135
+ pathParams: GetMigrationJobsPathParams;
4136
+ queryParams?: GetMigrationJobsQueryParams;
4137
+ } & DataPlaneFetcherExtraProps;
4138
+ declare const getMigrationJobs: (variables: GetMigrationJobsVariables, signal?: AbortSignal) => Promise<GetMigrationJobsResponse>;
3393
4139
  type GetMigrationJobStatusPathParams = {
3394
4140
  /**
3395
4141
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -3424,6 +4170,16 @@ type GetMigrationHistoryPathParams = {
3424
4170
  workspace: string;
3425
4171
  region: string;
3426
4172
  };
4173
+ type GetMigrationHistoryQueryParams = {
4174
+ /**
4175
+ * @format date-time
4176
+ */
4177
+ cursor?: string;
4178
+ /**
4179
+ * Page size
4180
+ */
4181
+ limit?: PageSize$1;
4182
+ };
3427
4183
  type GetMigrationHistoryError = ErrorWrapper<{
3428
4184
  status: 400;
3429
4185
  payload: BadRequestError$1;
@@ -3436,6 +4192,7 @@ type GetMigrationHistoryError = ErrorWrapper<{
3436
4192
  }>;
3437
4193
  type GetMigrationHistoryVariables = {
3438
4194
  pathParams: GetMigrationHistoryPathParams;
4195
+ queryParams?: GetMigrationHistoryQueryParams;
3439
4196
  } & DataPlaneFetcherExtraProps;
3440
4197
  declare const getMigrationHistory: (variables: GetMigrationHistoryVariables, signal?: AbortSignal) => Promise<MigrationHistoryResponse>;
3441
4198
  type GetBranchListPathParams = {
@@ -3650,6 +4407,31 @@ type GetSchemaVariables = {
3650
4407
  pathParams: GetSchemaPathParams;
3651
4408
  } & DataPlaneFetcherExtraProps;
3652
4409
  declare const getSchema: (variables: GetSchemaVariables, signal?: AbortSignal) => Promise<GetSchemaResponse>;
4410
+ type GetSchemasPathParams = {
4411
+ /**
4412
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4413
+ */
4414
+ dbBranchName: DBBranchName;
4415
+ workspace: string;
4416
+ region: string;
4417
+ };
4418
+ type GetSchemasError = ErrorWrapper<{
4419
+ status: 400;
4420
+ payload: BadRequestError$1;
4421
+ } | {
4422
+ status: 401;
4423
+ payload: AuthError$1;
4424
+ } | {
4425
+ status: 404;
4426
+ payload: SimpleError$1;
4427
+ }>;
4428
+ type GetSchemasResponse = {
4429
+ schemas: BranchSchema[];
4430
+ };
4431
+ type GetSchemasVariables = {
4432
+ pathParams: GetSchemasPathParams;
4433
+ } & DataPlaneFetcherExtraProps;
4434
+ declare const getSchemas: (variables: GetSchemasVariables, signal?: AbortSignal) => Promise<GetSchemasResponse>;
3653
4435
  type CopyBranchPathParams = {
3654
4436
  /**
3655
4437
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -3680,6 +4462,73 @@ type CopyBranchVariables = {
3680
4462
  * Create a copy of the branch
3681
4463
  */
3682
4464
  declare const copyBranch: (variables: CopyBranchVariables, signal?: AbortSignal) => Promise<BranchWithCopyID>;
4465
+ type GetBranchMoveStatusPathParams = {
4466
+ /**
4467
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4468
+ */
4469
+ dbBranchName: DBBranchName;
4470
+ workspace: string;
4471
+ region: string;
4472
+ };
4473
+ type GetBranchMoveStatusError = ErrorWrapper<{
4474
+ status: 400;
4475
+ payload: BadRequestError$1;
4476
+ } | {
4477
+ status: 401;
4478
+ payload: AuthError$1;
4479
+ } | {
4480
+ status: 404;
4481
+ payload: SimpleError$1;
4482
+ }>;
4483
+ type GetBranchMoveStatusResponse = {
4484
+ state: string;
4485
+ pendingBytes: number;
4486
+ };
4487
+ type GetBranchMoveStatusVariables = {
4488
+ pathParams: GetBranchMoveStatusPathParams;
4489
+ } & DataPlaneFetcherExtraProps;
4490
+ /**
4491
+ * Get the branch move status (if a move is happening)
4492
+ */
4493
+ declare const getBranchMoveStatus: (variables: GetBranchMoveStatusVariables, signal?: AbortSignal) => Promise<GetBranchMoveStatusResponse>;
4494
+ type MoveBranchPathParams = {
4495
+ /**
4496
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4497
+ */
4498
+ dbBranchName: DBBranchName;
4499
+ workspace: string;
4500
+ region: string;
4501
+ };
4502
+ type MoveBranchError = ErrorWrapper<{
4503
+ status: 400;
4504
+ payload: BadRequestError$1;
4505
+ } | {
4506
+ status: 401;
4507
+ payload: AuthError$1;
4508
+ } | {
4509
+ status: 404;
4510
+ payload: SimpleError$1;
4511
+ } | {
4512
+ status: 423;
4513
+ payload: SimpleError$1;
4514
+ }>;
4515
+ type MoveBranchResponse = {
4516
+ state: string;
4517
+ };
4518
+ type MoveBranchRequestBody = {
4519
+ /**
4520
+ * Select the cluster to move the branch to. Must be different from the current cluster.
4521
+ *
4522
+ * @minLength 1
4523
+ * @x-internal true
4524
+ */
4525
+ to: string;
4526
+ };
4527
+ type MoveBranchVariables = {
4528
+ body: MoveBranchRequestBody;
4529
+ pathParams: MoveBranchPathParams;
4530
+ } & DataPlaneFetcherExtraProps;
4531
+ declare const moveBranch: (variables: MoveBranchVariables, signal?: AbortSignal) => Promise<MoveBranchResponse>;
3683
4532
  type UpdateBranchMetadataPathParams = {
3684
4533
  /**
3685
4534
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -6854,186 +7703,222 @@ type SqlQueryError = ErrorWrapper<{
6854
7703
  status: 503;
6855
7704
  payload: ServiceUnavailableError;
6856
7705
  }>;
6857
- type SqlQueryRequestBody = {
6858
- /**
6859
- * The SQL statement.
6860
- *
6861
- * @minLength 1
6862
- */
6863
- statement: string;
6864
- /**
6865
- * The query parameter list.
6866
- */
6867
- params?: any[] | null;
7706
+ type SqlQueryRequestBody = PreparedStatement & {
7707
+ consistency?: SQLConsistency;
7708
+ responseType?: SQLResponseType$1;
7709
+ };
7710
+ type SqlQueryVariables = {
7711
+ body: SqlQueryRequestBody;
7712
+ pathParams: SqlQueryPathParams;
7713
+ } & DataPlaneFetcherExtraProps;
7714
+ /**
7715
+ * Run an SQL query across the database branch.
7716
+ */
7717
+ declare const sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<SQLResponse$1>;
7718
+ type SqlBatchQueryPathParams = {
6868
7719
  /**
6869
- * The consistency level for this request.
6870
- *
6871
- * @default strong
7720
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
6872
7721
  */
6873
- consistency?: 'strong' | 'eventual';
7722
+ dbBranchName: DBBranchName;
7723
+ workspace: string;
7724
+ region: string;
7725
+ };
7726
+ type SqlBatchQueryError = ErrorWrapper<{
7727
+ status: 400;
7728
+ payload: BadRequestError$1;
7729
+ } | {
7730
+ status: 401;
7731
+ payload: AuthError$1;
7732
+ } | {
7733
+ status: 404;
7734
+ payload: SimpleError$1;
7735
+ } | {
7736
+ status: 503;
7737
+ payload: ServiceUnavailableError;
7738
+ }>;
7739
+ type SqlBatchQueryRequestBody = {
6874
7740
  /**
6875
- * The response type.
7741
+ * The SQL statements.
6876
7742
  *
6877
- * @default json
7743
+ * @x-go-type []sqlproxy.PreparedStatement
6878
7744
  */
6879
- responseType?: 'json' | 'array';
7745
+ statements: PreparedStatement[];
7746
+ consistency?: SQLConsistency;
7747
+ responseType?: SQLResponseType$1;
6880
7748
  };
6881
- type SqlQueryVariables = {
6882
- body: SqlQueryRequestBody;
6883
- pathParams: SqlQueryPathParams;
7749
+ type SqlBatchQueryVariables = {
7750
+ body: SqlBatchQueryRequestBody;
7751
+ pathParams: SqlBatchQueryPathParams;
6884
7752
  } & DataPlaneFetcherExtraProps;
6885
7753
  /**
6886
- * Run an SQL query across the database branch.
7754
+ * Run multiple SQL queries across the database branch.
6887
7755
  */
6888
- declare const sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<SQLResponse>;
7756
+ declare const sqlBatchQuery: (variables: SqlBatchQueryVariables, signal?: AbortSignal) => Promise<SQLBatchResponse>;
6889
7757
 
6890
7758
  declare const operationsByTag: {
6891
7759
  branch: {
6892
- getBranchList: (variables: GetBranchListVariables, signal?: AbortSignal | undefined) => Promise<ListBranchesResponse>;
6893
- getBranchDetails: (variables: GetBranchDetailsVariables, signal?: AbortSignal | undefined) => Promise<DBBranch>;
6894
- createBranch: (variables: CreateBranchVariables, signal?: AbortSignal | undefined) => Promise<CreateBranchResponse>;
6895
- deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal | undefined) => Promise<DeleteBranchResponse>;
6896
- copyBranch: (variables: CopyBranchVariables, signal?: AbortSignal | undefined) => Promise<BranchWithCopyID>;
6897
- updateBranchMetadata: (variables: UpdateBranchMetadataVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
6898
- getBranchMetadata: (variables: GetBranchMetadataVariables, signal?: AbortSignal | undefined) => Promise<BranchMetadata$1>;
6899
- getBranchStats: (variables: GetBranchStatsVariables, signal?: AbortSignal | undefined) => Promise<GetBranchStatsResponse>;
6900
- getGitBranchesMapping: (variables: GetGitBranchesMappingVariables, signal?: AbortSignal | undefined) => Promise<ListGitBranchesResponse>;
6901
- addGitBranchesEntry: (variables: AddGitBranchesEntryVariables, signal?: AbortSignal | undefined) => Promise<AddGitBranchesEntryResponse>;
6902
- removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
6903
- resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal | undefined) => Promise<ResolveBranchResponse>;
7760
+ getBranchList: (variables: GetBranchListVariables, signal?: AbortSignal) => Promise<ListBranchesResponse>;
7761
+ getBranchDetails: (variables: GetBranchDetailsVariables, signal?: AbortSignal) => Promise<DBBranch>;
7762
+ createBranch: (variables: CreateBranchVariables, signal?: AbortSignal) => Promise<CreateBranchResponse>;
7763
+ deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal) => Promise<DeleteBranchResponse>;
7764
+ copyBranch: (variables: CopyBranchVariables, signal?: AbortSignal) => Promise<BranchWithCopyID>;
7765
+ getBranchMoveStatus: (variables: GetBranchMoveStatusVariables, signal?: AbortSignal) => Promise<GetBranchMoveStatusResponse>;
7766
+ moveBranch: (variables: MoveBranchVariables, signal?: AbortSignal) => Promise<MoveBranchResponse>;
7767
+ updateBranchMetadata: (variables: UpdateBranchMetadataVariables, signal?: AbortSignal) => Promise<undefined>;
7768
+ getBranchMetadata: (variables: GetBranchMetadataVariables, signal?: AbortSignal) => Promise<BranchMetadata$1>;
7769
+ getBranchStats: (variables: GetBranchStatsVariables, signal?: AbortSignal) => Promise<GetBranchStatsResponse>;
7770
+ getGitBranchesMapping: (variables: GetGitBranchesMappingVariables, signal?: AbortSignal) => Promise<ListGitBranchesResponse>;
7771
+ addGitBranchesEntry: (variables: AddGitBranchesEntryVariables, signal?: AbortSignal) => Promise<AddGitBranchesEntryResponse>;
7772
+ removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables, signal?: AbortSignal) => Promise<undefined>;
7773
+ resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal) => Promise<ResolveBranchResponse>;
6904
7774
  };
6905
7775
  workspaces: {
6906
- getWorkspacesList: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetWorkspacesListResponse>;
6907
- createWorkspace: (variables: CreateWorkspaceVariables, signal?: AbortSignal | undefined) => Promise<Workspace>;
6908
- getWorkspace: (variables: GetWorkspaceVariables, signal?: AbortSignal | undefined) => Promise<Workspace>;
6909
- updateWorkspace: (variables: UpdateWorkspaceVariables, signal?: AbortSignal | undefined) => Promise<Workspace>;
6910
- deleteWorkspace: (variables: DeleteWorkspaceVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
6911
- getWorkspaceSettings: (variables: GetWorkspaceSettingsVariables, signal?: AbortSignal | undefined) => Promise<WorkspaceSettings>;
6912
- updateWorkspaceSettings: (variables: UpdateWorkspaceSettingsVariables, signal?: AbortSignal | undefined) => Promise<WorkspaceSettings>;
6913
- getWorkspaceMembersList: (variables: GetWorkspaceMembersListVariables, signal?: AbortSignal | undefined) => Promise<WorkspaceMembers>;
6914
- updateWorkspaceMemberRole: (variables: UpdateWorkspaceMemberRoleVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
6915
- removeWorkspaceMember: (variables: RemoveWorkspaceMemberVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
7776
+ getWorkspacesList: (variables: GetWorkspacesListVariables, signal?: AbortSignal) => Promise<GetWorkspacesListResponse>;
7777
+ createWorkspace: (variables: CreateWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
7778
+ getWorkspace: (variables: GetWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
7779
+ updateWorkspace: (variables: UpdateWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
7780
+ deleteWorkspace: (variables: DeleteWorkspaceVariables, signal?: AbortSignal) => Promise<undefined>;
7781
+ getWorkspaceSettings: (variables: GetWorkspaceSettingsVariables, signal?: AbortSignal) => Promise<WorkspaceSettings>;
7782
+ updateWorkspaceSettings: (variables: UpdateWorkspaceSettingsVariables, signal?: AbortSignal) => Promise<WorkspaceSettings>;
7783
+ getWorkspaceMembersList: (variables: GetWorkspaceMembersListVariables, signal?: AbortSignal) => Promise<WorkspaceMembers>;
7784
+ updateWorkspaceMemberRole: (variables: UpdateWorkspaceMemberRoleVariables, signal?: AbortSignal) => Promise<undefined>;
7785
+ removeWorkspaceMember: (variables: RemoveWorkspaceMemberVariables, signal?: AbortSignal) => Promise<undefined>;
7786
+ };
7787
+ table: {
7788
+ createTable: (variables: CreateTableVariables, signal?: AbortSignal) => Promise<CreateTableResponse>;
7789
+ deleteTable: (variables: DeleteTableVariables, signal?: AbortSignal) => Promise<DeleteTableResponse>;
7790
+ updateTable: (variables: UpdateTableVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
7791
+ getTableSchema: (variables: GetTableSchemaVariables, signal?: AbortSignal) => Promise<GetTableSchemaResponse>;
7792
+ setTableSchema: (variables: SetTableSchemaVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
7793
+ getTableColumns: (variables: GetTableColumnsVariables, signal?: AbortSignal) => Promise<GetTableColumnsResponse>;
7794
+ addTableColumn: (variables: AddTableColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
7795
+ getColumn: (variables: GetColumnVariables, signal?: AbortSignal) => Promise<Column>;
7796
+ updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
7797
+ deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
6916
7798
  };
6917
7799
  migrations: {
6918
- applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal | undefined) => Promise<ApplyMigrationResponse>;
6919
- adaptTable: (variables: AdaptTableVariables, signal?: AbortSignal | undefined) => Promise<ApplyMigrationResponse>;
6920
- getBranchMigrationJobStatus: (variables: GetBranchMigrationJobStatusVariables, signal?: AbortSignal | undefined) => Promise<MigrationJobStatusResponse>;
6921
- getMigrationJobStatus: (variables: GetMigrationJobStatusVariables, signal?: AbortSignal | undefined) => Promise<MigrationJobStatusResponse>;
6922
- getMigrationHistory: (variables: GetMigrationHistoryVariables, signal?: AbortSignal | undefined) => Promise<MigrationHistoryResponse>;
6923
- getSchema: (variables: GetSchemaVariables, signal?: AbortSignal | undefined) => Promise<GetSchemaResponse>;
6924
- getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal | undefined) => Promise<GetBranchMigrationHistoryResponse>;
6925
- getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables, signal?: AbortSignal | undefined) => Promise<BranchMigrationPlan>;
6926
- executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
6927
- getBranchSchemaHistory: (variables: GetBranchSchemaHistoryVariables, signal?: AbortSignal | undefined) => Promise<GetBranchSchemaHistoryResponse>;
6928
- compareBranchWithUserSchema: (variables: CompareBranchWithUserSchemaVariables, signal?: AbortSignal | undefined) => Promise<SchemaCompareResponse>;
6929
- compareBranchSchemas: (variables: CompareBranchSchemasVariables, signal?: AbortSignal | undefined) => Promise<SchemaCompareResponse>;
6930
- updateBranchSchema: (variables: UpdateBranchSchemaVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
6931
- previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables, signal?: AbortSignal | undefined) => Promise<PreviewBranchSchemaEditResponse>;
6932
- applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
6933
- pushBranchMigrations: (variables: PushBranchMigrationsVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
7800
+ applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
7801
+ startMigration: (variables: StartMigrationVariables, signal?: AbortSignal) => Promise<StartMigrationResponse>;
7802
+ completeMigration: (variables: CompleteMigrationVariables, signal?: AbortSignal) => Promise<CompleteMigrationResponse>;
7803
+ rollbackMigration: (variables: RollbackMigrationVariables, signal?: AbortSignal) => Promise<RollbackMigrationResponse>;
7804
+ adaptTable: (variables: AdaptTableVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
7805
+ adaptAllTables: (variables: AdaptAllTablesVariables, signal?: AbortSignal) => Promise<ApplyMigrationResponse>;
7806
+ getBranchMigrationJobStatus: (variables: GetBranchMigrationJobStatusVariables, signal?: AbortSignal) => Promise<MigrationJobStatusResponse>;
7807
+ getMigrationJobs: (variables: GetMigrationJobsVariables, signal?: AbortSignal) => Promise<GetMigrationJobsResponse>;
7808
+ getMigrationJobStatus: (variables: GetMigrationJobStatusVariables, signal?: AbortSignal) => Promise<MigrationJobStatusResponse>;
7809
+ getMigrationHistory: (variables: GetMigrationHistoryVariables, signal?: AbortSignal) => Promise<MigrationHistoryResponse>;
7810
+ getSchema: (variables: GetSchemaVariables, signal?: AbortSignal) => Promise<GetSchemaResponse>;
7811
+ getSchemas: (variables: GetSchemasVariables, signal?: AbortSignal) => Promise<GetSchemasResponse>;
7812
+ getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal) => Promise<GetBranchMigrationHistoryResponse>;
7813
+ getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<BranchMigrationPlan>;
7814
+ executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
7815
+ getBranchSchemaHistory: (variables: GetBranchSchemaHistoryVariables, signal?: AbortSignal) => Promise<GetBranchSchemaHistoryResponse>;
7816
+ compareBranchWithUserSchema: (variables: CompareBranchWithUserSchemaVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
7817
+ compareBranchSchemas: (variables: CompareBranchSchemasVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
7818
+ updateBranchSchema: (variables: UpdateBranchSchemaVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
7819
+ previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables, signal?: AbortSignal) => Promise<PreviewBranchSchemaEditResponse>;
7820
+ applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
7821
+ pushBranchMigrations: (variables: PushBranchMigrationsVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
6934
7822
  };
6935
7823
  records: {
6936
- branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal | undefined) => Promise<TransactionSuccess>;
6937
- insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
6938
- getRecord: (variables: GetRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
6939
- insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
6940
- updateRecordWithID: (variables: UpdateRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
6941
- upsertRecordWithID: (variables: UpsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
6942
- deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
6943
- bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal | undefined) => Promise<BulkInsertResponse>;
7824
+ branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal) => Promise<TransactionSuccess>;
7825
+ insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
7826
+ getRecord: (variables: GetRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
7827
+ insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
7828
+ updateRecordWithID: (variables: UpdateRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
7829
+ upsertRecordWithID: (variables: UpsertRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
7830
+ deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
7831
+ bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal) => Promise<BulkInsertResponse>;
7832
+ };
7833
+ cluster: {
7834
+ listClusterBranches: (variables: ListClusterBranchesVariables, signal?: AbortSignal) => Promise<ListClusterBranchesResponse>;
7835
+ listClusterExtensions: (variables: ListClusterExtensionsVariables, signal?: AbortSignal) => Promise<ListClusterExtensionsResponse>;
7836
+ installClusterExtension: (variables: InstallClusterExtensionVariables, signal?: AbortSignal) => Promise<ClusterExtensionInstallationResponse>;
7837
+ dropClusterExtension: (variables: DropClusterExtensionVariables, signal?: AbortSignal) => Promise<undefined>;
7838
+ getClusterMetrics: (variables: GetClusterMetricsVariables, signal?: AbortSignal) => Promise<MetricsResponse>;
6944
7839
  };
6945
7840
  database: {
6946
- getDatabaseSettings: (variables: GetDatabaseSettingsVariables, signal?: AbortSignal | undefined) => Promise<DatabaseSettings>;
6947
- updateDatabaseSettings: (variables: UpdateDatabaseSettingsVariables, signal?: AbortSignal | undefined) => Promise<DatabaseSettings>;
7841
+ getDatabaseSettings: (variables: GetDatabaseSettingsVariables, signal?: AbortSignal) => Promise<DatabaseSettings>;
7842
+ updateDatabaseSettings: (variables: UpdateDatabaseSettingsVariables, signal?: AbortSignal) => Promise<DatabaseSettings>;
6948
7843
  };
6949
7844
  migrationRequests: {
6950
- queryMigrationRequests: (variables: QueryMigrationRequestsVariables, signal?: AbortSignal | undefined) => Promise<QueryMigrationRequestsResponse>;
6951
- createMigrationRequest: (variables: CreateMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<CreateMigrationRequestResponse>;
6952
- getMigrationRequest: (variables: GetMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<MigrationRequest>;
6953
- updateMigrationRequest: (variables: UpdateMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
6954
- listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables, signal?: AbortSignal | undefined) => Promise<ListMigrationRequestsCommitsResponse>;
6955
- compareMigrationRequest: (variables: CompareMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<SchemaCompareResponse>;
6956
- getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables, signal?: AbortSignal | undefined) => Promise<GetMigrationRequestIsMergedResponse>;
6957
- mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<BranchOp>;
6958
- };
6959
- table: {
6960
- createTable: (variables: CreateTableVariables, signal?: AbortSignal | undefined) => Promise<CreateTableResponse>;
6961
- deleteTable: (variables: DeleteTableVariables, signal?: AbortSignal | undefined) => Promise<DeleteTableResponse>;
6962
- updateTable: (variables: UpdateTableVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
6963
- getTableSchema: (variables: GetTableSchemaVariables, signal?: AbortSignal | undefined) => Promise<GetTableSchemaResponse>;
6964
- setTableSchema: (variables: SetTableSchemaVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
6965
- getTableColumns: (variables: GetTableColumnsVariables, signal?: AbortSignal | undefined) => Promise<GetTableColumnsResponse>;
6966
- addTableColumn: (variables: AddTableColumnVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
6967
- getColumn: (variables: GetColumnVariables, signal?: AbortSignal | undefined) => Promise<Column>;
6968
- updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
6969
- deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
7845
+ queryMigrationRequests: (variables: QueryMigrationRequestsVariables, signal?: AbortSignal) => Promise<QueryMigrationRequestsResponse>;
7846
+ createMigrationRequest: (variables: CreateMigrationRequestVariables, signal?: AbortSignal) => Promise<CreateMigrationRequestResponse>;
7847
+ getMigrationRequest: (variables: GetMigrationRequestVariables, signal?: AbortSignal) => Promise<MigrationRequest>;
7848
+ updateMigrationRequest: (variables: UpdateMigrationRequestVariables, signal?: AbortSignal) => Promise<undefined>;
7849
+ listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables, signal?: AbortSignal) => Promise<ListMigrationRequestsCommitsResponse>;
7850
+ compareMigrationRequest: (variables: CompareMigrationRequestVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
7851
+ getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables, signal?: AbortSignal) => Promise<GetMigrationRequestIsMergedResponse>;
7852
+ mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal) => Promise<BranchOp>;
6970
7853
  };
6971
7854
  files: {
6972
- getFileItem: (variables: GetFileItemVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
6973
- putFileItem: (variables: PutFileItemVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
6974
- deleteFileItem: (variables: DeleteFileItemVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
6975
- getFile: (variables: GetFileVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
6976
- putFile: (variables: PutFileVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
6977
- deleteFile: (variables: DeleteFileVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
6978
- fileAccess: (variables: FileAccessVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
6979
- fileUpload: (variables: FileUploadVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
7855
+ getFileItem: (variables: GetFileItemVariables, signal?: AbortSignal) => Promise<Blob>;
7856
+ putFileItem: (variables: PutFileItemVariables, signal?: AbortSignal) => Promise<FileResponse>;
7857
+ deleteFileItem: (variables: DeleteFileItemVariables, signal?: AbortSignal) => Promise<FileResponse>;
7858
+ getFile: (variables: GetFileVariables, signal?: AbortSignal) => Promise<Blob>;
7859
+ putFile: (variables: PutFileVariables, signal?: AbortSignal) => Promise<FileResponse>;
7860
+ deleteFile: (variables: DeleteFileVariables, signal?: AbortSignal) => Promise<FileResponse>;
7861
+ fileAccess: (variables: FileAccessVariables, signal?: AbortSignal) => Promise<Blob>;
7862
+ fileUpload: (variables: FileUploadVariables, signal?: AbortSignal) => Promise<FileResponse>;
6980
7863
  };
6981
7864
  searchAndFilter: {
6982
- queryTable: (variables: QueryTableVariables, signal?: AbortSignal | undefined) => Promise<QueryResponse>;
6983
- searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
6984
- searchTable: (variables: SearchTableVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
6985
- vectorSearchTable: (variables: VectorSearchTableVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
6986
- askTable: (variables: AskTableVariables, signal?: AbortSignal | undefined) => Promise<AskTableResponse>;
6987
- askTableSession: (variables: AskTableSessionVariables, signal?: AbortSignal | undefined) => Promise<AskTableSessionResponse>;
6988
- summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal | undefined) => Promise<SummarizeResponse>;
6989
- aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal | undefined) => Promise<AggResponse>;
7865
+ queryTable: (variables: QueryTableVariables, signal?: AbortSignal) => Promise<QueryResponse>;
7866
+ searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal) => Promise<SearchResponse>;
7867
+ searchTable: (variables: SearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
7868
+ vectorSearchTable: (variables: VectorSearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
7869
+ askTable: (variables: AskTableVariables, signal?: AbortSignal) => Promise<AskTableResponse>;
7870
+ askTableSession: (variables: AskTableSessionVariables, signal?: AbortSignal) => Promise<AskTableSessionResponse>;
7871
+ summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal) => Promise<SummarizeResponse>;
7872
+ aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal) => Promise<AggResponse>;
6990
7873
  };
6991
7874
  sql: {
6992
- sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal | undefined) => Promise<SQLResponse>;
7875
+ sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<SQLResponse$1>;
7876
+ sqlBatchQuery: (variables: SqlBatchQueryVariables, signal?: AbortSignal) => Promise<SQLBatchResponse>;
6993
7877
  };
6994
7878
  oAuth: {
6995
- getAuthorizationCode: (variables: GetAuthorizationCodeVariables, signal?: AbortSignal | undefined) => Promise<AuthorizationCodeResponse>;
6996
- grantAuthorizationCode: (variables: GrantAuthorizationCodeVariables, signal?: AbortSignal | undefined) => Promise<AuthorizationCodeResponse>;
6997
- getUserOAuthClients: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetUserOAuthClientsResponse>;
6998
- deleteUserOAuthClient: (variables: DeleteUserOAuthClientVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
6999
- getUserOAuthAccessTokens: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetUserOAuthAccessTokensResponse>;
7000
- deleteOAuthAccessToken: (variables: DeleteOAuthAccessTokenVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
7001
- updateOAuthAccessToken: (variables: UpdateOAuthAccessTokenVariables, signal?: AbortSignal | undefined) => Promise<OAuthAccessToken>;
7879
+ getAuthorizationCode: (variables: GetAuthorizationCodeVariables, signal?: AbortSignal) => Promise<AuthorizationCodeResponse>;
7880
+ grantAuthorizationCode: (variables: GrantAuthorizationCodeVariables, signal?: AbortSignal) => Promise<AuthorizationCodeResponse>;
7881
+ getUserOAuthClients: (variables: GetUserOAuthClientsVariables, signal?: AbortSignal) => Promise<GetUserOAuthClientsResponse>;
7882
+ deleteUserOAuthClient: (variables: DeleteUserOAuthClientVariables, signal?: AbortSignal) => Promise<undefined>;
7883
+ getUserOAuthAccessTokens: (variables: GetUserOAuthAccessTokensVariables, signal?: AbortSignal) => Promise<GetUserOAuthAccessTokensResponse>;
7884
+ deleteOAuthAccessToken: (variables: DeleteOAuthAccessTokenVariables, signal?: AbortSignal) => Promise<undefined>;
7885
+ updateOAuthAccessToken: (variables: UpdateOAuthAccessTokenVariables, signal?: AbortSignal) => Promise<OAuthAccessToken>;
7002
7886
  };
7003
7887
  users: {
7004
- getUser: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<UserWithID>;
7005
- updateUser: (variables: UpdateUserVariables, signal?: AbortSignal | undefined) => Promise<UserWithID>;
7006
- deleteUser: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<undefined>;
7888
+ getUser: (variables: GetUserVariables, signal?: AbortSignal) => Promise<UserWithID>;
7889
+ updateUser: (variables: UpdateUserVariables, signal?: AbortSignal) => Promise<UserWithID>;
7890
+ deleteUser: (variables: DeleteUserVariables, signal?: AbortSignal) => Promise<undefined>;
7007
7891
  };
7008
7892
  authentication: {
7009
- getUserAPIKeys: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetUserAPIKeysResponse>;
7010
- createUserAPIKey: (variables: CreateUserAPIKeyVariables, signal?: AbortSignal | undefined) => Promise<CreateUserAPIKeyResponse>;
7011
- deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
7893
+ getUserAPIKeys: (variables: GetUserAPIKeysVariables, signal?: AbortSignal) => Promise<GetUserAPIKeysResponse>;
7894
+ createUserAPIKey: (variables: CreateUserAPIKeyVariables, signal?: AbortSignal) => Promise<CreateUserAPIKeyResponse>;
7895
+ deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal) => Promise<undefined>;
7012
7896
  };
7013
7897
  invites: {
7014
- inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables, signal?: AbortSignal | undefined) => Promise<WorkspaceInvite>;
7015
- updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables, signal?: AbortSignal | undefined) => Promise<WorkspaceInvite>;
7016
- cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
7017
- acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
7018
- resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
7898
+ inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables, signal?: AbortSignal) => Promise<WorkspaceInvite>;
7899
+ updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<WorkspaceInvite>;
7900
+ cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
7901
+ acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
7902
+ resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
7019
7903
  };
7020
7904
  xbcontrolOther: {
7021
- listClusters: (variables: ListClustersVariables, signal?: AbortSignal | undefined) => Promise<ListClustersResponse>;
7022
- createCluster: (variables: CreateClusterVariables, signal?: AbortSignal | undefined) => Promise<ClusterResponse>;
7023
- getCluster: (variables: GetClusterVariables, signal?: AbortSignal | undefined) => Promise<ClusterMetadata>;
7024
- updateCluster: (variables: UpdateClusterVariables, signal?: AbortSignal | undefined) => Promise<ClusterUpdateMetadata>;
7905
+ listClusters: (variables: ListClustersVariables, signal?: AbortSignal) => Promise<ListClustersResponse>;
7906
+ createCluster: (variables: CreateClusterVariables, signal?: AbortSignal) => Promise<ClusterResponse>;
7907
+ getCluster: (variables: GetClusterVariables, signal?: AbortSignal) => Promise<ClusterMetadata>;
7908
+ updateCluster: (variables: UpdateClusterVariables, signal?: AbortSignal) => Promise<ClusterUpdateMetadata>;
7909
+ deleteCluster: (variables: DeleteClusterVariables, signal?: AbortSignal) => Promise<ClusterDeleteMetadata>;
7025
7910
  };
7026
7911
  databases: {
7027
- getDatabaseList: (variables: GetDatabaseListVariables, signal?: AbortSignal | undefined) => Promise<ListDatabasesResponse>;
7028
- createDatabase: (variables: CreateDatabaseVariables, signal?: AbortSignal | undefined) => Promise<CreateDatabaseResponse>;
7029
- deleteDatabase: (variables: DeleteDatabaseVariables, signal?: AbortSignal | undefined) => Promise<DeleteDatabaseResponse>;
7030
- getDatabaseMetadata: (variables: GetDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
7031
- updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
7032
- renameDatabase: (variables: RenameDatabaseVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
7033
- getDatabaseGithubSettings: (variables: GetDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<DatabaseGithubSettings>;
7034
- updateDatabaseGithubSettings: (variables: UpdateDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<DatabaseGithubSettings>;
7035
- deleteDatabaseGithubSettings: (variables: DeleteDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
7036
- listRegions: (variables: ListRegionsVariables, signal?: AbortSignal | undefined) => Promise<ListRegionsResponse>;
7912
+ getDatabaseList: (variables: GetDatabaseListVariables, signal?: AbortSignal) => Promise<ListDatabasesResponse>;
7913
+ createDatabase: (variables: CreateDatabaseVariables, signal?: AbortSignal) => Promise<CreateDatabaseResponse>;
7914
+ deleteDatabase: (variables: DeleteDatabaseVariables, signal?: AbortSignal) => Promise<DeleteDatabaseResponse>;
7915
+ getDatabaseMetadata: (variables: GetDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
7916
+ updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
7917
+ renameDatabase: (variables: RenameDatabaseVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
7918
+ getDatabaseGithubSettings: (variables: GetDatabaseGithubSettingsVariables, signal?: AbortSignal) => Promise<DatabaseGithubSettings>;
7919
+ updateDatabaseGithubSettings: (variables: UpdateDatabaseGithubSettingsVariables, signal?: AbortSignal) => Promise<DatabaseGithubSettings>;
7920
+ deleteDatabaseGithubSettings: (variables: DeleteDatabaseGithubSettingsVariables, signal?: AbortSignal) => Promise<undefined>;
7921
+ listRegions: (variables: ListRegionsVariables, signal?: AbortSignal) => Promise<ListRegionsResponse>;
7037
7922
  };
7038
7923
  };
7039
7924
 
@@ -7056,6 +7941,27 @@ declare function parseWorkspacesUrlParts(url: string): {
7056
7941
  host: HostAliases;
7057
7942
  } | null;
7058
7943
 
7944
+ type ApiExtraProps = Omit<FetcherExtraProps, 'endpoint'>;
7945
+ interface XataApiClientOptions {
7946
+ fetch?: FetchImpl;
7947
+ apiKey?: string;
7948
+ host?: HostProvider;
7949
+ trace?: TraceFunction;
7950
+ clientName?: string;
7951
+ xataAgentExtra?: Record<string, string>;
7952
+ }
7953
+ type UserProps = {
7954
+ headers?: Record<string, unknown>;
7955
+ };
7956
+ type XataApiProxy = {
7957
+ [Tag in keyof typeof operationsByTag]: {
7958
+ [Method in keyof (typeof operationsByTag)[Tag]]: (typeof operationsByTag)[Tag][Method] extends infer Operation extends (...args: any) => any ? Omit<Parameters<Operation>[0], keyof ApiExtraProps> extends infer Params ? RequiredKeys<Params> extends never ? (params?: Params & UserProps) => ReturnType<Operation> : (params: Params & UserProps) => ReturnType<Operation> : never : never;
7959
+ };
7960
+ };
7961
+ declare const XataApiClient_base: new (options?: XataApiClientOptions) => XataApiProxy;
7962
+ declare class XataApiClient extends XataApiClient_base {
7963
+ }
7964
+
7059
7965
  type responses_AggResponse = AggResponse;
7060
7966
  type responses_BranchMigrationPlan = BranchMigrationPlan;
7061
7967
  type responses_BulkError = BulkError;
@@ -7065,6 +7971,7 @@ type responses_QueryResponse = QueryResponse;
7065
7971
  type responses_RateLimitError = RateLimitError;
7066
7972
  type responses_RecordResponse = RecordResponse;
7067
7973
  type responses_RecordUpdateResponse = RecordUpdateResponse;
7974
+ type responses_SQLBatchResponse = SQLBatchResponse;
7068
7975
  type responses_SQLResponse = SQLResponse;
7069
7976
  type responses_SchemaCompareResponse = SchemaCompareResponse;
7070
7977
  type responses_SchemaUpdateResponse = SchemaUpdateResponse;
@@ -7072,7 +7979,7 @@ type responses_SearchResponse = SearchResponse;
7072
7979
  type responses_ServiceUnavailableError = ServiceUnavailableError;
7073
7980
  type responses_SummarizeResponse = SummarizeResponse;
7074
7981
  declare namespace responses {
7075
- export type { responses_AggResponse as AggResponse, AuthError$1 as AuthError, BadRequestError$1 as BadRequestError, responses_BranchMigrationPlan as BranchMigrationPlan, responses_BulkError as BulkError, responses_BulkInsertResponse as BulkInsertResponse, responses_PutFileResponse as PutFileResponse, responses_QueryResponse as QueryResponse, responses_RateLimitError as RateLimitError, responses_RecordResponse as RecordResponse, responses_RecordUpdateResponse as RecordUpdateResponse, responses_SQLResponse as SQLResponse, responses_SchemaCompareResponse as SchemaCompareResponse, responses_SchemaUpdateResponse as SchemaUpdateResponse, responses_SearchResponse as SearchResponse, responses_ServiceUnavailableError as ServiceUnavailableError, SimpleError$1 as SimpleError, responses_SummarizeResponse as SummarizeResponse };
7982
+ export type { responses_AggResponse as AggResponse, AuthError$1 as AuthError, BadRequestError$1 as BadRequestError, responses_BranchMigrationPlan as BranchMigrationPlan, responses_BulkError as BulkError, responses_BulkInsertResponse as BulkInsertResponse, responses_PutFileResponse as PutFileResponse, responses_QueryResponse as QueryResponse, responses_RateLimitError as RateLimitError, responses_RecordResponse as RecordResponse, responses_RecordUpdateResponse as RecordUpdateResponse, responses_SQLBatchResponse as SQLBatchResponse, responses_SQLResponse as SQLResponse, responses_SchemaCompareResponse as SchemaCompareResponse, responses_SchemaUpdateResponse as SchemaUpdateResponse, responses_SearchResponse as SearchResponse, responses_ServiceUnavailableError as ServiceUnavailableError, SimpleError$1 as SimpleError, responses_SummarizeResponse as SummarizeResponse };
7076
7983
  }
7077
7984
 
7078
7985
  type schemas_APIKeyName = APIKeyName;
@@ -7087,14 +7994,17 @@ type schemas_AutoscalingConfigResponse = AutoscalingConfigResponse;
7087
7994
  type schemas_AverageAgg = AverageAgg;
7088
7995
  type schemas_BoosterExpression = BoosterExpression;
7089
7996
  type schemas_Branch = Branch;
7997
+ type schemas_BranchDetails = BranchDetails;
7090
7998
  type schemas_BranchMigration = BranchMigration;
7091
7999
  type schemas_BranchOp = BranchOp;
7092
8000
  type schemas_BranchSchema = BranchSchema;
8001
+ type schemas_BranchState = BranchState;
7093
8002
  type schemas_BranchWithCopyID = BranchWithCopyID;
7094
8003
  type schemas_ClusterConfiguration = ClusterConfiguration;
7095
8004
  type schemas_ClusterConfigurationResponse = ClusterConfigurationResponse;
7096
8005
  type schemas_ClusterCreateDetails = ClusterCreateDetails;
7097
- type schemas_ClusterID = ClusterID;
8006
+ type schemas_ClusterDeleteMetadata = ClusterDeleteMetadata;
8007
+ type schemas_ClusterExtensionInstallationResponse = ClusterExtensionInstallationResponse;
7098
8008
  type schemas_ClusterMetadata = ClusterMetadata;
7099
8009
  type schemas_ClusterResponse = ClusterResponse;
7100
8010
  type schemas_ClusterShortMetadata = ClusterShortMetadata;
@@ -7111,6 +8021,7 @@ type schemas_ColumnOpRename = ColumnOpRename;
7111
8021
  type schemas_ColumnVector = ColumnVector;
7112
8022
  type schemas_ColumnsProjection = ColumnsProjection;
7113
8023
  type schemas_Commit = Commit;
8024
+ type schemas_CompleteMigrationResponse = CompleteMigrationResponse;
7114
8025
  type schemas_CountAgg = CountAgg;
7115
8026
  type schemas_DBBranch = DBBranch;
7116
8027
  type schemas_DBBranchName = DBBranchName;
@@ -7120,6 +8031,7 @@ type schemas_DatabaseGithubSettings = DatabaseGithubSettings;
7120
8031
  type schemas_DatabaseMetadata = DatabaseMetadata;
7121
8032
  type schemas_DatabaseSettings = DatabaseSettings;
7122
8033
  type schemas_DateHistogramAgg = DateHistogramAgg;
8034
+ type schemas_ExtensionDetails = ExtensionDetails;
7123
8035
  type schemas_FileAccessID = FileAccessID;
7124
8036
  type schemas_FileItemID = FileItemID;
7125
8037
  type schemas_FileName = FileName;
@@ -7135,6 +8047,7 @@ type schemas_FilterPredicateRangeOp = FilterPredicateRangeOp;
7135
8047
  type schemas_FilterRangeValue = FilterRangeValue;
7136
8048
  type schemas_FilterValue = FilterValue;
7137
8049
  type schemas_FuzzinessExpression = FuzzinessExpression;
8050
+ type schemas_GetMigrationJobsResponse = GetMigrationJobsResponse;
7138
8051
  type schemas_HighlightExpression = HighlightExpression;
7139
8052
  type schemas_InputFile = InputFile;
7140
8053
  type schemas_InputFileArray = InputFileArray;
@@ -7142,6 +8055,8 @@ type schemas_InputFileEntry = InputFileEntry;
7142
8055
  type schemas_InviteID = InviteID;
7143
8056
  type schemas_InviteKey = InviteKey;
7144
8057
  type schemas_ListBranchesResponse = ListBranchesResponse;
8058
+ type schemas_ListClusterBranchesResponse = ListClusterBranchesResponse;
8059
+ type schemas_ListClusterExtensionsResponse = ListClusterExtensionsResponse;
7145
8060
  type schemas_ListClustersResponse = ListClustersResponse;
7146
8061
  type schemas_ListDatabasesResponse = ListDatabasesResponse;
7147
8062
  type schemas_ListGitBranchesResponse = ListGitBranchesResponse;
@@ -7150,18 +8065,24 @@ type schemas_MaintenanceConfig = MaintenanceConfig;
7150
8065
  type schemas_MaintenanceConfigResponse = MaintenanceConfigResponse;
7151
8066
  type schemas_MaxAgg = MaxAgg;
7152
8067
  type schemas_MediaType = MediaType;
8068
+ type schemas_MetricData = MetricData;
8069
+ type schemas_MetricMessage = MetricMessage;
7153
8070
  type schemas_MetricsDatapoint = MetricsDatapoint;
7154
8071
  type schemas_MetricsLatency = MetricsLatency;
8072
+ type schemas_MetricsResponse = MetricsResponse;
7155
8073
  type schemas_Migration = Migration;
7156
8074
  type schemas_MigrationColumnOp = MigrationColumnOp;
8075
+ type schemas_MigrationDescription = MigrationDescription;
7157
8076
  type schemas_MigrationHistoryItem = MigrationHistoryItem;
7158
8077
  type schemas_MigrationHistoryResponse = MigrationHistoryResponse;
7159
8078
  type schemas_MigrationJobID = MigrationJobID;
8079
+ type schemas_MigrationJobItem = MigrationJobItem;
7160
8080
  type schemas_MigrationJobStatus = MigrationJobStatus;
7161
8081
  type schemas_MigrationJobStatusResponse = MigrationJobStatusResponse;
7162
8082
  type schemas_MigrationJobType = MigrationJobType;
7163
8083
  type schemas_MigrationObject = MigrationObject;
7164
8084
  type schemas_MigrationOp = MigrationOp;
8085
+ type schemas_MigrationOperationDescription = MigrationOperationDescription;
7165
8086
  type schemas_MigrationRequest = MigrationRequest;
7166
8087
  type schemas_MigrationRequestNumber = MigrationRequestNumber;
7167
8088
  type schemas_MigrationTableOp = MigrationTableOp;
@@ -7175,11 +8096,9 @@ type schemas_OAuthResponseType = OAuthResponseType;
7175
8096
  type schemas_OAuthScope = OAuthScope;
7176
8097
  type schemas_ObjectValue = ObjectValue;
7177
8098
  type schemas_PageConfig = PageConfig;
7178
- type schemas_PageResponse = PageResponse;
7179
- type schemas_PageSize = PageSize;
7180
- type schemas_PageToken = PageToken;
7181
8099
  type schemas_PercentilesAgg = PercentilesAgg;
7182
8100
  type schemas_PrefixExpression = PrefixExpression;
8101
+ type schemas_PreparedStatement = PreparedStatement;
7183
8102
  type schemas_ProjectionConfig = ProjectionConfig;
7184
8103
  type schemas_QueryColumnsProjection = QueryColumnsProjection;
7185
8104
  type schemas_RecordID = RecordID;
@@ -7188,12 +8107,18 @@ type schemas_RecordsMetadata = RecordsMetadata;
7188
8107
  type schemas_Region = Region;
7189
8108
  type schemas_RevLink = RevLink;
7190
8109
  type schemas_Role = Role;
8110
+ type schemas_RollbackMigrationResponse = RollbackMigrationResponse;
8111
+ type schemas_SQLConsistency = SQLConsistency;
7191
8112
  type schemas_SQLRecord = SQLRecord;
8113
+ type schemas_SQLResponseArray = SQLResponseArray;
8114
+ type schemas_SQLResponseBase = SQLResponseBase;
8115
+ type schemas_SQLResponseJSON = SQLResponseJSON;
7192
8116
  type schemas_Schema = Schema;
7193
8117
  type schemas_SchemaEditScript = SchemaEditScript;
7194
8118
  type schemas_SearchPageConfig = SearchPageConfig;
7195
8119
  type schemas_SortExpression = SortExpression;
7196
8120
  type schemas_SortOrder = SortOrder;
8121
+ type schemas_StartMigrationResponse = StartMigrationResponse;
7197
8122
  type schemas_StartedFromMetadata = StartedFromMetadata;
7198
8123
  type schemas_SumAgg = SumAgg;
7199
8124
  type schemas_SummaryExpression = SummaryExpression;
@@ -7224,781 +8149,22 @@ type schemas_User = User;
7224
8149
  type schemas_UserID = UserID;
7225
8150
  type schemas_UserWithID = UserWithID;
7226
8151
  type schemas_WeeklyTimeWindow = WeeklyTimeWindow;
7227
- type schemas_Workspace = Workspace;
7228
- type schemas_WorkspaceID = WorkspaceID;
7229
- type schemas_WorkspaceInvite = WorkspaceInvite;
7230
- type schemas_WorkspaceMember = WorkspaceMember;
7231
- type schemas_WorkspaceMembers = WorkspaceMembers;
7232
- type schemas_WorkspaceMeta = WorkspaceMeta;
7233
- type schemas_WorkspacePlan = WorkspacePlan;
7234
- type schemas_WorkspaceSettings = WorkspaceSettings;
7235
- declare namespace schemas {
7236
- 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, schemas_WorkspaceSettings as WorkspaceSettings, XataRecord$1 as XataRecord };
7237
- }
7238
-
7239
- type ApiExtraProps = Omit<FetcherExtraProps, 'endpoint'>;
7240
- interface XataApiClientOptions {
7241
- fetch?: FetchImpl;
7242
- apiKey?: string;
7243
- host?: HostProvider;
7244
- trace?: TraceFunction;
7245
- clientName?: string;
7246
- xataAgentExtra?: Record<string, string>;
7247
- }
7248
- declare class XataApiClient {
7249
- #private;
7250
- constructor(options?: XataApiClientOptions);
7251
- get user(): UserApi;
7252
- get authentication(): AuthenticationApi;
7253
- get workspaces(): WorkspaceApi;
7254
- get invites(): InvitesApi;
7255
- get database(): DatabaseApi;
7256
- get branches(): BranchApi;
7257
- get migrations(): MigrationsApi;
7258
- get migrationRequests(): MigrationRequestsApi;
7259
- get tables(): TableApi;
7260
- get records(): RecordsApi;
7261
- get files(): FilesApi;
7262
- get searchAndFilter(): SearchAndFilterApi;
7263
- }
7264
- declare class UserApi {
7265
- private extraProps;
7266
- constructor(extraProps: ApiExtraProps);
7267
- getUser(): Promise<UserWithID>;
7268
- updateUser({ user }: {
7269
- user: User;
7270
- }): Promise<UserWithID>;
7271
- deleteUser(): Promise<void>;
7272
- }
7273
- declare class AuthenticationApi {
7274
- private extraProps;
7275
- constructor(extraProps: ApiExtraProps);
7276
- getUserAPIKeys(): Promise<GetUserAPIKeysResponse>;
7277
- createUserAPIKey({ name }: {
7278
- name: APIKeyName;
7279
- }): Promise<CreateUserAPIKeyResponse>;
7280
- deleteUserAPIKey({ name }: {
7281
- name: APIKeyName;
7282
- }): Promise<void>;
7283
- }
7284
- declare class WorkspaceApi {
7285
- private extraProps;
7286
- constructor(extraProps: ApiExtraProps);
7287
- getWorkspacesList(): Promise<GetWorkspacesListResponse>;
7288
- createWorkspace({ data }: {
7289
- data: WorkspaceMeta;
7290
- }): Promise<Workspace>;
7291
- getWorkspace({ workspace }: {
7292
- workspace: WorkspaceID;
7293
- }): Promise<Workspace>;
7294
- updateWorkspace({ workspace, update }: {
7295
- workspace: WorkspaceID;
7296
- update: WorkspaceMeta;
7297
- }): Promise<Workspace>;
7298
- deleteWorkspace({ workspace }: {
7299
- workspace: WorkspaceID;
7300
- }): Promise<void>;
7301
- getWorkspaceMembersList({ workspace }: {
7302
- workspace: WorkspaceID;
7303
- }): Promise<WorkspaceMembers>;
7304
- updateWorkspaceMemberRole({ workspace, user, role }: {
7305
- workspace: WorkspaceID;
7306
- user: UserID;
7307
- role: Role;
7308
- }): Promise<void>;
7309
- removeWorkspaceMember({ workspace, user }: {
7310
- workspace: WorkspaceID;
7311
- user: UserID;
7312
- }): Promise<void>;
7313
- }
7314
- declare class InvitesApi {
7315
- private extraProps;
7316
- constructor(extraProps: ApiExtraProps);
7317
- inviteWorkspaceMember({ workspace, email, role }: {
7318
- workspace: WorkspaceID;
7319
- email: string;
7320
- role: Role;
7321
- }): Promise<WorkspaceInvite>;
7322
- updateWorkspaceMemberInvite({ workspace, invite, role }: {
7323
- workspace: WorkspaceID;
7324
- invite: InviteID;
7325
- role: Role;
7326
- }): Promise<WorkspaceInvite>;
7327
- cancelWorkspaceMemberInvite({ workspace, invite }: {
7328
- workspace: WorkspaceID;
7329
- invite: InviteID;
7330
- }): Promise<void>;
7331
- acceptWorkspaceMemberInvite({ workspace, key }: {
7332
- workspace: WorkspaceID;
7333
- key: InviteKey;
7334
- }): Promise<void>;
7335
- resendWorkspaceMemberInvite({ workspace, invite }: {
7336
- workspace: WorkspaceID;
7337
- invite: InviteID;
7338
- }): Promise<void>;
7339
- }
7340
- declare class BranchApi {
7341
- private extraProps;
7342
- constructor(extraProps: ApiExtraProps);
7343
- getBranchList({ workspace, region, database }: {
7344
- workspace: WorkspaceID;
7345
- region: string;
7346
- database: DBName$1;
7347
- }): Promise<ListBranchesResponse>;
7348
- getBranchDetails({ workspace, region, database, branch }: {
7349
- workspace: WorkspaceID;
7350
- region: string;
7351
- database: DBName$1;
7352
- branch: BranchName$1;
7353
- }): Promise<DBBranch>;
7354
- createBranch({ workspace, region, database, branch, from, metadata }: {
7355
- workspace: WorkspaceID;
7356
- region: string;
7357
- database: DBName$1;
7358
- branch: BranchName$1;
7359
- from?: string;
7360
- metadata?: BranchMetadata$1;
7361
- }): Promise<CreateBranchResponse>;
7362
- deleteBranch({ workspace, region, database, branch }: {
7363
- workspace: WorkspaceID;
7364
- region: string;
7365
- database: DBName$1;
7366
- branch: BranchName$1;
7367
- }): Promise<DeleteBranchResponse>;
7368
- copyBranch({ workspace, region, database, branch, destinationBranch, limit }: {
7369
- workspace: WorkspaceID;
7370
- region: string;
7371
- database: DBName$1;
7372
- branch: BranchName$1;
7373
- destinationBranch: BranchName$1;
7374
- limit?: number;
7375
- }): Promise<BranchWithCopyID>;
7376
- updateBranchMetadata({ workspace, region, database, branch, metadata }: {
7377
- workspace: WorkspaceID;
7378
- region: string;
7379
- database: DBName$1;
7380
- branch: BranchName$1;
7381
- metadata: BranchMetadata$1;
7382
- }): Promise<void>;
7383
- getBranchMetadata({ workspace, region, database, branch }: {
7384
- workspace: WorkspaceID;
7385
- region: string;
7386
- database: DBName$1;
7387
- branch: BranchName$1;
7388
- }): Promise<BranchMetadata$1>;
7389
- getBranchStats({ workspace, region, database, branch }: {
7390
- workspace: WorkspaceID;
7391
- region: string;
7392
- database: DBName$1;
7393
- branch: BranchName$1;
7394
- }): Promise<GetBranchStatsResponse>;
7395
- getGitBranchesMapping({ workspace, region, database }: {
7396
- workspace: WorkspaceID;
7397
- region: string;
7398
- database: DBName$1;
7399
- }): Promise<ListGitBranchesResponse>;
7400
- addGitBranchesEntry({ workspace, region, database, gitBranch, xataBranch }: {
7401
- workspace: WorkspaceID;
7402
- region: string;
7403
- database: DBName$1;
7404
- gitBranch: string;
7405
- xataBranch: BranchName$1;
7406
- }): Promise<AddGitBranchesEntryResponse>;
7407
- removeGitBranchesEntry({ workspace, region, database, gitBranch }: {
7408
- workspace: WorkspaceID;
7409
- region: string;
7410
- database: DBName$1;
7411
- gitBranch: string;
7412
- }): Promise<void>;
7413
- resolveBranch({ workspace, region, database, gitBranch, fallbackBranch }: {
7414
- workspace: WorkspaceID;
7415
- region: string;
7416
- database: DBName$1;
7417
- gitBranch?: string;
7418
- fallbackBranch?: string;
7419
- }): Promise<ResolveBranchResponse>;
7420
- pgRollMigrationHistory({ workspace, region, database, branch }: {
7421
- workspace: WorkspaceID;
7422
- region: string;
7423
- database: DBName$1;
7424
- branch: BranchName$1;
7425
- }): Promise<MigrationHistoryResponse>;
7426
- applyMigration({ workspace, region, database, branch, migration }: {
7427
- workspace: WorkspaceID;
7428
- region: string;
7429
- database: DBName$1;
7430
- branch: BranchName$1;
7431
- migration: Migration;
7432
- }): Promise<ApplyMigrationResponse>;
7433
- }
7434
- declare class TableApi {
7435
- private extraProps;
7436
- constructor(extraProps: ApiExtraProps);
7437
- createTable({ workspace, region, database, branch, table }: {
7438
- workspace: WorkspaceID;
7439
- region: string;
7440
- database: DBName$1;
7441
- branch: BranchName$1;
7442
- table: TableName;
7443
- }): Promise<CreateTableResponse>;
7444
- deleteTable({ workspace, region, database, branch, table }: {
7445
- workspace: WorkspaceID;
7446
- region: string;
7447
- database: DBName$1;
7448
- branch: BranchName$1;
7449
- table: TableName;
7450
- }): Promise<DeleteTableResponse>;
7451
- updateTable({ workspace, region, database, branch, table, update }: {
7452
- workspace: WorkspaceID;
7453
- region: string;
7454
- database: DBName$1;
7455
- branch: BranchName$1;
7456
- table: TableName;
7457
- update: UpdateTableRequestBody;
7458
- }): Promise<SchemaUpdateResponse>;
7459
- getTableSchema({ workspace, region, database, branch, table }: {
7460
- workspace: WorkspaceID;
7461
- region: string;
7462
- database: DBName$1;
7463
- branch: BranchName$1;
7464
- table: TableName;
7465
- }): Promise<GetTableSchemaResponse>;
7466
- setTableSchema({ workspace, region, database, branch, table, schema }: {
7467
- workspace: WorkspaceID;
7468
- region: string;
7469
- database: DBName$1;
7470
- branch: BranchName$1;
7471
- table: TableName;
7472
- schema: SetTableSchemaRequestBody;
7473
- }): Promise<SchemaUpdateResponse>;
7474
- getTableColumns({ workspace, region, database, branch, table }: {
7475
- workspace: WorkspaceID;
7476
- region: string;
7477
- database: DBName$1;
7478
- branch: BranchName$1;
7479
- table: TableName;
7480
- }): Promise<GetTableColumnsResponse>;
7481
- addTableColumn({ workspace, region, database, branch, table, column }: {
7482
- workspace: WorkspaceID;
7483
- region: string;
7484
- database: DBName$1;
7485
- branch: BranchName$1;
7486
- table: TableName;
7487
- column: Column;
7488
- }): Promise<SchemaUpdateResponse>;
7489
- getColumn({ workspace, region, database, branch, table, column }: {
7490
- workspace: WorkspaceID;
7491
- region: string;
7492
- database: DBName$1;
7493
- branch: BranchName$1;
7494
- table: TableName;
7495
- column: ColumnName;
7496
- }): Promise<Column>;
7497
- updateColumn({ workspace, region, database, branch, table, column, update }: {
7498
- workspace: WorkspaceID;
7499
- region: string;
7500
- database: DBName$1;
7501
- branch: BranchName$1;
7502
- table: TableName;
7503
- column: ColumnName;
7504
- update: UpdateColumnRequestBody;
7505
- }): Promise<SchemaUpdateResponse>;
7506
- deleteColumn({ workspace, region, database, branch, table, column }: {
7507
- workspace: WorkspaceID;
7508
- region: string;
7509
- database: DBName$1;
7510
- branch: BranchName$1;
7511
- table: TableName;
7512
- column: ColumnName;
7513
- }): Promise<SchemaUpdateResponse>;
7514
- }
7515
- declare class RecordsApi {
7516
- private extraProps;
7517
- constructor(extraProps: ApiExtraProps);
7518
- insertRecord({ workspace, region, database, branch, table, record, columns }: {
7519
- workspace: WorkspaceID;
7520
- region: string;
7521
- database: DBName$1;
7522
- branch: BranchName$1;
7523
- table: TableName;
7524
- record: Record<string, any>;
7525
- columns?: ColumnsProjection;
7526
- }): Promise<RecordUpdateResponse>;
7527
- getRecord({ workspace, region, database, branch, table, id, columns }: {
7528
- workspace: WorkspaceID;
7529
- region: string;
7530
- database: DBName$1;
7531
- branch: BranchName$1;
7532
- table: TableName;
7533
- id: RecordID;
7534
- columns?: ColumnsProjection;
7535
- }): Promise<XataRecord$1>;
7536
- insertRecordWithID({ workspace, region, database, branch, table, id, record, columns, createOnly, ifVersion }: {
7537
- workspace: WorkspaceID;
7538
- region: string;
7539
- database: DBName$1;
7540
- branch: BranchName$1;
7541
- table: TableName;
7542
- id: RecordID;
7543
- record: Record<string, any>;
7544
- columns?: ColumnsProjection;
7545
- createOnly?: boolean;
7546
- ifVersion?: number;
7547
- }): Promise<RecordUpdateResponse>;
7548
- updateRecordWithID({ workspace, region, database, branch, table, id, record, columns, ifVersion }: {
7549
- workspace: WorkspaceID;
7550
- region: string;
7551
- database: DBName$1;
7552
- branch: BranchName$1;
7553
- table: TableName;
7554
- id: RecordID;
7555
- record: Record<string, any>;
7556
- columns?: ColumnsProjection;
7557
- ifVersion?: number;
7558
- }): Promise<RecordUpdateResponse>;
7559
- upsertRecordWithID({ workspace, region, database, branch, table, id, record, columns, ifVersion }: {
7560
- workspace: WorkspaceID;
7561
- region: string;
7562
- database: DBName$1;
7563
- branch: BranchName$1;
7564
- table: TableName;
7565
- id: RecordID;
7566
- record: Record<string, any>;
7567
- columns?: ColumnsProjection;
7568
- ifVersion?: number;
7569
- }): Promise<RecordUpdateResponse>;
7570
- deleteRecord({ workspace, region, database, branch, table, id, columns }: {
7571
- workspace: WorkspaceID;
7572
- region: string;
7573
- database: DBName$1;
7574
- branch: BranchName$1;
7575
- table: TableName;
7576
- id: RecordID;
7577
- columns?: ColumnsProjection;
7578
- }): Promise<RecordUpdateResponse>;
7579
- bulkInsertTableRecords({ workspace, region, database, branch, table, records, columns }: {
7580
- workspace: WorkspaceID;
7581
- region: string;
7582
- database: DBName$1;
7583
- branch: BranchName$1;
7584
- table: TableName;
7585
- records: Record<string, any>[];
7586
- columns?: ColumnsProjection;
7587
- }): Promise<BulkInsertResponse>;
7588
- branchTransaction({ workspace, region, database, branch, operations }: {
7589
- workspace: WorkspaceID;
7590
- region: string;
7591
- database: DBName$1;
7592
- branch: BranchName$1;
7593
- operations: TransactionOperation$1[];
7594
- }): Promise<TransactionSuccess>;
7595
- }
7596
- declare class FilesApi {
7597
- private extraProps;
7598
- constructor(extraProps: ApiExtraProps);
7599
- getFileItem({ workspace, region, database, branch, table, record, column, fileId }: {
7600
- workspace: WorkspaceID;
7601
- region: string;
7602
- database: DBName$1;
7603
- branch: BranchName$1;
7604
- table: TableName;
7605
- record: RecordID;
7606
- column: ColumnName;
7607
- fileId: string;
7608
- }): Promise<any>;
7609
- putFileItem({ workspace, region, database, branch, table, record, column, fileId, file }: {
7610
- workspace: WorkspaceID;
7611
- region: string;
7612
- database: DBName$1;
7613
- branch: BranchName$1;
7614
- table: TableName;
7615
- record: RecordID;
7616
- column: ColumnName;
7617
- fileId: string;
7618
- file: any;
7619
- }): Promise<PutFileResponse>;
7620
- deleteFileItem({ workspace, region, database, branch, table, record, column, fileId }: {
7621
- workspace: WorkspaceID;
7622
- region: string;
7623
- database: DBName$1;
7624
- branch: BranchName$1;
7625
- table: TableName;
7626
- record: RecordID;
7627
- column: ColumnName;
7628
- fileId: string;
7629
- }): Promise<PutFileResponse>;
7630
- getFile({ workspace, region, database, branch, table, record, column }: {
7631
- workspace: WorkspaceID;
7632
- region: string;
7633
- database: DBName$1;
7634
- branch: BranchName$1;
7635
- table: TableName;
7636
- record: RecordID;
7637
- column: ColumnName;
7638
- }): Promise<any>;
7639
- putFile({ workspace, region, database, branch, table, record, column, file }: {
7640
- workspace: WorkspaceID;
7641
- region: string;
7642
- database: DBName$1;
7643
- branch: BranchName$1;
7644
- table: TableName;
7645
- record: RecordID;
7646
- column: ColumnName;
7647
- file: Blob;
7648
- }): Promise<PutFileResponse>;
7649
- deleteFile({ workspace, region, database, branch, table, record, column }: {
7650
- workspace: WorkspaceID;
7651
- region: string;
7652
- database: DBName$1;
7653
- branch: BranchName$1;
7654
- table: TableName;
7655
- record: RecordID;
7656
- column: ColumnName;
7657
- }): Promise<PutFileResponse>;
7658
- fileAccess({ workspace, region, fileId, verify }: {
7659
- workspace: WorkspaceID;
7660
- region: string;
7661
- fileId: string;
7662
- verify?: FileSignature;
7663
- }): Promise<any>;
7664
- }
7665
- declare class SearchAndFilterApi {
7666
- private extraProps;
7667
- constructor(extraProps: ApiExtraProps);
7668
- queryTable({ workspace, region, database, branch, table, filter, sort, page, columns, consistency }: {
7669
- workspace: WorkspaceID;
7670
- region: string;
7671
- database: DBName$1;
7672
- branch: BranchName$1;
7673
- table: TableName;
7674
- filter?: FilterExpression;
7675
- sort?: SortExpression;
7676
- page?: PageConfig;
7677
- columns?: ColumnsProjection;
7678
- consistency?: 'strong' | 'eventual';
7679
- }): Promise<QueryResponse>;
7680
- searchTable({ workspace, region, database, branch, table, query, fuzziness, target, prefix, filter, highlight, boosters }: {
7681
- workspace: WorkspaceID;
7682
- region: string;
7683
- database: DBName$1;
7684
- branch: BranchName$1;
7685
- table: TableName;
7686
- query: string;
7687
- fuzziness?: FuzzinessExpression;
7688
- target?: TargetExpression;
7689
- prefix?: PrefixExpression;
7690
- filter?: FilterExpression;
7691
- highlight?: HighlightExpression;
7692
- boosters?: BoosterExpression[];
7693
- }): Promise<SearchResponse>;
7694
- searchBranch({ workspace, region, database, branch, tables, query, fuzziness, prefix, highlight }: {
7695
- workspace: WorkspaceID;
7696
- region: string;
7697
- database: DBName$1;
7698
- branch: BranchName$1;
7699
- tables?: (string | {
7700
- table: string;
7701
- filter?: FilterExpression;
7702
- target?: TargetExpression;
7703
- boosters?: BoosterExpression[];
7704
- })[];
7705
- query: string;
7706
- fuzziness?: FuzzinessExpression;
7707
- prefix?: PrefixExpression;
7708
- highlight?: HighlightExpression;
7709
- }): Promise<SearchResponse>;
7710
- vectorSearchTable({ workspace, region, database, branch, table, queryVector, column, similarityFunction, size, filter }: {
7711
- workspace: WorkspaceID;
7712
- region: string;
7713
- database: DBName$1;
7714
- branch: BranchName$1;
7715
- table: TableName;
7716
- queryVector: number[];
7717
- column: string;
7718
- similarityFunction?: string;
7719
- size?: number;
7720
- filter?: FilterExpression;
7721
- }): Promise<SearchResponse>;
7722
- askTable({ workspace, region, database, branch, table, options }: {
7723
- workspace: WorkspaceID;
7724
- region: string;
7725
- database: DBName$1;
7726
- branch: BranchName$1;
7727
- table: TableName;
7728
- options: AskTableRequestBody;
7729
- }): Promise<AskTableResponse>;
7730
- askTableSession({ workspace, region, database, branch, table, sessionId, message }: {
7731
- workspace: WorkspaceID;
7732
- region: string;
7733
- database: DBName$1;
7734
- branch: BranchName$1;
7735
- table: TableName;
7736
- sessionId: string;
7737
- message: string;
7738
- }): Promise<AskTableSessionResponse>;
7739
- summarizeTable({ workspace, region, database, branch, table, filter, columns, summaries, sort, summariesFilter, page, consistency }: {
7740
- workspace: WorkspaceID;
7741
- region: string;
7742
- database: DBName$1;
7743
- branch: BranchName$1;
7744
- table: TableName;
7745
- filter?: FilterExpression;
7746
- columns?: ColumnsProjection;
7747
- summaries?: SummaryExpressionList;
7748
- sort?: SortExpression;
7749
- summariesFilter?: FilterExpression;
7750
- page?: {
7751
- size?: number;
7752
- };
7753
- consistency?: 'strong' | 'eventual';
7754
- }): Promise<SummarizeResponse>;
7755
- aggregateTable({ workspace, region, database, branch, table, filter, aggs }: {
7756
- workspace: WorkspaceID;
7757
- region: string;
7758
- database: DBName$1;
7759
- branch: BranchName$1;
7760
- table: TableName;
7761
- filter?: FilterExpression;
7762
- aggs?: AggExpressionMap;
7763
- }): Promise<AggResponse>;
7764
- }
7765
- declare class MigrationRequestsApi {
7766
- private extraProps;
7767
- constructor(extraProps: ApiExtraProps);
7768
- queryMigrationRequests({ workspace, region, database, filter, sort, page, columns }: {
7769
- workspace: WorkspaceID;
7770
- region: string;
7771
- database: DBName$1;
7772
- filter?: FilterExpression;
7773
- sort?: SortExpression;
7774
- page?: PageConfig;
7775
- columns?: ColumnsProjection;
7776
- }): Promise<QueryMigrationRequestsResponse>;
7777
- createMigrationRequest({ workspace, region, database, migration }: {
7778
- workspace: WorkspaceID;
7779
- region: string;
7780
- database: DBName$1;
7781
- migration: CreateMigrationRequestRequestBody;
7782
- }): Promise<CreateMigrationRequestResponse>;
7783
- getMigrationRequest({ workspace, region, database, migrationRequest }: {
7784
- workspace: WorkspaceID;
7785
- region: string;
7786
- database: DBName$1;
7787
- migrationRequest: MigrationRequestNumber;
7788
- }): Promise<MigrationRequest>;
7789
- updateMigrationRequest({ workspace, region, database, migrationRequest, update }: {
7790
- workspace: WorkspaceID;
7791
- region: string;
7792
- database: DBName$1;
7793
- migrationRequest: MigrationRequestNumber;
7794
- update: UpdateMigrationRequestRequestBody;
7795
- }): Promise<void>;
7796
- listMigrationRequestsCommits({ workspace, region, database, migrationRequest, page }: {
7797
- workspace: WorkspaceID;
7798
- region: string;
7799
- database: DBName$1;
7800
- migrationRequest: MigrationRequestNumber;
7801
- page?: {
7802
- after?: string;
7803
- before?: string;
7804
- size?: number;
7805
- };
7806
- }): Promise<ListMigrationRequestsCommitsResponse>;
7807
- compareMigrationRequest({ workspace, region, database, migrationRequest }: {
7808
- workspace: WorkspaceID;
7809
- region: string;
7810
- database: DBName$1;
7811
- migrationRequest: MigrationRequestNumber;
7812
- }): Promise<SchemaCompareResponse>;
7813
- getMigrationRequestIsMerged({ workspace, region, database, migrationRequest }: {
7814
- workspace: WorkspaceID;
7815
- region: string;
7816
- database: DBName$1;
7817
- migrationRequest: MigrationRequestNumber;
7818
- }): Promise<GetMigrationRequestIsMergedResponse>;
7819
- mergeMigrationRequest({ workspace, region, database, migrationRequest }: {
7820
- workspace: WorkspaceID;
7821
- region: string;
7822
- database: DBName$1;
7823
- migrationRequest: MigrationRequestNumber;
7824
- }): Promise<BranchOp>;
7825
- }
7826
- declare class MigrationsApi {
7827
- private extraProps;
7828
- constructor(extraProps: ApiExtraProps);
7829
- getBranchMigrationHistory({ workspace, region, database, branch, limit, startFrom }: {
7830
- workspace: WorkspaceID;
7831
- region: string;
7832
- database: DBName$1;
7833
- branch: BranchName$1;
7834
- limit?: number;
7835
- startFrom?: string;
7836
- }): Promise<GetBranchMigrationHistoryResponse>;
7837
- getBranchMigrationPlan({ workspace, region, database, branch, schema }: {
7838
- workspace: WorkspaceID;
7839
- region: string;
7840
- database: DBName$1;
7841
- branch: BranchName$1;
7842
- schema: Schema;
7843
- }): Promise<BranchMigrationPlan>;
7844
- executeBranchMigrationPlan({ workspace, region, database, branch, plan }: {
7845
- workspace: WorkspaceID;
7846
- region: string;
7847
- database: DBName$1;
7848
- branch: BranchName$1;
7849
- plan: ExecuteBranchMigrationPlanRequestBody;
7850
- }): Promise<SchemaUpdateResponse>;
7851
- getBranchSchemaHistory({ workspace, region, database, branch, page }: {
7852
- workspace: WorkspaceID;
7853
- region: string;
7854
- database: DBName$1;
7855
- branch: BranchName$1;
7856
- page?: {
7857
- after?: string;
7858
- before?: string;
7859
- size?: number;
7860
- };
7861
- }): Promise<GetBranchSchemaHistoryResponse>;
7862
- compareBranchWithUserSchema({ workspace, region, database, branch, schema, schemaOperations, branchOperations }: {
7863
- workspace: WorkspaceID;
7864
- region: string;
7865
- database: DBName$1;
7866
- branch: BranchName$1;
7867
- schema: Schema;
7868
- schemaOperations?: MigrationOp[];
7869
- branchOperations?: MigrationOp[];
7870
- }): Promise<SchemaCompareResponse>;
7871
- compareBranchSchemas({ workspace, region, database, branch, compare, sourceBranchOperations, targetBranchOperations }: {
7872
- workspace: WorkspaceID;
7873
- region: string;
7874
- database: DBName$1;
7875
- branch: BranchName$1;
7876
- compare: BranchName$1;
7877
- sourceBranchOperations?: MigrationOp[];
7878
- targetBranchOperations?: MigrationOp[];
7879
- }): Promise<SchemaCompareResponse>;
7880
- updateBranchSchema({ workspace, region, database, branch, migration }: {
7881
- workspace: WorkspaceID;
7882
- region: string;
7883
- database: DBName$1;
7884
- branch: BranchName$1;
7885
- migration: Migration;
7886
- }): Promise<SchemaUpdateResponse>;
7887
- previewBranchSchemaEdit({ workspace, region, database, branch, data }: {
7888
- workspace: WorkspaceID;
7889
- region: string;
7890
- database: DBName$1;
7891
- branch: BranchName$1;
7892
- data: {
7893
- edits?: SchemaEditScript;
7894
- };
7895
- }): Promise<PreviewBranchSchemaEditResponse>;
7896
- applyBranchSchemaEdit({ workspace, region, database, branch, edits }: {
7897
- workspace: WorkspaceID;
7898
- region: string;
7899
- database: DBName$1;
7900
- branch: BranchName$1;
7901
- edits: SchemaEditScript;
7902
- }): Promise<SchemaUpdateResponse>;
7903
- pushBranchMigrations({ workspace, region, database, branch, migrations }: {
7904
- workspace: WorkspaceID;
7905
- region: string;
7906
- database: DBName$1;
7907
- branch: BranchName$1;
7908
- migrations: MigrationObject[];
7909
- }): Promise<SchemaUpdateResponse>;
7910
- getSchema({ workspace, region, database, branch }: {
7911
- workspace: WorkspaceID;
7912
- region: string;
7913
- database: DBName$1;
7914
- branch: BranchName$1;
7915
- }): Promise<GetSchemaResponse>;
7916
- }
7917
- declare class DatabaseApi {
7918
- private extraProps;
7919
- constructor(extraProps: ApiExtraProps);
7920
- getDatabaseList({ workspace }: {
7921
- workspace: WorkspaceID;
7922
- }): Promise<ListDatabasesResponse>;
7923
- createDatabase({ workspace, database, data, headers }: {
7924
- workspace: WorkspaceID;
7925
- database: DBName$1;
7926
- data: CreateDatabaseRequestBody;
7927
- headers?: Record<string, string>;
7928
- }): Promise<CreateDatabaseResponse>;
7929
- deleteDatabase({ workspace, database }: {
7930
- workspace: WorkspaceID;
7931
- database: DBName$1;
7932
- }): Promise<DeleteDatabaseResponse>;
7933
- getDatabaseMetadata({ workspace, database }: {
7934
- workspace: WorkspaceID;
7935
- database: DBName$1;
7936
- }): Promise<DatabaseMetadata>;
7937
- updateDatabaseMetadata({ workspace, database, metadata }: {
7938
- workspace: WorkspaceID;
7939
- database: DBName$1;
7940
- metadata: DatabaseMetadata;
7941
- }): Promise<DatabaseMetadata>;
7942
- renameDatabase({ workspace, database, newName }: {
7943
- workspace: WorkspaceID;
7944
- database: DBName$1;
7945
- newName: DBName$1;
7946
- }): Promise<DatabaseMetadata>;
7947
- getDatabaseGithubSettings({ workspace, database }: {
7948
- workspace: WorkspaceID;
7949
- database: DBName$1;
7950
- }): Promise<DatabaseGithubSettings>;
7951
- updateDatabaseGithubSettings({ workspace, database, settings }: {
7952
- workspace: WorkspaceID;
7953
- database: DBName$1;
7954
- settings: DatabaseGithubSettings;
7955
- }): Promise<DatabaseGithubSettings>;
7956
- deleteDatabaseGithubSettings({ workspace, database }: {
7957
- workspace: WorkspaceID;
7958
- database: DBName$1;
7959
- }): Promise<void>;
7960
- listRegions({ workspace }: {
7961
- workspace: WorkspaceID;
7962
- }): Promise<ListRegionsResponse>;
8152
+ type schemas_Workspace = Workspace;
8153
+ type schemas_WorkspaceID = WorkspaceID;
8154
+ type schemas_WorkspaceInvite = WorkspaceInvite;
8155
+ type schemas_WorkspaceMember = WorkspaceMember;
8156
+ type schemas_WorkspaceMembers = WorkspaceMembers;
8157
+ type schemas_WorkspaceMeta = WorkspaceMeta;
8158
+ type schemas_WorkspacePlan = WorkspacePlan;
8159
+ type schemas_WorkspaceSettings = WorkspaceSettings;
8160
+ declare namespace schemas {
8161
+ export type { schemas_APIKeyName as APIKeyName, schemas_AccessToken as AccessToken, schemas_AggExpression as AggExpression, schemas_AggExpressionMap as AggExpressionMap, AggResponse$1 as AggResponse, schemas_ApplyMigrationResponse as ApplyMigrationResponse, schemas_AuthorizationCodeRequest as AuthorizationCodeRequest, schemas_AuthorizationCodeResponse as AuthorizationCodeResponse, schemas_AutoscalingConfig as AutoscalingConfig, schemas_AutoscalingConfigResponse as AutoscalingConfigResponse, schemas_AverageAgg as AverageAgg, schemas_BoosterExpression as BoosterExpression, schemas_Branch as Branch, schemas_BranchDetails as BranchDetails, BranchMetadata$1 as BranchMetadata, schemas_BranchMigration as BranchMigration, BranchName$1 as BranchName, schemas_BranchOp as BranchOp, schemas_BranchSchema as BranchSchema, schemas_BranchState as BranchState, schemas_BranchWithCopyID as BranchWithCopyID, schemas_ClusterConfiguration as ClusterConfiguration, schemas_ClusterConfigurationResponse as ClusterConfigurationResponse, schemas_ClusterCreateDetails as ClusterCreateDetails, schemas_ClusterDeleteMetadata as ClusterDeleteMetadata, schemas_ClusterExtensionInstallationResponse as ClusterExtensionInstallationResponse, ClusterID$1 as ClusterID, schemas_ClusterMetadata as ClusterMetadata, schemas_ClusterResponse as ClusterResponse, schemas_ClusterShortMetadata as ClusterShortMetadata, schemas_ClusterUpdateDetails as ClusterUpdateDetails, schemas_ClusterUpdateMetadata as ClusterUpdateMetadata, schemas_Column as Column, schemas_ColumnFile as ColumnFile, schemas_ColumnLink as ColumnLink, schemas_ColumnMigration as ColumnMigration, schemas_ColumnName as ColumnName, schemas_ColumnOpAdd as ColumnOpAdd, schemas_ColumnOpRemove as ColumnOpRemove, schemas_ColumnOpRename as ColumnOpRename, schemas_ColumnVector as ColumnVector, schemas_ColumnsProjection as ColumnsProjection, schemas_Commit as Commit, schemas_CompleteMigrationResponse as CompleteMigrationResponse, schemas_CountAgg as CountAgg, schemas_DBBranch as DBBranch, schemas_DBBranchName as DBBranchName, DBName$1 as DBName, schemas_DailyTimeWindow as DailyTimeWindow, schemas_DataInputRecord as DataInputRecord, schemas_DatabaseGithubSettings as DatabaseGithubSettings, schemas_DatabaseMetadata as DatabaseMetadata, schemas_DatabaseSettings as DatabaseSettings, DateBooster$1 as DateBooster, schemas_DateHistogramAgg as DateHistogramAgg, DateTime$1 as DateTime, schemas_ExtensionDetails as ExtensionDetails, schemas_FileAccessID as FileAccessID, schemas_FileItemID as FileItemID, schemas_FileName as FileName, schemas_FileResponse as FileResponse, schemas_FileSignature as FileSignature, schemas_FilterColumn as FilterColumn, schemas_FilterColumnIncludes as FilterColumnIncludes, schemas_FilterExpression as FilterExpression, schemas_FilterList as FilterList, schemas_FilterPredicate as FilterPredicate, schemas_FilterPredicateOp as FilterPredicateOp, schemas_FilterPredicateRangeOp as FilterPredicateRangeOp, schemas_FilterRangeValue as FilterRangeValue, schemas_FilterValue as FilterValue, schemas_FuzzinessExpression as FuzzinessExpression, schemas_GetMigrationJobsResponse as GetMigrationJobsResponse, schemas_HighlightExpression as HighlightExpression, schemas_InputFile as InputFile, schemas_InputFileArray as InputFileArray, schemas_InputFileEntry as InputFileEntry, schemas_InviteID as InviteID, schemas_InviteKey as InviteKey, schemas_ListBranchesResponse as ListBranchesResponse, schemas_ListClusterBranchesResponse as ListClusterBranchesResponse, schemas_ListClusterExtensionsResponse as ListClusterExtensionsResponse, schemas_ListClustersResponse as ListClustersResponse, schemas_ListDatabasesResponse as ListDatabasesResponse, schemas_ListGitBranchesResponse as ListGitBranchesResponse, schemas_ListRegionsResponse as ListRegionsResponse, schemas_MaintenanceConfig as MaintenanceConfig, schemas_MaintenanceConfigResponse as MaintenanceConfigResponse, schemas_MaxAgg as MaxAgg, schemas_MediaType as MediaType, schemas_MetricData as MetricData, schemas_MetricMessage as MetricMessage, schemas_MetricsDatapoint as MetricsDatapoint, schemas_MetricsLatency as MetricsLatency, schemas_MetricsResponse as MetricsResponse, schemas_Migration as Migration, schemas_MigrationColumnOp as MigrationColumnOp, schemas_MigrationDescription as MigrationDescription, schemas_MigrationHistoryItem as MigrationHistoryItem, schemas_MigrationHistoryResponse as MigrationHistoryResponse, schemas_MigrationJobID as MigrationJobID, schemas_MigrationJobItem as MigrationJobItem, schemas_MigrationJobStatus as MigrationJobStatus, schemas_MigrationJobStatusResponse as MigrationJobStatusResponse, schemas_MigrationJobType as MigrationJobType, schemas_MigrationObject as MigrationObject, schemas_MigrationOp as MigrationOp, schemas_MigrationOperationDescription as MigrationOperationDescription, schemas_MigrationRequest as MigrationRequest, schemas_MigrationRequestNumber as MigrationRequestNumber, MigrationStatus$1 as MigrationStatus, schemas_MigrationTableOp as MigrationTableOp, schemas_MigrationType as MigrationType, schemas_MinAgg as MinAgg, NumericBooster$1 as NumericBooster, schemas_NumericHistogramAgg as NumericHistogramAgg, schemas_OAuthAccessToken as OAuthAccessToken, schemas_OAuthClientID as OAuthClientID, schemas_OAuthClientPublicDetails as OAuthClientPublicDetails, schemas_OAuthResponseType as OAuthResponseType, schemas_OAuthScope as OAuthScope, schemas_ObjectValue as ObjectValue, schemas_PageConfig as PageConfig, PageResponse$1 as PageResponse, PageSize$1 as PageSize, PageToken$1 as PageToken, schemas_PercentilesAgg as PercentilesAgg, schemas_PrefixExpression as PrefixExpression, schemas_PreparedStatement as PreparedStatement, schemas_ProjectionConfig as ProjectionConfig, schemas_QueryColumnsProjection as QueryColumnsProjection, schemas_RecordID as RecordID, schemas_RecordMeta as RecordMeta, schemas_RecordsMetadata as RecordsMetadata, schemas_Region as Region, schemas_RevLink as RevLink, schemas_Role as Role, schemas_RollbackMigrationResponse as RollbackMigrationResponse, schemas_SQLConsistency as SQLConsistency, schemas_SQLRecord as SQLRecord, SQLResponse$1 as SQLResponse, schemas_SQLResponseArray as SQLResponseArray, schemas_SQLResponseBase as SQLResponseBase, schemas_SQLResponseJSON as SQLResponseJSON, SQLResponseType$1 as SQLResponseType, schemas_Schema as Schema, schemas_SchemaEditScript as SchemaEditScript, schemas_SearchPageConfig as SearchPageConfig, schemas_SortExpression as SortExpression, schemas_SortOrder as SortOrder, schemas_StartMigrationResponse as StartMigrationResponse, schemas_StartedFromMetadata as StartedFromMetadata, schemas_SumAgg as SumAgg, schemas_SummaryExpression as SummaryExpression, schemas_SummaryExpressionList as SummaryExpressionList, schemas_Table as Table, schemas_TableMigration as TableMigration, schemas_TableName as TableName, schemas_TableOpAdd as TableOpAdd, schemas_TableOpRemove as TableOpRemove, schemas_TableOpRename as TableOpRename, schemas_TableRename as TableRename, schemas_TargetExpression as TargetExpression, schemas_TopValuesAgg as TopValuesAgg, schemas_TransactionDeleteOp as TransactionDeleteOp, schemas_TransactionError as TransactionError, schemas_TransactionFailure as TransactionFailure, schemas_TransactionGetOp as TransactionGetOp, schemas_TransactionInsertOp as TransactionInsertOp, TransactionOperation$1 as TransactionOperation, schemas_TransactionResultColumns as TransactionResultColumns, schemas_TransactionResultDelete as TransactionResultDelete, schemas_TransactionResultGet as TransactionResultGet, schemas_TransactionResultInsert as TransactionResultInsert, schemas_TransactionResultUpdate as TransactionResultUpdate, schemas_TransactionSuccess as TransactionSuccess, schemas_TransactionUpdateOp as TransactionUpdateOp, schemas_UniqueCountAgg as UniqueCountAgg, schemas_User as User, schemas_UserID as UserID, schemas_UserWithID as UserWithID, ValueBooster$1 as ValueBooster, schemas_WeeklyTimeWindow as WeeklyTimeWindow, schemas_Workspace as Workspace, schemas_WorkspaceID as WorkspaceID, schemas_WorkspaceInvite as WorkspaceInvite, schemas_WorkspaceMember as WorkspaceMember, schemas_WorkspaceMembers as WorkspaceMembers, schemas_WorkspaceMeta as WorkspaceMeta, schemas_WorkspacePlan as WorkspacePlan, schemas_WorkspaceSettings as WorkspaceSettings, XataRecord$1 as XataRecord };
7963
8162
  }
7964
8163
 
7965
8164
  declare class XataApiPlugin implements XataPlugin {
7966
8165
  build(options: XataPluginOptions): XataApiClient;
7967
8166
  }
7968
8167
 
7969
- type StringKeys<O> = Extract<keyof O, string>;
7970
- type Values<O> = O[StringKeys<O>];
7971
- type UnionToIntersection<T> = (T extends any ? (x: T) => any : never) extends (x: infer R) => any ? R : never;
7972
- type If<Condition, Then, Else> = Condition extends true ? Then : Else;
7973
- type IsObject<T> = T extends Record<string, any> ? true : false;
7974
- type IsArray<T> = T extends Array<any> ? true : false;
7975
- type RequiredBy<T, K extends keyof T> = T & {
7976
- [P in K]-?: NonNullable<T[P]>;
7977
- };
7978
- type GetArrayInnerType<T extends readonly any[]> = T[number];
7979
- type SingleOrArray<T> = T | T[];
7980
- type Dictionary<T> = Record<string, T>;
7981
- type OmitBy<T, K extends keyof T> = T extends any ? Omit<T, K> : never;
7982
- type Without<T, U> = {
7983
- [P in Exclude<keyof T, keyof U>]?: never;
7984
- };
7985
- type ExclusiveOr<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
7986
- type Explode<T> = keyof T extends infer K ? K extends unknown ? {
7987
- [I in keyof T]: I extends K ? T[I] : never;
7988
- } : never : never;
7989
- type AtMostOne<T> = Explode<Partial<T>>;
7990
- type AtLeastOne<T, U = {
7991
- [K in keyof T]: Pick<T, K>;
7992
- }> = Partial<T> & U[keyof U];
7993
- type ExactlyOne<T> = AtMostOne<T> & AtLeastOne<T>;
7994
- type Fn = (...args: any[]) => any;
7995
- type NarrowRaw<A> = (A extends [] ? [] : never) | (A extends Narrowable ? A : never) | {
7996
- [K in keyof A]: A[K] extends Fn ? A[K] : NarrowRaw<A[K]>;
7997
- };
7998
- type Narrowable = string | number | bigint | boolean;
7999
- type Try<A1, A2, Catch = never> = A1 extends A2 ? A1 : Catch;
8000
- type Narrow<A> = Try<A, [], NarrowRaw<A>>;
8001
-
8002
8168
  interface ImageTransformations {
8003
8169
  /**
8004
8170
  * Whether to preserve animation frames from input files. Default is true.
@@ -8164,6 +8330,580 @@ interface ImageTransformations {
8164
8330
  declare function transformImage(url: string, ...transformations: ImageTransformations[]): string;
8165
8331
  declare function transformImage(url: string | undefined, ...transformations: ImageTransformations[]): string | undefined;
8166
8332
 
8333
+ declare class Buffer extends Uint8Array {
8334
+ /**
8335
+ * Allocates a new buffer containing the given `str`.
8336
+ *
8337
+ * @param str String to store in buffer.
8338
+ * @param encoding Encoding to use, optional. Default is `utf8`.
8339
+ */
8340
+ constructor(str: string, encoding?: Encoding);
8341
+ /**
8342
+ * Allocates a new buffer of `size` octets.
8343
+ *
8344
+ * @param size Count of octets to allocate.
8345
+ */
8346
+ constructor(size: number);
8347
+ /**
8348
+ * Allocates a new buffer containing the given `array` of octets.
8349
+ *
8350
+ * @param array The octets to store.
8351
+ */
8352
+ constructor(array: Uint8Array);
8353
+ /**
8354
+ * Allocates a new buffer containing the given `array` of octet values.
8355
+ *
8356
+ * @param array
8357
+ */
8358
+ constructor(array: number[]);
8359
+ /**
8360
+ * Allocates a new buffer containing the given `array` of octet values.
8361
+ *
8362
+ * @param array
8363
+ * @param encoding
8364
+ */
8365
+ constructor(array: number[], encoding: Encoding);
8366
+ /**
8367
+ * Copies the passed `buffer` data onto a new `Buffer` instance.
8368
+ *
8369
+ * @param buffer
8370
+ */
8371
+ constructor(buffer: Buffer);
8372
+ /**
8373
+ * When passed a reference to the .buffer property of a TypedArray instance, the newly created Buffer will share
8374
+ * the same allocated memory as the TypedArray. The optional `byteOffset` and `length` arguments specify a memory
8375
+ * range within the `arrayBuffer` that will be shared by the Buffer.
8376
+ *
8377
+ * @param buffer The .buffer property of a TypedArray or a new ArrayBuffer().
8378
+ * @param byteOffset
8379
+ * @param length
8380
+ */
8381
+ constructor(buffer: ArrayBuffer, byteOffset?: number, length?: number);
8382
+ /**
8383
+ * Return JSON representation of the buffer.
8384
+ */
8385
+ toJSON(): {
8386
+ type: 'Buffer';
8387
+ data: number[];
8388
+ };
8389
+ /**
8390
+ * Writes `string` to the buffer at `offset` according to the character encoding in `encoding`. The `length`
8391
+ * parameter is the number of bytes to write. If the buffer does not contain enough space to fit the entire string,
8392
+ * only part of `string` will be written. However, partially encoded characters will not be written.
8393
+ *
8394
+ * @param string String to write to `buf`.
8395
+ * @param encoding The character encoding of `string`. Default: `utf8`.
8396
+ */
8397
+ write(string: string, encoding?: Encoding): number;
8398
+ /**
8399
+ * Writes `string` to the buffer at `offset` according to the character encoding in `encoding`. The `length`
8400
+ * parameter is the number of bytes to write. If the buffer does not contain enough space to fit the entire string,
8401
+ * only part of `string` will be written. However, partially encoded characters will not be written.
8402
+ *
8403
+ * @param string String to write to `buf`.
8404
+ * @param offset Number of bytes to skip before starting to write `string`. Default: `0`.
8405
+ * @param length Maximum number of bytes to write: Default: `buf.length - offset`.
8406
+ * @param encoding The character encoding of `string`. Default: `utf8`.
8407
+ */
8408
+ write(string: string, offset?: number, length?: number, encoding?: Encoding): number;
8409
+ /**
8410
+ * Decodes the buffer to a string according to the specified character encoding.
8411
+ * Passing `start` and `end` will decode only a subset of the buffer.
8412
+ *
8413
+ * Note that if the encoding is `utf8` and a byte sequence in the input is not valid UTF-8, then each invalid byte
8414
+ * will be replaced with `U+FFFD`.
8415
+ *
8416
+ * @param encoding
8417
+ * @param start
8418
+ * @param end
8419
+ */
8420
+ toString(encoding?: Encoding, start?: number, end?: number): string;
8421
+ /**
8422
+ * Returns true if this buffer's is equal to the provided buffer, meaning they share the same exact data.
8423
+ *
8424
+ * @param otherBuffer
8425
+ */
8426
+ equals(otherBuffer: Buffer): boolean;
8427
+ /**
8428
+ * Compares the buffer with `otherBuffer` and returns a number indicating whether the buffer comes before, after,
8429
+ * or is the same as `otherBuffer` in sort order. Comparison is based on the actual sequence of bytes in each
8430
+ * buffer.
8431
+ *
8432
+ * - `0` is returned if `otherBuffer` is the same as this buffer.
8433
+ * - `1` is returned if `otherBuffer` should come before this buffer when sorted.
8434
+ * - `-1` is returned if `otherBuffer` should come after this buffer when sorted.
8435
+ *
8436
+ * @param otherBuffer The buffer to compare to.
8437
+ * @param targetStart The offset within `otherBuffer` at which to begin comparison.
8438
+ * @param targetEnd The offset within `otherBuffer` at which to end comparison (exclusive).
8439
+ * @param sourceStart The offset within this buffer at which to begin comparison.
8440
+ * @param sourceEnd The offset within this buffer at which to end the comparison (exclusive).
8441
+ */
8442
+ compare(otherBuffer: Uint8Array, targetStart?: number, targetEnd?: number, sourceStart?: number, sourceEnd?: number): number;
8443
+ /**
8444
+ * Copies data from a region of this buffer to a region in `targetBuffer`, even if the `targetBuffer` memory
8445
+ * region overlaps with this buffer.
8446
+ *
8447
+ * @param targetBuffer The target buffer to copy into.
8448
+ * @param targetStart The offset within `targetBuffer` at which to begin writing.
8449
+ * @param sourceStart The offset within this buffer at which to begin copying.
8450
+ * @param sourceEnd The offset within this buffer at which to end copying (exclusive).
8451
+ */
8452
+ copy(targetBuffer: Uint8Array, targetStart?: number, sourceStart?: number, sourceEnd?: number): number;
8453
+ /**
8454
+ * Returns a new `Buffer` that references the same memory as the original, but offset and cropped by the `start`
8455
+ * and `end` indices. This is the same behavior as `buf.subarray()`.
8456
+ *
8457
+ * This method is not compatible with the `Uint8Array.prototype.slice()`, which is a superclass of Buffer. To copy
8458
+ * the slice, use `Uint8Array.prototype.slice()`.
8459
+ *
8460
+ * @param start
8461
+ * @param end
8462
+ */
8463
+ slice(start?: number, end?: number): Buffer;
8464
+ /**
8465
+ * Writes `byteLength` bytes of `value` to `buf` at the specified `offset` as little-endian. Supports up to 48 bits
8466
+ * of accuracy. Behavior is undefined when value is anything other than an unsigned integer.
8467
+ *
8468
+ * @param value Number to write.
8469
+ * @param offset Number of bytes to skip before starting to write.
8470
+ * @param byteLength Number of bytes to write, between 0 and 6.
8471
+ * @param noAssert
8472
+ * @returns `offset` plus the number of bytes written.
8473
+ */
8474
+ writeUIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
8475
+ /**
8476
+ * Writes `byteLength` bytes of `value` to `buf` at the specified `offset` as big-endian. Supports up to 48 bits of
8477
+ * accuracy. Behavior is undefined when `value` is anything other than an unsigned integer.
8478
+ *
8479
+ * @param value Number to write.
8480
+ * @param offset Number of bytes to skip before starting to write.
8481
+ * @param byteLength Number of bytes to write, between 0 and 6.
8482
+ * @param noAssert
8483
+ * @returns `offset` plus the number of bytes written.
8484
+ */
8485
+ writeUIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
8486
+ /**
8487
+ * Writes `byteLength` bytes of `value` to `buf` at the specified `offset` as little-endian. Supports up to 48 bits
8488
+ * of accuracy. Behavior is undefined when `value` is anything other than a signed integer.
8489
+ *
8490
+ * @param value Number to write.
8491
+ * @param offset Number of bytes to skip before starting to write.
8492
+ * @param byteLength Number of bytes to write, between 0 and 6.
8493
+ * @param noAssert
8494
+ * @returns `offset` plus the number of bytes written.
8495
+ */
8496
+ writeIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
8497
+ /**
8498
+ * Writes `byteLength` bytes of `value` to `buf` at the specified `offset` as big-endian. Supports up to 48 bits
8499
+ * of accuracy. Behavior is undefined when `value` is anything other than a signed integer.
8500
+ *
8501
+ * @param value Number to write.
8502
+ * @param offset Number of bytes to skip before starting to write.
8503
+ * @param byteLength Number of bytes to write, between 0 and 6.
8504
+ * @param noAssert
8505
+ * @returns `offset` plus the number of bytes written.
8506
+ */
8507
+ writeIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
8508
+ /**
8509
+ * Reads `byteLength` number of bytes from `buf` at the specified `offset` and interprets the result as an
8510
+ * unsigned, little-endian integer supporting up to 48 bits of accuracy.
8511
+ *
8512
+ * @param offset Number of bytes to skip before starting to read.
8513
+ * @param byteLength Number of bytes to read, between 0 and 6.
8514
+ * @param noAssert
8515
+ */
8516
+ readUIntLE(offset: number, byteLength: number, noAssert?: boolean): number;
8517
+ /**
8518
+ * Reads `byteLength` number of bytes from `buf` at the specified `offset` and interprets the result as an
8519
+ * unsigned, big-endian integer supporting up to 48 bits of accuracy.
8520
+ *
8521
+ * @param offset Number of bytes to skip before starting to read.
8522
+ * @param byteLength Number of bytes to read, between 0 and 6.
8523
+ * @param noAssert
8524
+ */
8525
+ readUIntBE(offset: number, byteLength: number, noAssert?: boolean): number;
8526
+ /**
8527
+ * Reads `byteLength` number of bytes from `buf` at the specified `offset` and interprets the result as a
8528
+ * little-endian, two's complement signed value supporting up to 48 bits of accuracy.
8529
+ *
8530
+ * @param offset Number of bytes to skip before starting to read.
8531
+ * @param byteLength Number of bytes to read, between 0 and 6.
8532
+ * @param noAssert
8533
+ */
8534
+ readIntLE(offset: number, byteLength: number, noAssert?: boolean): number;
8535
+ /**
8536
+ * Reads `byteLength` number of bytes from `buf` at the specified `offset` and interprets the result as a
8537
+ * big-endian, two's complement signed value supporting up to 48 bits of accuracy.
8538
+ *
8539
+ * @param offset Number of bytes to skip before starting to read.
8540
+ * @param byteLength Number of bytes to read, between 0 and 6.
8541
+ * @param noAssert
8542
+ */
8543
+ readIntBE(offset: number, byteLength: number, noAssert?: boolean): number;
8544
+ /**
8545
+ * Reads an unsigned 8-bit integer from `buf` at the specified `offset`.
8546
+ *
8547
+ * @param offset Number of bytes to skip before starting to read.
8548
+ * @param noAssert
8549
+ */
8550
+ readUInt8(offset: number, noAssert?: boolean): number;
8551
+ /**
8552
+ * Reads an unsigned, little-endian 16-bit integer from `buf` at the specified `offset`.
8553
+ *
8554
+ * @param offset Number of bytes to skip before starting to read.
8555
+ * @param noAssert
8556
+ */
8557
+ readUInt16LE(offset: number, noAssert?: boolean): number;
8558
+ /**
8559
+ * Reads an unsigned, big-endian 16-bit integer from `buf` at the specified `offset`.
8560
+ *
8561
+ * @param offset Number of bytes to skip before starting to read.
8562
+ * @param noAssert
8563
+ */
8564
+ readUInt16BE(offset: number, noAssert?: boolean): number;
8565
+ /**
8566
+ * Reads an unsigned, little-endian 32-bit integer from `buf` at the specified `offset`.
8567
+ *
8568
+ * @param offset Number of bytes to skip before starting to read.
8569
+ * @param noAssert
8570
+ */
8571
+ readUInt32LE(offset: number, noAssert?: boolean): number;
8572
+ /**
8573
+ * Reads an unsigned, big-endian 32-bit integer from `buf` at the specified `offset`.
8574
+ *
8575
+ * @param offset Number of bytes to skip before starting to read.
8576
+ * @param noAssert
8577
+ */
8578
+ readUInt32BE(offset: number, noAssert?: boolean): number;
8579
+ /**
8580
+ * Reads a signed 8-bit integer from `buf` at the specified `offset`. Integers read from a `Buffer` are interpreted
8581
+ * as two's complement signed values.
8582
+ *
8583
+ * @param offset Number of bytes to skip before starting to read.
8584
+ * @param noAssert
8585
+ */
8586
+ readInt8(offset: number, noAssert?: boolean): number;
8587
+ /**
8588
+ * Reads a signed, little-endian 16-bit integer from `buf` at the specified `offset`. Integers read from a `Buffer`
8589
+ * are interpreted as two's complement signed values.
8590
+ *
8591
+ * @param offset Number of bytes to skip before starting to read.
8592
+ * @param noAssert
8593
+ */
8594
+ readInt16LE(offset: number, noAssert?: boolean): number;
8595
+ /**
8596
+ * Reads a signed, big-endian 16-bit integer from `buf` at the specified `offset`. Integers read from a `Buffer`
8597
+ * are interpreted as two's complement signed values.
8598
+ *
8599
+ * @param offset Number of bytes to skip before starting to read.
8600
+ * @param noAssert
8601
+ */
8602
+ readInt16BE(offset: number, noAssert?: boolean): number;
8603
+ /**
8604
+ * Reads a signed, little-endian 32-bit integer from `buf` at the specified `offset`. Integers read from a `Buffer`
8605
+ * are interpreted as two's complement signed values.
8606
+ *
8607
+ * @param offset Number of bytes to skip before starting to read.
8608
+ * @param noAssert
8609
+ */
8610
+ readInt32LE(offset: number, noAssert?: boolean): number;
8611
+ /**
8612
+ * Reads a signed, big-endian 32-bit integer from `buf` at the specified `offset`. Integers read from a `Buffer`
8613
+ * are interpreted as two's complement signed values.
8614
+ *
8615
+ * @param offset Number of bytes to skip before starting to read.
8616
+ * @param noAssert
8617
+ */
8618
+ readInt32BE(offset: number, noAssert?: boolean): number;
8619
+ /**
8620
+ * Interprets `buf` as an array of unsigned 16-bit integers and swaps the byte order in-place.
8621
+ * Throws a `RangeError` if `buf.length` is not a multiple of 2.
8622
+ */
8623
+ swap16(): Buffer;
8624
+ /**
8625
+ * Interprets `buf` as an array of unsigned 32-bit integers and swaps the byte order in-place.
8626
+ * Throws a `RangeError` if `buf.length` is not a multiple of 4.
8627
+ */
8628
+ swap32(): Buffer;
8629
+ /**
8630
+ * Interprets `buf` as an array of unsigned 64-bit integers and swaps the byte order in-place.
8631
+ * Throws a `RangeError` if `buf.length` is not a multiple of 8.
8632
+ */
8633
+ swap64(): Buffer;
8634
+ /**
8635
+ * Swaps two octets.
8636
+ *
8637
+ * @param b
8638
+ * @param n
8639
+ * @param m
8640
+ */
8641
+ private _swap;
8642
+ /**
8643
+ * Writes `value` to `buf` at the specified `offset`. The `value` must be a valid unsigned 8-bit integer.
8644
+ * Behavior is undefined when `value` is anything other than an unsigned 8-bit integer.
8645
+ *
8646
+ * @param value Number to write.
8647
+ * @param offset Number of bytes to skip before starting to write.
8648
+ * @param noAssert
8649
+ * @returns `offset` plus the number of bytes written.
8650
+ */
8651
+ writeUInt8(value: number, offset: number, noAssert?: boolean): number;
8652
+ /**
8653
+ * Writes `value` to `buf` at the specified `offset` as little-endian. The `value` must be a valid unsigned 16-bit
8654
+ * integer. Behavior is undefined when `value` is anything other than an unsigned 16-bit integer.
8655
+ *
8656
+ * @param value Number to write.
8657
+ * @param offset Number of bytes to skip before starting to write.
8658
+ * @param noAssert
8659
+ * @returns `offset` plus the number of bytes written.
8660
+ */
8661
+ writeUInt16LE(value: number | string, offset: number, noAssert?: boolean): number;
8662
+ /**
8663
+ * Writes `value` to `buf` at the specified `offset` as big-endian. The `value` must be a valid unsigned 16-bit
8664
+ * integer. Behavior is undefined when `value` is anything other than an unsigned 16-bit integer.
8665
+ *
8666
+ * @param value Number to write.
8667
+ * @param offset Number of bytes to skip before starting to write.
8668
+ * @param noAssert
8669
+ * @returns `offset` plus the number of bytes written.
8670
+ */
8671
+ writeUInt16BE(value: number, offset: number, noAssert?: boolean): number;
8672
+ /**
8673
+ * Writes `value` to `buf` at the specified `offset` as little-endian. The `value` must be a valid unsigned 32-bit
8674
+ * integer. Behavior is undefined when `value` is anything other than an unsigned 32-bit integer.
8675
+ *
8676
+ * @param value Number to write.
8677
+ * @param offset Number of bytes to skip before starting to write.
8678
+ * @param noAssert
8679
+ * @returns `offset` plus the number of bytes written.
8680
+ */
8681
+ writeUInt32LE(value: number, offset: number, noAssert?: boolean): number;
8682
+ /**
8683
+ * Writes `value` to `buf` at the specified `offset` as big-endian. The `value` must be a valid unsigned 32-bit
8684
+ * integer. Behavior is undefined when `value` is anything other than an unsigned 32-bit integer.
8685
+ *
8686
+ * @param value Number to write.
8687
+ * @param offset Number of bytes to skip before starting to write.
8688
+ * @param noAssert
8689
+ * @returns `offset` plus the number of bytes written.
8690
+ */
8691
+ writeUInt32BE(value: number, offset: number, noAssert?: boolean): number;
8692
+ /**
8693
+ * Writes `value` to `buf` at the specified `offset`. The `value` must be a valid signed 8-bit integer.
8694
+ * Behavior is undefined when `value` is anything other than a signed 8-bit integer.
8695
+ *
8696
+ * @param value Number to write.
8697
+ * @param offset Number of bytes to skip before starting to write.
8698
+ * @param noAssert
8699
+ * @returns `offset` plus the number of bytes written.
8700
+ */
8701
+ writeInt8(value: number, offset: number, noAssert?: boolean): number;
8702
+ /**
8703
+ * Writes `value` to `buf` at the specified `offset` as little-endian. The `value` must be a valid signed 16-bit
8704
+ * integer. Behavior is undefined when `value` is anything other than a signed 16-bit integer.
8705
+ *
8706
+ * @param value Number to write.
8707
+ * @param offset Number of bytes to skip before starting to write.
8708
+ * @param noAssert
8709
+ * @returns `offset` plus the number of bytes written.
8710
+ */
8711
+ writeInt16LE(value: number, offset: number, noAssert?: boolean): number;
8712
+ /**
8713
+ * Writes `value` to `buf` at the specified `offset` as big-endian. The `value` must be a valid signed 16-bit
8714
+ * integer. Behavior is undefined when `value` is anything other than a signed 16-bit integer.
8715
+ *
8716
+ * @param value Number to write.
8717
+ * @param offset Number of bytes to skip before starting to write.
8718
+ * @param noAssert
8719
+ * @returns `offset` plus the number of bytes written.
8720
+ */
8721
+ writeInt16BE(value: number, offset: number, noAssert?: boolean): number;
8722
+ /**
8723
+ * Writes `value` to `buf` at the specified `offset` as little-endian. The `value` must be a valid signed 32-bit
8724
+ * integer. Behavior is undefined when `value` is anything other than a signed 32-bit integer.
8725
+ *
8726
+ * @param value Number to write.
8727
+ * @param offset Number of bytes to skip before starting to write.
8728
+ * @param noAssert
8729
+ * @returns `offset` plus the number of bytes written.
8730
+ */
8731
+ writeInt32LE(value: number, offset: number, noAssert?: boolean): number;
8732
+ /**
8733
+ * Writes `value` to `buf` at the specified `offset` as big-endian. The `value` must be a valid signed 32-bit
8734
+ * integer. Behavior is undefined when `value` is anything other than a signed 32-bit integer.
8735
+ *
8736
+ * @param value Number to write.
8737
+ * @param offset Number of bytes to skip before starting to write.
8738
+ * @param noAssert
8739
+ * @returns `offset` plus the number of bytes written.
8740
+ */
8741
+ writeInt32BE(value: number, offset: number, noAssert?: boolean): number;
8742
+ /**
8743
+ * Fills `buf` with the specified `value`. If the `offset` and `end` are not given, the entire `buf` will be
8744
+ * filled. The `value` is coerced to a `uint32` value if it is not a string, `Buffer`, or integer. If the resulting
8745
+ * integer is greater than `255` (decimal), then `buf` will be filled with `value & 255`.
8746
+ *
8747
+ * If the final write of a `fill()` operation falls on a multi-byte character, then only the bytes of that
8748
+ * character that fit into `buf` are written.
8749
+ *
8750
+ * If `value` contains invalid characters, it is truncated; if no valid fill data remains, an exception is thrown.
8751
+ *
8752
+ * @param value
8753
+ * @param encoding
8754
+ */
8755
+ fill(value: any, offset?: number, end?: number, encoding?: Encoding): this;
8756
+ /**
8757
+ * Returns the index of the specified value.
8758
+ *
8759
+ * If `value` is:
8760
+ * - a string, `value` is interpreted according to the character encoding in `encoding`.
8761
+ * - a `Buffer` or `Uint8Array`, `value` will be used in its entirety. To compare a partial Buffer, use `slice()`.
8762
+ * - a number, `value` will be interpreted as an unsigned 8-bit integer value between `0` and `255`.
8763
+ *
8764
+ * Any other types will throw a `TypeError`.
8765
+ *
8766
+ * @param value What to search for.
8767
+ * @param byteOffset Where to begin searching in `buf`. If negative, then calculated from the end.
8768
+ * @param encoding If `value` is a string, this is the encoding used to search.
8769
+ * @returns The index of the first occurrence of `value` in `buf`, or `-1` if not found.
8770
+ */
8771
+ indexOf(value: string | number | Buffer, byteOffset?: number, encoding?: Encoding): number;
8772
+ /**
8773
+ * Gets the last index of the specified value.
8774
+ *
8775
+ * @see indexOf()
8776
+ * @param value
8777
+ * @param byteOffset
8778
+ * @param encoding
8779
+ */
8780
+ lastIndexOf(value: string | number | Buffer, byteOffset?: number, encoding?: Encoding): number;
8781
+ private _bidirectionalIndexOf;
8782
+ /**
8783
+ * Equivalent to `buf.indexOf() !== -1`.
8784
+ *
8785
+ * @param value
8786
+ * @param byteOffset
8787
+ * @param encoding
8788
+ */
8789
+ includes(value: string | number | Buffer, byteOffset?: number, encoding?: Encoding): boolean;
8790
+ /**
8791
+ * Allocates a new Buffer using an `array` of octet values.
8792
+ *
8793
+ * @param array
8794
+ */
8795
+ static from(array: number[]): Buffer;
8796
+ /**
8797
+ * When passed a reference to the .buffer property of a TypedArray instance, the newly created Buffer will share
8798
+ * the same allocated memory as the TypedArray. The optional `byteOffset` and `length` arguments specify a memory
8799
+ * range within the `arrayBuffer` that will be shared by the Buffer.
8800
+ *
8801
+ * @param buffer The .buffer property of a TypedArray or a new ArrayBuffer().
8802
+ * @param byteOffset
8803
+ * @param length
8804
+ */
8805
+ static from(buffer: ArrayBuffer, byteOffset?: number, length?: number): Buffer;
8806
+ /**
8807
+ * Copies the passed `buffer` data onto a new Buffer instance.
8808
+ *
8809
+ * @param buffer
8810
+ */
8811
+ static from(buffer: Buffer | Uint8Array): Buffer;
8812
+ /**
8813
+ * Creates a new Buffer containing the given string `str`. If provided, the `encoding` parameter identifies the
8814
+ * character encoding.
8815
+ *
8816
+ * @param str String to store in buffer.
8817
+ * @param encoding Encoding to use, optional. Default is `utf8`.
8818
+ */
8819
+ static from(str: string, encoding?: Encoding): Buffer;
8820
+ /**
8821
+ * Returns true if `obj` is a Buffer.
8822
+ *
8823
+ * @param obj
8824
+ */
8825
+ static isBuffer(obj: any): obj is Buffer;
8826
+ /**
8827
+ * Returns true if `encoding` is a supported encoding.
8828
+ *
8829
+ * @param encoding
8830
+ */
8831
+ static isEncoding(encoding: string): encoding is Encoding;
8832
+ /**
8833
+ * Gives the actual byte length of a string for an encoding. This is not the same as `string.length` since that
8834
+ * returns the number of characters in the string.
8835
+ *
8836
+ * @param string The string to test.
8837
+ * @param encoding The encoding to use for calculation. Defaults is `utf8`.
8838
+ */
8839
+ static byteLength(string: string | Buffer | ArrayBuffer, encoding?: Encoding): number;
8840
+ /**
8841
+ * Returns a Buffer which is the result of concatenating all the buffers in the list together.
8842
+ *
8843
+ * - If the list has no items, or if the `totalLength` is 0, then it returns a zero-length buffer.
8844
+ * - If the list has exactly one item, then the first item is returned.
8845
+ * - If the list has more than one item, then a new buffer is created.
8846
+ *
8847
+ * It is faster to provide the `totalLength` if it is known. However, it will be calculated if not provided at
8848
+ * a small computational expense.
8849
+ *
8850
+ * @param list An array of Buffer objects to concatenate.
8851
+ * @param totalLength Total length of the buffers when concatenated.
8852
+ */
8853
+ static concat(list: Uint8Array[], totalLength?: number): Buffer;
8854
+ /**
8855
+ * The same as `buf1.compare(buf2)`.
8856
+ */
8857
+ static compare(buf1: Uint8Array, buf2: Uint8Array): number;
8858
+ /**
8859
+ * Allocates a new buffer of `size` octets.
8860
+ *
8861
+ * @param size The number of octets to allocate.
8862
+ * @param fill If specified, the buffer will be initialized by calling `buf.fill(fill)`, or with zeroes otherwise.
8863
+ * @param encoding The encoding used for the call to `buf.fill()` while initializing.
8864
+ */
8865
+ static alloc(size: number, fill?: string | Buffer | number, encoding?: Encoding): Buffer;
8866
+ /**
8867
+ * Allocates a new buffer of `size` octets without initializing memory. The contents of the buffer are unknown.
8868
+ *
8869
+ * @param size
8870
+ */
8871
+ static allocUnsafe(size: number): Buffer;
8872
+ /**
8873
+ * Returns true if the given `obj` is an instance of `type`.
8874
+ *
8875
+ * @param obj
8876
+ * @param type
8877
+ */
8878
+ private static _isInstance;
8879
+ private static _checked;
8880
+ private static _blitBuffer;
8881
+ private static _utf8Write;
8882
+ private static _asciiWrite;
8883
+ private static _base64Write;
8884
+ private static _ucs2Write;
8885
+ private static _hexWrite;
8886
+ private static _utf8ToBytes;
8887
+ private static _base64ToBytes;
8888
+ private static _asciiToBytes;
8889
+ private static _utf16leToBytes;
8890
+ private static _hexSlice;
8891
+ private static _base64Slice;
8892
+ private static _utf8Slice;
8893
+ private static _decodeCodePointsArray;
8894
+ private static _asciiSlice;
8895
+ private static _latin1Slice;
8896
+ private static _utf16leSlice;
8897
+ private static _arrayIndexOf;
8898
+ private static _checkOffset;
8899
+ private static _checkInt;
8900
+ private static _getEncoding;
8901
+ }
8902
+ /**
8903
+ * The encodings that are supported in both native and polyfilled `Buffer` instances.
8904
+ */
8905
+ type Encoding = 'ascii' | 'utf8' | 'utf16le' | 'ucs2' | 'binary' | 'hex' | 'latin1' | 'base64';
8906
+
8167
8907
  type XataFileEditableFields = Partial<Pick<XataArrayFile, keyof InputFileEntry>>;
8168
8908
  type XataFileFields = Partial<Pick<XataArrayFile, {
8169
8909
  [K in StringKeys<XataArrayFile>]: XataArrayFile[K] extends Function ? never : K;
@@ -8410,13 +9150,13 @@ type XataRecordMetadata = {
8410
9150
  declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
8411
9151
  declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;
8412
9152
  type NumericOperator = ExclusiveOr<{
8413
- $increment?: number;
9153
+ $increment: number;
8414
9154
  }, ExclusiveOr<{
8415
- $decrement?: number;
9155
+ $decrement: number;
8416
9156
  }, ExclusiveOr<{
8417
- $multiply?: number;
9157
+ $multiply: number;
8418
9158
  }, {
8419
- $divide?: number;
9159
+ $divide: number;
8420
9160
  }>>>;
8421
9161
  type InputXataFile = Partial<XataArrayFile> | Promise<Partial<XataArrayFile>>;
8422
9162
  type EditableDataFields<T> = T extends XataRecord ? {
@@ -10106,7 +10846,7 @@ type PropertyType<Tables, Properties, PropertyName extends PropertyKey> = Proper
10106
10846
  } : {
10107
10847
  [K in PropertyName]?: InnerType<Type, Tables, LinkedTable> | null;
10108
10848
  } : never : never;
10109
- 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;
10849
+ type InnerType<Type, Tables, LinkedTable> = Type extends 'string' | 'text' | 'email' | 'character' | 'varchar' | 'character varying' | `varchar(${number})` | `character(${number})` ? string : Type extends 'int' | 'float' | 'bigint' | 'int8' | 'integer' | 'int4' | 'smallint' | 'double precision' | 'float8' | 'real' | 'numeric' ? number : Type extends 'bool' | 'boolean' ? boolean : Type extends 'datetime' | 'timestamptz' ? Date : Type extends 'multiple' | 'text[]' ? string[] : Type extends 'vector' | 'real[]' | 'float[]' | 'double precision[]' | 'float8[]' | 'numeric[]' ? number[] : Type extends 'int[]' | 'bigint[]' | 'int8[]' | 'integer[]' | 'int4[]' | 'smallint[]' ? number[] : Type extends 'bool[]' | 'boolean[]' ? boolean[] : Type extends 'file' | 'xata_file' ? XataFile : Type extends 'file[]' | 'xata_file_array' ? XataArrayFile[] : Type extends 'json' | 'jsonb' ? JSONValue<any> : Type extends 'link' ? TableType<Tables, LinkedTable> & XataRecord : string;
10110
10850
 
10111
10851
  /**
10112
10852
  * Operator to restrict results to only values that are greater than the given value.
@@ -10285,10 +11025,37 @@ type SQLQueryParams<T = any[]> = {
10285
11025
  params?: T;
10286
11026
  /**
10287
11027
  * The consistency level to use when executing the query.
11028
+ * @default 'strong'
10288
11029
  */
10289
11030
  consistency?: 'strong' | 'eventual';
10290
11031
  /**
10291
11032
  * The response type to use when executing the query.
11033
+ * @default 'json'
11034
+ */
11035
+ responseType?: 'json' | 'array';
11036
+ };
11037
+ type SQLBatchQuery = {
11038
+ /**
11039
+ * The SQL statements to execute.
11040
+ */
11041
+ statements: {
11042
+ /**
11043
+ * The SQL statement to execute.
11044
+ */
11045
+ statement: string;
11046
+ /**
11047
+ * The parameters to pass to the SQL statement.
11048
+ */
11049
+ params?: any[];
11050
+ }[];
11051
+ /**
11052
+ * The consistency level to use when executing the queries.
11053
+ * @default 'strong'
11054
+ */
11055
+ consistency?: 'strong' | 'eventual';
11056
+ /**
11057
+ * The response type to use when executing the queries.
11058
+ * @default 'json'
10292
11059
  */
10293
11060
  responseType?: 'json' | 'array';
10294
11061
  };
@@ -10337,6 +11104,13 @@ type SQLPluginResult = SQLPluginFunction & {
10337
11104
  * Connects with the same credentials as the Xata client.
10338
11105
  */
10339
11106
  connectionString: string;
11107
+ /**
11108
+ * Executes a batch of SQL statements.
11109
+ * @param query The batch of SQL statements to execute.
11110
+ */
11111
+ batch: <Query extends SQLBatchQuery = SQLBatchQuery>(query: Query) => Promise<{
11112
+ results: Array<SQLQueryResult<any, Query extends SQLBatchQuery ? Query['responseType'] extends SQLResponseType ? NonNullable<Query['responseType']> : 'json' : 'json'>>;
11113
+ }>;
10340
11114
  };
10341
11115
  declare class SQLPlugin extends XataPlugin {
10342
11116
  build(pluginOptions: XataPluginOptions): SQLPluginResult;
@@ -10504,4 +11278,4 @@ declare class XataError extends Error {
10504
11278
  constructor(message: string, status: number);
10505
11279
  }
10506
11280
 
10507
- 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 CacheImpl, type CancelWorkspaceMemberInviteError, type CancelWorkspaceMemberInvitePathParams, type CancelWorkspaceMemberInviteVariables, type ClientConstructor, type ColumnsByValue, type CompareBranchSchemasError, type CompareBranchSchemasPathParams, type CompareBranchSchemasRequestBody, type CompareBranchSchemasVariables, type CompareBranchWithUserSchemaError, type CompareBranchWithUserSchemaPathParams, type CompareBranchWithUserSchemaRequestBody, type CompareBranchWithUserSchemaVariables, type CompareMigrationRequestError, type CompareMigrationRequestPathParams, type CompareMigrationRequestVariables, type CopyBranchError, type CopyBranchPathParams, type CopyBranchRequestBody, type CopyBranchVariables, type CreateBranchError, type CreateBranchPathParams, type CreateBranchQueryParams, type CreateBranchRequestBody, type CreateBranchResponse, type CreateBranchVariables, type CreateClusterError, type CreateClusterPathParams, type CreateClusterVariables, type CreateDatabaseError, type CreateDatabasePathParams, type CreateDatabaseRequestBody, type CreateDatabaseResponse, type CreateDatabaseVariables, type CreateMigrationRequestError, type CreateMigrationRequestPathParams, type CreateMigrationRequestRequestBody, type CreateMigrationRequestResponse, type CreateMigrationRequestVariables, type CreateTableError, type CreateTablePathParams, type CreateTableResponse, type CreateTableVariables, type CreateUserAPIKeyError, type CreateUserAPIKeyPathParams, type CreateUserAPIKeyResponse, type CreateUserAPIKeyVariables, type CreateWorkspaceError, type CreateWorkspaceVariables, type CursorNavigationOptions, type DeleteBranchError, type DeleteBranchPathParams, type DeleteBranchResponse, type DeleteBranchVariables, type DeleteColumnError, type DeleteColumnPathParams, type DeleteColumnVariables, type DeleteDatabaseError, type DeleteDatabaseGithubSettingsError, type DeleteDatabaseGithubSettingsPathParams, type DeleteDatabaseGithubSettingsVariables, type DeleteDatabasePathParams, type DeleteDatabaseResponse, type DeleteDatabaseVariables, type DeleteFileError, type DeleteFileItemError, type DeleteFileItemPathParams, type DeleteFileItemVariables, type DeleteFilePathParams, type DeleteFileVariables, type DeleteOAuthAccessTokenError, type DeleteOAuthAccessTokenPathParams, type DeleteOAuthAccessTokenVariables, type DeleteRecordError, type DeleteRecordPathParams, type DeleteRecordQueryParams, type DeleteRecordVariables, type DeleteTableError, type DeleteTablePathParams, type DeleteTableResponse, type DeleteTableVariables, type DeleteTransactionOperation, type DeleteUserAPIKeyError, type DeleteUserAPIKeyPathParams, type DeleteUserAPIKeyVariables, type DeleteUserError, type DeleteUserOAuthClientError, type DeleteUserOAuthClientPathParams, type DeleteUserOAuthClientVariables, type DeleteUserVariables, type DeleteWorkspaceError, type DeleteWorkspacePathParams, type DeleteWorkspaceVariables, type DeserializedType, type DownloadDestination, type EditableData, type ExecuteBranchMigrationPlanError, type ExecuteBranchMigrationPlanPathParams, type ExecuteBranchMigrationPlanRequestBody, type ExecuteBranchMigrationPlanVariables, type FetchImpl, FetcherError, type FetcherExtraProps, type FileAccessError, type FileAccessPathParams, type FileAccessQueryParams, type FileAccessVariables, type FileUploadError, type FileUploadPathParams, type FileUploadQueryParams, type FileUploadVariables, FilesPlugin, type FilesPluginResult, type GetAuthorizationCodeError, type GetAuthorizationCodeQueryParams, type GetAuthorizationCodeVariables, type GetBranchDetailsError, type GetBranchDetailsPathParams, type GetBranchDetailsVariables, type GetBranchListError, type GetBranchListPathParams, type GetBranchListVariables, type GetBranchMetadataError, type GetBranchMetadataPathParams, type GetBranchMetadataVariables, type GetBranchMigrationHistoryError, type GetBranchMigrationHistoryPathParams, type GetBranchMigrationHistoryRequestBody, type GetBranchMigrationHistoryResponse, type GetBranchMigrationHistoryVariables, type 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 GetWorkspaceSettingsError, type GetWorkspaceSettingsPathParams, type GetWorkspaceSettingsVariables, type GetWorkspaceVariables, type GetWorkspacesListError, type GetWorkspacesListResponse, type GetWorkspacesListVariables, type GrantAuthorizationCodeError, type GrantAuthorizationCodeVariables, type HostProvider, type Identifiable, type ImageTransformations, type InsertRecordError, type InsertRecordPathParams, type InsertRecordQueryParams, type InsertRecordVariables, type InsertRecordWithIDError, type InsertRecordWithIDPathParams, type InsertRecordWithIDQueryParams, type InsertRecordWithIDVariables, type InsertTransactionOperation, type InviteWorkspaceMemberError, type InviteWorkspaceMemberPathParams, type InviteWorkspaceMemberRequestBody, type InviteWorkspaceMemberVariables, type JSONData, type KeywordAskOptions, type Link, type 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, SimpleCache, type SimpleCacheOptions, type SqlQueryError, type SqlQueryPathParams, type SqlQueryRequestBody, type SqlQueryVariables, type SummarizeTableError, type SummarizeTablePathParams, type SummarizeTableRequestBody, type SummarizeTableVariables, type TotalCount, type TransactionOperation, TransactionPlugin, type TransactionPluginResult, type TransactionResults, type UpdateBranchMetadataError, type UpdateBranchMetadataPathParams, type UpdateBranchMetadataVariables, type UpdateBranchSchemaError, type UpdateBranchSchemaPathParams, type UpdateBranchSchemaVariables, type UpdateClusterError, type UpdateClusterPathParams, type UpdateClusterVariables, type UpdateColumnError, type UpdateColumnPathParams, type UpdateColumnRequestBody, type UpdateColumnVariables, type UpdateDatabaseGithubSettingsError, type UpdateDatabaseGithubSettingsPathParams, type UpdateDatabaseGithubSettingsVariables, type UpdateDatabaseMetadataError, type UpdateDatabaseMetadataPathParams, type UpdateDatabaseMetadataRequestBody, type UpdateDatabaseMetadataVariables, type UpdateDatabaseSettingsError, type UpdateDatabaseSettingsPathParams, type UpdateDatabaseSettingsRequestBody, type UpdateDatabaseSettingsVariables, type UpdateMigrationRequestError, type UpdateMigrationRequestPathParams, type UpdateMigrationRequestRequestBody, type UpdateMigrationRequestVariables, type UpdateOAuthAccessTokenError, type UpdateOAuthAccessTokenPathParams, type UpdateOAuthAccessTokenRequestBody, type UpdateOAuthAccessTokenVariables, type UpdateRecordWithIDError, type UpdateRecordWithIDPathParams, type UpdateRecordWithIDQueryParams, type UpdateRecordWithIDVariables, type UpdateTableError, type UpdateTablePathParams, type UpdateTableRequestBody, type UpdateTableVariables, type UpdateTransactionOperation, type UpdateUserError, type UpdateUserVariables, type UpdateWorkspaceError, type UpdateWorkspaceMemberInviteError, type UpdateWorkspaceMemberInvitePathParams, type UpdateWorkspaceMemberInviteRequestBody, type UpdateWorkspaceMemberInviteVariables, type UpdateWorkspaceMemberRoleError, type UpdateWorkspaceMemberRolePathParams, type UpdateWorkspaceMemberRoleRequestBody, type UpdateWorkspaceMemberRoleVariables, type UpdateWorkspacePathParams, type UpdateWorkspaceSettingsError, type UpdateWorkspaceSettingsPathParams, type UpdateWorkspaceSettingsRequestBody, type UpdateWorkspaceSettingsVariables, type UpdateWorkspaceVariables, type UploadDestination, type UpsertRecordWithIDError, type UpsertRecordWithIDPathParams, type UpsertRecordWithIDQueryParams, type UpsertRecordWithIDVariables, type ValueAtColumn, type VectorAskOptions, type VectorSearchTableError, type VectorSearchTablePathParams, type VectorSearchTableRequestBody, type VectorSearchTableVariables, XataApiClient, type XataApiClientOptions, XataApiPlugin, type XataArrayFile, XataError, XataFile, XataPlugin, type XataPluginOptions, type XataRecord, acceptWorkspaceMemberInvite, 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, getWorkspaceSettings, getWorkspacesList, grantAuthorizationCode, greaterEquals, greaterThan, greaterThanEquals, gt, gte, iContains, iPattern, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isValidExpandedColumn, isValidSelectableColumns, isXataRecord, le, lessEquals, lessThan, lessThanEquals, 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, updateWorkspaceSettings, upsertRecordWithID, vectorSearchTable };
11281
+ export { type AcceptWorkspaceMemberInviteError, type AcceptWorkspaceMemberInvitePathParams, type AcceptWorkspaceMemberInviteVariables, type AdaptAllTablesError, type AdaptAllTablesPathParams, type AdaptAllTablesVariables, type AdaptTableError, type AdaptTablePathParams, type AdaptTableVariables, type AddGitBranchesEntryError, type AddGitBranchesEntryPathParams, type AddGitBranchesEntryRequestBody, type AddGitBranchesEntryResponse, type AddGitBranchesEntryVariables, type AddTableColumnError, type AddTableColumnPathParams, type AddTableColumnVariables, type AggregateTableError, type AggregateTablePathParams, type AggregateTableRequestBody, type AggregateTableVariables, type ApiExtraProps, type ApplyBranchSchemaEditError, type ApplyBranchSchemaEditPathParams, type ApplyBranchSchemaEditRequestBody, type ApplyBranchSchemaEditVariables, type ApplyMigrationError, type ApplyMigrationPathParams, type ApplyMigrationRequestBody, type ApplyMigrationVariables, type AskOptions, type AskResult, type AskTableError, type AskTablePathParams, type AskTableRequestBody, type AskTableResponse, type AskTableSessionError, type AskTableSessionPathParams, type AskTableSessionRequestBody, type AskTableSessionResponse, type AskTableSessionVariables, type AskTableVariables, BaseClient, type BaseClientOptions, type BaseData, type BaseSchema, type BinaryFile, type BranchTransactionError, type BranchTransactionPathParams, type BranchTransactionRequestBody, type BranchTransactionVariables, Buffer, type BulkInsertTableRecordsError, type BulkInsertTableRecordsPathParams, type BulkInsertTableRecordsQueryParams, type BulkInsertTableRecordsRequestBody, type BulkInsertTableRecordsVariables, type CacheImpl, type CancelWorkspaceMemberInviteError, type CancelWorkspaceMemberInvitePathParams, type CancelWorkspaceMemberInviteVariables, type ClientConstructor, type ColumnsByValue, type CompareBranchSchemasError, type CompareBranchSchemasPathParams, type CompareBranchSchemasRequestBody, type CompareBranchSchemasVariables, type CompareBranchWithUserSchemaError, type CompareBranchWithUserSchemaPathParams, type CompareBranchWithUserSchemaRequestBody, type CompareBranchWithUserSchemaVariables, type CompareMigrationRequestError, type CompareMigrationRequestPathParams, type CompareMigrationRequestVariables, type CompleteMigrationError, type CompleteMigrationPathParams, type CompleteMigrationRequestBody, type CompleteMigrationVariables, type CopyBranchError, type CopyBranchPathParams, type CopyBranchRequestBody, type CopyBranchVariables, type CreateBranchError, type CreateBranchPathParams, type CreateBranchQueryParams, type CreateBranchRequestBody, type CreateBranchResponse, type CreateBranchVariables, type CreateClusterError, type CreateClusterPathParams, type CreateClusterVariables, type CreateDatabaseError, type CreateDatabasePathParams, type CreateDatabaseRequestBody, type CreateDatabaseResponse, type CreateDatabaseVariables, type CreateMigrationRequestError, type CreateMigrationRequestPathParams, type CreateMigrationRequestRequestBody, type CreateMigrationRequestResponse, type CreateMigrationRequestVariables, type CreateTableError, type CreateTablePathParams, type CreateTableResponse, type CreateTableVariables, type CreateUserAPIKeyError, type CreateUserAPIKeyPathParams, type CreateUserAPIKeyResponse, type CreateUserAPIKeyVariables, type CreateWorkspaceError, type CreateWorkspaceVariables, type CursorNavigationOptions, type DeleteBranchError, type DeleteBranchPathParams, type DeleteBranchResponse, type DeleteBranchVariables, type DeleteClusterError, type DeleteClusterPathParams, type DeleteClusterVariables, type DeleteColumnError, type DeleteColumnPathParams, type DeleteColumnVariables, type DeleteDatabaseError, type DeleteDatabaseGithubSettingsError, type DeleteDatabaseGithubSettingsPathParams, type DeleteDatabaseGithubSettingsVariables, type DeleteDatabasePathParams, type DeleteDatabaseResponse, type DeleteDatabaseVariables, type DeleteFileError, type DeleteFileItemError, type DeleteFileItemPathParams, type DeleteFileItemVariables, type DeleteFilePathParams, type DeleteFileVariables, type DeleteOAuthAccessTokenError, type DeleteOAuthAccessTokenPathParams, type DeleteOAuthAccessTokenVariables, type DeleteRecordError, type DeleteRecordPathParams, type DeleteRecordQueryParams, type DeleteRecordVariables, type DeleteTableError, type DeleteTablePathParams, type DeleteTableResponse, type DeleteTableVariables, type DeleteTransactionOperation, type DeleteUserAPIKeyError, type DeleteUserAPIKeyPathParams, type DeleteUserAPIKeyVariables, type DeleteUserError, type DeleteUserOAuthClientError, type DeleteUserOAuthClientPathParams, type DeleteUserOAuthClientVariables, type DeleteUserVariables, type DeleteWorkspaceError, type DeleteWorkspacePathParams, type DeleteWorkspaceVariables, type DeserializedType, type DownloadDestination, type DropClusterExtensionError, type DropClusterExtensionPathParams, type DropClusterExtensionRequestBody, type DropClusterExtensionVariables, type EditableData, type ExecuteBranchMigrationPlanError, type ExecuteBranchMigrationPlanPathParams, type ExecuteBranchMigrationPlanRequestBody, type ExecuteBranchMigrationPlanVariables, type FetchImpl, FetcherError, type FetcherExtraProps, type FileAccessError, type FileAccessPathParams, type FileAccessQueryParams, type FileAccessVariables, type FileUploadError, type FileUploadPathParams, type FileUploadQueryParams, type FileUploadVariables, FilesPlugin, type FilesPluginResult, type GetAuthorizationCodeError, type GetAuthorizationCodeQueryParams, type GetAuthorizationCodeVariables, type GetBranchDetailsError, type GetBranchDetailsPathParams, type GetBranchDetailsVariables, type GetBranchListError, type GetBranchListPathParams, type GetBranchListVariables, type GetBranchMetadataError, type GetBranchMetadataPathParams, type GetBranchMetadataVariables, type GetBranchMigrationHistoryError, type GetBranchMigrationHistoryPathParams, type GetBranchMigrationHistoryRequestBody, type GetBranchMigrationHistoryResponse, type GetBranchMigrationHistoryVariables, type GetBranchMigrationJobStatusError, type GetBranchMigrationJobStatusPathParams, type GetBranchMigrationJobStatusVariables, type GetBranchMigrationPlanError, type GetBranchMigrationPlanPathParams, type GetBranchMigrationPlanVariables, type GetBranchMoveStatusError, type GetBranchMoveStatusPathParams, type GetBranchMoveStatusResponse, type GetBranchMoveStatusVariables, type GetBranchSchemaHistoryError, type GetBranchSchemaHistoryPathParams, type GetBranchSchemaHistoryRequestBody, type GetBranchSchemaHistoryResponse, type GetBranchSchemaHistoryVariables, type GetBranchStatsError, type GetBranchStatsPathParams, type GetBranchStatsResponse, type GetBranchStatsVariables, type GetClusterError, type GetClusterMetricsError, type GetClusterMetricsPathParams, type GetClusterMetricsQueryParams, type GetClusterMetricsVariables, type GetClusterPathParams, type GetClusterVariables, type GetColumnError, type GetColumnPathParams, type GetColumnVariables, type GetDatabaseGithubSettingsError, type GetDatabaseGithubSettingsPathParams, type GetDatabaseGithubSettingsVariables, type GetDatabaseListError, type GetDatabaseListPathParams, type GetDatabaseListVariables, type GetDatabaseMetadataError, type GetDatabaseMetadataPathParams, type GetDatabaseMetadataVariables, type GetDatabaseSettingsError, type GetDatabaseSettingsPathParams, type GetDatabaseSettingsVariables, type GetFileError, type GetFileItemError, type GetFileItemPathParams, type GetFileItemVariables, type GetFilePathParams, type GetFileVariables, type GetGitBranchesMappingError, type GetGitBranchesMappingPathParams, type GetGitBranchesMappingVariables, type GetMigrationHistoryError, type GetMigrationHistoryPathParams, type GetMigrationHistoryQueryParams, type GetMigrationHistoryVariables, type GetMigrationJobStatusError, type GetMigrationJobStatusPathParams, type GetMigrationJobStatusVariables, type GetMigrationJobsError, type GetMigrationJobsPathParams, type GetMigrationJobsQueryParams, type GetMigrationJobsVariables, type GetMigrationRequestError, type GetMigrationRequestIsMergedError, type GetMigrationRequestIsMergedPathParams, type GetMigrationRequestIsMergedResponse, type GetMigrationRequestIsMergedVariables, type GetMigrationRequestPathParams, type GetMigrationRequestVariables, type GetRecordError, type GetRecordPathParams, type GetRecordQueryParams, type GetRecordVariables, type GetSchemaError, type GetSchemaPathParams, type GetSchemaResponse, type GetSchemaVariables, type GetSchemasError, type GetSchemasPathParams, type GetSchemasResponse, type GetSchemasVariables, type GetTableColumnsError, type GetTableColumnsPathParams, type GetTableColumnsResponse, type GetTableColumnsVariables, type GetTableSchemaError, type GetTableSchemaPathParams, type GetTableSchemaResponse, type GetTableSchemaVariables, type GetTransactionOperation, type GetUserAPIKeysError, type GetUserAPIKeysResponse, type GetUserAPIKeysVariables, type GetUserError, type GetUserOAuthAccessTokensError, type GetUserOAuthAccessTokensResponse, type GetUserOAuthAccessTokensVariables, type GetUserOAuthClientsError, type GetUserOAuthClientsResponse, type GetUserOAuthClientsVariables, type GetUserVariables, type GetWorkspaceError, type GetWorkspaceMembersListError, type GetWorkspaceMembersListPathParams, type GetWorkspaceMembersListVariables, type GetWorkspacePathParams, type GetWorkspaceSettingsError, type GetWorkspaceSettingsPathParams, type GetWorkspaceSettingsVariables, type GetWorkspaceVariables, type GetWorkspacesListError, type GetWorkspacesListResponse, type GetWorkspacesListVariables, type GrantAuthorizationCodeError, type GrantAuthorizationCodeVariables, type HostProvider, type Identifiable, type ImageTransformations, type InsertRecordError, type InsertRecordPathParams, type InsertRecordQueryParams, type InsertRecordVariables, type InsertRecordWithIDError, type InsertRecordWithIDPathParams, type InsertRecordWithIDQueryParams, type InsertRecordWithIDVariables, type InsertTransactionOperation, type InstallClusterExtensionError, type InstallClusterExtensionPathParams, type InstallClusterExtensionRequestBody, type InstallClusterExtensionVariables, type InviteWorkspaceMemberError, type InviteWorkspaceMemberPathParams, type InviteWorkspaceMemberRequestBody, type InviteWorkspaceMemberVariables, type JSONData, type KeywordAskOptions, type Link, type ListClusterBranchesError, type ListClusterBranchesPathParams, type ListClusterBranchesQueryParams, type ListClusterBranchesVariables, type ListClusterExtensionsError, type ListClusterExtensionsPathParams, type ListClusterExtensionsQueryParams, type ListClusterExtensionsVariables, type ListClustersError, type ListClustersPathParams, type ListClustersQueryParams, type ListClustersVariables, type ListMigrationRequestsCommitsError, type ListMigrationRequestsCommitsPathParams, type ListMigrationRequestsCommitsRequestBody, type ListMigrationRequestsCommitsResponse, type ListMigrationRequestsCommitsVariables, type ListRegionsError, type ListRegionsPathParams, type ListRegionsVariables, type MergeMigrationRequestError, type MergeMigrationRequestPathParams, type MergeMigrationRequestVariables, type MoveBranchError, type MoveBranchPathParams, type MoveBranchRequestBody, type MoveBranchResponse, type MoveBranchVariables, type OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, PageRecordArray, type Paginable, type PaginationQueryMeta, type PreviewBranchSchemaEditError, type PreviewBranchSchemaEditPathParams, type PreviewBranchSchemaEditRequestBody, type PreviewBranchSchemaEditResponse, type PreviewBranchSchemaEditVariables, type PushBranchMigrationsError, type PushBranchMigrationsPathParams, type PushBranchMigrationsRequestBody, type PushBranchMigrationsVariables, type PutFileError, type PutFileItemError, type PutFileItemPathParams, type PutFileItemVariables, type PutFilePathParams, type PutFileVariables, Query, type QueryMigrationRequestsError, type QueryMigrationRequestsPathParams, type QueryMigrationRequestsRequestBody, type QueryMigrationRequestsResponse, type QueryMigrationRequestsVariables, type QueryTableError, type QueryTablePathParams, type QueryTableRequestBody, type QueryTableVariables, RecordArray, RecordColumnTypes, type RemoveGitBranchesEntryError, type RemoveGitBranchesEntryPathParams, type RemoveGitBranchesEntryQueryParams, type RemoveGitBranchesEntryVariables, type RemoveWorkspaceMemberError, type RemoveWorkspaceMemberPathParams, type RemoveWorkspaceMemberVariables, type RenameDatabaseError, type RenameDatabasePathParams, type RenameDatabaseRequestBody, type RenameDatabaseVariables, Repository, type ResendWorkspaceMemberInviteError, type ResendWorkspaceMemberInvitePathParams, type ResendWorkspaceMemberInviteVariables, type ResolveBranchError, type ResolveBranchPathParams, type ResolveBranchQueryParams, type ResolveBranchResponse, type ResolveBranchVariables, responses as Responses, RestRepository, type RollbackMigrationError, type RollbackMigrationPathParams, type RollbackMigrationRequestBody, type RollbackMigrationVariables, type SQLBatchQuery, SQLPlugin, type SQLPluginResult, type SQLQuery, type SQLQueryParams, type SQLQueryResult, type SchemaDefinition, type SchemaInference, SchemaPlugin, type SchemaPluginResult, schemas as Schemas, type SearchBranchError, type SearchBranchPathParams, type SearchBranchRequestBody, type SearchBranchVariables, type SearchOptions, SearchPlugin, type SearchPluginResult, type SearchTableError, type SearchTablePathParams, type SearchTableRequestBody, type SearchTableVariables, type SearchXataRecord, type SelectableColumn, type SelectableColumnWithObjectNotation, type SelectedPick, type SerializedString, Serializer, type SerializerResult, type SetTableSchemaError, type SetTableSchemaPathParams, type SetTableSchemaRequestBody, type SetTableSchemaVariables, SimpleCache, type SimpleCacheOptions, type SqlBatchQueryError, type SqlBatchQueryPathParams, type SqlBatchQueryRequestBody, type SqlBatchQueryVariables, type SqlQueryError, type SqlQueryPathParams, type SqlQueryRequestBody, type SqlQueryVariables, type StartMigrationError, type StartMigrationPathParams, type StartMigrationRequestBody, type StartMigrationVariables, type SummarizeTableError, type SummarizeTablePathParams, type SummarizeTableRequestBody, type SummarizeTableVariables, type TotalCount, type TransactionOperation, TransactionPlugin, type TransactionPluginResult, type TransactionResults, type UpdateBranchMetadataError, type UpdateBranchMetadataPathParams, type UpdateBranchMetadataVariables, type UpdateBranchSchemaError, type UpdateBranchSchemaPathParams, type UpdateBranchSchemaVariables, type UpdateClusterError, type UpdateClusterPathParams, type UpdateClusterVariables, type UpdateColumnError, type UpdateColumnPathParams, type UpdateColumnRequestBody, type UpdateColumnVariables, type UpdateDatabaseGithubSettingsError, type UpdateDatabaseGithubSettingsPathParams, type UpdateDatabaseGithubSettingsVariables, type UpdateDatabaseMetadataError, type UpdateDatabaseMetadataPathParams, type UpdateDatabaseMetadataRequestBody, type UpdateDatabaseMetadataVariables, type UpdateDatabaseSettingsError, type UpdateDatabaseSettingsPathParams, type UpdateDatabaseSettingsRequestBody, type UpdateDatabaseSettingsVariables, type UpdateMigrationRequestError, type UpdateMigrationRequestPathParams, type UpdateMigrationRequestRequestBody, type UpdateMigrationRequestVariables, type UpdateOAuthAccessTokenError, type UpdateOAuthAccessTokenPathParams, type UpdateOAuthAccessTokenRequestBody, type UpdateOAuthAccessTokenVariables, type UpdateRecordWithIDError, type UpdateRecordWithIDPathParams, type UpdateRecordWithIDQueryParams, type UpdateRecordWithIDVariables, type UpdateTableError, type UpdateTablePathParams, type UpdateTableRequestBody, type UpdateTableVariables, type UpdateTransactionOperation, type UpdateUserError, type UpdateUserVariables, type UpdateWorkspaceError, type UpdateWorkspaceMemberInviteError, type UpdateWorkspaceMemberInvitePathParams, type UpdateWorkspaceMemberInviteRequestBody, type UpdateWorkspaceMemberInviteVariables, type UpdateWorkspaceMemberRoleError, type UpdateWorkspaceMemberRolePathParams, type UpdateWorkspaceMemberRoleRequestBody, type UpdateWorkspaceMemberRoleVariables, type UpdateWorkspacePathParams, type UpdateWorkspaceSettingsError, type UpdateWorkspaceSettingsPathParams, type UpdateWorkspaceSettingsVariables, type UpdateWorkspaceVariables, type UploadDestination, type UpsertRecordWithIDError, type UpsertRecordWithIDPathParams, type UpsertRecordWithIDQueryParams, type UpsertRecordWithIDVariables, type ValueAtColumn, type VectorAskOptions, type VectorSearchTableError, type VectorSearchTablePathParams, type VectorSearchTableRequestBody, type VectorSearchTableVariables, XataApiClient, type XataApiClientOptions, XataApiPlugin, type XataArrayFile, XataError, XataFile, XataPlugin, type XataPluginOptions, type XataRecord, acceptWorkspaceMemberInvite, adaptAllTables, adaptTable, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, applyMigration, askTable, askTableSession, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, completeMigration, contains, copyBranch, createBranch, createCluster, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteCluster, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteFile, deleteFileItem, deleteOAuthAccessToken, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteUserOAuthClient, deleteWorkspace, deserialize, dropClusterExtension, endsWith, equals, executeBranchMigrationPlan, exists, fileAccess, fileUpload, ge, getAPIKey, getAuthorizationCode, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationJobStatus, getBranchMigrationPlan, getBranchMoveStatus, getBranchSchemaHistory, getBranchStats, getCluster, getClusterMetrics, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseSettings, getDatabaseURL, getFile, getFileItem, getGitBranchesMapping, getHostUrl, getMigrationHistory, getMigrationJobStatus, getMigrationJobs, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, getRecord, getSchema, getSchemas, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getUserOAuthAccessTokens, getUserOAuthClients, getWorkspace, getWorkspaceMembersList, getWorkspaceSettings, getWorkspacesList, grantAuthorizationCode, greaterEquals, greaterThan, greaterThanEquals, gt, gte, iContains, iPattern, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, installClusterExtension, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isValidExpandedColumn, isValidSelectableColumns, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listClusterBranches, listClusterExtensions, listClusters, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, moveBranch, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, pushBranchMigrations, putFile, putFileItem, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, renameDatabase, resendWorkspaceMemberInvite, resolveBranch, rollbackMigration, searchBranch, searchTable, serialize, setTableSchema, sqlBatchQuery, sqlQuery, startMigration, startsWith, summarizeTable, transformImage, updateBranchMetadata, updateBranchSchema, updateCluster, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateDatabaseSettings, updateMigrationRequest, updateOAuthAccessToken, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, updateWorkspaceSettings, upsertRecordWithID, vectorSearchTable };