@xata.io/client 0.0.0-alpha.vf882519 → 0.0.0-alpha.vf88f0fd
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 +32 -0
- package/README.md +9 -2
- package/dist/index.cjs +81 -187
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +913 -1054
- package/dist/index.mjs +81 -181
- package/dist/index.mjs.map +1 -1
- package/package.json +7 -8
- package/rollup.config.mjs +28 -13
package/dist/index.d.ts
CHANGED
@@ -32,8 +32,8 @@ declare abstract class XataPlugin {
|
|
32
32
|
abstract build(options: XataPluginOptions): unknown | Promise<unknown>;
|
33
33
|
}
|
34
34
|
type XataPluginOptions = {
|
35
|
-
getFetchProps: () =>
|
36
|
-
cache
|
35
|
+
getFetchProps: () => ApiExtraProps;
|
36
|
+
cache?: CacheImpl;
|
37
37
|
trace?: TraceFunction;
|
38
38
|
};
|
39
39
|
|
@@ -54,6 +54,20 @@ type Response = {
|
|
54
54
|
};
|
55
55
|
type FetchImpl = (url: string, init?: RequestInit) => Promise<Response>;
|
56
56
|
|
57
|
+
declare class ErrorWithCause extends Error {
|
58
|
+
cause?: Error;
|
59
|
+
constructor(message?: string, options?: {
|
60
|
+
cause?: Error;
|
61
|
+
});
|
62
|
+
}
|
63
|
+
declare class FetcherError extends ErrorWithCause {
|
64
|
+
status: number | string;
|
65
|
+
requestId: string | undefined;
|
66
|
+
errors: BulkError['errors'] | undefined;
|
67
|
+
constructor(status: number, data?: unknown, requestId?: string);
|
68
|
+
toString(): string;
|
69
|
+
}
|
70
|
+
|
57
71
|
type WorkspaceApiUrlBuilder = (path: string, pathParams: Partial<Record<string, string | number>>) => string;
|
58
72
|
type FetcherExtraProps = {
|
59
73
|
endpoint: 'controlPlane' | 'dataPlane';
|
@@ -181,6 +195,10 @@ type DatabaseMetadata = {
|
|
181
195
|
* The time this database was created
|
182
196
|
*/
|
183
197
|
createdAt: DateTime$1;
|
198
|
+
/**
|
199
|
+
* @x-internal true
|
200
|
+
*/
|
201
|
+
newMigrations?: boolean;
|
184
202
|
/**
|
185
203
|
* Metadata about the database for display in Xata user interfaces
|
186
204
|
*/
|
@@ -197,6 +215,18 @@ type ListDatabasesResponse = {
|
|
197
215
|
*/
|
198
216
|
databases: DatabaseMetadata[];
|
199
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;
|
200
230
|
/**
|
201
231
|
* @example {"repository":"github.com/my/repository","branch":"feature-login","stage":"testing","labels":["epic-100"]}
|
202
232
|
* @x-go-type xata.BranchMetadata
|
@@ -213,34 +243,22 @@ type BranchMetadata$1 = {
|
|
213
243
|
stage?: string;
|
214
244
|
labels?: string[];
|
215
245
|
};
|
216
|
-
/**
|
217
|
-
* @pattern [a-zA-Z0-9_\-~]+
|
218
|
-
*/
|
219
|
-
type BranchName$1 = string;
|
220
|
-
/**
|
221
|
-
* @pattern [a-zA-Z0-9_\-~]+
|
222
|
-
*/
|
223
|
-
type DBName$1 = string;
|
224
246
|
type MigrationStatus$1 = 'completed' | 'pending' | 'failed';
|
247
|
+
type Region = {
|
248
|
+
id: string;
|
249
|
+
};
|
225
250
|
type ListRegionsResponse = {
|
226
251
|
/**
|
227
252
|
* A list of regions where databases can be created
|
228
253
|
*/
|
229
254
|
regions: Region[];
|
230
255
|
};
|
231
|
-
type Region = {
|
232
|
-
id: string;
|
233
|
-
};
|
234
256
|
|
235
257
|
/**
|
236
258
|
* Generated by @openapi-codegen
|
237
259
|
*
|
238
260
|
* @version 1.0
|
239
261
|
*/
|
240
|
-
type SimpleError$1 = {
|
241
|
-
id?: string;
|
242
|
-
message: string;
|
243
|
-
};
|
244
262
|
type BadRequestError$1 = {
|
245
263
|
id?: string;
|
246
264
|
message: string;
|
@@ -252,6 +270,10 @@ type AuthError$1 = {
|
|
252
270
|
id?: string;
|
253
271
|
message: string;
|
254
272
|
};
|
273
|
+
type SimpleError$1 = {
|
274
|
+
id?: string;
|
275
|
+
message: string;
|
276
|
+
};
|
255
277
|
|
256
278
|
/**
|
257
279
|
* Generated by @openapi-codegen
|
@@ -787,6 +809,12 @@ type CreateDatabaseError = ErrorWrapper$1<{
|
|
787
809
|
} | {
|
788
810
|
status: 401;
|
789
811
|
payload: AuthError$1;
|
812
|
+
} | {
|
813
|
+
status: 422;
|
814
|
+
payload: SimpleError$1;
|
815
|
+
} | {
|
816
|
+
status: 423;
|
817
|
+
payload: SimpleError$1;
|
790
818
|
}>;
|
791
819
|
type CreateDatabaseResponse = {
|
792
820
|
/**
|
@@ -938,55 +966,38 @@ declare const listRegions: (variables: ListRegionsVariables, signal?: AbortSigna
|
|
938
966
|
* @version 1.0
|
939
967
|
*/
|
940
968
|
/**
|
941
|
-
*
|
969
|
+
* @maxLength 255
|
970
|
+
* @minLength 1
|
971
|
+
* @pattern [a-zA-Z0-9_\-~]+
|
942
972
|
*/
|
943
|
-
type
|
944
|
-
|
945
|
-
|
946
|
-
|
973
|
+
type DBName = string;
|
974
|
+
/**
|
975
|
+
* @format date-time
|
976
|
+
* @x-go-type string
|
977
|
+
*/
|
978
|
+
type DateTime = string;
|
979
|
+
type Branch = {
|
947
980
|
name: string;
|
948
|
-
/**
|
949
|
-
* The time this database was created
|
950
|
-
*/
|
951
981
|
createdAt: DateTime;
|
952
|
-
/**
|
953
|
-
* The number of branches the database has
|
954
|
-
*/
|
955
|
-
numberOfBranches: number;
|
956
|
-
/**
|
957
|
-
* Metadata about the database for display in Xata user interfaces
|
958
|
-
*/
|
959
|
-
ui?: {
|
960
|
-
/**
|
961
|
-
* The user-selected color for this database across interfaces
|
962
|
-
*/
|
963
|
-
color?: string;
|
964
|
-
};
|
965
|
-
/**
|
966
|
-
* @x-internal true
|
967
|
-
*/
|
968
|
-
newMigrations?: boolean;
|
969
|
-
};
|
970
|
-
type DEPRECATEDListDatabasesResponse = {
|
971
|
-
/**
|
972
|
-
* A list of databases in a Xata workspace
|
973
|
-
*/
|
974
|
-
databases?: DEPRECATEDDatabaseMetadata[];
|
975
982
|
};
|
976
983
|
type ListBranchesResponse = {
|
977
984
|
databaseName: string;
|
978
985
|
branches: Branch[];
|
979
986
|
};
|
980
|
-
|
981
|
-
|
982
|
-
|
983
|
-
|
984
|
-
|
985
|
-
|
986
|
-
|
987
|
-
|
988
|
-
|
989
|
-
|
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;
|
990
1001
|
/**
|
991
1002
|
* @example {"repository":"github.com/my/repository","branch":"feature-login","stage":"testing","labels":["epic-100"]}
|
992
1003
|
* @x-go-type xata.BranchMetadata
|
@@ -1003,39 +1014,19 @@ type BranchMetadata = {
|
|
1003
1014
|
stage?: string;
|
1004
1015
|
labels?: string[];
|
1005
1016
|
};
|
1006
|
-
type DBBranch = {
|
1007
|
-
databaseName: DBName;
|
1008
|
-
branchName: BranchName;
|
1009
|
-
createdAt: DateTime;
|
1010
|
-
id: string;
|
1011
|
-
version: number;
|
1012
|
-
lastMigrationID: string;
|
1013
|
-
metadata?: BranchMetadata;
|
1014
|
-
startedFrom?: StartedFromMetadata;
|
1015
|
-
schema: Schema;
|
1016
|
-
};
|
1017
1017
|
type StartedFromMetadata = {
|
1018
1018
|
branchName: BranchName;
|
1019
1019
|
dbBranchID: string;
|
1020
1020
|
migrationID: string;
|
1021
1021
|
};
|
1022
1022
|
/**
|
1023
|
-
* @
|
1023
|
+
* @maxLength 255
|
1024
|
+
* @minLength 1
|
1025
|
+
* @pattern [a-zA-Z0-9_\-~]+
|
1024
1026
|
*/
|
1025
|
-
type
|
1026
|
-
|
1027
|
-
|
1028
|
-
};
|
1029
|
-
type SchemaEditScript = {
|
1030
|
-
sourceMigrationID?: string;
|
1031
|
-
targetMigrationID?: string;
|
1032
|
-
operations: MigrationOp[];
|
1033
|
-
};
|
1034
|
-
type Table = {
|
1035
|
-
id?: string;
|
1036
|
-
name: TableName;
|
1037
|
-
columns: Column[];
|
1038
|
-
revLinks?: RevLink[];
|
1027
|
+
type TableName = string;
|
1028
|
+
type ColumnLink = {
|
1029
|
+
table: string;
|
1039
1030
|
};
|
1040
1031
|
type Column = {
|
1041
1032
|
name: string;
|
@@ -1046,35 +1037,35 @@ type Column = {
|
|
1046
1037
|
unique?: boolean;
|
1047
1038
|
columns?: Column[];
|
1048
1039
|
};
|
1049
|
-
type ColumnLink = {
|
1050
|
-
table: string;
|
1051
|
-
};
|
1052
1040
|
type RevLink = {
|
1053
1041
|
linkID: string;
|
1054
1042
|
table: string;
|
1055
1043
|
};
|
1044
|
+
type Table = {
|
1045
|
+
id?: string;
|
1046
|
+
name: TableName;
|
1047
|
+
columns: Column[];
|
1048
|
+
revLinks?: RevLink[];
|
1049
|
+
};
|
1056
1050
|
/**
|
1057
|
-
* @
|
1058
|
-
*/
|
1059
|
-
type BranchName = string;
|
1060
|
-
/**
|
1061
|
-
* @pattern [a-zA-Z0-9_\-~]+
|
1062
|
-
*/
|
1063
|
-
type DBName = string;
|
1064
|
-
/**
|
1065
|
-
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
1066
|
-
*
|
1067
|
-
* @pattern [a-zA-Z0-9_\-~]+:[a-zA-Z0-9_\-~]+
|
1068
|
-
*/
|
1069
|
-
type DBBranchName = string;
|
1070
|
-
/**
|
1071
|
-
* @pattern [a-zA-Z0-9_\-~]+
|
1072
|
-
*/
|
1073
|
-
type TableName = string;
|
1074
|
-
/**
|
1075
|
-
* @pattern [a-zA-Z0-9_\-~\.]+
|
1051
|
+
* @x-go-type xata.Schema
|
1076
1052
|
*/
|
1077
|
-
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';
|
1078
1069
|
type MetricsDatapoint = {
|
1079
1070
|
timestamp: string;
|
1080
1071
|
value: number;
|
@@ -1083,6 +1074,37 @@ type MetricsLatency = {
|
|
1083
1074
|
p50?: MetricsDatapoint[];
|
1084
1075
|
p90?: MetricsDatapoint[];
|
1085
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
|
+
};
|
1086
1108
|
type BranchMigration = {
|
1087
1109
|
id?: string;
|
1088
1110
|
parentID?: string;
|
@@ -1101,78 +1123,109 @@ type BranchMigration = {
|
|
1101
1123
|
newTableOrder: string[];
|
1102
1124
|
renamedTables?: TableRename[];
|
1103
1125
|
};
|
1104
|
-
type TableMigration = {
|
1105
|
-
newColumns?: {
|
1106
|
-
[key: string]: Column;
|
1107
|
-
};
|
1108
|
-
removedColumns?: string[];
|
1109
|
-
modifiedColumns?: ColumnMigration[];
|
1110
|
-
newColumnOrder: string[];
|
1111
|
-
};
|
1112
|
-
type ColumnMigration = {
|
1113
|
-
old: Column;
|
1114
|
-
['new']: Column;
|
1115
|
-
};
|
1116
|
-
type Commit = {
|
1117
|
-
title?: string;
|
1118
|
-
message?: string;
|
1119
|
-
id: string;
|
1120
|
-
parentID?: string;
|
1121
|
-
mergeParentID?: string;
|
1122
|
-
status: MigrationStatus;
|
1123
|
-
createdAt: DateTime;
|
1124
|
-
modifiedAt?: DateTime;
|
1125
|
-
operations: MigrationOp[];
|
1126
|
-
};
|
1127
|
-
type MigrationStatus = 'completed' | 'pending' | 'failed';
|
1128
1126
|
/**
|
1129
|
-
*
|
1127
|
+
* @minProperties 1
|
1130
1128
|
*/
|
1131
|
-
type
|
1132
|
-
|
1133
|
-
|
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;
|
1134
1138
|
};
|
1139
|
+
type FilterList = FilterExpression | FilterExpression[];
|
1140
|
+
type FilterValue = number | string | boolean;
|
1141
|
+
type FilterPredicate = FilterValue | FilterPredicate[] | FilterPredicateOp | FilterPredicateRangeOp;
|
1142
|
+
type FilterRangeValue = number | string;
|
1135
1143
|
/**
|
1136
|
-
*
|
1144
|
+
* @maxProperties 1
|
1145
|
+
* @minProperties 1
|
1137
1146
|
*/
|
1138
|
-
type
|
1139
|
-
|
1140
|
-
|
1141
|
-
|
1142
|
-
|
1143
|
-
|
1144
|
-
|
1145
|
-
|
1146
|
-
|
1147
|
-
|
1148
|
-
|
1149
|
-
|
1150
|
-
|
1151
|
-
|
1152
|
-
|
1153
|
-
type TableOpAdd = {
|
1154
|
-
table: string;
|
1155
|
-
};
|
1156
|
-
type TableOpRemove = {
|
1157
|
-
table: string;
|
1158
|
-
};
|
1159
|
-
type TableOpRename = {
|
1160
|
-
oldName: string;
|
1161
|
-
newName: string;
|
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;
|
1162
1162
|
};
|
1163
|
-
|
1164
|
-
|
1165
|
-
|
1163
|
+
/**
|
1164
|
+
* @maxProperties 2
|
1165
|
+
* @minProperties 2
|
1166
|
+
*/
|
1167
|
+
type FilterPredicateRangeOp = {
|
1168
|
+
$lt?: FilterRangeValue;
|
1169
|
+
$le?: FilterRangeValue;
|
1170
|
+
$gt?: FilterRangeValue;
|
1171
|
+
$ge?: FilterRangeValue;
|
1166
1172
|
};
|
1167
|
-
|
1168
|
-
|
1169
|
-
|
1173
|
+
/**
|
1174
|
+
* @maxProperties 1
|
1175
|
+
* @minProperties 1
|
1176
|
+
*/
|
1177
|
+
type FilterColumnIncludes = {
|
1178
|
+
$includes?: FilterPredicate;
|
1179
|
+
$includesAny?: FilterPredicate;
|
1180
|
+
$includesAll?: FilterPredicate;
|
1181
|
+
$includesNone?: FilterPredicate;
|
1170
1182
|
};
|
1171
|
-
type
|
1172
|
-
|
1173
|
-
|
1174
|
-
|
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;
|
1175
1222
|
};
|
1223
|
+
/**
|
1224
|
+
* @example name
|
1225
|
+
* @example email
|
1226
|
+
* @example created_at
|
1227
|
+
*/
|
1228
|
+
type ColumnsProjection = string[];
|
1176
1229
|
/**
|
1177
1230
|
* The migration request number.
|
1178
1231
|
*
|
@@ -1216,303 +1269,289 @@ type MigrationRequest = {
|
|
1216
1269
|
*/
|
1217
1270
|
target?: string;
|
1218
1271
|
};
|
1219
|
-
|
1220
|
-
|
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;
|
1221
1299
|
} | {
|
1222
|
-
|
1223
|
-
}
|
1224
|
-
|
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
|
+
};
|
1225
1324
|
/**
|
1226
|
-
*
|
1227
|
-
* distance is the number of one character changes needed to make two strings equal. The default is 1, meaning that single
|
1228
|
-
* character typos per word are tollerated by search. You can set it to 0 to remove the typo tollerance or set it to 2
|
1229
|
-
* to allow two typos in a word.
|
1230
|
-
*
|
1231
|
-
* @default 1
|
1232
|
-
* @maximum 2
|
1233
|
-
* @minimum 0
|
1325
|
+
* Branch schema migration operations.
|
1234
1326
|
*/
|
1235
|
-
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
|
+
};
|
1236
1344
|
/**
|
1237
|
-
*
|
1345
|
+
* Branch schema migration.
|
1238
1346
|
*/
|
1239
|
-
type
|
1347
|
+
type Migration = {
|
1348
|
+
parentID?: string;
|
1349
|
+
operations: MigrationOp[];
|
1350
|
+
};
|
1240
1351
|
/**
|
1241
|
-
*
|
1352
|
+
* @pattern [a-zA-Z0-9_\-~\.]+
|
1242
1353
|
*/
|
1243
|
-
type
|
1354
|
+
type ColumnName = string;
|
1355
|
+
/**
|
1356
|
+
* Insert operation
|
1357
|
+
*/
|
1358
|
+
type TransactionInsertOp = {
|
1244
1359
|
/**
|
1245
|
-
* The name
|
1360
|
+
* The table name
|
1246
1361
|
*/
|
1247
|
-
|
1362
|
+
table: string;
|
1248
1363
|
/**
|
1249
|
-
* 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.
|
1250
1376
|
*
|
1251
|
-
*
|
1252
|
-
*
|
1253
|
-
*
|
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.
|
1254
1382
|
*/
|
1255
|
-
|
1256
|
-
}
|
1383
|
+
createOnly?: boolean;
|
1384
|
+
};
|
1257
1385
|
/**
|
1258
|
-
* @
|
1386
|
+
* @pattern [a-zA-Z0-9_-~:]+
|
1259
1387
|
*/
|
1260
|
-
type
|
1261
|
-
$exists?: string;
|
1262
|
-
$existsNot?: string;
|
1263
|
-
$any?: FilterList;
|
1264
|
-
$all?: FilterList;
|
1265
|
-
$none?: FilterList;
|
1266
|
-
$not?: FilterList;
|
1267
|
-
} & {
|
1268
|
-
[key: string]: FilterColumn;
|
1269
|
-
};
|
1388
|
+
type RecordID = string;
|
1270
1389
|
/**
|
1271
|
-
*
|
1272
|
-
* you'd like for the summary. These names must not collide with other columns you've
|
1273
|
-
* requested from `columns`; including implicit requests like `settings.*`.
|
1274
|
-
*
|
1275
|
-
* The value for each key needs to be an object. This object should contain one key and one
|
1276
|
-
* value only. In this object, the key should be set to the summary function you wish to use
|
1277
|
-
* and the value set to the column name to be summarized.
|
1278
|
-
*
|
1279
|
-
* The column being summarized cannot be an internal column (id, xata.*), nor the base of
|
1280
|
-
* an object, i.e. if `settings` is an object with `dark_mode` as a field, you may summarize
|
1281
|
-
* `settings.dark_mode` but not `settings` nor `settings.*`.
|
1282
|
-
*
|
1283
|
-
* @example {"all_users":{"count":"*"}}
|
1284
|
-
* @example {"total_created":{"count":"created_at"}}
|
1285
|
-
* @example {"min_cost":{"min":"cost"}}
|
1286
|
-
* @example {"max_happiness":{"max":"happiness"}}
|
1287
|
-
* @example {"total_revenue":{"sum":"revenue"}}
|
1288
|
-
* @example {"average_speed":{"average":"speed"}}
|
1289
|
-
* @x-go-type xbquery.SummaryList
|
1390
|
+
* Update operation
|
1290
1391
|
*/
|
1291
|
-
type
|
1292
|
-
|
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;
|
1293
1412
|
};
|
1294
1413
|
/**
|
1295
|
-
* A
|
1296
|
-
* key representing the operation, and a value representing the column to be operated on.
|
1297
|
-
*
|
1298
|
-
* The column being summarized cannot be an internal column (id, xata.*), nor the base of
|
1299
|
-
* an object, i.e. if `settings` is an object with `dark_mode` as a field, you may summarize
|
1300
|
-
* `settings.dark_mode` but not `settings` nor `settings.*`.
|
1301
|
-
*
|
1302
|
-
* We currently support several aggregation functions. Not all functions can be run on all column
|
1303
|
-
* types.
|
1304
|
-
*
|
1305
|
-
* - `count` is used to count the number of records in each group. Use `{"count": "*"}` to count
|
1306
|
-
* all columns present, otherwise `{"count": "<column_path>"}` to count the number of non-null
|
1307
|
-
* values are present at column path.
|
1308
|
-
*
|
1309
|
-
* Count can be used on any column type, and always returns an int.
|
1310
|
-
*
|
1311
|
-
* - `min` calculates the minimum value in each group. `min` is compatible with most types;
|
1312
|
-
* string, multiple, text, email, int, float, and datetime. It returns a value of the same
|
1313
|
-
* type as operated on. This means that `{"lowest_latency": {"min": "latency"}}` where
|
1314
|
-
* `latency` is an int, will always return an int.
|
1315
|
-
*
|
1316
|
-
* - `max` calculates the maximum value in each group. `max` shares the same compatibility as
|
1317
|
-
* `min`.
|
1318
|
-
*
|
1319
|
-
* - `sum` adds up all values in a group. `sum` can be run on `int` and `float` types, and will
|
1320
|
-
* return a value of the same type as requested.
|
1321
|
-
*
|
1322
|
-
* - `average` averages all values in a group. `average` can be run on `int` and `float` types, and
|
1323
|
-
* always returns a float.
|
1324
|
-
*
|
1325
|
-
* @example {"count":"deleted_at"}
|
1326
|
-
* @x-go-type xbquery.Summary
|
1327
|
-
*/
|
1328
|
-
type SummaryExpression = Record<string, any>;
|
1329
|
-
/**
|
1330
|
-
* The description of the aggregations you wish to receive.
|
1331
|
-
*
|
1332
|
-
* @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.
|
1333
1415
|
*/
|
1334
|
-
type
|
1335
|
-
|
1416
|
+
type TransactionDeleteOp = {
|
1417
|
+
/**
|
1418
|
+
* The table name
|
1419
|
+
*/
|
1420
|
+
table: string;
|
1421
|
+
id: RecordID;
|
1336
1422
|
};
|
1337
1423
|
/**
|
1338
|
-
*
|
1339
|
-
* The key represents the aggreagtion type, while the value is an object with the configuration of
|
1340
|
-
* the aggreagtion.
|
1341
|
-
*
|
1342
|
-
* @x-go-type xata.AggExpression
|
1424
|
+
* A transaction operation
|
1343
1425
|
*/
|
1344
|
-
type
|
1345
|
-
|
1346
|
-
} | {
|
1347
|
-
sum?: SumAgg;
|
1348
|
-
} | {
|
1349
|
-
max?: MaxAgg;
|
1350
|
-
} | {
|
1351
|
-
min?: MinAgg;
|
1352
|
-
} | {
|
1353
|
-
average?: AverageAgg;
|
1354
|
-
} | {
|
1355
|
-
uniqueCount?: UniqueCountAgg;
|
1356
|
-
} | {
|
1357
|
-
dateHistogram?: DateHistogramAgg;
|
1426
|
+
type TransactionOperation$1 = {
|
1427
|
+
insert: TransactionInsertOp;
|
1358
1428
|
} | {
|
1359
|
-
|
1429
|
+
update: TransactionUpdateOp;
|
1360
1430
|
} | {
|
1361
|
-
|
1431
|
+
['delete']: TransactionDeleteOp;
|
1362
1432
|
};
|
1363
1433
|
/**
|
1364
|
-
*
|
1365
|
-
*/
|
1366
|
-
type CountAgg = {
|
1367
|
-
filter?: FilterExpression;
|
1368
|
-
} | '*';
|
1369
|
-
/**
|
1370
|
-
* The sum of the numeric values in a particular column.
|
1434
|
+
* A result from an insert operation.
|
1371
1435
|
*/
|
1372
|
-
type
|
1436
|
+
type TransactionResultInsert = {
|
1373
1437
|
/**
|
1374
|
-
* The
|
1438
|
+
* The type of operation who's result is being returned.
|
1375
1439
|
*/
|
1376
|
-
|
1377
|
-
};
|
1378
|
-
/**
|
1379
|
-
* The max of the numeric values in a particular column.
|
1380
|
-
*/
|
1381
|
-
type MaxAgg = {
|
1440
|
+
operation: 'insert';
|
1382
1441
|
/**
|
1383
|
-
* The
|
1442
|
+
* The number of affected rows
|
1384
1443
|
*/
|
1385
|
-
|
1444
|
+
rows: number;
|
1445
|
+
id: RecordID;
|
1386
1446
|
};
|
1387
1447
|
/**
|
1388
|
-
*
|
1448
|
+
* A result from an update operation.
|
1389
1449
|
*/
|
1390
|
-
type
|
1450
|
+
type TransactionResultUpdate = {
|
1391
1451
|
/**
|
1392
|
-
* The
|
1452
|
+
* The type of operation who's result is being returned.
|
1393
1453
|
*/
|
1394
|
-
|
1395
|
-
};
|
1396
|
-
/**
|
1397
|
-
* The average of the numeric values in a particular column.
|
1398
|
-
*/
|
1399
|
-
type AverageAgg = {
|
1454
|
+
operation: 'update';
|
1400
1455
|
/**
|
1401
|
-
* The
|
1456
|
+
* The number of updated rows
|
1402
1457
|
*/
|
1403
|
-
|
1458
|
+
rows: number;
|
1459
|
+
id: RecordID;
|
1404
1460
|
};
|
1405
1461
|
/**
|
1406
|
-
*
|
1462
|
+
* A result from a delete operation.
|
1407
1463
|
*/
|
1408
|
-
type
|
1464
|
+
type TransactionResultDelete = {
|
1409
1465
|
/**
|
1410
|
-
* The
|
1466
|
+
* The type of operation who's result is being returned.
|
1411
1467
|
*/
|
1412
|
-
|
1468
|
+
operation: 'delete';
|
1413
1469
|
/**
|
1414
|
-
* The
|
1415
|
-
* values in the column is higher than this threshold, the results are approximative.
|
1416
|
-
* Maximum value is 40,000, default value is 3000.
|
1470
|
+
* The number of deleted rows
|
1417
1471
|
*/
|
1418
|
-
|
1472
|
+
rows: number;
|
1419
1473
|
};
|
1420
1474
|
/**
|
1421
|
-
*
|
1475
|
+
* An ordered array of results from the submitted operations.
|
1422
1476
|
*/
|
1423
|
-
type
|
1424
|
-
|
1425
|
-
|
1426
|
-
|
1427
|
-
|
1428
|
-
|
1429
|
-
|
1430
|
-
* It is fromatted as number + units, for example: `5d`, `20m`, `10s`.
|
1431
|
-
*
|
1432
|
-
* @pattern ^(\d+)(d|h|m|s|ms)$
|
1433
|
-
*/
|
1434
|
-
interval?: string;
|
1477
|
+
type TransactionSuccess = {
|
1478
|
+
results: (TransactionResultInsert | TransactionResultUpdate | TransactionResultDelete)[];
|
1479
|
+
};
|
1480
|
+
/**
|
1481
|
+
* An error message from a failing transaction operation
|
1482
|
+
*/
|
1483
|
+
type TransactionError = {
|
1435
1484
|
/**
|
1436
|
-
* The
|
1437
|
-
* `hour`, `day`, `week`, `month`, `quarter`, `year`.
|
1485
|
+
* The index of the failing operation
|
1438
1486
|
*/
|
1439
|
-
|
1487
|
+
index: number;
|
1440
1488
|
/**
|
1441
|
-
* The
|
1442
|
-
* The accepted format is as an ISO 8601 UTC offset. For example: `+01:00` or
|
1443
|
-
* `-08:00`.
|
1444
|
-
*
|
1445
|
-
* @pattern ^[+-][01]\d:[0-5]\d$
|
1489
|
+
* The error message
|
1446
1490
|
*/
|
1447
|
-
|
1448
|
-
aggs?: AggExpressionMap;
|
1491
|
+
message: string;
|
1449
1492
|
};
|
1450
1493
|
/**
|
1451
|
-
*
|
1452
|
-
* The top values as ordered by the number of records (`$count`) are returned.
|
1494
|
+
* An array of errors, with indicides, from the transaction.
|
1453
1495
|
*/
|
1454
|
-
type
|
1496
|
+
type TransactionFailure = {
|
1455
1497
|
/**
|
1456
|
-
* The
|
1498
|
+
* The request ID.
|
1457
1499
|
*/
|
1458
|
-
|
1459
|
-
aggs?: AggExpressionMap;
|
1500
|
+
id: string;
|
1460
1501
|
/**
|
1461
|
-
*
|
1462
|
-
*
|
1463
|
-
* @default 10
|
1464
|
-
* @maximum 1000
|
1502
|
+
* An array of errors from the submitted operations.
|
1465
1503
|
*/
|
1466
|
-
|
1504
|
+
errors: TransactionError[];
|
1467
1505
|
};
|
1468
1506
|
/**
|
1469
|
-
*
|
1507
|
+
* Xata Table Record Metadata
|
1470
1508
|
*/
|
1471
|
-
type
|
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 | {
|
1472
1542
|
/**
|
1473
|
-
* The
|
1543
|
+
* The name of the column.
|
1474
1544
|
*/
|
1475
1545
|
column: string;
|
1476
1546
|
/**
|
1477
|
-
* The
|
1478
|
-
* with this value as size.
|
1479
|
-
*
|
1480
|
-
* @minimum 0
|
1481
|
-
*/
|
1482
|
-
interval: number;
|
1483
|
-
/**
|
1484
|
-
* By default the bucket keys start with 0 and then continue in `interval` steps. The bucket
|
1485
|
-
* boundaries can be shiftend by using the offset option. For example, if the `interval` is 100,
|
1486
|
-
* but you prefer the bucket boundaries to be `[50, 150), [150, 250), etc.`, you can set `offset`
|
1487
|
-
* to 50.
|
1547
|
+
* The weight of the column.
|
1488
1548
|
*
|
1489
|
-
* @default
|
1490
|
-
|
1491
|
-
|
1492
|
-
|
1493
|
-
|
1494
|
-
|
1495
|
-
/**
|
1496
|
-
* Set to `false` to disable highlighting. By default it is `true`.
|
1497
|
-
*/
|
1498
|
-
enabled?: boolean;
|
1499
|
-
/**
|
1500
|
-
* Set to `false` to disable HTML encoding in highlight snippets. By default it is `true`.
|
1501
|
-
*/
|
1502
|
-
encodeHTML?: boolean;
|
1503
|
-
};
|
1504
|
-
/**
|
1505
|
-
* Booster Expression
|
1506
|
-
*
|
1507
|
-
* @x-go-type xata.BoosterExpression
|
1508
|
-
*/
|
1509
|
-
type BoosterExpression = {
|
1510
|
-
valueBooster?: ValueBooster$1;
|
1511
|
-
} | {
|
1512
|
-
numericBooster?: NumericBooster$1;
|
1513
|
-
} | {
|
1514
|
-
dateBooster?: DateBooster$1;
|
1515
|
-
};
|
1549
|
+
* @default 1
|
1550
|
+
* @maximum 10
|
1551
|
+
* @minimum 1
|
1552
|
+
*/
|
1553
|
+
weight?: number;
|
1554
|
+
})[];
|
1516
1555
|
/**
|
1517
1556
|
* Boost records with a particular value for a column.
|
1518
1557
|
*/
|
@@ -1595,83 +1634,42 @@ type DateBooster$1 = {
|
|
1595
1634
|
*/
|
1596
1635
|
ifMatchesFilter?: FilterExpression;
|
1597
1636
|
};
|
1598
|
-
type FilterList = FilterExpression | FilterExpression[];
|
1599
|
-
type FilterColumn = FilterColumnIncludes | FilterPredicate | FilterList;
|
1600
|
-
/**
|
1601
|
-
* @maxProperties 1
|
1602
|
-
* @minProperties 1
|
1603
|
-
*/
|
1604
|
-
type FilterColumnIncludes = {
|
1605
|
-
$includes?: FilterPredicate;
|
1606
|
-
$includesAny?: FilterPredicate;
|
1607
|
-
$includesAll?: FilterPredicate;
|
1608
|
-
$includesNone?: FilterPredicate;
|
1609
|
-
};
|
1610
|
-
type FilterPredicate = FilterValue | FilterPredicate[] | FilterPredicateOp | FilterPredicateRangeOp;
|
1611
1637
|
/**
|
1612
|
-
*
|
1613
|
-
*
|
1638
|
+
* Booster Expression
|
1639
|
+
*
|
1640
|
+
* @x-go-type xata.BoosterExpression
|
1614
1641
|
*/
|
1615
|
-
type
|
1616
|
-
|
1617
|
-
|
1618
|
-
|
1619
|
-
|
1620
|
-
|
1621
|
-
$isNot?: FilterValue | FilterValue[];
|
1622
|
-
$lt?: FilterRangeValue;
|
1623
|
-
$le?: FilterRangeValue;
|
1624
|
-
$gt?: FilterRangeValue;
|
1625
|
-
$ge?: FilterRangeValue;
|
1626
|
-
$contains?: string;
|
1627
|
-
$startsWith?: string;
|
1628
|
-
$endsWith?: string;
|
1629
|
-
$pattern?: string;
|
1642
|
+
type BoosterExpression = {
|
1643
|
+
valueBooster?: ValueBooster$1;
|
1644
|
+
} | {
|
1645
|
+
numericBooster?: NumericBooster$1;
|
1646
|
+
} | {
|
1647
|
+
dateBooster?: DateBooster$1;
|
1630
1648
|
};
|
1631
1649
|
/**
|
1632
|
-
*
|
1633
|
-
*
|
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
|
1634
1658
|
*/
|
1635
|
-
type
|
1636
|
-
$lt?: FilterRangeValue;
|
1637
|
-
$le?: FilterRangeValue;
|
1638
|
-
$gt?: FilterRangeValue;
|
1639
|
-
$ge?: FilterRangeValue;
|
1640
|
-
};
|
1641
|
-
type FilterRangeValue = number | string;
|
1642
|
-
type FilterValue = number | string | boolean;
|
1659
|
+
type FuzzinessExpression = number;
|
1643
1660
|
/**
|
1644
|
-
*
|
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.
|
1645
1662
|
*/
|
1646
|
-
type
|
1647
|
-
|
1648
|
-
* Query the next page that follow the cursor.
|
1649
|
-
*/
|
1650
|
-
after?: string;
|
1651
|
-
/**
|
1652
|
-
* Query the previous page before the cursor.
|
1653
|
-
*/
|
1654
|
-
before?: string;
|
1655
|
-
/**
|
1656
|
-
* Query the first page from the cursor.
|
1657
|
-
*/
|
1658
|
-
start?: string;
|
1659
|
-
/**
|
1660
|
-
* Query the last page from the cursor.
|
1661
|
-
*/
|
1662
|
-
end?: string;
|
1663
|
+
type PrefixExpression = 'phrase' | 'disabled';
|
1664
|
+
type HighlightExpression = {
|
1663
1665
|
/**
|
1664
|
-
* Set
|
1665
|
-
*
|
1666
|
-
* @default 20
|
1666
|
+
* Set to `false` to disable highlighting. By default it is `true`.
|
1667
1667
|
*/
|
1668
|
-
|
1668
|
+
enabled?: boolean;
|
1669
1669
|
/**
|
1670
|
-
*
|
1671
|
-
*
|
1672
|
-
* @default 0
|
1670
|
+
* Set to `false` to disable HTML encoding in highlight snippets. By default it is `true`.
|
1673
1671
|
*/
|
1674
|
-
|
1672
|
+
encodeHTML?: boolean;
|
1675
1673
|
};
|
1676
1674
|
/**
|
1677
1675
|
* Pagination settings for the search endpoints.
|
@@ -1693,218 +1691,232 @@ type SearchPageConfig = {
|
|
1693
1691
|
offset?: number;
|
1694
1692
|
};
|
1695
1693
|
/**
|
1696
|
-
*
|
1697
|
-
*
|
1698
|
-
*
|
1699
|
-
|
1700
|
-
|
1701
|
-
|
1702
|
-
*
|
1703
|
-
|
1704
|
-
|
1705
|
-
|
1706
|
-
|
1707
|
-
|
1708
|
-
|
1709
|
-
|
1710
|
-
|
1711
|
-
|
1712
|
-
|
1713
|
-
|
1714
|
-
|
1715
|
-
|
1716
|
-
|
1717
|
-
|
1718
|
-
|
1719
|
-
|
1720
|
-
|
1721
|
-
|
1722
|
-
|
1723
|
-
|
1724
|
-
|
1725
|
-
|
1726
|
-
|
1727
|
-
|
1728
|
-
* Encoding/Decoding errors
|
1729
|
-
*/
|
1730
|
-
warnings?: string[];
|
1731
|
-
};
|
1732
|
-
};
|
1733
|
-
/**
|
1734
|
-
* @pattern [a-zA-Z0-9_-~:]+
|
1735
|
-
*/
|
1736
|
-
type RecordID = string;
|
1737
|
-
/**
|
1738
|
-
* @example {"newName":"newName","oldName":"oldName"}
|
1739
|
-
*/
|
1740
|
-
type TableRename = {
|
1741
|
-
/**
|
1742
|
-
* @minLength 1
|
1743
|
-
*/
|
1744
|
-
newName: string;
|
1745
|
-
/**
|
1746
|
-
* @minLength 1
|
1747
|
-
*/
|
1748
|
-
oldName: string;
|
1749
|
-
};
|
1750
|
-
/**
|
1751
|
-
* Records metadata
|
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
|
1752
1726
|
*/
|
1753
|
-
type
|
1754
|
-
page: {
|
1755
|
-
/**
|
1756
|
-
* last record id
|
1757
|
-
*/
|
1758
|
-
cursor: string;
|
1759
|
-
/**
|
1760
|
-
* true if more records can be fetch
|
1761
|
-
*/
|
1762
|
-
more: boolean;
|
1763
|
-
};
|
1764
|
-
};
|
1765
|
-
type AggResponse$1 = (number | null) | {
|
1766
|
-
values: ({
|
1767
|
-
$key: string | number;
|
1768
|
-
$count: number;
|
1769
|
-
} & {
|
1770
|
-
[key: string]: AggResponse$1;
|
1771
|
-
})[];
|
1772
|
-
};
|
1727
|
+
type SummaryExpression = Record<string, any>;
|
1773
1728
|
/**
|
1774
|
-
*
|
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
|
1775
1743
|
*/
|
1776
|
-
type
|
1777
|
-
|
1778
|
-
} | {
|
1779
|
-
update: TransactionUpdateOp;
|
1780
|
-
} | {
|
1781
|
-
['delete']: TransactionDeleteOp;
|
1744
|
+
type SummaryExpressionList = {
|
1745
|
+
[key: string]: SummaryExpression;
|
1782
1746
|
};
|
1783
1747
|
/**
|
1784
|
-
*
|
1748
|
+
* Count the number of records with an optional filter.
|
1785
1749
|
*/
|
1786
|
-
type
|
1787
|
-
|
1788
|
-
|
1789
|
-
*/
|
1790
|
-
table: string;
|
1791
|
-
/**
|
1792
|
-
* The record to insert. The `id` field is optional; when specified, it will be used as the ID for the record.
|
1793
|
-
*/
|
1794
|
-
record: {
|
1795
|
-
[key: string]: any;
|
1796
|
-
};
|
1797
|
-
/**
|
1798
|
-
* The version of the record you expect to be overwriting. Only valid with an
|
1799
|
-
* explicit ID is also set in the `record` key.
|
1800
|
-
*/
|
1801
|
-
ifVersion?: number;
|
1802
|
-
/**
|
1803
|
-
* createOnly is used to change how Xata acts when an explicit ID is set in the `record` key.
|
1804
|
-
*
|
1805
|
-
* If `createOnly` is set to `true`, Xata will only attempt to insert the record. If there's a conflict, Xata
|
1806
|
-
* will cancel the transaction.
|
1807
|
-
*
|
1808
|
-
* If `createOnly` is set to `false`, Xata will attempt to insert the record. If there's no
|
1809
|
-
* conflict, the record is inserted. If there is a conflict, Xata will replace the record.
|
1810
|
-
*/
|
1811
|
-
createOnly?: boolean;
|
1812
|
-
};
|
1750
|
+
type CountAgg = {
|
1751
|
+
filter?: FilterExpression;
|
1752
|
+
} | '*';
|
1813
1753
|
/**
|
1814
|
-
*
|
1754
|
+
* The sum of the numeric values in a particular column.
|
1815
1755
|
*/
|
1816
|
-
type
|
1817
|
-
/**
|
1818
|
-
* The table name
|
1819
|
-
*/
|
1820
|
-
table: string;
|
1821
|
-
id: RecordID;
|
1756
|
+
type SumAgg = {
|
1822
1757
|
/**
|
1823
|
-
* The
|
1758
|
+
* The column on which to compute the sum. Must be a numeric type.
|
1824
1759
|
*/
|
1825
|
-
|
1826
|
-
|
1827
|
-
|
1760
|
+
column: string;
|
1761
|
+
};
|
1762
|
+
/**
|
1763
|
+
* The max of the numeric values in a particular column.
|
1764
|
+
*/
|
1765
|
+
type MaxAgg = {
|
1828
1766
|
/**
|
1829
|
-
* The
|
1767
|
+
* The column on which to compute the max. Must be a numeric type.
|
1830
1768
|
*/
|
1831
|
-
|
1769
|
+
column: string;
|
1770
|
+
};
|
1771
|
+
/**
|
1772
|
+
* The min of the numeric values in a particular column.
|
1773
|
+
*/
|
1774
|
+
type MinAgg = {
|
1832
1775
|
/**
|
1833
|
-
*
|
1776
|
+
* The column on which to compute the min. Must be a numeric type.
|
1834
1777
|
*/
|
1835
|
-
|
1778
|
+
column: string;
|
1836
1779
|
};
|
1837
1780
|
/**
|
1838
|
-
*
|
1781
|
+
* The average of the numeric values in a particular column.
|
1839
1782
|
*/
|
1840
|
-
type
|
1783
|
+
type AverageAgg = {
|
1841
1784
|
/**
|
1842
|
-
* The
|
1785
|
+
* The column on which to compute the average. Must be a numeric type.
|
1843
1786
|
*/
|
1844
|
-
|
1845
|
-
id: RecordID;
|
1787
|
+
column: string;
|
1846
1788
|
};
|
1847
1789
|
/**
|
1848
|
-
*
|
1790
|
+
* Count the number of distinct values in a particular column.
|
1849
1791
|
*/
|
1850
|
-
type
|
1792
|
+
type UniqueCountAgg = {
|
1851
1793
|
/**
|
1852
|
-
* The
|
1794
|
+
* The column from where to count the unique values.
|
1853
1795
|
*/
|
1854
|
-
|
1796
|
+
column: string;
|
1855
1797
|
/**
|
1856
|
-
* The number of
|
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.
|
1857
1801
|
*/
|
1858
|
-
|
1859
|
-
id: RecordID;
|
1802
|
+
precisionThreshold?: number;
|
1860
1803
|
};
|
1861
1804
|
/**
|
1862
|
-
*
|
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"}}}}}}
|
1863
1808
|
*/
|
1864
|
-
type
|
1809
|
+
type AggExpressionMap = {
|
1810
|
+
[key: string]: AggExpression;
|
1811
|
+
};
|
1812
|
+
/**
|
1813
|
+
* Split data into buckets by a datetime column. Accepts sub-aggregations for each bucket.
|
1814
|
+
*/
|
1815
|
+
type DateHistogramAgg = {
|
1865
1816
|
/**
|
1866
|
-
* The
|
1817
|
+
* The column to use for bucketing. Must be of type datetime.
|
1867
1818
|
*/
|
1868
|
-
|
1819
|
+
column: string;
|
1869
1820
|
/**
|
1870
|
-
* 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)$
|
1871
1825
|
*/
|
1872
|
-
|
1873
|
-
|
1826
|
+
interval?: string;
|
1827
|
+
/**
|
1828
|
+
* The calendar-aware interval to use when bucketing. Possible values are: `minute`,
|
1829
|
+
* `hour`, `day`, `week`, `month`, `quarter`, `year`.
|
1830
|
+
*/
|
1831
|
+
calendarInterval?: 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year';
|
1832
|
+
/**
|
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$
|
1838
|
+
*/
|
1839
|
+
timezone?: string;
|
1840
|
+
aggs?: AggExpressionMap;
|
1874
1841
|
};
|
1875
1842
|
/**
|
1876
|
-
*
|
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.
|
1877
1845
|
*/
|
1878
|
-
type
|
1846
|
+
type TopValuesAgg = {
|
1879
1847
|
/**
|
1880
|
-
* The
|
1848
|
+
* The column to use for bucketing. Accepted types are `string`, `email`, `int`, `float`, or `bool`.
|
1881
1849
|
*/
|
1882
|
-
|
1850
|
+
column: string;
|
1851
|
+
aggs?: AggExpressionMap;
|
1883
1852
|
/**
|
1884
|
-
* The number of
|
1853
|
+
* The maximum number of unique values to return.
|
1854
|
+
*
|
1855
|
+
* @default 10
|
1856
|
+
* @maximum 1000
|
1885
1857
|
*/
|
1886
|
-
|
1858
|
+
size?: number;
|
1887
1859
|
};
|
1888
1860
|
/**
|
1889
|
-
*
|
1890
|
-
*
|
1891
|
-
* @x-go-type xata.ErrTxOp
|
1861
|
+
* Split data into buckets by dynamic numeric ranges. Accepts sub-aggregations for each bucket.
|
1892
1862
|
*/
|
1893
|
-
type
|
1863
|
+
type NumericHistogramAgg = {
|
1894
1864
|
/**
|
1895
|
-
* The
|
1865
|
+
* The column to use for bucketing. Must be of numeric type.
|
1896
1866
|
*/
|
1897
|
-
|
1867
|
+
column: string;
|
1898
1868
|
/**
|
1899
|
-
* 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
|
1900
1873
|
*/
|
1901
|
-
|
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;
|
1902
1885
|
};
|
1903
1886
|
/**
|
1904
|
-
*
|
1905
|
-
*
|
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
|
1906
1892
|
*/
|
1907
|
-
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
|
+
};
|
1908
1920
|
/**
|
1909
1921
|
* Xata Table Record Metadata
|
1910
1922
|
*/
|
@@ -1918,26 +1930,33 @@ type XataRecord$1 = RecordMeta & {
|
|
1918
1930
|
* @version 1.0
|
1919
1931
|
*/
|
1920
1932
|
|
1921
|
-
type
|
1933
|
+
type BadRequestError = {
|
1922
1934
|
id?: string;
|
1923
1935
|
message: string;
|
1924
1936
|
};
|
1925
|
-
|
1926
|
-
|
1927
|
-
|
1928
|
-
|
1929
|
-
|
1937
|
+
/**
|
1938
|
+
* @example {"message":"invalid API key"}
|
1939
|
+
*/
|
1940
|
+
type AuthError = {
|
1941
|
+
id?: string;
|
1942
|
+
message: string;
|
1930
1943
|
};
|
1931
|
-
type
|
1932
|
-
|
1933
|
-
|
1934
|
-
records: XataRecord$1[];
|
1944
|
+
type SimpleError = {
|
1945
|
+
id?: string;
|
1946
|
+
message: string;
|
1935
1947
|
};
|
1936
1948
|
type BranchMigrationPlan = {
|
1937
1949
|
version: number;
|
1938
1950
|
migration: BranchMigration;
|
1939
1951
|
};
|
1940
|
-
type
|
1952
|
+
type SchemaUpdateResponse = {
|
1953
|
+
/**
|
1954
|
+
* @minLength 1
|
1955
|
+
*/
|
1956
|
+
migrationID: string;
|
1957
|
+
parentMigrationID: string;
|
1958
|
+
status: MigrationStatus;
|
1959
|
+
};
|
1941
1960
|
type SchemaCompareResponse = {
|
1942
1961
|
source: Schema;
|
1943
1962
|
target: Schema;
|
@@ -1949,61 +1968,36 @@ type RecordUpdateResponse = XataRecord$1 | {
|
|
1949
1968
|
version: number;
|
1950
1969
|
};
|
1951
1970
|
};
|
1952
|
-
type
|
1971
|
+
type RecordResponse = XataRecord$1;
|
1972
|
+
type BulkInsertResponse = {
|
1973
|
+
recordIDs: string[];
|
1974
|
+
} | {
|
1953
1975
|
records: XataRecord$1[];
|
1954
|
-
meta: RecordsMetadata;
|
1955
|
-
};
|
1956
|
-
type SchemaUpdateResponse = {
|
1957
|
-
/**
|
1958
|
-
* @minLength 1
|
1959
|
-
*/
|
1960
|
-
migrationID: string;
|
1961
|
-
parentMigrationID: string;
|
1962
|
-
status: MigrationStatus;
|
1963
1976
|
};
|
1964
|
-
type
|
1965
|
-
|
1977
|
+
type BulkError = {
|
1978
|
+
errors: {
|
1979
|
+
message?: string;
|
1980
|
+
status?: number;
|
1981
|
+
}[];
|
1966
1982
|
};
|
1967
|
-
|
1968
|
-
|
1969
|
-
|
1970
|
-
type AggResponse = {
|
1971
|
-
aggs?: {
|
1972
|
-
[key: string]: AggResponse$1;
|
1973
|
-
};
|
1983
|
+
type QueryResponse = {
|
1984
|
+
records: XataRecord$1[];
|
1985
|
+
meta: RecordsMetadata;
|
1974
1986
|
};
|
1975
1987
|
type SearchResponse = {
|
1976
1988
|
records: XataRecord$1[];
|
1977
1989
|
warning?: string;
|
1978
1990
|
};
|
1979
|
-
|
1980
|
-
|
1981
|
-
*/
|
1982
|
-
type TransactionSuccess = {
|
1983
|
-
/**
|
1984
|
-
* An ordered array of results from the submitted operations that were executed
|
1985
|
-
*/
|
1986
|
-
results: (TransactionResultInsert | TransactionResultUpdate | TransactionResultDelete)[];
|
1987
|
-
};
|
1988
|
-
/**
|
1989
|
-
* @x-go-type TxFailure
|
1990
|
-
*/
|
1991
|
-
type TransactionFailure = {
|
1992
|
-
/**
|
1993
|
-
* An array of errors from the submitted operations.
|
1994
|
-
*/
|
1995
|
-
errors: TransactionError[];
|
1996
|
-
};
|
1997
|
-
type BadRequestError = {
|
1998
|
-
id?: string;
|
1999
|
-
message: string;
|
1991
|
+
type SummarizeResponse = {
|
1992
|
+
summaries: Record<string, any>[];
|
2000
1993
|
};
|
2001
1994
|
/**
|
2002
|
-
* @example {"
|
2003
|
-
*/
|
2004
|
-
type
|
2005
|
-
|
2006
|
-
|
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}]}}}
|
1996
|
+
*/
|
1997
|
+
type AggResponse = {
|
1998
|
+
aggs?: {
|
1999
|
+
[key: string]: AggResponse$1;
|
2000
|
+
};
|
2007
2001
|
};
|
2008
2002
|
|
2009
2003
|
type DataPlaneFetcherExtraProps = {
|
@@ -2028,24 +2022,6 @@ type ErrorWrapper<TError> = TError | {
|
|
2028
2022
|
* @version 1.0
|
2029
2023
|
*/
|
2030
2024
|
|
2031
|
-
type DEPRECATEDgetDatabaseListPathParams = {
|
2032
|
-
workspace: string;
|
2033
|
-
region: string;
|
2034
|
-
};
|
2035
|
-
type DEPRECATEDgetDatabaseListError = ErrorWrapper<{
|
2036
|
-
status: 400;
|
2037
|
-
payload: BadRequestError;
|
2038
|
-
} | {
|
2039
|
-
status: 401;
|
2040
|
-
payload: AuthError;
|
2041
|
-
}>;
|
2042
|
-
type DEPRECATEDgetDatabaseListVariables = {
|
2043
|
-
pathParams: DEPRECATEDgetDatabaseListPathParams;
|
2044
|
-
} & DataPlaneFetcherExtraProps;
|
2045
|
-
/**
|
2046
|
-
* List all databases available in your Workspace.
|
2047
|
-
*/
|
2048
|
-
declare const dEPRECATEDgetDatabaseList: (variables: DEPRECATEDgetDatabaseListVariables, signal?: AbortSignal) => Promise<DEPRECATEDListDatabasesResponse>;
|
2049
2025
|
type GetBranchListPathParams = {
|
2050
2026
|
/**
|
2051
2027
|
* The Database Name
|
@@ -2071,134 +2047,6 @@ type GetBranchListVariables = {
|
|
2071
2047
|
* List all available Branches
|
2072
2048
|
*/
|
2073
2049
|
declare const getBranchList: (variables: GetBranchListVariables, signal?: AbortSignal) => Promise<ListBranchesResponse>;
|
2074
|
-
type DEPRECATEDcreateDatabasePathParams = {
|
2075
|
-
/**
|
2076
|
-
* The Database Name
|
2077
|
-
*/
|
2078
|
-
dbName: DBName;
|
2079
|
-
workspace: string;
|
2080
|
-
region: string;
|
2081
|
-
};
|
2082
|
-
type DEPRECATEDcreateDatabaseError = ErrorWrapper<{
|
2083
|
-
status: 400;
|
2084
|
-
payload: BadRequestError;
|
2085
|
-
} | {
|
2086
|
-
status: 401;
|
2087
|
-
payload: AuthError;
|
2088
|
-
}>;
|
2089
|
-
type DEPRECATEDcreateDatabaseResponse = {
|
2090
|
-
/**
|
2091
|
-
* @minLength 1
|
2092
|
-
*/
|
2093
|
-
databaseName: string;
|
2094
|
-
branchName?: string;
|
2095
|
-
status: MigrationStatus;
|
2096
|
-
};
|
2097
|
-
type DEPRECATEDcreateDatabaseRequestBody = {
|
2098
|
-
/**
|
2099
|
-
* @minLength 1
|
2100
|
-
*/
|
2101
|
-
branchName?: string;
|
2102
|
-
ui?: {
|
2103
|
-
color?: string;
|
2104
|
-
};
|
2105
|
-
metadata?: BranchMetadata;
|
2106
|
-
};
|
2107
|
-
type DEPRECATEDcreateDatabaseVariables = {
|
2108
|
-
body?: DEPRECATEDcreateDatabaseRequestBody;
|
2109
|
-
pathParams: DEPRECATEDcreateDatabasePathParams;
|
2110
|
-
} & DataPlaneFetcherExtraProps;
|
2111
|
-
/**
|
2112
|
-
* Create Database with identifier name
|
2113
|
-
*/
|
2114
|
-
declare const dEPRECATEDcreateDatabase: (variables: DEPRECATEDcreateDatabaseVariables, signal?: AbortSignal) => Promise<DEPRECATEDcreateDatabaseResponse>;
|
2115
|
-
type DEPRECATEDdeleteDatabasePathParams = {
|
2116
|
-
/**
|
2117
|
-
* The Database Name
|
2118
|
-
*/
|
2119
|
-
dbName: DBName;
|
2120
|
-
workspace: string;
|
2121
|
-
region: string;
|
2122
|
-
};
|
2123
|
-
type DEPRECATEDdeleteDatabaseError = ErrorWrapper<{
|
2124
|
-
status: 400;
|
2125
|
-
payload: BadRequestError;
|
2126
|
-
} | {
|
2127
|
-
status: 401;
|
2128
|
-
payload: AuthError;
|
2129
|
-
} | {
|
2130
|
-
status: 404;
|
2131
|
-
payload: SimpleError;
|
2132
|
-
}>;
|
2133
|
-
type DEPRECATEDdeleteDatabaseResponse = {
|
2134
|
-
status: MigrationStatus;
|
2135
|
-
};
|
2136
|
-
type DEPRECATEDdeleteDatabaseVariables = {
|
2137
|
-
pathParams: DEPRECATEDdeleteDatabasePathParams;
|
2138
|
-
} & DataPlaneFetcherExtraProps;
|
2139
|
-
/**
|
2140
|
-
* Delete a database and all of its branches and tables permanently.
|
2141
|
-
*/
|
2142
|
-
declare const dEPRECATEDdeleteDatabase: (variables: DEPRECATEDdeleteDatabaseVariables, signal?: AbortSignal) => Promise<DEPRECATEDdeleteDatabaseResponse>;
|
2143
|
-
type DEPRECATEDgetDatabaseMetadataPathParams = {
|
2144
|
-
/**
|
2145
|
-
* The Database Name
|
2146
|
-
*/
|
2147
|
-
dbName: DBName;
|
2148
|
-
workspace: string;
|
2149
|
-
region: string;
|
2150
|
-
};
|
2151
|
-
type DEPRECATEDgetDatabaseMetadataError = ErrorWrapper<{
|
2152
|
-
status: 400;
|
2153
|
-
payload: BadRequestError;
|
2154
|
-
} | {
|
2155
|
-
status: 401;
|
2156
|
-
payload: AuthError;
|
2157
|
-
} | {
|
2158
|
-
status: 404;
|
2159
|
-
payload: SimpleError;
|
2160
|
-
}>;
|
2161
|
-
type DEPRECATEDgetDatabaseMetadataVariables = {
|
2162
|
-
pathParams: DEPRECATEDgetDatabaseMetadataPathParams;
|
2163
|
-
} & DataPlaneFetcherExtraProps;
|
2164
|
-
/**
|
2165
|
-
* Retrieve metadata of the given database
|
2166
|
-
*/
|
2167
|
-
declare const dEPRECATEDgetDatabaseMetadata: (variables: DEPRECATEDgetDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DEPRECATEDDatabaseMetadata>;
|
2168
|
-
type DEPRECATEDupdateDatabaseMetadataPathParams = {
|
2169
|
-
/**
|
2170
|
-
* The Database Name
|
2171
|
-
*/
|
2172
|
-
dbName: DBName;
|
2173
|
-
workspace: string;
|
2174
|
-
region: string;
|
2175
|
-
};
|
2176
|
-
type DEPRECATEDupdateDatabaseMetadataError = ErrorWrapper<{
|
2177
|
-
status: 400;
|
2178
|
-
payload: BadRequestError;
|
2179
|
-
} | {
|
2180
|
-
status: 401;
|
2181
|
-
payload: AuthError;
|
2182
|
-
} | {
|
2183
|
-
status: 404;
|
2184
|
-
payload: SimpleError;
|
2185
|
-
}>;
|
2186
|
-
type DEPRECATEDupdateDatabaseMetadataRequestBody = {
|
2187
|
-
ui?: {
|
2188
|
-
/**
|
2189
|
-
* @minLength 1
|
2190
|
-
*/
|
2191
|
-
color?: string;
|
2192
|
-
};
|
2193
|
-
};
|
2194
|
-
type DEPRECATEDupdateDatabaseMetadataVariables = {
|
2195
|
-
body?: DEPRECATEDupdateDatabaseMetadataRequestBody;
|
2196
|
-
pathParams: DEPRECATEDupdateDatabaseMetadataPathParams;
|
2197
|
-
} & DataPlaneFetcherExtraProps;
|
2198
|
-
/**
|
2199
|
-
* Update the color of the selected database
|
2200
|
-
*/
|
2201
|
-
declare const dEPRECATEDupdateDatabaseMetadata: (variables: DEPRECATEDupdateDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DEPRECATEDDatabaseMetadata>;
|
2202
2050
|
type GetBranchDetailsPathParams = {
|
2203
2051
|
/**
|
2204
2052
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2244,6 +2092,9 @@ type CreateBranchError = ErrorWrapper<{
|
|
2244
2092
|
} | {
|
2245
2093
|
status: 404;
|
2246
2094
|
payload: SimpleError;
|
2095
|
+
} | {
|
2096
|
+
status: 423;
|
2097
|
+
payload: SimpleError;
|
2247
2098
|
}>;
|
2248
2099
|
type CreateBranchResponse = {
|
2249
2100
|
/**
|
@@ -2283,6 +2134,9 @@ type DeleteBranchError = ErrorWrapper<{
|
|
2283
2134
|
} | {
|
2284
2135
|
status: 404;
|
2285
2136
|
payload: SimpleError;
|
2137
|
+
} | {
|
2138
|
+
status: 409;
|
2139
|
+
payload: SimpleError;
|
2286
2140
|
}>;
|
2287
2141
|
type DeleteBranchResponse = {
|
2288
2142
|
status: MigrationStatus;
|
@@ -2656,32 +2510,6 @@ type ExecuteBranchMigrationPlanVariables = {
|
|
2656
2510
|
* Apply a migration plan to the branch
|
2657
2511
|
*/
|
2658
2512
|
declare const executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
2659
|
-
type BranchTransactionPathParams = {
|
2660
|
-
/**
|
2661
|
-
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2662
|
-
*/
|
2663
|
-
dbBranchName: DBBranchName;
|
2664
|
-
workspace: string;
|
2665
|
-
region: string;
|
2666
|
-
};
|
2667
|
-
type BranchTransactionError = ErrorWrapper<{
|
2668
|
-
status: 400;
|
2669
|
-
payload: TransactionFailure;
|
2670
|
-
} | {
|
2671
|
-
status: 401;
|
2672
|
-
payload: AuthError;
|
2673
|
-
} | {
|
2674
|
-
status: 404;
|
2675
|
-
payload: SimpleError;
|
2676
|
-
}>;
|
2677
|
-
type BranchTransactionRequestBody = {
|
2678
|
-
operations: TransactionOperation$1[];
|
2679
|
-
};
|
2680
|
-
type BranchTransactionVariables = {
|
2681
|
-
body: BranchTransactionRequestBody;
|
2682
|
-
pathParams: BranchTransactionPathParams;
|
2683
|
-
} & DataPlaneFetcherExtraProps;
|
2684
|
-
declare const branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal) => Promise<TransactionSuccess>;
|
2685
2513
|
type QueryMigrationRequestsPathParams = {
|
2686
2514
|
/**
|
2687
2515
|
* The Database Name
|
@@ -3241,6 +3069,9 @@ type UpdateTableError = ErrorWrapper<{
|
|
3241
3069
|
} | {
|
3242
3070
|
status: 404;
|
3243
3071
|
payload: SimpleError;
|
3072
|
+
} | {
|
3073
|
+
status: 422;
|
3074
|
+
payload: SimpleError;
|
3244
3075
|
}>;
|
3245
3076
|
type UpdateTableRequestBody = {
|
3246
3077
|
/**
|
@@ -3499,6 +3330,32 @@ type DeleteColumnVariables = {
|
|
3499
3330
|
* Deletes the specified column. To refer to sub-objects, the column name can contain dots. For example `address.country`.
|
3500
3331
|
*/
|
3501
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>;
|
3502
3359
|
type InsertRecordPathParams = {
|
3503
3360
|
/**
|
3504
3361
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -4861,13 +4718,6 @@ declare const operationsByTag: {
|
|
4861
4718
|
deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
|
4862
4719
|
bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal | undefined) => Promise<BulkInsertResponse>;
|
4863
4720
|
};
|
4864
|
-
database: {
|
4865
|
-
dEPRECATEDgetDatabaseList: (variables: DEPRECATEDgetDatabaseListVariables, signal?: AbortSignal | undefined) => Promise<DEPRECATEDListDatabasesResponse>;
|
4866
|
-
dEPRECATEDcreateDatabase: (variables: DEPRECATEDcreateDatabaseVariables, signal?: AbortSignal | undefined) => Promise<DEPRECATEDcreateDatabaseResponse>;
|
4867
|
-
dEPRECATEDdeleteDatabase: (variables: DEPRECATEDdeleteDatabaseVariables, signal?: AbortSignal | undefined) => Promise<DEPRECATEDdeleteDatabaseResponse>;
|
4868
|
-
dEPRECATEDgetDatabaseMetadata: (variables: DEPRECATEDgetDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DEPRECATEDDatabaseMetadata>;
|
4869
|
-
dEPRECATEDupdateDatabaseMetadata: (variables: DEPRECATEDupdateDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DEPRECATEDDatabaseMetadata>;
|
4870
|
-
};
|
4871
4721
|
migrations: {
|
4872
4722
|
getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal | undefined) => Promise<GetBranchMigrationHistoryResponse>;
|
4873
4723
|
getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables, signal?: AbortSignal | undefined) => Promise<BranchMigrationPlan>;
|
@@ -4960,249 +4810,245 @@ declare function parseWorkspacesUrlParts(url: string): {
|
|
4960
4810
|
region: string;
|
4961
4811
|
} | null;
|
4962
4812
|
|
4813
|
+
type responses_AggResponse = AggResponse;
|
4963
4814
|
type responses_AuthError = AuthError;
|
4964
4815
|
type responses_BadRequestError = BadRequestError;
|
4965
|
-
type
|
4816
|
+
type responses_BranchMigrationPlan = BranchMigrationPlan;
|
4966
4817
|
type responses_BulkError = BulkError;
|
4967
4818
|
type responses_BulkInsertResponse = BulkInsertResponse;
|
4968
|
-
type
|
4819
|
+
type responses_QueryResponse = QueryResponse;
|
4969
4820
|
type responses_RecordResponse = RecordResponse;
|
4970
|
-
type responses_SchemaCompareResponse = SchemaCompareResponse;
|
4971
4821
|
type responses_RecordUpdateResponse = RecordUpdateResponse;
|
4972
|
-
type
|
4822
|
+
type responses_SchemaCompareResponse = SchemaCompareResponse;
|
4973
4823
|
type responses_SchemaUpdateResponse = SchemaUpdateResponse;
|
4974
|
-
type responses_SummarizeResponse = SummarizeResponse;
|
4975
|
-
type responses_AggResponse = AggResponse;
|
4976
4824
|
type responses_SearchResponse = SearchResponse;
|
4977
|
-
type
|
4978
|
-
type
|
4825
|
+
type responses_SimpleError = SimpleError;
|
4826
|
+
type responses_SummarizeResponse = SummarizeResponse;
|
4979
4827
|
declare namespace responses {
|
4980
4828
|
export {
|
4829
|
+
responses_AggResponse as AggResponse,
|
4981
4830
|
responses_AuthError as AuthError,
|
4982
4831
|
responses_BadRequestError as BadRequestError,
|
4983
|
-
|
4832
|
+
responses_BranchMigrationPlan as BranchMigrationPlan,
|
4984
4833
|
responses_BulkError as BulkError,
|
4985
4834
|
responses_BulkInsertResponse as BulkInsertResponse,
|
4986
|
-
|
4835
|
+
responses_QueryResponse as QueryResponse,
|
4987
4836
|
responses_RecordResponse as RecordResponse,
|
4988
|
-
responses_SchemaCompareResponse as SchemaCompareResponse,
|
4989
4837
|
responses_RecordUpdateResponse as RecordUpdateResponse,
|
4990
|
-
|
4838
|
+
responses_SchemaCompareResponse as SchemaCompareResponse,
|
4991
4839
|
responses_SchemaUpdateResponse as SchemaUpdateResponse,
|
4992
|
-
responses_SummarizeResponse as SummarizeResponse,
|
4993
|
-
responses_AggResponse as AggResponse,
|
4994
4840
|
responses_SearchResponse as SearchResponse,
|
4995
|
-
|
4996
|
-
|
4841
|
+
responses_SimpleError as SimpleError,
|
4842
|
+
responses_SummarizeResponse as SummarizeResponse,
|
4997
4843
|
};
|
4998
4844
|
}
|
4999
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;
|
5000
4852
|
type schemas_BranchMetadata = BranchMetadata;
|
4853
|
+
type schemas_BranchMigration = BranchMigration;
|
5001
4854
|
type schemas_BranchName = BranchName;
|
5002
|
-
type schemas_DBName = DBName;
|
5003
|
-
type schemas_DateTime = DateTime;
|
5004
|
-
type schemas_MigrationStatus = MigrationStatus;
|
5005
|
-
type schemas_DEPRECATEDDatabaseMetadata = DEPRECATEDDatabaseMetadata;
|
5006
|
-
type schemas_DEPRECATEDListDatabasesResponse = DEPRECATEDListDatabasesResponse;
|
5007
|
-
type schemas_ListBranchesResponse = ListBranchesResponse;
|
5008
|
-
type schemas_ListGitBranchesResponse = ListGitBranchesResponse;
|
5009
|
-
type schemas_Branch = Branch;
|
5010
|
-
type schemas_DBBranch = DBBranch;
|
5011
|
-
type schemas_StartedFromMetadata = StartedFromMetadata;
|
5012
|
-
type schemas_Schema = Schema;
|
5013
|
-
type schemas_SchemaEditScript = SchemaEditScript;
|
5014
|
-
type schemas_Table = Table;
|
5015
4855
|
type schemas_Column = Column;
|
5016
|
-
type schemas_ColumnLink = ColumnLink;
|
5017
|
-
type
|
5018
|
-
type
|
5019
|
-
type
|
5020
|
-
type
|
5021
|
-
type
|
5022
|
-
type
|
5023
|
-
type
|
5024
|
-
type schemas_TableMigration = TableMigration;
|
5025
|
-
type schemas_ColumnMigration = ColumnMigration;
|
5026
|
-
type schemas_Commit = Commit;
|
5027
|
-
type schemas_Migration = Migration;
|
5028
|
-
type schemas_MigrationOp = MigrationOp;
|
5029
|
-
type schemas_MigrationTableOp = MigrationTableOp;
|
5030
|
-
type schemas_MigrationColumnOp = MigrationColumnOp;
|
5031
|
-
type schemas_TableOpAdd = TableOpAdd;
|
5032
|
-
type schemas_TableOpRemove = TableOpRemove;
|
5033
|
-
type schemas_TableOpRename = TableOpRename;
|
5034
|
-
type schemas_ColumnOpAdd = ColumnOpAdd;
|
5035
|
-
type schemas_ColumnOpRemove = ColumnOpRemove;
|
5036
|
-
type schemas_ColumnOpRename = ColumnOpRename;
|
5037
|
-
type schemas_MigrationRequestNumber = MigrationRequestNumber;
|
5038
|
-
type schemas_MigrationRequest = MigrationRequest;
|
5039
|
-
type schemas_SortExpression = SortExpression;
|
5040
|
-
type schemas_SortOrder = SortOrder;
|
5041
|
-
type schemas_FuzzinessExpression = FuzzinessExpression;
|
5042
|
-
type schemas_PrefixExpression = PrefixExpression;
|
5043
|
-
type schemas_TargetExpression = TargetExpression;
|
5044
|
-
type schemas_FilterExpression = FilterExpression;
|
5045
|
-
type schemas_SummaryExpressionList = SummaryExpressionList;
|
5046
|
-
type schemas_SummaryExpression = SummaryExpression;
|
5047
|
-
type schemas_AggExpressionMap = AggExpressionMap;
|
5048
|
-
type schemas_AggExpression = AggExpression;
|
4856
|
+
type schemas_ColumnLink = ColumnLink;
|
4857
|
+
type schemas_ColumnMigration = ColumnMigration;
|
4858
|
+
type schemas_ColumnName = ColumnName;
|
4859
|
+
type schemas_ColumnOpAdd = ColumnOpAdd;
|
4860
|
+
type schemas_ColumnOpRemove = ColumnOpRemove;
|
4861
|
+
type schemas_ColumnOpRename = ColumnOpRename;
|
4862
|
+
type schemas_ColumnsProjection = ColumnsProjection;
|
4863
|
+
type schemas_Commit = Commit;
|
5049
4864
|
type schemas_CountAgg = CountAgg;
|
5050
|
-
type
|
5051
|
-
type
|
5052
|
-
type
|
5053
|
-
type
|
5054
|
-
type schemas_UniqueCountAgg = UniqueCountAgg;
|
4865
|
+
type schemas_DBBranch = DBBranch;
|
4866
|
+
type schemas_DBBranchName = DBBranchName;
|
4867
|
+
type schemas_DBName = DBName;
|
4868
|
+
type schemas_DatabaseMetadata = DatabaseMetadata;
|
5055
4869
|
type schemas_DateHistogramAgg = DateHistogramAgg;
|
5056
|
-
type
|
5057
|
-
type schemas_NumericHistogramAgg = NumericHistogramAgg;
|
5058
|
-
type schemas_HighlightExpression = HighlightExpression;
|
5059
|
-
type schemas_BoosterExpression = BoosterExpression;
|
5060
|
-
type schemas_FilterList = FilterList;
|
4870
|
+
type schemas_DateTime = DateTime;
|
5061
4871
|
type schemas_FilterColumn = FilterColumn;
|
5062
4872
|
type schemas_FilterColumnIncludes = FilterColumnIncludes;
|
4873
|
+
type schemas_FilterExpression = FilterExpression;
|
4874
|
+
type schemas_FilterList = FilterList;
|
5063
4875
|
type schemas_FilterPredicate = FilterPredicate;
|
5064
4876
|
type schemas_FilterPredicateOp = FilterPredicateOp;
|
5065
4877
|
type schemas_FilterPredicateRangeOp = FilterPredicateRangeOp;
|
5066
4878
|
type schemas_FilterRangeValue = FilterRangeValue;
|
5067
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;
|
5068
4900
|
type schemas_PageConfig = PageConfig;
|
5069
|
-
type
|
5070
|
-
type schemas_ColumnsProjection = ColumnsProjection;
|
5071
|
-
type schemas_RecordMeta = RecordMeta;
|
4901
|
+
type schemas_PrefixExpression = PrefixExpression;
|
5072
4902
|
type schemas_RecordID = RecordID;
|
5073
|
-
type
|
4903
|
+
type schemas_RecordMeta = RecordMeta;
|
5074
4904
|
type schemas_RecordsMetadata = RecordsMetadata;
|
5075
|
-
type
|
5076
|
-
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;
|
5077
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;
|
5078
4931
|
type schemas_TransactionResultInsert = TransactionResultInsert;
|
5079
4932
|
type schemas_TransactionResultUpdate = TransactionResultUpdate;
|
5080
|
-
type
|
5081
|
-
type
|
4933
|
+
type schemas_TransactionSuccess = TransactionSuccess;
|
4934
|
+
type schemas_TransactionUpdateOp = TransactionUpdateOp;
|
4935
|
+
type schemas_UniqueCountAgg = UniqueCountAgg;
|
5082
4936
|
type schemas_User = User;
|
5083
4937
|
type schemas_UserID = UserID;
|
5084
4938
|
type schemas_UserWithID = UserWithID;
|
5085
|
-
type schemas_APIKeyName = APIKeyName;
|
5086
|
-
type schemas_WorkspaceID = WorkspaceID;
|
5087
|
-
type schemas_Role = Role;
|
5088
|
-
type schemas_WorkspaceMeta = WorkspaceMeta;
|
5089
4939
|
type schemas_Workspace = Workspace;
|
5090
|
-
type
|
5091
|
-
type schemas_InviteID = InviteID;
|
4940
|
+
type schemas_WorkspaceID = WorkspaceID;
|
5092
4941
|
type schemas_WorkspaceInvite = WorkspaceInvite;
|
4942
|
+
type schemas_WorkspaceMember = WorkspaceMember;
|
5093
4943
|
type schemas_WorkspaceMembers = WorkspaceMembers;
|
5094
|
-
type
|
5095
|
-
type schemas_DatabaseMetadata = DatabaseMetadata;
|
5096
|
-
type schemas_ListDatabasesResponse = ListDatabasesResponse;
|
5097
|
-
type schemas_ListRegionsResponse = ListRegionsResponse;
|
5098
|
-
type schemas_Region = Region;
|
4944
|
+
type schemas_WorkspaceMeta = WorkspaceMeta;
|
5099
4945
|
declare namespace schemas {
|
5100
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,
|
5101
4954
|
schemas_BranchMetadata as BranchMetadata,
|
4955
|
+
schemas_BranchMigration as BranchMigration,
|
5102
4956
|
schemas_BranchName as BranchName,
|
5103
|
-
schemas_DBName as DBName,
|
5104
|
-
schemas_DateTime as DateTime,
|
5105
|
-
schemas_MigrationStatus as MigrationStatus,
|
5106
|
-
schemas_DEPRECATEDDatabaseMetadata as DEPRECATEDDatabaseMetadata,
|
5107
|
-
schemas_DEPRECATEDListDatabasesResponse as DEPRECATEDListDatabasesResponse,
|
5108
|
-
schemas_ListBranchesResponse as ListBranchesResponse,
|
5109
|
-
schemas_ListGitBranchesResponse as ListGitBranchesResponse,
|
5110
|
-
schemas_Branch as Branch,
|
5111
|
-
schemas_DBBranch as DBBranch,
|
5112
|
-
schemas_StartedFromMetadata as StartedFromMetadata,
|
5113
|
-
schemas_Schema as Schema,
|
5114
|
-
schemas_SchemaEditScript as SchemaEditScript,
|
5115
|
-
schemas_Table as Table,
|
5116
4957
|
schemas_Column as Column,
|
5117
4958
|
schemas_ColumnLink as ColumnLink,
|
5118
|
-
schemas_RevLink as RevLink,
|
5119
|
-
schemas_DBBranchName as DBBranchName,
|
5120
|
-
schemas_TableName as TableName,
|
5121
|
-
schemas_ColumnName as ColumnName,
|
5122
|
-
schemas_MetricsDatapoint as MetricsDatapoint,
|
5123
|
-
schemas_MetricsLatency as MetricsLatency,
|
5124
|
-
schemas_BranchMigration as BranchMigration,
|
5125
|
-
schemas_TableMigration as TableMigration,
|
5126
4959
|
schemas_ColumnMigration as ColumnMigration,
|
5127
|
-
|
5128
|
-
schemas_Migration as Migration,
|
5129
|
-
schemas_MigrationOp as MigrationOp,
|
5130
|
-
schemas_MigrationTableOp as MigrationTableOp,
|
5131
|
-
schemas_MigrationColumnOp as MigrationColumnOp,
|
5132
|
-
schemas_TableOpAdd as TableOpAdd,
|
5133
|
-
schemas_TableOpRemove as TableOpRemove,
|
5134
|
-
schemas_TableOpRename as TableOpRename,
|
4960
|
+
schemas_ColumnName as ColumnName,
|
5135
4961
|
schemas_ColumnOpAdd as ColumnOpAdd,
|
5136
4962
|
schemas_ColumnOpRemove as ColumnOpRemove,
|
5137
4963
|
schemas_ColumnOpRename as ColumnOpRename,
|
5138
|
-
|
5139
|
-
|
5140
|
-
schemas_SortExpression as SortExpression,
|
5141
|
-
schemas_SortOrder as SortOrder,
|
5142
|
-
schemas_FuzzinessExpression as FuzzinessExpression,
|
5143
|
-
schemas_PrefixExpression as PrefixExpression,
|
5144
|
-
schemas_TargetExpression as TargetExpression,
|
5145
|
-
schemas_FilterExpression as FilterExpression,
|
5146
|
-
schemas_SummaryExpressionList as SummaryExpressionList,
|
5147
|
-
schemas_SummaryExpression as SummaryExpression,
|
5148
|
-
schemas_AggExpressionMap as AggExpressionMap,
|
5149
|
-
schemas_AggExpression as AggExpression,
|
4964
|
+
schemas_ColumnsProjection as ColumnsProjection,
|
4965
|
+
schemas_Commit as Commit,
|
5150
4966
|
schemas_CountAgg as CountAgg,
|
5151
|
-
|
5152
|
-
|
5153
|
-
|
5154
|
-
|
5155
|
-
schemas_UniqueCountAgg as UniqueCountAgg,
|
5156
|
-
schemas_DateHistogramAgg as DateHistogramAgg,
|
5157
|
-
schemas_TopValuesAgg as TopValuesAgg,
|
5158
|
-
schemas_NumericHistogramAgg as NumericHistogramAgg,
|
5159
|
-
schemas_HighlightExpression as HighlightExpression,
|
5160
|
-
schemas_BoosterExpression as BoosterExpression,
|
5161
|
-
ValueBooster$1 as ValueBooster,
|
5162
|
-
NumericBooster$1 as NumericBooster,
|
4967
|
+
schemas_DBBranch as DBBranch,
|
4968
|
+
schemas_DBBranchName as DBBranchName,
|
4969
|
+
schemas_DBName as DBName,
|
4970
|
+
schemas_DatabaseMetadata as DatabaseMetadata,
|
5163
4971
|
DateBooster$1 as DateBooster,
|
5164
|
-
|
4972
|
+
schemas_DateHistogramAgg as DateHistogramAgg,
|
4973
|
+
schemas_DateTime as DateTime,
|
5165
4974
|
schemas_FilterColumn as FilterColumn,
|
5166
4975
|
schemas_FilterColumnIncludes as FilterColumnIncludes,
|
4976
|
+
schemas_FilterExpression as FilterExpression,
|
4977
|
+
schemas_FilterList as FilterList,
|
5167
4978
|
schemas_FilterPredicate as FilterPredicate,
|
5168
4979
|
schemas_FilterPredicateOp as FilterPredicateOp,
|
5169
4980
|
schemas_FilterPredicateRangeOp as FilterPredicateRangeOp,
|
5170
4981
|
schemas_FilterRangeValue as FilterRangeValue,
|
5171
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,
|
5172
5004
|
schemas_PageConfig as PageConfig,
|
5173
|
-
|
5174
|
-
schemas_ColumnsProjection as ColumnsProjection,
|
5175
|
-
schemas_RecordMeta as RecordMeta,
|
5005
|
+
schemas_PrefixExpression as PrefixExpression,
|
5176
5006
|
schemas_RecordID as RecordID,
|
5177
|
-
|
5007
|
+
schemas_RecordMeta as RecordMeta,
|
5178
5008
|
schemas_RecordsMetadata as RecordsMetadata,
|
5179
|
-
|
5180
|
-
|
5181
|
-
|
5182
|
-
|
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,
|
5183
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,
|
5184
5036
|
schemas_TransactionResultInsert as TransactionResultInsert,
|
5185
5037
|
schemas_TransactionResultUpdate as TransactionResultUpdate,
|
5186
|
-
|
5187
|
-
|
5188
|
-
|
5038
|
+
schemas_TransactionSuccess as TransactionSuccess,
|
5039
|
+
schemas_TransactionUpdateOp as TransactionUpdateOp,
|
5040
|
+
schemas_UniqueCountAgg as UniqueCountAgg,
|
5189
5041
|
schemas_User as User,
|
5190
5042
|
schemas_UserID as UserID,
|
5191
5043
|
schemas_UserWithID as UserWithID,
|
5192
|
-
|
5193
|
-
schemas_WorkspaceID as WorkspaceID,
|
5194
|
-
schemas_Role as Role,
|
5195
|
-
schemas_WorkspaceMeta as WorkspaceMeta,
|
5044
|
+
ValueBooster$1 as ValueBooster,
|
5196
5045
|
schemas_Workspace as Workspace,
|
5197
|
-
|
5198
|
-
schemas_InviteID as InviteID,
|
5046
|
+
schemas_WorkspaceID as WorkspaceID,
|
5199
5047
|
schemas_WorkspaceInvite as WorkspaceInvite,
|
5048
|
+
schemas_WorkspaceMember as WorkspaceMember,
|
5200
5049
|
schemas_WorkspaceMembers as WorkspaceMembers,
|
5201
|
-
|
5202
|
-
|
5203
|
-
schemas_ListDatabasesResponse as ListDatabasesResponse,
|
5204
|
-
schemas_ListRegionsResponse as ListRegionsResponse,
|
5205
|
-
schemas_Region as Region,
|
5050
|
+
schemas_WorkspaceMeta as WorkspaceMeta,
|
5051
|
+
XataRecord$1 as XataRecord,
|
5206
5052
|
};
|
5207
5053
|
}
|
5208
5054
|
|
@@ -5777,7 +5623,7 @@ declare class DatabaseApi {
|
|
5777
5623
|
}
|
5778
5624
|
|
5779
5625
|
declare class XataApiPlugin implements XataPlugin {
|
5780
|
-
build(options: XataPluginOptions):
|
5626
|
+
build(options: XataPluginOptions): XataApiClient;
|
5781
5627
|
}
|
5782
5628
|
|
5783
5629
|
type StringKeys<O> = Extract<keyof O, string>;
|
@@ -5826,7 +5672,7 @@ type SelectedPick<O extends XataRecord, Key extends SelectableColumn<O>[]> = Xat
|
|
5826
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> ? {
|
5827
5673
|
V: ValueAtColumn<Item, V>;
|
5828
5674
|
} : never : O[K] : never> : never : never;
|
5829
|
-
type MAX_RECURSION =
|
5675
|
+
type MAX_RECURSION = 2;
|
5830
5676
|
type NestedColumns<O, RecursivePath extends any[]> = RecursivePath['length'] extends MAX_RECURSION ? never : If<IsObject<O>, Values<{
|
5831
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
|
5832
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
|
@@ -5862,6 +5708,14 @@ interface XataRecord<OriginalRecord extends XataRecord<any> = XataRecord<any>> e
|
|
5862
5708
|
* Get metadata of this record.
|
5863
5709
|
*/
|
5864
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;
|
5865
5719
|
/**
|
5866
5720
|
* Retrieves a refreshed copy of the current record from the database.
|
5867
5721
|
* @param columns The columns to retrieve. If not specified, all first level properties are retrieved.
|
@@ -5934,12 +5788,17 @@ type XataRecordMetadata = {
|
|
5934
5788
|
};
|
5935
5789
|
declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
|
5936
5790
|
declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;
|
5791
|
+
type EditableDataFields<T> = T extends XataRecord ? {
|
5792
|
+
id: string;
|
5793
|
+
} | string : NonNullable<T> extends XataRecord ? {
|
5794
|
+
id: string;
|
5795
|
+
} | string | null | undefined : T extends Date ? string | Date : NonNullable<T> extends Date ? string | Date | null | undefined : T;
|
5937
5796
|
type EditableData<O extends XataRecord> = Identifiable & Partial<Omit<{
|
5938
|
-
[K in keyof O]: O[K]
|
5939
|
-
|
5940
|
-
|
5941
|
-
|
5942
|
-
|
5797
|
+
[K in keyof O]: EditableDataFields<O[K]>;
|
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]>;
|
5943
5802
|
}, keyof XataRecord>>;
|
5944
5803
|
|
5945
5804
|
/**
|
@@ -6401,7 +6260,7 @@ type BaseOptions<T extends XataRecord> = {
|
|
6401
6260
|
type CursorQueryOptions = {
|
6402
6261
|
pagination?: CursorNavigationOptions & OffsetNavigationOptions;
|
6403
6262
|
filter?: never;
|
6404
|
-
sort?: never
|
6263
|
+
sort?: never;
|
6405
6264
|
};
|
6406
6265
|
type OffsetQueryOptions<T extends XataRecord> = {
|
6407
6266
|
pagination?: OffsetNavigationOptions;
|
@@ -6472,10 +6331,10 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
6472
6331
|
* })
|
6473
6332
|
* ```
|
6474
6333
|
*
|
6475
|
-
* @param
|
6334
|
+
* @param filter A filter object
|
6476
6335
|
* @returns A new Query object.
|
6477
6336
|
*/
|
6478
|
-
filter(
|
6337
|
+
filter(filter?: Filter<Record>): Query<Record, Result>;
|
6479
6338
|
/**
|
6480
6339
|
* Builds a new query with a new sort option.
|
6481
6340
|
* @param column The column name.
|
@@ -6741,6 +6600,8 @@ declare class RecordArray<Result extends XataRecord> extends Array<Result> {
|
|
6741
6600
|
constructor(page: Paginable<any, Result>, overrideRecords?: Result[]);
|
6742
6601
|
static parseConstructorParams(...args: any[]): any[];
|
6743
6602
|
toArray(): Result[];
|
6603
|
+
toSerializable(): JSONData<Result>[];
|
6604
|
+
toString(): string;
|
6744
6605
|
map<U>(callbackfn: (value: Result, index: number, array: Result[]) => U, thisArg?: any): U[];
|
6745
6606
|
/**
|
6746
6607
|
* Retrieve next page of records
|
@@ -7655,12 +7516,13 @@ declare class TransactionPlugin<Schemas extends Record<string, XataRecord>> exte
|
|
7655
7516
|
}
|
7656
7517
|
|
7657
7518
|
type BranchStrategyValue = string | undefined | null;
|
7658
|
-
type BranchStrategyBuilder = () => BranchStrategyValue
|
7519
|
+
type BranchStrategyBuilder = () => BranchStrategyValue;
|
7659
7520
|
type BranchStrategy = BranchStrategyValue | BranchStrategyBuilder;
|
7660
7521
|
type BranchStrategyOption = NonNullable<BranchStrategy | BranchStrategy[]>;
|
7661
7522
|
|
7662
7523
|
type BaseClientOptions = {
|
7663
7524
|
fetch?: FetchImpl;
|
7525
|
+
host?: HostProvider;
|
7664
7526
|
apiKey?: string;
|
7665
7527
|
databaseURL?: string;
|
7666
7528
|
branch?: BranchStrategyOption;
|
@@ -7694,20 +7556,17 @@ declare class Serializer {
|
|
7694
7556
|
toJSON<T>(data: T): string;
|
7695
7557
|
fromJSON<T>(json: string): T;
|
7696
7558
|
}
|
7697
|
-
|
7698
|
-
|
7699
|
-
|
7559
|
+
type SerializedString<T> = string | (string & {
|
7560
|
+
__type: T;
|
7561
|
+
});
|
7562
|
+
type DeserializedType<T> = T extends SerializedString<infer U> ? U : T;
|
7563
|
+
declare const serialize: <T>(data: T) => SerializedString<T>;
|
7564
|
+
declare const deserialize: <T extends SerializedString<any>>(json: T) => SerializerResult<DeserializedType<T>>;
|
7565
|
+
type SerializerResult<T> = T extends XataRecord ? Identifiable & Omit<{
|
7566
|
+
[K in keyof T]: SerializerResult<T[K]>;
|
7567
|
+
}, keyof XataRecord> : T extends any[] ? SerializerResult<T[number]>[] : T;
|
7700
7568
|
|
7701
|
-
type BranchResolutionOptions = {
|
7702
|
-
databaseURL?: string;
|
7703
|
-
apiKey?: string;
|
7704
|
-
fetchImpl?: FetchImpl;
|
7705
|
-
clientName?: string;
|
7706
|
-
};
|
7707
|
-
declare function getCurrentBranchName(options?: BranchResolutionOptions): Promise<string>;
|
7708
|
-
declare function getCurrentBranchDetails(options?: BranchResolutionOptions): Promise<DBBranch | null>;
|
7709
7569
|
declare function getDatabaseURL(): string | undefined;
|
7710
|
-
|
7711
7570
|
declare function getAPIKey(): string | undefined;
|
7712
7571
|
|
7713
7572
|
interface Body {
|
@@ -7795,4 +7654,4 @@ declare class XataError extends Error {
|
|
7795
7654
|
constructor(message: string, status: number);
|
7796
7655
|
}
|
7797
7656
|
|
7798
|
-
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, DEPRECATEDcreateDatabaseError, DEPRECATEDcreateDatabasePathParams, DEPRECATEDcreateDatabaseRequestBody, DEPRECATEDcreateDatabaseResponse, DEPRECATEDcreateDatabaseVariables, DEPRECATEDdeleteDatabaseError, DEPRECATEDdeleteDatabasePathParams, DEPRECATEDdeleteDatabaseResponse, DEPRECATEDdeleteDatabaseVariables, DEPRECATEDgetDatabaseListError, DEPRECATEDgetDatabaseListPathParams, DEPRECATEDgetDatabaseListVariables, DEPRECATEDgetDatabaseMetadataError, DEPRECATEDgetDatabaseMetadataPathParams, DEPRECATEDgetDatabaseMetadataVariables, DEPRECATEDupdateDatabaseMetadataError, DEPRECATEDupdateDatabaseMetadataPathParams, DEPRECATEDupdateDatabaseMetadataRequestBody, DEPRECATEDupdateDatabaseMetadataVariables, 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, 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, dEPRECATEDcreateDatabase, dEPRECATEDdeleteDatabase, dEPRECATEDgetDatabaseList, dEPRECATEDgetDatabaseMetadata, dEPRECATEDupdateDatabaseMetadata, 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 };
|
7657
|
+
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, 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 };
|