@xata.io/client 0.0.0-alpha.veecda7c → 0.0.0-alpha.vefa01e6

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
@@ -37,7 +37,7 @@ type TraceFunction = <T>(name: string, fn: (options: {
37
37
  }) => T, options?: AttributeDictionary) => Promise<T>;
38
38
 
39
39
  type RequestInit = {
40
- body?: string;
40
+ body?: any;
41
41
  headers?: Record<string, string>;
42
42
  method?: string;
43
43
  signal?: any;
@@ -47,6 +47,8 @@ type Response = {
47
47
  status: number;
48
48
  url: string;
49
49
  json(): Promise<any>;
50
+ text(): Promise<string>;
51
+ blob(): Promise<Blob>;
50
52
  headers?: {
51
53
  get(name: string): string | null;
52
54
  };
@@ -81,6 +83,8 @@ type FetcherExtraProps = {
81
83
  clientName?: string;
82
84
  xataAgentExtra?: Record<string, string>;
83
85
  fetchOptions?: Record<string, unknown>;
86
+ rawResponse?: boolean;
87
+ headers?: Record<string, unknown>;
84
88
  };
85
89
 
86
90
  type ControlPlaneFetcherExtraProps = {
@@ -105,6 +109,26 @@ type ErrorWrapper$1<TError> = TError | {
105
109
  *
106
110
  * @version 1.0
107
111
  */
112
+ type OAuthResponseType = 'code';
113
+ type OAuthScope = 'admin:all';
114
+ type AuthorizationCodeResponse = {
115
+ state?: string;
116
+ redirectUri?: string;
117
+ scopes?: OAuthScope[];
118
+ clientId?: string;
119
+ /**
120
+ * @format date-time
121
+ */
122
+ expires?: string;
123
+ code?: string;
124
+ };
125
+ type AuthorizationCodeRequest = {
126
+ state?: string;
127
+ redirectUri?: string;
128
+ scopes?: OAuthScope[];
129
+ clientId: string;
130
+ responseType: OAuthResponseType;
131
+ };
108
132
  type User = {
109
133
  /**
110
134
  * @format email
@@ -129,6 +153,31 @@ type DateTime$1 = string;
129
153
  * @pattern [a-zA-Z0-9_\-~]*
130
154
  */
131
155
  type APIKeyName = string;
156
+ type OAuthClientPublicDetails = {
157
+ name?: string;
158
+ description?: string;
159
+ icon?: string;
160
+ clientId: string;
161
+ };
162
+ type OAuthClientID = string;
163
+ type OAuthAccessToken = {
164
+ token: string;
165
+ scopes: string[];
166
+ /**
167
+ * @format date-time
168
+ */
169
+ createdAt: string;
170
+ /**
171
+ * @format date-time
172
+ */
173
+ updatedAt: string;
174
+ /**
175
+ * @format date-time
176
+ */
177
+ expiresAt: string;
178
+ clientId: string;
179
+ };
180
+ type AccessToken = string;
132
181
  /**
133
182
  * @pattern ^([a-zA-Z0-9][a-zA-Z0-9_\-~]+-)?[a-zA-Z0-9]{6}
134
183
  * @x-go-type auth.WorkspaceID
@@ -138,6 +187,7 @@ type WorkspaceID = string;
138
187
  * @x-go-type auth.Role
139
188
  */
140
189
  type Role = 'owner' | 'maintainer';
190
+ type WorkspacePlan = 'free' | 'pro';
141
191
  type WorkspaceMeta = {
142
192
  name: string;
143
193
  slug?: string;
@@ -145,7 +195,7 @@ type WorkspaceMeta = {
145
195
  type Workspace = WorkspaceMeta & {
146
196
  id: WorkspaceID;
147
197
  memberCount: number;
148
- plan: 'free' | 'pro';
198
+ plan: WorkspacePlan;
149
199
  };
150
200
  type WorkspaceMember = {
151
201
  userId: UserID;
@@ -180,6 +230,170 @@ type WorkspaceMembers = {
180
230
  * @pattern ^ik_[a-zA-Z0-9]+
181
231
  */
182
232
  type InviteKey = string;
233
+ /**
234
+ * @x-internal true
235
+ * @pattern [a-zA-Z0-9_-~:]+
236
+ */
237
+ type ClusterID = string;
238
+ /**
239
+ * @x-internal true
240
+ */
241
+ type ClusterShortMetadata = {
242
+ id: ClusterID;
243
+ state: string;
244
+ region: string;
245
+ name: string;
246
+ /**
247
+ * @format int64
248
+ */
249
+ branches: number;
250
+ };
251
+ /**
252
+ * @x-internal true
253
+ */
254
+ type ListClustersResponse = {
255
+ clusters: ClusterShortMetadata[];
256
+ };
257
+ /**
258
+ * @x-internal true
259
+ */
260
+ type AutoscalingConfig = {
261
+ /**
262
+ * @format double
263
+ * @default 2
264
+ */
265
+ minCapacity?: number;
266
+ /**
267
+ * @format double
268
+ * @default 16
269
+ */
270
+ maxCapacity?: number;
271
+ };
272
+ /**
273
+ * @x-internal true
274
+ */
275
+ type WeeklyTimeWindow = {
276
+ day: 'mon' | 'tue' | 'wed' | 'thu' | 'fri' | 'sat' | 'sun';
277
+ /**
278
+ * @maximum 24
279
+ * @minimum 0
280
+ */
281
+ hour: number;
282
+ /**
283
+ * @maximum 60
284
+ * @minimum 0
285
+ */
286
+ minute: number;
287
+ /**
288
+ * @format float
289
+ * @maximum 23.5
290
+ * @minimum 0.5
291
+ */
292
+ duration: number;
293
+ };
294
+ /**
295
+ * @x-internal true
296
+ */
297
+ type DailyTimeWindow = {
298
+ /**
299
+ * @maximum 24
300
+ * @minimum 0
301
+ */
302
+ hour: number;
303
+ /**
304
+ * @maximum 60
305
+ * @minimum 0
306
+ */
307
+ minute: number;
308
+ /**
309
+ * @format float
310
+ */
311
+ duration: number;
312
+ };
313
+ /**
314
+ * @x-internal true
315
+ */
316
+ type MaintenanceConfig = {
317
+ /**
318
+ * @default false
319
+ */
320
+ autoMinorVersionUpgrade?: boolean;
321
+ /**
322
+ * @default false
323
+ */
324
+ applyImmediately?: boolean;
325
+ maintenanceWindow?: WeeklyTimeWindow;
326
+ backupWindow?: DailyTimeWindow;
327
+ };
328
+ /**
329
+ * @x-internal true
330
+ */
331
+ type ClusterConfiguration = {
332
+ engineVersion: string;
333
+ instanceType: string;
334
+ /**
335
+ * @format int64
336
+ */
337
+ replicas?: number;
338
+ /**
339
+ * @default false
340
+ */
341
+ deletionProtection?: boolean;
342
+ autoscaling?: AutoscalingConfig;
343
+ maintenance?: MaintenanceConfig;
344
+ };
345
+ /**
346
+ * @x-internal true
347
+ */
348
+ type ClusterCreateDetails = {
349
+ /**
350
+ * @minLength 1
351
+ */
352
+ region: string;
353
+ /**
354
+ * @maxLength 63
355
+ * @minLength 1
356
+ * @pattern [a-zA-Z0-9_-~:]+
357
+ */
358
+ name: string;
359
+ configuration: ClusterConfiguration;
360
+ };
361
+ /**
362
+ * @x-internal true
363
+ */
364
+ type ClusterResponse = {
365
+ state: string;
366
+ clusterID: string;
367
+ };
368
+ /**
369
+ * @x-internal true
370
+ */
371
+ type ClusterMetadata = {
372
+ id: ClusterID;
373
+ state: string;
374
+ region: string;
375
+ name: string;
376
+ /**
377
+ * @format int64
378
+ */
379
+ branches: number;
380
+ configuration?: ClusterConfiguration;
381
+ };
382
+ /**
383
+ * @x-internal true
384
+ */
385
+ type ClusterUpdateDetails = {
386
+ id: ClusterID;
387
+ /**
388
+ * @maxLength 63
389
+ * @minLength 1
390
+ * @pattern [a-zA-Z0-9_-~:]+
391
+ */
392
+ name?: string;
393
+ configuration?: ClusterConfiguration;
394
+ state?: string;
395
+ region?: string;
396
+ };
183
397
  /**
184
398
  * Metadata of databases
185
399
  */
@@ -260,6 +474,7 @@ type DatabaseGithubSettings = {
260
474
  };
261
475
  type Region = {
262
476
  id: string;
477
+ name: string;
263
478
  };
264
479
  type ListRegionsResponse = {
265
480
  /**
@@ -295,6 +510,53 @@ type SimpleError$1 = {
295
510
  * @version 1.0
296
511
  */
297
512
 
513
+ type GetAuthorizationCodeQueryParams = {
514
+ clientID: string;
515
+ responseType: OAuthResponseType;
516
+ redirectUri?: string;
517
+ scopes?: OAuthScope[];
518
+ state?: string;
519
+ };
520
+ type GetAuthorizationCodeError = ErrorWrapper$1<{
521
+ status: 400;
522
+ payload: BadRequestError$1;
523
+ } | {
524
+ status: 401;
525
+ payload: AuthError$1;
526
+ } | {
527
+ status: 404;
528
+ payload: SimpleError$1;
529
+ } | {
530
+ status: 409;
531
+ payload: SimpleError$1;
532
+ }>;
533
+ type GetAuthorizationCodeVariables = {
534
+ queryParams: GetAuthorizationCodeQueryParams;
535
+ } & ControlPlaneFetcherExtraProps;
536
+ /**
537
+ * Creates, stores and returns an authorization code to be used by a third party app. Supporting use of GET is required by OAuth2 spec
538
+ */
539
+ declare const getAuthorizationCode: (variables: GetAuthorizationCodeVariables, signal?: AbortSignal) => Promise<AuthorizationCodeResponse>;
540
+ type GrantAuthorizationCodeError = ErrorWrapper$1<{
541
+ status: 400;
542
+ payload: BadRequestError$1;
543
+ } | {
544
+ status: 401;
545
+ payload: AuthError$1;
546
+ } | {
547
+ status: 404;
548
+ payload: SimpleError$1;
549
+ } | {
550
+ status: 409;
551
+ payload: SimpleError$1;
552
+ }>;
553
+ type GrantAuthorizationCodeVariables = {
554
+ body: AuthorizationCodeRequest;
555
+ } & ControlPlaneFetcherExtraProps;
556
+ /**
557
+ * Creates, stores and returns an authorization code to be used by a third party app
558
+ */
559
+ declare const grantAuthorizationCode: (variables: GrantAuthorizationCodeVariables, signal?: AbortSignal) => Promise<AuthorizationCodeResponse>;
298
560
  type GetUserError = ErrorWrapper$1<{
299
561
  status: 400;
300
562
  payload: BadRequestError$1;
@@ -414,6 +676,115 @@ type DeleteUserAPIKeyVariables = {
414
676
  * Delete an existing API key
415
677
  */
416
678
  declare const deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal) => Promise<undefined>;
679
+ type GetUserOAuthClientsError = ErrorWrapper$1<{
680
+ status: 400;
681
+ payload: BadRequestError$1;
682
+ } | {
683
+ status: 401;
684
+ payload: AuthError$1;
685
+ } | {
686
+ status: 404;
687
+ payload: SimpleError$1;
688
+ }>;
689
+ type GetUserOAuthClientsResponse = {
690
+ clients?: OAuthClientPublicDetails[];
691
+ };
692
+ type GetUserOAuthClientsVariables = ControlPlaneFetcherExtraProps;
693
+ /**
694
+ * Retrieve the list of OAuth Clients that a user has authorized
695
+ */
696
+ declare const getUserOAuthClients: (variables: GetUserOAuthClientsVariables, signal?: AbortSignal) => Promise<GetUserOAuthClientsResponse>;
697
+ type DeleteUserOAuthClientPathParams = {
698
+ clientId: OAuthClientID;
699
+ };
700
+ type DeleteUserOAuthClientError = ErrorWrapper$1<{
701
+ status: 400;
702
+ payload: BadRequestError$1;
703
+ } | {
704
+ status: 401;
705
+ payload: AuthError$1;
706
+ } | {
707
+ status: 404;
708
+ payload: SimpleError$1;
709
+ }>;
710
+ type DeleteUserOAuthClientVariables = {
711
+ pathParams: DeleteUserOAuthClientPathParams;
712
+ } & ControlPlaneFetcherExtraProps;
713
+ /**
714
+ * Delete the oauth client for the user and revoke all access
715
+ */
716
+ declare const deleteUserOAuthClient: (variables: DeleteUserOAuthClientVariables, signal?: AbortSignal) => Promise<undefined>;
717
+ type GetUserOAuthAccessTokensError = ErrorWrapper$1<{
718
+ status: 400;
719
+ payload: BadRequestError$1;
720
+ } | {
721
+ status: 401;
722
+ payload: AuthError$1;
723
+ } | {
724
+ status: 404;
725
+ payload: SimpleError$1;
726
+ }>;
727
+ type GetUserOAuthAccessTokensResponse = {
728
+ accessTokens: OAuthAccessToken[];
729
+ };
730
+ type GetUserOAuthAccessTokensVariables = ControlPlaneFetcherExtraProps;
731
+ /**
732
+ * Retrieve the list of valid OAuth Access Tokens on the current user's account
733
+ */
734
+ declare const getUserOAuthAccessTokens: (variables: GetUserOAuthAccessTokensVariables, signal?: AbortSignal) => Promise<GetUserOAuthAccessTokensResponse>;
735
+ type DeleteOAuthAccessTokenPathParams = {
736
+ token: AccessToken;
737
+ };
738
+ type DeleteOAuthAccessTokenError = ErrorWrapper$1<{
739
+ status: 400;
740
+ payload: BadRequestError$1;
741
+ } | {
742
+ status: 401;
743
+ payload: AuthError$1;
744
+ } | {
745
+ status: 404;
746
+ payload: SimpleError$1;
747
+ } | {
748
+ status: 409;
749
+ payload: SimpleError$1;
750
+ }>;
751
+ type DeleteOAuthAccessTokenVariables = {
752
+ pathParams: DeleteOAuthAccessTokenPathParams;
753
+ } & ControlPlaneFetcherExtraProps;
754
+ /**
755
+ * Expires the access token for a third party app
756
+ */
757
+ declare const deleteOAuthAccessToken: (variables: DeleteOAuthAccessTokenVariables, signal?: AbortSignal) => Promise<undefined>;
758
+ type UpdateOAuthAccessTokenPathParams = {
759
+ token: AccessToken;
760
+ };
761
+ type UpdateOAuthAccessTokenError = ErrorWrapper$1<{
762
+ status: 400;
763
+ payload: BadRequestError$1;
764
+ } | {
765
+ status: 401;
766
+ payload: AuthError$1;
767
+ } | {
768
+ status: 404;
769
+ payload: SimpleError$1;
770
+ } | {
771
+ status: 409;
772
+ payload: SimpleError$1;
773
+ }>;
774
+ type UpdateOAuthAccessTokenRequestBody = {
775
+ /**
776
+ * expiration time of the token as a unix timestamp
777
+ */
778
+ expires: number;
779
+ };
780
+ type UpdateOAuthAccessTokenVariables = {
781
+ body: UpdateOAuthAccessTokenRequestBody;
782
+ pathParams: UpdateOAuthAccessTokenPathParams;
783
+ } & ControlPlaneFetcherExtraProps;
784
+ /**
785
+ * Updates partially the access token for a third party app
786
+ */
787
+ declare const updateOAuthAccessToken: (variables: UpdateOAuthAccessTokenVariables, signal?: AbortSignal) => Promise<OAuthAccessToken>;
417
788
  type GetWorkspacesListError = ErrorWrapper$1<{
418
789
  status: 400;
419
790
  payload: BadRequestError$1;
@@ -430,6 +801,7 @@ type GetWorkspacesListResponse = {
430
801
  name: string;
431
802
  slug: string;
432
803
  role: Role;
804
+ plan: WorkspacePlan;
433
805
  }[];
434
806
  };
435
807
  type GetWorkspacesListVariables = ControlPlaneFetcherExtraProps;
@@ -787,6 +1159,99 @@ type ResendWorkspaceMemberInviteVariables = {
787
1159
  * This operation provides a way to resend an Invite notification. Invite notifications can only be sent for Invites not yet accepted.
788
1160
  */
789
1161
  declare const resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
1162
+ type ListClustersPathParams = {
1163
+ /**
1164
+ * Workspace ID
1165
+ */
1166
+ workspaceId: WorkspaceID;
1167
+ };
1168
+ type ListClustersError = ErrorWrapper$1<{
1169
+ status: 400;
1170
+ payload: BadRequestError$1;
1171
+ } | {
1172
+ status: 401;
1173
+ payload: AuthError$1;
1174
+ }>;
1175
+ type ListClustersVariables = {
1176
+ pathParams: ListClustersPathParams;
1177
+ } & ControlPlaneFetcherExtraProps;
1178
+ /**
1179
+ * List all clusters available in your Workspace.
1180
+ */
1181
+ declare const listClusters: (variables: ListClustersVariables, signal?: AbortSignal) => Promise<ListClustersResponse>;
1182
+ type CreateClusterPathParams = {
1183
+ /**
1184
+ * Workspace ID
1185
+ */
1186
+ workspaceId: WorkspaceID;
1187
+ };
1188
+ type CreateClusterError = ErrorWrapper$1<{
1189
+ status: 400;
1190
+ payload: BadRequestError$1;
1191
+ } | {
1192
+ status: 401;
1193
+ payload: AuthError$1;
1194
+ } | {
1195
+ status: 422;
1196
+ payload: SimpleError$1;
1197
+ } | {
1198
+ status: 423;
1199
+ payload: SimpleError$1;
1200
+ }>;
1201
+ type CreateClusterVariables = {
1202
+ body: ClusterCreateDetails;
1203
+ pathParams: CreateClusterPathParams;
1204
+ } & ControlPlaneFetcherExtraProps;
1205
+ declare const createCluster: (variables: CreateClusterVariables, signal?: AbortSignal) => Promise<ClusterResponse>;
1206
+ type GetClusterPathParams = {
1207
+ /**
1208
+ * Workspace ID
1209
+ */
1210
+ workspaceId: WorkspaceID;
1211
+ /**
1212
+ * Cluster ID
1213
+ */
1214
+ clusterId: ClusterID;
1215
+ };
1216
+ type GetClusterError = ErrorWrapper$1<{
1217
+ status: 400;
1218
+ payload: BadRequestError$1;
1219
+ } | {
1220
+ status: 401;
1221
+ payload: AuthError$1;
1222
+ }>;
1223
+ type GetClusterVariables = {
1224
+ pathParams: GetClusterPathParams;
1225
+ } & ControlPlaneFetcherExtraProps;
1226
+ /**
1227
+ * Retrieve metadata for given cluster ID
1228
+ */
1229
+ declare const getCluster: (variables: GetClusterVariables, signal?: AbortSignal) => Promise<ClusterMetadata>;
1230
+ type UpdateClusterPathParams = {
1231
+ /**
1232
+ * Workspace ID
1233
+ */
1234
+ workspaceId: WorkspaceID;
1235
+ /**
1236
+ * Cluster ID
1237
+ */
1238
+ clusterId: ClusterID;
1239
+ };
1240
+ type UpdateClusterError = ErrorWrapper$1<{
1241
+ status: 400;
1242
+ payload: BadRequestError$1;
1243
+ } | {
1244
+ status: 401;
1245
+ payload: AuthError$1;
1246
+ }>;
1247
+ type UpdateClusterVariables = {
1248
+ body: ClusterUpdateDetails;
1249
+ pathParams: UpdateClusterPathParams;
1250
+ } & ControlPlaneFetcherExtraProps;
1251
+ /**
1252
+ * Update cluster for given cluster ID
1253
+ */
1254
+ declare const updateCluster: (variables: UpdateClusterVariables, signal?: AbortSignal) => Promise<ClusterMetadata>;
790
1255
  type GetDatabaseListPathParams = {
791
1256
  /**
792
1257
  * Workspace ID
@@ -847,6 +1312,13 @@ type CreateDatabaseRequestBody = {
847
1312
  * @minLength 1
848
1313
  */
849
1314
  region: string;
1315
+ /**
1316
+ * The dedicated cluster where branches from this database will be created. Defaults to 'xata-cloud'.
1317
+ *
1318
+ * @minLength 1
1319
+ * @x-internal true
1320
+ */
1321
+ defaultClusterID?: string;
850
1322
  ui?: {
851
1323
  color?: string;
852
1324
  };
@@ -953,6 +1425,43 @@ type UpdateDatabaseMetadataVariables = {
953
1425
  * Update the color of the selected database
954
1426
  */
955
1427
  declare const updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
1428
+ type RenameDatabasePathParams = {
1429
+ /**
1430
+ * Workspace ID
1431
+ */
1432
+ workspaceId: WorkspaceID;
1433
+ /**
1434
+ * The Database Name
1435
+ */
1436
+ dbName: DBName$1;
1437
+ };
1438
+ type RenameDatabaseError = ErrorWrapper$1<{
1439
+ status: 400;
1440
+ payload: BadRequestError$1;
1441
+ } | {
1442
+ status: 401;
1443
+ payload: AuthError$1;
1444
+ } | {
1445
+ status: 422;
1446
+ payload: SimpleError$1;
1447
+ } | {
1448
+ status: 423;
1449
+ payload: SimpleError$1;
1450
+ }>;
1451
+ type RenameDatabaseRequestBody = {
1452
+ /**
1453
+ * @minLength 1
1454
+ */
1455
+ newName: string;
1456
+ };
1457
+ type RenameDatabaseVariables = {
1458
+ body: RenameDatabaseRequestBody;
1459
+ pathParams: RenameDatabasePathParams;
1460
+ } & ControlPlaneFetcherExtraProps;
1461
+ /**
1462
+ * Change the name of an existing database
1463
+ */
1464
+ declare const renameDatabase: (variables: RenameDatabaseVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
956
1465
  type GetDatabaseGithubSettingsPathParams = {
957
1466
  /**
958
1467
  * Workspace ID
@@ -1064,6 +1573,31 @@ declare const listRegions: (variables: ListRegionsVariables, signal?: AbortSigna
1064
1573
  *
1065
1574
  * @version 1.0
1066
1575
  */
1576
+ /**
1577
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
1578
+ *
1579
+ * @maxLength 511
1580
+ * @minLength 1
1581
+ * @pattern [a-zA-Z0-9_\-~]+:[a-zA-Z0-9_\-~]+
1582
+ */
1583
+ type DBBranchName = string;
1584
+ type PgRollApplyMigrationResponse = {
1585
+ /**
1586
+ * The id of the applied migration
1587
+ */
1588
+ migrationID: string;
1589
+ };
1590
+ type PgRollMigrationStatus = 'no migrations' | 'in progress' | 'complete';
1591
+ type PgRollStatusResponse = {
1592
+ /**
1593
+ * The status of the most recent migration
1594
+ */
1595
+ status: PgRollMigrationStatus;
1596
+ /**
1597
+ * The name of the most recent version
1598
+ */
1599
+ version: string;
1600
+ };
1067
1601
  /**
1068
1602
  * @maxLength 255
1069
1603
  * @minLength 1
@@ -1083,14 +1617,6 @@ type ListBranchesResponse = {
1083
1617
  databaseName: string;
1084
1618
  branches: Branch[];
1085
1619
  };
1086
- /**
1087
- * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
1088
- *
1089
- * @maxLength 511
1090
- * @minLength 1
1091
- * @pattern [a-zA-Z0-9_\-~]+:[a-zA-Z0-9_\-~]+
1092
- */
1093
- type DBBranchName = string;
1094
1620
  /**
1095
1621
  * @maxLength 255
1096
1622
  * @minLength 1
@@ -1134,19 +1660,24 @@ type ColumnVector = {
1134
1660
  */
1135
1661
  dimension: number;
1136
1662
  };
1663
+ type ColumnFile = {
1664
+ defaultPublicAccess?: boolean;
1665
+ };
1137
1666
  type Column = {
1138
1667
  name: string;
1139
- type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object' | 'datetime' | 'vector' | 'file[]' | 'file' | 'image[]' | 'image';
1668
+ type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object' | 'datetime' | 'vector' | 'file[]' | 'file' | 'json';
1140
1669
  link?: ColumnLink;
1141
1670
  vector?: ColumnVector;
1671
+ file?: ColumnFile;
1672
+ ['file[]']?: ColumnFile;
1142
1673
  notNull?: boolean;
1143
1674
  defaultValue?: string;
1144
1675
  unique?: boolean;
1145
1676
  columns?: Column[];
1146
1677
  };
1147
1678
  type RevLink = {
1148
- linkID: string;
1149
1679
  table: string;
1680
+ column: string;
1150
1681
  };
1151
1682
  type Table = {
1152
1683
  id?: string;
@@ -1268,9 +1799,11 @@ type FilterPredicateOp = {
1268
1799
  $gt?: FilterRangeValue;
1269
1800
  $ge?: FilterRangeValue;
1270
1801
  $contains?: string;
1802
+ $iContains?: string;
1271
1803
  $startsWith?: string;
1272
1804
  $endsWith?: string;
1273
1805
  $pattern?: string;
1806
+ $iPattern?: string;
1274
1807
  };
1275
1808
  /**
1276
1809
  * @maxProperties 2
@@ -1293,7 +1826,7 @@ type FilterColumnIncludes = {
1293
1826
  $includesNone?: FilterPredicate;
1294
1827
  };
1295
1828
  type FilterColumn = FilterColumnIncludes | FilterPredicate | FilterList;
1296
- type SortOrder = 'asc' | 'desc';
1829
+ type SortOrder = 'asc' | 'desc' | 'random';
1297
1830
  type SortExpression = string[] | {
1298
1831
  [key: string]: SortOrder;
1299
1832
  } | {
@@ -1391,9 +1924,13 @@ type RecordsMetadata = {
1391
1924
  */
1392
1925
  cursor: string;
1393
1926
  /**
1394
- * true if more records can be fetch
1927
+ * true if more records can be fetched
1395
1928
  */
1396
1929
  more: boolean;
1930
+ /**
1931
+ * the number of records returned per page
1932
+ */
1933
+ size: number;
1397
1934
  };
1398
1935
  };
1399
1936
  type TableOpAdd = {
@@ -1442,7 +1979,7 @@ type Commit = {
1442
1979
  message?: string;
1443
1980
  id: string;
1444
1981
  parentID?: string;
1445
- checksum?: string;
1982
+ checksum: string;
1446
1983
  mergeParentID?: string;
1447
1984
  createdAt: DateTime;
1448
1985
  operations: MigrationOp[];
@@ -1474,7 +2011,7 @@ type MigrationObject = {
1474
2011
  message?: string;
1475
2012
  id: string;
1476
2013
  parentID?: string;
1477
- checksum?: string;
2014
+ checksum: string;
1478
2015
  operations: MigrationOp[];
1479
2016
  };
1480
2017
  /**
@@ -1550,9 +2087,27 @@ type TransactionUpdateOp = {
1550
2087
  columns?: string[];
1551
2088
  };
1552
2089
  /**
1553
- * A delete operation. The transaction will continue if no record matches the ID.
2090
+ * A delete operation. The transaction will continue if no record matches the ID by default. To override this behaviour, set failIfMissing to true.
1554
2091
  */
1555
2092
  type TransactionDeleteOp = {
2093
+ /**
2094
+ * The table name
2095
+ */
2096
+ table: string;
2097
+ id: RecordID;
2098
+ /**
2099
+ * If true, the transaction will fail when the record doesn't exist.
2100
+ */
2101
+ failIfMissing?: boolean;
2102
+ /**
2103
+ * If set, the call will return the requested fields as part of the response.
2104
+ */
2105
+ columns?: string[];
2106
+ };
2107
+ /**
2108
+ * Get by id operation.
2109
+ */
2110
+ type TransactionGetOp = {
1556
2111
  /**
1557
2112
  * The table name
1558
2113
  */
@@ -1572,6 +2127,8 @@ type TransactionOperation$1 = {
1572
2127
  update: TransactionUpdateOp;
1573
2128
  } | {
1574
2129
  ['delete']: TransactionDeleteOp;
2130
+ } | {
2131
+ get: TransactionGetOp;
1575
2132
  };
1576
2133
  /**
1577
2134
  * Fields to return in the transaction result.
@@ -1623,11 +2180,21 @@ type TransactionResultDelete = {
1623
2180
  rows: number;
1624
2181
  columns?: TransactionResultColumns;
1625
2182
  };
2183
+ /**
2184
+ * A result from a get operation.
2185
+ */
2186
+ type TransactionResultGet = {
2187
+ /**
2188
+ * The type of operation who's result is being returned.
2189
+ */
2190
+ operation: 'get';
2191
+ columns?: TransactionResultColumns;
2192
+ };
1626
2193
  /**
1627
2194
  * An ordered array of results from the submitted operations.
1628
2195
  */
1629
2196
  type TransactionSuccess = {
1630
- results: (TransactionResultInsert | TransactionResultUpdate | TransactionResultDelete)[];
2197
+ results: (TransactionResultInsert | TransactionResultUpdate | TransactionResultDelete | TransactionResultGet)[];
1631
2198
  };
1632
2199
  /**
1633
2200
  * An error message from a failing transaction operation
@@ -1643,7 +2210,7 @@ type TransactionError = {
1643
2210
  message: string;
1644
2211
  };
1645
2212
  /**
1646
- * An array of errors, with indicides, from the transaction.
2213
+ * An array of errors, with indices, from the transaction.
1647
2214
  */
1648
2215
  type TransactionFailure = {
1649
2216
  /**
@@ -1662,27 +2229,36 @@ type ObjectValue = {
1662
2229
  [key: string]: string | boolean | number | string[] | number[] | DateTime | ObjectValue;
1663
2230
  };
1664
2231
  /**
1665
- * Object representing a file
2232
+ * Unique file identifier
1666
2233
  *
1667
- * @x-go-type file.InputFile
2234
+ * @maxLength 255
2235
+ * @minLength 1
2236
+ * @pattern [a-zA-Z0-9_-~:]+
2237
+ */
2238
+ type FileItemID = string;
2239
+ /**
2240
+ * File name
2241
+ *
2242
+ * @maxLength 1024
2243
+ * @minLength 0
2244
+ * @pattern [0-9a-zA-Z!\-_\.\*'\(\)]*
2245
+ */
2246
+ type FileName = string;
2247
+ /**
2248
+ * Media type
2249
+ *
2250
+ * @maxLength 255
2251
+ * @minLength 3
2252
+ * @pattern ^\w+/[-+.\w]+$
2253
+ */
2254
+ type MediaType = string;
2255
+ /**
2256
+ * Object representing a file in an array
1668
2257
  */
1669
2258
  type InputFileEntry = {
1670
- /**
1671
- * File name
1672
- *
1673
- * @maxLength 1024
1674
- * @minLength 1
1675
- * @pattern [0-9a-zA-Z!\-_\.\*'\(\)]+
1676
- */
1677
- name: string;
1678
- /**
1679
- * Media type
1680
- *
1681
- * @maxLength 255
1682
- * @minLength 3
1683
- * @pattern ^\w+/[-+.\w]+$
1684
- */
1685
- mediaType?: string;
2259
+ id?: FileItemID;
2260
+ name?: FileName;
2261
+ mediaType?: MediaType;
1686
2262
  /**
1687
2263
  * Base64 encoded content
1688
2264
  *
@@ -1704,11 +2280,34 @@ type InputFileEntry = {
1704
2280
  * @maxItems 50
1705
2281
  */
1706
2282
  type InputFileArray = InputFileEntry[];
2283
+ /**
2284
+ * Object representing a file
2285
+ *
2286
+ * @x-go-type file.InputFile
2287
+ */
2288
+ type InputFile = {
2289
+ name: FileName;
2290
+ mediaType?: MediaType;
2291
+ /**
2292
+ * Base64 encoded content
2293
+ *
2294
+ * @maxLength 20971520
2295
+ */
2296
+ base64Content?: string;
2297
+ /**
2298
+ * Enable public access to the file
2299
+ */
2300
+ enablePublicUrl?: boolean;
2301
+ /**
2302
+ * Time to live for signed URLs
2303
+ */
2304
+ signedUrlTimeout?: number;
2305
+ };
1707
2306
  /**
1708
2307
  * Xata input record
1709
2308
  */
1710
2309
  type DataInputRecord = {
1711
- [key: string]: RecordID | string | boolean | number | string[] | number[] | DateTime | ObjectValue | InputFileArray | InputFileEntry | null;
2310
+ [key: string]: RecordID | string | boolean | number | string[] | number[] | DateTime | ObjectValue | InputFileArray | InputFile | null;
1712
2311
  };
1713
2312
  /**
1714
2313
  * Xata Table Record Metadata
@@ -1720,6 +2319,14 @@ type RecordMeta = {
1720
2319
  * The record's version. Can be used for optimistic concurrency control.
1721
2320
  */
1722
2321
  version: number;
2322
+ /**
2323
+ * The time when the record was created.
2324
+ */
2325
+ createdAt?: string;
2326
+ /**
2327
+ * The time when the record was last updated.
2328
+ */
2329
+ updatedAt?: string;
1723
2330
  /**
1724
2331
  * The record's table name. APIs that return records from multiple tables will set this field accordingly.
1725
2332
  */
@@ -1742,6 +2349,47 @@ type RecordMeta = {
1742
2349
  warnings?: string[];
1743
2350
  };
1744
2351
  };
2352
+ /**
2353
+ * File metadata
2354
+ */
2355
+ type FileResponse = {
2356
+ id?: FileItemID;
2357
+ name: FileName;
2358
+ mediaType: MediaType;
2359
+ /**
2360
+ * @format int64
2361
+ */
2362
+ size: number;
2363
+ /**
2364
+ * @format int64
2365
+ */
2366
+ version: number;
2367
+ attributes?: Record<string, any>;
2368
+ };
2369
+ type QueryColumnsProjection = (string | ProjectionConfig)[];
2370
+ /**
2371
+ * A structured projection that allows for some configuration.
2372
+ */
2373
+ type ProjectionConfig = {
2374
+ /**
2375
+ * The name of the column to project or a reverse link specification, see [API Guide](https://xata.io/docs/concepts/data-model#links-and-relations).
2376
+ */
2377
+ name?: string;
2378
+ columns?: QueryColumnsProjection;
2379
+ /**
2380
+ * An alias for the projected field, this is how it will be returned in the response.
2381
+ */
2382
+ as?: string;
2383
+ sort?: SortExpression;
2384
+ /**
2385
+ * @default 20
2386
+ */
2387
+ limit?: number;
2388
+ /**
2389
+ * @default 0
2390
+ */
2391
+ offset?: number;
2392
+ };
1745
2393
  /**
1746
2394
  * The target expression is used to filter the search results by the target columns.
1747
2395
  */
@@ -1772,7 +2420,7 @@ type ValueBooster$1 = {
1772
2420
  */
1773
2421
  value: string | number | boolean;
1774
2422
  /**
1775
- * The factor with which to multiply the score of the record.
2423
+ * The factor with which to multiply the added boost.
1776
2424
  */
1777
2425
  factor: number;
1778
2426
  /**
@@ -1814,7 +2462,8 @@ type NumericBooster$1 = {
1814
2462
  /**
1815
2463
  * Boost records based on the value of a datetime column. It is configured via "origin", "scale", and "decay". The further away from the "origin",
1816
2464
  * the more the score is decayed. The decay function uses an exponential function. For example if origin is "now", and scale is 10 days and decay is 0.5, it
1817
- * should be interpreted as: a record with a date 10 days before/after origin will score 2 times less than a record with the date at origin.
2465
+ * should be interpreted as: a record with a date 10 days before/after origin will be boosted 2 times less than a record with the date at origin.
2466
+ * The result of the exponential function is a boost between 0 and 1. The "factor" allows you to control how impactful this boost is, by multiplying it with a given value.
1818
2467
  */
1819
2468
  type DateBooster$1 = {
1820
2469
  /**
@@ -1827,7 +2476,7 @@ type DateBooster$1 = {
1827
2476
  */
1828
2477
  origin?: string;
1829
2478
  /**
1830
- * The duration at which distance from origin the score is decayed with factor, using an exponential function. It is fromatted as number + units, for example: `5d`, `20m`, `10s`.
2479
+ * The duration at which distance from origin the score is decayed with factor, using an exponential function. It is formatted as number + units, for example: `5d`, `20m`, `10s`.
1831
2480
  *
1832
2481
  * @pattern ^(\d+)(d|h|m|s|ms)$
1833
2482
  */
@@ -1836,6 +2485,12 @@ type DateBooster$1 = {
1836
2485
  * The decay factor to expect at "scale" distance from the "origin".
1837
2486
  */
1838
2487
  decay: number;
2488
+ /**
2489
+ * The factor with which to multiply the added boost.
2490
+ *
2491
+ * @minimum 0
2492
+ */
2493
+ factor?: number;
1839
2494
  /**
1840
2495
  * Only apply this booster to the records for which the provided filter matches.
1841
2496
  */
@@ -1856,7 +2511,7 @@ type BoosterExpression = {
1856
2511
  /**
1857
2512
  * Maximum [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) for the search terms. The Levenshtein
1858
2513
  * distance is the number of one character changes needed to make two strings equal. The default is 1, meaning that single
1859
- * character typos per word are tollerated by search. You can set it to 0 to remove the typo tollerance or set it to 2
2514
+ * character typos per word are tolerated by search. You can set it to 0 to remove the typo tolerance or set it to 2
1860
2515
  * to allow two typos in a word.
1861
2516
  *
1862
2517
  * @default 1
@@ -1993,6 +2648,16 @@ type AverageAgg = {
1993
2648
  */
1994
2649
  column: string;
1995
2650
  };
2651
+ /**
2652
+ * Calculate given percentiles of the numeric values in a particular column.
2653
+ */
2654
+ type PercentilesAgg = {
2655
+ /**
2656
+ * The column on which to compute the average. Must be a numeric type.
2657
+ */
2658
+ column: string;
2659
+ percentiles: number[];
2660
+ };
1996
2661
  /**
1997
2662
  * Count the number of distinct values in a particular column.
1998
2663
  */
@@ -2003,7 +2668,7 @@ type UniqueCountAgg = {
2003
2668
  column: string;
2004
2669
  /**
2005
2670
  * The threshold under which the unique count is exact. If the number of unique
2006
- * values in the column is higher than this threshold, the results are approximative.
2671
+ * values in the column is higher than this threshold, the results are approximate.
2007
2672
  * Maximum value is 40,000, default value is 3000.
2008
2673
  */
2009
2674
  precisionThreshold?: number;
@@ -2026,7 +2691,7 @@ type DateHistogramAgg = {
2026
2691
  column: string;
2027
2692
  /**
2028
2693
  * The fixed interval to use when bucketing.
2029
- * It is fromatted as number + units, for example: `5d`, `20m`, `10s`.
2694
+ * It is formatted as number + units, for example: `5d`, `20m`, `10s`.
2030
2695
  *
2031
2696
  * @pattern ^(\d+)(d|h|m|s|ms)$
2032
2697
  */
@@ -2081,7 +2746,7 @@ type NumericHistogramAgg = {
2081
2746
  interval: number;
2082
2747
  /**
2083
2748
  * By default the bucket keys start with 0 and then continue in `interval` steps. The bucket
2084
- * boundaries can be shiftend by using the offset option. For example, if the `interval` is 100,
2749
+ * boundaries can be shifted by using the offset option. For example, if the `interval` is 100,
2085
2750
  * but you prefer the bucket boundaries to be `[50, 150), [150, 250), etc.`, you can set `offset`
2086
2751
  * to 50.
2087
2752
  *
@@ -2107,6 +2772,8 @@ type AggExpression = {
2107
2772
  min?: MinAgg;
2108
2773
  } | {
2109
2774
  average?: AverageAgg;
2775
+ } | {
2776
+ percentiles?: PercentilesAgg;
2110
2777
  } | {
2111
2778
  uniqueCount?: UniqueCountAgg;
2112
2779
  } | {
@@ -2122,7 +2789,27 @@ type AggResponse$1 = (number | null) | {
2122
2789
  $count: number;
2123
2790
  } & {
2124
2791
  [key: string]: AggResponse$1;
2125
- })[];
2792
+ })[] | {
2793
+ [key: string]: number;
2794
+ };
2795
+ };
2796
+ /**
2797
+ * File identifier in access URLs
2798
+ *
2799
+ * @maxLength 296
2800
+ * @minLength 88
2801
+ * @pattern [a-v0-9=]+
2802
+ */
2803
+ type FileAccessID = string;
2804
+ /**
2805
+ * File signature
2806
+ */
2807
+ type FileSignature = string;
2808
+ /**
2809
+ * Xata Table SQL Record
2810
+ */
2811
+ type SQLRecord = {
2812
+ [key: string]: any;
2126
2813
  };
2127
2814
  /**
2128
2815
  * Xata Table Record Metadata
@@ -2169,12 +2856,19 @@ type SchemaCompareResponse = {
2169
2856
  target: Schema;
2170
2857
  edits: SchemaEditScript;
2171
2858
  };
2859
+ type RateLimitError = {
2860
+ id?: string;
2861
+ message: string;
2862
+ };
2172
2863
  type RecordUpdateResponse = XataRecord$1 | {
2173
2864
  id: string;
2174
2865
  xata: {
2175
2866
  version: number;
2867
+ createdAt: string;
2868
+ updatedAt: string;
2176
2869
  };
2177
2870
  };
2871
+ type PutFileResponse = FileResponse;
2178
2872
  type RecordResponse = XataRecord$1;
2179
2873
  type BulkInsertResponse = {
2180
2874
  recordIDs: string[];
@@ -2191,13 +2885,17 @@ type QueryResponse = {
2191
2885
  records: XataRecord$1[];
2192
2886
  meta: RecordsMetadata;
2193
2887
  };
2888
+ type ServiceUnavailableError = {
2889
+ id?: string;
2890
+ message: string;
2891
+ };
2194
2892
  type SearchResponse = {
2195
2893
  records: XataRecord$1[];
2196
2894
  warning?: string;
2197
- };
2198
- type RateLimitError = {
2199
- id?: string;
2200
- message: string;
2895
+ /**
2896
+ * The total count of records matched. It will be accurately returned up to 10000 records.
2897
+ */
2898
+ totalCount: number;
2201
2899
  };
2202
2900
  type SummarizeResponse = {
2203
2901
  summaries: Record<string, any>[];
@@ -2210,6 +2908,18 @@ type AggResponse = {
2210
2908
  [key: string]: AggResponse$1;
2211
2909
  };
2212
2910
  };
2911
+ type SQLResponse = {
2912
+ records?: SQLRecord[];
2913
+ /**
2914
+ * Name of the column and its PostgreSQL type
2915
+ */
2916
+ columns?: Record<string, any>;
2917
+ /**
2918
+ * Number of selected columns
2919
+ */
2920
+ total?: number;
2921
+ warning?: string;
2922
+ };
2213
2923
 
2214
2924
  type DataPlaneFetcherExtraProps = {
2215
2925
  apiUrl: string;
@@ -2222,6 +2932,8 @@ type DataPlaneFetcherExtraProps = {
2222
2932
  sessionID?: string;
2223
2933
  clientName?: string;
2224
2934
  xataAgentExtra?: Record<string, string>;
2935
+ rawResponse?: boolean;
2936
+ headers?: Record<string, unknown>;
2225
2937
  };
2226
2938
  type ErrorWrapper<TError> = TError | {
2227
2939
  status: 'unknown';
@@ -2229,11 +2941,62 @@ type ErrorWrapper<TError> = TError | {
2229
2941
  };
2230
2942
 
2231
2943
  /**
2232
- * Generated by @openapi-codegen
2233
- *
2234
- * @version 1.0
2944
+ * Generated by @openapi-codegen
2945
+ *
2946
+ * @version 1.0
2947
+ */
2948
+
2949
+ type ApplyMigrationPathParams = {
2950
+ /**
2951
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2952
+ */
2953
+ dbBranchName: DBBranchName;
2954
+ workspace: string;
2955
+ region: string;
2956
+ };
2957
+ type ApplyMigrationError = ErrorWrapper<{
2958
+ status: 400;
2959
+ payload: BadRequestError;
2960
+ } | {
2961
+ status: 401;
2962
+ payload: AuthError;
2963
+ } | {
2964
+ status: 404;
2965
+ payload: SimpleError;
2966
+ }>;
2967
+ type ApplyMigrationRequestBody = {
2968
+ [key: string]: any;
2969
+ }[];
2970
+ type ApplyMigrationVariables = {
2971
+ body?: ApplyMigrationRequestBody;
2972
+ pathParams: ApplyMigrationPathParams;
2973
+ } & DataPlaneFetcherExtraProps;
2974
+ /**
2975
+ * Applies a pgroll migration to the specified database.
2235
2976
  */
2236
-
2977
+ declare const applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal) => Promise<PgRollApplyMigrationResponse>;
2978
+ type PgRollStatusPathParams = {
2979
+ /**
2980
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2981
+ */
2982
+ dbBranchName: DBBranchName;
2983
+ workspace: string;
2984
+ region: string;
2985
+ };
2986
+ type PgRollStatusError = ErrorWrapper<{
2987
+ status: 400;
2988
+ payload: BadRequestError;
2989
+ } | {
2990
+ status: 401;
2991
+ payload: AuthError;
2992
+ } | {
2993
+ status: 404;
2994
+ payload: SimpleError;
2995
+ }>;
2996
+ type PgRollStatusVariables = {
2997
+ pathParams: PgRollStatusPathParams;
2998
+ } & DataPlaneFetcherExtraProps;
2999
+ declare const pgRollStatus: (variables: PgRollStatusVariables, signal?: AbortSignal) => Promise<PgRollStatusResponse>;
2237
3000
  type GetBranchListPathParams = {
2238
3001
  /**
2239
3002
  * The Database Name
@@ -2321,6 +3084,13 @@ type CreateBranchRequestBody = {
2321
3084
  * Select the branch to fork from. Defaults to 'main'
2322
3085
  */
2323
3086
  from?: string;
3087
+ /**
3088
+ * Select the dedicated cluster to create on. Defaults to 'xata-cloud'
3089
+ *
3090
+ * @minLength 1
3091
+ * @x-internal true
3092
+ */
3093
+ clusterID?: string;
2324
3094
  metadata?: BranchMetadata;
2325
3095
  };
2326
3096
  type CreateBranchVariables = {
@@ -2360,6 +3130,31 @@ type DeleteBranchVariables = {
2360
3130
  * Delete the branch in the database and all its resources
2361
3131
  */
2362
3132
  declare const deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal) => Promise<DeleteBranchResponse>;
3133
+ type GetSchemaPathParams = {
3134
+ /**
3135
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3136
+ */
3137
+ dbBranchName: DBBranchName;
3138
+ workspace: string;
3139
+ region: string;
3140
+ };
3141
+ type GetSchemaError = ErrorWrapper<{
3142
+ status: 400;
3143
+ payload: BadRequestError;
3144
+ } | {
3145
+ status: 401;
3146
+ payload: AuthError;
3147
+ } | {
3148
+ status: 404;
3149
+ payload: SimpleError;
3150
+ }>;
3151
+ type GetSchemaResponse = {
3152
+ schema: Record<string, any>;
3153
+ };
3154
+ type GetSchemaVariables = {
3155
+ pathParams: GetSchemaPathParams;
3156
+ } & DataPlaneFetcherExtraProps;
3157
+ declare const getSchema: (variables: GetSchemaVariables, signal?: AbortSignal) => Promise<GetSchemaResponse>;
2363
3158
  type CopyBranchPathParams = {
2364
3159
  /**
2365
3160
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -3256,6 +4051,18 @@ type PushBranchMigrationsVariables = {
3256
4051
  body: PushBranchMigrationsRequestBody;
3257
4052
  pathParams: PushBranchMigrationsPathParams;
3258
4053
  } & DataPlaneFetcherExtraProps;
4054
+ /**
4055
+ * The `schema/push` API accepts a list of migrations to be applied to the
4056
+ * current branch. A list of applicable migrations can be fetched using
4057
+ * the `schema/history` API from another branch or database.
4058
+ *
4059
+ * The most recent migration must be part of the list or referenced (via
4060
+ * `parentID`) by the first migration in the list of migrations to be pushed.
4061
+ *
4062
+ * Each migration in the list has an `id`, `parentID`, and `checksum`. The
4063
+ * checksum for migrations are generated and verified by xata. The
4064
+ * operation fails if any migration in the list has an invalid checksum.
4065
+ */
3259
4066
  declare const pushBranchMigrations: (variables: PushBranchMigrationsVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
3260
4067
  type CreateTablePathParams = {
3261
4068
  /**
@@ -3497,9 +4304,7 @@ type AddTableColumnVariables = {
3497
4304
  pathParams: AddTableColumnPathParams;
3498
4305
  } & DataPlaneFetcherExtraProps;
3499
4306
  /**
3500
- * Adds a new column to the table. The body of the request should contain the column definition. In the column definition, the 'name' field should
3501
- * contain the full path separated by dots. If the parent objects do not exists, they will be automatically created. For example,
3502
- * passing `"name": "address.city"` will auto-create the `address` object if it doesn't exist.
4307
+ * Adds a new column to the table. The body of the request should contain the column definition.
3503
4308
  */
3504
4309
  declare const addTableColumn: (variables: AddTableColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
3505
4310
  type GetColumnPathParams = {
@@ -3532,7 +4337,7 @@ type GetColumnVariables = {
3532
4337
  pathParams: GetColumnPathParams;
3533
4338
  } & DataPlaneFetcherExtraProps;
3534
4339
  /**
3535
- * Get the definition of a single column. To refer to sub-objects, the column name can contain dots. For example `address.country`.
4340
+ * Get the definition of a single column.
3536
4341
  */
3537
4342
  declare const getColumn: (variables: GetColumnVariables, signal?: AbortSignal) => Promise<Column>;
3538
4343
  type UpdateColumnPathParams = {
@@ -3551,7 +4356,240 @@ type UpdateColumnPathParams = {
3551
4356
  workspace: string;
3552
4357
  region: string;
3553
4358
  };
3554
- type UpdateColumnError = ErrorWrapper<{
4359
+ type UpdateColumnError = ErrorWrapper<{
4360
+ status: 400;
4361
+ payload: BadRequestError;
4362
+ } | {
4363
+ status: 401;
4364
+ payload: AuthError;
4365
+ } | {
4366
+ status: 404;
4367
+ payload: SimpleError;
4368
+ }>;
4369
+ type UpdateColumnRequestBody = {
4370
+ /**
4371
+ * @minLength 1
4372
+ */
4373
+ name: string;
4374
+ };
4375
+ type UpdateColumnVariables = {
4376
+ body: UpdateColumnRequestBody;
4377
+ pathParams: UpdateColumnPathParams;
4378
+ } & DataPlaneFetcherExtraProps;
4379
+ /**
4380
+ * Update column with partial data. Can be used for renaming the column by providing a new "name" field.
4381
+ */
4382
+ declare const updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
4383
+ type DeleteColumnPathParams = {
4384
+ /**
4385
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4386
+ */
4387
+ dbBranchName: DBBranchName;
4388
+ /**
4389
+ * The Table name
4390
+ */
4391
+ tableName: TableName;
4392
+ /**
4393
+ * The Column name
4394
+ */
4395
+ columnName: ColumnName;
4396
+ workspace: string;
4397
+ region: string;
4398
+ };
4399
+ type DeleteColumnError = ErrorWrapper<{
4400
+ status: 400;
4401
+ payload: BadRequestError;
4402
+ } | {
4403
+ status: 401;
4404
+ payload: AuthError;
4405
+ } | {
4406
+ status: 404;
4407
+ payload: SimpleError;
4408
+ }>;
4409
+ type DeleteColumnVariables = {
4410
+ pathParams: DeleteColumnPathParams;
4411
+ } & DataPlaneFetcherExtraProps;
4412
+ /**
4413
+ * Deletes the specified column.
4414
+ */
4415
+ declare const deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
4416
+ type BranchTransactionPathParams = {
4417
+ /**
4418
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4419
+ */
4420
+ dbBranchName: DBBranchName;
4421
+ workspace: string;
4422
+ region: string;
4423
+ };
4424
+ type BranchTransactionError = ErrorWrapper<{
4425
+ status: 400;
4426
+ payload: TransactionFailure;
4427
+ } | {
4428
+ status: 401;
4429
+ payload: AuthError;
4430
+ } | {
4431
+ status: 404;
4432
+ payload: SimpleError;
4433
+ } | {
4434
+ status: 429;
4435
+ payload: RateLimitError;
4436
+ }>;
4437
+ type BranchTransactionRequestBody = {
4438
+ operations: TransactionOperation$1[];
4439
+ };
4440
+ type BranchTransactionVariables = {
4441
+ body: BranchTransactionRequestBody;
4442
+ pathParams: BranchTransactionPathParams;
4443
+ } & DataPlaneFetcherExtraProps;
4444
+ declare const branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal) => Promise<TransactionSuccess>;
4445
+ type InsertRecordPathParams = {
4446
+ /**
4447
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4448
+ */
4449
+ dbBranchName: DBBranchName;
4450
+ /**
4451
+ * The Table name
4452
+ */
4453
+ tableName: TableName;
4454
+ workspace: string;
4455
+ region: string;
4456
+ };
4457
+ type InsertRecordQueryParams = {
4458
+ /**
4459
+ * Column filters
4460
+ */
4461
+ columns?: ColumnsProjection;
4462
+ };
4463
+ type InsertRecordError = ErrorWrapper<{
4464
+ status: 400;
4465
+ payload: BadRequestError;
4466
+ } | {
4467
+ status: 401;
4468
+ payload: AuthError;
4469
+ } | {
4470
+ status: 404;
4471
+ payload: SimpleError;
4472
+ }>;
4473
+ type InsertRecordVariables = {
4474
+ body?: DataInputRecord;
4475
+ pathParams: InsertRecordPathParams;
4476
+ queryParams?: InsertRecordQueryParams;
4477
+ } & DataPlaneFetcherExtraProps;
4478
+ /**
4479
+ * Insert a new Record into the Table
4480
+ */
4481
+ declare const insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
4482
+ type GetFileItemPathParams = {
4483
+ /**
4484
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4485
+ */
4486
+ dbBranchName: DBBranchName;
4487
+ /**
4488
+ * The Table name
4489
+ */
4490
+ tableName: TableName;
4491
+ /**
4492
+ * The Record name
4493
+ */
4494
+ recordId: RecordID;
4495
+ /**
4496
+ * The Column name
4497
+ */
4498
+ columnName: ColumnName;
4499
+ /**
4500
+ * The File Identifier
4501
+ */
4502
+ fileId: FileItemID;
4503
+ workspace: string;
4504
+ region: string;
4505
+ };
4506
+ type GetFileItemError = ErrorWrapper<{
4507
+ status: 400;
4508
+ payload: BadRequestError;
4509
+ } | {
4510
+ status: 401;
4511
+ payload: AuthError;
4512
+ } | {
4513
+ status: 404;
4514
+ payload: SimpleError;
4515
+ }>;
4516
+ type GetFileItemVariables = {
4517
+ pathParams: GetFileItemPathParams;
4518
+ } & DataPlaneFetcherExtraProps;
4519
+ /**
4520
+ * Retrieves file content from an array by file ID
4521
+ */
4522
+ declare const getFileItem: (variables: GetFileItemVariables, signal?: AbortSignal) => Promise<Blob>;
4523
+ type PutFileItemPathParams = {
4524
+ /**
4525
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4526
+ */
4527
+ dbBranchName: DBBranchName;
4528
+ /**
4529
+ * The Table name
4530
+ */
4531
+ tableName: TableName;
4532
+ /**
4533
+ * The Record name
4534
+ */
4535
+ recordId: RecordID;
4536
+ /**
4537
+ * The Column name
4538
+ */
4539
+ columnName: ColumnName;
4540
+ /**
4541
+ * The File Identifier
4542
+ */
4543
+ fileId: FileItemID;
4544
+ workspace: string;
4545
+ region: string;
4546
+ };
4547
+ type PutFileItemError = ErrorWrapper<{
4548
+ status: 400;
4549
+ payload: BadRequestError;
4550
+ } | {
4551
+ status: 401;
4552
+ payload: AuthError;
4553
+ } | {
4554
+ status: 404;
4555
+ payload: SimpleError;
4556
+ } | {
4557
+ status: 422;
4558
+ payload: SimpleError;
4559
+ }>;
4560
+ type PutFileItemVariables = {
4561
+ body?: Blob;
4562
+ pathParams: PutFileItemPathParams;
4563
+ } & DataPlaneFetcherExtraProps;
4564
+ /**
4565
+ * Uploads the file content to an array given the file ID
4566
+ */
4567
+ declare const putFileItem: (variables: PutFileItemVariables, signal?: AbortSignal) => Promise<FileResponse>;
4568
+ type DeleteFileItemPathParams = {
4569
+ /**
4570
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4571
+ */
4572
+ dbBranchName: DBBranchName;
4573
+ /**
4574
+ * The Table name
4575
+ */
4576
+ tableName: TableName;
4577
+ /**
4578
+ * The Record name
4579
+ */
4580
+ recordId: RecordID;
4581
+ /**
4582
+ * The Column name
4583
+ */
4584
+ columnName: ColumnName;
4585
+ /**
4586
+ * The File Identifier
4587
+ */
4588
+ fileId: FileItemID;
4589
+ workspace: string;
4590
+ region: string;
4591
+ };
4592
+ type DeleteFileItemError = ErrorWrapper<{
3555
4593
  status: 400;
3556
4594
  payload: BadRequestError;
3557
4595
  } | {
@@ -3561,21 +4599,14 @@ type UpdateColumnError = ErrorWrapper<{
3561
4599
  status: 404;
3562
4600
  payload: SimpleError;
3563
4601
  }>;
3564
- type UpdateColumnRequestBody = {
3565
- /**
3566
- * @minLength 1
3567
- */
3568
- name: string;
3569
- };
3570
- type UpdateColumnVariables = {
3571
- body: UpdateColumnRequestBody;
3572
- pathParams: UpdateColumnPathParams;
4602
+ type DeleteFileItemVariables = {
4603
+ pathParams: DeleteFileItemPathParams;
3573
4604
  } & DataPlaneFetcherExtraProps;
3574
4605
  /**
3575
- * Update column with partial data. Can be used for renaming the column by providing a new "name" field. To refer to sub-objects, the column name can contain dots. For example `address.country`.
4606
+ * Deletes an item from an file array column given the file ID
3576
4607
  */
3577
- declare const updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
3578
- type DeleteColumnPathParams = {
4608
+ declare const deleteFileItem: (variables: DeleteFileItemVariables, signal?: AbortSignal) => Promise<FileResponse>;
4609
+ type GetFilePathParams = {
3579
4610
  /**
3580
4611
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3581
4612
  */
@@ -3584,6 +4615,10 @@ type DeleteColumnPathParams = {
3584
4615
  * The Table name
3585
4616
  */
3586
4617
  tableName: TableName;
4618
+ /**
4619
+ * The Record name
4620
+ */
4621
+ recordId: RecordID;
3587
4622
  /**
3588
4623
  * The Column name
3589
4624
  */
@@ -3591,7 +4626,7 @@ type DeleteColumnPathParams = {
3591
4626
  workspace: string;
3592
4627
  region: string;
3593
4628
  };
3594
- type DeleteColumnError = ErrorWrapper<{
4629
+ type GetFileError = ErrorWrapper<{
3595
4630
  status: 400;
3596
4631
  payload: BadRequestError;
3597
4632
  } | {
@@ -3601,40 +4636,55 @@ type DeleteColumnError = ErrorWrapper<{
3601
4636
  status: 404;
3602
4637
  payload: SimpleError;
3603
4638
  }>;
3604
- type DeleteColumnVariables = {
3605
- pathParams: DeleteColumnPathParams;
4639
+ type GetFileVariables = {
4640
+ pathParams: GetFilePathParams;
3606
4641
  } & DataPlaneFetcherExtraProps;
3607
4642
  /**
3608
- * Deletes the specified column. To refer to sub-objects, the column name can contain dots. For example `address.country`.
4643
+ * Retrieves the file content from a file column
3609
4644
  */
3610
- declare const deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
3611
- type BranchTransactionPathParams = {
4645
+ declare const getFile: (variables: GetFileVariables, signal?: AbortSignal) => Promise<Blob>;
4646
+ type PutFilePathParams = {
3612
4647
  /**
3613
4648
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3614
4649
  */
3615
4650
  dbBranchName: DBBranchName;
4651
+ /**
4652
+ * The Table name
4653
+ */
4654
+ tableName: TableName;
4655
+ /**
4656
+ * The Record name
4657
+ */
4658
+ recordId: RecordID;
4659
+ /**
4660
+ * The Column name
4661
+ */
4662
+ columnName: ColumnName;
3616
4663
  workspace: string;
3617
4664
  region: string;
3618
4665
  };
3619
- type BranchTransactionError = ErrorWrapper<{
4666
+ type PutFileError = ErrorWrapper<{
3620
4667
  status: 400;
3621
- payload: TransactionFailure;
4668
+ payload: BadRequestError;
3622
4669
  } | {
3623
4670
  status: 401;
3624
4671
  payload: AuthError;
3625
4672
  } | {
3626
4673
  status: 404;
3627
4674
  payload: SimpleError;
4675
+ } | {
4676
+ status: 422;
4677
+ payload: SimpleError;
3628
4678
  }>;
3629
- type BranchTransactionRequestBody = {
3630
- operations: TransactionOperation$1[];
3631
- };
3632
- type BranchTransactionVariables = {
3633
- body: BranchTransactionRequestBody;
3634
- pathParams: BranchTransactionPathParams;
4679
+ type PutFileVariables = {
4680
+ body?: Blob;
4681
+ pathParams: PutFilePathParams;
3635
4682
  } & DataPlaneFetcherExtraProps;
3636
- declare const branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal) => Promise<TransactionSuccess>;
3637
- type InsertRecordPathParams = {
4683
+ /**
4684
+ * Uploads the file content to the given file column
4685
+ */
4686
+ declare const putFile: (variables: PutFileVariables, signal?: AbortSignal) => Promise<FileResponse>;
4687
+ type DeleteFilePathParams = {
3638
4688
  /**
3639
4689
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3640
4690
  */
@@ -3643,16 +4693,18 @@ type InsertRecordPathParams = {
3643
4693
  * The Table name
3644
4694
  */
3645
4695
  tableName: TableName;
3646
- workspace: string;
3647
- region: string;
3648
- };
3649
- type InsertRecordQueryParams = {
3650
4696
  /**
3651
- * Column filters
4697
+ * The Record name
3652
4698
  */
3653
- columns?: ColumnsProjection;
4699
+ recordId: RecordID;
4700
+ /**
4701
+ * The Column name
4702
+ */
4703
+ columnName: ColumnName;
4704
+ workspace: string;
4705
+ region: string;
3654
4706
  };
3655
- type InsertRecordError = ErrorWrapper<{
4707
+ type DeleteFileError = ErrorWrapper<{
3656
4708
  status: 400;
3657
4709
  payload: BadRequestError;
3658
4710
  } | {
@@ -3662,15 +4714,13 @@ type InsertRecordError = ErrorWrapper<{
3662
4714
  status: 404;
3663
4715
  payload: SimpleError;
3664
4716
  }>;
3665
- type InsertRecordVariables = {
3666
- body?: DataInputRecord;
3667
- pathParams: InsertRecordPathParams;
3668
- queryParams?: InsertRecordQueryParams;
4717
+ type DeleteFileVariables = {
4718
+ pathParams: DeleteFilePathParams;
3669
4719
  } & DataPlaneFetcherExtraProps;
3670
4720
  /**
3671
- * Insert a new Record into the Table
4721
+ * Deletes a file referred in a file column
3672
4722
  */
3673
- declare const insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
4723
+ declare const deleteFile: (variables: DeleteFileVariables, signal?: AbortSignal) => Promise<FileResponse>;
3674
4724
  type GetRecordPathParams = {
3675
4725
  /**
3676
4726
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -3942,12 +4992,15 @@ type QueryTableError = ErrorWrapper<{
3942
4992
  } | {
3943
4993
  status: 404;
3944
4994
  payload: SimpleError;
4995
+ } | {
4996
+ status: 503;
4997
+ payload: ServiceUnavailableError;
3945
4998
  }>;
3946
4999
  type QueryTableRequestBody = {
3947
5000
  filter?: FilterExpression;
3948
5001
  sort?: SortExpression;
3949
5002
  page?: PageConfig;
3950
- columns?: ColumnsProjection;
5003
+ columns?: QueryColumnsProjection;
3951
5004
  /**
3952
5005
  * The consistency level for this request.
3953
5006
  *
@@ -4611,25 +5664,40 @@ type QueryTableVariables = {
4611
5664
  * }
4612
5665
  * ```
4613
5666
  *
4614
- * ### Pagination
5667
+ * It is also possible to sort results randomly:
4615
5668
  *
4616
- * We offer cursor pagination and offset pagination. For queries that are expected to return more than 1000 records,
4617
- * cursor pagination is needed in order to retrieve all of their results. The offset pagination method is limited to 1000 records.
5669
+ * ```json
5670
+ * POST /db/demo:main/tables/table/query
5671
+ * {
5672
+ * "sort": {
5673
+ * "*": "random"
5674
+ * }
5675
+ * }
5676
+ * ```
5677
+ *
5678
+ * Note that a random sort does not apply to a specific column, hence the special column name `"*"`.
4618
5679
  *
4619
- * Example of size + offset pagination:
5680
+ * A random sort can be combined with an ascending or descending sort on a specific column:
4620
5681
  *
4621
5682
  * ```json
4622
5683
  * POST /db/demo:main/tables/table/query
4623
5684
  * {
4624
- * "page": {
4625
- * "size": 100,
4626
- * "offset": 200
4627
- * }
5685
+ * "sort": [
5686
+ * {
5687
+ * "name": "desc"
5688
+ * },
5689
+ * {
5690
+ * "*": "random"
5691
+ * }
5692
+ * ]
4628
5693
  * }
4629
5694
  * ```
4630
5695
  *
4631
- * The `page.size` parameter represents the maximum number of records returned by this query. It has a default value of 20 and a maximum value of 200.
4632
- * The `page.offset` parameter represents the number of matching records to skip. It has a default value of 0 and a maximum value of 800.
5696
+ * This will sort on the `name` column, breaking ties randomly.
5697
+ *
5698
+ * ### Pagination
5699
+ *
5700
+ * We offer cursor pagination and offset pagination. The cursor pagination method can be used for sequential scrolling with unrestricted depth. The offset pagination can be used to skip pages and is limited to 1000 records.
4633
5701
  *
4634
5702
  * Example of cursor pagination:
4635
5703
  *
@@ -4683,18 +5751,46 @@ type QueryTableVariables = {
4683
5751
  * `filter` or `sort` is set. The columns returned and page size can be changed
4684
5752
  * anytime by passing the `columns` or `page.size` settings to the next query.
4685
5753
  *
5754
+ * In the following example of size + offset pagination we retrieve the third page of up to 100 results:
5755
+ *
5756
+ * ```json
5757
+ * POST /db/demo:main/tables/table/query
5758
+ * {
5759
+ * "page": {
5760
+ * "size": 100,
5761
+ * "offset": 200
5762
+ * }
5763
+ * }
5764
+ * ```
5765
+ *
5766
+ * The `page.size` parameter represents the maximum number of records returned by this query. It has a default value of 20 and a maximum value of 200.
5767
+ * The `page.offset` parameter represents the number of matching records to skip. It has a default value of 0 and a maximum value of 800.
5768
+ *
5769
+ * Cursor pagination also works in combination with offset pagination. For example, starting from a specific cursor position, using a page size of 200 and an offset of 800, you can skip up to 5 pages of 200 records forwards or backwards from the cursor's position:
5770
+ *
5771
+ * ```json
5772
+ * POST /db/demo:main/tables/table/query
5773
+ * {
5774
+ * "page": {
5775
+ * "size": 200,
5776
+ * "offset": 800,
5777
+ * "after": "fMoxCsIwFIDh3WP8c4amDai5hO5SJCRNfaVSeC9b6d1FD"
5778
+ * }
5779
+ * }
5780
+ * ```
5781
+ *
4686
5782
  * **Special cursors:**
4687
5783
  *
4688
5784
  * - `page.after=end`: Result points past the last entry. The list of records
4689
5785
  * returned is empty, but `page.meta.cursor` will include a cursor that can be
4690
5786
  * used to "tail" the table from the end waiting for new data to be inserted.
4691
5787
  * - `page.before=end`: This cursor returns the last page.
4692
- * - `page.start=<cursor>`: Start at the beginning of the result set of the <cursor> query. This is equivalent to querying the
5788
+ * - `page.start=$cursor`: Start at the beginning of the result set of the $cursor query. This is equivalent to querying the
4693
5789
  * first page without a cursor but applying `filter` and `sort` . Yet the `page.start`
4694
5790
  * cursor can be convenient at times as user code does not need to remember the
4695
5791
  * filter, sort, columns or page size configuration. All these information are
4696
5792
  * read from the cursor.
4697
- * - `page.end=<cursor>`: Move to the end of the result set of the <cursor> query. This is equivalent to querying the
5793
+ * - `page.end=$cursor`: Move to the end of the result set of the $cursor query. This is equivalent to querying the
4698
5794
  * last page with `page.before=end`, `filter`, and `sort` . Yet the
4699
5795
  * `page.end` cursor can be more convenient at times as user code does not
4700
5796
  * need to remember the filter, sort, columns or page size configuration. All
@@ -4733,6 +5829,9 @@ type SearchBranchError = ErrorWrapper<{
4733
5829
  } | {
4734
5830
  status: 404;
4735
5831
  payload: SimpleError;
5832
+ } | {
5833
+ status: 503;
5834
+ payload: ServiceUnavailableError;
4736
5835
  }>;
4737
5836
  type SearchBranchRequestBody = {
4738
5837
  /**
@@ -4815,46 +5914,6 @@ type SearchTableVariables = {
4815
5914
  * * filtering on columns of type `multiple` is currently unsupported
4816
5915
  */
4817
5916
  declare const searchTable: (variables: SearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
4818
- type SqlQueryPathParams = {
4819
- /**
4820
- * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4821
- */
4822
- dbBranchName: DBBranchName;
4823
- workspace: string;
4824
- region: string;
4825
- };
4826
- type SqlQueryError = ErrorWrapper<{
4827
- status: 400;
4828
- payload: BadRequestError;
4829
- } | {
4830
- status: 401;
4831
- payload: AuthError;
4832
- } | {
4833
- status: 404;
4834
- payload: SimpleError;
4835
- }>;
4836
- type SqlQueryRequestBody = {
4837
- /**
4838
- * The query string.
4839
- *
4840
- * @minLength 1
4841
- */
4842
- query: string;
4843
- /**
4844
- * The consistency level for this request.
4845
- *
4846
- * @default strong
4847
- */
4848
- consistency?: 'strong' | 'eventual';
4849
- };
4850
- type SqlQueryVariables = {
4851
- body: SqlQueryRequestBody;
4852
- pathParams: SqlQueryPathParams;
4853
- } & DataPlaneFetcherExtraProps;
4854
- /**
4855
- * Run an SQL query across the database branch.
4856
- */
4857
- declare const sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<QueryResponse>;
4858
5917
  type VectorSearchTablePathParams = {
4859
5918
  /**
4860
5919
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -4944,7 +6003,11 @@ type AskTableResponse = {
4944
6003
  /**
4945
6004
  * The answer to the input question
4946
6005
  */
4947
- answer?: string;
6006
+ answer: string;
6007
+ /**
6008
+ * The session ID for the chat session.
6009
+ */
6010
+ sessionId: string;
4948
6011
  };
4949
6012
  type AskTableRequestBody = {
4950
6013
  /**
@@ -4999,6 +6062,61 @@ type AskTableVariables = {
4999
6062
  * Ask your table a question. If the `Accept` header is set to `text/event-stream`, Xata will stream the results back as SSE's.
5000
6063
  */
5001
6064
  declare const askTable: (variables: AskTableVariables, signal?: AbortSignal) => Promise<AskTableResponse>;
6065
+ type AskTableSessionPathParams = {
6066
+ /**
6067
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
6068
+ */
6069
+ dbBranchName: DBBranchName;
6070
+ /**
6071
+ * The Table name
6072
+ */
6073
+ tableName: TableName;
6074
+ /**
6075
+ * @maxLength 36
6076
+ * @minLength 36
6077
+ */
6078
+ sessionId: string;
6079
+ workspace: string;
6080
+ region: string;
6081
+ };
6082
+ type AskTableSessionError = ErrorWrapper<{
6083
+ status: 400;
6084
+ payload: BadRequestError;
6085
+ } | {
6086
+ status: 401;
6087
+ payload: AuthError;
6088
+ } | {
6089
+ status: 404;
6090
+ payload: SimpleError;
6091
+ } | {
6092
+ status: 429;
6093
+ payload: RateLimitError;
6094
+ } | {
6095
+ status: 503;
6096
+ payload: ServiceUnavailableError;
6097
+ }>;
6098
+ type AskTableSessionResponse = {
6099
+ /**
6100
+ * The answer to the input question
6101
+ */
6102
+ answer: string;
6103
+ };
6104
+ type AskTableSessionRequestBody = {
6105
+ /**
6106
+ * The question you'd like to ask.
6107
+ *
6108
+ * @minLength 3
6109
+ */
6110
+ message?: string;
6111
+ };
6112
+ type AskTableSessionVariables = {
6113
+ body?: AskTableSessionRequestBody;
6114
+ pathParams: AskTableSessionPathParams;
6115
+ } & DataPlaneFetcherExtraProps;
6116
+ /**
6117
+ * Ask a follow-up question. If the `Accept` header is set to `text/event-stream`, Xata will stream the results back as SSE's.
6118
+ */
6119
+ declare const askTableSession: (variables: AskTableSessionVariables, signal?: AbortSignal) => Promise<AskTableSessionResponse>;
5002
6120
  type SummarizeTablePathParams = {
5003
6121
  /**
5004
6122
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -5113,20 +6231,89 @@ type SummarizeTableVariables = {
5113
6231
  * `page.size`: tells Xata how many records to return. If unspecified, Xata
5114
6232
  * will return the default size.
5115
6233
  */
5116
- declare const summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal) => Promise<SummarizeResponse>;
5117
- type AggregateTablePathParams = {
6234
+ declare const summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal) => Promise<SummarizeResponse>;
6235
+ type AggregateTablePathParams = {
6236
+ /**
6237
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
6238
+ */
6239
+ dbBranchName: DBBranchName;
6240
+ /**
6241
+ * The Table name
6242
+ */
6243
+ tableName: TableName;
6244
+ workspace: string;
6245
+ region: string;
6246
+ };
6247
+ type AggregateTableError = ErrorWrapper<{
6248
+ status: 400;
6249
+ payload: BadRequestError;
6250
+ } | {
6251
+ status: 401;
6252
+ payload: AuthError;
6253
+ } | {
6254
+ status: 404;
6255
+ payload: SimpleError;
6256
+ }>;
6257
+ type AggregateTableRequestBody = {
6258
+ filter?: FilterExpression;
6259
+ aggs?: AggExpressionMap;
6260
+ };
6261
+ type AggregateTableVariables = {
6262
+ body?: AggregateTableRequestBody;
6263
+ pathParams: AggregateTablePathParams;
6264
+ } & DataPlaneFetcherExtraProps;
6265
+ /**
6266
+ * This endpoint allows you to run aggregations (analytics) on the data from one table.
6267
+ * While the summary endpoint is served from a transactional store and the results are strongly
6268
+ * consistent, the aggregate endpoint is served from our columnar store and the results are
6269
+ * only eventually consistent. On the other hand, the aggregate endpoint uses a
6270
+ * store that is more appropiate for analytics, makes use of approximative algorithms
6271
+ * (e.g for cardinality), and is generally faster and can do more complex aggregations.
6272
+ *
6273
+ * For usage, see the [API Guide](https://xata.io/docs/api-guide/aggregate).
6274
+ */
6275
+ declare const aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal) => Promise<AggResponse>;
6276
+ type FileAccessPathParams = {
6277
+ /**
6278
+ * The File Access Identifier
6279
+ */
6280
+ fileId: FileAccessID;
6281
+ workspace: string;
6282
+ region: string;
6283
+ };
6284
+ type FileAccessQueryParams = {
6285
+ /**
6286
+ * File access signature
6287
+ */
6288
+ verify?: FileSignature;
6289
+ };
6290
+ type FileAccessError = ErrorWrapper<{
6291
+ status: 400;
6292
+ payload: BadRequestError;
6293
+ } | {
6294
+ status: 401;
6295
+ payload: AuthError;
6296
+ } | {
6297
+ status: 404;
6298
+ payload: SimpleError;
6299
+ }>;
6300
+ type FileAccessVariables = {
6301
+ pathParams: FileAccessPathParams;
6302
+ queryParams?: FileAccessQueryParams;
6303
+ } & DataPlaneFetcherExtraProps;
6304
+ /**
6305
+ * Retrieve file content by access id
6306
+ */
6307
+ declare const fileAccess: (variables: FileAccessVariables, signal?: AbortSignal) => Promise<Blob>;
6308
+ type SqlQueryPathParams = {
5118
6309
  /**
5119
6310
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
5120
6311
  */
5121
6312
  dbBranchName: DBBranchName;
5122
- /**
5123
- * The Table name
5124
- */
5125
- tableName: TableName;
5126
6313
  workspace: string;
5127
6314
  region: string;
5128
6315
  };
5129
- type AggregateTableError = ErrorWrapper<{
6316
+ type SqlQueryError = ErrorWrapper<{
5130
6317
  status: 400;
5131
6318
  payload: BadRequestError;
5132
6319
  } | {
@@ -5135,29 +6322,41 @@ type AggregateTableError = ErrorWrapper<{
5135
6322
  } | {
5136
6323
  status: 404;
5137
6324
  payload: SimpleError;
6325
+ } | {
6326
+ status: 503;
6327
+ payload: ServiceUnavailableError;
5138
6328
  }>;
5139
- type AggregateTableRequestBody = {
5140
- filter?: FilterExpression;
5141
- aggs?: AggExpressionMap;
6329
+ type SqlQueryRequestBody = {
6330
+ /**
6331
+ * The SQL statement.
6332
+ *
6333
+ * @minLength 1
6334
+ */
6335
+ statement: string;
6336
+ /**
6337
+ * The query parameter list.
6338
+ */
6339
+ params?: any[] | null;
6340
+ /**
6341
+ * The consistency level for this request.
6342
+ *
6343
+ * @default strong
6344
+ */
6345
+ consistency?: 'strong' | 'eventual';
5142
6346
  };
5143
- type AggregateTableVariables = {
5144
- body?: AggregateTableRequestBody;
5145
- pathParams: AggregateTablePathParams;
6347
+ type SqlQueryVariables = {
6348
+ body: SqlQueryRequestBody;
6349
+ pathParams: SqlQueryPathParams;
5146
6350
  } & DataPlaneFetcherExtraProps;
5147
6351
  /**
5148
- * This endpoint allows you to run aggregations (analytics) on the data from one table.
5149
- * While the summary endpoint is served from a transactional store and the results are strongly
5150
- * consistent, the aggregate endpoint is served from our columnar store and the results are
5151
- * only eventually consistent. On the other hand, the aggregate endpoint uses a
5152
- * store that is more appropiate for analytics, makes use of approximative algorithms
5153
- * (e.g for cardinality), and is generally faster and can do more complex aggregations.
5154
- *
5155
- * For usage, see the [API Guide](https://xata.io/docs/api-guide/aggregate).
6352
+ * Run an SQL query across the database branch.
5156
6353
  */
5157
- declare const aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal) => Promise<AggResponse>;
6354
+ declare const sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<SQLResponse>;
5158
6355
 
5159
6356
  declare const operationsByTag: {
5160
6357
  branch: {
6358
+ applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal | undefined) => Promise<PgRollApplyMigrationResponse>;
6359
+ pgRollStatus: (variables: PgRollStatusVariables, signal?: AbortSignal | undefined) => Promise<PgRollStatusResponse>;
5161
6360
  getBranchList: (variables: GetBranchListVariables, signal?: AbortSignal | undefined) => Promise<ListBranchesResponse>;
5162
6361
  getBranchDetails: (variables: GetBranchDetailsVariables, signal?: AbortSignal | undefined) => Promise<DBBranch>;
5163
6362
  createBranch: (variables: CreateBranchVariables, signal?: AbortSignal | undefined) => Promise<CreateBranchResponse>;
@@ -5172,6 +6371,7 @@ declare const operationsByTag: {
5172
6371
  resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal | undefined) => Promise<ResolveBranchResponse>;
5173
6372
  };
5174
6373
  migrations: {
6374
+ getSchema: (variables: GetSchemaVariables, signal?: AbortSignal | undefined) => Promise<GetSchemaResponse>;
5175
6375
  getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal | undefined) => Promise<GetBranchMigrationHistoryResponse>;
5176
6376
  getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables, signal?: AbortSignal | undefined) => Promise<BranchMigrationPlan>;
5177
6377
  executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
@@ -5215,16 +6415,37 @@ declare const operationsByTag: {
5215
6415
  updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
5216
6416
  deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
5217
6417
  };
6418
+ files: {
6419
+ getFileItem: (variables: GetFileItemVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
6420
+ putFileItem: (variables: PutFileItemVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
6421
+ deleteFileItem: (variables: DeleteFileItemVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
6422
+ getFile: (variables: GetFileVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
6423
+ putFile: (variables: PutFileVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
6424
+ deleteFile: (variables: DeleteFileVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
6425
+ fileAccess: (variables: FileAccessVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
6426
+ };
5218
6427
  searchAndFilter: {
5219
6428
  queryTable: (variables: QueryTableVariables, signal?: AbortSignal | undefined) => Promise<QueryResponse>;
5220
6429
  searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
5221
6430
  searchTable: (variables: SearchTableVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
5222
- sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal | undefined) => Promise<QueryResponse>;
5223
6431
  vectorSearchTable: (variables: VectorSearchTableVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
5224
6432
  askTable: (variables: AskTableVariables, signal?: AbortSignal | undefined) => Promise<AskTableResponse>;
6433
+ askTableSession: (variables: AskTableSessionVariables, signal?: AbortSignal | undefined) => Promise<AskTableSessionResponse>;
5225
6434
  summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal | undefined) => Promise<SummarizeResponse>;
5226
6435
  aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal | undefined) => Promise<AggResponse>;
5227
6436
  };
6437
+ sql: {
6438
+ sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal | undefined) => Promise<SQLResponse>;
6439
+ };
6440
+ oAuth: {
6441
+ getAuthorizationCode: (variables: GetAuthorizationCodeVariables, signal?: AbortSignal | undefined) => Promise<AuthorizationCodeResponse>;
6442
+ grantAuthorizationCode: (variables: GrantAuthorizationCodeVariables, signal?: AbortSignal | undefined) => Promise<AuthorizationCodeResponse>;
6443
+ getUserOAuthClients: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetUserOAuthClientsResponse>;
6444
+ deleteUserOAuthClient: (variables: DeleteUserOAuthClientVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
6445
+ getUserOAuthAccessTokens: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetUserOAuthAccessTokensResponse>;
6446
+ deleteOAuthAccessToken: (variables: DeleteOAuthAccessTokenVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
6447
+ updateOAuthAccessToken: (variables: UpdateOAuthAccessTokenVariables, signal?: AbortSignal | undefined) => Promise<OAuthAccessToken>;
6448
+ };
5228
6449
  users: {
5229
6450
  getUser: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<UserWithID>;
5230
6451
  updateUser: (variables: UpdateUserVariables, signal?: AbortSignal | undefined) => Promise<UserWithID>;
@@ -5252,12 +6473,19 @@ declare const operationsByTag: {
5252
6473
  acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
5253
6474
  resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
5254
6475
  };
6476
+ xbcontrolOther: {
6477
+ listClusters: (variables: ListClustersVariables, signal?: AbortSignal | undefined) => Promise<ListClustersResponse>;
6478
+ createCluster: (variables: CreateClusterVariables, signal?: AbortSignal | undefined) => Promise<ClusterResponse>;
6479
+ getCluster: (variables: GetClusterVariables, signal?: AbortSignal | undefined) => Promise<ClusterMetadata>;
6480
+ updateCluster: (variables: UpdateClusterVariables, signal?: AbortSignal | undefined) => Promise<ClusterMetadata>;
6481
+ };
5255
6482
  databases: {
5256
6483
  getDatabaseList: (variables: GetDatabaseListVariables, signal?: AbortSignal | undefined) => Promise<ListDatabasesResponse>;
5257
6484
  createDatabase: (variables: CreateDatabaseVariables, signal?: AbortSignal | undefined) => Promise<CreateDatabaseResponse>;
5258
6485
  deleteDatabase: (variables: DeleteDatabaseVariables, signal?: AbortSignal | undefined) => Promise<DeleteDatabaseResponse>;
5259
6486
  getDatabaseMetadata: (variables: GetDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
5260
6487
  updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
6488
+ renameDatabase: (variables: RenameDatabaseVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
5261
6489
  getDatabaseGithubSettings: (variables: GetDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<DatabaseGithubSettings>;
5262
6490
  updateDatabaseGithubSettings: (variables: UpdateDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<DatabaseGithubSettings>;
5263
6491
  deleteDatabaseGithubSettings: (variables: DeleteDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
@@ -5287,38 +6515,29 @@ type responses_BadRequestError = BadRequestError;
5287
6515
  type responses_BranchMigrationPlan = BranchMigrationPlan;
5288
6516
  type responses_BulkError = BulkError;
5289
6517
  type responses_BulkInsertResponse = BulkInsertResponse;
6518
+ type responses_PutFileResponse = PutFileResponse;
5290
6519
  type responses_QueryResponse = QueryResponse;
5291
6520
  type responses_RateLimitError = RateLimitError;
5292
6521
  type responses_RecordResponse = RecordResponse;
5293
6522
  type responses_RecordUpdateResponse = RecordUpdateResponse;
6523
+ type responses_SQLResponse = SQLResponse;
5294
6524
  type responses_SchemaCompareResponse = SchemaCompareResponse;
5295
6525
  type responses_SchemaUpdateResponse = SchemaUpdateResponse;
5296
6526
  type responses_SearchResponse = SearchResponse;
6527
+ type responses_ServiceUnavailableError = ServiceUnavailableError;
5297
6528
  type responses_SimpleError = SimpleError;
5298
6529
  type responses_SummarizeResponse = SummarizeResponse;
5299
6530
  declare namespace responses {
5300
- export {
5301
- responses_AggResponse as AggResponse,
5302
- responses_AuthError as AuthError,
5303
- responses_BadRequestError as BadRequestError,
5304
- responses_BranchMigrationPlan as BranchMigrationPlan,
5305
- responses_BulkError as BulkError,
5306
- responses_BulkInsertResponse as BulkInsertResponse,
5307
- responses_QueryResponse as QueryResponse,
5308
- responses_RateLimitError as RateLimitError,
5309
- responses_RecordResponse as RecordResponse,
5310
- responses_RecordUpdateResponse as RecordUpdateResponse,
5311
- responses_SchemaCompareResponse as SchemaCompareResponse,
5312
- responses_SchemaUpdateResponse as SchemaUpdateResponse,
5313
- responses_SearchResponse as SearchResponse,
5314
- responses_SimpleError as SimpleError,
5315
- responses_SummarizeResponse as SummarizeResponse,
5316
- };
6531
+ export type { responses_AggResponse as AggResponse, responses_AuthError as AuthError, responses_BadRequestError 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, responses_SimpleError as SimpleError, responses_SummarizeResponse as SummarizeResponse };
5317
6532
  }
5318
6533
 
5319
6534
  type schemas_APIKeyName = APIKeyName;
6535
+ type schemas_AccessToken = AccessToken;
5320
6536
  type schemas_AggExpression = AggExpression;
5321
6537
  type schemas_AggExpressionMap = AggExpressionMap;
6538
+ type schemas_AuthorizationCodeRequest = AuthorizationCodeRequest;
6539
+ type schemas_AuthorizationCodeResponse = AuthorizationCodeResponse;
6540
+ type schemas_AutoscalingConfig = AutoscalingConfig;
5322
6541
  type schemas_AverageAgg = AverageAgg;
5323
6542
  type schemas_BoosterExpression = BoosterExpression;
5324
6543
  type schemas_Branch = Branch;
@@ -5327,7 +6546,15 @@ type schemas_BranchMigration = BranchMigration;
5327
6546
  type schemas_BranchName = BranchName;
5328
6547
  type schemas_BranchOp = BranchOp;
5329
6548
  type schemas_BranchWithCopyID = BranchWithCopyID;
6549
+ type schemas_ClusterConfiguration = ClusterConfiguration;
6550
+ type schemas_ClusterCreateDetails = ClusterCreateDetails;
6551
+ type schemas_ClusterID = ClusterID;
6552
+ type schemas_ClusterMetadata = ClusterMetadata;
6553
+ type schemas_ClusterResponse = ClusterResponse;
6554
+ type schemas_ClusterShortMetadata = ClusterShortMetadata;
6555
+ type schemas_ClusterUpdateDetails = ClusterUpdateDetails;
5330
6556
  type schemas_Column = Column;
6557
+ type schemas_ColumnFile = ColumnFile;
5331
6558
  type schemas_ColumnLink = ColumnLink;
5332
6559
  type schemas_ColumnMigration = ColumnMigration;
5333
6560
  type schemas_ColumnName = ColumnName;
@@ -5341,11 +6568,17 @@ type schemas_CountAgg = CountAgg;
5341
6568
  type schemas_DBBranch = DBBranch;
5342
6569
  type schemas_DBBranchName = DBBranchName;
5343
6570
  type schemas_DBName = DBName;
6571
+ type schemas_DailyTimeWindow = DailyTimeWindow;
5344
6572
  type schemas_DataInputRecord = DataInputRecord;
5345
6573
  type schemas_DatabaseGithubSettings = DatabaseGithubSettings;
5346
6574
  type schemas_DatabaseMetadata = DatabaseMetadata;
5347
6575
  type schemas_DateHistogramAgg = DateHistogramAgg;
5348
6576
  type schemas_DateTime = DateTime;
6577
+ type schemas_FileAccessID = FileAccessID;
6578
+ type schemas_FileItemID = FileItemID;
6579
+ type schemas_FileName = FileName;
6580
+ type schemas_FileResponse = FileResponse;
6581
+ type schemas_FileSignature = FileSignature;
5349
6582
  type schemas_FilterColumn = FilterColumn;
5350
6583
  type schemas_FilterColumnIncludes = FilterColumnIncludes;
5351
6584
  type schemas_FilterExpression = FilterExpression;
@@ -5357,15 +6590,19 @@ type schemas_FilterRangeValue = FilterRangeValue;
5357
6590
  type schemas_FilterValue = FilterValue;
5358
6591
  type schemas_FuzzinessExpression = FuzzinessExpression;
5359
6592
  type schemas_HighlightExpression = HighlightExpression;
6593
+ type schemas_InputFile = InputFile;
5360
6594
  type schemas_InputFileArray = InputFileArray;
5361
6595
  type schemas_InputFileEntry = InputFileEntry;
5362
6596
  type schemas_InviteID = InviteID;
5363
6597
  type schemas_InviteKey = InviteKey;
5364
6598
  type schemas_ListBranchesResponse = ListBranchesResponse;
6599
+ type schemas_ListClustersResponse = ListClustersResponse;
5365
6600
  type schemas_ListDatabasesResponse = ListDatabasesResponse;
5366
6601
  type schemas_ListGitBranchesResponse = ListGitBranchesResponse;
5367
6602
  type schemas_ListRegionsResponse = ListRegionsResponse;
6603
+ type schemas_MaintenanceConfig = MaintenanceConfig;
5368
6604
  type schemas_MaxAgg = MaxAgg;
6605
+ type schemas_MediaType = MediaType;
5369
6606
  type schemas_MetricsDatapoint = MetricsDatapoint;
5370
6607
  type schemas_MetricsLatency = MetricsLatency;
5371
6608
  type schemas_Migration = Migration;
@@ -5378,15 +6615,27 @@ type schemas_MigrationStatus = MigrationStatus;
5378
6615
  type schemas_MigrationTableOp = MigrationTableOp;
5379
6616
  type schemas_MinAgg = MinAgg;
5380
6617
  type schemas_NumericHistogramAgg = NumericHistogramAgg;
6618
+ type schemas_OAuthAccessToken = OAuthAccessToken;
6619
+ type schemas_OAuthClientID = OAuthClientID;
6620
+ type schemas_OAuthClientPublicDetails = OAuthClientPublicDetails;
6621
+ type schemas_OAuthResponseType = OAuthResponseType;
6622
+ type schemas_OAuthScope = OAuthScope;
5381
6623
  type schemas_ObjectValue = ObjectValue;
5382
6624
  type schemas_PageConfig = PageConfig;
6625
+ type schemas_PercentilesAgg = PercentilesAgg;
6626
+ type schemas_PgRollApplyMigrationResponse = PgRollApplyMigrationResponse;
6627
+ type schemas_PgRollMigrationStatus = PgRollMigrationStatus;
6628
+ type schemas_PgRollStatusResponse = PgRollStatusResponse;
5383
6629
  type schemas_PrefixExpression = PrefixExpression;
6630
+ type schemas_ProjectionConfig = ProjectionConfig;
6631
+ type schemas_QueryColumnsProjection = QueryColumnsProjection;
5384
6632
  type schemas_RecordID = RecordID;
5385
6633
  type schemas_RecordMeta = RecordMeta;
5386
6634
  type schemas_RecordsMetadata = RecordsMetadata;
5387
6635
  type schemas_Region = Region;
5388
6636
  type schemas_RevLink = RevLink;
5389
6637
  type schemas_Role = Role;
6638
+ type schemas_SQLRecord = SQLRecord;
5390
6639
  type schemas_Schema = Schema;
5391
6640
  type schemas_SchemaEditScript = SchemaEditScript;
5392
6641
  type schemas_SearchPageConfig = SearchPageConfig;
@@ -5408,9 +6657,11 @@ type schemas_TopValuesAgg = TopValuesAgg;
5408
6657
  type schemas_TransactionDeleteOp = TransactionDeleteOp;
5409
6658
  type schemas_TransactionError = TransactionError;
5410
6659
  type schemas_TransactionFailure = TransactionFailure;
6660
+ type schemas_TransactionGetOp = TransactionGetOp;
5411
6661
  type schemas_TransactionInsertOp = TransactionInsertOp;
5412
6662
  type schemas_TransactionResultColumns = TransactionResultColumns;
5413
6663
  type schemas_TransactionResultDelete = TransactionResultDelete;
6664
+ type schemas_TransactionResultGet = TransactionResultGet;
5414
6665
  type schemas_TransactionResultInsert = TransactionResultInsert;
5415
6666
  type schemas_TransactionResultUpdate = TransactionResultUpdate;
5416
6667
  type schemas_TransactionSuccess = TransactionSuccess;
@@ -5419,130 +6670,16 @@ type schemas_UniqueCountAgg = UniqueCountAgg;
5419
6670
  type schemas_User = User;
5420
6671
  type schemas_UserID = UserID;
5421
6672
  type schemas_UserWithID = UserWithID;
6673
+ type schemas_WeeklyTimeWindow = WeeklyTimeWindow;
5422
6674
  type schemas_Workspace = Workspace;
5423
6675
  type schemas_WorkspaceID = WorkspaceID;
5424
6676
  type schemas_WorkspaceInvite = WorkspaceInvite;
5425
6677
  type schemas_WorkspaceMember = WorkspaceMember;
5426
6678
  type schemas_WorkspaceMembers = WorkspaceMembers;
5427
6679
  type schemas_WorkspaceMeta = WorkspaceMeta;
6680
+ type schemas_WorkspacePlan = WorkspacePlan;
5428
6681
  declare namespace schemas {
5429
- export {
5430
- schemas_APIKeyName as APIKeyName,
5431
- schemas_AggExpression as AggExpression,
5432
- schemas_AggExpressionMap as AggExpressionMap,
5433
- AggResponse$1 as AggResponse,
5434
- schemas_AverageAgg as AverageAgg,
5435
- schemas_BoosterExpression as BoosterExpression,
5436
- schemas_Branch as Branch,
5437
- schemas_BranchMetadata as BranchMetadata,
5438
- schemas_BranchMigration as BranchMigration,
5439
- schemas_BranchName as BranchName,
5440
- schemas_BranchOp as BranchOp,
5441
- schemas_BranchWithCopyID as BranchWithCopyID,
5442
- schemas_Column as Column,
5443
- schemas_ColumnLink as ColumnLink,
5444
- schemas_ColumnMigration as ColumnMigration,
5445
- schemas_ColumnName as ColumnName,
5446
- schemas_ColumnOpAdd as ColumnOpAdd,
5447
- schemas_ColumnOpRemove as ColumnOpRemove,
5448
- schemas_ColumnOpRename as ColumnOpRename,
5449
- schemas_ColumnVector as ColumnVector,
5450
- schemas_ColumnsProjection as ColumnsProjection,
5451
- schemas_Commit as Commit,
5452
- schemas_CountAgg as CountAgg,
5453
- schemas_DBBranch as DBBranch,
5454
- schemas_DBBranchName as DBBranchName,
5455
- schemas_DBName as DBName,
5456
- schemas_DataInputRecord as DataInputRecord,
5457
- schemas_DatabaseGithubSettings as DatabaseGithubSettings,
5458
- schemas_DatabaseMetadata as DatabaseMetadata,
5459
- DateBooster$1 as DateBooster,
5460
- schemas_DateHistogramAgg as DateHistogramAgg,
5461
- schemas_DateTime as DateTime,
5462
- schemas_FilterColumn as FilterColumn,
5463
- schemas_FilterColumnIncludes as FilterColumnIncludes,
5464
- schemas_FilterExpression as FilterExpression,
5465
- schemas_FilterList as FilterList,
5466
- schemas_FilterPredicate as FilterPredicate,
5467
- schemas_FilterPredicateOp as FilterPredicateOp,
5468
- schemas_FilterPredicateRangeOp as FilterPredicateRangeOp,
5469
- schemas_FilterRangeValue as FilterRangeValue,
5470
- schemas_FilterValue as FilterValue,
5471
- schemas_FuzzinessExpression as FuzzinessExpression,
5472
- schemas_HighlightExpression as HighlightExpression,
5473
- schemas_InputFileArray as InputFileArray,
5474
- schemas_InputFileEntry as InputFileEntry,
5475
- schemas_InviteID as InviteID,
5476
- schemas_InviteKey as InviteKey,
5477
- schemas_ListBranchesResponse as ListBranchesResponse,
5478
- schemas_ListDatabasesResponse as ListDatabasesResponse,
5479
- schemas_ListGitBranchesResponse as ListGitBranchesResponse,
5480
- schemas_ListRegionsResponse as ListRegionsResponse,
5481
- schemas_MaxAgg as MaxAgg,
5482
- schemas_MetricsDatapoint as MetricsDatapoint,
5483
- schemas_MetricsLatency as MetricsLatency,
5484
- schemas_Migration as Migration,
5485
- schemas_MigrationColumnOp as MigrationColumnOp,
5486
- schemas_MigrationObject as MigrationObject,
5487
- schemas_MigrationOp as MigrationOp,
5488
- schemas_MigrationRequest as MigrationRequest,
5489
- schemas_MigrationRequestNumber as MigrationRequestNumber,
5490
- schemas_MigrationStatus as MigrationStatus,
5491
- schemas_MigrationTableOp as MigrationTableOp,
5492
- schemas_MinAgg as MinAgg,
5493
- NumericBooster$1 as NumericBooster,
5494
- schemas_NumericHistogramAgg as NumericHistogramAgg,
5495
- schemas_ObjectValue as ObjectValue,
5496
- schemas_PageConfig as PageConfig,
5497
- schemas_PrefixExpression as PrefixExpression,
5498
- schemas_RecordID as RecordID,
5499
- schemas_RecordMeta as RecordMeta,
5500
- schemas_RecordsMetadata as RecordsMetadata,
5501
- schemas_Region as Region,
5502
- schemas_RevLink as RevLink,
5503
- schemas_Role as Role,
5504
- schemas_Schema as Schema,
5505
- schemas_SchemaEditScript as SchemaEditScript,
5506
- schemas_SearchPageConfig as SearchPageConfig,
5507
- schemas_SortExpression as SortExpression,
5508
- schemas_SortOrder as SortOrder,
5509
- schemas_StartedFromMetadata as StartedFromMetadata,
5510
- schemas_SumAgg as SumAgg,
5511
- schemas_SummaryExpression as SummaryExpression,
5512
- schemas_SummaryExpressionList as SummaryExpressionList,
5513
- schemas_Table as Table,
5514
- schemas_TableMigration as TableMigration,
5515
- schemas_TableName as TableName,
5516
- schemas_TableOpAdd as TableOpAdd,
5517
- schemas_TableOpRemove as TableOpRemove,
5518
- schemas_TableOpRename as TableOpRename,
5519
- schemas_TableRename as TableRename,
5520
- schemas_TargetExpression as TargetExpression,
5521
- schemas_TopValuesAgg as TopValuesAgg,
5522
- schemas_TransactionDeleteOp as TransactionDeleteOp,
5523
- schemas_TransactionError as TransactionError,
5524
- schemas_TransactionFailure as TransactionFailure,
5525
- schemas_TransactionInsertOp as TransactionInsertOp,
5526
- TransactionOperation$1 as TransactionOperation,
5527
- schemas_TransactionResultColumns as TransactionResultColumns,
5528
- schemas_TransactionResultDelete as TransactionResultDelete,
5529
- schemas_TransactionResultInsert as TransactionResultInsert,
5530
- schemas_TransactionResultUpdate as TransactionResultUpdate,
5531
- schemas_TransactionSuccess as TransactionSuccess,
5532
- schemas_TransactionUpdateOp as TransactionUpdateOp,
5533
- schemas_UniqueCountAgg as UniqueCountAgg,
5534
- schemas_User as User,
5535
- schemas_UserID as UserID,
5536
- schemas_UserWithID as UserWithID,
5537
- ValueBooster$1 as ValueBooster,
5538
- schemas_Workspace as Workspace,
5539
- schemas_WorkspaceID as WorkspaceID,
5540
- schemas_WorkspaceInvite as WorkspaceInvite,
5541
- schemas_WorkspaceMember as WorkspaceMember,
5542
- schemas_WorkspaceMembers as WorkspaceMembers,
5543
- schemas_WorkspaceMeta as WorkspaceMeta,
5544
- XataRecord$1 as XataRecord,
5545
- };
6682
+ export type { schemas_APIKeyName as APIKeyName, schemas_AccessToken as AccessToken, schemas_AggExpression as AggExpression, schemas_AggExpressionMap as AggExpressionMap, AggResponse$1 as AggResponse, schemas_AuthorizationCodeRequest as AuthorizationCodeRequest, schemas_AuthorizationCodeResponse as AuthorizationCodeResponse, schemas_AutoscalingConfig as AutoscalingConfig, schemas_AverageAgg as AverageAgg, schemas_BoosterExpression as BoosterExpression, schemas_Branch as Branch, schemas_BranchMetadata as BranchMetadata, schemas_BranchMigration as BranchMigration, schemas_BranchName as BranchName, schemas_BranchOp as BranchOp, schemas_BranchWithCopyID as BranchWithCopyID, schemas_ClusterConfiguration as ClusterConfiguration, 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_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, schemas_DBName as DBName, schemas_DailyTimeWindow as DailyTimeWindow, schemas_DataInputRecord as DataInputRecord, schemas_DatabaseGithubSettings as DatabaseGithubSettings, schemas_DatabaseMetadata as DatabaseMetadata, DateBooster$1 as DateBooster, schemas_DateHistogramAgg as DateHistogramAgg, schemas_DateTime 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_MaxAgg as MaxAgg, schemas_MediaType as MediaType, schemas_MetricsDatapoint as MetricsDatapoint, schemas_MetricsLatency as MetricsLatency, schemas_Migration as Migration, schemas_MigrationColumnOp as MigrationColumnOp, schemas_MigrationObject as MigrationObject, schemas_MigrationOp as MigrationOp, schemas_MigrationRequest as MigrationRequest, schemas_MigrationRequestNumber as MigrationRequestNumber, schemas_MigrationStatus as MigrationStatus, schemas_MigrationTableOp as MigrationTableOp, 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_PercentilesAgg as PercentilesAgg, schemas_PgRollApplyMigrationResponse as PgRollApplyMigrationResponse, schemas_PgRollMigrationStatus as PgRollMigrationStatus, schemas_PgRollStatusResponse as PgRollStatusResponse, schemas_PrefixExpression as PrefixExpression, schemas_ProjectionConfig as ProjectionConfig, schemas_QueryColumnsProjection as QueryColumnsProjection, schemas_RecordID as RecordID, schemas_RecordMeta as RecordMeta, schemas_RecordsMetadata as RecordsMetadata, schemas_Region as Region, schemas_RevLink as RevLink, schemas_Role as Role, schemas_SQLRecord as SQLRecord, schemas_Schema as Schema, schemas_SchemaEditScript as SchemaEditScript, schemas_SearchPageConfig as SearchPageConfig, schemas_SortExpression as SortExpression, schemas_SortOrder as SortOrder, schemas_StartedFromMetadata as StartedFromMetadata, schemas_SumAgg as SumAgg, schemas_SummaryExpression as SummaryExpression, schemas_SummaryExpressionList as SummaryExpressionList, schemas_Table as Table, schemas_TableMigration as TableMigration, schemas_TableName as TableName, schemas_TableOpAdd as TableOpAdd, schemas_TableOpRemove as TableOpRemove, schemas_TableOpRename as TableOpRename, schemas_TableRename as TableRename, schemas_TargetExpression as TargetExpression, schemas_TopValuesAgg as TopValuesAgg, schemas_TransactionDeleteOp as TransactionDeleteOp, schemas_TransactionError as TransactionError, schemas_TransactionFailure as TransactionFailure, schemas_TransactionGetOp as TransactionGetOp, schemas_TransactionInsertOp as TransactionInsertOp, TransactionOperation$1 as TransactionOperation, schemas_TransactionResultColumns as TransactionResultColumns, schemas_TransactionResultDelete as TransactionResultDelete, schemas_TransactionResultGet as TransactionResultGet, schemas_TransactionResultInsert as TransactionResultInsert, schemas_TransactionResultUpdate as TransactionResultUpdate, schemas_TransactionSuccess as TransactionSuccess, schemas_TransactionUpdateOp as TransactionUpdateOp, schemas_UniqueCountAgg as UniqueCountAgg, schemas_User as User, schemas_UserID as UserID, schemas_UserWithID as UserWithID, ValueBooster$1 as ValueBooster, schemas_WeeklyTimeWindow as WeeklyTimeWindow, schemas_Workspace as Workspace, schemas_WorkspaceID as WorkspaceID, schemas_WorkspaceInvite as WorkspaceInvite, schemas_WorkspaceMember as WorkspaceMember, schemas_WorkspaceMembers as WorkspaceMembers, schemas_WorkspaceMeta as WorkspaceMeta, schemas_WorkspacePlan as WorkspacePlan, XataRecord$1 as XataRecord };
5546
6683
  }
5547
6684
 
5548
6685
  type ApiExtraProps = Omit<FetcherExtraProps, 'endpoint'>;
@@ -5567,6 +6704,7 @@ declare class XataApiClient {
5567
6704
  get migrationRequests(): MigrationRequestsApi;
5568
6705
  get tables(): TableApi;
5569
6706
  get records(): RecordsApi;
6707
+ get files(): FilesApi;
5570
6708
  get searchAndFilter(): SearchAndFilterApi;
5571
6709
  }
5572
6710
  declare class UserApi {
@@ -5888,6 +7026,75 @@ declare class RecordsApi {
5888
7026
  operations: TransactionOperation$1[];
5889
7027
  }): Promise<TransactionSuccess>;
5890
7028
  }
7029
+ declare class FilesApi {
7030
+ private extraProps;
7031
+ constructor(extraProps: ApiExtraProps);
7032
+ getFileItem({ workspace, region, database, branch, table, record, column, fileId }: {
7033
+ workspace: WorkspaceID;
7034
+ region: string;
7035
+ database: DBName;
7036
+ branch: BranchName;
7037
+ table: TableName;
7038
+ record: RecordID;
7039
+ column: ColumnName;
7040
+ fileId: string;
7041
+ }): Promise<any>;
7042
+ putFileItem({ workspace, region, database, branch, table, record, column, fileId, file }: {
7043
+ workspace: WorkspaceID;
7044
+ region: string;
7045
+ database: DBName;
7046
+ branch: BranchName;
7047
+ table: TableName;
7048
+ record: RecordID;
7049
+ column: ColumnName;
7050
+ fileId: string;
7051
+ file: any;
7052
+ }): Promise<PutFileResponse>;
7053
+ deleteFileItem({ workspace, region, database, branch, table, record, column, fileId }: {
7054
+ workspace: WorkspaceID;
7055
+ region: string;
7056
+ database: DBName;
7057
+ branch: BranchName;
7058
+ table: TableName;
7059
+ record: RecordID;
7060
+ column: ColumnName;
7061
+ fileId: string;
7062
+ }): Promise<PutFileResponse>;
7063
+ getFile({ workspace, region, database, branch, table, record, column }: {
7064
+ workspace: WorkspaceID;
7065
+ region: string;
7066
+ database: DBName;
7067
+ branch: BranchName;
7068
+ table: TableName;
7069
+ record: RecordID;
7070
+ column: ColumnName;
7071
+ }): Promise<any>;
7072
+ putFile({ workspace, region, database, branch, table, record, column, file }: {
7073
+ workspace: WorkspaceID;
7074
+ region: string;
7075
+ database: DBName;
7076
+ branch: BranchName;
7077
+ table: TableName;
7078
+ record: RecordID;
7079
+ column: ColumnName;
7080
+ file: Blob;
7081
+ }): Promise<PutFileResponse>;
7082
+ deleteFile({ workspace, region, database, branch, table, record, column }: {
7083
+ workspace: WorkspaceID;
7084
+ region: string;
7085
+ database: DBName;
7086
+ branch: BranchName;
7087
+ table: TableName;
7088
+ record: RecordID;
7089
+ column: ColumnName;
7090
+ }): Promise<PutFileResponse>;
7091
+ fileAccess({ workspace, region, fileId, verify }: {
7092
+ workspace: WorkspaceID;
7093
+ region: string;
7094
+ fileId: string;
7095
+ verify?: FileSignature;
7096
+ }): Promise<any>;
7097
+ }
5891
7098
  declare class SearchAndFilterApi {
5892
7099
  private extraProps;
5893
7100
  constructor(extraProps: ApiExtraProps);
@@ -5953,6 +7160,15 @@ declare class SearchAndFilterApi {
5953
7160
  table: TableName;
5954
7161
  options: AskTableRequestBody;
5955
7162
  }): Promise<AskTableResponse>;
7163
+ askTableSession({ workspace, region, database, branch, table, sessionId, message }: {
7164
+ workspace: WorkspaceID;
7165
+ region: string;
7166
+ database: DBName;
7167
+ branch: BranchName;
7168
+ table: TableName;
7169
+ sessionId: string;
7170
+ message: string;
7171
+ }): Promise<AskTableSessionResponse>;
5956
7172
  summarizeTable({ workspace, region, database, branch, table, filter, columns, summaries, sort, summariesFilter, page, consistency }: {
5957
7173
  workspace: WorkspaceID;
5958
7174
  region: string;
@@ -6131,10 +7347,11 @@ declare class DatabaseApi {
6131
7347
  getDatabaseList({ workspace }: {
6132
7348
  workspace: WorkspaceID;
6133
7349
  }): Promise<ListDatabasesResponse>;
6134
- createDatabase({ workspace, database, data }: {
7350
+ createDatabase({ workspace, database, data, headers }: {
6135
7351
  workspace: WorkspaceID;
6136
7352
  database: DBName;
6137
7353
  data: CreateDatabaseRequestBody;
7354
+ headers?: Record<string, string>;
6138
7355
  }): Promise<CreateDatabaseResponse>;
6139
7356
  deleteDatabase({ workspace, database }: {
6140
7357
  workspace: WorkspaceID;
@@ -6149,6 +7366,11 @@ declare class DatabaseApi {
6149
7366
  database: DBName;
6150
7367
  metadata: DatabaseMetadata;
6151
7368
  }): Promise<DatabaseMetadata>;
7369
+ renameDatabase({ workspace, database, newName }: {
7370
+ workspace: WorkspaceID;
7371
+ database: DBName;
7372
+ newName: DBName;
7373
+ }): Promise<DatabaseMetadata>;
6152
7374
  getDatabaseGithubSettings({ workspace, database }: {
6153
7375
  workspace: WorkspaceID;
6154
7376
  database: DBName;
@@ -6204,35 +7426,296 @@ type Narrowable = string | number | bigint | boolean;
6204
7426
  type Try<A1, A2, Catch = never> = A1 extends A2 ? A1 : Catch;
6205
7427
  type Narrow<A> = Try<A, [], NarrowRaw<A>>;
6206
7428
 
6207
- type SelectableColumn<O, RecursivePath extends any[] = []> = '*' | 'id' | DataProps<O> | NestedColumns<O, RecursivePath>;
7429
+ interface ImageTransformations {
7430
+ /**
7431
+ * Whether to preserve animation frames from input files. Default is true.
7432
+ * Setting it to false reduces animations to still images. This setting is
7433
+ * recommended when enlarging images or processing arbitrary user content,
7434
+ * because large GIF animations can weigh tens or even hundreds of megabytes.
7435
+ * It is also useful to set anim:false when using format:"json" to get the
7436
+ * response quicker without the number of frames.
7437
+ */
7438
+ anim?: boolean;
7439
+ /**
7440
+ * Background color to add underneath the image. Applies only to images with
7441
+ * transparency (such as PNG). Accepts any CSS color (#RRGGBB, rgba(…),
7442
+ * hsl(…), etc.)
7443
+ */
7444
+ background?: string;
7445
+ /**
7446
+ * Radius of a blur filter (approximate gaussian). Maximum supported radius
7447
+ * is 250.
7448
+ */
7449
+ blur?: number;
7450
+ /**
7451
+ * Increase brightness by a factor. A value of 1.0 equals no change, a value
7452
+ * of 0.5 equals half brightness, and a value of 2.0 equals twice as bright.
7453
+ * 0 is ignored.
7454
+ */
7455
+ brightness?: number;
7456
+ /**
7457
+ * Slightly reduces latency on a cache miss by selecting a
7458
+ * quickest-to-compress file format, at a cost of increased file size and
7459
+ * lower image quality. It will usually override the format option and choose
7460
+ * JPEG over WebP or AVIF. We do not recommend using this option, except in
7461
+ * unusual circumstances like resizing uncacheable dynamically-generated
7462
+ * images.
7463
+ */
7464
+ compression?: 'fast';
7465
+ /**
7466
+ * Increase contrast by a factor. A value of 1.0 equals no change, a value of
7467
+ * 0.5 equals low contrast, and a value of 2.0 equals high contrast. 0 is
7468
+ * ignored.
7469
+ */
7470
+ contrast?: number;
7471
+ /**
7472
+ * Download file. Forces browser to download the image.
7473
+ * Value is used for the download file name. Extension is optional.
7474
+ */
7475
+ download?: string;
7476
+ /**
7477
+ * Device Pixel Ratio. Default 1. Multiplier for width/height that makes it
7478
+ * easier to specify higher-DPI sizes in <img srcset>.
7479
+ */
7480
+ dpr?: number;
7481
+ /**
7482
+ * Resizing mode as a string. It affects interpretation of width and height
7483
+ * options:
7484
+ * - scale-down: Similar to contain, but the image is never enlarged. If
7485
+ * the image is larger than given width or height, it will be resized.
7486
+ * Otherwise its original size will be kept.
7487
+ * - contain: Resizes to maximum size that fits within the given width and
7488
+ * height. If only a single dimension is given (e.g. only width), the
7489
+ * image will be shrunk or enlarged to exactly match that dimension.
7490
+ * Aspect ratio is always preserved.
7491
+ * - cover: Resizes (shrinks or enlarges) to fill the entire area of width
7492
+ * and height. If the image has an aspect ratio different from the ratio
7493
+ * of width and height, it will be cropped to fit.
7494
+ * - crop: The image will be shrunk and cropped to fit within the area
7495
+ * specified by width and height. The image will not be enlarged. For images
7496
+ * smaller than the given dimensions it's the same as scale-down. For
7497
+ * images larger than the given dimensions, it's the same as cover.
7498
+ * See also trim.
7499
+ * - pad: Resizes to the maximum size that fits within the given width and
7500
+ * height, and then fills the remaining area with a background color
7501
+ * (white by default). Use of this mode is not recommended, as the same
7502
+ * effect can be more efficiently achieved with the contain mode and the
7503
+ * CSS object-fit: contain property.
7504
+ */
7505
+ fit?: 'scale-down' | 'contain' | 'cover' | 'crop' | 'pad';
7506
+ /**
7507
+ * Output format to generate. It can be:
7508
+ * - avif: generate images in AVIF format.
7509
+ * - webp: generate images in Google WebP format. Set quality to 100 to get
7510
+ * the WebP-lossless format.
7511
+ * - json: instead of generating an image, outputs information about the
7512
+ * image, in JSON format. The JSON object will contain image size
7513
+ * (before and after resizing), source image’s MIME type, file size, etc.
7514
+ * - jpeg: generate images in JPEG format.
7515
+ * - png: generate images in PNG format.
7516
+ */
7517
+ format?: 'auto' | 'avif' | 'webp' | 'json' | 'jpeg' | 'png';
7518
+ /**
7519
+ * Increase exposure by a factor. A value of 1.0 equals no change, a value of
7520
+ * 0.5 darkens the image, and a value of 2.0 lightens the image. 0 is ignored.
7521
+ */
7522
+ gamma?: number;
7523
+ /**
7524
+ * When cropping with fit: "cover", this defines the side or point that should
7525
+ * be left uncropped. The value is either a string
7526
+ * "left", "right", "top", "bottom", "auto", or "center" (the default),
7527
+ * or an object {x, y} containing focal point coordinates in the original
7528
+ * image expressed as fractions ranging from 0.0 (top or left) to 1.0
7529
+ * (bottom or right), 0.5 being the center. {fit: "cover", gravity: "top"} will
7530
+ * crop bottom or left and right sides as necessary, but won’t crop anything
7531
+ * from the top. {fit: "cover", gravity: {x:0.5, y:0.2}} will crop each side to
7532
+ * preserve as much as possible around a point at 20% of the height of the
7533
+ * source image.
7534
+ */
7535
+ gravity?: 'left' | 'right' | 'top' | 'bottom' | 'center' | 'auto' | {
7536
+ x: number;
7537
+ y: number;
7538
+ };
7539
+ /**
7540
+ * Maximum height in image pixels. The value must be an integer.
7541
+ */
7542
+ height?: number;
7543
+ /**
7544
+ * What EXIF data should be preserved in the output image. Note that EXIF
7545
+ * rotation and embedded color profiles are always applied ("baked in" into
7546
+ * the image), and aren't affected by this option. Note that if the Polish
7547
+ * feature is enabled, all metadata may have been removed already and this
7548
+ * option may have no effect.
7549
+ * - keep: Preserve most of EXIF metadata, including GPS location if there's
7550
+ * any.
7551
+ * - copyright: Only keep the copyright tag, and discard everything else.
7552
+ * This is the default behavior for JPEG files.
7553
+ * - none: Discard all invisible EXIF metadata. Currently WebP and PNG
7554
+ * output formats always discard metadata.
7555
+ */
7556
+ metadata?: 'keep' | 'copyright' | 'none';
7557
+ /**
7558
+ * Quality setting from 1-100 (useful values are in 60-90 range). Lower values
7559
+ * make images look worse, but load faster. The default is 85. It applies only
7560
+ * to JPEG and WebP images. It doesn’t have any effect on PNG.
7561
+ */
7562
+ quality?: number;
7563
+ /**
7564
+ * Number of degrees (90, 180, 270) to rotate the image by. width and height
7565
+ * options refer to axes after rotation.
7566
+ */
7567
+ rotate?: 0 | 90 | 180 | 270 | 360;
7568
+ /**
7569
+ * Strength of sharpening filter to apply to the image. Floating-point
7570
+ * number between 0 (no sharpening, default) and 10 (maximum). 1.0 is a
7571
+ * recommended value for downscaled images.
7572
+ */
7573
+ sharpen?: number;
7574
+ /**
7575
+ * An object with four properties {left, top, right, bottom} that specify
7576
+ * a number of pixels to cut off on each side. Allows removal of borders
7577
+ * or cutting out a specific fragment of an image. Trimming is performed
7578
+ * before resizing or rotation. Takes dpr into account.
7579
+ */
7580
+ trim?: {
7581
+ left?: number;
7582
+ top?: number;
7583
+ right?: number;
7584
+ bottom?: number;
7585
+ };
7586
+ /**
7587
+ * Maximum width in image pixels. The value must be an integer.
7588
+ */
7589
+ width?: number;
7590
+ }
7591
+ declare function transformImage(url: string, ...transformations: ImageTransformations[]): string;
7592
+ declare function transformImage(url: string | undefined, ...transformations: ImageTransformations[]): string | undefined;
7593
+
7594
+ type XataFileEditableFields = Partial<Pick<XataArrayFile, keyof InputFileEntry>>;
7595
+ type XataFileFields = Partial<Pick<XataArrayFile, {
7596
+ [K in StringKeys<XataArrayFile>]: XataArrayFile[K] extends Function ? never : K;
7597
+ }[keyof XataArrayFile]>>;
7598
+ declare class XataFile {
7599
+ /**
7600
+ * Identifier of the file.
7601
+ */
7602
+ id?: string;
7603
+ /**
7604
+ * Name of the file.
7605
+ */
7606
+ name: string;
7607
+ /**
7608
+ * Media type of the file.
7609
+ */
7610
+ mediaType: string;
7611
+ /**
7612
+ * Base64 encoded content of the file.
7613
+ */
7614
+ base64Content?: string;
7615
+ /**
7616
+ * Whether to enable public url for the file.
7617
+ */
7618
+ enablePublicUrl: boolean;
7619
+ /**
7620
+ * Timeout for the signed url.
7621
+ */
7622
+ signedUrlTimeout: number;
7623
+ /**
7624
+ * Size of the file.
7625
+ */
7626
+ size?: number;
7627
+ /**
7628
+ * Version of the file.
7629
+ */
7630
+ version: number;
7631
+ /**
7632
+ * Url of the file.
7633
+ */
7634
+ url: string;
7635
+ /**
7636
+ * Signed url of the file.
7637
+ */
7638
+ signedUrl?: string;
7639
+ /**
7640
+ * Attributes of the file.
7641
+ */
7642
+ attributes: Record<string, any>;
7643
+ constructor(file: Partial<XataFile>);
7644
+ static fromBuffer(buffer: Buffer, options?: XataFileEditableFields): XataFile;
7645
+ toBuffer(): Buffer;
7646
+ static fromArrayBuffer(arrayBuffer: ArrayBuffer, options?: XataFileEditableFields): XataFile;
7647
+ toArrayBuffer(): ArrayBuffer;
7648
+ static fromUint8Array(uint8Array: Uint8Array, options?: XataFileEditableFields): XataFile;
7649
+ toUint8Array(): Uint8Array;
7650
+ static fromBlob(file: Blob, options?: XataFileEditableFields): Promise<XataFile>;
7651
+ toBlob(): Blob;
7652
+ static fromString(string: string, options?: XataFileEditableFields): XataFile;
7653
+ toString(): string;
7654
+ static fromBase64(base64Content: string, options?: XataFileEditableFields): XataFile;
7655
+ toBase64(): string;
7656
+ transform(...options: ImageTransformations[]): {
7657
+ url: string;
7658
+ signedUrl: string | undefined;
7659
+ metadataUrl: string;
7660
+ metadataSignedUrl: string | undefined;
7661
+ };
7662
+ }
7663
+ type XataArrayFile = Identifiable & XataFile;
7664
+
7665
+ type SelectableColumn<O, RecursivePath extends any[] = []> = '*' | 'id' | `xata.${'version' | 'createdAt' | 'updatedAt'}` | DataProps<O> | NestedColumns<O, RecursivePath>;
7666
+ type ExpandedColumnNotation = {
7667
+ name: string;
7668
+ columns?: SelectableColumn<any>[];
7669
+ as?: string;
7670
+ limit?: number;
7671
+ offset?: number;
7672
+ order?: {
7673
+ column: string;
7674
+ order: 'asc' | 'desc';
7675
+ }[];
7676
+ };
7677
+ type SelectableColumnWithObjectNotation<O, RecursivePath extends any[] = []> = SelectableColumn<O, RecursivePath> | ExpandedColumnNotation;
7678
+ declare function isValidExpandedColumn(column: any): column is ExpandedColumnNotation;
7679
+ declare function isValidSelectableColumns(columns: any): columns is SelectableColumn<any>[];
7680
+ type StringColumns<T> = T extends string ? T : never;
7681
+ type ProjectionColumns<T> = T extends string ? never : T extends {
7682
+ as: infer As;
7683
+ } ? NonNullable<As> extends string ? NonNullable<As> : never : never;
6208
7684
  type WildcardColumns<O> = Values<{
6209
7685
  [K in SelectableColumn<O>]: K extends `${string}*` ? K : never;
6210
7686
  }>;
6211
7687
  type ColumnsByValue<O, Value> = Values<{
6212
7688
  [K in SelectableColumn<O>]: ValueAtColumn<O, K> extends infer C ? C extends Value ? K extends WildcardColumns<O> ? never : K : never : never;
6213
7689
  }>;
6214
- type SelectedPick<O extends XataRecord, Key extends SelectableColumn<O>[]> = XataRecord<O> & UnionToIntersection<Values<{
6215
- [K in Key[number]]: NestedValueAtColumn<O, K> & XataRecord<O>;
7690
+ type SelectedPick<O extends XataRecord, Key extends SelectableColumnWithObjectNotation<O>[]> = XataRecord<O> & UnionToIntersection<Values<{
7691
+ [K in StringColumns<Key[number]>]: NestedValueAtColumn<O, K> & XataRecord<O>;
7692
+ }>> & UnionToIntersection<Values<{
7693
+ [K in ProjectionColumns<Key[number]>]: {
7694
+ [Key in K]: {
7695
+ records: (Record<string, any> & XataRecord<O>)[];
7696
+ };
7697
+ };
6216
7698
  }>>;
6217
- type ValueAtColumn<O, P extends SelectableColumn<O>> = P extends '*' ? Values<O> : P extends 'id' ? string : P extends keyof O ? O[P] : P extends `${infer K}.${infer V}` ? K extends keyof O ? Values<NonNullable<O[K]> extends infer Item ? Item extends Record<string, any> ? V extends SelectableColumn<Item> ? {
6218
- V: ValueAtColumn<Item, V>;
6219
- } : never : O[K] : never> : never : never;
6220
- type MAX_RECURSION = 2;
7699
+ type ValueAtColumn<Object, Key, RecursivePath extends any[] = []> = RecursivePath['length'] extends MAX_RECURSION ? never : Key extends '*' ? Values<Object> : Key extends 'id' ? string : Key extends 'xata.version' ? number : Key extends 'xata.createdAt' ? Date : Key extends 'xata.updatedAt' ? Date : Key extends keyof Object ? Object[Key] : Key extends `${infer K}.${infer V}` ? K extends keyof Object ? Values<NonNullable<Object[K]> extends infer Item ? Item extends Record<string, any> ? V extends SelectableColumn<Item> ? {
7700
+ V: ValueAtColumn<Item, V, [...RecursivePath, Item]>;
7701
+ } : never : Object[K] : never> : never : never;
7702
+ type MAX_RECURSION = 3;
6221
7703
  type NestedColumns<O, RecursivePath extends any[]> = RecursivePath['length'] extends MAX_RECURSION ? never : If<IsObject<O>, Values<{
6222
- [K in DataProps<O>]: NonNullable<O[K]> extends infer Item ? If<IsArray<Item>, K, // If the property is an array, we stop recursion. We don't support object arrays yet
6223
- If<IsObject<Item>, Item extends XataRecord ? SelectableColumn<Item, [...RecursivePath, Item]> extends infer Column ? Column extends string ? K | `${K}.${Column}` : never : never : Item extends Date ? K : `${K}.${StringKeys<Item> | '*'}`, // This allows usage of objects that are not links
7704
+ [K in DataProps<O>]: NonNullable<O[K]> extends infer Item ? If<IsArray<Item>, Item extends (infer Type)[] ? Type extends XataArrayFile ? K | `${K}.${keyof XataFileFields | '*'}` : K | `${K}.${StringKeys<Type> | '*'}` : never, If<IsObject<Item>, Item extends XataRecord ? SelectableColumn<Item, [...RecursivePath, Item]> extends infer Column ? Column extends string ? K | `${K}.${Column}` : never : never : Item extends Date ? K : Item extends XataFile ? K | `${K}.${keyof XataFileFields | '*'}` : `${K}.${StringKeys<Item> | '*'}`, // This allows usage of objects that are not links
6224
7705
  K>> : never;
6225
7706
  }>, never>;
6226
7707
  type DataProps<O> = Exclude<StringKeys<O>, StringKeys<XataRecord>>;
6227
7708
  type NestedValueAtColumn<O, Key extends SelectableColumn<O>> = Key extends `${infer N}.${infer M}` ? N extends DataProps<O> ? {
6228
- [K in N]: M extends SelectableColumn<NonNullable<O[K]>> ? NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M> & XataRecord> : ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M>> : unknown;
7709
+ [K in N]: M extends SelectableColumn<NonNullable<O[K]>> ? NonNullable<O[K]> extends XataFile ? ForwardNullable<O[K], XataFile> : NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M> & XataRecord> : ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M>> : NonNullable<O[K]> extends (infer ArrayType)[] ? ArrayType extends XataArrayFile ? ForwardNullable<O[K], XataArrayFile[]> : M extends SelectableColumn<NonNullable<ArrayType>> ? ForwardNullable<O[K], NestedValueAtColumn<NonNullable<ArrayType>, M>[]> : unknown : unknown;
6229
7710
  } : unknown : Key extends DataProps<O> ? {
6230
- [K in Key]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], SelectedPick<NonNullable<O[K]>, ['*']>> : O[K];
7711
+ [K in Key]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], Omit<SelectedPick<NonNullable<O[K]>, ['*']>, 'xata' | 'getMetadata'>> : O[K];
6231
7712
  } : Key extends '*' ? {
6232
7713
  [K in StringKeys<O>]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], Link<NonNullable<O[K]>>> : O[K];
6233
7714
  } : unknown;
6234
7715
  type ForwardNullable<T, R> = T extends NonNullable<T> ? R : R | null;
6235
7716
 
7717
+ declare const RecordColumnTypes: readonly ["bool", "int", "float", "string", "text", "email", "multiple", "link", "object", "datetime", "vector", "file[]", "file", "json"];
7718
+ type Identifier = string;
6236
7719
  /**
6237
7720
  * Represents an identifiable record from the database.
6238
7721
  */
@@ -6240,7 +7723,7 @@ interface Identifiable {
6240
7723
  /**
6241
7724
  * Unique id of this record.
6242
7725
  */
6243
- id: string;
7726
+ id: Identifier;
6244
7727
  }
6245
7728
  interface BaseData {
6246
7729
  [key: string]: any;
@@ -6249,8 +7732,13 @@ interface BaseData {
6249
7732
  * Represents a persisted record from the database.
6250
7733
  */
6251
7734
  interface XataRecord<OriginalRecord extends XataRecord<any> = XataRecord<any>> extends Identifiable {
7735
+ /**
7736
+ * Metadata of this record.
7737
+ */
7738
+ xata: XataRecordMetadata;
6252
7739
  /**
6253
7740
  * Get metadata of this record.
7741
+ * @deprecated Use `xata` property instead.
6254
7742
  */
6255
7743
  getMetadata(): XataRecordMetadata;
6256
7744
  /**
@@ -6329,7 +7817,14 @@ type XataRecordMetadata = {
6329
7817
  * Number that is increased every time the record is updated.
6330
7818
  */
6331
7819
  version: number;
6332
- warnings?: string[];
7820
+ /**
7821
+ * Timestamp when the record was created.
7822
+ */
7823
+ createdAt: Date;
7824
+ /**
7825
+ * Timestamp when the record was last updated.
7826
+ */
7827
+ updatedAt: Date;
6333
7828
  };
6334
7829
  declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
6335
7830
  declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;
@@ -6342,19 +7837,51 @@ type NumericOperator = ExclusiveOr<{
6342
7837
  }, {
6343
7838
  $divide?: number;
6344
7839
  }>>>;
7840
+ type InputXataFile = Partial<XataArrayFile> | Promise<Partial<XataArrayFile>>;
6345
7841
  type EditableDataFields<T> = T extends XataRecord ? {
6346
- id: string;
6347
- } | string : NonNullable<T> extends XataRecord ? {
6348
- id: string;
6349
- } | string | null | undefined : T extends Date ? string | Date : NonNullable<T> extends Date ? string | Date | null | undefined : T extends number ? number | NumericOperator : T;
7842
+ id: Identifier;
7843
+ } | Identifier : NonNullable<T> extends XataRecord ? {
7844
+ id: Identifier;
7845
+ } | Identifier | null | undefined : T extends Date ? string | Date : NonNullable<T> extends Date ? string | Date | null | undefined : T extends XataFile ? InputXataFile : T extends XataFile[] ? InputXataFile[] : T extends number ? number | NumericOperator : T;
6350
7846
  type EditableData<O extends XataRecord> = Identifiable & Partial<Omit<{
6351
7847
  [K in keyof O]: EditableDataFields<O[K]>;
6352
7848
  }, keyof XataRecord>>;
6353
- type JSONDataFields<T> = T extends XataRecord ? string : NonNullable<T> extends XataRecord ? string | null | undefined : T extends Date ? string : NonNullable<T> extends Date ? string | null | undefined : T;
6354
- type JSONData<O> = Identifiable & Partial<Omit<{
7849
+ type JSONDataFile = {
7850
+ [K in keyof XataFile]: XataFile[K] extends Function ? never : XataFile[K];
7851
+ };
7852
+ type JSONDataFields<T> = T extends XataFile ? JSONDataFile : NonNullable<T> extends XataFile ? JSONDataFile | null | undefined : T extends XataRecord ? JSONData<T> : NonNullable<T> extends XataRecord ? JSONData<T> | null | undefined : T extends Date ? string : NonNullable<T> extends Date ? string | null | undefined : T;
7853
+ type JSONDataBase = Identifiable & {
7854
+ /**
7855
+ * Metadata about the record.
7856
+ */
7857
+ xata: {
7858
+ /**
7859
+ * Timestamp when the record was created.
7860
+ */
7861
+ createdAt: string;
7862
+ /**
7863
+ * Timestamp when the record was last updated.
7864
+ */
7865
+ updatedAt: string;
7866
+ /**
7867
+ * Number that is increased every time the record is updated.
7868
+ */
7869
+ version: number;
7870
+ };
7871
+ };
7872
+ type JSONData<O> = JSONDataBase & Partial<Omit<{
6355
7873
  [K in keyof O]: JSONDataFields<O[K]>;
6356
7874
  }, keyof XataRecord>>;
6357
7875
 
7876
+ type JSONValue<Value> = Value & {
7877
+ __json: true;
7878
+ };
7879
+
7880
+ type JSONFilterColumns<Record> = Values<{
7881
+ [K in keyof Record]: NonNullable<Record[K]> extends JSONValue<any> ? K extends string ? `${K}->${string}` : never : never;
7882
+ }>;
7883
+ type FilterColumns<T> = ColumnsByValue<T, any> | `xata.${keyof XataRecordMetadata}`;
7884
+ type FilterValueAtColumn<Record, F> = NonNullable<ValueAtColumn<Record, F>> extends JSONValue<any> ? PropertyFilter<any> : Filter<NonNullable<ValueAtColumn<Record, F>>>;
6358
7885
  /**
6359
7886
  * PropertyMatchFilter
6360
7887
  * Example:
@@ -6374,7 +7901,9 @@ type JSONData<O> = Identifiable & Partial<Omit<{
6374
7901
  }
6375
7902
  */
6376
7903
  type PropertyAccessFilter<Record> = {
6377
- [key in ColumnsByValue<Record, any>]?: NestedApiFilter<ValueAtColumn<Record, key>> | PropertyFilter<ValueAtColumn<Record, key>>;
7904
+ [key in FilterColumns<Record>]?: NestedApiFilter<ValueAtColumn<Record, key>> | PropertyFilter<ValueAtColumn<Record, key>>;
7905
+ } & {
7906
+ [key in JSONFilterColumns<Record>]?: PropertyFilter<Record[keyof Record]>;
6378
7907
  };
6379
7908
  type PropertyFilter<T> = T | {
6380
7909
  $is: T;
@@ -6391,7 +7920,7 @@ type IncludesFilter<T> = PropertyFilter<T> | {
6391
7920
  }>;
6392
7921
  };
6393
7922
  type StringTypeFilter = {
6394
- [key in '$contains' | '$pattern' | '$startsWith' | '$endsWith']?: string;
7923
+ [key in '$contains' | '$iContains' | '$pattern' | '$iPattern' | '$startsWith' | '$endsWith']?: string;
6395
7924
  };
6396
7925
  type ComparableType = number | Date;
6397
7926
  type ComparableTypeFilter<T extends ComparableType> = {
@@ -6436,7 +7965,7 @@ type AggregatorFilter<T> = {
6436
7965
  * Example: { filter: { $exists: "settings" } }
6437
7966
  */
6438
7967
  type ExistanceFilter<Record> = {
6439
- [key in '$exists' | '$notExists']?: ColumnsByValue<Record, any>;
7968
+ [key in '$exists' | '$notExists']?: FilterColumns<Record>;
6440
7969
  };
6441
7970
  type BaseApiFilter<Record> = PropertyAccessFilter<Record> | AggregatorFilter<Record> | ExistanceFilter<Record>;
6442
7971
  /**
@@ -6453,6 +7982,12 @@ type DateBooster = {
6453
7982
  origin?: string;
6454
7983
  scale: string;
6455
7984
  decay: number;
7985
+ /**
7986
+ * The factor with which to multiply the added boost.
7987
+ *
7988
+ * @minimum 0
7989
+ */
7990
+ factor?: number;
6456
7991
  };
6457
7992
  type NumericBooster = {
6458
7993
  factor: number;
@@ -6554,15 +8089,20 @@ type SearchOptions<Schemas extends Record<string, BaseData>, Tables extends Stri
6554
8089
  }>>;
6555
8090
  page?: SearchPageConfig;
6556
8091
  };
8092
+ type TotalCount = Pick<SearchResponse, 'totalCount'>;
6557
8093
  type SearchPluginResult<Schemas extends Record<string, BaseData>> = {
6558
- all: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<Values<{
6559
- [Model in ExtractTables<Schemas, Tables, GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>>]: {
6560
- table: Model;
6561
- record: Awaited<SearchXataRecord<SelectedPick<Schemas[Model] & XataRecord, ['*']>>>;
8094
+ all: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<TotalCount & {
8095
+ records: Values<{
8096
+ [Model in ExtractTables<Schemas, Tables, GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>>]: {
8097
+ table: Model;
8098
+ record: Awaited<SearchXataRecord<SelectedPick<Schemas[Model] & XataRecord, ['*']>>>;
8099
+ };
8100
+ }>[];
8101
+ }>;
8102
+ byTable: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<TotalCount & {
8103
+ records: {
8104
+ [Model in ExtractTables<Schemas, Tables, GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>>]?: Awaited<SearchXataRecord<SelectedPick<Schemas[Model] & XataRecord, ['*']>>[]>;
6562
8105
  };
6563
- }>[]>;
6564
- byTable: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<{
6565
- [Model in ExtractTables<Schemas, Tables, GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>>]?: Awaited<SearchXataRecord<SelectedPick<Schemas[Model] & XataRecord, ['*']>>[]>;
6566
8106
  }>;
6567
8107
  };
6568
8108
  declare class SearchPlugin<Schemas extends Record<string, XataRecord>> extends XataPlugin {
@@ -6597,6 +8137,7 @@ type AggregationExpression<O extends XataRecord> = ExactlyOne<{
6597
8137
  max: MaxAggregation<O>;
6598
8138
  min: MinAggregation<O>;
6599
8139
  average: AverageAggregation<O>;
8140
+ percentiles: PercentilesAggregation<O>;
6600
8141
  uniqueCount: UniqueCountAggregation<O>;
6601
8142
  dateHistogram: DateHistogramAggregation<O>;
6602
8143
  topValues: TopValuesAggregation<O>;
@@ -6651,6 +8192,16 @@ type AverageAggregation<O extends XataRecord> = {
6651
8192
  */
6652
8193
  column: ColumnsByValue<O, number>;
6653
8194
  };
8195
+ /**
8196
+ * Calculate given percentiles of the numeric values in a particular column.
8197
+ */
8198
+ type PercentilesAggregation<O extends XataRecord> = {
8199
+ /**
8200
+ * The column on which to compute the average. Must be a numeric type.
8201
+ */
8202
+ column: ColumnsByValue<O, number>;
8203
+ percentiles: number[];
8204
+ };
6654
8205
  /**
6655
8206
  * Count the number of distinct values in a particular column.
6656
8207
  */
@@ -6746,6 +8297,11 @@ type AggregationExpressionResultTypes = {
6746
8297
  max: number | null;
6747
8298
  min: number | null;
6748
8299
  average: number | null;
8300
+ percentiles: {
8301
+ values: {
8302
+ [key: string]: number;
8303
+ };
8304
+ };
6749
8305
  uniqueCount: number;
6750
8306
  dateHistogram: ComplexAggregationResult;
6751
8307
  topValues: ComplexAggregationResult;
@@ -6760,7 +8316,7 @@ type ComplexAggregationResult = {
6760
8316
  };
6761
8317
 
6762
8318
  type KeywordAskOptions<Record extends XataRecord> = {
6763
- searchType: 'keyword';
8319
+ searchType?: 'keyword';
6764
8320
  search?: {
6765
8321
  fuzziness?: FuzzinessExpression;
6766
8322
  target?: TargetColumn<Record>[];
@@ -6770,7 +8326,7 @@ type KeywordAskOptions<Record extends XataRecord> = {
6770
8326
  };
6771
8327
  };
6772
8328
  type VectorAskOptions<Record extends XataRecord> = {
6773
- searchType: 'vector';
8329
+ searchType?: 'vector';
6774
8330
  vectorSearch?: {
6775
8331
  /**
6776
8332
  * The column to use for vector search. It must be of type `vector`.
@@ -6786,20 +8342,30 @@ type VectorAskOptions<Record extends XataRecord> = {
6786
8342
  type TypeAskOptions<Record extends XataRecord> = KeywordAskOptions<Record> | VectorAskOptions<Record>;
6787
8343
  type BaseAskOptions = {
6788
8344
  rules?: string[];
8345
+ sessionId?: string;
6789
8346
  };
6790
8347
  type AskOptions<Record extends XataRecord> = TypeAskOptions<Record> & BaseAskOptions;
6791
8348
  type AskResult = {
6792
8349
  answer?: string;
6793
8350
  records?: string[];
8351
+ sessionId?: string;
6794
8352
  };
6795
8353
 
6796
8354
  type SortDirection = 'asc' | 'desc';
6797
- type SortFilterExtended<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = {
8355
+ type RandomFilter = {
8356
+ '*': 'random';
8357
+ };
8358
+ type RandomFilterExtended = {
8359
+ column: '*';
8360
+ direction: 'random';
8361
+ };
8362
+ type SortColumns<T extends XataRecord> = ColumnsByValue<T, any> | `xata.${keyof XataRecordMetadata}`;
8363
+ type SortFilterExtended<T extends XataRecord, Columns extends string = SortColumns<T>> = RandomFilterExtended | {
6798
8364
  column: Columns;
6799
8365
  direction?: SortDirection;
6800
8366
  };
6801
- type SortFilter<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = Columns | SortFilterExtended<T, Columns> | SortFilterBase<T, Columns>;
6802
- type SortFilterBase<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = Values<{
8367
+ type SortFilter<T extends XataRecord, Columns extends string = SortColumns<T>> = Columns | SortFilterExtended<T, Columns> | SortFilterBase<T, Columns> | RandomFilter;
8368
+ type SortFilterBase<T extends XataRecord, Columns extends string = SortColumns<T>> = Values<{
6803
8369
  [Key in Columns]: {
6804
8370
  [K in Key]: SortDirection;
6805
8371
  };
@@ -6841,7 +8407,7 @@ type SummarizeFilter<Record extends XataRecord, Expression extends Dictionary<Su
6841
8407
  type SummarizeResultItem<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>, Columns extends SelectableColumn<Record>[]> = SummarizeValuePick<Record, Expression> & SelectedPick<Record, Columns>;
6842
8408
 
6843
8409
  type BaseOptions<T extends XataRecord> = {
6844
- columns?: SelectableColumn<T>[];
8410
+ columns?: SelectableColumnWithObjectNotation<T>[];
6845
8411
  consistency?: 'strong' | 'eventual';
6846
8412
  cache?: number;
6847
8413
  fetchOptions?: Record<string, unknown>;
@@ -6909,7 +8475,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
6909
8475
  * @param value The value to filter.
6910
8476
  * @returns A new Query object.
6911
8477
  */
6912
- filter<F extends SelectableColumn<Record>>(column: F, value: Filter<NonNullable<ValueAtColumn<Record, F>>>): Query<Record, Result>;
8478
+ filter<F extends FilterColumns<Record> | JSONFilterColumns<Record>>(column: F, value: FilterValueAtColumn<Record, F>): Query<Record, Result>;
6913
8479
  /**
6914
8480
  * Builds a new query object adding one or more constraints. Examples:
6915
8481
  *
@@ -6930,13 +8496,15 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
6930
8496
  * @param direction The direction. Either ascending or descending.
6931
8497
  * @returns A new Query object.
6932
8498
  */
6933
- sort<F extends ColumnsByValue<Record, any>>(column: F, direction?: SortDirection): Query<Record, Result>;
8499
+ sort<F extends SortColumns<Record>>(column: F, direction: SortDirection): Query<Record, Result>;
8500
+ sort(column: '*', direction: 'random'): Query<Record, Result>;
8501
+ sort<F extends SortColumns<Record>>(column: F): Query<Record, Result>;
6934
8502
  /**
6935
8503
  * Builds a new query specifying the set of columns to be returned in the query response.
6936
8504
  * @param columns Array of column names to be returned by the query.
6937
8505
  * @returns A new Query object.
6938
8506
  */
6939
- select<K extends SelectableColumn<Record>>(columns: K[]): Query<Record, SelectedPick<Record, K[]>>;
8507
+ select<K extends SelectableColumnWithObjectNotation<Record>>(columns: K[]): Query<Record, SelectedPick<Record, K[]>>;
6940
8508
  /**
6941
8509
  * Get paginated results
6942
8510
  *
@@ -6956,7 +8524,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
6956
8524
  * @param options Pagination options
6957
8525
  * @returns A page of results
6958
8526
  */
6959
- getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, typeof options['columns']>>>;
8527
+ getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, (typeof options)['columns']>>>;
6960
8528
  /**
6961
8529
  * Get results in an iterator
6962
8530
  *
@@ -6987,7 +8555,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
6987
8555
  */
6988
8556
  getIterator<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
6989
8557
  batchSize?: number;
6990
- }>(options: Options): AsyncGenerator<SelectedPick<Record, typeof options['columns']>[]>;
8558
+ }>(options: Options): AsyncGenerator<SelectedPick<Record, (typeof options)['columns']>[]>;
6991
8559
  /**
6992
8560
  * Performs the query in the database and returns a set of results.
6993
8561
  * @returns An array of records from the database.
@@ -6998,7 +8566,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
6998
8566
  * @param options Additional options to be used when performing the query.
6999
8567
  * @returns An array of records from the database.
7000
8568
  */
7001
- getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<RecordArray<SelectedPick<Record, typeof options['columns']>>>;
8569
+ getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<RecordArray<SelectedPick<Record, (typeof options)['columns']>>>;
7002
8570
  /**
7003
8571
  * Performs the query in the database and returns a set of results.
7004
8572
  * @param options Additional options to be used when performing the query.
@@ -7019,7 +8587,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
7019
8587
  */
7020
8588
  getAll<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
7021
8589
  batchSize?: number;
7022
- }>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
8590
+ }>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']>[]>;
7023
8591
  /**
7024
8592
  * Performs the query in the database and returns all the results.
7025
8593
  * Warning: If there are a large number of results, this method can have performance implications.
@@ -7039,7 +8607,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
7039
8607
  * @param options Additional options to be used when performing the query.
7040
8608
  * @returns The first record that matches the query, or null if no record matched the query.
7041
8609
  */
7042
- getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']> | null>;
8610
+ getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']> | null>;
7043
8611
  /**
7044
8612
  * Performs the query in the database and returns the first result.
7045
8613
  * @param options Additional options to be used when performing the query.
@@ -7058,7 +8626,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
7058
8626
  * @returns The first record that matches the query, or null if no record matched the query.
7059
8627
  * @throws if there are no results.
7060
8628
  */
7061
- getFirstOrThrow<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>>;
8629
+ getFirstOrThrow<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']>>;
7062
8630
  /**
7063
8631
  * Performs the query in the database and returns the first result.
7064
8632
  * @param options Additional options to be used when performing the query.
@@ -7107,6 +8675,7 @@ type PaginationQueryMeta = {
7107
8675
  page: {
7108
8676
  cursor: string;
7109
8677
  more: boolean;
8678
+ size: number;
7110
8679
  };
7111
8680
  };
7112
8681
  interface Paginable<Record extends XataRecord, Result extends XataRecord = Record> {
@@ -7179,9 +8748,9 @@ type OffsetNavigationOptions = {
7179
8748
  size?: number;
7180
8749
  offset?: number;
7181
8750
  };
7182
- declare const PAGINATION_MAX_SIZE = 200;
8751
+ declare const PAGINATION_MAX_SIZE = 1000;
7183
8752
  declare const PAGINATION_DEFAULT_SIZE = 20;
7184
- declare const PAGINATION_MAX_OFFSET = 800;
8753
+ declare const PAGINATION_MAX_OFFSET = 49000;
7185
8754
  declare const PAGINATION_DEFAULT_OFFSET = 0;
7186
8755
  declare function isCursorPaginationOptions(options: Record<string, unknown> | undefined | null): options is CursorNavigationOptions;
7187
8756
  declare class RecordArray<Result extends XataRecord> extends Array<Result> {
@@ -7239,7 +8808,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7239
8808
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7240
8809
  * @returns The full persisted record.
7241
8810
  */
7242
- abstract create<K extends SelectableColumn<Record>>(id: string, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
8811
+ abstract create<K extends SelectableColumn<Record>>(id: Identifier, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
7243
8812
  ifVersion?: number;
7244
8813
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7245
8814
  /**
@@ -7248,7 +8817,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7248
8817
  * @param object Object containing the column names with their values to be stored in the table.
7249
8818
  * @returns The full persisted record.
7250
8819
  */
7251
- abstract create(id: string, object: Omit<EditableData<Record>, 'id'>, options?: {
8820
+ abstract create(id: Identifier, object: Omit<EditableData<Record>, 'id'>, options?: {
7252
8821
  ifVersion?: number;
7253
8822
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7254
8823
  /**
@@ -7270,26 +8839,26 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7270
8839
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7271
8840
  * @returns The persisted record for the given id or null if the record could not be found.
7272
8841
  */
7273
- abstract read<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
8842
+ abstract read<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
7274
8843
  /**
7275
8844
  * Queries a single record from the table given its unique id.
7276
8845
  * @param id The unique id.
7277
8846
  * @returns The persisted record for the given id or null if the record could not be found.
7278
8847
  */
7279
- abstract read(id: string): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
8848
+ abstract read(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
7280
8849
  /**
7281
8850
  * Queries multiple records from the table given their unique id.
7282
8851
  * @param ids The unique ids array.
7283
8852
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7284
8853
  * @returns The persisted records for the given ids in order (if a record could not be found null is returned).
7285
8854
  */
7286
- abstract read<K extends SelectableColumn<Record>>(ids: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
8855
+ abstract read<K extends SelectableColumn<Record>>(ids: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
7287
8856
  /**
7288
8857
  * Queries multiple records from the table given their unique id.
7289
8858
  * @param ids The unique ids array.
7290
8859
  * @returns The persisted records for the given ids in order (if a record could not be found null is returned).
7291
8860
  */
7292
- abstract read(ids: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
8861
+ abstract read(ids: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
7293
8862
  /**
7294
8863
  * Queries a single record from the table by the id in the object.
7295
8864
  * @param object Object containing the id of the record.
@@ -7323,14 +8892,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7323
8892
  * @returns The persisted record for the given id.
7324
8893
  * @throws If the record could not be found.
7325
8894
  */
7326
- abstract readOrThrow<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
8895
+ abstract readOrThrow<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7327
8896
  /**
7328
8897
  * Queries a single record from the table given its unique id.
7329
8898
  * @param id The unique id.
7330
8899
  * @returns The persisted record for the given id.
7331
8900
  * @throws If the record could not be found.
7332
8901
  */
7333
- abstract readOrThrow(id: string): Promise<Readonly<SelectedPick<Record, ['*']>>>;
8902
+ abstract readOrThrow(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7334
8903
  /**
7335
8904
  * Queries multiple records from the table given their unique id.
7336
8905
  * @param ids The unique ids array.
@@ -7338,14 +8907,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7338
8907
  * @returns The persisted records for the given ids in order.
7339
8908
  * @throws If one or more records could not be found.
7340
8909
  */
7341
- abstract readOrThrow<K extends SelectableColumn<Record>>(ids: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
8910
+ abstract readOrThrow<K extends SelectableColumn<Record>>(ids: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
7342
8911
  /**
7343
8912
  * Queries multiple records from the table given their unique id.
7344
8913
  * @param ids The unique ids array.
7345
8914
  * @returns The persisted records for the given ids in order.
7346
8915
  * @throws If one or more records could not be found.
7347
8916
  */
7348
- abstract readOrThrow(ids: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
8917
+ abstract readOrThrow(ids: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
7349
8918
  /**
7350
8919
  * Queries a single record from the table by the id in the object.
7351
8920
  * @param object Object containing the id of the record.
@@ -7400,7 +8969,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7400
8969
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7401
8970
  * @returns The full persisted record, null if the record could not be found.
7402
8971
  */
7403
- abstract update<K extends SelectableColumn<Record>>(id: string, object: Partial<EditableData<Record>>, columns: K[], options?: {
8972
+ abstract update<K extends SelectableColumn<Record>>(id: Identifier, object: Partial<EditableData<Record>>, columns: K[], options?: {
7404
8973
  ifVersion?: number;
7405
8974
  }): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
7406
8975
  /**
@@ -7409,7 +8978,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7409
8978
  * @param object The column names and their values that have to be updated.
7410
8979
  * @returns The full persisted record, null if the record could not be found.
7411
8980
  */
7412
- abstract update(id: string, object: Partial<EditableData<Record>>, options?: {
8981
+ abstract update(id: Identifier, object: Partial<EditableData<Record>>, options?: {
7413
8982
  ifVersion?: number;
7414
8983
  }): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
7415
8984
  /**
@@ -7452,7 +9021,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7452
9021
  * @returns The full persisted record.
7453
9022
  * @throws If the record could not be found.
7454
9023
  */
7455
- abstract updateOrThrow<K extends SelectableColumn<Record>>(id: string, object: Partial<EditableData<Record>>, columns: K[], options?: {
9024
+ abstract updateOrThrow<K extends SelectableColumn<Record>>(id: Identifier, object: Partial<EditableData<Record>>, columns: K[], options?: {
7456
9025
  ifVersion?: number;
7457
9026
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7458
9027
  /**
@@ -7462,7 +9031,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7462
9031
  * @returns The full persisted record.
7463
9032
  * @throws If the record could not be found.
7464
9033
  */
7465
- abstract updateOrThrow(id: string, object: Partial<EditableData<Record>>, options?: {
9034
+ abstract updateOrThrow(id: Identifier, object: Partial<EditableData<Record>>, options?: {
7466
9035
  ifVersion?: number;
7467
9036
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7468
9037
  /**
@@ -7487,7 +9056,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7487
9056
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7488
9057
  * @returns The full persisted record.
7489
9058
  */
7490
- abstract createOrUpdate<K extends SelectableColumn<Record>>(object: EditableData<Record> & Identifiable, columns: K[], options?: {
9059
+ abstract createOrUpdate<K extends SelectableColumn<Record>>(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, columns: K[], options?: {
7491
9060
  ifVersion?: number;
7492
9061
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7493
9062
  /**
@@ -7496,7 +9065,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7496
9065
  * @param object Object containing the column names with their values to be persisted in the table.
7497
9066
  * @returns The full persisted record.
7498
9067
  */
7499
- abstract createOrUpdate(object: EditableData<Record> & Identifiable, options?: {
9068
+ abstract createOrUpdate(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, options?: {
7500
9069
  ifVersion?: number;
7501
9070
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7502
9071
  /**
@@ -7507,7 +9076,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7507
9076
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7508
9077
  * @returns The full persisted record.
7509
9078
  */
7510
- abstract createOrUpdate<K extends SelectableColumn<Record>>(id: string, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
9079
+ abstract createOrUpdate<K extends SelectableColumn<Record>>(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
7511
9080
  ifVersion?: number;
7512
9081
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7513
9082
  /**
@@ -7517,7 +9086,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7517
9086
  * @param object The column names and the values to be persisted.
7518
9087
  * @returns The full persisted record.
7519
9088
  */
7520
- abstract createOrUpdate(id: string, object: Omit<EditableData<Record>, 'id'>, options?: {
9089
+ abstract createOrUpdate(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, options?: {
7521
9090
  ifVersion?: number;
7522
9091
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7523
9092
  /**
@@ -7527,14 +9096,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7527
9096
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7528
9097
  * @returns Array of the persisted records.
7529
9098
  */
7530
- abstract createOrUpdate<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
9099
+ abstract createOrUpdate<K extends SelectableColumn<Record>>(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
7531
9100
  /**
7532
9101
  * Creates or updates a single record. If a record exists with the given id,
7533
9102
  * it will be partially updated, otherwise a new record will be created.
7534
9103
  * @param objects Array of objects with the column names and the values to be stored in the table.
7535
9104
  * @returns Array of the persisted records.
7536
9105
  */
7537
- abstract createOrUpdate(objects: Array<EditableData<Record> & Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
9106
+ abstract createOrUpdate(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
7538
9107
  /**
7539
9108
  * Creates or replaces a single record. If a record exists with the given id,
7540
9109
  * it will be replaced, otherwise a new record will be created.
@@ -7542,7 +9111,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7542
9111
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7543
9112
  * @returns The full persisted record.
7544
9113
  */
7545
- abstract createOrReplace<K extends SelectableColumn<Record>>(object: EditableData<Record> & Identifiable, columns: K[], options?: {
9114
+ abstract createOrReplace<K extends SelectableColumn<Record>>(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, columns: K[], options?: {
7546
9115
  ifVersion?: number;
7547
9116
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7548
9117
  /**
@@ -7551,7 +9120,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7551
9120
  * @param object Object containing the column names with their values to be persisted in the table.
7552
9121
  * @returns The full persisted record.
7553
9122
  */
7554
- abstract createOrReplace(object: EditableData<Record> & Identifiable, options?: {
9123
+ abstract createOrReplace(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, options?: {
7555
9124
  ifVersion?: number;
7556
9125
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7557
9126
  /**
@@ -7562,7 +9131,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7562
9131
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7563
9132
  * @returns The full persisted record.
7564
9133
  */
7565
- abstract createOrReplace<K extends SelectableColumn<Record>>(id: string, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
9134
+ abstract createOrReplace<K extends SelectableColumn<Record>>(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
7566
9135
  ifVersion?: number;
7567
9136
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7568
9137
  /**
@@ -7572,7 +9141,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7572
9141
  * @param object The column names and the values to be persisted.
7573
9142
  * @returns The full persisted record.
7574
9143
  */
7575
- abstract createOrReplace(id: string, object: Omit<EditableData<Record>, 'id'>, options?: {
9144
+ abstract createOrReplace(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, options?: {
7576
9145
  ifVersion?: number;
7577
9146
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7578
9147
  /**
@@ -7582,14 +9151,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7582
9151
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7583
9152
  * @returns Array of the persisted records.
7584
9153
  */
7585
- abstract createOrReplace<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
9154
+ abstract createOrReplace<K extends SelectableColumn<Record>>(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
7586
9155
  /**
7587
9156
  * Creates or replaces a single record. If a record exists with the given id,
7588
9157
  * it will be replaced, otherwise a new record will be created.
7589
9158
  * @param objects Array of objects with the column names and the values to be stored in the table.
7590
9159
  * @returns Array of the persisted records.
7591
9160
  */
7592
- abstract createOrReplace(objects: Array<EditableData<Record> & Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
9161
+ abstract createOrReplace(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
7593
9162
  /**
7594
9163
  * Deletes a record given its unique id.
7595
9164
  * @param object An object with a unique id.
@@ -7609,13 +9178,13 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7609
9178
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7610
9179
  * @returns The deleted record, null if the record could not be found.
7611
9180
  */
7612
- abstract delete<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
9181
+ abstract delete<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
7613
9182
  /**
7614
9183
  * Deletes a record given a unique id.
7615
9184
  * @param id The unique id.
7616
9185
  * @returns The deleted record, null if the record could not be found.
7617
9186
  */
7618
- abstract delete(id: string): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
9187
+ abstract delete(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
7619
9188
  /**
7620
9189
  * Deletes multiple records given an array of objects with ids.
7621
9190
  * @param objects An array of objects with unique ids.
@@ -7635,13 +9204,13 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7635
9204
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7636
9205
  * @returns Array of the deleted records in order (if a record could not be found null is returned).
7637
9206
  */
7638
- abstract delete<K extends SelectableColumn<Record>>(objects: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
9207
+ abstract delete<K extends SelectableColumn<Record>>(objects: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
7639
9208
  /**
7640
9209
  * Deletes multiple records given an array of unique ids.
7641
9210
  * @param objects An array of ids.
7642
9211
  * @returns Array of the deleted records in order (if a record could not be found null is returned).
7643
9212
  */
7644
- abstract delete(objects: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
9213
+ abstract delete(objects: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
7645
9214
  /**
7646
9215
  * Deletes a record given its unique id.
7647
9216
  * @param object An object with a unique id.
@@ -7664,14 +9233,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7664
9233
  * @returns The deleted record, null if the record could not be found.
7665
9234
  * @throws If the record could not be found.
7666
9235
  */
7667
- abstract deleteOrThrow<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
9236
+ abstract deleteOrThrow<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7668
9237
  /**
7669
9238
  * Deletes a record given a unique id.
7670
9239
  * @param id The unique id.
7671
9240
  * @returns The deleted record, null if the record could not be found.
7672
9241
  * @throws If the record could not be found.
7673
9242
  */
7674
- abstract deleteOrThrow(id: string): Promise<Readonly<SelectedPick<Record, ['*']>>>;
9243
+ abstract deleteOrThrow(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7675
9244
  /**
7676
9245
  * Deletes multiple records given an array of objects with ids.
7677
9246
  * @param objects An array of objects with unique ids.
@@ -7694,14 +9263,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7694
9263
  * @returns Array of the deleted records in order (if a record could not be found null is returned).
7695
9264
  * @throws If one or more records could not be found.
7696
9265
  */
7697
- abstract deleteOrThrow<K extends SelectableColumn<Record>>(objects: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
9266
+ abstract deleteOrThrow<K extends SelectableColumn<Record>>(objects: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
7698
9267
  /**
7699
9268
  * Deletes multiple records given an array of unique ids.
7700
9269
  * @param objects An array of ids.
7701
9270
  * @returns Array of the deleted records in order.
7702
9271
  * @throws If one or more records could not be found.
7703
9272
  */
7704
- abstract deleteOrThrow(objects: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
9273
+ abstract deleteOrThrow(objects: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
7705
9274
  /**
7706
9275
  * Search for records in the table.
7707
9276
  * @param query The query to search for.
@@ -7716,7 +9285,9 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7716
9285
  boosters?: Boosters<Record>[];
7717
9286
  page?: SearchPageConfig;
7718
9287
  target?: TargetColumn<Record>[];
7719
- }): Promise<SearchXataRecord<SelectedPick<Record, ['*']>>[]>;
9288
+ }): Promise<{
9289
+ records: SearchXataRecord<SelectedPick<Record, ['*']>>[];
9290
+ } & TotalCount>;
7720
9291
  /**
7721
9292
  * Search for vectors in the table.
7722
9293
  * @param column The column to search for.
@@ -7740,7 +9311,9 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7740
9311
  */
7741
9312
  size?: number;
7742
9313
  filter?: Filter<Record>;
7743
- }): Promise<SearchXataRecord<SelectedPick<Record, ['*']>>[]>;
9314
+ }): Promise<{
9315
+ records: SearchXataRecord<SelectedPick<Record, ['*']>>[];
9316
+ } & TotalCount>;
7744
9317
  /**
7745
9318
  * Aggregates records in the table.
7746
9319
  * @param expression The aggregations to perform.
@@ -7752,6 +9325,10 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7752
9325
  * Experimental: Ask the database to perform a natural language question.
7753
9326
  */
7754
9327
  abstract ask(question: string, options?: AskOptions<Record>): Promise<AskResult>;
9328
+ /**
9329
+ * Experimental: Ask the database to perform a natural language question.
9330
+ */
9331
+ abstract ask(question: string, options: AskOptions<Record>): Promise<AskResult>;
7755
9332
  /**
7756
9333
  * Experimental: Ask the database to perform a natural language question.
7757
9334
  */
@@ -7774,26 +9351,26 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
7774
9351
  create(object: EditableData<Record> & Partial<Identifiable>, options?: {
7775
9352
  ifVersion?: number;
7776
9353
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7777
- create<K extends SelectableColumn<Record>>(id: string, object: EditableData<Record>, columns: K[], options?: {
9354
+ create<K extends SelectableColumn<Record>>(id: Identifier, object: EditableData<Record>, columns: K[], options?: {
7778
9355
  ifVersion?: number;
7779
9356
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7780
- create(id: string, object: EditableData<Record>, options?: {
9357
+ create(id: Identifier, object: EditableData<Record>, options?: {
7781
9358
  ifVersion?: number;
7782
9359
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7783
9360
  create<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
7784
9361
  create(objects: Array<EditableData<Record> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
7785
- read<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
9362
+ read<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
7786
9363
  read(id: string): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
7787
- read<K extends SelectableColumn<Record>>(ids: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
7788
- read(ids: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
9364
+ read<K extends SelectableColumn<Record>>(ids: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
9365
+ read(ids: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
7789
9366
  read<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
7790
9367
  read(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
7791
9368
  read<K extends SelectableColumn<Record>>(objects: Identifiable[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
7792
9369
  read(objects: Identifiable[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
7793
- readOrThrow<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7794
- readOrThrow(id: string): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7795
- readOrThrow<K extends SelectableColumn<Record>>(ids: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
7796
- readOrThrow(ids: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
9370
+ readOrThrow<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
9371
+ readOrThrow(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>>>;
9372
+ readOrThrow<K extends SelectableColumn<Record>>(ids: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
9373
+ readOrThrow(ids: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
7797
9374
  readOrThrow<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7798
9375
  readOrThrow(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7799
9376
  readOrThrow<K extends SelectableColumn<Record>>(objects: Identifiable[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
@@ -7804,10 +9381,10 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
7804
9381
  update(object: Partial<EditableData<Record>> & Identifiable, options?: {
7805
9382
  ifVersion?: number;
7806
9383
  }): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
7807
- update<K extends SelectableColumn<Record>>(id: string, object: Partial<EditableData<Record>>, columns: K[], options?: {
9384
+ update<K extends SelectableColumn<Record>>(id: Identifier, object: Partial<EditableData<Record>>, columns: K[], options?: {
7808
9385
  ifVersion?: number;
7809
9386
  }): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
7810
- update(id: string, object: Partial<EditableData<Record>>, options?: {
9387
+ update(id: Identifier, object: Partial<EditableData<Record>>, options?: {
7811
9388
  ifVersion?: number;
7812
9389
  }): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
7813
9390
  update<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
@@ -7818,58 +9395,58 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
7818
9395
  updateOrThrow(object: Partial<EditableData<Record>> & Identifiable, options?: {
7819
9396
  ifVersion?: number;
7820
9397
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7821
- updateOrThrow<K extends SelectableColumn<Record>>(id: string, object: Partial<EditableData<Record>>, columns: K[], options?: {
9398
+ updateOrThrow<K extends SelectableColumn<Record>>(id: Identifier, object: Partial<EditableData<Record>>, columns: K[], options?: {
7822
9399
  ifVersion?: number;
7823
9400
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7824
- updateOrThrow(id: string, object: Partial<EditableData<Record>>, options?: {
9401
+ updateOrThrow(id: Identifier, object: Partial<EditableData<Record>>, options?: {
7825
9402
  ifVersion?: number;
7826
9403
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7827
9404
  updateOrThrow<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
7828
9405
  updateOrThrow(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
7829
- createOrUpdate<K extends SelectableColumn<Record>>(object: EditableData<Record> & Identifiable, columns: K[], options?: {
9406
+ createOrUpdate<K extends SelectableColumn<Record>>(object: EditableData<Record> & Partial<Identifiable>, columns: K[], options?: {
7830
9407
  ifVersion?: number;
7831
9408
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7832
- createOrUpdate(object: EditableData<Record> & Identifiable, options?: {
9409
+ createOrUpdate(object: EditableData<Record> & Partial<Identifiable>, options?: {
7833
9410
  ifVersion?: number;
7834
9411
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7835
- createOrUpdate<K extends SelectableColumn<Record>>(id: string, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
9412
+ createOrUpdate<K extends SelectableColumn<Record>>(id: Identifier, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
7836
9413
  ifVersion?: number;
7837
9414
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7838
- createOrUpdate(id: string, object: Omit<EditableData<Record>, 'id'>, options?: {
9415
+ createOrUpdate(id: Identifier, object: Omit<EditableData<Record>, 'id'>, options?: {
7839
9416
  ifVersion?: number;
7840
9417
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7841
- createOrUpdate<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
7842
- createOrUpdate(objects: Array<EditableData<Record> & Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
7843
- createOrReplace<K extends SelectableColumn<Record>>(object: EditableData<Record> & Identifiable, columns: K[], options?: {
9418
+ createOrUpdate<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
9419
+ createOrUpdate(objects: Array<EditableData<Record> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
9420
+ createOrReplace<K extends SelectableColumn<Record>>(object: EditableData<Record> & Partial<Identifiable>, columns: K[], options?: {
7844
9421
  ifVersion?: number;
7845
9422
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7846
- createOrReplace(object: EditableData<Record> & Identifiable, options?: {
9423
+ createOrReplace(object: EditableData<Record> & Partial<Identifiable>, options?: {
7847
9424
  ifVersion?: number;
7848
9425
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7849
- createOrReplace<K extends SelectableColumn<Record>>(id: string, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
9426
+ createOrReplace<K extends SelectableColumn<Record>>(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
7850
9427
  ifVersion?: number;
7851
9428
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7852
- createOrReplace(id: string, object: Omit<EditableData<Record>, 'id'>, options?: {
9429
+ createOrReplace(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, options?: {
7853
9430
  ifVersion?: number;
7854
9431
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7855
- createOrReplace<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
7856
- createOrReplace(objects: Array<EditableData<Record> & Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
9432
+ createOrReplace<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
9433
+ createOrReplace(objects: Array<EditableData<Record> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
7857
9434
  delete<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
7858
9435
  delete(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
7859
- delete<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
7860
- delete(id: string): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
9436
+ delete<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
9437
+ delete(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
7861
9438
  delete<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
7862
9439
  delete(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
7863
- delete<K extends SelectableColumn<Record>>(objects: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
7864
- delete(objects: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
9440
+ delete<K extends SelectableColumn<Record>>(objects: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
9441
+ delete(objects: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
7865
9442
  deleteOrThrow<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7866
9443
  deleteOrThrow(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7867
- deleteOrThrow<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7868
- deleteOrThrow(id: string): Promise<Readonly<SelectedPick<Record, ['*']>>>;
9444
+ deleteOrThrow<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
9445
+ deleteOrThrow(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7869
9446
  deleteOrThrow<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
7870
9447
  deleteOrThrow(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
7871
- deleteOrThrow<K extends SelectableColumn<Record>>(objects: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
7872
- deleteOrThrow(objects: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
9448
+ deleteOrThrow<K extends SelectableColumn<Record>>(objects: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
9449
+ deleteOrThrow(objects: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
7873
9450
  search(query: string, options?: {
7874
9451
  fuzziness?: FuzzinessExpression;
7875
9452
  prefix?: PrefixExpression;
@@ -7878,15 +9455,22 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
7878
9455
  boosters?: Boosters<Record>[];
7879
9456
  page?: SearchPageConfig;
7880
9457
  target?: TargetColumn<Record>[];
7881
- }): Promise<any>;
9458
+ }): Promise<{
9459
+ records: any;
9460
+ totalCount: number;
9461
+ }>;
7882
9462
  vectorSearch<F extends ColumnsByValue<Record, number[]>>(column: F, query: number[], options?: {
7883
9463
  similarityFunction?: string | undefined;
7884
9464
  size?: number | undefined;
7885
9465
  filter?: Filter<Record> | undefined;
7886
- } | undefined): Promise<SearchXataRecord<SelectedPick<Record, ['*']>>[]>;
9466
+ } | undefined): Promise<{
9467
+ records: SearchXataRecord<SelectedPick<Record, ['*']>>[];
9468
+ } & TotalCount>;
7887
9469
  aggregate<Expression extends Dictionary<AggregationExpression<Record>>>(aggs?: Expression, filter?: Filter<Record>): Promise<any>;
7888
9470
  query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
7889
- summarizeTable<Result extends XataRecord>(query: Query<Record, Result>, summaries?: Dictionary<SummarizeExpression<Record>>, summariesFilter?: FilterExpression): Promise<SummarizeResponse>;
9471
+ summarizeTable<Result extends XataRecord>(query: Query<Record, Result>, summaries?: Dictionary<SummarizeExpression<Record>>, summariesFilter?: FilterExpression): Promise<{
9472
+ summaries: Record[];
9473
+ }>;
7890
9474
  ask(question: string, options?: AskOptions<Record> & {
7891
9475
  onMessage?: (message: AskResult) => void;
7892
9476
  }): any;
@@ -7945,7 +9529,7 @@ type PropertyType<Tables, Properties, PropertyName extends PropertyKey> = Proper
7945
9529
  } : {
7946
9530
  [K in PropertyName]?: InnerType<Type, ObjectColumns, Tables, LinkedTable> | null;
7947
9531
  } : never : never;
7948
- type InnerType<Type, ObjectColumns, 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 'object' ? ObjectColumns extends readonly unknown[] ? ObjectColumns[number] extends {
9532
+ type InnerType<Type, ObjectColumns, 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 'object' ? ObjectColumns extends readonly unknown[] ? ObjectColumns[number] extends {
7949
9533
  name: string;
7950
9534
  type: string;
7951
9535
  } ? UnionToIntersection<Values<{
@@ -8003,11 +9587,11 @@ declare const le: <T extends ComparableType>(value: T) => ComparableTypeFilter<T
8003
9587
  /**
8004
9588
  * Operator to restrict results to only values that are not null.
8005
9589
  */
8006
- declare const exists: <T>(column?: ColumnsByValue<T, any> | undefined) => ExistanceFilter<T>;
9590
+ declare const exists: <T>(column?: FilterColumns<T> | undefined) => ExistanceFilter<T>;
8007
9591
  /**
8008
9592
  * Operator to restrict results to only values that are null.
8009
9593
  */
8010
- declare const notExists: <T>(column?: ColumnsByValue<T, any> | undefined) => ExistanceFilter<T>;
9594
+ declare const notExists: <T>(column?: FilterColumns<T> | undefined) => ExistanceFilter<T>;
8011
9595
  /**
8012
9596
  * Operator to restrict results to only values that start with the given prefix.
8013
9597
  */
@@ -8020,6 +9604,10 @@ declare const endsWith: (value: string) => StringTypeFilter;
8020
9604
  * Operator to restrict results to only values that match the given pattern.
8021
9605
  */
8022
9606
  declare const pattern: (value: string) => StringTypeFilter;
9607
+ /**
9608
+ * Operator to restrict results to only values that match the given pattern (case insensitive).
9609
+ */
9610
+ declare const iPattern: (value: string) => StringTypeFilter;
8023
9611
  /**
8024
9612
  * Operator to restrict results to only values that are equal to the given value.
8025
9613
  */
@@ -8036,6 +9624,10 @@ declare const isNot: <T>(value: T) => PropertyFilter<T>;
8036
9624
  * Operator to restrict results to only values that contain the given value.
8037
9625
  */
8038
9626
  declare const contains: (value: string) => StringTypeFilter;
9627
+ /**
9628
+ * Operator to restrict results to only values that contain the given value (case insensitive).
9629
+ */
9630
+ declare const iContains: (value: string) => StringTypeFilter;
8039
9631
  /**
8040
9632
  * Operator to restrict results if some array items match the predicate.
8041
9633
  */
@@ -8065,6 +9657,56 @@ declare class SchemaPlugin<Schemas extends Record<string, XataRecord>> extends X
8065
9657
  build(pluginOptions: XataPluginOptions): SchemaPluginResult<Schemas>;
8066
9658
  }
8067
9659
 
9660
+ type BinaryFile = string | Blob | ArrayBuffer | XataFile | Promise<XataFile>;
9661
+ type FilesPluginResult<Schemas extends Record<string, BaseData>> = {
9662
+ download: <Tables extends StringKeys<Schemas>>(location: DownloadDestination<Schemas, Tables>) => Promise<Blob>;
9663
+ upload: <Tables extends StringKeys<Schemas>>(location: UploadDestination<Schemas, Tables>, file: BinaryFile, options?: {
9664
+ mediaType?: string;
9665
+ }) => Promise<FileResponse>;
9666
+ delete: <Tables extends StringKeys<Schemas>>(location: DownloadDestination<Schemas, Tables>) => Promise<FileResponse>;
9667
+ };
9668
+ type UploadDestination<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = Values<{
9669
+ [Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
9670
+ table: Model;
9671
+ column: ColumnsByValue<Schemas[Model], XataFile>;
9672
+ record: string;
9673
+ } | {
9674
+ table: Model;
9675
+ column: ColumnsByValue<Schemas[Model], XataArrayFile[]>;
9676
+ record: string;
9677
+ fileId?: string;
9678
+ };
9679
+ }>;
9680
+ type DownloadDestination<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = Values<{
9681
+ [Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
9682
+ table: Model;
9683
+ column: ColumnsByValue<Schemas[Model], XataFile>;
9684
+ record: string;
9685
+ } | {
9686
+ table: Model;
9687
+ column: ColumnsByValue<Schemas[Model], XataArrayFile[]>;
9688
+ record: string;
9689
+ fileId: string;
9690
+ };
9691
+ }>;
9692
+ declare class FilesPlugin<Schemas extends Record<string, XataRecord>> extends XataPlugin {
9693
+ build(pluginOptions: XataPluginOptions): FilesPluginResult<Schemas>;
9694
+ }
9695
+
9696
+ type SQLQueryParams<T = any[]> = {
9697
+ statement: string;
9698
+ params?: T;
9699
+ consistency?: 'strong' | 'eventual';
9700
+ };
9701
+ type SQLQuery = TemplateStringsArray | SQLQueryParams | string;
9702
+ type SQLPluginResult = <T>(query: SQLQuery, ...parameters: any[]) => Promise<{
9703
+ records: T[];
9704
+ warning?: string;
9705
+ }>;
9706
+ declare class SQLPlugin extends XataPlugin {
9707
+ build(pluginOptions: XataPluginOptions): SQLPluginResult;
9708
+ }
9709
+
8068
9710
  type TransactionOperation<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = {
8069
9711
  insert: Values<{
8070
9712
  [Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
@@ -8097,6 +9739,7 @@ type UpdateTransactionOperation<O extends XataRecord> = {
8097
9739
  };
8098
9740
  type DeleteTransactionOperation = {
8099
9741
  id: string;
9742
+ failIfMissing?: boolean;
8100
9743
  };
8101
9744
  type TransactionOperationSingleResult<Schema extends Record<string, BaseData>, Table extends StringKeys<Schema>, Operation extends TransactionOperation<Schema, Table>> = Operation extends {
8102
9745
  insert: {
@@ -8164,6 +9807,8 @@ interface ClientConstructor<Plugins extends Record<string, XataPlugin>> {
8164
9807
  db: Awaited<ReturnType<SchemaPlugin<Schemas>['build']>>;
8165
9808
  search: Awaited<ReturnType<SearchPlugin<Schemas>['build']>>;
8166
9809
  transactions: Awaited<ReturnType<TransactionPlugin<Schemas>['build']>>;
9810
+ sql: Awaited<ReturnType<SQLPlugin['build']>>;
9811
+ files: Awaited<ReturnType<FilesPlugin<Schemas>['build']>>;
8167
9812
  }, keyof Plugins> & {
8168
9813
  [Key in StringKeys<NonNullable<Plugins>>]: Awaited<ReturnType<NonNullable<Plugins>[Key]['build']>>;
8169
9814
  } & {
@@ -8202,89 +9847,9 @@ declare function buildPreviewBranchName({ org, branch }: {
8202
9847
  }): string;
8203
9848
  declare function getPreviewBranch(): string | undefined;
8204
9849
 
8205
- interface Body {
8206
- arrayBuffer(): Promise<ArrayBuffer>;
8207
- blob(): Promise<Blob>;
8208
- formData(): Promise<FormData>;
8209
- json(): Promise<any>;
8210
- text(): Promise<string>;
8211
- }
8212
- interface Blob {
8213
- readonly size: number;
8214
- readonly type: string;
8215
- arrayBuffer(): Promise<ArrayBuffer>;
8216
- slice(start?: number, end?: number, contentType?: string): Blob;
8217
- text(): Promise<string>;
8218
- }
8219
- /** Provides information about files and allows JavaScript in a web page to access their content. */
8220
- interface File extends Blob {
8221
- readonly lastModified: number;
8222
- readonly name: string;
8223
- readonly webkitRelativePath: string;
8224
- }
8225
- type FormDataEntryValue = File | string;
8226
- /** Provides a way to easily construct a set of key/value pairs representing form fields and their values, which can then be easily sent using the XMLHttpRequest.send() method. It uses the same format a form would use if the encoding type were set to "multipart/form-data". */
8227
- interface FormData {
8228
- append(name: string, value: string | Blob, fileName?: string): void;
8229
- delete(name: string): void;
8230
- get(name: string): FormDataEntryValue | null;
8231
- getAll(name: string): FormDataEntryValue[];
8232
- has(name: string): boolean;
8233
- set(name: string, value: string | Blob, fileName?: string): void;
8234
- forEach(callbackfn: (value: FormDataEntryValue, key: string, parent: FormData) => void, thisArg?: any): void;
8235
- }
8236
- /** This Fetch API interface allows you to perform various actions on HTTP request and response headers. These actions include retrieving, setting, adding to, and removing. A Headers object has an associated header list, which is initially empty and consists of zero or more name and value pairs. You can add to this using methods like append() (see Examples.) In all methods of this interface, header names are matched by case-insensitive byte sequence. */
8237
- interface Headers {
8238
- append(name: string, value: string): void;
8239
- delete(name: string): void;
8240
- get(name: string): string | null;
8241
- has(name: string): boolean;
8242
- set(name: string, value: string): void;
8243
- forEach(callbackfn: (value: string, key: string, parent: Headers) => void, thisArg?: any): void;
8244
- }
8245
- interface Request extends Body {
8246
- /** Returns the cache mode associated with request, which is a string indicating how the request will interact with the browser's cache when fetching. */
8247
- readonly cache: 'default' | 'force-cache' | 'no-cache' | 'no-store' | 'only-if-cached' | 'reload';
8248
- /** Returns the credentials mode associated with request, which is a string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. */
8249
- readonly credentials: 'include' | 'omit' | 'same-origin';
8250
- /** Returns the kind of resource requested by request, e.g., "document" or "script". */
8251
- readonly destination: '' | 'audio' | 'audioworklet' | 'document' | 'embed' | 'font' | 'frame' | 'iframe' | 'image' | 'manifest' | 'object' | 'paintworklet' | 'report' | 'script' | 'sharedworker' | 'style' | 'track' | 'video' | 'worker' | 'xslt';
8252
- /** Returns a Headers object consisting of the headers associated with request. Note that headers added in the network layer by the user agent will not be accounted for in this object, e.g., the "Host" header. */
8253
- readonly headers: Headers;
8254
- /** Returns request's subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. [SRI] */
8255
- readonly integrity: string;
8256
- /** Returns a boolean indicating whether or not request can outlive the global in which it was created. */
8257
- readonly keepalive: boolean;
8258
- /** Returns request's HTTP method, which is "GET" by default. */
8259
- readonly method: string;
8260
- /** Returns the mode associated with request, which is a string indicating whether the request will use CORS, or will be restricted to same-origin URLs. */
8261
- readonly mode: 'cors' | 'navigate' | 'no-cors' | 'same-origin';
8262
- /** Returns the redirect mode associated with request, which is a string indicating how redirects for the request will be handled during fetching. A request will follow redirects by default. */
8263
- readonly redirect: 'error' | 'follow' | 'manual';
8264
- /** Returns the referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to indicate no referrer, and "about:client" when defaulting to the global's default. This is used during fetching to determine the value of the `Referer` header of the request being made. */
8265
- readonly referrer: string;
8266
- /** Returns the referrer policy associated with request. This is used during fetching to compute the value of the request's referrer. */
8267
- readonly referrerPolicy: '' | 'no-referrer' | 'no-referrer-when-downgrade' | 'origin' | 'origin-when-cross-origin' | 'same-origin' | 'strict-origin' | 'strict-origin-when-cross-origin' | 'unsafe-url';
8268
- /** Returns the URL of request as a string. */
8269
- readonly url: string;
8270
- clone(): Request;
8271
- }
8272
-
8273
- type XataWorkerContext<XataClient> = {
8274
- xata: XataClient;
8275
- request: Request;
8276
- env: Record<string, string | undefined>;
8277
- };
8278
- type RemoveFirst<T> = T extends [any, ...infer U] ? U : never;
8279
- type WorkerRunnerConfig = {
8280
- workspace: string;
8281
- worker: string;
8282
- };
8283
- declare function buildWorkerRunner<XataClient>(config: WorkerRunnerConfig): <WorkerFunction extends (ctx: XataWorkerContext<XataClient>, ...args: any[]) => any>(name: string, worker: WorkerFunction) => (...args: RemoveFirst<Parameters<WorkerFunction>>) => Promise<SerializerResult<Awaited<ReturnType<WorkerFunction>>>>;
8284
-
8285
9850
  declare class XataError extends Error {
8286
9851
  readonly status: number;
8287
9852
  constructor(message: string, status: number);
8288
9853
  }
8289
9854
 
8290
- export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, AggregateTableError, AggregateTablePathParams, AggregateTableRequestBody, AggregateTableVariables, ApiExtraProps, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditVariables, AskOptions, AskResult, AskTableError, AskTablePathParams, AskTableRequestBody, AskTableResponse, AskTableVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BranchTransactionError, BranchTransactionPathParams, BranchTransactionRequestBody, BranchTransactionVariables, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, ColumnsByValue, CompareBranchSchemasError, CompareBranchSchemasPathParams, CompareBranchSchemasRequestBody, CompareBranchSchemasVariables, CompareBranchWithUserSchemaError, CompareBranchWithUserSchemaPathParams, CompareBranchWithUserSchemaRequestBody, CompareBranchWithUserSchemaVariables, CompareMigrationRequestError, CompareMigrationRequestPathParams, CompareMigrationRequestVariables, CopyBranchError, CopyBranchPathParams, CopyBranchRequestBody, CopyBranchVariables, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchResponse, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateMigrationRequestError, CreateMigrationRequestPathParams, CreateMigrationRequestRequestBody, CreateMigrationRequestResponse, CreateMigrationRequestVariables, CreateTableError, CreateTablePathParams, CreateTableResponse, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchResponse, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabaseGithubSettingsError, DeleteDatabaseGithubSettingsPathParams, DeleteDatabaseGithubSettingsVariables, DeleteDatabasePathParams, DeleteDatabaseResponse, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableResponse, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, DeserializedType, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherError, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchSchemaHistoryError, GetBranchSchemaHistoryPathParams, GetBranchSchemaHistoryRequestBody, GetBranchSchemaHistoryResponse, GetBranchSchemaHistoryVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseGithubSettingsError, GetDatabaseGithubSettingsPathParams, GetDatabaseGithubSettingsVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetDatabaseMetadataError, GetDatabaseMetadataPathParams, GetDatabaseMetadataVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetMigrationRequestError, GetMigrationRequestIsMergedError, GetMigrationRequestIsMergedPathParams, GetMigrationRequestIsMergedResponse, GetMigrationRequestIsMergedVariables, GetMigrationRequestPathParams, GetMigrationRequestVariables, GetRecordError, GetRecordPathParams, GetRecordQueryParams, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, HostProvider, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, KeywordAskOptions, Link, ListMigrationRequestsCommitsError, ListMigrationRequestsCommitsPathParams, ListMigrationRequestsCommitsRequestBody, ListMigrationRequestsCommitsResponse, ListMigrationRequestsCommitsVariables, ListRegionsError, ListRegionsPathParams, ListRegionsVariables, MergeMigrationRequestError, MergeMigrationRequestPathParams, MergeMigrationRequestVariables, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, PreviewBranchSchemaEditError, PreviewBranchSchemaEditPathParams, PreviewBranchSchemaEditRequestBody, PreviewBranchSchemaEditResponse, PreviewBranchSchemaEditVariables, PushBranchMigrationsError, PushBranchMigrationsPathParams, PushBranchMigrationsRequestBody, PushBranchMigrationsVariables, Query, QueryMigrationRequestsError, QueryMigrationRequestsPathParams, QueryMigrationRequestsRequestBody, QueryMigrationRequestsResponse, QueryMigrationRequestsVariables, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RecordArray, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaInference, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SearchTableError, SearchTablePathParams, SearchTableRequestBody, SearchTableVariables, SearchXataRecord, SelectableColumn, SelectedPick, SerializedString, Serializer, SerializerResult, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, SqlQueryError, SqlQueryPathParams, SqlQueryRequestBody, SqlQueryVariables, SummarizeTableError, SummarizeTablePathParams, SummarizeTableRequestBody, SummarizeTableVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, UpdateBranchSchemaVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateDatabaseGithubSettingsError, UpdateDatabaseGithubSettingsPathParams, UpdateDatabaseGithubSettingsVariables, UpdateDatabaseMetadataError, UpdateDatabaseMetadataPathParams, UpdateDatabaseMetadataRequestBody, UpdateDatabaseMetadataVariables, UpdateMigrationRequestError, UpdateMigrationRequestPathParams, UpdateMigrationRequestRequestBody, UpdateMigrationRequestVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberInviteError, UpdateWorkspaceMemberInvitePathParams, UpdateWorkspaceMemberInviteRequestBody, UpdateWorkspaceMemberInviteVariables, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, VectorAskOptions, VectorSearchTableError, VectorSearchTablePathParams, VectorSearchTableRequestBody, VectorSearchTableVariables, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, askTable, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, pushBranchMigrations, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, sqlQuery, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
9855
+ export { type AcceptWorkspaceMemberInviteError, type AcceptWorkspaceMemberInvitePathParams, type AcceptWorkspaceMemberInviteVariables, type AddGitBranchesEntryError, type AddGitBranchesEntryPathParams, type AddGitBranchesEntryRequestBody, type AddGitBranchesEntryResponse, type AddGitBranchesEntryVariables, type AddTableColumnError, type AddTableColumnPathParams, type AddTableColumnVariables, type AggregateTableError, type AggregateTablePathParams, type AggregateTableRequestBody, type AggregateTableVariables, type ApiExtraProps, type ApplyBranchSchemaEditError, type ApplyBranchSchemaEditPathParams, type ApplyBranchSchemaEditRequestBody, type ApplyBranchSchemaEditVariables, type ApplyMigrationError, type ApplyMigrationPathParams, type ApplyMigrationRequestBody, type ApplyMigrationVariables, type AskOptions, type AskResult, type AskTableError, type AskTablePathParams, type AskTableRequestBody, type AskTableResponse, type AskTableSessionError, type AskTableSessionPathParams, type AskTableSessionRequestBody, type AskTableSessionResponse, type AskTableSessionVariables, type AskTableVariables, BaseClient, type BaseClientOptions, type BaseData, type BaseSchema, type BinaryFile, type BranchTransactionError, type BranchTransactionPathParams, type BranchTransactionRequestBody, type BranchTransactionVariables, type BulkInsertTableRecordsError, type BulkInsertTableRecordsPathParams, type BulkInsertTableRecordsQueryParams, type BulkInsertTableRecordsRequestBody, type BulkInsertTableRecordsVariables, type CacheImpl, type CancelWorkspaceMemberInviteError, type CancelWorkspaceMemberInvitePathParams, type CancelWorkspaceMemberInviteVariables, type ClientConstructor, type ColumnsByValue, type CompareBranchSchemasError, type CompareBranchSchemasPathParams, type CompareBranchSchemasRequestBody, type CompareBranchSchemasVariables, type CompareBranchWithUserSchemaError, type CompareBranchWithUserSchemaPathParams, type CompareBranchWithUserSchemaRequestBody, type CompareBranchWithUserSchemaVariables, type CompareMigrationRequestError, type CompareMigrationRequestPathParams, type CompareMigrationRequestVariables, type CopyBranchError, type CopyBranchPathParams, type CopyBranchRequestBody, type CopyBranchVariables, type CreateBranchError, type CreateBranchPathParams, type CreateBranchQueryParams, type CreateBranchRequestBody, type CreateBranchResponse, type CreateBranchVariables, type CreateClusterError, type CreateClusterPathParams, type CreateClusterVariables, type CreateDatabaseError, type CreateDatabasePathParams, type CreateDatabaseRequestBody, type CreateDatabaseResponse, type CreateDatabaseVariables, type CreateMigrationRequestError, type CreateMigrationRequestPathParams, type CreateMigrationRequestRequestBody, type CreateMigrationRequestResponse, type CreateMigrationRequestVariables, type CreateTableError, type CreateTablePathParams, type CreateTableResponse, type CreateTableVariables, type CreateUserAPIKeyError, type CreateUserAPIKeyPathParams, type CreateUserAPIKeyResponse, type CreateUserAPIKeyVariables, type CreateWorkspaceError, type CreateWorkspaceVariables, type CursorNavigationOptions, type DeleteBranchError, type DeleteBranchPathParams, type DeleteBranchResponse, type DeleteBranchVariables, type DeleteColumnError, type DeleteColumnPathParams, type DeleteColumnVariables, type DeleteDatabaseError, type DeleteDatabaseGithubSettingsError, type DeleteDatabaseGithubSettingsPathParams, type DeleteDatabaseGithubSettingsVariables, type DeleteDatabasePathParams, type DeleteDatabaseResponse, type DeleteDatabaseVariables, type DeleteFileError, type DeleteFileItemError, type DeleteFileItemPathParams, type DeleteFileItemVariables, type DeleteFilePathParams, type DeleteFileVariables, type DeleteOAuthAccessTokenError, type DeleteOAuthAccessTokenPathParams, type DeleteOAuthAccessTokenVariables, type DeleteRecordError, type DeleteRecordPathParams, type DeleteRecordQueryParams, type DeleteRecordVariables, type DeleteTableError, type DeleteTablePathParams, type DeleteTableResponse, type DeleteTableVariables, type DeleteTransactionOperation, type DeleteUserAPIKeyError, type DeleteUserAPIKeyPathParams, type DeleteUserAPIKeyVariables, type DeleteUserError, type DeleteUserOAuthClientError, type DeleteUserOAuthClientPathParams, type DeleteUserOAuthClientVariables, type DeleteUserVariables, type DeleteWorkspaceError, type DeleteWorkspacePathParams, type DeleteWorkspaceVariables, type DeserializedType, type DownloadDestination, type EditableData, type ExecuteBranchMigrationPlanError, type ExecuteBranchMigrationPlanPathParams, type ExecuteBranchMigrationPlanRequestBody, type ExecuteBranchMigrationPlanVariables, type FetchImpl, FetcherError, type FetcherExtraProps, type FileAccessError, type FileAccessPathParams, type FileAccessQueryParams, type FileAccessVariables, FilesPlugin, type FilesPluginResult, type GetAuthorizationCodeError, type GetAuthorizationCodeQueryParams, type GetAuthorizationCodeVariables, type GetBranchDetailsError, type GetBranchDetailsPathParams, type GetBranchDetailsVariables, type GetBranchListError, type GetBranchListPathParams, type GetBranchListVariables, type GetBranchMetadataError, type GetBranchMetadataPathParams, type GetBranchMetadataVariables, type GetBranchMigrationHistoryError, type GetBranchMigrationHistoryPathParams, type GetBranchMigrationHistoryRequestBody, type GetBranchMigrationHistoryResponse, type GetBranchMigrationHistoryVariables, type GetBranchMigrationPlanError, type GetBranchMigrationPlanPathParams, type GetBranchMigrationPlanVariables, type GetBranchSchemaHistoryError, type GetBranchSchemaHistoryPathParams, type GetBranchSchemaHistoryRequestBody, type GetBranchSchemaHistoryResponse, type GetBranchSchemaHistoryVariables, type GetBranchStatsError, type GetBranchStatsPathParams, type GetBranchStatsResponse, type GetBranchStatsVariables, type GetClusterError, type GetClusterPathParams, type GetClusterVariables, type GetColumnError, type GetColumnPathParams, type GetColumnVariables, type GetDatabaseGithubSettingsError, type GetDatabaseGithubSettingsPathParams, type GetDatabaseGithubSettingsVariables, type GetDatabaseListError, type GetDatabaseListPathParams, type GetDatabaseListVariables, type GetDatabaseMetadataError, type GetDatabaseMetadataPathParams, type GetDatabaseMetadataVariables, type GetFileError, type GetFileItemError, type GetFileItemPathParams, type GetFileItemVariables, type GetFilePathParams, type GetFileVariables, type GetGitBranchesMappingError, type GetGitBranchesMappingPathParams, type GetGitBranchesMappingVariables, type GetMigrationRequestError, type GetMigrationRequestIsMergedError, type GetMigrationRequestIsMergedPathParams, type GetMigrationRequestIsMergedResponse, type GetMigrationRequestIsMergedVariables, type GetMigrationRequestPathParams, type GetMigrationRequestVariables, type GetRecordError, type GetRecordPathParams, type GetRecordQueryParams, type GetRecordVariables, type GetSchemaError, type GetSchemaPathParams, type GetSchemaResponse, type GetSchemaVariables, type GetTableColumnsError, type GetTableColumnsPathParams, type GetTableColumnsResponse, type GetTableColumnsVariables, type GetTableSchemaError, type GetTableSchemaPathParams, type GetTableSchemaResponse, type GetTableSchemaVariables, type GetUserAPIKeysError, type GetUserAPIKeysResponse, type GetUserAPIKeysVariables, type GetUserError, type GetUserOAuthAccessTokensError, type GetUserOAuthAccessTokensResponse, type GetUserOAuthAccessTokensVariables, type GetUserOAuthClientsError, type GetUserOAuthClientsResponse, type GetUserOAuthClientsVariables, type GetUserVariables, type GetWorkspaceError, type GetWorkspaceMembersListError, type GetWorkspaceMembersListPathParams, type GetWorkspaceMembersListVariables, type GetWorkspacePathParams, type GetWorkspaceVariables, type GetWorkspacesListError, type GetWorkspacesListResponse, type GetWorkspacesListVariables, type GrantAuthorizationCodeError, type GrantAuthorizationCodeVariables, type HostProvider, type Identifiable, type ImageTransformations, type InsertRecordError, type InsertRecordPathParams, type InsertRecordQueryParams, type InsertRecordVariables, type InsertRecordWithIDError, type InsertRecordWithIDPathParams, type InsertRecordWithIDQueryParams, type InsertRecordWithIDVariables, type InsertTransactionOperation, type InviteWorkspaceMemberError, type InviteWorkspaceMemberPathParams, type InviteWorkspaceMemberRequestBody, type InviteWorkspaceMemberVariables, type JSONData, type KeywordAskOptions, type Link, type ListClustersError, type ListClustersPathParams, type ListClustersVariables, type ListMigrationRequestsCommitsError, type ListMigrationRequestsCommitsPathParams, type ListMigrationRequestsCommitsRequestBody, type ListMigrationRequestsCommitsResponse, type ListMigrationRequestsCommitsVariables, type ListRegionsError, type ListRegionsPathParams, type ListRegionsVariables, type MergeMigrationRequestError, type MergeMigrationRequestPathParams, type MergeMigrationRequestVariables, type OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, type Paginable, type PaginationQueryMeta, type PgRollStatusError, type PgRollStatusPathParams, type PgRollStatusVariables, type PreviewBranchSchemaEditError, type PreviewBranchSchemaEditPathParams, type PreviewBranchSchemaEditRequestBody, type PreviewBranchSchemaEditResponse, type PreviewBranchSchemaEditVariables, type PushBranchMigrationsError, type PushBranchMigrationsPathParams, type PushBranchMigrationsRequestBody, type PushBranchMigrationsVariables, type PutFileError, type PutFileItemError, type PutFileItemPathParams, type PutFileItemVariables, type PutFilePathParams, type PutFileVariables, Query, type QueryMigrationRequestsError, type QueryMigrationRequestsPathParams, type QueryMigrationRequestsRequestBody, type QueryMigrationRequestsResponse, type QueryMigrationRequestsVariables, type QueryTableError, type QueryTablePathParams, type QueryTableRequestBody, type QueryTableVariables, RecordArray, RecordColumnTypes, type RemoveGitBranchesEntryError, type RemoveGitBranchesEntryPathParams, type RemoveGitBranchesEntryQueryParams, type RemoveGitBranchesEntryVariables, type RemoveWorkspaceMemberError, type RemoveWorkspaceMemberPathParams, type RemoveWorkspaceMemberVariables, type RenameDatabaseError, type RenameDatabasePathParams, type RenameDatabaseRequestBody, type RenameDatabaseVariables, Repository, type ResendWorkspaceMemberInviteError, type ResendWorkspaceMemberInvitePathParams, type ResendWorkspaceMemberInviteVariables, type ResolveBranchError, type ResolveBranchPathParams, type ResolveBranchQueryParams, type ResolveBranchResponse, type ResolveBranchVariables, responses as Responses, RestRepository, SQLPlugin, type SQLPluginResult, type SQLQuery, type SQLQueryParams, type SchemaDefinition, type SchemaInference, SchemaPlugin, type SchemaPluginResult, schemas as Schemas, type SearchBranchError, type SearchBranchPathParams, type SearchBranchRequestBody, type SearchBranchVariables, type SearchOptions, SearchPlugin, type SearchPluginResult, type SearchTableError, type SearchTablePathParams, type SearchTableRequestBody, type SearchTableVariables, type SearchXataRecord, type SelectableColumn, type SelectableColumnWithObjectNotation, type SelectedPick, type SerializedString, Serializer, type SerializerResult, type SetTableSchemaError, type SetTableSchemaPathParams, type SetTableSchemaRequestBody, type SetTableSchemaVariables, SimpleCache, type SimpleCacheOptions, type SqlQueryError, type SqlQueryPathParams, type SqlQueryRequestBody, type SqlQueryVariables, type SummarizeTableError, type SummarizeTablePathParams, type SummarizeTableRequestBody, type SummarizeTableVariables, type TotalCount, type TransactionOperation, TransactionPlugin, type TransactionPluginResult, type TransactionResults, type UpdateBranchMetadataError, type UpdateBranchMetadataPathParams, type UpdateBranchMetadataVariables, type UpdateBranchSchemaError, type UpdateBranchSchemaPathParams, type UpdateBranchSchemaVariables, type UpdateClusterError, type UpdateClusterPathParams, type UpdateClusterVariables, type UpdateColumnError, type UpdateColumnPathParams, type UpdateColumnRequestBody, type UpdateColumnVariables, type UpdateDatabaseGithubSettingsError, type UpdateDatabaseGithubSettingsPathParams, type UpdateDatabaseGithubSettingsVariables, type UpdateDatabaseMetadataError, type UpdateDatabaseMetadataPathParams, type UpdateDatabaseMetadataRequestBody, type UpdateDatabaseMetadataVariables, type UpdateMigrationRequestError, type UpdateMigrationRequestPathParams, type UpdateMigrationRequestRequestBody, type UpdateMigrationRequestVariables, type UpdateOAuthAccessTokenError, type UpdateOAuthAccessTokenPathParams, type UpdateOAuthAccessTokenRequestBody, type UpdateOAuthAccessTokenVariables, type UpdateRecordWithIDError, type UpdateRecordWithIDPathParams, type UpdateRecordWithIDQueryParams, type UpdateRecordWithIDVariables, type UpdateTableError, type UpdateTablePathParams, type UpdateTableRequestBody, type UpdateTableVariables, type UpdateTransactionOperation, type UpdateUserError, type UpdateUserVariables, type UpdateWorkspaceError, type UpdateWorkspaceMemberInviteError, type UpdateWorkspaceMemberInvitePathParams, type UpdateWorkspaceMemberInviteRequestBody, type UpdateWorkspaceMemberInviteVariables, type UpdateWorkspaceMemberRoleError, type UpdateWorkspaceMemberRolePathParams, type UpdateWorkspaceMemberRoleRequestBody, type UpdateWorkspaceMemberRoleVariables, type UpdateWorkspacePathParams, type UpdateWorkspaceVariables, type UploadDestination, type UpsertRecordWithIDError, type UpsertRecordWithIDPathParams, type UpsertRecordWithIDQueryParams, type UpsertRecordWithIDVariables, type ValueAtColumn, type VectorAskOptions, type VectorSearchTableError, type VectorSearchTablePathParams, type VectorSearchTableRequestBody, type VectorSearchTableVariables, XataApiClient, type XataApiClientOptions, XataApiPlugin, type XataArrayFile, XataError, XataFile, XataPlugin, type XataPluginOptions, type XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, applyMigration, askTable, askTableSession, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createCluster, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteFile, deleteFileItem, deleteOAuthAccessToken, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteUserOAuthClient, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, fileAccess, ge, getAPIKey, getAuthorizationCode, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getCluster, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getFile, getFileItem, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, getRecord, getSchema, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getUserOAuthAccessTokens, getUserOAuthClients, getWorkspace, getWorkspaceMembersList, getWorkspacesList, grantAuthorizationCode, greaterEquals, greaterThan, greaterThanEquals, gt, gte, iContains, iPattern, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isValidExpandedColumn, isValidSelectableColumns, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listClusters, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, pgRollStatus, previewBranchSchemaEdit, pushBranchMigrations, putFile, putFileItem, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, renameDatabase, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, sqlQuery, startsWith, summarizeTable, transformImage, updateBranchMetadata, updateBranchSchema, updateCluster, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateOAuthAccessToken, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };