@xata.io/client 0.18.4 → 0.18.6
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/CHANGELOG.md +18 -0
- package/dist/index.cjs +307 -139
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +888 -190
- package/dist/index.mjs +298 -140
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
@@ -7,6 +7,7 @@ declare type FetchImpl = (url: string, init?: {
|
|
7
7
|
body?: string;
|
8
8
|
headers?: Record<string, string>;
|
9
9
|
method?: string;
|
10
|
+
signal?: any;
|
10
11
|
}) => Promise<{
|
11
12
|
ok: boolean;
|
12
13
|
status: number;
|
@@ -23,6 +24,9 @@ declare type FetcherExtraProps = {
|
|
23
24
|
fetchImpl: FetchImpl;
|
24
25
|
apiKey: string;
|
25
26
|
trace: TraceFunction;
|
27
|
+
signal?: AbortSignal;
|
28
|
+
clientID?: string;
|
29
|
+
sessionID?: string;
|
26
30
|
};
|
27
31
|
declare type ErrorWrapper<TError> = TError | {
|
28
32
|
status: 'unknown';
|
@@ -546,6 +550,171 @@ declare type SummaryExpressionList = {
|
|
546
550
|
* @x-go-type xbquery.Summary
|
547
551
|
*/
|
548
552
|
declare type SummaryExpression = Record<string, any>;
|
553
|
+
/**
|
554
|
+
* The description of the aggregations you wish to receive.
|
555
|
+
*
|
556
|
+
* @example {"totalCount":{"count":"*"},"dailyActiveUsers":{"dateHistogram":{"column":"date","interval":"1d"},"aggs":{"uniqueUsers":{"uniqueCount":{"column":"userID"}}}}}
|
557
|
+
*/
|
558
|
+
declare type AggExpressionMap = {
|
559
|
+
[key: string]: AggExpression;
|
560
|
+
};
|
561
|
+
/**
|
562
|
+
* The description of a single aggregation operation. It is an object with only one key-value pair.
|
563
|
+
* The key represents the aggreagtion type, while the value is an object with the configuration of
|
564
|
+
* the aggreagtion.
|
565
|
+
*
|
566
|
+
* @x-go-type xata.AggExpression
|
567
|
+
*/
|
568
|
+
declare type AggExpression = {
|
569
|
+
count?: CountAgg;
|
570
|
+
} | {
|
571
|
+
sum?: SumAgg;
|
572
|
+
} | {
|
573
|
+
max?: MaxAgg;
|
574
|
+
} | {
|
575
|
+
min?: MinAgg;
|
576
|
+
} | {
|
577
|
+
average?: AverageAgg;
|
578
|
+
} | {
|
579
|
+
uniqueCount?: UniqueCountAgg;
|
580
|
+
} | {
|
581
|
+
dateHistogram?: DateHistogramAgg;
|
582
|
+
} | {
|
583
|
+
topValues?: TopValuesAgg;
|
584
|
+
} | {
|
585
|
+
numericHistogram?: NumericHistogramAgg;
|
586
|
+
};
|
587
|
+
/**
|
588
|
+
* Count the number of records with an optional filter.
|
589
|
+
*/
|
590
|
+
declare type CountAgg = {
|
591
|
+
filter?: FilterExpression;
|
592
|
+
} | '*';
|
593
|
+
/**
|
594
|
+
* The sum of the numeric values in a particular column.
|
595
|
+
*/
|
596
|
+
declare type SumAgg = {
|
597
|
+
/**
|
598
|
+
* The column on which to compute the sum. Must be a numeric type.
|
599
|
+
*/
|
600
|
+
column: string;
|
601
|
+
};
|
602
|
+
/**
|
603
|
+
* The max of the numeric values in a particular column.
|
604
|
+
*/
|
605
|
+
declare type MaxAgg = {
|
606
|
+
/**
|
607
|
+
* The column on which to compute the max. Must be a numeric type.
|
608
|
+
*/
|
609
|
+
column: string;
|
610
|
+
};
|
611
|
+
/**
|
612
|
+
* The min of the numeric values in a particular column.
|
613
|
+
*/
|
614
|
+
declare type MinAgg = {
|
615
|
+
/**
|
616
|
+
* The column on which to compute the min. Must be a numeric type.
|
617
|
+
*/
|
618
|
+
column: string;
|
619
|
+
};
|
620
|
+
/**
|
621
|
+
* The average of the numeric values in a particular column.
|
622
|
+
*/
|
623
|
+
declare type AverageAgg = {
|
624
|
+
/**
|
625
|
+
* The column on which to compute the average. Must be a numeric type.
|
626
|
+
*/
|
627
|
+
column: string;
|
628
|
+
};
|
629
|
+
/**
|
630
|
+
* Count the number of distinct values in a particular column.
|
631
|
+
*/
|
632
|
+
declare type UniqueCountAgg = {
|
633
|
+
/**
|
634
|
+
* The column from where to count the unique values.
|
635
|
+
*/
|
636
|
+
column: string;
|
637
|
+
/**
|
638
|
+
* The threshold under which the unique count is exact. If the number of unique
|
639
|
+
* values in the column is higher than this threshold, the results are approximative.
|
640
|
+
* Maximum value is 40,000, default value is 3000.
|
641
|
+
*/
|
642
|
+
precisionThreshold?: number;
|
643
|
+
};
|
644
|
+
/**
|
645
|
+
* Split data into buckets by a datetime column. Accepts sub-aggregations for each bucket.
|
646
|
+
*/
|
647
|
+
declare type DateHistogramAgg = {
|
648
|
+
/**
|
649
|
+
* The column to use for bucketing. Must be of type datetime.
|
650
|
+
*/
|
651
|
+
column: string;
|
652
|
+
/**
|
653
|
+
* The fixed interval to use when bucketing.
|
654
|
+
* It is fromatted as number + units, for example: `5d`, `20m`, `10s`.
|
655
|
+
*
|
656
|
+
* @pattern ^(\d+)(d|h|m|s|ms)$
|
657
|
+
*/
|
658
|
+
interval?: string;
|
659
|
+
/**
|
660
|
+
* The calendar-aware interval to use when bucketing. Possible values are: `minute`,
|
661
|
+
* `hour`, `day`, `week`, `month`, `quarter`, `year`.
|
662
|
+
*/
|
663
|
+
calendarInterval?: 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year';
|
664
|
+
/**
|
665
|
+
* The timezone to use for bucketing. By default, UTC is assumed.
|
666
|
+
* The accepted format is as an ISO 8601 UTC offset. For example: `+01:00` or
|
667
|
+
* `-08:00`.
|
668
|
+
*
|
669
|
+
* @pattern ^[+-][01]\d:[0-5]\d$
|
670
|
+
*/
|
671
|
+
timezone?: string;
|
672
|
+
aggs?: AggExpressionMap;
|
673
|
+
};
|
674
|
+
/**
|
675
|
+
* Split data into buckets by the unique values in a column. Accepts sub-aggregations for each bucket.
|
676
|
+
* The top values as ordered by the number of records (`$count``) are returned.
|
677
|
+
*/
|
678
|
+
declare type TopValuesAgg = {
|
679
|
+
/**
|
680
|
+
* The column to use for bucketing. Accepted types are `string`, `email`, `int`, `float`, or `bool`.
|
681
|
+
*/
|
682
|
+
column: string;
|
683
|
+
aggs?: AggExpressionMap;
|
684
|
+
/**
|
685
|
+
* The maximum number of unique values to return.
|
686
|
+
*
|
687
|
+
* @default 10
|
688
|
+
* @maximum 1000
|
689
|
+
*/
|
690
|
+
size?: number;
|
691
|
+
};
|
692
|
+
/**
|
693
|
+
* Split data into buckets by dynamic numeric ranges. Accepts sub-aggregations for each bucket.
|
694
|
+
*/
|
695
|
+
declare type NumericHistogramAgg = {
|
696
|
+
/**
|
697
|
+
* The column to use for bucketing. Must be of numeric type.
|
698
|
+
*/
|
699
|
+
column: string;
|
700
|
+
/**
|
701
|
+
* The numeric interval to use for bucketing. The resulting buckets will be ranges
|
702
|
+
* with this value as size.
|
703
|
+
*
|
704
|
+
* @minimum 0
|
705
|
+
*/
|
706
|
+
interval: number;
|
707
|
+
/**
|
708
|
+
* By default the bucket keys start with 0 and then continue in `interval` steps. The bucket
|
709
|
+
* boundaries can be shiftend by using the offset option. For example, if the `interval` is 100,
|
710
|
+
* but you prefer the bucket boundaries to be `[50, 150), [150, 250), etc.`, you can set `offset`
|
711
|
+
* to 50.
|
712
|
+
*
|
713
|
+
* @default 0
|
714
|
+
*/
|
715
|
+
offset?: number;
|
716
|
+
aggs?: AggExpressionMap;
|
717
|
+
};
|
549
718
|
declare type HighlightExpression = {
|
550
719
|
/**
|
551
720
|
* Set to `false` to disable highlighting. By default it is `true`.
|
@@ -772,6 +941,46 @@ declare type RecordsMetadata = {
|
|
772
941
|
more: boolean;
|
773
942
|
};
|
774
943
|
};
|
944
|
+
declare type AggResponse$1 = (number | null) | {
|
945
|
+
values: ({
|
946
|
+
$key: string | number;
|
947
|
+
$count: number;
|
948
|
+
} & {
|
949
|
+
[key: string]: AggResponse$1;
|
950
|
+
})[];
|
951
|
+
};
|
952
|
+
/**
|
953
|
+
* Metadata of databases
|
954
|
+
*/
|
955
|
+
declare type CPDatabaseMetadata = {
|
956
|
+
/**
|
957
|
+
* The machine-readable name of a database
|
958
|
+
*/
|
959
|
+
name: string;
|
960
|
+
/**
|
961
|
+
* Region where this database is hosted
|
962
|
+
*/
|
963
|
+
region: string;
|
964
|
+
/**
|
965
|
+
* The time this database was created
|
966
|
+
*/
|
967
|
+
createdAt: DateTime;
|
968
|
+
/**
|
969
|
+
* Metadata about the database for display in Xata user interfaces
|
970
|
+
*/
|
971
|
+
ui?: {
|
972
|
+
/**
|
973
|
+
* The user-selected color for this database across interfaces
|
974
|
+
*/
|
975
|
+
color?: string;
|
976
|
+
};
|
977
|
+
};
|
978
|
+
declare type CPListDatabasesResponse = {
|
979
|
+
/**
|
980
|
+
* A list of databases in a Xata workspace
|
981
|
+
*/
|
982
|
+
databases?: CPDatabaseMetadata[];
|
983
|
+
};
|
775
984
|
/**
|
776
985
|
* Xata Table Record Metadata
|
777
986
|
*/
|
@@ -837,6 +1046,17 @@ type schemas_TargetExpression = TargetExpression;
|
|
837
1046
|
type schemas_FilterExpression = FilterExpression;
|
838
1047
|
type schemas_SummaryExpressionList = SummaryExpressionList;
|
839
1048
|
type schemas_SummaryExpression = SummaryExpression;
|
1049
|
+
type schemas_AggExpressionMap = AggExpressionMap;
|
1050
|
+
type schemas_AggExpression = AggExpression;
|
1051
|
+
type schemas_CountAgg = CountAgg;
|
1052
|
+
type schemas_SumAgg = SumAgg;
|
1053
|
+
type schemas_MaxAgg = MaxAgg;
|
1054
|
+
type schemas_MinAgg = MinAgg;
|
1055
|
+
type schemas_AverageAgg = AverageAgg;
|
1056
|
+
type schemas_UniqueCountAgg = UniqueCountAgg;
|
1057
|
+
type schemas_DateHistogramAgg = DateHistogramAgg;
|
1058
|
+
type schemas_TopValuesAgg = TopValuesAgg;
|
1059
|
+
type schemas_NumericHistogramAgg = NumericHistogramAgg;
|
840
1060
|
type schemas_HighlightExpression = HighlightExpression;
|
841
1061
|
type schemas_BoosterExpression = BoosterExpression;
|
842
1062
|
type schemas_FilterList = FilterList;
|
@@ -853,6 +1073,8 @@ type schemas_RecordMeta = RecordMeta;
|
|
853
1073
|
type schemas_RecordID = RecordID;
|
854
1074
|
type schemas_TableRename = TableRename;
|
855
1075
|
type schemas_RecordsMetadata = RecordsMetadata;
|
1076
|
+
type schemas_CPDatabaseMetadata = CPDatabaseMetadata;
|
1077
|
+
type schemas_CPListDatabasesResponse = CPListDatabasesResponse;
|
856
1078
|
declare namespace schemas {
|
857
1079
|
export {
|
858
1080
|
schemas_User as User,
|
@@ -913,6 +1135,17 @@ declare namespace schemas {
|
|
913
1135
|
schemas_FilterExpression as FilterExpression,
|
914
1136
|
schemas_SummaryExpressionList as SummaryExpressionList,
|
915
1137
|
schemas_SummaryExpression as SummaryExpression,
|
1138
|
+
schemas_AggExpressionMap as AggExpressionMap,
|
1139
|
+
schemas_AggExpression as AggExpression,
|
1140
|
+
schemas_CountAgg as CountAgg,
|
1141
|
+
schemas_SumAgg as SumAgg,
|
1142
|
+
schemas_MaxAgg as MaxAgg,
|
1143
|
+
schemas_MinAgg as MinAgg,
|
1144
|
+
schemas_AverageAgg as AverageAgg,
|
1145
|
+
schemas_UniqueCountAgg as UniqueCountAgg,
|
1146
|
+
schemas_DateHistogramAgg as DateHistogramAgg,
|
1147
|
+
schemas_TopValuesAgg as TopValuesAgg,
|
1148
|
+
schemas_NumericHistogramAgg as NumericHistogramAgg,
|
916
1149
|
schemas_HighlightExpression as HighlightExpression,
|
917
1150
|
schemas_BoosterExpression as BoosterExpression,
|
918
1151
|
ValueBooster$1 as ValueBooster,
|
@@ -932,6 +1165,9 @@ declare namespace schemas {
|
|
932
1165
|
schemas_RecordID as RecordID,
|
933
1166
|
schemas_TableRename as TableRename,
|
934
1167
|
schemas_RecordsMetadata as RecordsMetadata,
|
1168
|
+
AggResponse$1 as AggResponse,
|
1169
|
+
schemas_CPDatabaseMetadata as CPDatabaseMetadata,
|
1170
|
+
schemas_CPListDatabasesResponse as CPListDatabasesResponse,
|
935
1171
|
XataRecord$1 as XataRecord,
|
936
1172
|
};
|
937
1173
|
}
|
@@ -991,6 +1227,14 @@ declare type QueryResponse = {
|
|
991
1227
|
declare type SummarizeResponse = {
|
992
1228
|
summaries: Record<string, any>[];
|
993
1229
|
};
|
1230
|
+
/**
|
1231
|
+
* @example {"aggs":{"dailyUniqueUsers":{"values":[{"key":"2022-02-22T22:22:22Z","uniqueUsers":134},{"key":"2022-02-23T22:22:22Z","uniqueUsers":90}]}}}
|
1232
|
+
*/
|
1233
|
+
declare type AggResponse = {
|
1234
|
+
aggs?: {
|
1235
|
+
[key: string]: AggResponse$1;
|
1236
|
+
};
|
1237
|
+
};
|
994
1238
|
declare type SearchResponse = {
|
995
1239
|
records: XataRecord$1[];
|
996
1240
|
warning?: string;
|
@@ -1016,6 +1260,7 @@ type responses_SchemaCompareResponse = SchemaCompareResponse;
|
|
1016
1260
|
type responses_RecordUpdateResponse = RecordUpdateResponse;
|
1017
1261
|
type responses_QueryResponse = QueryResponse;
|
1018
1262
|
type responses_SummarizeResponse = SummarizeResponse;
|
1263
|
+
type responses_AggResponse = AggResponse;
|
1019
1264
|
type responses_SearchResponse = SearchResponse;
|
1020
1265
|
type responses_MigrationIdResponse = MigrationIdResponse;
|
1021
1266
|
declare namespace responses {
|
@@ -1031,6 +1276,7 @@ declare namespace responses {
|
|
1031
1276
|
responses_RecordUpdateResponse as RecordUpdateResponse,
|
1032
1277
|
responses_QueryResponse as QueryResponse,
|
1033
1278
|
responses_SummarizeResponse as SummarizeResponse,
|
1279
|
+
responses_AggResponse as AggResponse,
|
1034
1280
|
responses_SearchResponse as SearchResponse,
|
1035
1281
|
responses_MigrationIdResponse as MigrationIdResponse,
|
1036
1282
|
};
|
@@ -1056,7 +1302,7 @@ declare type GetUserVariables = FetcherExtraProps;
|
|
1056
1302
|
/**
|
1057
1303
|
* Return details of the user making the request
|
1058
1304
|
*/
|
1059
|
-
declare const getUser: (variables: GetUserVariables) => Promise<UserWithID>;
|
1305
|
+
declare const getUser: (variables: GetUserVariables, signal?: AbortSignal) => Promise<UserWithID>;
|
1060
1306
|
declare type UpdateUserError = ErrorWrapper<{
|
1061
1307
|
status: 400;
|
1062
1308
|
payload: BadRequestError;
|
@@ -1073,7 +1319,7 @@ declare type UpdateUserVariables = {
|
|
1073
1319
|
/**
|
1074
1320
|
* Update user info
|
1075
1321
|
*/
|
1076
|
-
declare const updateUser: (variables: UpdateUserVariables) => Promise<UserWithID>;
|
1322
|
+
declare const updateUser: (variables: UpdateUserVariables, signal?: AbortSignal) => Promise<UserWithID>;
|
1077
1323
|
declare type DeleteUserError = ErrorWrapper<{
|
1078
1324
|
status: 400;
|
1079
1325
|
payload: BadRequestError;
|
@@ -1088,7 +1334,7 @@ declare type DeleteUserVariables = FetcherExtraProps;
|
|
1088
1334
|
/**
|
1089
1335
|
* Delete the user making the request
|
1090
1336
|
*/
|
1091
|
-
declare const deleteUser: (variables: DeleteUserVariables) => Promise<undefined>;
|
1337
|
+
declare const deleteUser: (variables: DeleteUserVariables, signal?: AbortSignal) => Promise<undefined>;
|
1092
1338
|
declare type GetUserAPIKeysError = ErrorWrapper<{
|
1093
1339
|
status: 400;
|
1094
1340
|
payload: BadRequestError;
|
@@ -1109,7 +1355,7 @@ declare type GetUserAPIKeysVariables = FetcherExtraProps;
|
|
1109
1355
|
/**
|
1110
1356
|
* Retrieve a list of existing user API keys
|
1111
1357
|
*/
|
1112
|
-
declare const getUserAPIKeys: (variables: GetUserAPIKeysVariables) => Promise<GetUserAPIKeysResponse>;
|
1358
|
+
declare const getUserAPIKeys: (variables: GetUserAPIKeysVariables, signal?: AbortSignal) => Promise<GetUserAPIKeysResponse>;
|
1113
1359
|
declare type CreateUserAPIKeyPathParams = {
|
1114
1360
|
/**
|
1115
1361
|
* API Key name
|
@@ -1137,7 +1383,7 @@ declare type CreateUserAPIKeyVariables = {
|
|
1137
1383
|
/**
|
1138
1384
|
* Create and return new API key
|
1139
1385
|
*/
|
1140
|
-
declare const createUserAPIKey: (variables: CreateUserAPIKeyVariables) => Promise<CreateUserAPIKeyResponse>;
|
1386
|
+
declare const createUserAPIKey: (variables: CreateUserAPIKeyVariables, signal?: AbortSignal) => Promise<CreateUserAPIKeyResponse>;
|
1141
1387
|
declare type DeleteUserAPIKeyPathParams = {
|
1142
1388
|
/**
|
1143
1389
|
* API Key name
|
@@ -1160,7 +1406,7 @@ declare type DeleteUserAPIKeyVariables = {
|
|
1160
1406
|
/**
|
1161
1407
|
* Delete an existing API key
|
1162
1408
|
*/
|
1163
|
-
declare const deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables) => Promise<undefined>;
|
1409
|
+
declare const deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal) => Promise<undefined>;
|
1164
1410
|
declare type CreateWorkspaceError = ErrorWrapper<{
|
1165
1411
|
status: 400;
|
1166
1412
|
payload: BadRequestError;
|
@@ -1177,7 +1423,7 @@ declare type CreateWorkspaceVariables = {
|
|
1177
1423
|
/**
|
1178
1424
|
* Creates a new workspace with the user requesting it as its single owner.
|
1179
1425
|
*/
|
1180
|
-
declare const createWorkspace: (variables: CreateWorkspaceVariables) => Promise<Workspace>;
|
1426
|
+
declare const createWorkspace: (variables: CreateWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
1181
1427
|
declare type GetWorkspacesListError = ErrorWrapper<{
|
1182
1428
|
status: 400;
|
1183
1429
|
payload: BadRequestError;
|
@@ -1200,7 +1446,7 @@ declare type GetWorkspacesListVariables = FetcherExtraProps;
|
|
1200
1446
|
/**
|
1201
1447
|
* Retrieve the list of workspaces the user belongs to
|
1202
1448
|
*/
|
1203
|
-
declare const getWorkspacesList: (variables: GetWorkspacesListVariables) => Promise<GetWorkspacesListResponse>;
|
1449
|
+
declare const getWorkspacesList: (variables: GetWorkspacesListVariables, signal?: AbortSignal) => Promise<GetWorkspacesListResponse>;
|
1204
1450
|
declare type GetWorkspacePathParams = {
|
1205
1451
|
/**
|
1206
1452
|
* Workspace ID
|
@@ -1223,7 +1469,7 @@ declare type GetWorkspaceVariables = {
|
|
1223
1469
|
/**
|
1224
1470
|
* Retrieve workspace info from a workspace ID
|
1225
1471
|
*/
|
1226
|
-
declare const getWorkspace: (variables: GetWorkspaceVariables) => Promise<Workspace>;
|
1472
|
+
declare const getWorkspace: (variables: GetWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
1227
1473
|
declare type UpdateWorkspacePathParams = {
|
1228
1474
|
/**
|
1229
1475
|
* Workspace ID
|
@@ -1247,7 +1493,7 @@ declare type UpdateWorkspaceVariables = {
|
|
1247
1493
|
/**
|
1248
1494
|
* Update workspace info
|
1249
1495
|
*/
|
1250
|
-
declare const updateWorkspace: (variables: UpdateWorkspaceVariables) => Promise<Workspace>;
|
1496
|
+
declare const updateWorkspace: (variables: UpdateWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
1251
1497
|
declare type DeleteWorkspacePathParams = {
|
1252
1498
|
/**
|
1253
1499
|
* Workspace ID
|
@@ -1270,7 +1516,7 @@ declare type DeleteWorkspaceVariables = {
|
|
1270
1516
|
/**
|
1271
1517
|
* Delete the workspace with the provided ID
|
1272
1518
|
*/
|
1273
|
-
declare const deleteWorkspace: (variables: DeleteWorkspaceVariables) => Promise<undefined>;
|
1519
|
+
declare const deleteWorkspace: (variables: DeleteWorkspaceVariables, signal?: AbortSignal) => Promise<undefined>;
|
1274
1520
|
declare type GetWorkspaceMembersListPathParams = {
|
1275
1521
|
/**
|
1276
1522
|
* Workspace ID
|
@@ -1293,7 +1539,7 @@ declare type GetWorkspaceMembersListVariables = {
|
|
1293
1539
|
/**
|
1294
1540
|
* Retrieve the list of members of the given workspace
|
1295
1541
|
*/
|
1296
|
-
declare const getWorkspaceMembersList: (variables: GetWorkspaceMembersListVariables) => Promise<WorkspaceMembers>;
|
1542
|
+
declare const getWorkspaceMembersList: (variables: GetWorkspaceMembersListVariables, signal?: AbortSignal) => Promise<WorkspaceMembers>;
|
1297
1543
|
declare type UpdateWorkspaceMemberRolePathParams = {
|
1298
1544
|
/**
|
1299
1545
|
* Workspace ID
|
@@ -1324,7 +1570,7 @@ declare type UpdateWorkspaceMemberRoleVariables = {
|
|
1324
1570
|
/**
|
1325
1571
|
* Update a workspace member role. Workspaces must always have at least one owner, so this operation will fail if trying to remove owner role from the last owner in the workspace.
|
1326
1572
|
*/
|
1327
|
-
declare const updateWorkspaceMemberRole: (variables: UpdateWorkspaceMemberRoleVariables) => Promise<undefined>;
|
1573
|
+
declare const updateWorkspaceMemberRole: (variables: UpdateWorkspaceMemberRoleVariables, signal?: AbortSignal) => Promise<undefined>;
|
1328
1574
|
declare type RemoveWorkspaceMemberPathParams = {
|
1329
1575
|
/**
|
1330
1576
|
* Workspace ID
|
@@ -1351,7 +1597,7 @@ declare type RemoveWorkspaceMemberVariables = {
|
|
1351
1597
|
/**
|
1352
1598
|
* Remove the member from the workspace
|
1353
1599
|
*/
|
1354
|
-
declare const removeWorkspaceMember: (variables: RemoveWorkspaceMemberVariables) => Promise<undefined>;
|
1600
|
+
declare const removeWorkspaceMember: (variables: RemoveWorkspaceMemberVariables, signal?: AbortSignal) => Promise<undefined>;
|
1355
1601
|
declare type InviteWorkspaceMemberPathParams = {
|
1356
1602
|
/**
|
1357
1603
|
* Workspace ID
|
@@ -1385,7 +1631,7 @@ declare type InviteWorkspaceMemberVariables = {
|
|
1385
1631
|
/**
|
1386
1632
|
* Invite some user to join the workspace with the given role
|
1387
1633
|
*/
|
1388
|
-
declare const inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables) => Promise<WorkspaceInvite>;
|
1634
|
+
declare const inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables, signal?: AbortSignal) => Promise<WorkspaceInvite>;
|
1389
1635
|
declare type UpdateWorkspaceMemberInvitePathParams = {
|
1390
1636
|
/**
|
1391
1637
|
* Workspace ID
|
@@ -1419,7 +1665,7 @@ declare type UpdateWorkspaceMemberInviteVariables = {
|
|
1419
1665
|
/**
|
1420
1666
|
* This operation provides a way to update an existing invite. Updates are performed in-place; they do not change the invite link, the expiry time, nor do they re-notify the recipient of the invite.
|
1421
1667
|
*/
|
1422
|
-
declare const updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables) => Promise<WorkspaceInvite>;
|
1668
|
+
declare const updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<WorkspaceInvite>;
|
1423
1669
|
declare type CancelWorkspaceMemberInvitePathParams = {
|
1424
1670
|
/**
|
1425
1671
|
* Workspace ID
|
@@ -1446,7 +1692,7 @@ declare type CancelWorkspaceMemberInviteVariables = {
|
|
1446
1692
|
/**
|
1447
1693
|
* This operation provides a way to cancel invites by deleting them. Already accepted invites cannot be deleted.
|
1448
1694
|
*/
|
1449
|
-
declare const cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables) => Promise<undefined>;
|
1695
|
+
declare const cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
1450
1696
|
declare type ResendWorkspaceMemberInvitePathParams = {
|
1451
1697
|
/**
|
1452
1698
|
* Workspace ID
|
@@ -1473,7 +1719,7 @@ declare type ResendWorkspaceMemberInviteVariables = {
|
|
1473
1719
|
/**
|
1474
1720
|
* This operation provides a way to resend an Invite notification. Invite notifications can only be sent for Invites not yet accepted.
|
1475
1721
|
*/
|
1476
|
-
declare const resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables) => Promise<undefined>;
|
1722
|
+
declare const resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
1477
1723
|
declare type AcceptWorkspaceMemberInvitePathParams = {
|
1478
1724
|
/**
|
1479
1725
|
* Workspace ID
|
@@ -1500,7 +1746,7 @@ declare type AcceptWorkspaceMemberInviteVariables = {
|
|
1500
1746
|
/**
|
1501
1747
|
* Accept the invitation to join a workspace. If the operation succeeds the user will be a member of the workspace
|
1502
1748
|
*/
|
1503
|
-
declare const acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables) => Promise<undefined>;
|
1749
|
+
declare const acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
1504
1750
|
declare type GetDatabaseListPathParams = {
|
1505
1751
|
workspace: string;
|
1506
1752
|
};
|
@@ -1517,7 +1763,7 @@ declare type GetDatabaseListVariables = {
|
|
1517
1763
|
/**
|
1518
1764
|
* List all databases available in your Workspace.
|
1519
1765
|
*/
|
1520
|
-
declare const getDatabaseList: (variables: GetDatabaseListVariables) => Promise<ListDatabasesResponse>;
|
1766
|
+
declare const getDatabaseList: (variables: GetDatabaseListVariables, signal?: AbortSignal) => Promise<ListDatabasesResponse>;
|
1521
1767
|
declare type GetBranchListPathParams = {
|
1522
1768
|
/**
|
1523
1769
|
* The Database Name
|
@@ -1541,7 +1787,7 @@ declare type GetBranchListVariables = {
|
|
1541
1787
|
/**
|
1542
1788
|
* List all available Branches
|
1543
1789
|
*/
|
1544
|
-
declare const getBranchList: (variables: GetBranchListVariables) => Promise<ListBranchesResponse>;
|
1790
|
+
declare const getBranchList: (variables: GetBranchListVariables, signal?: AbortSignal) => Promise<ListBranchesResponse>;
|
1545
1791
|
declare type CreateDatabasePathParams = {
|
1546
1792
|
/**
|
1547
1793
|
* The Database Name
|
@@ -1580,7 +1826,7 @@ declare type CreateDatabaseVariables = {
|
|
1580
1826
|
/**
|
1581
1827
|
* Create Database with identifier name
|
1582
1828
|
*/
|
1583
|
-
declare const createDatabase: (variables: CreateDatabaseVariables) => Promise<CreateDatabaseResponse>;
|
1829
|
+
declare const createDatabase: (variables: CreateDatabaseVariables, signal?: AbortSignal) => Promise<CreateDatabaseResponse>;
|
1584
1830
|
declare type DeleteDatabasePathParams = {
|
1585
1831
|
/**
|
1586
1832
|
* The Database Name
|
@@ -1604,7 +1850,7 @@ declare type DeleteDatabaseVariables = {
|
|
1604
1850
|
/**
|
1605
1851
|
* Delete a database and all of its branches and tables permanently.
|
1606
1852
|
*/
|
1607
|
-
declare const deleteDatabase: (variables: DeleteDatabaseVariables) => Promise<undefined>;
|
1853
|
+
declare const deleteDatabase: (variables: DeleteDatabaseVariables, signal?: AbortSignal) => Promise<undefined>;
|
1608
1854
|
declare type GetDatabaseMetadataPathParams = {
|
1609
1855
|
/**
|
1610
1856
|
* The Database Name
|
@@ -1628,7 +1874,7 @@ declare type GetDatabaseMetadataVariables = {
|
|
1628
1874
|
/**
|
1629
1875
|
* Retrieve metadata of the given database
|
1630
1876
|
*/
|
1631
|
-
declare const getDatabaseMetadata: (variables: GetDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
|
1877
|
+
declare const getDatabaseMetadata: (variables: GetDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
1632
1878
|
declare type UpdateDatabaseMetadataPathParams = {
|
1633
1879
|
/**
|
1634
1880
|
* The Database Name
|
@@ -1661,7 +1907,7 @@ declare type UpdateDatabaseMetadataVariables = {
|
|
1661
1907
|
/**
|
1662
1908
|
* Update the color of the selected database
|
1663
1909
|
*/
|
1664
|
-
declare const updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
|
1910
|
+
declare const updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
1665
1911
|
declare type GetGitBranchesMappingPathParams = {
|
1666
1912
|
/**
|
1667
1913
|
* The Database Name
|
@@ -1703,7 +1949,7 @@ declare type GetGitBranchesMappingVariables = {
|
|
1703
1949
|
* }
|
1704
1950
|
* ```
|
1705
1951
|
*/
|
1706
|
-
declare const getGitBranchesMapping: (variables: GetGitBranchesMappingVariables) => Promise<ListGitBranchesResponse>;
|
1952
|
+
declare const getGitBranchesMapping: (variables: GetGitBranchesMappingVariables, signal?: AbortSignal) => Promise<ListGitBranchesResponse>;
|
1707
1953
|
declare type AddGitBranchesEntryPathParams = {
|
1708
1954
|
/**
|
1709
1955
|
* The Database Name
|
@@ -1753,7 +1999,7 @@ declare type AddGitBranchesEntryVariables = {
|
|
1753
1999
|
* }
|
1754
2000
|
* ```
|
1755
2001
|
*/
|
1756
|
-
declare const addGitBranchesEntry: (variables: AddGitBranchesEntryVariables) => Promise<AddGitBranchesEntryResponse>;
|
2002
|
+
declare const addGitBranchesEntry: (variables: AddGitBranchesEntryVariables, signal?: AbortSignal) => Promise<AddGitBranchesEntryResponse>;
|
1757
2003
|
declare type RemoveGitBranchesEntryPathParams = {
|
1758
2004
|
/**
|
1759
2005
|
* The Database Name
|
@@ -1787,7 +2033,7 @@ declare type RemoveGitBranchesEntryVariables = {
|
|
1787
2033
|
* // DELETE https://tutorial-ng7s8c.xata.sh/dbs/demo/gitBranches?gitBranch=fix%2Fbug123
|
1788
2034
|
* ```
|
1789
2035
|
*/
|
1790
|
-
declare const removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables) => Promise<undefined>;
|
2036
|
+
declare const removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables, signal?: AbortSignal) => Promise<undefined>;
|
1791
2037
|
declare type ResolveBranchPathParams = {
|
1792
2038
|
/**
|
1793
2039
|
* The Database Name
|
@@ -1848,7 +2094,7 @@ declare type ResolveBranchVariables = {
|
|
1848
2094
|
* }
|
1849
2095
|
* ```
|
1850
2096
|
*/
|
1851
|
-
declare const resolveBranch: (variables: ResolveBranchVariables) => Promise<ResolveBranchResponse>;
|
2097
|
+
declare const resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal) => Promise<ResolveBranchResponse>;
|
1852
2098
|
declare type QueryMigrationRequestsPathParams = {
|
1853
2099
|
/**
|
1854
2100
|
* The Database Name
|
@@ -1880,7 +2126,7 @@ declare type QueryMigrationRequestsVariables = {
|
|
1880
2126
|
body?: QueryMigrationRequestsRequestBody;
|
1881
2127
|
pathParams: QueryMigrationRequestsPathParams;
|
1882
2128
|
} & FetcherExtraProps;
|
1883
|
-
declare const queryMigrationRequests: (variables: QueryMigrationRequestsVariables) => Promise<QueryMigrationRequestsResponse>;
|
2129
|
+
declare const queryMigrationRequests: (variables: QueryMigrationRequestsVariables, signal?: AbortSignal) => Promise<QueryMigrationRequestsResponse>;
|
1884
2130
|
declare type CreateMigrationRequestPathParams = {
|
1885
2131
|
/**
|
1886
2132
|
* The Database Name
|
@@ -1923,7 +2169,7 @@ declare type CreateMigrationRequestVariables = {
|
|
1923
2169
|
body: CreateMigrationRequestRequestBody;
|
1924
2170
|
pathParams: CreateMigrationRequestPathParams;
|
1925
2171
|
} & FetcherExtraProps;
|
1926
|
-
declare const createMigrationRequest: (variables: CreateMigrationRequestVariables) => Promise<CreateMigrationRequestResponse>;
|
2172
|
+
declare const createMigrationRequest: (variables: CreateMigrationRequestVariables, signal?: AbortSignal) => Promise<CreateMigrationRequestResponse>;
|
1927
2173
|
declare type GetMigrationRequestPathParams = {
|
1928
2174
|
/**
|
1929
2175
|
* The Database Name
|
@@ -1948,7 +2194,7 @@ declare type GetMigrationRequestError = ErrorWrapper<{
|
|
1948
2194
|
declare type GetMigrationRequestVariables = {
|
1949
2195
|
pathParams: GetMigrationRequestPathParams;
|
1950
2196
|
} & FetcherExtraProps;
|
1951
|
-
declare const getMigrationRequest: (variables: GetMigrationRequestVariables) => Promise<MigrationRequest>;
|
2197
|
+
declare const getMigrationRequest: (variables: GetMigrationRequestVariables, signal?: AbortSignal) => Promise<MigrationRequest>;
|
1952
2198
|
declare type UpdateMigrationRequestPathParams = {
|
1953
2199
|
/**
|
1954
2200
|
* The Database Name
|
@@ -1988,7 +2234,7 @@ declare type UpdateMigrationRequestVariables = {
|
|
1988
2234
|
body?: UpdateMigrationRequestRequestBody;
|
1989
2235
|
pathParams: UpdateMigrationRequestPathParams;
|
1990
2236
|
} & FetcherExtraProps;
|
1991
|
-
declare const updateMigrationRequest: (variables: UpdateMigrationRequestVariables) => Promise<undefined>;
|
2237
|
+
declare const updateMigrationRequest: (variables: UpdateMigrationRequestVariables, signal?: AbortSignal) => Promise<undefined>;
|
1992
2238
|
declare type ListMigrationRequestsCommitsPathParams = {
|
1993
2239
|
/**
|
1994
2240
|
* The Database Name
|
@@ -2045,7 +2291,7 @@ declare type ListMigrationRequestsCommitsVariables = {
|
|
2045
2291
|
body?: ListMigrationRequestsCommitsRequestBody;
|
2046
2292
|
pathParams: ListMigrationRequestsCommitsPathParams;
|
2047
2293
|
} & FetcherExtraProps;
|
2048
|
-
declare const listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables) => Promise<ListMigrationRequestsCommitsResponse>;
|
2294
|
+
declare const listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables, signal?: AbortSignal) => Promise<ListMigrationRequestsCommitsResponse>;
|
2049
2295
|
declare type CompareMigrationRequestPathParams = {
|
2050
2296
|
/**
|
2051
2297
|
* The Database Name
|
@@ -2070,7 +2316,7 @@ declare type CompareMigrationRequestError = ErrorWrapper<{
|
|
2070
2316
|
declare type CompareMigrationRequestVariables = {
|
2071
2317
|
pathParams: CompareMigrationRequestPathParams;
|
2072
2318
|
} & FetcherExtraProps;
|
2073
|
-
declare const compareMigrationRequest: (variables: CompareMigrationRequestVariables) => Promise<SchemaCompareResponse>;
|
2319
|
+
declare const compareMigrationRequest: (variables: CompareMigrationRequestVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
2074
2320
|
declare type GetMigrationRequestIsMergedPathParams = {
|
2075
2321
|
/**
|
2076
2322
|
* The Database Name
|
@@ -2098,7 +2344,7 @@ declare type GetMigrationRequestIsMergedResponse = {
|
|
2098
2344
|
declare type GetMigrationRequestIsMergedVariables = {
|
2099
2345
|
pathParams: GetMigrationRequestIsMergedPathParams;
|
2100
2346
|
} & FetcherExtraProps;
|
2101
|
-
declare const getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables) => Promise<GetMigrationRequestIsMergedResponse>;
|
2347
|
+
declare const getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables, signal?: AbortSignal) => Promise<GetMigrationRequestIsMergedResponse>;
|
2102
2348
|
declare type MergeMigrationRequestPathParams = {
|
2103
2349
|
/**
|
2104
2350
|
* The Database Name
|
@@ -2123,7 +2369,7 @@ declare type MergeMigrationRequestError = ErrorWrapper<{
|
|
2123
2369
|
declare type MergeMigrationRequestVariables = {
|
2124
2370
|
pathParams: MergeMigrationRequestPathParams;
|
2125
2371
|
} & FetcherExtraProps;
|
2126
|
-
declare const mergeMigrationRequest: (variables: MergeMigrationRequestVariables) => Promise<Commit>;
|
2372
|
+
declare const mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal) => Promise<Commit>;
|
2127
2373
|
declare type GetBranchDetailsPathParams = {
|
2128
2374
|
/**
|
2129
2375
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2144,7 +2390,7 @@ declare type GetBranchDetailsError = ErrorWrapper<{
|
|
2144
2390
|
declare type GetBranchDetailsVariables = {
|
2145
2391
|
pathParams: GetBranchDetailsPathParams;
|
2146
2392
|
} & FetcherExtraProps;
|
2147
|
-
declare const getBranchDetails: (variables: GetBranchDetailsVariables) => Promise<DBBranch>;
|
2393
|
+
declare const getBranchDetails: (variables: GetBranchDetailsVariables, signal?: AbortSignal) => Promise<DBBranch>;
|
2148
2394
|
declare type CreateBranchPathParams = {
|
2149
2395
|
/**
|
2150
2396
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2187,7 +2433,7 @@ declare type CreateBranchVariables = {
|
|
2187
2433
|
pathParams: CreateBranchPathParams;
|
2188
2434
|
queryParams?: CreateBranchQueryParams;
|
2189
2435
|
} & FetcherExtraProps;
|
2190
|
-
declare const createBranch: (variables: CreateBranchVariables) => Promise<CreateBranchResponse>;
|
2436
|
+
declare const createBranch: (variables: CreateBranchVariables, signal?: AbortSignal) => Promise<CreateBranchResponse>;
|
2191
2437
|
declare type DeleteBranchPathParams = {
|
2192
2438
|
/**
|
2193
2439
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2211,7 +2457,7 @@ declare type DeleteBranchVariables = {
|
|
2211
2457
|
/**
|
2212
2458
|
* Delete the branch in the database and all its resources
|
2213
2459
|
*/
|
2214
|
-
declare const deleteBranch: (variables: DeleteBranchVariables) => Promise<undefined>;
|
2460
|
+
declare const deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal) => Promise<undefined>;
|
2215
2461
|
declare type UpdateBranchMetadataPathParams = {
|
2216
2462
|
/**
|
2217
2463
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2236,7 +2482,7 @@ declare type UpdateBranchMetadataVariables = {
|
|
2236
2482
|
/**
|
2237
2483
|
* Update the branch metadata
|
2238
2484
|
*/
|
2239
|
-
declare const updateBranchMetadata: (variables: UpdateBranchMetadataVariables) => Promise<undefined>;
|
2485
|
+
declare const updateBranchMetadata: (variables: UpdateBranchMetadataVariables, signal?: AbortSignal) => Promise<undefined>;
|
2240
2486
|
declare type GetBranchMetadataPathParams = {
|
2241
2487
|
/**
|
2242
2488
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2257,7 +2503,7 @@ declare type GetBranchMetadataError = ErrorWrapper<{
|
|
2257
2503
|
declare type GetBranchMetadataVariables = {
|
2258
2504
|
pathParams: GetBranchMetadataPathParams;
|
2259
2505
|
} & FetcherExtraProps;
|
2260
|
-
declare const getBranchMetadata: (variables: GetBranchMetadataVariables) => Promise<BranchMetadata>;
|
2506
|
+
declare const getBranchMetadata: (variables: GetBranchMetadataVariables, signal?: AbortSignal) => Promise<BranchMetadata>;
|
2261
2507
|
declare type GetBranchMigrationHistoryPathParams = {
|
2262
2508
|
/**
|
2263
2509
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2287,7 +2533,7 @@ declare type GetBranchMigrationHistoryVariables = {
|
|
2287
2533
|
body?: GetBranchMigrationHistoryRequestBody;
|
2288
2534
|
pathParams: GetBranchMigrationHistoryPathParams;
|
2289
2535
|
} & FetcherExtraProps;
|
2290
|
-
declare const getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables) => Promise<GetBranchMigrationHistoryResponse>;
|
2536
|
+
declare const getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal) => Promise<GetBranchMigrationHistoryResponse>;
|
2291
2537
|
declare type ExecuteBranchMigrationPlanPathParams = {
|
2292
2538
|
/**
|
2293
2539
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2316,7 +2562,7 @@ declare type ExecuteBranchMigrationPlanVariables = {
|
|
2316
2562
|
/**
|
2317
2563
|
* Apply a migration plan to the branch
|
2318
2564
|
*/
|
2319
|
-
declare const executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables) => Promise<undefined>;
|
2565
|
+
declare const executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<undefined>;
|
2320
2566
|
declare type GetBranchMigrationPlanPathParams = {
|
2321
2567
|
/**
|
2322
2568
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2341,7 +2587,7 @@ declare type GetBranchMigrationPlanVariables = {
|
|
2341
2587
|
/**
|
2342
2588
|
* Compute a migration plan from a target schema the branch should be migrated too.
|
2343
2589
|
*/
|
2344
|
-
declare const getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables) => Promise<BranchMigrationPlan>;
|
2590
|
+
declare const getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<BranchMigrationPlan>;
|
2345
2591
|
declare type CompareBranchWithUserSchemaPathParams = {
|
2346
2592
|
/**
|
2347
2593
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2366,7 +2612,7 @@ declare type CompareBranchWithUserSchemaVariables = {
|
|
2366
2612
|
body: CompareBranchWithUserSchemaRequestBody;
|
2367
2613
|
pathParams: CompareBranchWithUserSchemaPathParams;
|
2368
2614
|
} & FetcherExtraProps;
|
2369
|
-
declare const compareBranchWithUserSchema: (variables: CompareBranchWithUserSchemaVariables) => Promise<SchemaCompareResponse>;
|
2615
|
+
declare const compareBranchWithUserSchema: (variables: CompareBranchWithUserSchemaVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
2370
2616
|
declare type CompareBranchSchemasPathParams = {
|
2371
2617
|
/**
|
2372
2618
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2392,7 +2638,7 @@ declare type CompareBranchSchemasVariables = {
|
|
2392
2638
|
body?: Record<string, any>;
|
2393
2639
|
pathParams: CompareBranchSchemasPathParams;
|
2394
2640
|
} & FetcherExtraProps;
|
2395
|
-
declare const compareBranchSchemas: (variables: CompareBranchSchemasVariables) => Promise<SchemaCompareResponse>;
|
2641
|
+
declare const compareBranchSchemas: (variables: CompareBranchSchemasVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
2396
2642
|
declare type UpdateBranchSchemaPathParams = {
|
2397
2643
|
/**
|
2398
2644
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2418,7 +2664,7 @@ declare type UpdateBranchSchemaVariables = {
|
|
2418
2664
|
body: Migration;
|
2419
2665
|
pathParams: UpdateBranchSchemaPathParams;
|
2420
2666
|
} & FetcherExtraProps;
|
2421
|
-
declare const updateBranchSchema: (variables: UpdateBranchSchemaVariables) => Promise<UpdateBranchSchemaResponse>;
|
2667
|
+
declare const updateBranchSchema: (variables: UpdateBranchSchemaVariables, signal?: AbortSignal) => Promise<UpdateBranchSchemaResponse>;
|
2422
2668
|
declare type PreviewBranchSchemaEditPathParams = {
|
2423
2669
|
/**
|
2424
2670
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2448,7 +2694,7 @@ declare type PreviewBranchSchemaEditVariables = {
|
|
2448
2694
|
body?: PreviewBranchSchemaEditRequestBody;
|
2449
2695
|
pathParams: PreviewBranchSchemaEditPathParams;
|
2450
2696
|
} & FetcherExtraProps;
|
2451
|
-
declare const previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables) => Promise<PreviewBranchSchemaEditResponse>;
|
2697
|
+
declare const previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables, signal?: AbortSignal) => Promise<PreviewBranchSchemaEditResponse>;
|
2452
2698
|
declare type ApplyBranchSchemaEditPathParams = {
|
2453
2699
|
/**
|
2454
2700
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2477,7 +2723,7 @@ declare type ApplyBranchSchemaEditVariables = {
|
|
2477
2723
|
body: ApplyBranchSchemaEditRequestBody;
|
2478
2724
|
pathParams: ApplyBranchSchemaEditPathParams;
|
2479
2725
|
} & FetcherExtraProps;
|
2480
|
-
declare const applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables) => Promise<ApplyBranchSchemaEditResponse>;
|
2726
|
+
declare const applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal) => Promise<ApplyBranchSchemaEditResponse>;
|
2481
2727
|
declare type GetBranchSchemaHistoryPathParams = {
|
2482
2728
|
/**
|
2483
2729
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2530,7 +2776,7 @@ declare type GetBranchSchemaHistoryVariables = {
|
|
2530
2776
|
body?: GetBranchSchemaHistoryRequestBody;
|
2531
2777
|
pathParams: GetBranchSchemaHistoryPathParams;
|
2532
2778
|
} & FetcherExtraProps;
|
2533
|
-
declare const getBranchSchemaHistory: (variables: GetBranchSchemaHistoryVariables) => Promise<GetBranchSchemaHistoryResponse>;
|
2779
|
+
declare const getBranchSchemaHistory: (variables: GetBranchSchemaHistoryVariables, signal?: AbortSignal) => Promise<GetBranchSchemaHistoryResponse>;
|
2534
2780
|
declare type GetBranchStatsPathParams = {
|
2535
2781
|
/**
|
2536
2782
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2565,7 +2811,7 @@ declare type GetBranchStatsVariables = {
|
|
2565
2811
|
/**
|
2566
2812
|
* Get branch usage metrics.
|
2567
2813
|
*/
|
2568
|
-
declare const getBranchStats: (variables: GetBranchStatsVariables) => Promise<GetBranchStatsResponse>;
|
2814
|
+
declare const getBranchStats: (variables: GetBranchStatsVariables, signal?: AbortSignal) => Promise<GetBranchStatsResponse>;
|
2569
2815
|
declare type CreateTablePathParams = {
|
2570
2816
|
/**
|
2571
2817
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2603,7 +2849,7 @@ declare type CreateTableVariables = {
|
|
2603
2849
|
/**
|
2604
2850
|
* Creates a new table with the given name. Returns 422 if a table with the same name already exists.
|
2605
2851
|
*/
|
2606
|
-
declare const createTable: (variables: CreateTableVariables) => Promise<CreateTableResponse>;
|
2852
|
+
declare const createTable: (variables: CreateTableVariables, signal?: AbortSignal) => Promise<CreateTableResponse>;
|
2607
2853
|
declare type DeleteTablePathParams = {
|
2608
2854
|
/**
|
2609
2855
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2628,7 +2874,7 @@ declare type DeleteTableVariables = {
|
|
2628
2874
|
/**
|
2629
2875
|
* Deletes the table with the given name.
|
2630
2876
|
*/
|
2631
|
-
declare const deleteTable: (variables: DeleteTableVariables) => Promise<undefined>;
|
2877
|
+
declare const deleteTable: (variables: DeleteTableVariables, signal?: AbortSignal) => Promise<undefined>;
|
2632
2878
|
declare type UpdateTablePathParams = {
|
2633
2879
|
/**
|
2634
2880
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2673,7 +2919,7 @@ declare type UpdateTableVariables = {
|
|
2673
2919
|
* }
|
2674
2920
|
* ```
|
2675
2921
|
*/
|
2676
|
-
declare const updateTable: (variables: UpdateTableVariables) => Promise<undefined>;
|
2922
|
+
declare const updateTable: (variables: UpdateTableVariables, signal?: AbortSignal) => Promise<undefined>;
|
2677
2923
|
declare type GetTableSchemaPathParams = {
|
2678
2924
|
/**
|
2679
2925
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2701,7 +2947,7 @@ declare type GetTableSchemaResponse = {
|
|
2701
2947
|
declare type GetTableSchemaVariables = {
|
2702
2948
|
pathParams: GetTableSchemaPathParams;
|
2703
2949
|
} & FetcherExtraProps;
|
2704
|
-
declare const getTableSchema: (variables: GetTableSchemaVariables) => Promise<GetTableSchemaResponse>;
|
2950
|
+
declare const getTableSchema: (variables: GetTableSchemaVariables, signal?: AbortSignal) => Promise<GetTableSchemaResponse>;
|
2705
2951
|
declare type SetTableSchemaPathParams = {
|
2706
2952
|
/**
|
2707
2953
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2733,7 +2979,7 @@ declare type SetTableSchemaVariables = {
|
|
2733
2979
|
body: SetTableSchemaRequestBody;
|
2734
2980
|
pathParams: SetTableSchemaPathParams;
|
2735
2981
|
} & FetcherExtraProps;
|
2736
|
-
declare const setTableSchema: (variables: SetTableSchemaVariables) => Promise<undefined>;
|
2982
|
+
declare const setTableSchema: (variables: SetTableSchemaVariables, signal?: AbortSignal) => Promise<undefined>;
|
2737
2983
|
declare type GetTableColumnsPathParams = {
|
2738
2984
|
/**
|
2739
2985
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2765,7 +3011,7 @@ declare type GetTableColumnsVariables = {
|
|
2765
3011
|
* Retrieves the list of table columns and their definition. This endpoint returns the column list with object columns being reported with their
|
2766
3012
|
* full dot-separated path (flattened).
|
2767
3013
|
*/
|
2768
|
-
declare const getTableColumns: (variables: GetTableColumnsVariables) => Promise<GetTableColumnsResponse>;
|
3014
|
+
declare const getTableColumns: (variables: GetTableColumnsVariables, signal?: AbortSignal) => Promise<GetTableColumnsResponse>;
|
2769
3015
|
declare type AddTableColumnPathParams = {
|
2770
3016
|
/**
|
2771
3017
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2796,7 +3042,7 @@ declare type AddTableColumnVariables = {
|
|
2796
3042
|
* contain the full path separated by dots. If the parent objects do not exists, they will be automatically created. For example,
|
2797
3043
|
* passing `"name": "address.city"` will auto-create the `address` object if it doesn't exist.
|
2798
3044
|
*/
|
2799
|
-
declare const addTableColumn: (variables: AddTableColumnVariables) => Promise<MigrationIdResponse>;
|
3045
|
+
declare const addTableColumn: (variables: AddTableColumnVariables, signal?: AbortSignal) => Promise<MigrationIdResponse>;
|
2800
3046
|
declare type GetColumnPathParams = {
|
2801
3047
|
/**
|
2802
3048
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2828,7 +3074,7 @@ declare type GetColumnVariables = {
|
|
2828
3074
|
/**
|
2829
3075
|
* Get the definition of a single column. To refer to sub-objects, the column name can contain dots. For example `address.country`.
|
2830
3076
|
*/
|
2831
|
-
declare const getColumn: (variables: GetColumnVariables) => Promise<Column>;
|
3077
|
+
declare const getColumn: (variables: GetColumnVariables, signal?: AbortSignal) => Promise<Column>;
|
2832
3078
|
declare type DeleteColumnPathParams = {
|
2833
3079
|
/**
|
2834
3080
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2860,7 +3106,7 @@ declare type DeleteColumnVariables = {
|
|
2860
3106
|
/**
|
2861
3107
|
* Deletes the specified column. To refer to sub-objects, the column name can contain dots. For example `address.country`.
|
2862
3108
|
*/
|
2863
|
-
declare const deleteColumn: (variables: DeleteColumnVariables) => Promise<MigrationIdResponse>;
|
3109
|
+
declare const deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal) => Promise<MigrationIdResponse>;
|
2864
3110
|
declare type UpdateColumnPathParams = {
|
2865
3111
|
/**
|
2866
3112
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2899,7 +3145,7 @@ declare type UpdateColumnVariables = {
|
|
2899
3145
|
/**
|
2900
3146
|
* Update column with partial data. Can be used for renaming the column by providing a new "name" field. To refer to sub-objects, the column name can contain dots. For example `address.country`.
|
2901
3147
|
*/
|
2902
|
-
declare const updateColumn: (variables: UpdateColumnVariables) => Promise<MigrationIdResponse>;
|
3148
|
+
declare const updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal) => Promise<MigrationIdResponse>;
|
2903
3149
|
declare type InsertRecordPathParams = {
|
2904
3150
|
/**
|
2905
3151
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2935,7 +3181,7 @@ declare type InsertRecordVariables = {
|
|
2935
3181
|
/**
|
2936
3182
|
* Insert a new Record into the Table
|
2937
3183
|
*/
|
2938
|
-
declare const insertRecord: (variables: InsertRecordVariables) => Promise<RecordUpdateResponse>;
|
3184
|
+
declare const insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
2939
3185
|
declare type InsertRecordWithIDPathParams = {
|
2940
3186
|
/**
|
2941
3187
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2980,7 +3226,7 @@ declare type InsertRecordWithIDVariables = {
|
|
2980
3226
|
/**
|
2981
3227
|
* By default, IDs are auto-generated when data is insterted into Xata. Sending a request to this endpoint allows us to insert a record with a pre-existing ID, bypassing the default automatic ID generation.
|
2982
3228
|
*/
|
2983
|
-
declare const insertRecordWithID: (variables: InsertRecordWithIDVariables) => Promise<RecordUpdateResponse>;
|
3229
|
+
declare const insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
2984
3230
|
declare type UpdateRecordWithIDPathParams = {
|
2985
3231
|
/**
|
2986
3232
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3021,7 +3267,7 @@ declare type UpdateRecordWithIDVariables = {
|
|
3021
3267
|
pathParams: UpdateRecordWithIDPathParams;
|
3022
3268
|
queryParams?: UpdateRecordWithIDQueryParams;
|
3023
3269
|
} & FetcherExtraProps;
|
3024
|
-
declare const updateRecordWithID: (variables: UpdateRecordWithIDVariables) => Promise<RecordUpdateResponse>;
|
3270
|
+
declare const updateRecordWithID: (variables: UpdateRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
3025
3271
|
declare type UpsertRecordWithIDPathParams = {
|
3026
3272
|
/**
|
3027
3273
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3062,7 +3308,7 @@ declare type UpsertRecordWithIDVariables = {
|
|
3062
3308
|
pathParams: UpsertRecordWithIDPathParams;
|
3063
3309
|
queryParams?: UpsertRecordWithIDQueryParams;
|
3064
3310
|
} & FetcherExtraProps;
|
3065
|
-
declare const upsertRecordWithID: (variables: UpsertRecordWithIDVariables) => Promise<RecordUpdateResponse>;
|
3311
|
+
declare const upsertRecordWithID: (variables: UpsertRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
3066
3312
|
declare type DeleteRecordPathParams = {
|
3067
3313
|
/**
|
3068
3314
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3098,7 +3344,7 @@ declare type DeleteRecordVariables = {
|
|
3098
3344
|
pathParams: DeleteRecordPathParams;
|
3099
3345
|
queryParams?: DeleteRecordQueryParams;
|
3100
3346
|
} & FetcherExtraProps;
|
3101
|
-
declare const deleteRecord: (variables: DeleteRecordVariables) => Promise<XataRecord$1>;
|
3347
|
+
declare const deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
|
3102
3348
|
declare type GetRecordPathParams = {
|
3103
3349
|
/**
|
3104
3350
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3137,7 +3383,7 @@ declare type GetRecordVariables = {
|
|
3137
3383
|
/**
|
3138
3384
|
* Retrieve record by ID
|
3139
3385
|
*/
|
3140
|
-
declare const getRecord: (variables: GetRecordVariables) => Promise<XataRecord$1>;
|
3386
|
+
declare const getRecord: (variables: GetRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
|
3141
3387
|
declare type BulkInsertTableRecordsPathParams = {
|
3142
3388
|
/**
|
3143
3389
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3179,7 +3425,7 @@ declare type BulkInsertTableRecordsVariables = {
|
|
3179
3425
|
/**
|
3180
3426
|
* Bulk insert records
|
3181
3427
|
*/
|
3182
|
-
declare const bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables) => Promise<BulkInsertResponse>;
|
3428
|
+
declare const bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal) => Promise<BulkInsertResponse>;
|
3183
3429
|
declare type QueryTablePathParams = {
|
3184
3430
|
/**
|
3185
3431
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3945,7 +4191,7 @@ declare type QueryTableVariables = {
|
|
3945
4191
|
* }
|
3946
4192
|
* ```
|
3947
4193
|
*/
|
3948
|
-
declare const queryTable: (variables: QueryTableVariables) => Promise<QueryResponse>;
|
4194
|
+
declare const queryTable: (variables: QueryTableVariables, signal?: AbortSignal) => Promise<QueryResponse>;
|
3949
4195
|
declare type SearchTablePathParams = {
|
3950
4196
|
/**
|
3951
4197
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3992,7 +4238,7 @@ declare type SearchTableVariables = {
|
|
3992
4238
|
* * filters `$contains`, `$startsWith`, `$endsWith` don't work on columns of type `text`
|
3993
4239
|
* * filtering on columns of type `multiple` is currently unsupported
|
3994
4240
|
*/
|
3995
|
-
declare const searchTable: (variables: SearchTableVariables) => Promise<SearchResponse>;
|
4241
|
+
declare const searchTable: (variables: SearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
3996
4242
|
declare type SearchBranchPathParams = {
|
3997
4243
|
/**
|
3998
4244
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -4040,7 +4286,7 @@ declare type SearchBranchVariables = {
|
|
4040
4286
|
/**
|
4041
4287
|
* Run a free text search operation across the database branch.
|
4042
4288
|
*/
|
4043
|
-
declare const searchBranch: (variables: SearchBranchVariables) => Promise<SearchResponse>;
|
4289
|
+
declare const searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
4044
4290
|
declare type SummarizeTablePathParams = {
|
4045
4291
|
/**
|
4046
4292
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -4063,10 +4309,11 @@ declare type SummarizeTableError = ErrorWrapper<{
|
|
4063
4309
|
payload: SimpleError;
|
4064
4310
|
}>;
|
4065
4311
|
declare type SummarizeTableRequestBody = {
|
4066
|
-
|
4312
|
+
filter?: FilterExpression;
|
4067
4313
|
columns?: ColumnsProjection;
|
4068
4314
|
summaries?: SummaryExpressionList;
|
4069
4315
|
sort?: SortExpression;
|
4316
|
+
summariesFilter?: FilterExpression;
|
4070
4317
|
};
|
4071
4318
|
declare type SummarizeTableVariables = {
|
4072
4319
|
body?: SummarizeTableRequestBody;
|
@@ -4074,135 +4321,356 @@ declare type SummarizeTableVariables = {
|
|
4074
4321
|
} & FetcherExtraProps;
|
4075
4322
|
/**
|
4076
4323
|
* This endpoint allows you to (optionally) define groups, and then to run
|
4077
|
-
* calculations on the values in each group. This is most helpful when
|
4078
|
-
* like to understand the data you have in your database.
|
4324
|
+
* calculations on the values in each group. This is most helpful when
|
4325
|
+
* you'd like to understand the data you have in your database.
|
4079
4326
|
*
|
4080
|
-
* A group is a combination of unique values. If you create a group for
|
4081
|
-
* `product_name`, we will return one row for every combination
|
4082
|
-
* `product_name` you have in your database. When you
|
4083
|
-
* you define these groups and ask Xata to
|
4327
|
+
* A group is a combination of unique values. If you create a group for
|
4328
|
+
* `sold_by`, `product_name`, we will return one row for every combination
|
4329
|
+
* of `sold_by` and `product_name` you have in your database. When you
|
4330
|
+
* want to calculate statistics, you define these groups and ask Xata to
|
4331
|
+
* calculate data on each group.
|
4084
4332
|
*
|
4085
4333
|
* **Some questions you can ask of your data:**
|
4086
4334
|
*
|
4087
4335
|
* How many records do I have in this table?
|
4088
|
-
* - Set `columns: []` as we we want data from the entire table, so we ask
|
4089
|
-
*
|
4090
|
-
*
|
4091
|
-
*
|
4092
|
-
*
|
4093
|
-
*
|
4094
|
-
*
|
4095
|
-
*
|
4096
|
-
*
|
4097
|
-
*
|
4098
|
-
*
|
4099
|
-
*
|
4100
|
-
*
|
4101
|
-
* - Set `
|
4102
|
-
*
|
4103
|
-
*
|
4104
|
-
*
|
4105
|
-
* a
|
4336
|
+
* - Set `columns: []` as we we want data from the entire table, so we ask
|
4337
|
+
* for no groups.
|
4338
|
+
* - Set `summaries: {"total": {"count": "*"}}` in order to see the count
|
4339
|
+
* of all records. We use `count: *` here we'd like to know the total
|
4340
|
+
* amount of rows; ignoring whether they are `null` or not.
|
4341
|
+
*
|
4342
|
+
* What are the top total sales for each product in July 2022 and sold
|
4343
|
+
* more than 10 units?
|
4344
|
+
* - Set `filter: {soldAt: {
|
4345
|
+
* "$ge": "2022-07-01T00:00:00.000Z",
|
4346
|
+
* "$lt": "2022-08-01T00:00:00.000Z"}
|
4347
|
+
* }`
|
4348
|
+
* in order to limit the result set to sales recorded in July 2022.
|
4349
|
+
* - Set `columns: [product_name]` as we'd like to run calculations on
|
4350
|
+
* each unique product name in our table. Setting `columns` like this will
|
4351
|
+
* produce one row per unique product name.
|
4352
|
+
* - Set `summaries: {"total_sales": {"count": "product_name"}}` as we'd
|
4353
|
+
* like to create a field called "total_sales" for each group. This field
|
4354
|
+
* will count all rows in each group with non-null product names.
|
4355
|
+
* - Set `sort: [{"total_sales": "desc"}]` in order to bring the rows with
|
4356
|
+
* the highest total_sales field to the top.
|
4357
|
+
* - Set `summariesFilter: {"total_sales": {"$ge": 10}}` to only send back data
|
4358
|
+
* with greater than or equal to 10 units.
|
4359
|
+
*
|
4360
|
+
* `columns`: tells Xata how to create each group. If you add `product_id`
|
4361
|
+
* we will create a new group for every unique `product_id`.
|
4106
4362
|
*
|
4107
4363
|
* `summaries`: tells Xata which calculations to run on each group.
|
4108
4364
|
*
|
4109
|
-
* `sort`: tells Xata in which order you'd like to see results. You may
|
4110
|
-
* specified in `columns` as well as the summary names
|
4365
|
+
* `sort`: tells Xata in which order you'd like to see results. You may
|
4366
|
+
* sort by fields specified in `columns` as well as the summary names
|
4367
|
+
* defined in `summaries`.
|
4368
|
+
*
|
4369
|
+
* note: Sorting on summarized values can be slower on very large tables;
|
4370
|
+
* this will impact your rate limit significantly more than other queries.
|
4371
|
+
* Try use `filter` [coming soon] to reduce the amount of data being
|
4372
|
+
* processed in order to reduce impact on your limits.
|
4373
|
+
*
|
4374
|
+
* `summariesFilter`: tells Xata how to filter the results of a summary.
|
4375
|
+
* It has the same syntax as `filter`, however, by using `summariesFilter`
|
4376
|
+
* you may also filter on the results of a query.
|
4111
4377
|
*
|
4112
|
-
* note:
|
4113
|
-
*
|
4114
|
-
*
|
4378
|
+
* note: This is a much slower to use than `filter`. We recommend using
|
4379
|
+
* `filter` wherever possible and `summariesFilter` when it's not
|
4380
|
+
* possible to use `filter`.
|
4381
|
+
*/
|
4382
|
+
declare const summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal) => Promise<SummarizeResponse>;
|
4383
|
+
declare type AggregateTablePathParams = {
|
4384
|
+
/**
|
4385
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4386
|
+
*/
|
4387
|
+
dbBranchName: DBBranchName;
|
4388
|
+
/**
|
4389
|
+
* The Table name
|
4390
|
+
*/
|
4391
|
+
tableName: TableName;
|
4392
|
+
workspace: string;
|
4393
|
+
};
|
4394
|
+
declare type AggregateTableError = ErrorWrapper<{
|
4395
|
+
status: 400;
|
4396
|
+
payload: BadRequestError;
|
4397
|
+
} | {
|
4398
|
+
status: 401;
|
4399
|
+
payload: AuthError;
|
4400
|
+
} | {
|
4401
|
+
status: 404;
|
4402
|
+
payload: SimpleError;
|
4403
|
+
}>;
|
4404
|
+
declare type AggregateTableRequestBody = {
|
4405
|
+
filter?: FilterExpression;
|
4406
|
+
aggs?: AggExpressionMap;
|
4407
|
+
};
|
4408
|
+
declare type AggregateTableVariables = {
|
4409
|
+
body?: AggregateTableRequestBody;
|
4410
|
+
pathParams: AggregateTablePathParams;
|
4411
|
+
} & FetcherExtraProps;
|
4412
|
+
/**
|
4413
|
+
* This endpoint allows you to run aggragations (analytics) on the data from one table.
|
4414
|
+
* While the summary endpoint is served from a transactional store and the results are strongly
|
4415
|
+
* consistent, the aggregate endpoint is served from our columnar store and the results are
|
4416
|
+
* only eventually consistent. On the other hand, the aggregate endpoint uses a
|
4417
|
+
* store that is more appropiate for analytics, makes use of approximative algorithms
|
4418
|
+
* (e.g for cardinality), and is generally faster and can do more complex aggregations.
|
4419
|
+
*/
|
4420
|
+
declare const aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal) => Promise<AggResponse>;
|
4421
|
+
declare type CPGetDatabaseListPathParams = {
|
4422
|
+
/**
|
4423
|
+
* Workspace ID
|
4424
|
+
*/
|
4425
|
+
workspaceId: WorkspaceID;
|
4426
|
+
};
|
4427
|
+
declare type CPGetDatabaseListError = ErrorWrapper<{
|
4428
|
+
status: 400;
|
4429
|
+
payload: BadRequestError;
|
4430
|
+
} | {
|
4431
|
+
status: 401;
|
4432
|
+
payload: AuthError;
|
4433
|
+
}>;
|
4434
|
+
declare type CPGetDatabaseListVariables = {
|
4435
|
+
pathParams: CPGetDatabaseListPathParams;
|
4436
|
+
} & FetcherExtraProps;
|
4437
|
+
/**
|
4438
|
+
* List all databases available in your Workspace.
|
4439
|
+
*/
|
4440
|
+
declare const cPGetDatabaseList: (variables: CPGetDatabaseListVariables, signal?: AbortSignal) => Promise<CPListDatabasesResponse>;
|
4441
|
+
declare type CPCreateDatabasePathParams = {
|
4442
|
+
/**
|
4443
|
+
* Workspace ID
|
4444
|
+
*/
|
4445
|
+
workspaceId: WorkspaceID;
|
4446
|
+
/**
|
4447
|
+
* The Database Name
|
4448
|
+
*/
|
4449
|
+
dbName: DBName;
|
4450
|
+
};
|
4451
|
+
declare type CPCreateDatabaseError = ErrorWrapper<{
|
4452
|
+
status: 400;
|
4453
|
+
payload: BadRequestError;
|
4454
|
+
} | {
|
4455
|
+
status: 401;
|
4456
|
+
payload: AuthError;
|
4457
|
+
}>;
|
4458
|
+
declare type CPCreateDatabaseResponse = {
|
4459
|
+
/**
|
4460
|
+
* @minLength 1
|
4461
|
+
*/
|
4462
|
+
databaseName?: string;
|
4463
|
+
branchName?: string;
|
4464
|
+
};
|
4465
|
+
declare type CPCreateDatabaseRequestBody = {
|
4466
|
+
/**
|
4467
|
+
* @minLength 1
|
4468
|
+
*/
|
4469
|
+
branchName?: string;
|
4470
|
+
/**
|
4471
|
+
* @minLength 1
|
4472
|
+
*/
|
4473
|
+
region: string;
|
4474
|
+
ui?: {
|
4475
|
+
color?: string;
|
4476
|
+
};
|
4477
|
+
metadata?: BranchMetadata;
|
4478
|
+
};
|
4479
|
+
declare type CPCreateDatabaseVariables = {
|
4480
|
+
body: CPCreateDatabaseRequestBody;
|
4481
|
+
pathParams: CPCreateDatabasePathParams;
|
4482
|
+
} & FetcherExtraProps;
|
4483
|
+
/**
|
4484
|
+
* Create Database with identifier name
|
4485
|
+
*/
|
4486
|
+
declare const cPCreateDatabase: (variables: CPCreateDatabaseVariables, signal?: AbortSignal) => Promise<CPCreateDatabaseResponse>;
|
4487
|
+
declare type CPDeleteDatabasePathParams = {
|
4488
|
+
/**
|
4489
|
+
* Workspace ID
|
4490
|
+
*/
|
4491
|
+
workspaceId: WorkspaceID;
|
4492
|
+
/**
|
4493
|
+
* The Database Name
|
4494
|
+
*/
|
4495
|
+
dbName: DBName;
|
4496
|
+
};
|
4497
|
+
declare type CPDeleteDatabaseError = ErrorWrapper<{
|
4498
|
+
status: 400;
|
4499
|
+
payload: BadRequestError;
|
4500
|
+
} | {
|
4501
|
+
status: 401;
|
4502
|
+
payload: AuthError;
|
4503
|
+
} | {
|
4504
|
+
status: 404;
|
4505
|
+
payload: SimpleError;
|
4506
|
+
}>;
|
4507
|
+
declare type CPDeleteDatabaseVariables = {
|
4508
|
+
pathParams: CPDeleteDatabasePathParams;
|
4509
|
+
} & FetcherExtraProps;
|
4510
|
+
/**
|
4511
|
+
* Delete a database and all of its branches and tables permanently.
|
4115
4512
|
*/
|
4116
|
-
declare const
|
4513
|
+
declare const cPDeleteDatabase: (variables: CPDeleteDatabaseVariables, signal?: AbortSignal) => Promise<undefined>;
|
4514
|
+
declare type CPGetCPDatabaseMetadataPathParams = {
|
4515
|
+
/**
|
4516
|
+
* Workspace ID
|
4517
|
+
*/
|
4518
|
+
workspaceId: WorkspaceID;
|
4519
|
+
/**
|
4520
|
+
* The Database Name
|
4521
|
+
*/
|
4522
|
+
dbName: DBName;
|
4523
|
+
};
|
4524
|
+
declare type CPGetCPDatabaseMetadataError = ErrorWrapper<{
|
4525
|
+
status: 400;
|
4526
|
+
payload: BadRequestError;
|
4527
|
+
} | {
|
4528
|
+
status: 401;
|
4529
|
+
payload: AuthError;
|
4530
|
+
} | {
|
4531
|
+
status: 404;
|
4532
|
+
payload: SimpleError;
|
4533
|
+
}>;
|
4534
|
+
declare type CPGetCPDatabaseMetadataVariables = {
|
4535
|
+
pathParams: CPGetCPDatabaseMetadataPathParams;
|
4536
|
+
} & FetcherExtraProps;
|
4537
|
+
/**
|
4538
|
+
* Retrieve metadata of the given database
|
4539
|
+
*/
|
4540
|
+
declare const cPGetCPDatabaseMetadata: (variables: CPGetCPDatabaseMetadataVariables, signal?: AbortSignal) => Promise<CPDatabaseMetadata>;
|
4541
|
+
declare type CPUpdateCPDatabaseMetadataPathParams = {
|
4542
|
+
/**
|
4543
|
+
* Workspace ID
|
4544
|
+
*/
|
4545
|
+
workspaceId: WorkspaceID;
|
4546
|
+
/**
|
4547
|
+
* The Database Name
|
4548
|
+
*/
|
4549
|
+
dbName: DBName;
|
4550
|
+
};
|
4551
|
+
declare type CPUpdateCPDatabaseMetadataError = ErrorWrapper<{
|
4552
|
+
status: 400;
|
4553
|
+
payload: BadRequestError;
|
4554
|
+
} | {
|
4555
|
+
status: 401;
|
4556
|
+
payload: AuthError;
|
4557
|
+
} | {
|
4558
|
+
status: 404;
|
4559
|
+
payload: SimpleError;
|
4560
|
+
}>;
|
4561
|
+
declare type CPUpdateCPDatabaseMetadataRequestBody = {
|
4562
|
+
ui?: {
|
4563
|
+
/**
|
4564
|
+
* @minLength 1
|
4565
|
+
*/
|
4566
|
+
color?: string;
|
4567
|
+
};
|
4568
|
+
};
|
4569
|
+
declare type CPUpdateCPDatabaseMetadataVariables = {
|
4570
|
+
body?: CPUpdateCPDatabaseMetadataRequestBody;
|
4571
|
+
pathParams: CPUpdateCPDatabaseMetadataPathParams;
|
4572
|
+
} & FetcherExtraProps;
|
4573
|
+
/**
|
4574
|
+
* Update the color of the selected database
|
4575
|
+
*/
|
4576
|
+
declare const cPUpdateCPDatabaseMetadata: (variables: CPUpdateCPDatabaseMetadataVariables, signal?: AbortSignal) => Promise<CPDatabaseMetadata>;
|
4117
4577
|
declare const operationsByTag: {
|
4118
4578
|
users: {
|
4119
|
-
getUser: (variables: GetUserVariables) => Promise<UserWithID>;
|
4120
|
-
updateUser: (variables: UpdateUserVariables) => Promise<UserWithID>;
|
4121
|
-
deleteUser: (variables: DeleteUserVariables) => Promise<undefined>;
|
4122
|
-
getUserAPIKeys: (variables: GetUserAPIKeysVariables) => Promise<GetUserAPIKeysResponse>;
|
4123
|
-
createUserAPIKey: (variables: CreateUserAPIKeyVariables) => Promise<CreateUserAPIKeyResponse>;
|
4124
|
-
deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables) => Promise<undefined>;
|
4579
|
+
getUser: (variables: GetUserVariables, signal?: AbortSignal) => Promise<UserWithID>;
|
4580
|
+
updateUser: (variables: UpdateUserVariables, signal?: AbortSignal) => Promise<UserWithID>;
|
4581
|
+
deleteUser: (variables: DeleteUserVariables, signal?: AbortSignal) => Promise<undefined>;
|
4582
|
+
getUserAPIKeys: (variables: GetUserAPIKeysVariables, signal?: AbortSignal) => Promise<GetUserAPIKeysResponse>;
|
4583
|
+
createUserAPIKey: (variables: CreateUserAPIKeyVariables, signal?: AbortSignal) => Promise<CreateUserAPIKeyResponse>;
|
4584
|
+
deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal) => Promise<undefined>;
|
4125
4585
|
};
|
4126
4586
|
workspaces: {
|
4127
|
-
createWorkspace: (variables: CreateWorkspaceVariables) => Promise<Workspace>;
|
4128
|
-
getWorkspacesList: (variables: GetWorkspacesListVariables) => Promise<GetWorkspacesListResponse>;
|
4129
|
-
getWorkspace: (variables: GetWorkspaceVariables) => Promise<Workspace>;
|
4130
|
-
updateWorkspace: (variables: UpdateWorkspaceVariables) => Promise<Workspace>;
|
4131
|
-
deleteWorkspace: (variables: DeleteWorkspaceVariables) => Promise<undefined>;
|
4132
|
-
getWorkspaceMembersList: (variables: GetWorkspaceMembersListVariables) => Promise<WorkspaceMembers>;
|
4133
|
-
updateWorkspaceMemberRole: (variables: UpdateWorkspaceMemberRoleVariables) => Promise<undefined>;
|
4134
|
-
removeWorkspaceMember: (variables: RemoveWorkspaceMemberVariables) => Promise<undefined>;
|
4135
|
-
inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables) => Promise<WorkspaceInvite>;
|
4136
|
-
updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables) => Promise<WorkspaceInvite>;
|
4137
|
-
cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables) => Promise<undefined>;
|
4138
|
-
resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables) => Promise<undefined>;
|
4139
|
-
acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables) => Promise<undefined>;
|
4587
|
+
createWorkspace: (variables: CreateWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
4588
|
+
getWorkspacesList: (variables: GetWorkspacesListVariables, signal?: AbortSignal) => Promise<GetWorkspacesListResponse>;
|
4589
|
+
getWorkspace: (variables: GetWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
4590
|
+
updateWorkspace: (variables: UpdateWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
4591
|
+
deleteWorkspace: (variables: DeleteWorkspaceVariables, signal?: AbortSignal) => Promise<undefined>;
|
4592
|
+
getWorkspaceMembersList: (variables: GetWorkspaceMembersListVariables, signal?: AbortSignal) => Promise<WorkspaceMembers>;
|
4593
|
+
updateWorkspaceMemberRole: (variables: UpdateWorkspaceMemberRoleVariables, signal?: AbortSignal) => Promise<undefined>;
|
4594
|
+
removeWorkspaceMember: (variables: RemoveWorkspaceMemberVariables, signal?: AbortSignal) => Promise<undefined>;
|
4595
|
+
inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables, signal?: AbortSignal) => Promise<WorkspaceInvite>;
|
4596
|
+
updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<WorkspaceInvite>;
|
4597
|
+
cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
4598
|
+
resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
4599
|
+
acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
4140
4600
|
};
|
4141
4601
|
database: {
|
4142
|
-
getDatabaseList: (variables: GetDatabaseListVariables) => Promise<ListDatabasesResponse>;
|
4143
|
-
createDatabase: (variables: CreateDatabaseVariables) => Promise<CreateDatabaseResponse>;
|
4144
|
-
deleteDatabase: (variables: DeleteDatabaseVariables) => Promise<undefined>;
|
4145
|
-
getDatabaseMetadata: (variables: GetDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
|
4146
|
-
updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
|
4147
|
-
getGitBranchesMapping: (variables: GetGitBranchesMappingVariables) => Promise<ListGitBranchesResponse>;
|
4148
|
-
addGitBranchesEntry: (variables: AddGitBranchesEntryVariables) => Promise<AddGitBranchesEntryResponse>;
|
4149
|
-
removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables) => Promise<undefined>;
|
4150
|
-
resolveBranch: (variables: ResolveBranchVariables) => Promise<ResolveBranchResponse>;
|
4602
|
+
getDatabaseList: (variables: GetDatabaseListVariables, signal?: AbortSignal) => Promise<ListDatabasesResponse>;
|
4603
|
+
createDatabase: (variables: CreateDatabaseVariables, signal?: AbortSignal) => Promise<CreateDatabaseResponse>;
|
4604
|
+
deleteDatabase: (variables: DeleteDatabaseVariables, signal?: AbortSignal) => Promise<undefined>;
|
4605
|
+
getDatabaseMetadata: (variables: GetDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
4606
|
+
updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
4607
|
+
getGitBranchesMapping: (variables: GetGitBranchesMappingVariables, signal?: AbortSignal) => Promise<ListGitBranchesResponse>;
|
4608
|
+
addGitBranchesEntry: (variables: AddGitBranchesEntryVariables, signal?: AbortSignal) => Promise<AddGitBranchesEntryResponse>;
|
4609
|
+
removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables, signal?: AbortSignal) => Promise<undefined>;
|
4610
|
+
resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal) => Promise<ResolveBranchResponse>;
|
4151
4611
|
};
|
4152
4612
|
branch: {
|
4153
|
-
getBranchList: (variables: GetBranchListVariables) => Promise<ListBranchesResponse>;
|
4154
|
-
getBranchDetails: (variables: GetBranchDetailsVariables) => Promise<DBBranch>;
|
4155
|
-
createBranch: (variables: CreateBranchVariables) => Promise<CreateBranchResponse>;
|
4156
|
-
deleteBranch: (variables: DeleteBranchVariables) => Promise<undefined>;
|
4157
|
-
updateBranchMetadata: (variables: UpdateBranchMetadataVariables) => Promise<undefined>;
|
4158
|
-
getBranchMetadata: (variables: GetBranchMetadataVariables) => Promise<BranchMetadata>;
|
4159
|
-
getBranchStats: (variables: GetBranchStatsVariables) => Promise<GetBranchStatsResponse>;
|
4613
|
+
getBranchList: (variables: GetBranchListVariables, signal?: AbortSignal) => Promise<ListBranchesResponse>;
|
4614
|
+
getBranchDetails: (variables: GetBranchDetailsVariables, signal?: AbortSignal) => Promise<DBBranch>;
|
4615
|
+
createBranch: (variables: CreateBranchVariables, signal?: AbortSignal) => Promise<CreateBranchResponse>;
|
4616
|
+
deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal) => Promise<undefined>;
|
4617
|
+
updateBranchMetadata: (variables: UpdateBranchMetadataVariables, signal?: AbortSignal) => Promise<undefined>;
|
4618
|
+
getBranchMetadata: (variables: GetBranchMetadataVariables, signal?: AbortSignal) => Promise<BranchMetadata>;
|
4619
|
+
getBranchStats: (variables: GetBranchStatsVariables, signal?: AbortSignal) => Promise<GetBranchStatsResponse>;
|
4160
4620
|
};
|
4161
4621
|
migrationRequests: {
|
4162
|
-
queryMigrationRequests: (variables: QueryMigrationRequestsVariables) => Promise<QueryMigrationRequestsResponse>;
|
4163
|
-
createMigrationRequest: (variables: CreateMigrationRequestVariables) => Promise<CreateMigrationRequestResponse>;
|
4164
|
-
getMigrationRequest: (variables: GetMigrationRequestVariables) => Promise<MigrationRequest>;
|
4165
|
-
updateMigrationRequest: (variables: UpdateMigrationRequestVariables) => Promise<undefined>;
|
4166
|
-
listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables) => Promise<ListMigrationRequestsCommitsResponse>;
|
4167
|
-
compareMigrationRequest: (variables: CompareMigrationRequestVariables) => Promise<SchemaCompareResponse>;
|
4168
|
-
getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables) => Promise<GetMigrationRequestIsMergedResponse>;
|
4169
|
-
mergeMigrationRequest: (variables: MergeMigrationRequestVariables) => Promise<Commit>;
|
4622
|
+
queryMigrationRequests: (variables: QueryMigrationRequestsVariables, signal?: AbortSignal) => Promise<QueryMigrationRequestsResponse>;
|
4623
|
+
createMigrationRequest: (variables: CreateMigrationRequestVariables, signal?: AbortSignal) => Promise<CreateMigrationRequestResponse>;
|
4624
|
+
getMigrationRequest: (variables: GetMigrationRequestVariables, signal?: AbortSignal) => Promise<MigrationRequest>;
|
4625
|
+
updateMigrationRequest: (variables: UpdateMigrationRequestVariables, signal?: AbortSignal) => Promise<undefined>;
|
4626
|
+
listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables, signal?: AbortSignal) => Promise<ListMigrationRequestsCommitsResponse>;
|
4627
|
+
compareMigrationRequest: (variables: CompareMigrationRequestVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
4628
|
+
getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables, signal?: AbortSignal) => Promise<GetMigrationRequestIsMergedResponse>;
|
4629
|
+
mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal) => Promise<Commit>;
|
4170
4630
|
};
|
4171
4631
|
branchSchema: {
|
4172
|
-
getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables) => Promise<GetBranchMigrationHistoryResponse>;
|
4173
|
-
executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables) => Promise<undefined>;
|
4174
|
-
getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables) => Promise<BranchMigrationPlan>;
|
4175
|
-
compareBranchWithUserSchema: (variables: CompareBranchWithUserSchemaVariables) => Promise<SchemaCompareResponse>;
|
4176
|
-
compareBranchSchemas: (variables: CompareBranchSchemasVariables) => Promise<SchemaCompareResponse>;
|
4177
|
-
updateBranchSchema: (variables: UpdateBranchSchemaVariables) => Promise<UpdateBranchSchemaResponse>;
|
4178
|
-
previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables) => Promise<PreviewBranchSchemaEditResponse>;
|
4179
|
-
applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables) => Promise<ApplyBranchSchemaEditResponse>;
|
4180
|
-
getBranchSchemaHistory: (variables: GetBranchSchemaHistoryVariables) => Promise<GetBranchSchemaHistoryResponse>;
|
4632
|
+
getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal) => Promise<GetBranchMigrationHistoryResponse>;
|
4633
|
+
executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<undefined>;
|
4634
|
+
getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<BranchMigrationPlan>;
|
4635
|
+
compareBranchWithUserSchema: (variables: CompareBranchWithUserSchemaVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
4636
|
+
compareBranchSchemas: (variables: CompareBranchSchemasVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
4637
|
+
updateBranchSchema: (variables: UpdateBranchSchemaVariables, signal?: AbortSignal) => Promise<UpdateBranchSchemaResponse>;
|
4638
|
+
previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables, signal?: AbortSignal) => Promise<PreviewBranchSchemaEditResponse>;
|
4639
|
+
applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal) => Promise<ApplyBranchSchemaEditResponse>;
|
4640
|
+
getBranchSchemaHistory: (variables: GetBranchSchemaHistoryVariables, signal?: AbortSignal) => Promise<GetBranchSchemaHistoryResponse>;
|
4181
4641
|
};
|
4182
4642
|
table: {
|
4183
|
-
createTable: (variables: CreateTableVariables) => Promise<CreateTableResponse>;
|
4184
|
-
deleteTable: (variables: DeleteTableVariables) => Promise<undefined>;
|
4185
|
-
updateTable: (variables: UpdateTableVariables) => Promise<undefined>;
|
4186
|
-
getTableSchema: (variables: GetTableSchemaVariables) => Promise<GetTableSchemaResponse>;
|
4187
|
-
setTableSchema: (variables: SetTableSchemaVariables) => Promise<undefined>;
|
4188
|
-
getTableColumns: (variables: GetTableColumnsVariables) => Promise<GetTableColumnsResponse>;
|
4189
|
-
addTableColumn: (variables: AddTableColumnVariables) => Promise<MigrationIdResponse>;
|
4190
|
-
getColumn: (variables: GetColumnVariables) => Promise<Column>;
|
4191
|
-
deleteColumn: (variables: DeleteColumnVariables) => Promise<MigrationIdResponse>;
|
4192
|
-
updateColumn: (variables: UpdateColumnVariables) => Promise<MigrationIdResponse>;
|
4643
|
+
createTable: (variables: CreateTableVariables, signal?: AbortSignal) => Promise<CreateTableResponse>;
|
4644
|
+
deleteTable: (variables: DeleteTableVariables, signal?: AbortSignal) => Promise<undefined>;
|
4645
|
+
updateTable: (variables: UpdateTableVariables, signal?: AbortSignal) => Promise<undefined>;
|
4646
|
+
getTableSchema: (variables: GetTableSchemaVariables, signal?: AbortSignal) => Promise<GetTableSchemaResponse>;
|
4647
|
+
setTableSchema: (variables: SetTableSchemaVariables, signal?: AbortSignal) => Promise<undefined>;
|
4648
|
+
getTableColumns: (variables: GetTableColumnsVariables, signal?: AbortSignal) => Promise<GetTableColumnsResponse>;
|
4649
|
+
addTableColumn: (variables: AddTableColumnVariables, signal?: AbortSignal) => Promise<MigrationIdResponse>;
|
4650
|
+
getColumn: (variables: GetColumnVariables, signal?: AbortSignal) => Promise<Column>;
|
4651
|
+
deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal) => Promise<MigrationIdResponse>;
|
4652
|
+
updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal) => Promise<MigrationIdResponse>;
|
4193
4653
|
};
|
4194
4654
|
records: {
|
4195
|
-
insertRecord: (variables: InsertRecordVariables) => Promise<RecordUpdateResponse>;
|
4196
|
-
insertRecordWithID: (variables: InsertRecordWithIDVariables) => Promise<RecordUpdateResponse>;
|
4197
|
-
updateRecordWithID: (variables: UpdateRecordWithIDVariables) => Promise<RecordUpdateResponse>;
|
4198
|
-
upsertRecordWithID: (variables: UpsertRecordWithIDVariables) => Promise<RecordUpdateResponse>;
|
4199
|
-
deleteRecord: (variables: DeleteRecordVariables) => Promise<XataRecord$1>;
|
4200
|
-
getRecord: (variables: GetRecordVariables) => Promise<XataRecord$1>;
|
4201
|
-
bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables) => Promise<BulkInsertResponse>;
|
4202
|
-
queryTable: (variables: QueryTableVariables) => Promise<QueryResponse>;
|
4203
|
-
searchTable: (variables: SearchTableVariables) => Promise<SearchResponse>;
|
4204
|
-
searchBranch: (variables: SearchBranchVariables) => Promise<SearchResponse>;
|
4205
|
-
summarizeTable: (variables: SummarizeTableVariables) => Promise<SummarizeResponse>;
|
4655
|
+
insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
4656
|
+
insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
4657
|
+
updateRecordWithID: (variables: UpdateRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
4658
|
+
upsertRecordWithID: (variables: UpsertRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
4659
|
+
deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
|
4660
|
+
getRecord: (variables: GetRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
|
4661
|
+
bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal) => Promise<BulkInsertResponse>;
|
4662
|
+
queryTable: (variables: QueryTableVariables, signal?: AbortSignal) => Promise<QueryResponse>;
|
4663
|
+
searchTable: (variables: SearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
4664
|
+
searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
4665
|
+
summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal) => Promise<SummarizeResponse>;
|
4666
|
+
aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal) => Promise<AggResponse>;
|
4667
|
+
};
|
4668
|
+
databases: {
|
4669
|
+
cPGetDatabaseList: (variables: CPGetDatabaseListVariables, signal?: AbortSignal) => Promise<CPListDatabasesResponse>;
|
4670
|
+
cPCreateDatabase: (variables: CPCreateDatabaseVariables, signal?: AbortSignal) => Promise<CPCreateDatabaseResponse>;
|
4671
|
+
cPDeleteDatabase: (variables: CPDeleteDatabaseVariables, signal?: AbortSignal) => Promise<undefined>;
|
4672
|
+
cPGetCPDatabaseMetadata: (variables: CPGetCPDatabaseMetadataVariables, signal?: AbortSignal) => Promise<CPDatabaseMetadata>;
|
4673
|
+
cPUpdateCPDatabaseMetadata: (variables: CPUpdateCPDatabaseMetadataVariables, signal?: AbortSignal) => Promise<CPDatabaseMetadata>;
|
4206
4674
|
};
|
4207
4675
|
};
|
4208
4676
|
|
@@ -4212,6 +4680,10 @@ declare type ProviderBuilder = {
|
|
4212
4680
|
workspaces: string;
|
4213
4681
|
};
|
4214
4682
|
declare type HostProvider = HostAliases | ProviderBuilder;
|
4683
|
+
declare function getHostUrl(provider: HostProvider, type: keyof ProviderBuilder): string;
|
4684
|
+
declare function isHostProviderAlias(alias: HostProvider | string): alias is HostAliases;
|
4685
|
+
declare function isHostProviderBuilder(builder: HostProvider): builder is ProviderBuilder;
|
4686
|
+
declare function parseProviderString(provider?: string): HostProvider | null;
|
4215
4687
|
|
4216
4688
|
interface XataApiClientOptions {
|
4217
4689
|
fetch?: FetchImpl;
|
@@ -4310,6 +4782,7 @@ declare class RecordsApi {
|
|
4310
4782
|
searchTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: SearchTableRequestBody): Promise<SearchResponse>;
|
4311
4783
|
searchBranch(workspace: WorkspaceID, database: DBName, branch: BranchName, query: SearchBranchRequestBody): Promise<SearchResponse>;
|
4312
4784
|
summarizeTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: SummarizeTableRequestBody): Promise<SummarizeResponse>;
|
4785
|
+
aggregateTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: AggregateTableRequestBody): Promise<AggResponse>;
|
4313
4786
|
}
|
4314
4787
|
declare class MigrationRequestsApi {
|
4315
4788
|
private extraProps;
|
@@ -4352,13 +4825,28 @@ declare type RequiredBy<T, K extends keyof T> = T & {
|
|
4352
4825
|
};
|
4353
4826
|
declare type GetArrayInnerType<T extends readonly any[]> = T[number];
|
4354
4827
|
declare type SingleOrArray<T> = T | T[];
|
4828
|
+
declare type Dictionary<T> = Record<string, T>;
|
4355
4829
|
declare type OmitBy<T, K extends keyof T> = T extends any ? Omit<T, K> : never;
|
4356
4830
|
declare type Without<T, U> = {
|
4357
4831
|
[P in Exclude<keyof T, keyof U>]?: never;
|
4358
4832
|
};
|
4359
4833
|
declare type ExclusiveOr<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
|
4834
|
+
declare type Explode<T> = keyof T extends infer K ? K extends unknown ? {
|
4835
|
+
[I in keyof T]: I extends K ? T[I] : never;
|
4836
|
+
} : never : never;
|
4837
|
+
declare type AtMostOne<T> = Explode<Partial<T>>;
|
4838
|
+
declare type AtLeastOne<T, U = {
|
4839
|
+
[K in keyof T]: Pick<T, K>;
|
4840
|
+
}> = Partial<T> & U[keyof U];
|
4841
|
+
declare type ExactlyOne<T> = AtMostOne<T> & AtLeastOne<T>;
|
4360
4842
|
|
4361
4843
|
declare type SelectableColumn<O, RecursivePath extends any[] = []> = '*' | 'id' | DataProps<O> | NestedColumns<O, RecursivePath>;
|
4844
|
+
declare type WildcardColumns<O> = Values<{
|
4845
|
+
[K in SelectableColumn<O>]: K extends `${string}*` ? K : never;
|
4846
|
+
}>;
|
4847
|
+
declare type ColumnsByValue<O, Value> = Values<{
|
4848
|
+
[K in SelectableColumn<O>]: ValueAtColumn<O, K> extends infer C ? C extends Value ? K extends WildcardColumns<O> ? never : K : never : never;
|
4849
|
+
}>;
|
4362
4850
|
declare type SelectedPick<O extends XataRecord, Key extends SelectableColumn<O>[]> = XataRecord<O> & UnionToIntersection<Values<{
|
4363
4851
|
[K in Key[number]]: NestedValueAtColumn<O, K> & XataRecord<O>;
|
4364
4852
|
}>>;
|
@@ -4477,7 +4965,7 @@ declare type EditableData<O extends XataRecord> = Identifiable & Omit<{
|
|
4477
4965
|
}
|
4478
4966
|
*/
|
4479
4967
|
declare type PropertyAccessFilter<Record> = {
|
4480
|
-
[key in
|
4968
|
+
[key in ColumnsByValue<Record, any>]?: NestedApiFilter<ValueAtColumn<Record, key>> | PropertyFilter<ValueAtColumn<Record, key>>;
|
4481
4969
|
};
|
4482
4970
|
declare type PropertyFilter<T> = T | {
|
4483
4971
|
$is: T;
|
@@ -4539,7 +5027,7 @@ declare type AggregatorFilter<T> = {
|
|
4539
5027
|
* Example: { filter: { $exists: "settings" } }
|
4540
5028
|
*/
|
4541
5029
|
declare type ExistanceFilter<Record> = {
|
4542
|
-
[key in '$exists' | '$notExists']?:
|
5030
|
+
[key in '$exists' | '$notExists']?: ColumnsByValue<Record, any>;
|
4543
5031
|
};
|
4544
5032
|
declare type BaseApiFilter<Record> = PropertyAccessFilter<Record> | AggregatorFilter<Record> | ExistanceFilter<Record>;
|
4545
5033
|
/**
|
@@ -4646,15 +5134,215 @@ declare type ExtractTables<Schemas extends Record<string, BaseData>, Tables exte
|
|
4646
5134
|
table: infer Table;
|
4647
5135
|
} ? ReturnTable<Table, Tables> : never;
|
4648
5136
|
|
5137
|
+
/**
|
5138
|
+
* The description of a single aggregation operation. The key represents the
|
5139
|
+
*/
|
5140
|
+
declare type AggregationExpression<O extends XataRecord> = ExactlyOne<{
|
5141
|
+
count: CountAggregation<O>;
|
5142
|
+
sum: SumAggregation<O>;
|
5143
|
+
max: MaxAggregation<O>;
|
5144
|
+
min: MinAggregation<O>;
|
5145
|
+
average: AverageAggregation<O>;
|
5146
|
+
uniqueCount: UniqueCountAggregation<O>;
|
5147
|
+
dateHistogram: DateHistogramAggregation<O>;
|
5148
|
+
topValues: TopValuesAggregation<O>;
|
5149
|
+
numericHistogram: NumericHistogramAggregation<O>;
|
5150
|
+
}>;
|
5151
|
+
declare type AggregationResult<Record extends XataRecord, Expression extends Dictionary<AggregationExpression<Record>>> = {
|
5152
|
+
aggs: {
|
5153
|
+
[K in keyof Expression]: AggregationResultItem<Record, Expression[K]>;
|
5154
|
+
};
|
5155
|
+
};
|
5156
|
+
declare type AggregationExpressionType<T extends AggregationExpression<any>> = keyof T;
|
5157
|
+
declare type AggregationResultItem<Record extends XataRecord, Expression extends AggregationExpression<Record>> = AggregationExpressionType<Expression> extends infer Type ? Type extends keyof AggregationExpressionResultTypes ? AggregationExpressionResultTypes[Type] : never : never;
|
5158
|
+
/**
|
5159
|
+
* Count the number of records with an optional filter.
|
5160
|
+
*/
|
5161
|
+
declare type CountAggregation<O extends XataRecord> = {
|
5162
|
+
filter?: Filter<O>;
|
5163
|
+
} | '*';
|
5164
|
+
/**
|
5165
|
+
* The sum of the numeric values in a particular column.
|
5166
|
+
*/
|
5167
|
+
declare type SumAggregation<O extends XataRecord> = {
|
5168
|
+
/**
|
5169
|
+
* The column on which to compute the sum. Must be a numeric type.
|
5170
|
+
*/
|
5171
|
+
column: ColumnsByValue<O, number>;
|
5172
|
+
};
|
5173
|
+
/**
|
5174
|
+
* The max of the numeric values in a particular column.
|
5175
|
+
*/
|
5176
|
+
declare type MaxAggregation<O extends XataRecord> = {
|
5177
|
+
/**
|
5178
|
+
* The column on which to compute the max. Must be a numeric type.
|
5179
|
+
*/
|
5180
|
+
column: ColumnsByValue<O, number>;
|
5181
|
+
};
|
5182
|
+
/**
|
5183
|
+
* The min of the numeric values in a particular column.
|
5184
|
+
*/
|
5185
|
+
declare type MinAggregation<O extends XataRecord> = {
|
5186
|
+
/**
|
5187
|
+
* The column on which to compute the min. Must be a numeric type.
|
5188
|
+
*/
|
5189
|
+
column: ColumnsByValue<O, number>;
|
5190
|
+
};
|
5191
|
+
/**
|
5192
|
+
* The average of the numeric values in a particular column.
|
5193
|
+
*/
|
5194
|
+
declare type AverageAggregation<O extends XataRecord> = {
|
5195
|
+
/**
|
5196
|
+
* The column on which to compute the average. Must be a numeric type.
|
5197
|
+
*/
|
5198
|
+
column: ColumnsByValue<O, number>;
|
5199
|
+
};
|
5200
|
+
/**
|
5201
|
+
* Count the number of distinct values in a particular column.
|
5202
|
+
*/
|
5203
|
+
declare type UniqueCountAggregation<O extends XataRecord> = {
|
5204
|
+
/**
|
5205
|
+
* The column from where to count the unique values.
|
5206
|
+
*/
|
5207
|
+
column: ColumnsByValue<O, any>;
|
5208
|
+
/**
|
5209
|
+
* The threshold under which the unique count is exact. If the number of unique
|
5210
|
+
* values in the column is higher than this threshold, the results are approximative.
|
5211
|
+
* Maximum value is 40,000, default value is 3000.
|
5212
|
+
*/
|
5213
|
+
precisionThreshold?: number;
|
5214
|
+
};
|
5215
|
+
/**
|
5216
|
+
* Split data into buckets by a datetime column. Accepts sub-aggregations for each bucket.
|
5217
|
+
*/
|
5218
|
+
declare type DateHistogramAggregation<O extends XataRecord> = {
|
5219
|
+
/**
|
5220
|
+
* The column to use for bucketing. Must be of type datetime.
|
5221
|
+
*/
|
5222
|
+
column: ColumnsByValue<O, Date>;
|
5223
|
+
/**
|
5224
|
+
* The fixed interval to use when bucketing.
|
5225
|
+
* It is fromatted as number + units, for example: `5d`, `20m`, `10s`.
|
5226
|
+
*
|
5227
|
+
* @pattern ^(\d+)(d|h|m|s|ms)$
|
5228
|
+
*/
|
5229
|
+
interval?: string;
|
5230
|
+
/**
|
5231
|
+
* The calendar-aware interval to use when bucketing. Possible values are: `minute`,
|
5232
|
+
* `hour`, `day`, `week`, `month`, `quarter`, `year`.
|
5233
|
+
*/
|
5234
|
+
calendarInterval?: 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year';
|
5235
|
+
/**
|
5236
|
+
* The timezone to use for bucketing. By default, UTC is assumed.
|
5237
|
+
* The accepted format is as an ISO 8601 UTC offset. For example: `+01:00` or
|
5238
|
+
* `-08:00`.
|
5239
|
+
*
|
5240
|
+
* @pattern ^[+-][01]\d:[0-5]\d$
|
5241
|
+
*/
|
5242
|
+
timezone?: string;
|
5243
|
+
aggs?: Dictionary<AggregationExpression<O>>;
|
5244
|
+
};
|
5245
|
+
/**
|
5246
|
+
* Split data into buckets by the unique values in a column. Accepts sub-aggregations for each bucket.
|
5247
|
+
* The top values as ordered by the number of records (`$count``) are returned.
|
5248
|
+
*/
|
5249
|
+
declare type TopValuesAggregation<O extends XataRecord> = {
|
5250
|
+
/**
|
5251
|
+
* The column to use for bucketing. Accepted types are `string`, `email`, `int`, `float`, or `bool`.
|
5252
|
+
*/
|
5253
|
+
column: ColumnsByValue<O, string | number | boolean>;
|
5254
|
+
aggs?: Dictionary<AggregationExpression<O>>;
|
5255
|
+
/**
|
5256
|
+
* The maximum number of unique values to return.
|
5257
|
+
*
|
5258
|
+
* @default 10
|
5259
|
+
* @maximum 1000
|
5260
|
+
*/
|
5261
|
+
size?: number;
|
5262
|
+
};
|
5263
|
+
/**
|
5264
|
+
* Split data into buckets by dynamic numeric ranges. Accepts sub-aggregations for each bucket.
|
5265
|
+
*/
|
5266
|
+
declare type NumericHistogramAggregation<O extends XataRecord> = {
|
5267
|
+
/**
|
5268
|
+
* The column to use for bucketing. Must be of numeric type.
|
5269
|
+
*/
|
5270
|
+
column: ColumnsByValue<O, number>;
|
5271
|
+
/**
|
5272
|
+
* The numeric interval to use for bucketing. The resulting buckets will be ranges
|
5273
|
+
* with this value as size.
|
5274
|
+
*
|
5275
|
+
* @minimum 0
|
5276
|
+
*/
|
5277
|
+
interval: number;
|
5278
|
+
/**
|
5279
|
+
* By default the bucket keys start with 0 and then continue in `interval` steps. The bucket
|
5280
|
+
* boundaries can be shiftend by using the offset option. For example, if the `interval` is 100,
|
5281
|
+
* but you prefer the bucket boundaries to be `[50, 150), [150, 250), etc.`, you can set `offset`
|
5282
|
+
* to 50.
|
5283
|
+
*
|
5284
|
+
* @default 0
|
5285
|
+
*/
|
5286
|
+
offset?: number;
|
5287
|
+
aggs?: Dictionary<AggregationExpression<O>>;
|
5288
|
+
};
|
5289
|
+
declare type AggregationExpressionResultTypes = {
|
5290
|
+
count: number;
|
5291
|
+
sum: number | null;
|
5292
|
+
max: number | null;
|
5293
|
+
min: number | null;
|
5294
|
+
average: number | null;
|
5295
|
+
uniqueCount: number;
|
5296
|
+
dateHistogram: ComplexAggregationResult;
|
5297
|
+
topValues: ComplexAggregationResult;
|
5298
|
+
numericHistogram: ComplexAggregationResult;
|
5299
|
+
};
|
5300
|
+
declare type ComplexAggregationResult = {
|
5301
|
+
values: Array<{
|
5302
|
+
$key: string | number;
|
5303
|
+
$count: number;
|
5304
|
+
[key: string]: any;
|
5305
|
+
}>;
|
5306
|
+
};
|
5307
|
+
|
4649
5308
|
declare type SortDirection = 'asc' | 'desc';
|
4650
|
-
declare type SortFilterExtended<T extends XataRecord
|
4651
|
-
column:
|
5309
|
+
declare type SortFilterExtended<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = {
|
5310
|
+
column: Columns;
|
4652
5311
|
direction?: SortDirection;
|
4653
5312
|
};
|
4654
|
-
declare type SortFilter<T extends XataRecord
|
4655
|
-
declare type SortFilterBase<T extends XataRecord
|
4656
|
-
[Key in
|
4657
|
-
|
5313
|
+
declare type SortFilter<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = Columns | SortFilterExtended<T, Columns> | SortFilterBase<T, Columns>;
|
5314
|
+
declare type SortFilterBase<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = Values<{
|
5315
|
+
[Key in Columns]: {
|
5316
|
+
[K in Key]: SortDirection;
|
5317
|
+
};
|
5318
|
+
}>;
|
5319
|
+
|
5320
|
+
declare type SummarizeExpression<O extends XataRecord> = ExactlyOne<{
|
5321
|
+
count: ColumnsByValue<O, any> | '*';
|
5322
|
+
}>;
|
5323
|
+
declare type SummarizeParams<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>, Columns extends SelectableColumn<Record>[]> = {
|
5324
|
+
summaries?: Expression;
|
5325
|
+
summariesFilter?: SummarizeFilter<Record, Expression>;
|
5326
|
+
filter?: Filter<Record>;
|
5327
|
+
columns?: Columns;
|
5328
|
+
sort?: SummarizeSort<Record, Expression>;
|
5329
|
+
};
|
5330
|
+
declare type SummarizeResult<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>, Columns extends SelectableColumn<Record>[]> = {
|
5331
|
+
summaries: SummarizeResultItem<Record, Expression, Columns>[];
|
5332
|
+
};
|
5333
|
+
declare type SummarizeExpressionResultTypes<Value> = {
|
5334
|
+
count: number;
|
5335
|
+
min: Value;
|
5336
|
+
max: Value;
|
5337
|
+
sum: number;
|
5338
|
+
avg: number;
|
5339
|
+
};
|
5340
|
+
declare type SummarizeSort<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>> = SingleOrArray<SortFilter<Record, SelectableColumn<Record> | StringKeys<Expression>>>;
|
5341
|
+
declare type SummarizeValuePick<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>> = {
|
5342
|
+
[K in StringKeys<Expression>]: StringKeys<Expression[K]> extends infer SummarizeOperation ? SummarizeOperation extends keyof Expression[K] ? Expression[K][SummarizeOperation] extends infer Column ? Column extends SelectableColumn<Record> ? SummarizeOperation extends keyof SummarizeExpressionResultTypes<any> ? SummarizeExpressionResultTypes<ValueAtColumn<Record, Column>>[SummarizeOperation] : never : never : never : never : never;
|
5343
|
+
};
|
5344
|
+
declare type SummarizeFilter<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>> = Filter<Record> & Filter<SummarizeValuePick<Record, Expression>>;
|
5345
|
+
declare type SummarizeResultItem<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>, Columns extends SelectableColumn<Record>[]> = SummarizeValuePick<Record, Expression> & SelectedPick<Record, Columns>;
|
4658
5346
|
|
4659
5347
|
declare type BaseOptions<T extends XataRecord> = {
|
4660
5348
|
columns?: SelectableColumn<T>[];
|
@@ -4668,7 +5356,7 @@ declare type CursorQueryOptions = {
|
|
4668
5356
|
declare type OffsetQueryOptions<T extends XataRecord> = {
|
4669
5357
|
pagination?: OffsetNavigationOptions;
|
4670
5358
|
filter?: FilterExpression;
|
4671
|
-
sort?:
|
5359
|
+
sort?: SingleOrArray<SortFilter<T>>;
|
4672
5360
|
};
|
4673
5361
|
declare type QueryOptions<T extends XataRecord> = BaseOptions<T> & (CursorQueryOptions | OffsetQueryOptions<T>);
|
4674
5362
|
/**
|
@@ -4681,7 +5369,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
4681
5369
|
#private;
|
4682
5370
|
readonly meta: PaginationQueryMeta;
|
4683
5371
|
readonly records: RecordArray<Result>;
|
4684
|
-
constructor(repository:
|
5372
|
+
constructor(repository: RestRepository<Record> | null, table: {
|
4685
5373
|
name: string;
|
4686
5374
|
schema?: Table;
|
4687
5375
|
}, data: Partial<QueryOptions<Record>>, rawParent?: Partial<QueryOptions<Record>>);
|
@@ -4744,7 +5432,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
4744
5432
|
* @param direction The direction. Either ascending or descending.
|
4745
5433
|
* @returns A new Query object.
|
4746
5434
|
*/
|
4747
|
-
sort<F extends
|
5435
|
+
sort<F extends ColumnsByValue<Record, any>>(column: F, direction?: SortDirection): Query<Record, Result>;
|
4748
5436
|
/**
|
4749
5437
|
* Builds a new query specifying the set of columns to be returned in the query response.
|
4750
5438
|
* @param columns Array of column names to be returned by the query.
|
@@ -4880,6 +5568,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
4880
5568
|
* @throws if there are no results.
|
4881
5569
|
*/
|
4882
5570
|
getFirstOrThrow(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'>): Promise<Result>;
|
5571
|
+
summarize<Expression extends Dictionary<SummarizeExpression<Record>>, Columns extends SelectableColumn<Record>[]>(params?: SummarizeParams<Record, Expression, Columns>): Promise<SummarizeResult<Record, Expression, Columns>>;
|
4883
5572
|
/**
|
4884
5573
|
* Builds a new query object adding a cache TTL in milliseconds.
|
4885
5574
|
* @param ttl The cache TTL in milliseconds.
|
@@ -5439,6 +6128,13 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
5439
6128
|
filter?: Filter<Record>;
|
5440
6129
|
boosters?: Boosters<Record>[];
|
5441
6130
|
}): Promise<SearchXataRecord<SelectedPick<Record, ['*']>>[]>;
|
6131
|
+
/**
|
6132
|
+
* Aggregates records in the table.
|
6133
|
+
* @param expression The aggregations to perform.
|
6134
|
+
* @param filter The filter to apply to the queried records.
|
6135
|
+
* @returns The requested aggregations.
|
6136
|
+
*/
|
6137
|
+
abstract aggregate<Expression extends Dictionary<AggregationExpression<Record>>>(expression?: Expression, filter?: Filter<Record>): Promise<AggregationResult<Record, Expression>>;
|
5442
6138
|
abstract query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
|
5443
6139
|
}
|
5444
6140
|
declare class RestRepository<Record extends XataRecord> extends Query<Record, SelectedPick<Record, ['*']>> implements Repository<Record> {
|
@@ -5512,7 +6208,9 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
|
|
5512
6208
|
filter?: Filter<Record>;
|
5513
6209
|
boosters?: Boosters<Record>[];
|
5514
6210
|
}): Promise<any>;
|
6211
|
+
aggregate<Expression extends Dictionary<AggregationExpression<Record>>>(aggs?: Expression, filter?: Filter<Record>): Promise<any>;
|
5515
6212
|
query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
|
6213
|
+
summarizeTable<Result extends XataRecord>(query: Query<Record, Result>, summaries?: Dictionary<SummarizeExpression<Record>>, summariesFilter?: FilterExpression): Promise<SummarizeResponse>;
|
5516
6214
|
}
|
5517
6215
|
|
5518
6216
|
declare type BaseSchema = {
|
@@ -5626,11 +6324,11 @@ declare const le: <T extends ComparableType>(value: T) => ComparableTypeFilter<T
|
|
5626
6324
|
/**
|
5627
6325
|
* Operator to restrict results to only values that are not null.
|
5628
6326
|
*/
|
5629
|
-
declare const exists: <T>(column
|
6327
|
+
declare const exists: <T>(column?: ColumnsByValue<T, any> | undefined) => ExistanceFilter<T>;
|
5630
6328
|
/**
|
5631
6329
|
* Operator to restrict results to only values that are null.
|
5632
6330
|
*/
|
5633
|
-
declare const notExists: <T>(column
|
6331
|
+
declare const notExists: <T>(column?: ColumnsByValue<T, any> | undefined) => ExistanceFilter<T>;
|
5634
6332
|
/**
|
5635
6333
|
* Operator to restrict results to only values that start with the given prefix.
|
5636
6334
|
*/
|
@@ -5824,4 +6522,4 @@ declare class XataError extends Error {
|
|
5824
6522
|
constructor(message: string, status: number);
|
5825
6523
|
}
|
5826
6524
|
|
5827
|
-
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditResponse, ApplyBranchSchemaEditVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, CompareBranchSchemasError, CompareBranchSchemasPathParams, CompareBranchSchemasVariables, CompareBranchWithUserSchemaError, CompareBranchWithUserSchemaPathParams, CompareBranchWithUserSchemaRequestBody, CompareBranchWithUserSchemaVariables, CompareMigrationRequestError, CompareMigrationRequestPathParams, CompareMigrationRequestVariables, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchResponse, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateMigrationRequestError, CreateMigrationRequestPathParams, CreateMigrationRequestRequestBody, CreateMigrationRequestResponse, CreateMigrationRequestVariables, CreateTableError, CreateTablePathParams, CreateTableResponse, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchSchemaHistoryError, GetBranchSchemaHistoryPathParams, GetBranchSchemaHistoryRequestBody, GetBranchSchemaHistoryResponse, GetBranchSchemaHistoryVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetDatabaseMetadataError, GetDatabaseMetadataPathParams, GetDatabaseMetadataVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetMigrationRequestError, GetMigrationRequestIsMergedError, GetMigrationRequestIsMergedPathParams, GetMigrationRequestIsMergedResponse, GetMigrationRequestIsMergedVariables, GetMigrationRequestPathParams, GetMigrationRequestVariables, GetRecordError, GetRecordPathParams, GetRecordQueryParams, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, Link, ListMigrationRequestsCommitsError, ListMigrationRequestsCommitsPathParams, ListMigrationRequestsCommitsRequestBody, ListMigrationRequestsCommitsResponse, ListMigrationRequestsCommitsVariables, 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, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, SummarizeTableError, SummarizeTablePathParams, SummarizeTableRequestBody, SummarizeTableVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, UpdateBranchSchemaResponse, UpdateBranchSchemaVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateDatabaseMetadataError, UpdateDatabaseMetadataPathParams, UpdateDatabaseMetadataRequestBody, UpdateDatabaseMetadataVariables, UpdateMigrationRequestError, UpdateMigrationRequestPathParams, UpdateMigrationRequestRequestBody, UpdateMigrationRequestVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberInviteError, UpdateWorkspaceMemberInvitePathParams, UpdateWorkspaceMemberInviteRequestBody, UpdateWorkspaceMemberInviteVariables, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, applyBranchSchemaEdit, buildClient, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, lt, lte, mergeMigrationRequest, notExists, operationsByTag, 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 };
|
6525
|
+
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, AggregateTableError, AggregateTablePathParams, AggregateTableRequestBody, AggregateTableVariables, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditResponse, ApplyBranchSchemaEditVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CPCreateDatabaseError, CPCreateDatabasePathParams, CPCreateDatabaseRequestBody, CPCreateDatabaseResponse, CPCreateDatabaseVariables, CPDeleteDatabaseError, CPDeleteDatabasePathParams, CPDeleteDatabaseVariables, CPGetCPDatabaseMetadataError, CPGetCPDatabaseMetadataPathParams, CPGetCPDatabaseMetadataVariables, CPGetDatabaseListError, CPGetDatabaseListPathParams, CPGetDatabaseListVariables, CPUpdateCPDatabaseMetadataError, CPUpdateCPDatabaseMetadataPathParams, CPUpdateCPDatabaseMetadataRequestBody, CPUpdateCPDatabaseMetadataVariables, 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, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchSchemaHistoryError, GetBranchSchemaHistoryPathParams, GetBranchSchemaHistoryRequestBody, GetBranchSchemaHistoryResponse, GetBranchSchemaHistoryVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetDatabaseMetadataError, GetDatabaseMetadataPathParams, GetDatabaseMetadataVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetMigrationRequestError, GetMigrationRequestIsMergedError, GetMigrationRequestIsMergedPathParams, GetMigrationRequestIsMergedResponse, GetMigrationRequestIsMergedVariables, GetMigrationRequestPathParams, GetMigrationRequestVariables, GetRecordError, GetRecordPathParams, GetRecordQueryParams, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, HostProvider, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, Link, ListMigrationRequestsCommitsError, ListMigrationRequestsCommitsPathParams, ListMigrationRequestsCommitsRequestBody, ListMigrationRequestsCommitsResponse, ListMigrationRequestsCommitsVariables, 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, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, SummarizeTableError, SummarizeTablePathParams, SummarizeTableRequestBody, SummarizeTableVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, UpdateBranchSchemaResponse, UpdateBranchSchemaVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateDatabaseMetadataError, UpdateDatabaseMetadataPathParams, UpdateDatabaseMetadataRequestBody, UpdateDatabaseMetadataVariables, UpdateMigrationRequestError, UpdateMigrationRequestPathParams, UpdateMigrationRequestRequestBody, UpdateMigrationRequestVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberInviteError, UpdateWorkspaceMemberInvitePathParams, UpdateWorkspaceMemberInviteRequestBody, UpdateWorkspaceMemberInviteVariables, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, buildClient, buildWorkerRunner, bulkInsertTableRecords, cPCreateDatabase, cPDeleteDatabase, cPGetCPDatabaseMetadata, cPGetDatabaseList, cPUpdateCPDatabaseMetadata, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, 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 };
|