@xata.io/client 0.21.5 → 0.22.0
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/.eslintrc.cjs +3 -2
- package/.turbo/turbo-add-version.log +4 -0
- package/.turbo/turbo-build.log +13 -0
- package/CHANGELOG.md +18 -0
- package/LICENSE +201 -0
- package/README.md +9 -2
- package/dist/index.cjs +47 -36
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +892 -857
- package/dist/index.mjs +47 -37
- package/dist/index.mjs.map +1 -1
- package/package.json +8 -8
- package/rollup.config.mjs +28 -13
package/dist/index.d.ts
CHANGED
@@ -215,6 +215,18 @@ type ListDatabasesResponse = {
|
|
215
215
|
*/
|
216
216
|
databases: DatabaseMetadata[];
|
217
217
|
};
|
218
|
+
/**
|
219
|
+
* @maxLength 255
|
220
|
+
* @minLength 1
|
221
|
+
* @pattern [a-zA-Z0-9_\-~]+
|
222
|
+
*/
|
223
|
+
type DBName$1 = string;
|
224
|
+
/**
|
225
|
+
* @maxLength 255
|
226
|
+
* @minLength 1
|
227
|
+
* @pattern [a-zA-Z0-9_\-~]+
|
228
|
+
*/
|
229
|
+
type BranchName$1 = string;
|
218
230
|
/**
|
219
231
|
* @example {"repository":"github.com/my/repository","branch":"feature-login","stage":"testing","labels":["epic-100"]}
|
220
232
|
* @x-go-type xata.BranchMetadata
|
@@ -231,36 +243,22 @@ type BranchMetadata$1 = {
|
|
231
243
|
stage?: string;
|
232
244
|
labels?: string[];
|
233
245
|
};
|
234
|
-
/**
|
235
|
-
* @pattern [a-zA-Z0-9_\-~]+
|
236
|
-
*/
|
237
|
-
type BranchName$1 = string;
|
238
|
-
/**
|
239
|
-
* @maxLength 255
|
240
|
-
* @minLength 1
|
241
|
-
* @pattern [a-zA-Z0-9_\-~]+
|
242
|
-
*/
|
243
|
-
type DBName$1 = string;
|
244
246
|
type MigrationStatus$1 = 'completed' | 'pending' | 'failed';
|
247
|
+
type Region = {
|
248
|
+
id: string;
|
249
|
+
};
|
245
250
|
type ListRegionsResponse = {
|
246
251
|
/**
|
247
252
|
* A list of regions where databases can be created
|
248
253
|
*/
|
249
254
|
regions: Region[];
|
250
255
|
};
|
251
|
-
type Region = {
|
252
|
-
id: string;
|
253
|
-
};
|
254
256
|
|
255
257
|
/**
|
256
258
|
* Generated by @openapi-codegen
|
257
259
|
*
|
258
260
|
* @version 1.0
|
259
261
|
*/
|
260
|
-
type SimpleError$1 = {
|
261
|
-
id?: string;
|
262
|
-
message: string;
|
263
|
-
};
|
264
262
|
type BadRequestError$1 = {
|
265
263
|
id?: string;
|
266
264
|
message: string;
|
@@ -272,6 +270,10 @@ type AuthError$1 = {
|
|
272
270
|
id?: string;
|
273
271
|
message: string;
|
274
272
|
};
|
273
|
+
type SimpleError$1 = {
|
274
|
+
id?: string;
|
275
|
+
message: string;
|
276
|
+
};
|
275
277
|
|
276
278
|
/**
|
277
279
|
* Generated by @openapi-codegen
|
@@ -807,6 +809,12 @@ type CreateDatabaseError = ErrorWrapper$1<{
|
|
807
809
|
} | {
|
808
810
|
status: 401;
|
809
811
|
payload: AuthError$1;
|
812
|
+
} | {
|
813
|
+
status: 422;
|
814
|
+
payload: SimpleError$1;
|
815
|
+
} | {
|
816
|
+
status: 423;
|
817
|
+
payload: SimpleError$1;
|
810
818
|
}>;
|
811
819
|
type CreateDatabaseResponse = {
|
812
820
|
/**
|
@@ -957,20 +965,39 @@ declare const listRegions: (variables: ListRegionsVariables, signal?: AbortSigna
|
|
957
965
|
*
|
958
966
|
* @version 1.0
|
959
967
|
*/
|
960
|
-
|
961
|
-
|
962
|
-
|
963
|
-
|
964
|
-
|
965
|
-
|
966
|
-
|
967
|
-
|
968
|
-
|
969
|
-
|
968
|
+
/**
|
969
|
+
* @maxLength 255
|
970
|
+
* @minLength 1
|
971
|
+
* @pattern [a-zA-Z0-9_\-~]+
|
972
|
+
*/
|
973
|
+
type DBName = string;
|
974
|
+
/**
|
975
|
+
* @format date-time
|
976
|
+
* @x-go-type string
|
977
|
+
*/
|
978
|
+
type DateTime = string;
|
970
979
|
type Branch = {
|
971
980
|
name: string;
|
972
981
|
createdAt: DateTime;
|
973
982
|
};
|
983
|
+
type ListBranchesResponse = {
|
984
|
+
databaseName: string;
|
985
|
+
branches: Branch[];
|
986
|
+
};
|
987
|
+
/**
|
988
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
989
|
+
*
|
990
|
+
* @maxLength 511
|
991
|
+
* @minLength 1
|
992
|
+
* @pattern [a-zA-Z0-9_\-~]+:[a-zA-Z0-9_\-~]+
|
993
|
+
*/
|
994
|
+
type DBBranchName = string;
|
995
|
+
/**
|
996
|
+
* @maxLength 255
|
997
|
+
* @minLength 1
|
998
|
+
* @pattern [a-zA-Z0-9_\-~]+
|
999
|
+
*/
|
1000
|
+
type BranchName = string;
|
974
1001
|
/**
|
975
1002
|
* @example {"repository":"github.com/my/repository","branch":"feature-login","stage":"testing","labels":["epic-100"]}
|
976
1003
|
* @x-go-type xata.BranchMetadata
|
@@ -987,39 +1014,19 @@ type BranchMetadata = {
|
|
987
1014
|
stage?: string;
|
988
1015
|
labels?: string[];
|
989
1016
|
};
|
990
|
-
type DBBranch = {
|
991
|
-
databaseName: DBName;
|
992
|
-
branchName: BranchName;
|
993
|
-
createdAt: DateTime;
|
994
|
-
id: string;
|
995
|
-
version: number;
|
996
|
-
lastMigrationID: string;
|
997
|
-
metadata?: BranchMetadata;
|
998
|
-
startedFrom?: StartedFromMetadata;
|
999
|
-
schema: Schema;
|
1000
|
-
};
|
1001
1017
|
type StartedFromMetadata = {
|
1002
1018
|
branchName: BranchName;
|
1003
1019
|
dbBranchID: string;
|
1004
1020
|
migrationID: string;
|
1005
1021
|
};
|
1006
1022
|
/**
|
1007
|
-
* @
|
1023
|
+
* @maxLength 255
|
1024
|
+
* @minLength 1
|
1025
|
+
* @pattern [a-zA-Z0-9_\-~]+
|
1008
1026
|
*/
|
1009
|
-
type
|
1010
|
-
|
1011
|
-
|
1012
|
-
};
|
1013
|
-
type SchemaEditScript = {
|
1014
|
-
sourceMigrationID?: string;
|
1015
|
-
targetMigrationID?: string;
|
1016
|
-
operations: MigrationOp[];
|
1017
|
-
};
|
1018
|
-
type Table = {
|
1019
|
-
id?: string;
|
1020
|
-
name: TableName;
|
1021
|
-
columns: Column[];
|
1022
|
-
revLinks?: RevLink[];
|
1027
|
+
type TableName = string;
|
1028
|
+
type ColumnLink = {
|
1029
|
+
table: string;
|
1023
1030
|
};
|
1024
1031
|
type Column = {
|
1025
1032
|
name: string;
|
@@ -1030,39 +1037,35 @@ type Column = {
|
|
1030
1037
|
unique?: boolean;
|
1031
1038
|
columns?: Column[];
|
1032
1039
|
};
|
1033
|
-
type ColumnLink = {
|
1034
|
-
table: string;
|
1035
|
-
};
|
1036
1040
|
type RevLink = {
|
1037
1041
|
linkID: string;
|
1038
1042
|
table: string;
|
1039
1043
|
};
|
1044
|
+
type Table = {
|
1045
|
+
id?: string;
|
1046
|
+
name: TableName;
|
1047
|
+
columns: Column[];
|
1048
|
+
revLinks?: RevLink[];
|
1049
|
+
};
|
1040
1050
|
/**
|
1041
|
-
* @
|
1042
|
-
*/
|
1043
|
-
type BranchName = string;
|
1044
|
-
/**
|
1045
|
-
* @maxLength 255
|
1046
|
-
* @minLength 1
|
1047
|
-
* @pattern [a-zA-Z0-9_\-~]+
|
1048
|
-
*/
|
1049
|
-
type DBName = string;
|
1050
|
-
/**
|
1051
|
-
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
1052
|
-
*
|
1053
|
-
* @maxLength 255
|
1054
|
-
* @minLength 1
|
1055
|
-
* @pattern [a-zA-Z0-9_\-~]+:[a-zA-Z0-9_\-~]+
|
1056
|
-
*/
|
1057
|
-
type DBBranchName = string;
|
1058
|
-
/**
|
1059
|
-
* @pattern [a-zA-Z0-9_\-~]+
|
1060
|
-
*/
|
1061
|
-
type TableName = string;
|
1062
|
-
/**
|
1063
|
-
* @pattern [a-zA-Z0-9_\-~\.]+
|
1051
|
+
* @x-go-type xata.Schema
|
1064
1052
|
*/
|
1065
|
-
type
|
1053
|
+
type Schema = {
|
1054
|
+
tables: Table[];
|
1055
|
+
tablesOrder?: string[];
|
1056
|
+
};
|
1057
|
+
type DBBranch = {
|
1058
|
+
databaseName: DBName;
|
1059
|
+
branchName: BranchName;
|
1060
|
+
createdAt: DateTime;
|
1061
|
+
id: string;
|
1062
|
+
version: number;
|
1063
|
+
lastMigrationID: string;
|
1064
|
+
metadata?: BranchMetadata;
|
1065
|
+
startedFrom?: StartedFromMetadata;
|
1066
|
+
schema: Schema;
|
1067
|
+
};
|
1068
|
+
type MigrationStatus = 'completed' | 'pending' | 'failed';
|
1066
1069
|
type MetricsDatapoint = {
|
1067
1070
|
timestamp: string;
|
1068
1071
|
value: number;
|
@@ -1071,6 +1074,37 @@ type MetricsLatency = {
|
|
1071
1074
|
p50?: MetricsDatapoint[];
|
1072
1075
|
p90?: MetricsDatapoint[];
|
1073
1076
|
};
|
1077
|
+
type ListGitBranchesResponse = {
|
1078
|
+
mapping: {
|
1079
|
+
gitBranch: string;
|
1080
|
+
xataBranch: string;
|
1081
|
+
}[];
|
1082
|
+
};
|
1083
|
+
type ColumnMigration = {
|
1084
|
+
old: Column;
|
1085
|
+
['new']: Column;
|
1086
|
+
};
|
1087
|
+
type TableMigration = {
|
1088
|
+
newColumns?: {
|
1089
|
+
[key: string]: Column;
|
1090
|
+
};
|
1091
|
+
removedColumns?: string[];
|
1092
|
+
modifiedColumns?: ColumnMigration[];
|
1093
|
+
newColumnOrder: string[];
|
1094
|
+
};
|
1095
|
+
/**
|
1096
|
+
* @example {"newName":"newName","oldName":"oldName"}
|
1097
|
+
*/
|
1098
|
+
type TableRename = {
|
1099
|
+
/**
|
1100
|
+
* @minLength 1
|
1101
|
+
*/
|
1102
|
+
newName: string;
|
1103
|
+
/**
|
1104
|
+
* @minLength 1
|
1105
|
+
*/
|
1106
|
+
oldName: string;
|
1107
|
+
};
|
1074
1108
|
type BranchMigration = {
|
1075
1109
|
id?: string;
|
1076
1110
|
parentID?: string;
|
@@ -1089,78 +1123,109 @@ type BranchMigration = {
|
|
1089
1123
|
newTableOrder: string[];
|
1090
1124
|
renamedTables?: TableRename[];
|
1091
1125
|
};
|
1092
|
-
|
1093
|
-
|
1094
|
-
|
1095
|
-
|
1096
|
-
|
1097
|
-
|
1098
|
-
|
1099
|
-
|
1100
|
-
|
1101
|
-
|
1102
|
-
|
1103
|
-
|
1104
|
-
type Commit = {
|
1105
|
-
title?: string;
|
1106
|
-
message?: string;
|
1107
|
-
id: string;
|
1108
|
-
parentID?: string;
|
1109
|
-
mergeParentID?: string;
|
1110
|
-
status: MigrationStatus;
|
1111
|
-
createdAt: DateTime;
|
1112
|
-
modifiedAt?: DateTime;
|
1113
|
-
operations: MigrationOp[];
|
1126
|
+
/**
|
1127
|
+
* @minProperties 1
|
1128
|
+
*/
|
1129
|
+
type FilterExpression = {
|
1130
|
+
$exists?: string;
|
1131
|
+
$existsNot?: string;
|
1132
|
+
$any?: FilterList;
|
1133
|
+
$all?: FilterList;
|
1134
|
+
$none?: FilterList;
|
1135
|
+
$not?: FilterList;
|
1136
|
+
} & {
|
1137
|
+
[key: string]: FilterColumn;
|
1114
1138
|
};
|
1115
|
-
type
|
1139
|
+
type FilterList = FilterExpression | FilterExpression[];
|
1140
|
+
type FilterValue = number | string | boolean;
|
1141
|
+
type FilterPredicate = FilterValue | FilterPredicate[] | FilterPredicateOp | FilterPredicateRangeOp;
|
1142
|
+
type FilterRangeValue = number | string;
|
1116
1143
|
/**
|
1117
|
-
*
|
1144
|
+
* @maxProperties 1
|
1145
|
+
* @minProperties 1
|
1118
1146
|
*/
|
1119
|
-
type
|
1120
|
-
|
1121
|
-
|
1147
|
+
type FilterPredicateOp = {
|
1148
|
+
$any?: FilterPredicate[];
|
1149
|
+
$all?: FilterPredicate[];
|
1150
|
+
$none?: FilterPredicate | FilterPredicate[];
|
1151
|
+
$not?: FilterPredicate | FilterPredicate[];
|
1152
|
+
$is?: FilterValue | FilterValue[];
|
1153
|
+
$isNot?: FilterValue | FilterValue[];
|
1154
|
+
$lt?: FilterRangeValue;
|
1155
|
+
$le?: FilterRangeValue;
|
1156
|
+
$gt?: FilterRangeValue;
|
1157
|
+
$ge?: FilterRangeValue;
|
1158
|
+
$contains?: string;
|
1159
|
+
$startsWith?: string;
|
1160
|
+
$endsWith?: string;
|
1161
|
+
$pattern?: string;
|
1122
1162
|
};
|
1123
1163
|
/**
|
1124
|
-
*
|
1164
|
+
* @maxProperties 2
|
1165
|
+
* @minProperties 2
|
1125
1166
|
*/
|
1126
|
-
type
|
1127
|
-
|
1128
|
-
|
1129
|
-
|
1130
|
-
|
1131
|
-
} | {
|
1132
|
-
renameTable: TableOpRename;
|
1133
|
-
};
|
1134
|
-
type MigrationColumnOp = {
|
1135
|
-
addColumn: ColumnOpAdd;
|
1136
|
-
} | {
|
1137
|
-
removeColumn: ColumnOpRemove;
|
1138
|
-
} | {
|
1139
|
-
renameColumn: ColumnOpRename;
|
1140
|
-
};
|
1141
|
-
type TableOpAdd = {
|
1142
|
-
table: string;
|
1143
|
-
};
|
1144
|
-
type TableOpRemove = {
|
1145
|
-
table: string;
|
1146
|
-
};
|
1147
|
-
type TableOpRename = {
|
1148
|
-
oldName: string;
|
1149
|
-
newName: string;
|
1150
|
-
};
|
1151
|
-
type ColumnOpAdd = {
|
1152
|
-
table: string;
|
1153
|
-
column: Column;
|
1167
|
+
type FilterPredicateRangeOp = {
|
1168
|
+
$lt?: FilterRangeValue;
|
1169
|
+
$le?: FilterRangeValue;
|
1170
|
+
$gt?: FilterRangeValue;
|
1171
|
+
$ge?: FilterRangeValue;
|
1154
1172
|
};
|
1155
|
-
|
1156
|
-
|
1157
|
-
|
1173
|
+
/**
|
1174
|
+
* @maxProperties 1
|
1175
|
+
* @minProperties 1
|
1176
|
+
*/
|
1177
|
+
type FilterColumnIncludes = {
|
1178
|
+
$includes?: FilterPredicate;
|
1179
|
+
$includesAny?: FilterPredicate;
|
1180
|
+
$includesAll?: FilterPredicate;
|
1181
|
+
$includesNone?: FilterPredicate;
|
1158
1182
|
};
|
1159
|
-
type
|
1160
|
-
|
1161
|
-
|
1162
|
-
|
1183
|
+
type FilterColumn = FilterColumnIncludes | FilterPredicate | FilterList;
|
1184
|
+
type SortOrder = 'asc' | 'desc';
|
1185
|
+
type SortExpression = string[] | {
|
1186
|
+
[key: string]: SortOrder;
|
1187
|
+
} | {
|
1188
|
+
[key: string]: SortOrder;
|
1189
|
+
}[];
|
1190
|
+
/**
|
1191
|
+
* Pagination settings.
|
1192
|
+
*/
|
1193
|
+
type PageConfig = {
|
1194
|
+
/**
|
1195
|
+
* Query the next page that follow the cursor.
|
1196
|
+
*/
|
1197
|
+
after?: string;
|
1198
|
+
/**
|
1199
|
+
* Query the previous page before the cursor.
|
1200
|
+
*/
|
1201
|
+
before?: string;
|
1202
|
+
/**
|
1203
|
+
* Query the first page from the cursor.
|
1204
|
+
*/
|
1205
|
+
start?: string;
|
1206
|
+
/**
|
1207
|
+
* Query the last page from the cursor.
|
1208
|
+
*/
|
1209
|
+
end?: string;
|
1210
|
+
/**
|
1211
|
+
* 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.
|
1212
|
+
*
|
1213
|
+
* @default 20
|
1214
|
+
*/
|
1215
|
+
size?: number;
|
1216
|
+
/**
|
1217
|
+
* Use offset to skip entries. To skip pages set offset to a multiple of size.
|
1218
|
+
*
|
1219
|
+
* @default 0
|
1220
|
+
*/
|
1221
|
+
offset?: number;
|
1163
1222
|
};
|
1223
|
+
/**
|
1224
|
+
* @example name
|
1225
|
+
* @example email
|
1226
|
+
* @example created_at
|
1227
|
+
*/
|
1228
|
+
type ColumnsProjection = string[];
|
1164
1229
|
/**
|
1165
1230
|
* The migration request number.
|
1166
1231
|
*
|
@@ -1204,336 +1269,322 @@ type MigrationRequest = {
|
|
1204
1269
|
*/
|
1205
1270
|
target?: string;
|
1206
1271
|
};
|
1207
|
-
|
1208
|
-
|
1272
|
+
/**
|
1273
|
+
* Records metadata
|
1274
|
+
*/
|
1275
|
+
type RecordsMetadata = {
|
1276
|
+
page: {
|
1277
|
+
/**
|
1278
|
+
* last record id
|
1279
|
+
*/
|
1280
|
+
cursor: string;
|
1281
|
+
/**
|
1282
|
+
* true if more records can be fetch
|
1283
|
+
*/
|
1284
|
+
more: boolean;
|
1285
|
+
};
|
1286
|
+
};
|
1287
|
+
type TableOpAdd = {
|
1288
|
+
table: string;
|
1289
|
+
};
|
1290
|
+
type TableOpRemove = {
|
1291
|
+
table: string;
|
1292
|
+
};
|
1293
|
+
type TableOpRename = {
|
1294
|
+
oldName: string;
|
1295
|
+
newName: string;
|
1296
|
+
};
|
1297
|
+
type MigrationTableOp = {
|
1298
|
+
addTable: TableOpAdd;
|
1209
1299
|
} | {
|
1210
|
-
|
1211
|
-
}
|
1212
|
-
|
1300
|
+
removeTable: TableOpRemove;
|
1301
|
+
} | {
|
1302
|
+
renameTable: TableOpRename;
|
1303
|
+
};
|
1304
|
+
type ColumnOpAdd = {
|
1305
|
+
table: string;
|
1306
|
+
column: Column;
|
1307
|
+
};
|
1308
|
+
type ColumnOpRemove = {
|
1309
|
+
table: string;
|
1310
|
+
column: string;
|
1311
|
+
};
|
1312
|
+
type ColumnOpRename = {
|
1313
|
+
table: string;
|
1314
|
+
oldName: string;
|
1315
|
+
newName: string;
|
1316
|
+
};
|
1317
|
+
type MigrationColumnOp = {
|
1318
|
+
addColumn: ColumnOpAdd;
|
1319
|
+
} | {
|
1320
|
+
removeColumn: ColumnOpRemove;
|
1321
|
+
} | {
|
1322
|
+
renameColumn: ColumnOpRename;
|
1323
|
+
};
|
1213
1324
|
/**
|
1214
|
-
*
|
1215
|
-
* distance is the number of one character changes needed to make two strings equal. The default is 1, meaning that single
|
1216
|
-
* character typos per word are tollerated by search. You can set it to 0 to remove the typo tollerance or set it to 2
|
1217
|
-
* to allow two typos in a word.
|
1218
|
-
*
|
1219
|
-
* @default 1
|
1220
|
-
* @maximum 2
|
1221
|
-
* @minimum 0
|
1325
|
+
* Branch schema migration operations.
|
1222
1326
|
*/
|
1223
|
-
type
|
1327
|
+
type MigrationOp = MigrationTableOp | MigrationColumnOp;
|
1328
|
+
type Commit = {
|
1329
|
+
title?: string;
|
1330
|
+
message?: string;
|
1331
|
+
id: string;
|
1332
|
+
parentID?: string;
|
1333
|
+
mergeParentID?: string;
|
1334
|
+
status: MigrationStatus;
|
1335
|
+
createdAt: DateTime;
|
1336
|
+
modifiedAt?: DateTime;
|
1337
|
+
operations: MigrationOp[];
|
1338
|
+
};
|
1339
|
+
type SchemaEditScript = {
|
1340
|
+
sourceMigrationID?: string;
|
1341
|
+
targetMigrationID?: string;
|
1342
|
+
operations: MigrationOp[];
|
1343
|
+
};
|
1224
1344
|
/**
|
1225
|
-
*
|
1345
|
+
* Branch schema migration.
|
1226
1346
|
*/
|
1227
|
-
type
|
1347
|
+
type Migration = {
|
1348
|
+
parentID?: string;
|
1349
|
+
operations: MigrationOp[];
|
1350
|
+
};
|
1228
1351
|
/**
|
1229
|
-
*
|
1352
|
+
* @pattern [a-zA-Z0-9_\-~\.]+
|
1230
1353
|
*/
|
1231
|
-
type
|
1354
|
+
type ColumnName = string;
|
1355
|
+
/**
|
1356
|
+
* Insert operation
|
1357
|
+
*/
|
1358
|
+
type TransactionInsertOp = {
|
1232
1359
|
/**
|
1233
|
-
* The name
|
1360
|
+
* The table name
|
1234
1361
|
*/
|
1235
|
-
|
1362
|
+
table: string;
|
1236
1363
|
/**
|
1237
|
-
* The
|
1364
|
+
* The record to insert. The `id` field is optional; when specified, it will be used as the ID for the record.
|
1365
|
+
*/
|
1366
|
+
record: {
|
1367
|
+
[key: string]: any;
|
1368
|
+
};
|
1369
|
+
/**
|
1370
|
+
* The version of the record you expect to be overwriting. Only valid with an
|
1371
|
+
* explicit ID is also set in the `record` key.
|
1372
|
+
*/
|
1373
|
+
ifVersion?: number;
|
1374
|
+
/**
|
1375
|
+
* createOnly is used to change how Xata acts when an explicit ID is set in the `record` key.
|
1238
1376
|
*
|
1239
|
-
*
|
1240
|
-
*
|
1241
|
-
*
|
1377
|
+
* If `createOnly` is set to `true`, Xata will only attempt to insert the record. If there's a conflict, Xata
|
1378
|
+
* will cancel the transaction.
|
1379
|
+
*
|
1380
|
+
* If `createOnly` is set to `false`, Xata will attempt to insert the record. If there's no
|
1381
|
+
* conflict, the record is inserted. If there is a conflict, Xata will replace the record.
|
1242
1382
|
*/
|
1243
|
-
|
1244
|
-
})[];
|
1245
|
-
/**
|
1246
|
-
* @minProperties 1
|
1247
|
-
*/
|
1248
|
-
type FilterExpression = {
|
1249
|
-
$exists?: string;
|
1250
|
-
$existsNot?: string;
|
1251
|
-
$any?: FilterList;
|
1252
|
-
$all?: FilterList;
|
1253
|
-
$none?: FilterList;
|
1254
|
-
$not?: FilterList;
|
1255
|
-
} & {
|
1256
|
-
[key: string]: FilterColumn;
|
1383
|
+
createOnly?: boolean;
|
1257
1384
|
};
|
1258
1385
|
/**
|
1259
|
-
*
|
1260
|
-
* you'd like for the summary. These names must not collide with other columns you've
|
1261
|
-
* requested from `columns`; including implicit requests like `settings.*`.
|
1262
|
-
*
|
1263
|
-
* The value for each key needs to be an object. This object should contain one key and one
|
1264
|
-
* value only. In this object, the key should be set to the summary function you wish to use
|
1265
|
-
* and the value set to the column name to be summarized.
|
1266
|
-
*
|
1267
|
-
* The column being summarized cannot be an internal column (id, xata.*), nor the base of
|
1268
|
-
* an object, i.e. if `settings` is an object with `dark_mode` as a field, you may summarize
|
1269
|
-
* `settings.dark_mode` but not `settings` nor `settings.*`.
|
1270
|
-
*
|
1271
|
-
* @example {"all_users":{"count":"*"}}
|
1272
|
-
* @example {"total_created":{"count":"created_at"}}
|
1273
|
-
* @example {"min_cost":{"min":"cost"}}
|
1274
|
-
* @example {"max_happiness":{"max":"happiness"}}
|
1275
|
-
* @example {"total_revenue":{"sum":"revenue"}}
|
1276
|
-
* @example {"average_speed":{"average":"speed"}}
|
1277
|
-
* @x-go-type xbquery.SummaryList
|
1386
|
+
* @pattern [a-zA-Z0-9_-~:]+
|
1278
1387
|
*/
|
1279
|
-
type
|
1280
|
-
[key: string]: SummaryExpression;
|
1281
|
-
};
|
1388
|
+
type RecordID = string;
|
1282
1389
|
/**
|
1283
|
-
*
|
1284
|
-
* key representing the operation, and a value representing the column to be operated on.
|
1285
|
-
*
|
1286
|
-
* The column being summarized cannot be an internal column (id, xata.*), nor the base of
|
1287
|
-
* an object, i.e. if `settings` is an object with `dark_mode` as a field, you may summarize
|
1288
|
-
* `settings.dark_mode` but not `settings` nor `settings.*`.
|
1289
|
-
*
|
1290
|
-
* We currently support several aggregation functions. Not all functions can be run on all column
|
1291
|
-
* types.
|
1292
|
-
*
|
1293
|
-
* - `count` is used to count the number of records in each group. Use `{"count": "*"}` to count
|
1294
|
-
* all columns present, otherwise `{"count": "<column_path>"}` to count the number of non-null
|
1295
|
-
* values are present at column path.
|
1296
|
-
*
|
1297
|
-
* Count can be used on any column type, and always returns an int.
|
1298
|
-
*
|
1299
|
-
* - `min` calculates the minimum value in each group. `min` is compatible with most types;
|
1300
|
-
* string, multiple, text, email, int, float, and datetime. It returns a value of the same
|
1301
|
-
* type as operated on. This means that `{"lowest_latency": {"min": "latency"}}` where
|
1302
|
-
* `latency` is an int, will always return an int.
|
1303
|
-
*
|
1304
|
-
* - `max` calculates the maximum value in each group. `max` shares the same compatibility as
|
1305
|
-
* `min`.
|
1306
|
-
*
|
1307
|
-
* - `sum` adds up all values in a group. `sum` can be run on `int` and `float` types, and will
|
1308
|
-
* return a value of the same type as requested.
|
1309
|
-
*
|
1310
|
-
* - `average` averages all values in a group. `average` can be run on `int` and `float` types, and
|
1311
|
-
* always returns a float.
|
1312
|
-
*
|
1313
|
-
* @example {"count":"deleted_at"}
|
1314
|
-
* @x-go-type xbquery.Summary
|
1390
|
+
* Update operation
|
1315
1391
|
*/
|
1316
|
-
type
|
1392
|
+
type TransactionUpdateOp = {
|
1393
|
+
/**
|
1394
|
+
* The table name
|
1395
|
+
*/
|
1396
|
+
table: string;
|
1397
|
+
id: RecordID;
|
1398
|
+
/**
|
1399
|
+
* The fields of the record you'd like to update
|
1400
|
+
*/
|
1401
|
+
fields: {
|
1402
|
+
[key: string]: any;
|
1403
|
+
};
|
1404
|
+
/**
|
1405
|
+
* The version of the record you expect to be updating
|
1406
|
+
*/
|
1407
|
+
ifVersion?: number;
|
1408
|
+
/**
|
1409
|
+
* Xata will insert this record if it cannot be found.
|
1410
|
+
*/
|
1411
|
+
upsert?: boolean;
|
1412
|
+
};
|
1317
1413
|
/**
|
1318
|
-
* The
|
1319
|
-
*
|
1320
|
-
* @example {"totalCount":{"count":"*"},"dailyActiveUsers":{"dateHistogram":{"column":"date","interval":"1d"},"aggs":{"uniqueUsers":{"uniqueCount":{"column":"userID"}}}}}
|
1414
|
+
* A delete operation. The transaction will continue if no record matches the ID.
|
1321
1415
|
*/
|
1322
|
-
type
|
1323
|
-
|
1416
|
+
type TransactionDeleteOp = {
|
1417
|
+
/**
|
1418
|
+
* The table name
|
1419
|
+
*/
|
1420
|
+
table: string;
|
1421
|
+
id: RecordID;
|
1324
1422
|
};
|
1325
1423
|
/**
|
1326
|
-
*
|
1327
|
-
* The key represents the aggreagtion type, while the value is an object with the configuration of
|
1328
|
-
* the aggreagtion.
|
1329
|
-
*
|
1330
|
-
* @x-go-type xata.AggExpression
|
1424
|
+
* A transaction operation
|
1331
1425
|
*/
|
1332
|
-
type
|
1333
|
-
|
1334
|
-
} | {
|
1335
|
-
sum?: SumAgg;
|
1336
|
-
} | {
|
1337
|
-
max?: MaxAgg;
|
1338
|
-
} | {
|
1339
|
-
min?: MinAgg;
|
1340
|
-
} | {
|
1341
|
-
average?: AverageAgg;
|
1342
|
-
} | {
|
1343
|
-
uniqueCount?: UniqueCountAgg;
|
1344
|
-
} | {
|
1345
|
-
dateHistogram?: DateHistogramAgg;
|
1426
|
+
type TransactionOperation$1 = {
|
1427
|
+
insert: TransactionInsertOp;
|
1346
1428
|
} | {
|
1347
|
-
|
1429
|
+
update: TransactionUpdateOp;
|
1348
1430
|
} | {
|
1349
|
-
|
1431
|
+
['delete']: TransactionDeleteOp;
|
1350
1432
|
};
|
1351
1433
|
/**
|
1352
|
-
*
|
1353
|
-
*/
|
1354
|
-
type CountAgg = {
|
1355
|
-
filter?: FilterExpression;
|
1356
|
-
} | '*';
|
1357
|
-
/**
|
1358
|
-
* The sum of the numeric values in a particular column.
|
1434
|
+
* A result from an insert operation.
|
1359
1435
|
*/
|
1360
|
-
type
|
1436
|
+
type TransactionResultInsert = {
|
1361
1437
|
/**
|
1362
|
-
* The
|
1438
|
+
* The type of operation who's result is being returned.
|
1363
1439
|
*/
|
1364
|
-
|
1440
|
+
operation: 'insert';
|
1441
|
+
/**
|
1442
|
+
* The number of affected rows
|
1443
|
+
*/
|
1444
|
+
rows: number;
|
1445
|
+
id: RecordID;
|
1365
1446
|
};
|
1366
1447
|
/**
|
1367
|
-
*
|
1448
|
+
* A result from an update operation.
|
1368
1449
|
*/
|
1369
|
-
type
|
1450
|
+
type TransactionResultUpdate = {
|
1370
1451
|
/**
|
1371
|
-
* The
|
1452
|
+
* The type of operation who's result is being returned.
|
1372
1453
|
*/
|
1373
|
-
|
1454
|
+
operation: 'update';
|
1455
|
+
/**
|
1456
|
+
* The number of updated rows
|
1457
|
+
*/
|
1458
|
+
rows: number;
|
1459
|
+
id: RecordID;
|
1374
1460
|
};
|
1375
1461
|
/**
|
1376
|
-
*
|
1462
|
+
* A result from a delete operation.
|
1377
1463
|
*/
|
1378
|
-
type
|
1464
|
+
type TransactionResultDelete = {
|
1379
1465
|
/**
|
1380
|
-
* The
|
1466
|
+
* The type of operation who's result is being returned.
|
1381
1467
|
*/
|
1382
|
-
|
1468
|
+
operation: 'delete';
|
1469
|
+
/**
|
1470
|
+
* The number of deleted rows
|
1471
|
+
*/
|
1472
|
+
rows: number;
|
1383
1473
|
};
|
1384
1474
|
/**
|
1385
|
-
*
|
1475
|
+
* An ordered array of results from the submitted operations.
|
1386
1476
|
*/
|
1387
|
-
type
|
1388
|
-
|
1389
|
-
* The column on which to compute the average. Must be a numeric type.
|
1390
|
-
*/
|
1391
|
-
column: string;
|
1477
|
+
type TransactionSuccess = {
|
1478
|
+
results: (TransactionResultInsert | TransactionResultUpdate | TransactionResultDelete)[];
|
1392
1479
|
};
|
1393
1480
|
/**
|
1394
|
-
*
|
1481
|
+
* An error message from a failing transaction operation
|
1395
1482
|
*/
|
1396
|
-
type
|
1483
|
+
type TransactionError = {
|
1397
1484
|
/**
|
1398
|
-
* The
|
1485
|
+
* The index of the failing operation
|
1399
1486
|
*/
|
1400
|
-
|
1487
|
+
index: number;
|
1401
1488
|
/**
|
1402
|
-
* The
|
1403
|
-
* values in the column is higher than this threshold, the results are approximative.
|
1404
|
-
* Maximum value is 40,000, default value is 3000.
|
1489
|
+
* The error message
|
1405
1490
|
*/
|
1406
|
-
|
1491
|
+
message: string;
|
1407
1492
|
};
|
1408
1493
|
/**
|
1409
|
-
*
|
1494
|
+
* An array of errors, with indicides, from the transaction.
|
1410
1495
|
*/
|
1411
|
-
type
|
1496
|
+
type TransactionFailure = {
|
1412
1497
|
/**
|
1413
|
-
* The
|
1498
|
+
* The request ID.
|
1414
1499
|
*/
|
1415
|
-
|
1500
|
+
id: string;
|
1416
1501
|
/**
|
1417
|
-
*
|
1418
|
-
* It is fromatted as number + units, for example: `5d`, `20m`, `10s`.
|
1419
|
-
*
|
1420
|
-
* @pattern ^(\d+)(d|h|m|s|ms)$
|
1502
|
+
* An array of errors from the submitted operations.
|
1421
1503
|
*/
|
1422
|
-
|
1504
|
+
errors: TransactionError[];
|
1505
|
+
};
|
1506
|
+
/**
|
1507
|
+
* Xata Table Record Metadata
|
1508
|
+
*/
|
1509
|
+
type RecordMeta = {
|
1510
|
+
id: RecordID;
|
1511
|
+
xata: {
|
1512
|
+
/**
|
1513
|
+
* The record's version. Can be used for optimistic concurrency control.
|
1514
|
+
*/
|
1515
|
+
version: number;
|
1516
|
+
/**
|
1517
|
+
* The record's table name. APIs that return records from multiple tables will set this field accordingly.
|
1518
|
+
*/
|
1519
|
+
table?: string;
|
1520
|
+
/**
|
1521
|
+
* Highlights of the record. This is used by the search APIs to indicate which fields and parts of the fields have matched the search.
|
1522
|
+
*/
|
1523
|
+
highlight?: {
|
1524
|
+
[key: string]: string[] | {
|
1525
|
+
[key: string]: any;
|
1526
|
+
};
|
1527
|
+
};
|
1528
|
+
/**
|
1529
|
+
* The record's relevancy score. This is returned by the search APIs.
|
1530
|
+
*/
|
1531
|
+
score?: number;
|
1532
|
+
/**
|
1533
|
+
* Encoding/Decoding errors
|
1534
|
+
*/
|
1535
|
+
warnings?: string[];
|
1536
|
+
};
|
1537
|
+
};
|
1538
|
+
/**
|
1539
|
+
* The target expression is used to filter the search results by the target columns.
|
1540
|
+
*/
|
1541
|
+
type TargetExpression = (string | {
|
1423
1542
|
/**
|
1424
|
-
* The
|
1425
|
-
* `hour`, `day`, `week`, `month`, `quarter`, `year`.
|
1543
|
+
* The name of the column.
|
1426
1544
|
*/
|
1427
|
-
|
1545
|
+
column: string;
|
1428
1546
|
/**
|
1429
|
-
* The
|
1430
|
-
* The accepted format is as an ISO 8601 UTC offset. For example: `+01:00` or
|
1431
|
-
* `-08:00`.
|
1547
|
+
* The weight of the column.
|
1432
1548
|
*
|
1433
|
-
* @
|
1549
|
+
* @default 1
|
1550
|
+
* @maximum 10
|
1551
|
+
* @minimum 1
|
1434
1552
|
*/
|
1435
|
-
|
1436
|
-
|
1437
|
-
};
|
1553
|
+
weight?: number;
|
1554
|
+
})[];
|
1438
1555
|
/**
|
1439
|
-
*
|
1440
|
-
* The top values as ordered by the number of records (`$count`) are returned.
|
1556
|
+
* Boost records with a particular value for a column.
|
1441
1557
|
*/
|
1442
|
-
type
|
1558
|
+
type ValueBooster$1 = {
|
1443
1559
|
/**
|
1444
|
-
* The column to
|
1560
|
+
* The column in which to look for the value.
|
1445
1561
|
*/
|
1446
1562
|
column: string;
|
1447
|
-
aggs?: AggExpressionMap;
|
1448
1563
|
/**
|
1449
|
-
* The
|
1450
|
-
*
|
1451
|
-
* @default 10
|
1452
|
-
* @maximum 1000
|
1564
|
+
* The exact value to boost.
|
1453
1565
|
*/
|
1454
|
-
|
1566
|
+
value: string | number | boolean;
|
1567
|
+
/**
|
1568
|
+
* The factor with which to multiply the score of the record.
|
1569
|
+
*/
|
1570
|
+
factor: number;
|
1571
|
+
/**
|
1572
|
+
* Only apply this booster to the records for which the provided filter matches.
|
1573
|
+
*/
|
1574
|
+
ifMatchesFilter?: FilterExpression;
|
1455
1575
|
};
|
1456
1576
|
/**
|
1457
|
-
*
|
1577
|
+
* Boost records based on the value of a numeric column.
|
1458
1578
|
*/
|
1459
|
-
type
|
1579
|
+
type NumericBooster$1 = {
|
1460
1580
|
/**
|
1461
|
-
* The column to
|
1581
|
+
* The column in which to look for the value.
|
1462
1582
|
*/
|
1463
1583
|
column: string;
|
1464
1584
|
/**
|
1465
|
-
* The
|
1466
|
-
* with this value as size.
|
1467
|
-
*
|
1468
|
-
* @minimum 0
|
1585
|
+
* The factor with which to multiply the value of the column before adding it to the item score.
|
1469
1586
|
*/
|
1470
|
-
|
1471
|
-
/**
|
1472
|
-
* By default the bucket keys start with 0 and then continue in `interval` steps. The bucket
|
1473
|
-
* boundaries can be shiftend by using the offset option. For example, if the `interval` is 100,
|
1474
|
-
* but you prefer the bucket boundaries to be `[50, 150), [150, 250), etc.`, you can set `offset`
|
1475
|
-
* to 50.
|
1476
|
-
*
|
1477
|
-
* @default 0
|
1478
|
-
*/
|
1479
|
-
offset?: number;
|
1480
|
-
aggs?: AggExpressionMap;
|
1481
|
-
};
|
1482
|
-
type HighlightExpression = {
|
1483
|
-
/**
|
1484
|
-
* Set to `false` to disable highlighting. By default it is `true`.
|
1485
|
-
*/
|
1486
|
-
enabled?: boolean;
|
1487
|
-
/**
|
1488
|
-
* Set to `false` to disable HTML encoding in highlight snippets. By default it is `true`.
|
1489
|
-
*/
|
1490
|
-
encodeHTML?: boolean;
|
1491
|
-
};
|
1492
|
-
/**
|
1493
|
-
* Booster Expression
|
1494
|
-
*
|
1495
|
-
* @x-go-type xata.BoosterExpression
|
1496
|
-
*/
|
1497
|
-
type BoosterExpression = {
|
1498
|
-
valueBooster?: ValueBooster$1;
|
1499
|
-
} | {
|
1500
|
-
numericBooster?: NumericBooster$1;
|
1501
|
-
} | {
|
1502
|
-
dateBooster?: DateBooster$1;
|
1503
|
-
};
|
1504
|
-
/**
|
1505
|
-
* Boost records with a particular value for a column.
|
1506
|
-
*/
|
1507
|
-
type ValueBooster$1 = {
|
1508
|
-
/**
|
1509
|
-
* The column in which to look for the value.
|
1510
|
-
*/
|
1511
|
-
column: string;
|
1512
|
-
/**
|
1513
|
-
* The exact value to boost.
|
1514
|
-
*/
|
1515
|
-
value: string | number | boolean;
|
1516
|
-
/**
|
1517
|
-
* The factor with which to multiply the score of the record.
|
1518
|
-
*/
|
1519
|
-
factor: number;
|
1520
|
-
/**
|
1521
|
-
* Only apply this booster to the records for which the provided filter matches.
|
1522
|
-
*/
|
1523
|
-
ifMatchesFilter?: FilterExpression;
|
1524
|
-
};
|
1525
|
-
/**
|
1526
|
-
* Boost records based on the value of a numeric column.
|
1527
|
-
*/
|
1528
|
-
type NumericBooster$1 = {
|
1529
|
-
/**
|
1530
|
-
* The column in which to look for the value.
|
1531
|
-
*/
|
1532
|
-
column: string;
|
1533
|
-
/**
|
1534
|
-
* The factor with which to multiply the value of the column before adding it to the item score.
|
1535
|
-
*/
|
1536
|
-
factor: number;
|
1587
|
+
factor: number;
|
1537
1588
|
/**
|
1538
1589
|
* Modifier to be applied to the column value, before being multiplied with the factor. The possible values are:
|
1539
1590
|
* - none (default).
|
@@ -1583,83 +1634,42 @@ type DateBooster$1 = {
|
|
1583
1634
|
*/
|
1584
1635
|
ifMatchesFilter?: FilterExpression;
|
1585
1636
|
};
|
1586
|
-
type FilterList = FilterExpression | FilterExpression[];
|
1587
|
-
type FilterColumn = FilterColumnIncludes | FilterPredicate | FilterList;
|
1588
|
-
/**
|
1589
|
-
* @maxProperties 1
|
1590
|
-
* @minProperties 1
|
1591
|
-
*/
|
1592
|
-
type FilterColumnIncludes = {
|
1593
|
-
$includes?: FilterPredicate;
|
1594
|
-
$includesAny?: FilterPredicate;
|
1595
|
-
$includesAll?: FilterPredicate;
|
1596
|
-
$includesNone?: FilterPredicate;
|
1597
|
-
};
|
1598
|
-
type FilterPredicate = FilterValue | FilterPredicate[] | FilterPredicateOp | FilterPredicateRangeOp;
|
1599
1637
|
/**
|
1600
|
-
*
|
1601
|
-
*
|
1638
|
+
* Booster Expression
|
1639
|
+
*
|
1640
|
+
* @x-go-type xata.BoosterExpression
|
1602
1641
|
*/
|
1603
|
-
type
|
1604
|
-
|
1605
|
-
|
1606
|
-
|
1607
|
-
|
1608
|
-
|
1609
|
-
$isNot?: FilterValue | FilterValue[];
|
1610
|
-
$lt?: FilterRangeValue;
|
1611
|
-
$le?: FilterRangeValue;
|
1612
|
-
$gt?: FilterRangeValue;
|
1613
|
-
$ge?: FilterRangeValue;
|
1614
|
-
$contains?: string;
|
1615
|
-
$startsWith?: string;
|
1616
|
-
$endsWith?: string;
|
1617
|
-
$pattern?: string;
|
1642
|
+
type BoosterExpression = {
|
1643
|
+
valueBooster?: ValueBooster$1;
|
1644
|
+
} | {
|
1645
|
+
numericBooster?: NumericBooster$1;
|
1646
|
+
} | {
|
1647
|
+
dateBooster?: DateBooster$1;
|
1618
1648
|
};
|
1619
1649
|
/**
|
1620
|
-
*
|
1621
|
-
*
|
1650
|
+
* Maximum [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) for the search terms. The Levenshtein
|
1651
|
+
* distance is the number of one character changes needed to make two strings equal. The default is 1, meaning that single
|
1652
|
+
* character typos per word are tollerated by search. You can set it to 0 to remove the typo tollerance or set it to 2
|
1653
|
+
* to allow two typos in a word.
|
1654
|
+
*
|
1655
|
+
* @default 1
|
1656
|
+
* @maximum 2
|
1657
|
+
* @minimum 0
|
1622
1658
|
*/
|
1623
|
-
type
|
1624
|
-
$lt?: FilterRangeValue;
|
1625
|
-
$le?: FilterRangeValue;
|
1626
|
-
$gt?: FilterRangeValue;
|
1627
|
-
$ge?: FilterRangeValue;
|
1628
|
-
};
|
1629
|
-
type FilterRangeValue = number | string;
|
1630
|
-
type FilterValue = number | string | boolean;
|
1659
|
+
type FuzzinessExpression = number;
|
1631
1660
|
/**
|
1632
|
-
*
|
1661
|
+
* If the prefix type is set to "disabled" (the default), the search only matches full words. If the prefix type is set to "phrase", the search will return results that match prefixes of the search phrase.
|
1633
1662
|
*/
|
1634
|
-
type
|
1635
|
-
|
1636
|
-
* Query the next page that follow the cursor.
|
1637
|
-
*/
|
1638
|
-
after?: string;
|
1639
|
-
/**
|
1640
|
-
* Query the previous page before the cursor.
|
1641
|
-
*/
|
1642
|
-
before?: string;
|
1643
|
-
/**
|
1644
|
-
* Query the first page from the cursor.
|
1645
|
-
*/
|
1646
|
-
start?: string;
|
1647
|
-
/**
|
1648
|
-
* Query the last page from the cursor.
|
1649
|
-
*/
|
1650
|
-
end?: string;
|
1663
|
+
type PrefixExpression = 'phrase' | 'disabled';
|
1664
|
+
type HighlightExpression = {
|
1651
1665
|
/**
|
1652
|
-
* Set
|
1653
|
-
*
|
1654
|
-
* @default 20
|
1666
|
+
* Set to `false` to disable highlighting. By default it is `true`.
|
1655
1667
|
*/
|
1656
|
-
|
1668
|
+
enabled?: boolean;
|
1657
1669
|
/**
|
1658
|
-
*
|
1659
|
-
*
|
1660
|
-
* @default 0
|
1670
|
+
* Set to `false` to disable HTML encoding in highlight snippets. By default it is `true`.
|
1661
1671
|
*/
|
1662
|
-
|
1672
|
+
encodeHTML?: boolean;
|
1663
1673
|
};
|
1664
1674
|
/**
|
1665
1675
|
* Pagination settings for the search endpoints.
|
@@ -1681,218 +1691,232 @@ type SearchPageConfig = {
|
|
1681
1691
|
offset?: number;
|
1682
1692
|
};
|
1683
1693
|
/**
|
1684
|
-
*
|
1685
|
-
*
|
1686
|
-
*
|
1694
|
+
* A summary expression is the description of a single summary operation. It consists of a single
|
1695
|
+
* key representing the operation, and a value representing the column to be operated on.
|
1696
|
+
*
|
1697
|
+
* The column being summarized cannot be an internal column (id, xata.*), nor the base of
|
1698
|
+
* an object, i.e. if `settings` is an object with `dark_mode` as a field, you may summarize
|
1699
|
+
* `settings.dark_mode` but not `settings` nor `settings.*`.
|
1700
|
+
*
|
1701
|
+
* We currently support several aggregation functions. Not all functions can be run on all column
|
1702
|
+
* types.
|
1703
|
+
*
|
1704
|
+
* - `count` is used to count the number of records in each group. Use `{"count": "*"}` to count
|
1705
|
+
* all columns present, otherwise `{"count": "<column_path>"}` to count the number of non-null
|
1706
|
+
* values are present at column path.
|
1707
|
+
*
|
1708
|
+
* Count can be used on any column type, and always returns an int.
|
1709
|
+
*
|
1710
|
+
* - `min` calculates the minimum value in each group. `min` is compatible with most types;
|
1711
|
+
* string, multiple, text, email, int, float, and datetime. It returns a value of the same
|
1712
|
+
* type as operated on. This means that `{"lowest_latency": {"min": "latency"}}` where
|
1713
|
+
* `latency` is an int, will always return an int.
|
1714
|
+
*
|
1715
|
+
* - `max` calculates the maximum value in each group. `max` shares the same compatibility as
|
1716
|
+
* `min`.
|
1717
|
+
*
|
1718
|
+
* - `sum` adds up all values in a group. `sum` can be run on `int` and `float` types, and will
|
1719
|
+
* return a value of the same type as requested.
|
1720
|
+
*
|
1721
|
+
* - `average` averages all values in a group. `average` can be run on `int` and `float` types, and
|
1722
|
+
* always returns a float.
|
1723
|
+
*
|
1724
|
+
* @example {"count":"deleted_at"}
|
1725
|
+
* @x-go-type xbquery.Summary
|
1687
1726
|
*/
|
1688
|
-
type
|
1727
|
+
type SummaryExpression = Record<string, any>;
|
1689
1728
|
/**
|
1690
|
-
*
|
1729
|
+
* The description of the summaries you wish to receive. Set each key to be the field name
|
1730
|
+
* you'd like for the summary. These names must not collide with other columns you've
|
1731
|
+
* requested from `columns`; including implicit requests like `settings.*`.
|
1732
|
+
*
|
1733
|
+
* The value for each key needs to be an object. This object should contain one key and one
|
1734
|
+
* value only. In this object, the key should be set to the summary function you wish to use
|
1735
|
+
* and the value set to the column name to be summarized.
|
1736
|
+
*
|
1737
|
+
* The column being summarized cannot be an internal column (id, xata.*), nor the base of
|
1738
|
+
* an object, i.e. if `settings` is an object with `dark_mode` as a field, you may summarize
|
1739
|
+
* `settings.dark_mode` but not `settings` nor `settings.*`.
|
1740
|
+
*
|
1741
|
+
* @example {"all_users":{"count":"*"},"total_created":{"count":"created_at"},"min_cost":{"min":"cost"},"max_happiness":{"max":"happiness"},"total_revenue":{"sum":"revenue"},"average_speed":{"average":"speed"}}
|
1742
|
+
* @x-go-type xbquery.SummaryList
|
1691
1743
|
*/
|
1692
|
-
type
|
1693
|
-
|
1694
|
-
xata: {
|
1695
|
-
/**
|
1696
|
-
* The record's version. Can be used for optimistic concurrency control.
|
1697
|
-
*/
|
1698
|
-
version: number;
|
1699
|
-
/**
|
1700
|
-
* The record's table name. APIs that return records from multiple tables will set this field accordingly.
|
1701
|
-
*/
|
1702
|
-
table?: string;
|
1703
|
-
/**
|
1704
|
-
* Highlights of the record. This is used by the search APIs to indicate which fields and parts of the fields have matched the search.
|
1705
|
-
*/
|
1706
|
-
highlight?: {
|
1707
|
-
[key: string]: string[] | {
|
1708
|
-
[key: string]: any;
|
1709
|
-
};
|
1710
|
-
};
|
1711
|
-
/**
|
1712
|
-
* The record's relevancy score. This is returned by the search APIs.
|
1713
|
-
*/
|
1714
|
-
score?: number;
|
1715
|
-
/**
|
1716
|
-
* Encoding/Decoding errors
|
1717
|
-
*/
|
1718
|
-
warnings?: string[];
|
1719
|
-
};
|
1744
|
+
type SummaryExpressionList = {
|
1745
|
+
[key: string]: SummaryExpression;
|
1720
1746
|
};
|
1721
1747
|
/**
|
1722
|
-
*
|
1748
|
+
* Count the number of records with an optional filter.
|
1723
1749
|
*/
|
1724
|
-
type
|
1750
|
+
type CountAgg = {
|
1751
|
+
filter?: FilterExpression;
|
1752
|
+
} | '*';
|
1725
1753
|
/**
|
1726
|
-
*
|
1754
|
+
* The sum of the numeric values in a particular column.
|
1727
1755
|
*/
|
1728
|
-
type
|
1729
|
-
/**
|
1730
|
-
* @minLength 1
|
1731
|
-
*/
|
1732
|
-
newName: string;
|
1756
|
+
type SumAgg = {
|
1733
1757
|
/**
|
1734
|
-
*
|
1758
|
+
* The column on which to compute the sum. Must be a numeric type.
|
1735
1759
|
*/
|
1736
|
-
|
1760
|
+
column: string;
|
1737
1761
|
};
|
1738
1762
|
/**
|
1739
|
-
*
|
1763
|
+
* The max of the numeric values in a particular column.
|
1740
1764
|
*/
|
1741
|
-
type
|
1742
|
-
|
1743
|
-
|
1744
|
-
|
1745
|
-
|
1746
|
-
cursor: string;
|
1747
|
-
/**
|
1748
|
-
* true if more records can be fetch
|
1749
|
-
*/
|
1750
|
-
more: boolean;
|
1751
|
-
};
|
1752
|
-
};
|
1753
|
-
type AggResponse$1 = (number | null) | {
|
1754
|
-
values: ({
|
1755
|
-
$key: string | number;
|
1756
|
-
$count: number;
|
1757
|
-
} & {
|
1758
|
-
[key: string]: AggResponse$1;
|
1759
|
-
})[];
|
1765
|
+
type MaxAgg = {
|
1766
|
+
/**
|
1767
|
+
* The column on which to compute the max. Must be a numeric type.
|
1768
|
+
*/
|
1769
|
+
column: string;
|
1760
1770
|
};
|
1761
1771
|
/**
|
1762
|
-
*
|
1772
|
+
* The min of the numeric values in a particular column.
|
1763
1773
|
*/
|
1764
|
-
type
|
1765
|
-
|
1766
|
-
|
1767
|
-
|
1768
|
-
|
1769
|
-
['delete']: TransactionDeleteOp;
|
1774
|
+
type MinAgg = {
|
1775
|
+
/**
|
1776
|
+
* The column on which to compute the min. Must be a numeric type.
|
1777
|
+
*/
|
1778
|
+
column: string;
|
1770
1779
|
};
|
1771
1780
|
/**
|
1772
|
-
*
|
1781
|
+
* The average of the numeric values in a particular column.
|
1773
1782
|
*/
|
1774
|
-
type
|
1775
|
-
/**
|
1776
|
-
* The table name
|
1777
|
-
*/
|
1778
|
-
table: string;
|
1779
|
-
/**
|
1780
|
-
* The record to insert. The `id` field is optional; when specified, it will be used as the ID for the record.
|
1781
|
-
*/
|
1782
|
-
record: {
|
1783
|
-
[key: string]: any;
|
1784
|
-
};
|
1785
|
-
/**
|
1786
|
-
* The version of the record you expect to be overwriting. Only valid with an
|
1787
|
-
* explicit ID is also set in the `record` key.
|
1788
|
-
*/
|
1789
|
-
ifVersion?: number;
|
1783
|
+
type AverageAgg = {
|
1790
1784
|
/**
|
1791
|
-
*
|
1792
|
-
*
|
1793
|
-
* If `createOnly` is set to `true`, Xata will only attempt to insert the record. If there's a conflict, Xata
|
1794
|
-
* will cancel the transaction.
|
1795
|
-
*
|
1796
|
-
* If `createOnly` is set to `false`, Xata will attempt to insert the record. If there's no
|
1797
|
-
* conflict, the record is inserted. If there is a conflict, Xata will replace the record.
|
1785
|
+
* The column on which to compute the average. Must be a numeric type.
|
1798
1786
|
*/
|
1799
|
-
|
1787
|
+
column: string;
|
1800
1788
|
};
|
1801
1789
|
/**
|
1802
|
-
*
|
1790
|
+
* Count the number of distinct values in a particular column.
|
1803
1791
|
*/
|
1804
|
-
type
|
1805
|
-
/**
|
1806
|
-
* The table name
|
1807
|
-
*/
|
1808
|
-
table: string;
|
1809
|
-
id: RecordID;
|
1810
|
-
/**
|
1811
|
-
* The fields of the record you'd like to update
|
1812
|
-
*/
|
1813
|
-
fields: {
|
1814
|
-
[key: string]: any;
|
1815
|
-
};
|
1792
|
+
type UniqueCountAgg = {
|
1816
1793
|
/**
|
1817
|
-
* The
|
1794
|
+
* The column from where to count the unique values.
|
1818
1795
|
*/
|
1819
|
-
|
1796
|
+
column: string;
|
1820
1797
|
/**
|
1821
|
-
*
|
1798
|
+
* The threshold under which the unique count is exact. If the number of unique
|
1799
|
+
* values in the column is higher than this threshold, the results are approximative.
|
1800
|
+
* Maximum value is 40,000, default value is 3000.
|
1822
1801
|
*/
|
1823
|
-
|
1802
|
+
precisionThreshold?: number;
|
1824
1803
|
};
|
1825
1804
|
/**
|
1826
|
-
*
|
1805
|
+
* The description of the aggregations you wish to receive.
|
1806
|
+
*
|
1807
|
+
* @example {"totalCount":{"count":"*"},"dailyActiveUsers":{"dateHistogram":{"column":"date","interval":"1d","aggs":{"uniqueUsers":{"uniqueCount":{"column":"userID"}}}}}}
|
1827
1808
|
*/
|
1828
|
-
type
|
1829
|
-
|
1830
|
-
* The table name
|
1831
|
-
*/
|
1832
|
-
table: string;
|
1833
|
-
id: RecordID;
|
1809
|
+
type AggExpressionMap = {
|
1810
|
+
[key: string]: AggExpression;
|
1834
1811
|
};
|
1835
1812
|
/**
|
1836
|
-
*
|
1813
|
+
* Split data into buckets by a datetime column. Accepts sub-aggregations for each bucket.
|
1837
1814
|
*/
|
1838
|
-
type
|
1815
|
+
type DateHistogramAgg = {
|
1839
1816
|
/**
|
1840
|
-
* The
|
1817
|
+
* The column to use for bucketing. Must be of type datetime.
|
1841
1818
|
*/
|
1842
|
-
|
1819
|
+
column: string;
|
1843
1820
|
/**
|
1844
|
-
* The
|
1821
|
+
* The fixed interval to use when bucketing.
|
1822
|
+
* It is fromatted as number + units, for example: `5d`, `20m`, `10s`.
|
1823
|
+
*
|
1824
|
+
* @pattern ^(\d+)(d|h|m|s|ms)$
|
1845
1825
|
*/
|
1846
|
-
|
1847
|
-
id: RecordID;
|
1848
|
-
};
|
1849
|
-
/**
|
1850
|
-
* A result from an update operation.
|
1851
|
-
*/
|
1852
|
-
type TransactionResultUpdate = {
|
1826
|
+
interval?: string;
|
1853
1827
|
/**
|
1854
|
-
* The
|
1828
|
+
* The calendar-aware interval to use when bucketing. Possible values are: `minute`,
|
1829
|
+
* `hour`, `day`, `week`, `month`, `quarter`, `year`.
|
1855
1830
|
*/
|
1856
|
-
|
1831
|
+
calendarInterval?: 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year';
|
1857
1832
|
/**
|
1858
|
-
* The
|
1833
|
+
* The timezone to use for bucketing. By default, UTC is assumed.
|
1834
|
+
* The accepted format is as an ISO 8601 UTC offset. For example: `+01:00` or
|
1835
|
+
* `-08:00`.
|
1836
|
+
*
|
1837
|
+
* @pattern ^[+-][01]\d:[0-5]\d$
|
1859
1838
|
*/
|
1860
|
-
|
1861
|
-
|
1839
|
+
timezone?: string;
|
1840
|
+
aggs?: AggExpressionMap;
|
1862
1841
|
};
|
1863
1842
|
/**
|
1864
|
-
*
|
1843
|
+
* Split data into buckets by the unique values in a column. Accepts sub-aggregations for each bucket.
|
1844
|
+
* The top values as ordered by the number of records (`$count`) are returned.
|
1865
1845
|
*/
|
1866
|
-
type
|
1846
|
+
type TopValuesAgg = {
|
1867
1847
|
/**
|
1868
|
-
* The
|
1848
|
+
* The column to use for bucketing. Accepted types are `string`, `email`, `int`, `float`, or `bool`.
|
1869
1849
|
*/
|
1870
|
-
|
1850
|
+
column: string;
|
1851
|
+
aggs?: AggExpressionMap;
|
1871
1852
|
/**
|
1872
|
-
* The number of
|
1853
|
+
* The maximum number of unique values to return.
|
1854
|
+
*
|
1855
|
+
* @default 10
|
1856
|
+
* @maximum 1000
|
1873
1857
|
*/
|
1874
|
-
|
1858
|
+
size?: number;
|
1875
1859
|
};
|
1876
1860
|
/**
|
1877
|
-
*
|
1878
|
-
*
|
1879
|
-
* @x-go-type xata.ErrTxOp
|
1861
|
+
* Split data into buckets by dynamic numeric ranges. Accepts sub-aggregations for each bucket.
|
1880
1862
|
*/
|
1881
|
-
type
|
1863
|
+
type NumericHistogramAgg = {
|
1882
1864
|
/**
|
1883
|
-
* The
|
1865
|
+
* The column to use for bucketing. Must be of numeric type.
|
1884
1866
|
*/
|
1885
|
-
|
1867
|
+
column: string;
|
1886
1868
|
/**
|
1887
|
-
* The
|
1869
|
+
* The numeric interval to use for bucketing. The resulting buckets will be ranges
|
1870
|
+
* with this value as size.
|
1871
|
+
*
|
1872
|
+
* @minimum 0
|
1888
1873
|
*/
|
1889
|
-
|
1874
|
+
interval: number;
|
1875
|
+
/**
|
1876
|
+
* By default the bucket keys start with 0 and then continue in `interval` steps. The bucket
|
1877
|
+
* boundaries can be shiftend by using the offset option. For example, if the `interval` is 100,
|
1878
|
+
* but you prefer the bucket boundaries to be `[50, 150), [150, 250), etc.`, you can set `offset`
|
1879
|
+
* to 50.
|
1880
|
+
*
|
1881
|
+
* @default 0
|
1882
|
+
*/
|
1883
|
+
offset?: number;
|
1884
|
+
aggs?: AggExpressionMap;
|
1890
1885
|
};
|
1891
1886
|
/**
|
1892
|
-
*
|
1893
|
-
*
|
1887
|
+
* The description of a single aggregation operation. It is an object with only one key-value pair.
|
1888
|
+
* The key represents the aggregation type, while the value is an object with the configuration of
|
1889
|
+
* the aggregation.
|
1890
|
+
*
|
1891
|
+
* @x-go-type xata.AggExpression
|
1894
1892
|
*/
|
1895
|
-
type
|
1893
|
+
type AggExpression = {
|
1894
|
+
count?: CountAgg;
|
1895
|
+
} | {
|
1896
|
+
sum?: SumAgg;
|
1897
|
+
} | {
|
1898
|
+
max?: MaxAgg;
|
1899
|
+
} | {
|
1900
|
+
min?: MinAgg;
|
1901
|
+
} | {
|
1902
|
+
average?: AverageAgg;
|
1903
|
+
} | {
|
1904
|
+
uniqueCount?: UniqueCountAgg;
|
1905
|
+
} | {
|
1906
|
+
dateHistogram?: DateHistogramAgg;
|
1907
|
+
} | {
|
1908
|
+
topValues?: TopValuesAgg;
|
1909
|
+
} | {
|
1910
|
+
numericHistogram?: NumericHistogramAgg;
|
1911
|
+
};
|
1912
|
+
type AggResponse$1 = (number | null) | {
|
1913
|
+
values: ({
|
1914
|
+
$key: string | number;
|
1915
|
+
$count: number;
|
1916
|
+
} & {
|
1917
|
+
[key: string]: AggResponse$1;
|
1918
|
+
})[];
|
1919
|
+
};
|
1896
1920
|
/**
|
1897
1921
|
* Xata Table Record Metadata
|
1898
1922
|
*/
|
@@ -1906,26 +1930,33 @@ type XataRecord$1 = RecordMeta & {
|
|
1906
1930
|
* @version 1.0
|
1907
1931
|
*/
|
1908
1932
|
|
1909
|
-
type
|
1933
|
+
type BadRequestError = {
|
1910
1934
|
id?: string;
|
1911
1935
|
message: string;
|
1912
1936
|
};
|
1913
|
-
|
1914
|
-
|
1915
|
-
|
1916
|
-
|
1917
|
-
|
1937
|
+
/**
|
1938
|
+
* @example {"message":"invalid API key"}
|
1939
|
+
*/
|
1940
|
+
type AuthError = {
|
1941
|
+
id?: string;
|
1942
|
+
message: string;
|
1918
1943
|
};
|
1919
|
-
type
|
1920
|
-
|
1921
|
-
|
1922
|
-
records: XataRecord$1[];
|
1944
|
+
type SimpleError = {
|
1945
|
+
id?: string;
|
1946
|
+
message: string;
|
1923
1947
|
};
|
1924
1948
|
type BranchMigrationPlan = {
|
1925
1949
|
version: number;
|
1926
1950
|
migration: BranchMigration;
|
1927
1951
|
};
|
1928
|
-
type
|
1952
|
+
type SchemaUpdateResponse = {
|
1953
|
+
/**
|
1954
|
+
* @minLength 1
|
1955
|
+
*/
|
1956
|
+
migrationID: string;
|
1957
|
+
parentMigrationID: string;
|
1958
|
+
status: MigrationStatus;
|
1959
|
+
};
|
1929
1960
|
type SchemaCompareResponse = {
|
1930
1961
|
source: Schema;
|
1931
1962
|
target: Schema;
|
@@ -1937,62 +1968,37 @@ type RecordUpdateResponse = XataRecord$1 | {
|
|
1937
1968
|
version: number;
|
1938
1969
|
};
|
1939
1970
|
};
|
1971
|
+
type RecordResponse = XataRecord$1;
|
1972
|
+
type BulkInsertResponse = {
|
1973
|
+
recordIDs: string[];
|
1974
|
+
} | {
|
1975
|
+
records: XataRecord$1[];
|
1976
|
+
};
|
1977
|
+
type BulkError = {
|
1978
|
+
errors: {
|
1979
|
+
message?: string;
|
1980
|
+
status?: number;
|
1981
|
+
}[];
|
1982
|
+
};
|
1940
1983
|
type QueryResponse = {
|
1941
1984
|
records: XataRecord$1[];
|
1942
1985
|
meta: RecordsMetadata;
|
1943
1986
|
};
|
1944
|
-
type
|
1945
|
-
|
1946
|
-
|
1947
|
-
*/
|
1948
|
-
migrationID: string;
|
1949
|
-
parentMigrationID: string;
|
1950
|
-
status: MigrationStatus;
|
1987
|
+
type SearchResponse = {
|
1988
|
+
records: XataRecord$1[];
|
1989
|
+
warning?: string;
|
1951
1990
|
};
|
1952
1991
|
type SummarizeResponse = {
|
1953
1992
|
summaries: Record<string, any>[];
|
1954
1993
|
};
|
1955
1994
|
/**
|
1956
|
-
* @example {"aggs":{"dailyUniqueUsers":{"values":[{"key":"2022-02-22T22:22:22Z","uniqueUsers":134},{"key":"2022-02-23T22:22:22Z","uniqueUsers":90}]}}}
|
1995
|
+
* @example {"aggs":{"dailyUniqueUsers":{"values":[{"$count":321,"$key":"2022-02-22T22:22:22Z","uniqueUsers":134},{"$count":202,"$key":"2022-02-23T22:22:22Z","uniqueUsers":90}]}}}
|
1957
1996
|
*/
|
1958
1997
|
type AggResponse = {
|
1959
1998
|
aggs?: {
|
1960
1999
|
[key: string]: AggResponse$1;
|
1961
2000
|
};
|
1962
2001
|
};
|
1963
|
-
type SearchResponse = {
|
1964
|
-
records: XataRecord$1[];
|
1965
|
-
warning?: string;
|
1966
|
-
};
|
1967
|
-
/**
|
1968
|
-
* @x-go-type TxSuccess
|
1969
|
-
*/
|
1970
|
-
type TransactionSuccess = {
|
1971
|
-
/**
|
1972
|
-
* An ordered array of results from the submitted operations that were executed
|
1973
|
-
*/
|
1974
|
-
results: (TransactionResultInsert | TransactionResultUpdate | TransactionResultDelete)[];
|
1975
|
-
};
|
1976
|
-
/**
|
1977
|
-
* @x-go-type TxFailure
|
1978
|
-
*/
|
1979
|
-
type TransactionFailure = {
|
1980
|
-
/**
|
1981
|
-
* An array of errors from the submitted operations.
|
1982
|
-
*/
|
1983
|
-
errors: TransactionError[];
|
1984
|
-
};
|
1985
|
-
type BadRequestError = {
|
1986
|
-
id?: string;
|
1987
|
-
message: string;
|
1988
|
-
};
|
1989
|
-
/**
|
1990
|
-
* @example {"message":"invalid API key"}
|
1991
|
-
*/
|
1992
|
-
type AuthError = {
|
1993
|
-
id?: string;
|
1994
|
-
message: string;
|
1995
|
-
};
|
1996
2002
|
|
1997
2003
|
type DataPlaneFetcherExtraProps = {
|
1998
2004
|
apiUrl: string;
|
@@ -2086,6 +2092,9 @@ type CreateBranchError = ErrorWrapper<{
|
|
2086
2092
|
} | {
|
2087
2093
|
status: 404;
|
2088
2094
|
payload: SimpleError;
|
2095
|
+
} | {
|
2096
|
+
status: 423;
|
2097
|
+
payload: SimpleError;
|
2089
2098
|
}>;
|
2090
2099
|
type CreateBranchResponse = {
|
2091
2100
|
/**
|
@@ -2125,6 +2134,9 @@ type DeleteBranchError = ErrorWrapper<{
|
|
2125
2134
|
} | {
|
2126
2135
|
status: 404;
|
2127
2136
|
payload: SimpleError;
|
2137
|
+
} | {
|
2138
|
+
status: 409;
|
2139
|
+
payload: SimpleError;
|
2128
2140
|
}>;
|
2129
2141
|
type DeleteBranchResponse = {
|
2130
2142
|
status: MigrationStatus;
|
@@ -2498,32 +2510,6 @@ type ExecuteBranchMigrationPlanVariables = {
|
|
2498
2510
|
* Apply a migration plan to the branch
|
2499
2511
|
*/
|
2500
2512
|
declare const executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
2501
|
-
type BranchTransactionPathParams = {
|
2502
|
-
/**
|
2503
|
-
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2504
|
-
*/
|
2505
|
-
dbBranchName: DBBranchName;
|
2506
|
-
workspace: string;
|
2507
|
-
region: string;
|
2508
|
-
};
|
2509
|
-
type BranchTransactionError = ErrorWrapper<{
|
2510
|
-
status: 400;
|
2511
|
-
payload: TransactionFailure;
|
2512
|
-
} | {
|
2513
|
-
status: 401;
|
2514
|
-
payload: AuthError;
|
2515
|
-
} | {
|
2516
|
-
status: 404;
|
2517
|
-
payload: SimpleError;
|
2518
|
-
}>;
|
2519
|
-
type BranchTransactionRequestBody = {
|
2520
|
-
operations: TransactionOperation$1[];
|
2521
|
-
};
|
2522
|
-
type BranchTransactionVariables = {
|
2523
|
-
body: BranchTransactionRequestBody;
|
2524
|
-
pathParams: BranchTransactionPathParams;
|
2525
|
-
} & DataPlaneFetcherExtraProps;
|
2526
|
-
declare const branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal) => Promise<TransactionSuccess>;
|
2527
2513
|
type QueryMigrationRequestsPathParams = {
|
2528
2514
|
/**
|
2529
2515
|
* The Database Name
|
@@ -3083,6 +3069,9 @@ type UpdateTableError = ErrorWrapper<{
|
|
3083
3069
|
} | {
|
3084
3070
|
status: 404;
|
3085
3071
|
payload: SimpleError;
|
3072
|
+
} | {
|
3073
|
+
status: 422;
|
3074
|
+
payload: SimpleError;
|
3086
3075
|
}>;
|
3087
3076
|
type UpdateTableRequestBody = {
|
3088
3077
|
/**
|
@@ -3341,6 +3330,32 @@ type DeleteColumnVariables = {
|
|
3341
3330
|
* Deletes the specified column. To refer to sub-objects, the column name can contain dots. For example `address.country`.
|
3342
3331
|
*/
|
3343
3332
|
declare const deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
3333
|
+
type BranchTransactionPathParams = {
|
3334
|
+
/**
|
3335
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3336
|
+
*/
|
3337
|
+
dbBranchName: DBBranchName;
|
3338
|
+
workspace: string;
|
3339
|
+
region: string;
|
3340
|
+
};
|
3341
|
+
type BranchTransactionError = ErrorWrapper<{
|
3342
|
+
status: 400;
|
3343
|
+
payload: TransactionFailure;
|
3344
|
+
} | {
|
3345
|
+
status: 401;
|
3346
|
+
payload: AuthError;
|
3347
|
+
} | {
|
3348
|
+
status: 404;
|
3349
|
+
payload: SimpleError;
|
3350
|
+
}>;
|
3351
|
+
type BranchTransactionRequestBody = {
|
3352
|
+
operations: TransactionOperation$1[];
|
3353
|
+
};
|
3354
|
+
type BranchTransactionVariables = {
|
3355
|
+
body: BranchTransactionRequestBody;
|
3356
|
+
pathParams: BranchTransactionPathParams;
|
3357
|
+
} & DataPlaneFetcherExtraProps;
|
3358
|
+
declare const branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal) => Promise<TransactionSuccess>;
|
3344
3359
|
type InsertRecordPathParams = {
|
3345
3360
|
/**
|
3346
3361
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -4795,245 +4810,245 @@ declare function parseWorkspacesUrlParts(url: string): {
|
|
4795
4810
|
region: string;
|
4796
4811
|
} | null;
|
4797
4812
|
|
4813
|
+
type responses_AggResponse = AggResponse;
|
4798
4814
|
type responses_AuthError = AuthError;
|
4799
4815
|
type responses_BadRequestError = BadRequestError;
|
4800
|
-
type
|
4816
|
+
type responses_BranchMigrationPlan = BranchMigrationPlan;
|
4801
4817
|
type responses_BulkError = BulkError;
|
4802
4818
|
type responses_BulkInsertResponse = BulkInsertResponse;
|
4803
|
-
type
|
4819
|
+
type responses_QueryResponse = QueryResponse;
|
4804
4820
|
type responses_RecordResponse = RecordResponse;
|
4805
|
-
type responses_SchemaCompareResponse = SchemaCompareResponse;
|
4806
4821
|
type responses_RecordUpdateResponse = RecordUpdateResponse;
|
4807
|
-
type
|
4822
|
+
type responses_SchemaCompareResponse = SchemaCompareResponse;
|
4808
4823
|
type responses_SchemaUpdateResponse = SchemaUpdateResponse;
|
4809
|
-
type responses_SummarizeResponse = SummarizeResponse;
|
4810
|
-
type responses_AggResponse = AggResponse;
|
4811
4824
|
type responses_SearchResponse = SearchResponse;
|
4812
|
-
type
|
4813
|
-
type
|
4825
|
+
type responses_SimpleError = SimpleError;
|
4826
|
+
type responses_SummarizeResponse = SummarizeResponse;
|
4814
4827
|
declare namespace responses {
|
4815
4828
|
export {
|
4829
|
+
responses_AggResponse as AggResponse,
|
4816
4830
|
responses_AuthError as AuthError,
|
4817
4831
|
responses_BadRequestError as BadRequestError,
|
4818
|
-
|
4832
|
+
responses_BranchMigrationPlan as BranchMigrationPlan,
|
4819
4833
|
responses_BulkError as BulkError,
|
4820
4834
|
responses_BulkInsertResponse as BulkInsertResponse,
|
4821
|
-
|
4835
|
+
responses_QueryResponse as QueryResponse,
|
4822
4836
|
responses_RecordResponse as RecordResponse,
|
4823
|
-
responses_SchemaCompareResponse as SchemaCompareResponse,
|
4824
4837
|
responses_RecordUpdateResponse as RecordUpdateResponse,
|
4825
|
-
|
4838
|
+
responses_SchemaCompareResponse as SchemaCompareResponse,
|
4826
4839
|
responses_SchemaUpdateResponse as SchemaUpdateResponse,
|
4827
|
-
responses_SummarizeResponse as SummarizeResponse,
|
4828
|
-
responses_AggResponse as AggResponse,
|
4829
4840
|
responses_SearchResponse as SearchResponse,
|
4830
|
-
|
4831
|
-
|
4841
|
+
responses_SimpleError as SimpleError,
|
4842
|
+
responses_SummarizeResponse as SummarizeResponse,
|
4832
4843
|
};
|
4833
4844
|
}
|
4834
4845
|
|
4846
|
+
type schemas_APIKeyName = APIKeyName;
|
4847
|
+
type schemas_AggExpression = AggExpression;
|
4848
|
+
type schemas_AggExpressionMap = AggExpressionMap;
|
4849
|
+
type schemas_AverageAgg = AverageAgg;
|
4850
|
+
type schemas_BoosterExpression = BoosterExpression;
|
4851
|
+
type schemas_Branch = Branch;
|
4835
4852
|
type schemas_BranchMetadata = BranchMetadata;
|
4853
|
+
type schemas_BranchMigration = BranchMigration;
|
4836
4854
|
type schemas_BranchName = BranchName;
|
4837
|
-
type schemas_DBName = DBName;
|
4838
|
-
type schemas_DateTime = DateTime;
|
4839
|
-
type schemas_MigrationStatus = MigrationStatus;
|
4840
|
-
type schemas_ListBranchesResponse = ListBranchesResponse;
|
4841
|
-
type schemas_ListGitBranchesResponse = ListGitBranchesResponse;
|
4842
|
-
type schemas_Branch = Branch;
|
4843
|
-
type schemas_DBBranch = DBBranch;
|
4844
|
-
type schemas_StartedFromMetadata = StartedFromMetadata;
|
4845
|
-
type schemas_Schema = Schema;
|
4846
|
-
type schemas_SchemaEditScript = SchemaEditScript;
|
4847
|
-
type schemas_Table = Table;
|
4848
4855
|
type schemas_Column = Column;
|
4849
4856
|
type schemas_ColumnLink = ColumnLink;
|
4850
|
-
type schemas_RevLink = RevLink;
|
4851
|
-
type schemas_DBBranchName = DBBranchName;
|
4852
|
-
type schemas_TableName = TableName;
|
4853
|
-
type schemas_ColumnName = ColumnName;
|
4854
|
-
type schemas_MetricsDatapoint = MetricsDatapoint;
|
4855
|
-
type schemas_MetricsLatency = MetricsLatency;
|
4856
|
-
type schemas_BranchMigration = BranchMigration;
|
4857
|
-
type schemas_TableMigration = TableMigration;
|
4858
4857
|
type schemas_ColumnMigration = ColumnMigration;
|
4859
|
-
type
|
4860
|
-
type schemas_Migration = Migration;
|
4861
|
-
type schemas_MigrationOp = MigrationOp;
|
4862
|
-
type schemas_MigrationTableOp = MigrationTableOp;
|
4863
|
-
type schemas_MigrationColumnOp = MigrationColumnOp;
|
4864
|
-
type schemas_TableOpAdd = TableOpAdd;
|
4865
|
-
type schemas_TableOpRemove = TableOpRemove;
|
4866
|
-
type schemas_TableOpRename = TableOpRename;
|
4858
|
+
type schemas_ColumnName = ColumnName;
|
4867
4859
|
type schemas_ColumnOpAdd = ColumnOpAdd;
|
4868
4860
|
type schemas_ColumnOpRemove = ColumnOpRemove;
|
4869
4861
|
type schemas_ColumnOpRename = ColumnOpRename;
|
4870
|
-
type
|
4871
|
-
type
|
4872
|
-
type schemas_SortExpression = SortExpression;
|
4873
|
-
type schemas_SortOrder = SortOrder;
|
4874
|
-
type schemas_FuzzinessExpression = FuzzinessExpression;
|
4875
|
-
type schemas_PrefixExpression = PrefixExpression;
|
4876
|
-
type schemas_TargetExpression = TargetExpression;
|
4877
|
-
type schemas_FilterExpression = FilterExpression;
|
4878
|
-
type schemas_SummaryExpressionList = SummaryExpressionList;
|
4879
|
-
type schemas_SummaryExpression = SummaryExpression;
|
4880
|
-
type schemas_AggExpressionMap = AggExpressionMap;
|
4881
|
-
type schemas_AggExpression = AggExpression;
|
4862
|
+
type schemas_ColumnsProjection = ColumnsProjection;
|
4863
|
+
type schemas_Commit = Commit;
|
4882
4864
|
type schemas_CountAgg = CountAgg;
|
4883
|
-
type
|
4884
|
-
type
|
4885
|
-
type
|
4886
|
-
type
|
4887
|
-
type schemas_UniqueCountAgg = UniqueCountAgg;
|
4865
|
+
type schemas_DBBranch = DBBranch;
|
4866
|
+
type schemas_DBBranchName = DBBranchName;
|
4867
|
+
type schemas_DBName = DBName;
|
4868
|
+
type schemas_DatabaseMetadata = DatabaseMetadata;
|
4888
4869
|
type schemas_DateHistogramAgg = DateHistogramAgg;
|
4889
|
-
type
|
4890
|
-
type schemas_NumericHistogramAgg = NumericHistogramAgg;
|
4891
|
-
type schemas_HighlightExpression = HighlightExpression;
|
4892
|
-
type schemas_BoosterExpression = BoosterExpression;
|
4893
|
-
type schemas_FilterList = FilterList;
|
4870
|
+
type schemas_DateTime = DateTime;
|
4894
4871
|
type schemas_FilterColumn = FilterColumn;
|
4895
4872
|
type schemas_FilterColumnIncludes = FilterColumnIncludes;
|
4873
|
+
type schemas_FilterExpression = FilterExpression;
|
4874
|
+
type schemas_FilterList = FilterList;
|
4896
4875
|
type schemas_FilterPredicate = FilterPredicate;
|
4897
4876
|
type schemas_FilterPredicateOp = FilterPredicateOp;
|
4898
4877
|
type schemas_FilterPredicateRangeOp = FilterPredicateRangeOp;
|
4899
4878
|
type schemas_FilterRangeValue = FilterRangeValue;
|
4900
4879
|
type schemas_FilterValue = FilterValue;
|
4880
|
+
type schemas_FuzzinessExpression = FuzzinessExpression;
|
4881
|
+
type schemas_HighlightExpression = HighlightExpression;
|
4882
|
+
type schemas_InviteID = InviteID;
|
4883
|
+
type schemas_InviteKey = InviteKey;
|
4884
|
+
type schemas_ListBranchesResponse = ListBranchesResponse;
|
4885
|
+
type schemas_ListDatabasesResponse = ListDatabasesResponse;
|
4886
|
+
type schemas_ListGitBranchesResponse = ListGitBranchesResponse;
|
4887
|
+
type schemas_ListRegionsResponse = ListRegionsResponse;
|
4888
|
+
type schemas_MaxAgg = MaxAgg;
|
4889
|
+
type schemas_MetricsDatapoint = MetricsDatapoint;
|
4890
|
+
type schemas_MetricsLatency = MetricsLatency;
|
4891
|
+
type schemas_Migration = Migration;
|
4892
|
+
type schemas_MigrationColumnOp = MigrationColumnOp;
|
4893
|
+
type schemas_MigrationOp = MigrationOp;
|
4894
|
+
type schemas_MigrationRequest = MigrationRequest;
|
4895
|
+
type schemas_MigrationRequestNumber = MigrationRequestNumber;
|
4896
|
+
type schemas_MigrationStatus = MigrationStatus;
|
4897
|
+
type schemas_MigrationTableOp = MigrationTableOp;
|
4898
|
+
type schemas_MinAgg = MinAgg;
|
4899
|
+
type schemas_NumericHistogramAgg = NumericHistogramAgg;
|
4901
4900
|
type schemas_PageConfig = PageConfig;
|
4902
|
-
type
|
4903
|
-
type schemas_ColumnsProjection = ColumnsProjection;
|
4904
|
-
type schemas_RecordMeta = RecordMeta;
|
4901
|
+
type schemas_PrefixExpression = PrefixExpression;
|
4905
4902
|
type schemas_RecordID = RecordID;
|
4906
|
-
type
|
4903
|
+
type schemas_RecordMeta = RecordMeta;
|
4907
4904
|
type schemas_RecordsMetadata = RecordsMetadata;
|
4908
|
-
type
|
4909
|
-
type
|
4905
|
+
type schemas_Region = Region;
|
4906
|
+
type schemas_RevLink = RevLink;
|
4907
|
+
type schemas_Role = Role;
|
4908
|
+
type schemas_Schema = Schema;
|
4909
|
+
type schemas_SchemaEditScript = SchemaEditScript;
|
4910
|
+
type schemas_SearchPageConfig = SearchPageConfig;
|
4911
|
+
type schemas_SortExpression = SortExpression;
|
4912
|
+
type schemas_SortOrder = SortOrder;
|
4913
|
+
type schemas_StartedFromMetadata = StartedFromMetadata;
|
4914
|
+
type schemas_SumAgg = SumAgg;
|
4915
|
+
type schemas_SummaryExpression = SummaryExpression;
|
4916
|
+
type schemas_SummaryExpressionList = SummaryExpressionList;
|
4917
|
+
type schemas_Table = Table;
|
4918
|
+
type schemas_TableMigration = TableMigration;
|
4919
|
+
type schemas_TableName = TableName;
|
4920
|
+
type schemas_TableOpAdd = TableOpAdd;
|
4921
|
+
type schemas_TableOpRemove = TableOpRemove;
|
4922
|
+
type schemas_TableOpRename = TableOpRename;
|
4923
|
+
type schemas_TableRename = TableRename;
|
4924
|
+
type schemas_TargetExpression = TargetExpression;
|
4925
|
+
type schemas_TopValuesAgg = TopValuesAgg;
|
4910
4926
|
type schemas_TransactionDeleteOp = TransactionDeleteOp;
|
4927
|
+
type schemas_TransactionError = TransactionError;
|
4928
|
+
type schemas_TransactionFailure = TransactionFailure;
|
4929
|
+
type schemas_TransactionInsertOp = TransactionInsertOp;
|
4930
|
+
type schemas_TransactionResultDelete = TransactionResultDelete;
|
4911
4931
|
type schemas_TransactionResultInsert = TransactionResultInsert;
|
4912
4932
|
type schemas_TransactionResultUpdate = TransactionResultUpdate;
|
4913
|
-
type
|
4914
|
-
type
|
4933
|
+
type schemas_TransactionSuccess = TransactionSuccess;
|
4934
|
+
type schemas_TransactionUpdateOp = TransactionUpdateOp;
|
4935
|
+
type schemas_UniqueCountAgg = UniqueCountAgg;
|
4915
4936
|
type schemas_User = User;
|
4916
4937
|
type schemas_UserID = UserID;
|
4917
4938
|
type schemas_UserWithID = UserWithID;
|
4918
|
-
type schemas_APIKeyName = APIKeyName;
|
4919
|
-
type schemas_WorkspaceID = WorkspaceID;
|
4920
|
-
type schemas_Role = Role;
|
4921
|
-
type schemas_WorkspaceMeta = WorkspaceMeta;
|
4922
4939
|
type schemas_Workspace = Workspace;
|
4923
|
-
type
|
4924
|
-
type schemas_InviteID = InviteID;
|
4940
|
+
type schemas_WorkspaceID = WorkspaceID;
|
4925
4941
|
type schemas_WorkspaceInvite = WorkspaceInvite;
|
4942
|
+
type schemas_WorkspaceMember = WorkspaceMember;
|
4926
4943
|
type schemas_WorkspaceMembers = WorkspaceMembers;
|
4927
|
-
type
|
4928
|
-
type schemas_DatabaseMetadata = DatabaseMetadata;
|
4929
|
-
type schemas_ListDatabasesResponse = ListDatabasesResponse;
|
4930
|
-
type schemas_ListRegionsResponse = ListRegionsResponse;
|
4931
|
-
type schemas_Region = Region;
|
4944
|
+
type schemas_WorkspaceMeta = WorkspaceMeta;
|
4932
4945
|
declare namespace schemas {
|
4933
4946
|
export {
|
4947
|
+
schemas_APIKeyName as APIKeyName,
|
4948
|
+
schemas_AggExpression as AggExpression,
|
4949
|
+
schemas_AggExpressionMap as AggExpressionMap,
|
4950
|
+
AggResponse$1 as AggResponse,
|
4951
|
+
schemas_AverageAgg as AverageAgg,
|
4952
|
+
schemas_BoosterExpression as BoosterExpression,
|
4953
|
+
schemas_Branch as Branch,
|
4934
4954
|
schemas_BranchMetadata as BranchMetadata,
|
4955
|
+
schemas_BranchMigration as BranchMigration,
|
4935
4956
|
schemas_BranchName as BranchName,
|
4936
|
-
schemas_DBName as DBName,
|
4937
|
-
schemas_DateTime as DateTime,
|
4938
|
-
schemas_MigrationStatus as MigrationStatus,
|
4939
|
-
schemas_ListBranchesResponse as ListBranchesResponse,
|
4940
|
-
schemas_ListGitBranchesResponse as ListGitBranchesResponse,
|
4941
|
-
schemas_Branch as Branch,
|
4942
|
-
schemas_DBBranch as DBBranch,
|
4943
|
-
schemas_StartedFromMetadata as StartedFromMetadata,
|
4944
|
-
schemas_Schema as Schema,
|
4945
|
-
schemas_SchemaEditScript as SchemaEditScript,
|
4946
|
-
schemas_Table as Table,
|
4947
4957
|
schemas_Column as Column,
|
4948
4958
|
schemas_ColumnLink as ColumnLink,
|
4949
|
-
schemas_RevLink as RevLink,
|
4950
|
-
schemas_DBBranchName as DBBranchName,
|
4951
|
-
schemas_TableName as TableName,
|
4952
|
-
schemas_ColumnName as ColumnName,
|
4953
|
-
schemas_MetricsDatapoint as MetricsDatapoint,
|
4954
|
-
schemas_MetricsLatency as MetricsLatency,
|
4955
|
-
schemas_BranchMigration as BranchMigration,
|
4956
|
-
schemas_TableMigration as TableMigration,
|
4957
4959
|
schemas_ColumnMigration as ColumnMigration,
|
4958
|
-
|
4959
|
-
schemas_Migration as Migration,
|
4960
|
-
schemas_MigrationOp as MigrationOp,
|
4961
|
-
schemas_MigrationTableOp as MigrationTableOp,
|
4962
|
-
schemas_MigrationColumnOp as MigrationColumnOp,
|
4963
|
-
schemas_TableOpAdd as TableOpAdd,
|
4964
|
-
schemas_TableOpRemove as TableOpRemove,
|
4965
|
-
schemas_TableOpRename as TableOpRename,
|
4960
|
+
schemas_ColumnName as ColumnName,
|
4966
4961
|
schemas_ColumnOpAdd as ColumnOpAdd,
|
4967
4962
|
schemas_ColumnOpRemove as ColumnOpRemove,
|
4968
4963
|
schemas_ColumnOpRename as ColumnOpRename,
|
4969
|
-
|
4970
|
-
|
4971
|
-
schemas_SortExpression as SortExpression,
|
4972
|
-
schemas_SortOrder as SortOrder,
|
4973
|
-
schemas_FuzzinessExpression as FuzzinessExpression,
|
4974
|
-
schemas_PrefixExpression as PrefixExpression,
|
4975
|
-
schemas_TargetExpression as TargetExpression,
|
4976
|
-
schemas_FilterExpression as FilterExpression,
|
4977
|
-
schemas_SummaryExpressionList as SummaryExpressionList,
|
4978
|
-
schemas_SummaryExpression as SummaryExpression,
|
4979
|
-
schemas_AggExpressionMap as AggExpressionMap,
|
4980
|
-
schemas_AggExpression as AggExpression,
|
4964
|
+
schemas_ColumnsProjection as ColumnsProjection,
|
4965
|
+
schemas_Commit as Commit,
|
4981
4966
|
schemas_CountAgg as CountAgg,
|
4982
|
-
|
4983
|
-
|
4984
|
-
|
4985
|
-
|
4986
|
-
schemas_UniqueCountAgg as UniqueCountAgg,
|
4987
|
-
schemas_DateHistogramAgg as DateHistogramAgg,
|
4988
|
-
schemas_TopValuesAgg as TopValuesAgg,
|
4989
|
-
schemas_NumericHistogramAgg as NumericHistogramAgg,
|
4990
|
-
schemas_HighlightExpression as HighlightExpression,
|
4991
|
-
schemas_BoosterExpression as BoosterExpression,
|
4992
|
-
ValueBooster$1 as ValueBooster,
|
4993
|
-
NumericBooster$1 as NumericBooster,
|
4967
|
+
schemas_DBBranch as DBBranch,
|
4968
|
+
schemas_DBBranchName as DBBranchName,
|
4969
|
+
schemas_DBName as DBName,
|
4970
|
+
schemas_DatabaseMetadata as DatabaseMetadata,
|
4994
4971
|
DateBooster$1 as DateBooster,
|
4995
|
-
|
4972
|
+
schemas_DateHistogramAgg as DateHistogramAgg,
|
4973
|
+
schemas_DateTime as DateTime,
|
4996
4974
|
schemas_FilterColumn as FilterColumn,
|
4997
4975
|
schemas_FilterColumnIncludes as FilterColumnIncludes,
|
4976
|
+
schemas_FilterExpression as FilterExpression,
|
4977
|
+
schemas_FilterList as FilterList,
|
4998
4978
|
schemas_FilterPredicate as FilterPredicate,
|
4999
4979
|
schemas_FilterPredicateOp as FilterPredicateOp,
|
5000
4980
|
schemas_FilterPredicateRangeOp as FilterPredicateRangeOp,
|
5001
4981
|
schemas_FilterRangeValue as FilterRangeValue,
|
5002
4982
|
schemas_FilterValue as FilterValue,
|
4983
|
+
schemas_FuzzinessExpression as FuzzinessExpression,
|
4984
|
+
schemas_HighlightExpression as HighlightExpression,
|
4985
|
+
schemas_InviteID as InviteID,
|
4986
|
+
schemas_InviteKey as InviteKey,
|
4987
|
+
schemas_ListBranchesResponse as ListBranchesResponse,
|
4988
|
+
schemas_ListDatabasesResponse as ListDatabasesResponse,
|
4989
|
+
schemas_ListGitBranchesResponse as ListGitBranchesResponse,
|
4990
|
+
schemas_ListRegionsResponse as ListRegionsResponse,
|
4991
|
+
schemas_MaxAgg as MaxAgg,
|
4992
|
+
schemas_MetricsDatapoint as MetricsDatapoint,
|
4993
|
+
schemas_MetricsLatency as MetricsLatency,
|
4994
|
+
schemas_Migration as Migration,
|
4995
|
+
schemas_MigrationColumnOp as MigrationColumnOp,
|
4996
|
+
schemas_MigrationOp as MigrationOp,
|
4997
|
+
schemas_MigrationRequest as MigrationRequest,
|
4998
|
+
schemas_MigrationRequestNumber as MigrationRequestNumber,
|
4999
|
+
schemas_MigrationStatus as MigrationStatus,
|
5000
|
+
schemas_MigrationTableOp as MigrationTableOp,
|
5001
|
+
schemas_MinAgg as MinAgg,
|
5002
|
+
NumericBooster$1 as NumericBooster,
|
5003
|
+
schemas_NumericHistogramAgg as NumericHistogramAgg,
|
5003
5004
|
schemas_PageConfig as PageConfig,
|
5004
|
-
|
5005
|
-
schemas_ColumnsProjection as ColumnsProjection,
|
5006
|
-
schemas_RecordMeta as RecordMeta,
|
5005
|
+
schemas_PrefixExpression as PrefixExpression,
|
5007
5006
|
schemas_RecordID as RecordID,
|
5008
|
-
|
5007
|
+
schemas_RecordMeta as RecordMeta,
|
5009
5008
|
schemas_RecordsMetadata as RecordsMetadata,
|
5010
|
-
|
5011
|
-
|
5012
|
-
|
5013
|
-
|
5009
|
+
schemas_Region as Region,
|
5010
|
+
schemas_RevLink as RevLink,
|
5011
|
+
schemas_Role as Role,
|
5012
|
+
schemas_Schema as Schema,
|
5013
|
+
schemas_SchemaEditScript as SchemaEditScript,
|
5014
|
+
schemas_SearchPageConfig as SearchPageConfig,
|
5015
|
+
schemas_SortExpression as SortExpression,
|
5016
|
+
schemas_SortOrder as SortOrder,
|
5017
|
+
schemas_StartedFromMetadata as StartedFromMetadata,
|
5018
|
+
schemas_SumAgg as SumAgg,
|
5019
|
+
schemas_SummaryExpression as SummaryExpression,
|
5020
|
+
schemas_SummaryExpressionList as SummaryExpressionList,
|
5021
|
+
schemas_Table as Table,
|
5022
|
+
schemas_TableMigration as TableMigration,
|
5023
|
+
schemas_TableName as TableName,
|
5024
|
+
schemas_TableOpAdd as TableOpAdd,
|
5025
|
+
schemas_TableOpRemove as TableOpRemove,
|
5026
|
+
schemas_TableOpRename as TableOpRename,
|
5027
|
+
schemas_TableRename as TableRename,
|
5028
|
+
schemas_TargetExpression as TargetExpression,
|
5029
|
+
schemas_TopValuesAgg as TopValuesAgg,
|
5014
5030
|
schemas_TransactionDeleteOp as TransactionDeleteOp,
|
5031
|
+
schemas_TransactionError as TransactionError,
|
5032
|
+
schemas_TransactionFailure as TransactionFailure,
|
5033
|
+
schemas_TransactionInsertOp as TransactionInsertOp,
|
5034
|
+
TransactionOperation$1 as TransactionOperation,
|
5035
|
+
schemas_TransactionResultDelete as TransactionResultDelete,
|
5015
5036
|
schemas_TransactionResultInsert as TransactionResultInsert,
|
5016
5037
|
schemas_TransactionResultUpdate as TransactionResultUpdate,
|
5017
|
-
|
5018
|
-
|
5019
|
-
|
5038
|
+
schemas_TransactionSuccess as TransactionSuccess,
|
5039
|
+
schemas_TransactionUpdateOp as TransactionUpdateOp,
|
5040
|
+
schemas_UniqueCountAgg as UniqueCountAgg,
|
5020
5041
|
schemas_User as User,
|
5021
5042
|
schemas_UserID as UserID,
|
5022
5043
|
schemas_UserWithID as UserWithID,
|
5023
|
-
|
5024
|
-
schemas_WorkspaceID as WorkspaceID,
|
5025
|
-
schemas_Role as Role,
|
5026
|
-
schemas_WorkspaceMeta as WorkspaceMeta,
|
5044
|
+
ValueBooster$1 as ValueBooster,
|
5027
5045
|
schemas_Workspace as Workspace,
|
5028
|
-
|
5029
|
-
schemas_InviteID as InviteID,
|
5046
|
+
schemas_WorkspaceID as WorkspaceID,
|
5030
5047
|
schemas_WorkspaceInvite as WorkspaceInvite,
|
5048
|
+
schemas_WorkspaceMember as WorkspaceMember,
|
5031
5049
|
schemas_WorkspaceMembers as WorkspaceMembers,
|
5032
|
-
|
5033
|
-
|
5034
|
-
schemas_ListDatabasesResponse as ListDatabasesResponse,
|
5035
|
-
schemas_ListRegionsResponse as ListRegionsResponse,
|
5036
|
-
schemas_Region as Region,
|
5050
|
+
schemas_WorkspaceMeta as WorkspaceMeta,
|
5051
|
+
XataRecord$1 as XataRecord,
|
5037
5052
|
};
|
5038
5053
|
}
|
5039
5054
|
|
@@ -5657,7 +5672,7 @@ type SelectedPick<O extends XataRecord, Key extends SelectableColumn<O>[]> = Xat
|
|
5657
5672
|
type ValueAtColumn<O, P extends SelectableColumn<O>> = P extends '*' ? Values<O> : P extends 'id' ? string : P extends keyof O ? O[P] : P extends `${infer K}.${infer V}` ? K extends keyof O ? Values<NonNullable<O[K]> extends infer Item ? Item extends Record<string, any> ? V extends SelectableColumn<Item> ? {
|
5658
5673
|
V: ValueAtColumn<Item, V>;
|
5659
5674
|
} : never : O[K] : never> : never : never;
|
5660
|
-
type MAX_RECURSION =
|
5675
|
+
type MAX_RECURSION = 2;
|
5661
5676
|
type NestedColumns<O, RecursivePath extends any[]> = RecursivePath['length'] extends MAX_RECURSION ? never : If<IsObject<O>, Values<{
|
5662
5677
|
[K in DataProps<O>]: NonNullable<O[K]> extends infer Item ? If<IsArray<Item>, K, // If the property is an array, we stop recursion. We don't support object arrays yet
|
5663
5678
|
If<IsObject<Item>, Item extends XataRecord ? SelectableColumn<Item, [...RecursivePath, Item]> extends infer Column ? Column extends string ? K | `${K}.${Column}` : never : never : Item extends Date ? K : `${K}.${StringKeys<Item> | '*'}`, // This allows usage of objects that are not links
|
@@ -5693,6 +5708,14 @@ interface XataRecord<OriginalRecord extends XataRecord<any> = XataRecord<any>> e
|
|
5693
5708
|
* Get metadata of this record.
|
5694
5709
|
*/
|
5695
5710
|
getMetadata(): XataRecordMetadata;
|
5711
|
+
/**
|
5712
|
+
* Get an object representation of this record.
|
5713
|
+
*/
|
5714
|
+
toSerializable(): JSONData<OriginalRecord>;
|
5715
|
+
/**
|
5716
|
+
* Get a string representation of this record.
|
5717
|
+
*/
|
5718
|
+
toString(): string;
|
5696
5719
|
/**
|
5697
5720
|
* Retrieves a refreshed copy of the current record from the database.
|
5698
5721
|
* @param columns The columns to retrieve. If not specified, all first level properties are retrieved.
|
@@ -5773,6 +5796,10 @@ type EditableDataFields<T> = T extends XataRecord ? {
|
|
5773
5796
|
type EditableData<O extends XataRecord> = Identifiable & Partial<Omit<{
|
5774
5797
|
[K in keyof O]: EditableDataFields<O[K]>;
|
5775
5798
|
}, keyof XataRecord>>;
|
5799
|
+
type JSONDataFields<T> = T extends XataRecord ? string : NonNullable<T> extends XataRecord ? string | null | undefined : T extends Date ? string : NonNullable<T> extends Date ? string | null | undefined : T;
|
5800
|
+
type JSONData<O> = Identifiable & Partial<Omit<{
|
5801
|
+
[K in keyof O]: JSONDataFields<O[K]>;
|
5802
|
+
}, keyof XataRecord>>;
|
5776
5803
|
|
5777
5804
|
/**
|
5778
5805
|
* PropertyMatchFilter
|
@@ -6573,6 +6600,8 @@ declare class RecordArray<Result extends XataRecord> extends Array<Result> {
|
|
6573
6600
|
constructor(page: Paginable<any, Result>, overrideRecords?: Result[]);
|
6574
6601
|
static parseConstructorParams(...args: any[]): any[];
|
6575
6602
|
toArray(): Result[];
|
6603
|
+
toSerializable(): JSONData<Result>[];
|
6604
|
+
toString(): string;
|
6576
6605
|
map<U>(callbackfn: (value: Result, index: number, array: Result[]) => U, thisArg?: any): U[];
|
6577
6606
|
/**
|
6578
6607
|
* Retrieve next page of records
|
@@ -7526,9 +7555,15 @@ declare class Serializer {
|
|
7526
7555
|
toJSON<T>(data: T): string;
|
7527
7556
|
fromJSON<T>(json: string): T;
|
7528
7557
|
}
|
7529
|
-
|
7530
|
-
|
7531
|
-
|
7558
|
+
type SerializedString<T> = string | (string & {
|
7559
|
+
__type: T;
|
7560
|
+
});
|
7561
|
+
type DeserializedType<T> = T extends SerializedString<infer U> ? U : T;
|
7562
|
+
declare const serialize: <T>(data: T) => SerializedString<T>;
|
7563
|
+
declare const deserialize: <T extends SerializedString<any>>(json: T) => SerializerResult<DeserializedType<T>>;
|
7564
|
+
type SerializerResult<T> = T extends XataRecord ? Identifiable & Omit<{
|
7565
|
+
[K in keyof T]: SerializerResult<T[K]>;
|
7566
|
+
}, keyof XataRecord> : T extends any[] ? SerializerResult<T[number]>[] : T;
|
7532
7567
|
|
7533
7568
|
type BranchResolutionOptions = {
|
7534
7569
|
databaseURL?: string;
|
@@ -7627,4 +7662,4 @@ declare class XataError extends Error {
|
|
7627
7662
|
constructor(message: string, status: number);
|
7628
7663
|
}
|
7629
7664
|
|
7630
|
-
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, AggregateTableError, AggregateTablePathParams, AggregateTableRequestBody, AggregateTableVariables, ApiExtraProps, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BranchTransactionError, BranchTransactionPathParams, BranchTransactionRequestBody, BranchTransactionVariables, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, ColumnsByValue, 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, DeleteBranchResponse, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseResponse, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableResponse, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherError, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchSchemaHistoryError, GetBranchSchemaHistoryPathParams, GetBranchSchemaHistoryRequestBody, GetBranchSchemaHistoryResponse, GetBranchSchemaHistoryVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetDatabaseMetadataError, GetDatabaseMetadataPathParams, GetDatabaseMetadataVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetMigrationRequestError, GetMigrationRequestIsMergedError, GetMigrationRequestIsMergedPathParams, GetMigrationRequestIsMergedResponse, GetMigrationRequestIsMergedVariables, GetMigrationRequestPathParams, GetMigrationRequestVariables, GetRecordError, GetRecordPathParams, GetRecordQueryParams, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, HostProvider, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, Link, ListMigrationRequestsCommitsError, ListMigrationRequestsCommitsPathParams, ListMigrationRequestsCommitsRequestBody, ListMigrationRequestsCommitsResponse, ListMigrationRequestsCommitsVariables, ListRegionsError, ListRegionsPathParams, ListRegionsVariables, MergeMigrationRequestError, MergeMigrationRequestPathParams, MergeMigrationRequestVariables, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, PreviewBranchSchemaEditError, PreviewBranchSchemaEditPathParams, PreviewBranchSchemaEditRequestBody, PreviewBranchSchemaEditResponse, PreviewBranchSchemaEditVariables, Query, QueryMigrationRequestsError, QueryMigrationRequestsPathParams, QueryMigrationRequestsRequestBody, QueryMigrationRequestsResponse, QueryMigrationRequestsVariables, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RecordArray, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaInference, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SearchTableError, SearchTablePathParams, SearchTableRequestBody, SearchTableVariables, SearchXataRecord, SelectableColumn, SelectedPick, Serializer, SerializerResult, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, SummarizeTableError, SummarizeTablePathParams, SummarizeTableRequestBody, SummarizeTableVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, 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, aggregateTable, applyBranchSchemaEdit, branchTransaction, 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, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID };
|
7665
|
+
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, AggregateTableError, AggregateTablePathParams, AggregateTableRequestBody, AggregateTableVariables, ApiExtraProps, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BranchTransactionError, BranchTransactionPathParams, BranchTransactionRequestBody, BranchTransactionVariables, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, ColumnsByValue, 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, DeleteBranchResponse, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseResponse, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableResponse, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, DeserializedType, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherError, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchSchemaHistoryError, GetBranchSchemaHistoryPathParams, GetBranchSchemaHistoryRequestBody, GetBranchSchemaHistoryResponse, GetBranchSchemaHistoryVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetDatabaseMetadataError, GetDatabaseMetadataPathParams, GetDatabaseMetadataVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetMigrationRequestError, GetMigrationRequestIsMergedError, GetMigrationRequestIsMergedPathParams, GetMigrationRequestIsMergedResponse, GetMigrationRequestIsMergedVariables, GetMigrationRequestPathParams, GetMigrationRequestVariables, GetRecordError, GetRecordPathParams, GetRecordQueryParams, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, HostProvider, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, Link, ListMigrationRequestsCommitsError, ListMigrationRequestsCommitsPathParams, ListMigrationRequestsCommitsRequestBody, ListMigrationRequestsCommitsResponse, ListMigrationRequestsCommitsVariables, ListRegionsError, ListRegionsPathParams, ListRegionsVariables, MergeMigrationRequestError, MergeMigrationRequestPathParams, MergeMigrationRequestVariables, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, PreviewBranchSchemaEditError, PreviewBranchSchemaEditPathParams, PreviewBranchSchemaEditRequestBody, PreviewBranchSchemaEditResponse, PreviewBranchSchemaEditVariables, Query, QueryMigrationRequestsError, QueryMigrationRequestsPathParams, QueryMigrationRequestsRequestBody, QueryMigrationRequestsResponse, QueryMigrationRequestsVariables, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RecordArray, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaInference, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SearchTableError, SearchTablePathParams, SearchTableRequestBody, SearchTableVariables, SearchXataRecord, SelectableColumn, SelectedPick, SerializedString, Serializer, SerializerResult, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, SummarizeTableError, SummarizeTablePathParams, SummarizeTableRequestBody, SummarizeTableVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, 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, aggregateTable, applyBranchSchemaEdit, branchTransaction, 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, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID };
|