@xata.io/client 0.17.1 → 0.18.1

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
@@ -68,6 +68,9 @@ declare type XataPluginOptions = {
68
68
  * @version 1.0
69
69
  */
70
70
  declare type User = {
71
+ /**
72
+ * @format email
73
+ */
71
74
  email: string;
72
75
  fullname: string;
73
76
  image: string;
@@ -99,7 +102,7 @@ declare type WorkspaceID = string;
99
102
  declare type Role = 'owner' | 'maintainer';
100
103
  declare type WorkspaceMeta = {
101
104
  name: string;
102
- slug: string;
105
+ slug?: string;
103
106
  };
104
107
  declare type Workspace = WorkspaceMeta & {
105
108
  id: WorkspaceID;
@@ -109,6 +112,9 @@ declare type Workspace = WorkspaceMeta & {
109
112
  declare type WorkspaceMember = {
110
113
  userId: UserID;
111
114
  fullname: string;
115
+ /**
116
+ * @format email
117
+ */
112
118
  email: string;
113
119
  role: Role;
114
120
  };
@@ -118,7 +124,13 @@ declare type WorkspaceMember = {
118
124
  declare type InviteID = string;
119
125
  declare type WorkspaceInvite = {
120
126
  inviteId: InviteID;
127
+ /**
128
+ * @format email
129
+ */
121
130
  email: string;
131
+ /**
132
+ * @format date-time
133
+ */
122
134
  expires: string;
123
135
  role: Role;
124
136
  };
@@ -134,20 +146,36 @@ declare type InviteKey = string;
134
146
  * Metadata of databases
135
147
  */
136
148
  declare type DatabaseMetadata = {
149
+ /**
150
+ * The machine-readable name of a database
151
+ */
137
152
  name: string;
138
- displayName: string;
153
+ /**
154
+ * The time this database was created
155
+ */
139
156
  createdAt: DateTime;
157
+ /**
158
+ * The number of branches the database has
159
+ */
140
160
  numberOfBranches: number;
161
+ /**
162
+ * Metadata about the database for display in Xata user interfaces
163
+ */
141
164
  ui?: {
165
+ /**
166
+ * The user-selected color for this database across interfaces
167
+ */
142
168
  color?: string;
143
169
  };
144
170
  };
145
171
  declare type ListDatabasesResponse = {
172
+ /**
173
+ * A list of databases in a Xata workspace
174
+ */
146
175
  databases?: DatabaseMetadata[];
147
176
  };
148
177
  declare type ListBranchesResponse = {
149
178
  databaseName: string;
150
- displayName: string;
151
179
  branches: Branch[];
152
180
  };
153
181
  declare type ListGitBranchesResponse = {
@@ -165,8 +193,14 @@ declare type Branch = {
165
193
  * @x-go-type xata.BranchMetadata
166
194
  */
167
195
  declare type BranchMetadata = {
196
+ /**
197
+ * @minLength 1
198
+ */
168
199
  repository?: string;
169
200
  branch?: BranchName;
201
+ /**
202
+ * @minLength 1
203
+ */
170
204
  stage?: string;
171
205
  labels?: string[];
172
206
  };
@@ -224,6 +258,8 @@ declare type Column = {
224
258
  link?: {
225
259
  table: string;
226
260
  };
261
+ notNull?: boolean;
262
+ unique?: boolean;
227
263
  columns?: Column[];
228
264
  };
229
265
  declare type RevLink = {
@@ -383,15 +419,42 @@ declare type ColumnOpRename = {
383
419
  newName: string;
384
420
  };
385
421
  declare type MigrationRequest = {
422
+ /**
423
+ * The migration request number.
424
+ */
386
425
  number: number;
426
+ /**
427
+ * Migration request creation timestamp.
428
+ */
387
429
  createdAt: DateTime;
430
+ /**
431
+ * Last modified timestamp.
432
+ */
388
433
  modifiedAt?: DateTime;
434
+ /**
435
+ * Timestamp when the migration request was closed.
436
+ */
389
437
  closedAt?: DateTime;
438
+ /**
439
+ * Timestamp when the migration request was merged.
440
+ */
390
441
  mergedAt?: DateTime;
391
442
  status: 'open' | 'closed' | 'merging' | 'merged';
443
+ /**
444
+ * The migration request title.
445
+ */
392
446
  title: string;
447
+ /**
448
+ * The migration request body with detailed description.
449
+ */
393
450
  body: string;
451
+ /**
452
+ * Name of the source branch.
453
+ */
394
454
  source: string;
455
+ /**
456
+ * Name of the target branch.
457
+ */
395
458
  target: string;
396
459
  };
397
460
  declare type SortExpression = string[] | {
@@ -402,7 +465,7 @@ declare type SortExpression = string[] | {
402
465
  declare type SortOrder = 'asc' | 'desc';
403
466
  /**
404
467
  * Maximum [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) for the search terms. The Levenshtein
405
- * distance is the number of one charcter changes needed to make two strings equal. The default is 1, meaning that single
468
+ * distance is the number of one character changes needed to make two strings equal. The default is 1, meaning that single
406
469
  * character typos per word are tollerated by search. You can set it to 0 to remove the typo tollerance or set it to 2
407
470
  * to allow two typos in a word.
408
471
  *
@@ -428,8 +491,52 @@ declare type FilterExpression = {
428
491
  } & {
429
492
  [key: string]: FilterColumn;
430
493
  };
494
+ /**
495
+ * The description of the summaries you wish to receive. Set each key to be the field name
496
+ * you'd like for the summary. These names must not collide with other columns you've
497
+ * requested from `columns`; including implicit requests like `settings.*`.
498
+ *
499
+ * The value for each key needs to be an object. This object should contain one key and one
500
+ * value only. In this object, the key should be set to the summary function you wish to use
501
+ * and the value set to the column name to be summarized.
502
+ *
503
+ * The column being summarized cannot be an internal column (id, xata.*), nor the base of
504
+ * an object, i.e. if `settings` is an object with `dark_mode` as a field, you may summarize
505
+ * `settings.dark_mode` but not `settings` nor `settings.*`.
506
+ *
507
+ * @example {"all_users":{"count":"*"}}
508
+ * @example {"total_created":{"count":"created_at"}}
509
+ * @x-go-type xbquery.SummaryList
510
+ */
511
+ declare type SummaryExpressionList = {
512
+ [key: string]: SummaryExpression;
513
+ };
514
+ /**
515
+ * A summary expression is the description of a single summary operation. It consists of a single
516
+ * key representing the operation, and a value representing the column to be operated on.
517
+ *
518
+ * The column being summarized cannot be an internal column (id, xata.*), nor the base of
519
+ * an object, i.e. if `settings` is an object with `dark_mode` as a field, you may summarize
520
+ * `settings.dark_mode` but not `settings` nor `settings.*`.
521
+ *
522
+ * We currently support the `count` operation. When using `count`, one can set a column name
523
+ * as the value. Xata will return the total number times this column is non-null in each group.
524
+ *
525
+ * Alternately, if you'd like to count the total rows in each group - irregardless of null/not null
526
+ * status - you can set `count` to `*` to count everything.
527
+ *
528
+ * @example {"count":"deleted_at"}
529
+ * @x-go-type xbquery.Summary
530
+ */
531
+ declare type SummaryExpression = Record<string, any>;
431
532
  declare type HighlightExpression = {
533
+ /**
534
+ * Set to `false` to disable highlighting. By default it is `true`.
535
+ */
432
536
  enabled?: boolean;
537
+ /**
538
+ * Set to `false` to disable HTML encoding in highlight snippets. By default it is `true`.
539
+ */
433
540
  encodeHTML?: boolean;
434
541
  };
435
542
  /**
@@ -448,15 +555,30 @@ declare type BoosterExpression = {
448
555
  * Boost records with a particular value for a column.
449
556
  */
450
557
  declare type ValueBooster$1 = {
558
+ /**
559
+ * The column in which to look for the value.
560
+ */
451
561
  column: string;
562
+ /**
563
+ * The exact value to boost.
564
+ */
452
565
  value: string | number | boolean;
566
+ /**
567
+ * The factor with which to multiply the score of the record.
568
+ */
453
569
  factor: number;
454
570
  };
455
571
  /**
456
572
  * Boost records based on the value of a numeric column.
457
573
  */
458
574
  declare type NumericBooster$1 = {
575
+ /**
576
+ * The column in which to look for the value.
577
+ */
459
578
  column: string;
579
+ /**
580
+ * The factor with which to multiply the value of the column before adding it to the item score.
581
+ */
460
582
  factor: number;
461
583
  };
462
584
  /**
@@ -465,9 +587,24 @@ declare type NumericBooster$1 = {
465
587
  * 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.
466
588
  */
467
589
  declare type DateBooster$1 = {
590
+ /**
591
+ * The column in which to look for the value.
592
+ */
468
593
  column: string;
594
+ /**
595
+ * The datetime (formatted as RFC3339) from where to apply the score decay function. The maximum boost will be applied for records with values at this time.
596
+ * If it is not specified, the current date and time is used.
597
+ */
469
598
  origin?: string;
599
+ /**
600
+ * 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`.
601
+ *
602
+ * @pattern ^(\d+)(d|h|m|s|ms)$
603
+ */
470
604
  scale: string;
605
+ /**
606
+ * The decay factor to expect at "scale" distance from the "origin".
607
+ */
471
608
  decay: number;
472
609
  };
473
610
  declare type FilterList = FilterExpression | FilterExpression[];
@@ -519,13 +656,40 @@ declare type FilterValue = number | string | boolean;
519
656
  * Pagination settings.
520
657
  */
521
658
  declare type PageConfig = {
659
+ /**
660
+ * Query the next page that follow the cursor.
661
+ */
522
662
  after?: string;
663
+ /**
664
+ * Query the previous page before the cursor.
665
+ */
523
666
  before?: string;
667
+ /**
668
+ * Query the first page from the cursor.
669
+ */
524
670
  first?: string;
671
+ /**
672
+ * Query the last page from the cursor.
673
+ */
525
674
  last?: string;
675
+ /**
676
+ * Set page size. If the size is missing it is read from the cursor. If no cursor is given xata will choose the default page size.
677
+ *
678
+ * @default 20
679
+ */
526
680
  size?: number;
681
+ /**
682
+ * Use offset to skip entries. To skip pages set offset to a multiple of size.
683
+ *
684
+ * @default 0
685
+ */
527
686
  offset?: number;
528
687
  };
688
+ /**
689
+ * @example name
690
+ * @example email
691
+ * @example created_at
692
+ */
529
693
  declare type ColumnsProjection = string[];
530
694
  /**
531
695
  * Xata Table Record Metadata
@@ -533,14 +697,29 @@ declare type ColumnsProjection = string[];
533
697
  declare type RecordMeta = {
534
698
  id: RecordID;
535
699
  xata: {
700
+ /**
701
+ * The record's version. Can be used for optimistic concurrency control.
702
+ */
536
703
  version: number;
704
+ /**
705
+ * The record's table name. APIs that return records from multiple tables will set this field accordingly.
706
+ */
537
707
  table?: string;
708
+ /**
709
+ * Highlights of the record. This is used by the search APIs to indicate which fields and parts of the fields have matched the search.
710
+ */
538
711
  highlight?: {
539
712
  [key: string]: string[] | {
540
713
  [key: string]: any;
541
714
  };
542
715
  };
716
+ /**
717
+ * The record's relevancy score. This is returned by the search APIs.
718
+ */
543
719
  score?: number;
720
+ /**
721
+ * Encoding/Decoding errors
722
+ */
544
723
  warnings?: string[];
545
724
  };
546
725
  };
@@ -552,7 +731,13 @@ declare type RecordID = string;
552
731
  * @example {"newName":"newName","oldName":"oldName"}
553
732
  */
554
733
  declare type TableRename = {
734
+ /**
735
+ * @minLength 1
736
+ */
555
737
  newName: string;
738
+ /**
739
+ * @minLength 1
740
+ */
556
741
  oldName: string;
557
742
  };
558
743
  /**
@@ -560,7 +745,13 @@ declare type TableRename = {
560
745
  */
561
746
  declare type RecordsMetadata = {
562
747
  page: {
748
+ /**
749
+ * last record id
750
+ */
563
751
  cursor: string;
752
+ /**
753
+ * true if more records can be fetch
754
+ */
564
755
  more: boolean;
565
756
  };
566
757
  };
@@ -626,6 +817,8 @@ type schemas_SortOrder = SortOrder;
626
817
  type schemas_FuzzinessExpression = FuzzinessExpression;
627
818
  type schemas_PrefixExpression = PrefixExpression;
628
819
  type schemas_FilterExpression = FilterExpression;
820
+ type schemas_SummaryExpressionList = SummaryExpressionList;
821
+ type schemas_SummaryExpression = SummaryExpression;
629
822
  type schemas_HighlightExpression = HighlightExpression;
630
823
  type schemas_BoosterExpression = BoosterExpression;
631
824
  type schemas_FilterList = FilterList;
@@ -699,6 +892,8 @@ declare namespace schemas {
699
892
  schemas_FuzzinessExpression as FuzzinessExpression,
700
893
  schemas_PrefixExpression as PrefixExpression,
701
894
  schemas_FilterExpression as FilterExpression,
895
+ schemas_SummaryExpressionList as SummaryExpressionList,
896
+ schemas_SummaryExpression as SummaryExpression,
702
897
  schemas_HighlightExpression as HighlightExpression,
703
898
  schemas_BoosterExpression as BoosterExpression,
704
899
  ValueBooster$1 as ValueBooster,
@@ -774,6 +969,9 @@ declare type QueryResponse = {
774
969
  records: XataRecord$1[];
775
970
  meta: RecordsMetadata;
776
971
  };
972
+ declare type SummarizeResponse = {
973
+ summary: Record<string, any>[];
974
+ };
777
975
  declare type SearchResponse = {
778
976
  records: XataRecord$1[];
779
977
  };
@@ -781,6 +979,9 @@ declare type SearchResponse = {
781
979
  * @example {"migrationID":"mig_c7m19ilcefoebpqj12p0"}
782
980
  */
783
981
  declare type MigrationIdResponse = {
982
+ /**
983
+ * @minLength 1
984
+ */
784
985
  migrationID: string;
785
986
  };
786
987
 
@@ -794,6 +995,7 @@ type responses_RecordResponse = RecordResponse;
794
995
  type responses_SchemaCompareResponse = SchemaCompareResponse;
795
996
  type responses_RecordUpdateResponse = RecordUpdateResponse;
796
997
  type responses_QueryResponse = QueryResponse;
998
+ type responses_SummarizeResponse = SummarizeResponse;
797
999
  type responses_SearchResponse = SearchResponse;
798
1000
  type responses_MigrationIdResponse = MigrationIdResponse;
799
1001
  declare namespace responses {
@@ -808,6 +1010,7 @@ declare namespace responses {
808
1010
  responses_SchemaCompareResponse as SchemaCompareResponse,
809
1011
  responses_RecordUpdateResponse as RecordUpdateResponse,
810
1012
  responses_QueryResponse as QueryResponse,
1013
+ responses_SummarizeResponse as SummarizeResponse,
811
1014
  responses_SearchResponse as SearchResponse,
812
1015
  responses_MigrationIdResponse as MigrationIdResponse,
813
1016
  };
@@ -888,6 +1091,9 @@ declare type GetUserAPIKeysVariables = FetcherExtraProps;
888
1091
  */
889
1092
  declare const getUserAPIKeys: (variables: GetUserAPIKeysVariables) => Promise<GetUserAPIKeysResponse>;
890
1093
  declare type CreateUserAPIKeyPathParams = {
1094
+ /**
1095
+ * API Key name
1096
+ */
891
1097
  keyName: APIKeyName;
892
1098
  };
893
1099
  declare type CreateUserAPIKeyError = ErrorWrapper<{
@@ -913,6 +1119,9 @@ declare type CreateUserAPIKeyVariables = {
913
1119
  */
914
1120
  declare const createUserAPIKey: (variables: CreateUserAPIKeyVariables) => Promise<CreateUserAPIKeyResponse>;
915
1121
  declare type DeleteUserAPIKeyPathParams = {
1122
+ /**
1123
+ * API Key name
1124
+ */
916
1125
  keyName: APIKeyName;
917
1126
  };
918
1127
  declare type DeleteUserAPIKeyError = ErrorWrapper<{
@@ -973,6 +1182,9 @@ declare type GetWorkspacesListVariables = FetcherExtraProps;
973
1182
  */
974
1183
  declare const getWorkspacesList: (variables: GetWorkspacesListVariables) => Promise<GetWorkspacesListResponse>;
975
1184
  declare type GetWorkspacePathParams = {
1185
+ /**
1186
+ * Workspace name
1187
+ */
976
1188
  workspaceId: WorkspaceID;
977
1189
  };
978
1190
  declare type GetWorkspaceError = ErrorWrapper<{
@@ -993,6 +1205,9 @@ declare type GetWorkspaceVariables = {
993
1205
  */
994
1206
  declare const getWorkspace: (variables: GetWorkspaceVariables) => Promise<Workspace>;
995
1207
  declare type UpdateWorkspacePathParams = {
1208
+ /**
1209
+ * Workspace name
1210
+ */
996
1211
  workspaceId: WorkspaceID;
997
1212
  };
998
1213
  declare type UpdateWorkspaceError = ErrorWrapper<{
@@ -1014,6 +1229,9 @@ declare type UpdateWorkspaceVariables = {
1014
1229
  */
1015
1230
  declare const updateWorkspace: (variables: UpdateWorkspaceVariables) => Promise<Workspace>;
1016
1231
  declare type DeleteWorkspacePathParams = {
1232
+ /**
1233
+ * Workspace name
1234
+ */
1017
1235
  workspaceId: WorkspaceID;
1018
1236
  };
1019
1237
  declare type DeleteWorkspaceError = ErrorWrapper<{
@@ -1034,6 +1252,9 @@ declare type DeleteWorkspaceVariables = {
1034
1252
  */
1035
1253
  declare const deleteWorkspace: (variables: DeleteWorkspaceVariables) => Promise<undefined>;
1036
1254
  declare type GetWorkspaceMembersListPathParams = {
1255
+ /**
1256
+ * Workspace name
1257
+ */
1037
1258
  workspaceId: WorkspaceID;
1038
1259
  };
1039
1260
  declare type GetWorkspaceMembersListError = ErrorWrapper<{
@@ -1054,7 +1275,13 @@ declare type GetWorkspaceMembersListVariables = {
1054
1275
  */
1055
1276
  declare const getWorkspaceMembersList: (variables: GetWorkspaceMembersListVariables) => Promise<WorkspaceMembers>;
1056
1277
  declare type UpdateWorkspaceMemberRolePathParams = {
1278
+ /**
1279
+ * Workspace name
1280
+ */
1057
1281
  workspaceId: WorkspaceID;
1282
+ /**
1283
+ * UserID
1284
+ */
1058
1285
  userId: UserID;
1059
1286
  };
1060
1287
  declare type UpdateWorkspaceMemberRoleError = ErrorWrapper<{
@@ -1079,7 +1306,13 @@ declare type UpdateWorkspaceMemberRoleVariables = {
1079
1306
  */
1080
1307
  declare const updateWorkspaceMemberRole: (variables: UpdateWorkspaceMemberRoleVariables) => Promise<undefined>;
1081
1308
  declare type RemoveWorkspaceMemberPathParams = {
1309
+ /**
1310
+ * Workspace name
1311
+ */
1082
1312
  workspaceId: WorkspaceID;
1313
+ /**
1314
+ * UserID
1315
+ */
1083
1316
  userId: UserID;
1084
1317
  };
1085
1318
  declare type RemoveWorkspaceMemberError = ErrorWrapper<{
@@ -1100,6 +1333,9 @@ declare type RemoveWorkspaceMemberVariables = {
1100
1333
  */
1101
1334
  declare const removeWorkspaceMember: (variables: RemoveWorkspaceMemberVariables) => Promise<undefined>;
1102
1335
  declare type InviteWorkspaceMemberPathParams = {
1336
+ /**
1337
+ * Workspace name
1338
+ */
1103
1339
  workspaceId: WorkspaceID;
1104
1340
  };
1105
1341
  declare type InviteWorkspaceMemberError = ErrorWrapper<{
@@ -1116,6 +1352,9 @@ declare type InviteWorkspaceMemberError = ErrorWrapper<{
1116
1352
  payload: SimpleError;
1117
1353
  }>;
1118
1354
  declare type InviteWorkspaceMemberRequestBody = {
1355
+ /**
1356
+ * @format email
1357
+ */
1119
1358
  email: string;
1120
1359
  role: Role;
1121
1360
  };
@@ -1128,7 +1367,13 @@ declare type InviteWorkspaceMemberVariables = {
1128
1367
  */
1129
1368
  declare const inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables) => Promise<WorkspaceInvite>;
1130
1369
  declare type UpdateWorkspaceMemberInvitePathParams = {
1370
+ /**
1371
+ * Workspace name
1372
+ */
1131
1373
  workspaceId: WorkspaceID;
1374
+ /**
1375
+ * Invite identifier
1376
+ */
1132
1377
  inviteId: InviteID;
1133
1378
  };
1134
1379
  declare type UpdateWorkspaceMemberInviteError = ErrorWrapper<{
@@ -1156,7 +1401,13 @@ declare type UpdateWorkspaceMemberInviteVariables = {
1156
1401
  */
1157
1402
  declare const updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables) => Promise<WorkspaceInvite>;
1158
1403
  declare type CancelWorkspaceMemberInvitePathParams = {
1404
+ /**
1405
+ * Workspace name
1406
+ */
1159
1407
  workspaceId: WorkspaceID;
1408
+ /**
1409
+ * Invite identifier
1410
+ */
1160
1411
  inviteId: InviteID;
1161
1412
  };
1162
1413
  declare type CancelWorkspaceMemberInviteError = ErrorWrapper<{
@@ -1177,7 +1428,13 @@ declare type CancelWorkspaceMemberInviteVariables = {
1177
1428
  */
1178
1429
  declare const cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables) => Promise<undefined>;
1179
1430
  declare type ResendWorkspaceMemberInvitePathParams = {
1431
+ /**
1432
+ * Workspace name
1433
+ */
1180
1434
  workspaceId: WorkspaceID;
1435
+ /**
1436
+ * Invite identifier
1437
+ */
1181
1438
  inviteId: InviteID;
1182
1439
  };
1183
1440
  declare type ResendWorkspaceMemberInviteError = ErrorWrapper<{
@@ -1198,7 +1455,13 @@ declare type ResendWorkspaceMemberInviteVariables = {
1198
1455
  */
1199
1456
  declare const resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables) => Promise<undefined>;
1200
1457
  declare type AcceptWorkspaceMemberInvitePathParams = {
1458
+ /**
1459
+ * Workspace name
1460
+ */
1201
1461
  workspaceId: WorkspaceID;
1462
+ /**
1463
+ * Invite Key (secret) for the invited user
1464
+ */
1202
1465
  inviteKey: InviteKey;
1203
1466
  };
1204
1467
  declare type AcceptWorkspaceMemberInviteError = ErrorWrapper<{
@@ -1236,6 +1499,9 @@ declare type GetDatabaseListVariables = {
1236
1499
  */
1237
1500
  declare const getDatabaseList: (variables: GetDatabaseListVariables) => Promise<ListDatabasesResponse>;
1238
1501
  declare type GetBranchListPathParams = {
1502
+ /**
1503
+ * The Database Name
1504
+ */
1239
1505
  dbName: DBName;
1240
1506
  workspace: string;
1241
1507
  };
@@ -1257,6 +1523,9 @@ declare type GetBranchListVariables = {
1257
1523
  */
1258
1524
  declare const getBranchList: (variables: GetBranchListVariables) => Promise<ListBranchesResponse>;
1259
1525
  declare type CreateDatabasePathParams = {
1526
+ /**
1527
+ * The Database Name
1528
+ */
1260
1529
  dbName: DBName;
1261
1530
  workspace: string;
1262
1531
  };
@@ -1268,11 +1537,16 @@ declare type CreateDatabaseError = ErrorWrapper<{
1268
1537
  payload: AuthError;
1269
1538
  }>;
1270
1539
  declare type CreateDatabaseResponse = {
1540
+ /**
1541
+ * @minLength 1
1542
+ */
1271
1543
  databaseName: string;
1272
1544
  branchName?: string;
1273
1545
  };
1274
1546
  declare type CreateDatabaseRequestBody = {
1275
- displayName?: string;
1547
+ /**
1548
+ * @minLength 1
1549
+ */
1276
1550
  branchName?: string;
1277
1551
  ui?: {
1278
1552
  color?: string;
@@ -1288,6 +1562,9 @@ declare type CreateDatabaseVariables = {
1288
1562
  */
1289
1563
  declare const createDatabase: (variables: CreateDatabaseVariables) => Promise<CreateDatabaseResponse>;
1290
1564
  declare type DeleteDatabasePathParams = {
1565
+ /**
1566
+ * The Database Name
1567
+ */
1291
1568
  dbName: DBName;
1292
1569
  workspace: string;
1293
1570
  };
@@ -1309,6 +1586,9 @@ declare type DeleteDatabaseVariables = {
1309
1586
  */
1310
1587
  declare const deleteDatabase: (variables: DeleteDatabaseVariables) => Promise<undefined>;
1311
1588
  declare type GetDatabaseMetadataPathParams = {
1589
+ /**
1590
+ * The Database Name
1591
+ */
1312
1592
  dbName: DBName;
1313
1593
  workspace: string;
1314
1594
  };
@@ -1329,7 +1609,43 @@ declare type GetDatabaseMetadataVariables = {
1329
1609
  * Retrieve metadata of the given database
1330
1610
  */
1331
1611
  declare const getDatabaseMetadata: (variables: GetDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
1612
+ declare type UpdateDatabaseMetadataPathParams = {
1613
+ /**
1614
+ * The Database Name
1615
+ */
1616
+ dbName: DBName;
1617
+ workspace: string;
1618
+ };
1619
+ declare type UpdateDatabaseMetadataError = ErrorWrapper<{
1620
+ status: 400;
1621
+ payload: BadRequestError;
1622
+ } | {
1623
+ status: 401;
1624
+ payload: AuthError;
1625
+ } | {
1626
+ status: 404;
1627
+ payload: SimpleError;
1628
+ }>;
1629
+ declare type UpdateDatabaseMetadataRequestBody = {
1630
+ ui?: {
1631
+ /**
1632
+ * @minLength 1
1633
+ */
1634
+ color?: string;
1635
+ };
1636
+ };
1637
+ declare type UpdateDatabaseMetadataVariables = {
1638
+ body?: UpdateDatabaseMetadataRequestBody;
1639
+ pathParams: UpdateDatabaseMetadataPathParams;
1640
+ } & FetcherExtraProps;
1641
+ /**
1642
+ * Update the color of the selected database
1643
+ */
1644
+ declare const updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
1332
1645
  declare type GetGitBranchesMappingPathParams = {
1646
+ /**
1647
+ * The Database Name
1648
+ */
1333
1649
  dbName: DBName;
1334
1650
  workspace: string;
1335
1651
  };
@@ -1369,6 +1685,9 @@ declare type GetGitBranchesMappingVariables = {
1369
1685
  */
1370
1686
  declare const getGitBranchesMapping: (variables: GetGitBranchesMappingVariables) => Promise<ListGitBranchesResponse>;
1371
1687
  declare type AddGitBranchesEntryPathParams = {
1688
+ /**
1689
+ * The Database Name
1690
+ */
1372
1691
  dbName: DBName;
1373
1692
  workspace: string;
1374
1693
  };
@@ -1380,10 +1699,19 @@ declare type AddGitBranchesEntryError = ErrorWrapper<{
1380
1699
  payload: AuthError;
1381
1700
  }>;
1382
1701
  declare type AddGitBranchesEntryResponse = {
1702
+ /**
1703
+ * Warning message
1704
+ */
1383
1705
  warning?: string;
1384
1706
  };
1385
1707
  declare type AddGitBranchesEntryRequestBody = {
1708
+ /**
1709
+ * The name of the Git branch.
1710
+ */
1386
1711
  gitBranch: string;
1712
+ /**
1713
+ * The name of the Xata branch.
1714
+ */
1387
1715
  xataBranch: BranchName;
1388
1716
  };
1389
1717
  declare type AddGitBranchesEntryVariables = {
@@ -1407,10 +1735,16 @@ declare type AddGitBranchesEntryVariables = {
1407
1735
  */
1408
1736
  declare const addGitBranchesEntry: (variables: AddGitBranchesEntryVariables) => Promise<AddGitBranchesEntryResponse>;
1409
1737
  declare type RemoveGitBranchesEntryPathParams = {
1738
+ /**
1739
+ * The Database Name
1740
+ */
1410
1741
  dbName: DBName;
1411
1742
  workspace: string;
1412
1743
  };
1413
1744
  declare type RemoveGitBranchesEntryQueryParams = {
1745
+ /**
1746
+ * The Git Branch to remove from the mapping
1747
+ */
1414
1748
  gitBranch: string;
1415
1749
  };
1416
1750
  declare type RemoveGitBranchesEntryError = ErrorWrapper<{
@@ -1435,11 +1769,20 @@ declare type RemoveGitBranchesEntryVariables = {
1435
1769
  */
1436
1770
  declare const removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables) => Promise<undefined>;
1437
1771
  declare type ResolveBranchPathParams = {
1772
+ /**
1773
+ * The Database Name
1774
+ */
1438
1775
  dbName: DBName;
1439
1776
  workspace: string;
1440
1777
  };
1441
1778
  declare type ResolveBranchQueryParams = {
1779
+ /**
1780
+ * The Git Branch
1781
+ */
1442
1782
  gitBranch?: string;
1783
+ /**
1784
+ * Default branch to fallback to
1785
+ */
1443
1786
  fallbackBranch?: string;
1444
1787
  };
1445
1788
  declare type ResolveBranchError = ErrorWrapper<{
@@ -1487,6 +1830,9 @@ declare type ResolveBranchVariables = {
1487
1830
  */
1488
1831
  declare const resolveBranch: (variables: ResolveBranchVariables) => Promise<ResolveBranchResponse>;
1489
1832
  declare type ListMigrationRequestsPathParams = {
1833
+ /**
1834
+ * The Database Name
1835
+ */
1490
1836
  dbName: DBName;
1491
1837
  workspace: string;
1492
1838
  };
@@ -1516,6 +1862,9 @@ declare type ListMigrationRequestsVariables = {
1516
1862
  } & FetcherExtraProps;
1517
1863
  declare const listMigrationRequests: (variables: ListMigrationRequestsVariables) => Promise<ListMigrationRequestsResponse>;
1518
1864
  declare type CreateMigrationRequestPathParams = {
1865
+ /**
1866
+ * The Database Name
1867
+ */
1519
1868
  dbName: DBName;
1520
1869
  workspace: string;
1521
1870
  };
@@ -1533,9 +1882,21 @@ declare type CreateMigrationRequestResponse = {
1533
1882
  number: number;
1534
1883
  };
1535
1884
  declare type CreateMigrationRequestRequestBody = {
1885
+ /**
1886
+ * The source branch.
1887
+ */
1536
1888
  source: string;
1889
+ /**
1890
+ * The target branch.
1891
+ */
1537
1892
  target: string;
1893
+ /**
1894
+ * The title.
1895
+ */
1538
1896
  title: string;
1897
+ /**
1898
+ * Optional migration request description.
1899
+ */
1539
1900
  body?: string;
1540
1901
  };
1541
1902
  declare type CreateMigrationRequestVariables = {
@@ -1544,7 +1905,13 @@ declare type CreateMigrationRequestVariables = {
1544
1905
  } & FetcherExtraProps;
1545
1906
  declare const createMigrationRequest: (variables: CreateMigrationRequestVariables) => Promise<CreateMigrationRequestResponse>;
1546
1907
  declare type GetMigrationRequestPathParams = {
1908
+ /**
1909
+ * The Database Name
1910
+ */
1547
1911
  dbName: DBName;
1912
+ /**
1913
+ * The migration request number.
1914
+ */
1548
1915
  mrNumber: number;
1549
1916
  workspace: string;
1550
1917
  };
@@ -1563,7 +1930,13 @@ declare type GetMigrationRequestVariables = {
1563
1930
  } & FetcherExtraProps;
1564
1931
  declare const getMigrationRequest: (variables: GetMigrationRequestVariables) => Promise<MigrationRequest>;
1565
1932
  declare type UpdateMigrationRequestPathParams = {
1933
+ /**
1934
+ * The Database Name
1935
+ */
1566
1936
  dbName: DBName;
1937
+ /**
1938
+ * The migration request number.
1939
+ */
1567
1940
  mrNumber: number;
1568
1941
  workspace: string;
1569
1942
  };
@@ -1578,8 +1951,17 @@ declare type UpdateMigrationRequestError = ErrorWrapper<{
1578
1951
  payload: SimpleError;
1579
1952
  }>;
1580
1953
  declare type UpdateMigrationRequestRequestBody = {
1954
+ /**
1955
+ * New migration request title.
1956
+ */
1581
1957
  title?: string;
1958
+ /**
1959
+ * New migration request description.
1960
+ */
1582
1961
  body?: string;
1962
+ /**
1963
+ * Change the migration request status.
1964
+ */
1583
1965
  status?: 'open' | 'closed';
1584
1966
  };
1585
1967
  declare type UpdateMigrationRequestVariables = {
@@ -1588,7 +1970,13 @@ declare type UpdateMigrationRequestVariables = {
1588
1970
  } & FetcherExtraProps;
1589
1971
  declare const updateMigrationRequest: (variables: UpdateMigrationRequestVariables) => Promise<undefined>;
1590
1972
  declare type ListMigrationRequestsCommitsPathParams = {
1973
+ /**
1974
+ * The Database Name
1975
+ */
1591
1976
  dbName: DBName;
1977
+ /**
1978
+ * The migration request number.
1979
+ */
1592
1980
  mrNumber: number;
1593
1981
  workspace: string;
1594
1982
  };
@@ -1604,15 +1992,32 @@ declare type ListMigrationRequestsCommitsError = ErrorWrapper<{
1604
1992
  }>;
1605
1993
  declare type ListMigrationRequestsCommitsResponse = {
1606
1994
  meta: {
1995
+ /**
1996
+ * last record id
1997
+ */
1607
1998
  cursor: string;
1999
+ /**
2000
+ * true if more records can be fetch
2001
+ */
1608
2002
  more: boolean;
1609
2003
  };
1610
2004
  logs: Commit[];
1611
2005
  };
1612
2006
  declare type ListMigrationRequestsCommitsRequestBody = {
1613
2007
  page?: {
2008
+ /**
2009
+ * Query the next page that follow the cursor.
2010
+ */
1614
2011
  after?: string;
2012
+ /**
2013
+ * Query the previous page before the cursor.
2014
+ */
1615
2015
  before?: string;
2016
+ /**
2017
+ * Set page size. If the size is missing it is read from the cursor. If no cursor is given xata will choose the default page size.
2018
+ *
2019
+ * @default 20
2020
+ */
1616
2021
  size?: number;
1617
2022
  };
1618
2023
  };
@@ -1622,7 +2027,13 @@ declare type ListMigrationRequestsCommitsVariables = {
1622
2027
  } & FetcherExtraProps;
1623
2028
  declare const listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables) => Promise<ListMigrationRequestsCommitsResponse>;
1624
2029
  declare type CompareMigrationRequestPathParams = {
2030
+ /**
2031
+ * The Database Name
2032
+ */
1625
2033
  dbName: DBName;
2034
+ /**
2035
+ * The migration request number.
2036
+ */
1626
2037
  mrNumber: number;
1627
2038
  workspace: string;
1628
2039
  };
@@ -1641,7 +2052,13 @@ declare type CompareMigrationRequestVariables = {
1641
2052
  } & FetcherExtraProps;
1642
2053
  declare const compareMigrationRequest: (variables: CompareMigrationRequestVariables) => Promise<SchemaCompareResponse>;
1643
2054
  declare type GetMigrationRequestIsMergedPathParams = {
2055
+ /**
2056
+ * The Database Name
2057
+ */
1644
2058
  dbName: DBName;
2059
+ /**
2060
+ * The migration request number.
2061
+ */
1645
2062
  mrNumber: number;
1646
2063
  workspace: string;
1647
2064
  };
@@ -1663,7 +2080,13 @@ declare type GetMigrationRequestIsMergedVariables = {
1663
2080
  } & FetcherExtraProps;
1664
2081
  declare const getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables) => Promise<GetMigrationRequestIsMergedResponse>;
1665
2082
  declare type MergeMigrationRequestPathParams = {
2083
+ /**
2084
+ * The Database Name
2085
+ */
1666
2086
  dbName: DBName;
2087
+ /**
2088
+ * The migration request number.
2089
+ */
1667
2090
  mrNumber: number;
1668
2091
  workspace: string;
1669
2092
  };
@@ -1682,6 +2105,9 @@ declare type MergeMigrationRequestVariables = {
1682
2105
  } & FetcherExtraProps;
1683
2106
  declare const mergeMigrationRequest: (variables: MergeMigrationRequestVariables) => Promise<Commit>;
1684
2107
  declare type GetBranchDetailsPathParams = {
2108
+ /**
2109
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2110
+ */
1685
2111
  dbBranchName: DBBranchName;
1686
2112
  workspace: string;
1687
2113
  };
@@ -1700,10 +2126,16 @@ declare type GetBranchDetailsVariables = {
1700
2126
  } & FetcherExtraProps;
1701
2127
  declare const getBranchDetails: (variables: GetBranchDetailsVariables) => Promise<DBBranch>;
1702
2128
  declare type CreateBranchPathParams = {
2129
+ /**
2130
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2131
+ */
1703
2132
  dbBranchName: DBBranchName;
1704
2133
  workspace: string;
1705
2134
  };
1706
2135
  declare type CreateBranchQueryParams = {
2136
+ /**
2137
+ * Name of source branch to branch the new schema from
2138
+ */
1707
2139
  from?: string;
1708
2140
  };
1709
2141
  declare type CreateBranchError = ErrorWrapper<{
@@ -1717,10 +2149,16 @@ declare type CreateBranchError = ErrorWrapper<{
1717
2149
  payload: SimpleError;
1718
2150
  }>;
1719
2151
  declare type CreateBranchResponse = {
2152
+ /**
2153
+ * @minLength 1
2154
+ */
1720
2155
  databaseName: string;
1721
2156
  branchName: string;
1722
2157
  };
1723
2158
  declare type CreateBranchRequestBody = {
2159
+ /**
2160
+ * Select the branch to fork from. Defaults to 'main'
2161
+ */
1724
2162
  from?: string;
1725
2163
  metadata?: BranchMetadata;
1726
2164
  };
@@ -1731,6 +2169,9 @@ declare type CreateBranchVariables = {
1731
2169
  } & FetcherExtraProps;
1732
2170
  declare const createBranch: (variables: CreateBranchVariables) => Promise<CreateBranchResponse>;
1733
2171
  declare type DeleteBranchPathParams = {
2172
+ /**
2173
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2174
+ */
1734
2175
  dbBranchName: DBBranchName;
1735
2176
  workspace: string;
1736
2177
  };
@@ -1752,6 +2193,9 @@ declare type DeleteBranchVariables = {
1752
2193
  */
1753
2194
  declare const deleteBranch: (variables: DeleteBranchVariables) => Promise<undefined>;
1754
2195
  declare type UpdateBranchMetadataPathParams = {
2196
+ /**
2197
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2198
+ */
1755
2199
  dbBranchName: DBBranchName;
1756
2200
  workspace: string;
1757
2201
  };
@@ -1774,6 +2218,9 @@ declare type UpdateBranchMetadataVariables = {
1774
2218
  */
1775
2219
  declare const updateBranchMetadata: (variables: UpdateBranchMetadataVariables) => Promise<undefined>;
1776
2220
  declare type GetBranchMetadataPathParams = {
2221
+ /**
2222
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2223
+ */
1777
2224
  dbBranchName: DBBranchName;
1778
2225
  workspace: string;
1779
2226
  };
@@ -1792,6 +2239,9 @@ declare type GetBranchMetadataVariables = {
1792
2239
  } & FetcherExtraProps;
1793
2240
  declare const getBranchMetadata: (variables: GetBranchMetadataVariables) => Promise<BranchMetadata>;
1794
2241
  declare type GetBranchMigrationHistoryPathParams = {
2242
+ /**
2243
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2244
+ */
1795
2245
  dbBranchName: DBBranchName;
1796
2246
  workspace: string;
1797
2247
  };
@@ -1819,6 +2269,9 @@ declare type GetBranchMigrationHistoryVariables = {
1819
2269
  } & FetcherExtraProps;
1820
2270
  declare const getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables) => Promise<GetBranchMigrationHistoryResponse>;
1821
2271
  declare type ExecuteBranchMigrationPlanPathParams = {
2272
+ /**
2273
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2274
+ */
1822
2275
  dbBranchName: DBBranchName;
1823
2276
  workspace: string;
1824
2277
  };
@@ -1845,6 +2298,9 @@ declare type ExecuteBranchMigrationPlanVariables = {
1845
2298
  */
1846
2299
  declare const executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables) => Promise<undefined>;
1847
2300
  declare type GetBranchMigrationPlanPathParams = {
2301
+ /**
2302
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2303
+ */
1848
2304
  dbBranchName: DBBranchName;
1849
2305
  workspace: string;
1850
2306
  };
@@ -1867,6 +2323,9 @@ declare type GetBranchMigrationPlanVariables = {
1867
2323
  */
1868
2324
  declare const getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables) => Promise<BranchMigrationPlan>;
1869
2325
  declare type CompareBranchWithUserSchemaPathParams = {
2326
+ /**
2327
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2328
+ */
1870
2329
  dbBranchName: DBBranchName;
1871
2330
  workspace: string;
1872
2331
  };
@@ -1889,7 +2348,13 @@ declare type CompareBranchWithUserSchemaVariables = {
1889
2348
  } & FetcherExtraProps;
1890
2349
  declare const compareBranchWithUserSchema: (variables: CompareBranchWithUserSchemaVariables) => Promise<SchemaCompareResponse>;
1891
2350
  declare type CompareBranchSchemasPathParams = {
2351
+ /**
2352
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2353
+ */
1892
2354
  dbBranchName: DBBranchName;
2355
+ /**
2356
+ * The Database Name
2357
+ */
1893
2358
  branchName: BranchName;
1894
2359
  workspace: string;
1895
2360
  };
@@ -1909,6 +2374,9 @@ declare type CompareBranchSchemasVariables = {
1909
2374
  } & FetcherExtraProps;
1910
2375
  declare const compareBranchSchemas: (variables: CompareBranchSchemasVariables) => Promise<SchemaCompareResponse>;
1911
2376
  declare type UpdateBranchSchemaPathParams = {
2377
+ /**
2378
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2379
+ */
1912
2380
  dbBranchName: DBBranchName;
1913
2381
  workspace: string;
1914
2382
  };
@@ -1932,6 +2400,9 @@ declare type UpdateBranchSchemaVariables = {
1932
2400
  } & FetcherExtraProps;
1933
2401
  declare const updateBranchSchema: (variables: UpdateBranchSchemaVariables) => Promise<UpdateBranchSchemaResponse>;
1934
2402
  declare type PreviewBranchSchemaEditPathParams = {
2403
+ /**
2404
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2405
+ */
1935
2406
  dbBranchName: DBBranchName;
1936
2407
  workspace: string;
1937
2408
  };
@@ -1959,6 +2430,9 @@ declare type PreviewBranchSchemaEditVariables = {
1959
2430
  } & FetcherExtraProps;
1960
2431
  declare const previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables) => Promise<PreviewBranchSchemaEditResponse>;
1961
2432
  declare type ApplyBranchSchemaEditPathParams = {
2433
+ /**
2434
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2435
+ */
1962
2436
  dbBranchName: DBBranchName;
1963
2437
  workspace: string;
1964
2438
  };
@@ -1985,6 +2459,9 @@ declare type ApplyBranchSchemaEditVariables = {
1985
2459
  } & FetcherExtraProps;
1986
2460
  declare const applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables) => Promise<ApplyBranchSchemaEditResponse>;
1987
2461
  declare type GetBranchSchemaHistoryPathParams = {
2462
+ /**
2463
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2464
+ */
1988
2465
  dbBranchName: DBBranchName;
1989
2466
  workspace: string;
1990
2467
  };
@@ -2000,15 +2477,32 @@ declare type GetBranchSchemaHistoryError = ErrorWrapper<{
2000
2477
  }>;
2001
2478
  declare type GetBranchSchemaHistoryResponse = {
2002
2479
  meta: {
2480
+ /**
2481
+ * last record id
2482
+ */
2003
2483
  cursor: string;
2484
+ /**
2485
+ * true if more records can be fetch
2486
+ */
2004
2487
  more: boolean;
2005
2488
  };
2006
2489
  logs: Commit[];
2007
2490
  };
2008
2491
  declare type GetBranchSchemaHistoryRequestBody = {
2009
2492
  page?: {
2493
+ /**
2494
+ * Query the next page that follow the cursor.
2495
+ */
2010
2496
  after?: string;
2497
+ /**
2498
+ * Query the previous page before the cursor.
2499
+ */
2011
2500
  before?: string;
2501
+ /**
2502
+ * Set page size. If the size is missing it is read from the cursor. If no cursor is given xata will choose the default page size.
2503
+ *
2504
+ * @default 20
2505
+ */
2012
2506
  size?: number;
2013
2507
  };
2014
2508
  };
@@ -2018,6 +2512,9 @@ declare type GetBranchSchemaHistoryVariables = {
2018
2512
  } & FetcherExtraProps;
2019
2513
  declare const getBranchSchemaHistory: (variables: GetBranchSchemaHistoryVariables) => Promise<GetBranchSchemaHistoryResponse>;
2020
2514
  declare type GetBranchStatsPathParams = {
2515
+ /**
2516
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2517
+ */
2021
2518
  dbBranchName: DBBranchName;
2022
2519
  workspace: string;
2023
2520
  };
@@ -2050,7 +2547,13 @@ declare type GetBranchStatsVariables = {
2050
2547
  */
2051
2548
  declare const getBranchStats: (variables: GetBranchStatsVariables) => Promise<GetBranchStatsResponse>;
2052
2549
  declare type CreateTablePathParams = {
2550
+ /**
2551
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2552
+ */
2053
2553
  dbBranchName: DBBranchName;
2554
+ /**
2555
+ * The Table name
2556
+ */
2054
2557
  tableName: TableName;
2055
2558
  workspace: string;
2056
2559
  };
@@ -2069,6 +2572,9 @@ declare type CreateTableError = ErrorWrapper<{
2069
2572
  }>;
2070
2573
  declare type CreateTableResponse = {
2071
2574
  branchName: string;
2575
+ /**
2576
+ * @minLength 1
2577
+ */
2072
2578
  tableName: string;
2073
2579
  };
2074
2580
  declare type CreateTableVariables = {
@@ -2079,7 +2585,13 @@ declare type CreateTableVariables = {
2079
2585
  */
2080
2586
  declare const createTable: (variables: CreateTableVariables) => Promise<CreateTableResponse>;
2081
2587
  declare type DeleteTablePathParams = {
2588
+ /**
2589
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2590
+ */
2082
2591
  dbBranchName: DBBranchName;
2592
+ /**
2593
+ * The Table name
2594
+ */
2083
2595
  tableName: TableName;
2084
2596
  workspace: string;
2085
2597
  };
@@ -2098,7 +2610,13 @@ declare type DeleteTableVariables = {
2098
2610
  */
2099
2611
  declare const deleteTable: (variables: DeleteTableVariables) => Promise<undefined>;
2100
2612
  declare type UpdateTablePathParams = {
2613
+ /**
2614
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2615
+ */
2101
2616
  dbBranchName: DBBranchName;
2617
+ /**
2618
+ * The Table name
2619
+ */
2102
2620
  tableName: TableName;
2103
2621
  workspace: string;
2104
2622
  };
@@ -2113,6 +2631,9 @@ declare type UpdateTableError = ErrorWrapper<{
2113
2631
  payload: SimpleError;
2114
2632
  }>;
2115
2633
  declare type UpdateTableRequestBody = {
2634
+ /**
2635
+ * @minLength 1
2636
+ */
2116
2637
  name: string;
2117
2638
  };
2118
2639
  declare type UpdateTableVariables = {
@@ -2134,7 +2655,13 @@ declare type UpdateTableVariables = {
2134
2655
  */
2135
2656
  declare const updateTable: (variables: UpdateTableVariables) => Promise<undefined>;
2136
2657
  declare type GetTableSchemaPathParams = {
2658
+ /**
2659
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2660
+ */
2137
2661
  dbBranchName: DBBranchName;
2662
+ /**
2663
+ * The Table name
2664
+ */
2138
2665
  tableName: TableName;
2139
2666
  workspace: string;
2140
2667
  };
@@ -2156,7 +2683,13 @@ declare type GetTableSchemaVariables = {
2156
2683
  } & FetcherExtraProps;
2157
2684
  declare const getTableSchema: (variables: GetTableSchemaVariables) => Promise<GetTableSchemaResponse>;
2158
2685
  declare type SetTableSchemaPathParams = {
2686
+ /**
2687
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2688
+ */
2159
2689
  dbBranchName: DBBranchName;
2690
+ /**
2691
+ * The Table name
2692
+ */
2160
2693
  tableName: TableName;
2161
2694
  workspace: string;
2162
2695
  };
@@ -2182,7 +2715,13 @@ declare type SetTableSchemaVariables = {
2182
2715
  } & FetcherExtraProps;
2183
2716
  declare const setTableSchema: (variables: SetTableSchemaVariables) => Promise<undefined>;
2184
2717
  declare type GetTableColumnsPathParams = {
2718
+ /**
2719
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2720
+ */
2185
2721
  dbBranchName: DBBranchName;
2722
+ /**
2723
+ * The Table name
2724
+ */
2186
2725
  tableName: TableName;
2187
2726
  workspace: string;
2188
2727
  };
@@ -2208,7 +2747,13 @@ declare type GetTableColumnsVariables = {
2208
2747
  */
2209
2748
  declare const getTableColumns: (variables: GetTableColumnsVariables) => Promise<GetTableColumnsResponse>;
2210
2749
  declare type AddTableColumnPathParams = {
2750
+ /**
2751
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2752
+ */
2211
2753
  dbBranchName: DBBranchName;
2754
+ /**
2755
+ * The Table name
2756
+ */
2212
2757
  tableName: TableName;
2213
2758
  workspace: string;
2214
2759
  };
@@ -2233,8 +2778,17 @@ declare type AddTableColumnVariables = {
2233
2778
  */
2234
2779
  declare const addTableColumn: (variables: AddTableColumnVariables) => Promise<MigrationIdResponse>;
2235
2780
  declare type GetColumnPathParams = {
2781
+ /**
2782
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2783
+ */
2236
2784
  dbBranchName: DBBranchName;
2785
+ /**
2786
+ * The Table name
2787
+ */
2237
2788
  tableName: TableName;
2789
+ /**
2790
+ * The Column name
2791
+ */
2238
2792
  columnName: ColumnName;
2239
2793
  workspace: string;
2240
2794
  };
@@ -2256,8 +2810,17 @@ declare type GetColumnVariables = {
2256
2810
  */
2257
2811
  declare const getColumn: (variables: GetColumnVariables) => Promise<Column>;
2258
2812
  declare type DeleteColumnPathParams = {
2813
+ /**
2814
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2815
+ */
2259
2816
  dbBranchName: DBBranchName;
2817
+ /**
2818
+ * The Table name
2819
+ */
2260
2820
  tableName: TableName;
2821
+ /**
2822
+ * The Column name
2823
+ */
2261
2824
  columnName: ColumnName;
2262
2825
  workspace: string;
2263
2826
  };
@@ -2279,8 +2842,17 @@ declare type DeleteColumnVariables = {
2279
2842
  */
2280
2843
  declare const deleteColumn: (variables: DeleteColumnVariables) => Promise<MigrationIdResponse>;
2281
2844
  declare type UpdateColumnPathParams = {
2845
+ /**
2846
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2847
+ */
2282
2848
  dbBranchName: DBBranchName;
2849
+ /**
2850
+ * The Table name
2851
+ */
2283
2852
  tableName: TableName;
2853
+ /**
2854
+ * The Column name
2855
+ */
2284
2856
  columnName: ColumnName;
2285
2857
  workspace: string;
2286
2858
  };
@@ -2295,6 +2867,9 @@ declare type UpdateColumnError = ErrorWrapper<{
2295
2867
  payload: SimpleError;
2296
2868
  }>;
2297
2869
  declare type UpdateColumnRequestBody = {
2870
+ /**
2871
+ * @minLength 1
2872
+ */
2298
2873
  name: string;
2299
2874
  };
2300
2875
  declare type UpdateColumnVariables = {
@@ -2306,11 +2881,20 @@ declare type UpdateColumnVariables = {
2306
2881
  */
2307
2882
  declare const updateColumn: (variables: UpdateColumnVariables) => Promise<MigrationIdResponse>;
2308
2883
  declare type InsertRecordPathParams = {
2884
+ /**
2885
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2886
+ */
2309
2887
  dbBranchName: DBBranchName;
2888
+ /**
2889
+ * The Table name
2890
+ */
2310
2891
  tableName: TableName;
2311
2892
  workspace: string;
2312
2893
  };
2313
2894
  declare type InsertRecordQueryParams = {
2895
+ /**
2896
+ * Column filters
2897
+ */
2314
2898
  columns?: ColumnsProjection;
2315
2899
  };
2316
2900
  declare type InsertRecordError = ErrorWrapper<{
@@ -2333,12 +2917,24 @@ declare type InsertRecordVariables = {
2333
2917
  */
2334
2918
  declare const insertRecord: (variables: InsertRecordVariables) => Promise<RecordUpdateResponse>;
2335
2919
  declare type InsertRecordWithIDPathParams = {
2920
+ /**
2921
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2922
+ */
2336
2923
  dbBranchName: DBBranchName;
2924
+ /**
2925
+ * The Table name
2926
+ */
2337
2927
  tableName: TableName;
2928
+ /**
2929
+ * The Record name
2930
+ */
2338
2931
  recordId: RecordID;
2339
2932
  workspace: string;
2340
2933
  };
2341
2934
  declare type InsertRecordWithIDQueryParams = {
2935
+ /**
2936
+ * Column filters
2937
+ */
2342
2938
  columns?: ColumnsProjection;
2343
2939
  createOnly?: boolean;
2344
2940
  ifVersion?: number;
@@ -2366,12 +2962,24 @@ declare type InsertRecordWithIDVariables = {
2366
2962
  */
2367
2963
  declare const insertRecordWithID: (variables: InsertRecordWithIDVariables) => Promise<RecordUpdateResponse>;
2368
2964
  declare type UpdateRecordWithIDPathParams = {
2965
+ /**
2966
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2967
+ */
2369
2968
  dbBranchName: DBBranchName;
2969
+ /**
2970
+ * The Table name
2971
+ */
2370
2972
  tableName: TableName;
2973
+ /**
2974
+ * The Record name
2975
+ */
2371
2976
  recordId: RecordID;
2372
2977
  workspace: string;
2373
2978
  };
2374
2979
  declare type UpdateRecordWithIDQueryParams = {
2980
+ /**
2981
+ * Column filters
2982
+ */
2375
2983
  columns?: ColumnsProjection;
2376
2984
  ifVersion?: number;
2377
2985
  };
@@ -2395,12 +3003,24 @@ declare type UpdateRecordWithIDVariables = {
2395
3003
  } & FetcherExtraProps;
2396
3004
  declare const updateRecordWithID: (variables: UpdateRecordWithIDVariables) => Promise<RecordUpdateResponse>;
2397
3005
  declare type UpsertRecordWithIDPathParams = {
3006
+ /**
3007
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3008
+ */
2398
3009
  dbBranchName: DBBranchName;
3010
+ /**
3011
+ * The Table name
3012
+ */
2399
3013
  tableName: TableName;
3014
+ /**
3015
+ * The Record name
3016
+ */
2400
3017
  recordId: RecordID;
2401
3018
  workspace: string;
2402
3019
  };
2403
3020
  declare type UpsertRecordWithIDQueryParams = {
3021
+ /**
3022
+ * Column filters
3023
+ */
2404
3024
  columns?: ColumnsProjection;
2405
3025
  ifVersion?: number;
2406
3026
  };
@@ -2424,12 +3044,24 @@ declare type UpsertRecordWithIDVariables = {
2424
3044
  } & FetcherExtraProps;
2425
3045
  declare const upsertRecordWithID: (variables: UpsertRecordWithIDVariables) => Promise<RecordUpdateResponse>;
2426
3046
  declare type DeleteRecordPathParams = {
3047
+ /**
3048
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3049
+ */
2427
3050
  dbBranchName: DBBranchName;
3051
+ /**
3052
+ * The Table name
3053
+ */
2428
3054
  tableName: TableName;
3055
+ /**
3056
+ * The Record name
3057
+ */
2429
3058
  recordId: RecordID;
2430
3059
  workspace: string;
2431
3060
  };
2432
3061
  declare type DeleteRecordQueryParams = {
3062
+ /**
3063
+ * Column filters
3064
+ */
2433
3065
  columns?: ColumnsProjection;
2434
3066
  };
2435
3067
  declare type DeleteRecordError = ErrorWrapper<{
@@ -2448,12 +3080,24 @@ declare type DeleteRecordVariables = {
2448
3080
  } & FetcherExtraProps;
2449
3081
  declare const deleteRecord: (variables: DeleteRecordVariables) => Promise<XataRecord$1>;
2450
3082
  declare type GetRecordPathParams = {
3083
+ /**
3084
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3085
+ */
2451
3086
  dbBranchName: DBBranchName;
3087
+ /**
3088
+ * The Table name
3089
+ */
2452
3090
  tableName: TableName;
3091
+ /**
3092
+ * The Record name
3093
+ */
2453
3094
  recordId: RecordID;
2454
3095
  workspace: string;
2455
3096
  };
2456
3097
  declare type GetRecordQueryParams = {
3098
+ /**
3099
+ * Column filters
3100
+ */
2457
3101
  columns?: ColumnsProjection;
2458
3102
  };
2459
3103
  declare type GetRecordError = ErrorWrapper<{
@@ -2475,11 +3119,20 @@ declare type GetRecordVariables = {
2475
3119
  */
2476
3120
  declare const getRecord: (variables: GetRecordVariables) => Promise<XataRecord$1>;
2477
3121
  declare type BulkInsertTableRecordsPathParams = {
3122
+ /**
3123
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3124
+ */
2478
3125
  dbBranchName: DBBranchName;
3126
+ /**
3127
+ * The Table name
3128
+ */
2479
3129
  tableName: TableName;
2480
3130
  workspace: string;
2481
3131
  };
2482
3132
  declare type BulkInsertTableRecordsQueryParams = {
3133
+ /**
3134
+ * Column filters
3135
+ */
2483
3136
  columns?: ColumnsProjection;
2484
3137
  };
2485
3138
  declare type BulkInsertTableRecordsError = ErrorWrapper<{
@@ -2508,7 +3161,13 @@ declare type BulkInsertTableRecordsVariables = {
2508
3161
  */
2509
3162
  declare const bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables) => Promise<BulkInsertResponse>;
2510
3163
  declare type QueryTablePathParams = {
3164
+ /**
3165
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3166
+ */
2511
3167
  dbBranchName: DBBranchName;
3168
+ /**
3169
+ * The Table name
3170
+ */
2512
3171
  tableName: TableName;
2513
3172
  workspace: string;
2514
3173
  };
@@ -2562,8 +3221,9 @@ declare type QueryTableVariables = {
2562
3221
  * If the `columns` array is not specified, all columns are included. For link
2563
3222
  * fields, only the ID column of the linked records is included in the response.
2564
3223
  *
2565
- * If the `columns` array is specified, only the selected columns are included.
2566
- * The `*` wildcard can be used to select all columns of the given array
3224
+ * If the `columns` array is specified, only the selected and internal
3225
+ * columns `id` and `xata` are included. The `*` wildcard can be used to
3226
+ * select all columns.
2567
3227
  *
2568
3228
  * For objects and link fields, if the column name of the object is specified, we
2569
3229
  * include all of its sub-keys. If only some sub-keys are specified (via dotted
@@ -2679,6 +3339,10 @@ declare type QueryTableVariables = {
2679
3339
  *
2680
3340
  * ```json
2681
3341
  * {
3342
+ * "id": "id1"
3343
+ * "xata": {
3344
+ * "version": 0
3345
+ * }
2682
3346
  * "name": "Kilian",
2683
3347
  * "address": {
2684
3348
  * "street": "New street"
@@ -2698,6 +3362,10 @@ declare type QueryTableVariables = {
2698
3362
  *
2699
3363
  * ```json
2700
3364
  * {
3365
+ * "id": "id1"
3366
+ * "xata": {
3367
+ * "version": 0
3368
+ * }
2701
3369
  * "name": "Kilian",
2702
3370
  * "email": "kilian@gmail.com",
2703
3371
  * "address": {
@@ -2727,6 +3395,10 @@ declare type QueryTableVariables = {
2727
3395
  *
2728
3396
  * ```json
2729
3397
  * {
3398
+ * "id": "id1"
3399
+ * "xata": {
3400
+ * "version": 0
3401
+ * }
2730
3402
  * "name": "Kilian",
2731
3403
  * "email": "kilian@gmail.com",
2732
3404
  * "address": {
@@ -3255,7 +3927,13 @@ declare type QueryTableVariables = {
3255
3927
  */
3256
3928
  declare const queryTable: (variables: QueryTableVariables) => Promise<QueryResponse>;
3257
3929
  declare type SearchTablePathParams = {
3930
+ /**
3931
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3932
+ */
3258
3933
  dbBranchName: DBBranchName;
3934
+ /**
3935
+ * The Table name
3936
+ */
3259
3937
  tableName: TableName;
3260
3938
  workspace: string;
3261
3939
  };
@@ -3270,6 +3948,11 @@ declare type SearchTableError = ErrorWrapper<{
3270
3948
  payload: SimpleError;
3271
3949
  }>;
3272
3950
  declare type SearchTableRequestBody = {
3951
+ /**
3952
+ * The query string.
3953
+ *
3954
+ * @minLength 1
3955
+ */
3273
3956
  query: string;
3274
3957
  fuzziness?: FuzzinessExpression;
3275
3958
  prefix?: PrefixExpression;
@@ -3290,6 +3973,9 @@ declare type SearchTableVariables = {
3290
3973
  */
3291
3974
  declare const searchTable: (variables: SearchTableVariables) => Promise<SearchResponse>;
3292
3975
  declare type SearchBranchPathParams = {
3976
+ /**
3977
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3978
+ */
3293
3979
  dbBranchName: DBBranchName;
3294
3980
  workspace: string;
3295
3981
  };
@@ -3304,13 +3990,25 @@ declare type SearchBranchError = ErrorWrapper<{
3304
3990
  payload: SimpleError;
3305
3991
  }>;
3306
3992
  declare type SearchBranchRequestBody = {
3993
+ /**
3994
+ * An array with the tables in which to search. By default, all tables are included. Optionally, filters can be included that apply to each table.
3995
+ */
3307
3996
  tables?: (string | {
3997
+ /**
3998
+ * The name of the table.
3999
+ */
3308
4000
  table: string;
3309
4001
  filter?: FilterExpression;
3310
4002
  boosters?: BoosterExpression[];
3311
4003
  })[];
4004
+ /**
4005
+ * The query string.
4006
+ *
4007
+ * @minLength 1
4008
+ */
3312
4009
  query: string;
3313
4010
  fuzziness?: FuzzinessExpression;
4011
+ prefix?: PrefixExpression;
3314
4012
  highlight?: HighlightExpression;
3315
4013
  };
3316
4014
  declare type SearchBranchVariables = {
@@ -3321,6 +4019,77 @@ declare type SearchBranchVariables = {
3321
4019
  * Run a free text search operation across the database branch.
3322
4020
  */
3323
4021
  declare const searchBranch: (variables: SearchBranchVariables) => Promise<SearchResponse>;
4022
+ declare type SummarizeTablePathParams = {
4023
+ /**
4024
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4025
+ */
4026
+ dbBranchName: DBBranchName;
4027
+ /**
4028
+ * The Table name
4029
+ */
4030
+ tableName: TableName;
4031
+ workspace: string;
4032
+ };
4033
+ declare type SummarizeTableError = ErrorWrapper<{
4034
+ status: 400;
4035
+ payload: BadRequestError;
4036
+ } | {
4037
+ status: 401;
4038
+ payload: AuthError;
4039
+ } | {
4040
+ status: 404;
4041
+ payload: SimpleError;
4042
+ }>;
4043
+ declare type SummarizeTableRequestBody = {
4044
+ columns?: ColumnsProjection;
4045
+ summaries?: SummaryExpressionList;
4046
+ sort?: SortExpression;
4047
+ };
4048
+ declare type SummarizeTableVariables = {
4049
+ body?: SummarizeTableRequestBody;
4050
+ pathParams: SummarizeTablePathParams;
4051
+ } & FetcherExtraProps;
4052
+ /**
4053
+ * This endpoint allows you to (optionally) define groups, and then to run
4054
+ * calculations on the values in each group. This is most helpful when you'd
4055
+ * like to understand the data you have in your database.
4056
+ *
4057
+ * A group is a combination of unique values. If you create a group for `sold_by`,
4058
+ * `product_name`, we will return one row for every combination of `sold_by` and
4059
+ * `product_name` you have in your database. When you want to calculate statistics,
4060
+ * you define these groups and ask Xata to calculate data on each group.
4061
+ *
4062
+ * **Some questions you can ask of your data:**
4063
+ *
4064
+ * How many records do I have in this table?
4065
+ * - Set `columns: []` as we we want data from the entire table, so we ask for no groups.
4066
+ * - Set `summaries: {"total": {"count": "*"}}` in order to see the count of all records.
4067
+ * We use `count: *` here we'd like to know the total amount of rows; ignoring whether
4068
+ * they are `null` or not.
4069
+ *
4070
+ * What are the top total sales for each product?
4071
+ * - Set `columns: [product_name]` as we'd like to run calculations on each unique product
4072
+ * name in our table. Setting `columns` like this will produce one row per unique product
4073
+ * name.
4074
+ * - Set `summaries: {"total_sales": {"count": "product_name"}}` as we'd like to create a
4075
+ * field called "total_sales" for each group. This field will count all rows in each group
4076
+ * with non-null product names.
4077
+ * - Set `sort: [{"total_sales": "desc"}]` in order to bring the rows with the highest
4078
+ * total_sales field to the top.
4079
+ *
4080
+ * `columns`: tells Xata how to create each group. If you add `product_id` we will create
4081
+ * a new group for every unique `product_id`.
4082
+ *
4083
+ * `summaries`: tells Xata which calculations to run on each group.
4084
+ *
4085
+ * `sort`: tells Xata in which order you'd like to see results. You may sort by fields
4086
+ * specified in `columns` as well as the summary names defined in `summaries`.
4087
+ *
4088
+ * note: Sorting on summarized values can be slower on very large tables; this will impact
4089
+ * your rate limit significantly more than other queries. Try use `filter` [coming soon] to
4090
+ * reduce the amount of data being processed in order to reduce impact on your limits.
4091
+ */
4092
+ declare const summarizeTable: (variables: SummarizeTableVariables) => Promise<SummarizeResponse>;
3324
4093
  declare const operationsByTag: {
3325
4094
  users: {
3326
4095
  getUser: (variables: GetUserVariables) => Promise<UserWithID>;
@@ -3350,6 +4119,7 @@ declare const operationsByTag: {
3350
4119
  createDatabase: (variables: CreateDatabaseVariables) => Promise<CreateDatabaseResponse>;
3351
4120
  deleteDatabase: (variables: DeleteDatabaseVariables) => Promise<undefined>;
3352
4121
  getDatabaseMetadata: (variables: GetDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
4122
+ updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
3353
4123
  getGitBranchesMapping: (variables: GetGitBranchesMappingVariables) => Promise<ListGitBranchesResponse>;
3354
4124
  addGitBranchesEntry: (variables: AddGitBranchesEntryVariables) => Promise<AddGitBranchesEntryResponse>;
3355
4125
  removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables) => Promise<undefined>;
@@ -3408,6 +4178,7 @@ declare const operationsByTag: {
3408
4178
  queryTable: (variables: QueryTableVariables) => Promise<QueryResponse>;
3409
4179
  searchTable: (variables: SearchTableVariables) => Promise<SearchResponse>;
3410
4180
  searchBranch: (variables: SearchBranchVariables) => Promise<SearchResponse>;
4181
+ summarizeTable: (variables: SummarizeTableVariables) => Promise<SummarizeResponse>;
3411
4182
  };
3412
4183
  };
3413
4184
 
@@ -3470,6 +4241,7 @@ declare class DatabaseApi {
3470
4241
  createDatabase(workspace: WorkspaceID, dbName: DBName, options?: CreateDatabaseRequestBody): Promise<CreateDatabaseResponse>;
3471
4242
  deleteDatabase(workspace: WorkspaceID, dbName: DBName): Promise<void>;
3472
4243
  getDatabaseMetadata(workspace: WorkspaceID, dbName: DBName): Promise<DatabaseMetadata>;
4244
+ updateDatabaseMetadata(workspace: WorkspaceID, dbName: DBName, options?: UpdateDatabaseMetadataRequestBody): Promise<DatabaseMetadata>;
3473
4245
  getGitBranchesMapping(workspace: WorkspaceID, dbName: DBName): Promise<ListGitBranchesResponse>;
3474
4246
  addGitBranchesEntry(workspace: WorkspaceID, dbName: DBName, body: AddGitBranchesEntryRequestBody): Promise<AddGitBranchesEntryResponse>;
3475
4247
  removeGitBranchesEntry(workspace: WorkspaceID, dbName: DBName, gitBranch: string): Promise<void>;
@@ -3513,6 +4285,7 @@ declare class RecordsApi {
3513
4285
  queryTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: QueryTableRequestBody): Promise<QueryResponse>;
3514
4286
  searchTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: SearchTableRequestBody): Promise<SearchResponse>;
3515
4287
  searchBranch(workspace: WorkspaceID, database: DBName, branch: BranchName, query: SearchBranchRequestBody): Promise<SearchResponse>;
4288
+ summarizeTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: SummarizeTableRequestBody): Promise<SummarizeResponse>;
3516
4289
  }
3517
4290
  declare class MigrationRequestsApi {
3518
4291
  private extraProps;
@@ -3643,25 +4416,7 @@ interface XataRecord<OriginalRecord extends XataRecord<any> = XataRecord<any>> e
3643
4416
  */
3644
4417
  delete(): Promise<Readonly<SelectedPick<OriginalRecord, ['*']>> | null>;
3645
4418
  }
3646
- declare type Link<Record extends XataRecord> = Omit<XataRecord, 'read' | 'update'> & {
3647
- /**
3648
- * Retrieves a refreshed copy of the current record from the database.
3649
- */
3650
- read<K extends SelectableColumn<Record>>(columns?: K[]): Promise<Readonly<SelectedPick<Record, typeof columns extends SelectableColumn<Record>[] ? typeof columns : ['*']>> | null>;
3651
- /**
3652
- * Performs a partial update of the current record. On success a new object is
3653
- * returned and the current object is not mutated.
3654
- * @param partialUpdate The columns and their values that have to be updated.
3655
- * @returns A new record containing the latest values for all the columns of the current record.
3656
- */
3657
- update<K extends SelectableColumn<Record>>(partialUpdate: Partial<EditableData<Record>>, columns?: K[]): Promise<Readonly<SelectedPick<Record, typeof columns extends SelectableColumn<Record>[] ? typeof columns : ['*']>>>;
3658
- /**
3659
- * Performs a deletion of the current record in the database.
3660
- *
3661
- * @throws If the record was already deleted or if an error happened while performing the deletion.
3662
- */
3663
- delete(): Promise<void>;
3664
- };
4419
+ declare type Link<Record extends XataRecord> = XataRecord<Record>;
3665
4420
  declare type XataRecordMetadata = {
3666
4421
  /**
3667
4422
  * Number that is increased every time the record is updated.
@@ -3943,9 +4698,6 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
3943
4698
  * @returns A new Query object.
3944
4699
  */
3945
4700
  filter(filters?: Filter<Record>): Query<Record, Result>;
3946
- defaultFilter<T>(column: string, value: T): T | {
3947
- $includes: (T & string) | (T & string[]);
3948
- };
3949
4701
  /**
3950
4702
  * Builds a new query with a new sort option.
3951
4703
  * @param column The column name.
@@ -4068,6 +4820,26 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
4068
4820
  * @returns The first record that matches the query, or null if no record matched the query.
4069
4821
  */
4070
4822
  getFirst(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'>): Promise<Result | null>;
4823
+ /**
4824
+ * Performs the query in the database and returns the first result.
4825
+ * @returns The first record that matches the query, or null if no record matched the query.
4826
+ * @throws if there are no results.
4827
+ */
4828
+ getFirstOrThrow(): Promise<Result>;
4829
+ /**
4830
+ * Performs the query in the database and returns the first result.
4831
+ * @param options Additional options to be used when performing the query.
4832
+ * @returns The first record that matches the query, or null if no record matched the query.
4833
+ * @throws if there are no results.
4834
+ */
4835
+ getFirstOrThrow<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>>;
4836
+ /**
4837
+ * Performs the query in the database and returns the first result.
4838
+ * @param options Additional options to be used when performing the query.
4839
+ * @returns The first record that matches the query, or null if no record matched the query.
4840
+ * @throws if there are no results.
4841
+ */
4842
+ getFirstOrThrow(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'>): Promise<Result>;
4071
4843
  /**
4072
4844
  * Builds a new query object adding a cache TTL in milliseconds.
4073
4845
  * @param ttl The cache TTL in milliseconds.
@@ -4307,6 +5079,66 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
4307
5079
  * @returns The persisted records for the given ids in order (if a record could not be found null is returned).
4308
5080
  */
4309
5081
  abstract read(objects: Identifiable[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
5082
+ /**
5083
+ * Queries a single record from the table given its unique id.
5084
+ * @param id The unique id.
5085
+ * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
5086
+ * @returns The persisted record for the given id.
5087
+ * @throws If the record could not be found.
5088
+ */
5089
+ abstract readOrThrow<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
5090
+ /**
5091
+ * Queries a single record from the table given its unique id.
5092
+ * @param id The unique id.
5093
+ * @returns The persisted record for the given id.
5094
+ * @throws If the record could not be found.
5095
+ */
5096
+ abstract readOrThrow(id: string): Promise<Readonly<SelectedPick<Record, ['*']>>>;
5097
+ /**
5098
+ * Queries multiple records from the table given their unique id.
5099
+ * @param ids The unique ids array.
5100
+ * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
5101
+ * @returns The persisted records for the given ids in order.
5102
+ * @throws If one or more records could not be found.
5103
+ */
5104
+ abstract readOrThrow<K extends SelectableColumn<Record>>(ids: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
5105
+ /**
5106
+ * Queries multiple records from the table given their unique id.
5107
+ * @param ids The unique ids array.
5108
+ * @returns The persisted records for the given ids in order.
5109
+ * @throws If one or more records could not be found.
5110
+ */
5111
+ abstract readOrThrow(ids: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
5112
+ /**
5113
+ * Queries a single record from the table by the id in the object.
5114
+ * @param object Object containing the id of the record.
5115
+ * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
5116
+ * @returns The persisted record for the given id.
5117
+ * @throws If the record could not be found.
5118
+ */
5119
+ abstract readOrThrow<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
5120
+ /**
5121
+ * Queries a single record from the table by the id in the object.
5122
+ * @param object Object containing the id of the record.
5123
+ * @returns The persisted record for the given id.
5124
+ * @throws If the record could not be found.
5125
+ */
5126
+ abstract readOrThrow(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
5127
+ /**
5128
+ * Queries multiple records from the table by the ids in the objects.
5129
+ * @param objects Array of objects containing the ids of the records.
5130
+ * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
5131
+ * @returns The persisted records for the given ids in order.
5132
+ * @throws If one or more records could not be found.
5133
+ */
5134
+ abstract readOrThrow<K extends SelectableColumn<Record>>(objects: Identifiable[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
5135
+ /**
5136
+ * Queries multiple records from the table by the ids in the objects.
5137
+ * @param objects Array of objects containing the ids of the records.
5138
+ * @returns The persisted records for the given ids in order.
5139
+ * @throws If one or more records could not be found.
5140
+ */
5141
+ abstract readOrThrow(objects: Identifiable[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
4310
5142
  /**
4311
5143
  * Partially update a single record.
4312
5144
  * @param object An object with its id and the columns to be updated.
@@ -4348,6 +5180,53 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
4348
5180
  * @returns Array of the persisted records in order (if a record could not be found null is returned).
4349
5181
  */
4350
5182
  abstract update(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
5183
+ /**
5184
+ * Partially update a single record.
5185
+ * @param object An object with its id and the columns to be updated.
5186
+ * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
5187
+ * @returns The full persisted record.
5188
+ * @throws If the record could not be found.
5189
+ */
5190
+ abstract updateOrThrow<K extends SelectableColumn<Record>>(object: Partial<EditableData<Record>> & Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
5191
+ /**
5192
+ * Partially update a single record.
5193
+ * @param object An object with its id and the columns to be updated.
5194
+ * @returns The full persisted record.
5195
+ * @throws If the record could not be found.
5196
+ */
5197
+ abstract updateOrThrow(object: Partial<EditableData<Record>> & Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
5198
+ /**
5199
+ * Partially update a single record given its unique id.
5200
+ * @param id The unique id.
5201
+ * @param object The column names and their values that have to be updated.
5202
+ * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
5203
+ * @returns The full persisted record.
5204
+ * @throws If the record could not be found.
5205
+ */
5206
+ abstract updateOrThrow<K extends SelectableColumn<Record>>(id: string, object: Partial<EditableData<Record>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
5207
+ /**
5208
+ * Partially update a single record given its unique id.
5209
+ * @param id The unique id.
5210
+ * @param object The column names and their values that have to be updated.
5211
+ * @returns The full persisted record.
5212
+ * @throws If the record could not be found.
5213
+ */
5214
+ abstract updateOrThrow(id: string, object: Partial<EditableData<Record>>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
5215
+ /**
5216
+ * Partially updates multiple records.
5217
+ * @param objects An array of objects with their ids and columns to be updated.
5218
+ * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
5219
+ * @returns Array of the persisted records in order.
5220
+ * @throws If one or more records could not be found.
5221
+ */
5222
+ abstract updateOrThrow<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
5223
+ /**
5224
+ * Partially updates multiple records.
5225
+ * @param objects An array of objects with their ids and columns to be updated.
5226
+ * @returns Array of the persisted records in order.
5227
+ * @throws If one or more records could not be found.
5228
+ */
5229
+ abstract updateOrThrow(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
4351
5230
  /**
4352
5231
  * Creates or updates a single record. If a record exists with the given id,
4353
5232
  * it will be update, otherwise a new record will be created.
@@ -4447,6 +5326,66 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
4447
5326
  * @returns Array of the deleted records in order (if a record could not be found null is returned).
4448
5327
  */
4449
5328
  abstract delete(objects: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
5329
+ /**
5330
+ * Deletes a record given its unique id.
5331
+ * @param object An object with a unique id.
5332
+ * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
5333
+ * @returns The deleted record, null if the record could not be found.
5334
+ * @throws If the record could not be found.
5335
+ */
5336
+ abstract deleteOrThrow<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
5337
+ /**
5338
+ * Deletes a record given its unique id.
5339
+ * @param object An object with a unique id.
5340
+ * @returns The deleted record, null if the record could not be found.
5341
+ * @throws If the record could not be found.
5342
+ */
5343
+ abstract deleteOrThrow(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
5344
+ /**
5345
+ * Deletes a record given a unique id.
5346
+ * @param id The unique id.
5347
+ * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
5348
+ * @returns The deleted record, null if the record could not be found.
5349
+ * @throws If the record could not be found.
5350
+ */
5351
+ abstract deleteOrThrow<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
5352
+ /**
5353
+ * Deletes a record given a unique id.
5354
+ * @param id The unique id.
5355
+ * @returns The deleted record, null if the record could not be found.
5356
+ * @throws If the record could not be found.
5357
+ */
5358
+ abstract deleteOrThrow(id: string): Promise<Readonly<SelectedPick<Record, ['*']>>>;
5359
+ /**
5360
+ * Deletes multiple records given an array of objects with ids.
5361
+ * @param objects An array of objects with unique ids.
5362
+ * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
5363
+ * @returns Array of the deleted records in order (if a record could not be found null is returned).
5364
+ * @throws If one or more records could not be found.
5365
+ */
5366
+ abstract deleteOrThrow<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
5367
+ /**
5368
+ * Deletes multiple records given an array of objects with ids.
5369
+ * @param objects An array of objects with unique ids.
5370
+ * @returns Array of the deleted records in order (if a record could not be found null is returned).
5371
+ * @throws If one or more records could not be found.
5372
+ */
5373
+ abstract deleteOrThrow(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
5374
+ /**
5375
+ * Deletes multiple records given an array of unique ids.
5376
+ * @param objects An array of ids.
5377
+ * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
5378
+ * @returns Array of the deleted records in order (if a record could not be found null is returned).
5379
+ * @throws If one or more records could not be found.
5380
+ */
5381
+ abstract deleteOrThrow<K extends SelectableColumn<Record>>(objects: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
5382
+ /**
5383
+ * Deletes multiple records given an array of unique ids.
5384
+ * @param objects An array of ids.
5385
+ * @returns Array of the deleted records in order.
5386
+ * @throws If one or more records could not be found.
5387
+ */
5388
+ abstract deleteOrThrow(objects: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
4450
5389
  /**
4451
5390
  * Search for records in the table.
4452
5391
  * @param query The query to search for.
@@ -4484,12 +5423,26 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
4484
5423
  read(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
4485
5424
  read<K extends SelectableColumn<Record>>(objects: Identifiable[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
4486
5425
  read(objects: Identifiable[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
5426
+ readOrThrow<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
5427
+ readOrThrow(id: string): Promise<Readonly<SelectedPick<Record, ['*']>>>;
5428
+ readOrThrow<K extends SelectableColumn<Record>>(ids: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
5429
+ readOrThrow(ids: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
5430
+ readOrThrow<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
5431
+ readOrThrow(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
5432
+ readOrThrow<K extends SelectableColumn<Record>>(objects: Identifiable[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
5433
+ readOrThrow(objects: Identifiable[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
4487
5434
  update<K extends SelectableColumn<Record>>(object: Partial<EditableData<Record>> & Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
4488
5435
  update(object: Partial<EditableData<Record>> & Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
4489
5436
  update<K extends SelectableColumn<Record>>(id: string, object: Partial<EditableData<Record>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
4490
5437
  update(id: string, object: Partial<EditableData<Record>>): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
4491
5438
  update<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
4492
5439
  update(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
5440
+ updateOrThrow<K extends SelectableColumn<Record>>(object: Partial<EditableData<Record>> & Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
5441
+ updateOrThrow(object: Partial<EditableData<Record>> & Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
5442
+ updateOrThrow<K extends SelectableColumn<Record>>(id: string, object: Partial<EditableData<Record>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
5443
+ updateOrThrow(id: string, object: Partial<EditableData<Record>>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
5444
+ updateOrThrow<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
5445
+ updateOrThrow(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
4493
5446
  createOrUpdate<K extends SelectableColumn<Record>>(object: EditableData<Record> & Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
4494
5447
  createOrUpdate(object: EditableData<Record> & Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
4495
5448
  createOrUpdate<K extends SelectableColumn<Record>>(id: string, object: Omit<EditableData<Record>, 'id'>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
@@ -4504,6 +5457,14 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
4504
5457
  delete(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
4505
5458
  delete<K extends SelectableColumn<Record>>(objects: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
4506
5459
  delete(objects: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
5460
+ deleteOrThrow<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
5461
+ deleteOrThrow(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
5462
+ deleteOrThrow<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
5463
+ deleteOrThrow(id: string): Promise<Readonly<SelectedPick<Record, ['*']>>>;
5464
+ deleteOrThrow<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
5465
+ deleteOrThrow(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
5466
+ deleteOrThrow<K extends SelectableColumn<Record>>(objects: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
5467
+ deleteOrThrow(objects: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
4507
5468
  search(query: string, options?: {
4508
5469
  fuzziness?: FuzzinessExpression;
4509
5470
  prefix?: PrefixExpression;
@@ -4519,6 +5480,7 @@ declare type BaseSchema = {
4519
5480
  columns: readonly ({
4520
5481
  name: string;
4521
5482
  type: Column['type'];
5483
+ notNull?: boolean;
4522
5484
  } | {
4523
5485
  name: string;
4524
5486
  type: 'link';
@@ -4548,10 +5510,10 @@ declare type TableType<Tables, TableName> = Tables & {
4548
5510
  } ? Columns extends readonly unknown[] ? Columns[number] extends {
4549
5511
  name: string;
4550
5512
  type: string;
4551
- } ? Identifiable & {
4552
- [K in Columns[number]['name']]?: PropertyType<Tables, Columns[number], K>;
4553
- } : never : never : never : never;
4554
- declare type PropertyType<Tables, Properties, PropertyName> = Properties & {
5513
+ } ? Identifiable & UnionToIntersection<Values<{
5514
+ [K in Columns[number]['name']]: PropertyType<Tables, Columns[number], K>;
5515
+ }>> : never : never : never : never;
5516
+ declare type PropertyType<Tables, Properties, PropertyName extends PropertyKey> = Properties & {
4555
5517
  name: PropertyName;
4556
5518
  } extends infer Property ? Property extends {
4557
5519
  name: string;
@@ -4560,12 +5522,18 @@ declare type PropertyType<Tables, Properties, PropertyName> = Properties & {
4560
5522
  table: infer LinkedTable;
4561
5523
  };
4562
5524
  columns?: infer ObjectColumns;
4563
- } ? (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 'object' ? ObjectColumns extends readonly unknown[] ? ObjectColumns[number] extends {
5525
+ notNull?: infer NotNull;
5526
+ } ? NotNull extends true ? {
5527
+ [K in PropertyName]: InnerType<Type, ObjectColumns, Tables, LinkedTable>;
5528
+ } : {
5529
+ [K in PropertyName]?: InnerType<Type, ObjectColumns, Tables, LinkedTable> | null;
5530
+ } : never : never;
5531
+ declare 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 'object' ? ObjectColumns extends readonly unknown[] ? ObjectColumns[number] extends {
4564
5532
  name: string;
4565
5533
  type: string;
4566
- } ? {
4567
- [K in ObjectColumns[number]['name']]?: PropertyType<Tables, ObjectColumns[number], K>;
4568
- } : never : never : Type extends 'link' ? TableType<Tables, LinkedTable> & XataRecord : never) | null : never : never;
5534
+ } ? UnionToIntersection<Values<{
5535
+ [K in ObjectColumns[number]['name']]: PropertyType<Tables, ObjectColumns[number], K>;
5536
+ }>> : never : never : Type extends 'link' ? TableType<Tables, LinkedTable> & XataRecord : never;
4569
5537
 
4570
5538
  /**
4571
5539
  * Operator to restrict results to only values that are greater than the given value.
@@ -4816,4 +5784,4 @@ declare class XataError extends Error {
4816
5784
  constructor(message: string, status: number);
4817
5785
  }
4818
5786
 
4819
- export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditResponse, ApplyBranchSchemaEditVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, CompareBranchSchemasError, CompareBranchSchemasPathParams, CompareBranchSchemasVariables, CompareBranchWithUserSchemaError, CompareBranchWithUserSchemaPathParams, CompareBranchWithUserSchemaRequestBody, CompareBranchWithUserSchemaVariables, CompareMigrationRequestError, CompareMigrationRequestPathParams, CompareMigrationRequestVariables, 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, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, 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, 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, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, Link, ListMigrationRequestsCommitsError, ListMigrationRequestsCommitsPathParams, ListMigrationRequestsCommitsRequestBody, ListMigrationRequestsCommitsResponse, ListMigrationRequestsCommitsVariables, ListMigrationRequestsError, ListMigrationRequestsPathParams, ListMigrationRequestsRequestBody, ListMigrationRequestsResponse, ListMigrationRequestsVariables, 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, Query, 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, Serializer, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, UpdateBranchSchemaResponse, UpdateBranchSchemaVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, 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, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, applyBranchSchemaEdit, buildClient, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequests, listMigrationRequestsCommits, lt, lte, mergeMigrationRequest, notExists, operationsByTag, pattern, previewBranchSchemaEdit, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, updateBranchMetadata, updateBranchSchema, updateColumn, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID };
5787
+ export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditResponse, ApplyBranchSchemaEditVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, CompareBranchSchemasError, CompareBranchSchemasPathParams, CompareBranchSchemasVariables, CompareBranchWithUserSchemaError, CompareBranchWithUserSchemaPathParams, CompareBranchWithUserSchemaRequestBody, CompareBranchWithUserSchemaVariables, CompareMigrationRequestError, CompareMigrationRequestPathParams, CompareMigrationRequestVariables, 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, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, 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, 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, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, Link, ListMigrationRequestsCommitsError, ListMigrationRequestsCommitsPathParams, ListMigrationRequestsCommitsRequestBody, ListMigrationRequestsCommitsResponse, ListMigrationRequestsCommitsVariables, ListMigrationRequestsError, ListMigrationRequestsPathParams, ListMigrationRequestsRequestBody, ListMigrationRequestsResponse, ListMigrationRequestsVariables, 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, Query, 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, Serializer, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, SummarizeTableError, SummarizeTablePathParams, SummarizeTableRequestBody, SummarizeTableVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, UpdateBranchSchemaResponse, UpdateBranchSchemaVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, 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, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, applyBranchSchemaEdit, buildClient, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequests, listMigrationRequestsCommits, lt, lte, mergeMigrationRequest, notExists, operationsByTag, pattern, previewBranchSchemaEdit, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID };