@xata.io/client 0.19.0 → 0.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +22 -0
- package/README.md +2 -2
- package/Usage.md +5 -5
- package/dist/index.cjs +102 -71
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +365 -167
- package/dist/index.mjs +97 -67
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
- /package/{rollup.config.js → rollup.config.mjs} +0 -0
package/dist/index.d.ts
CHANGED
@@ -61,6 +61,7 @@ declare type FetcherExtraProps = {
|
|
61
61
|
signal?: AbortSignal;
|
62
62
|
clientID?: string;
|
63
63
|
sessionID?: string;
|
64
|
+
fetchOptions?: Record<string, unknown>;
|
64
65
|
};
|
65
66
|
|
66
67
|
declare type ControlPlaneFetcherExtraProps = {
|
@@ -161,7 +162,7 @@ declare type InviteKey = string;
|
|
161
162
|
/**
|
162
163
|
* Metadata of databases
|
163
164
|
*/
|
164
|
-
declare type
|
165
|
+
declare type DatabaseMetadata = {
|
165
166
|
/**
|
166
167
|
* The machine-readable name of a database
|
167
168
|
*/
|
@@ -184,11 +185,11 @@ declare type CPDatabaseMetadata = {
|
|
184
185
|
color?: string;
|
185
186
|
};
|
186
187
|
};
|
187
|
-
declare type
|
188
|
+
declare type ListDatabasesResponse = {
|
188
189
|
/**
|
189
190
|
* A list of databases in a Xata workspace
|
190
191
|
*/
|
191
|
-
databases:
|
192
|
+
databases: DatabaseMetadata[];
|
192
193
|
};
|
193
194
|
/**
|
194
195
|
* @example {"repository":"github.com/my/repository","branch":"feature-login","stage":"testing","labels":["epic-100"]}
|
@@ -711,27 +712,27 @@ declare type ResendWorkspaceMemberInviteVariables = {
|
|
711
712
|
* This operation provides a way to resend an Invite notification. Invite notifications can only be sent for Invites not yet accepted.
|
712
713
|
*/
|
713
714
|
declare const resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
714
|
-
declare type
|
715
|
+
declare type GetDatabaseListPathParams = {
|
715
716
|
/**
|
716
717
|
* Workspace ID
|
717
718
|
*/
|
718
719
|
workspaceId: WorkspaceID;
|
719
720
|
};
|
720
|
-
declare type
|
721
|
+
declare type GetDatabaseListError = ErrorWrapper$1<{
|
721
722
|
status: 400;
|
722
723
|
payload: BadRequestError$1;
|
723
724
|
} | {
|
724
725
|
status: 401;
|
725
726
|
payload: AuthError$1;
|
726
727
|
}>;
|
727
|
-
declare type
|
728
|
-
pathParams:
|
728
|
+
declare type GetDatabaseListVariables = {
|
729
|
+
pathParams: GetDatabaseListPathParams;
|
729
730
|
} & ControlPlaneFetcherExtraProps;
|
730
731
|
/**
|
731
732
|
* List all databases available in your Workspace.
|
732
733
|
*/
|
733
|
-
declare const
|
734
|
-
declare type
|
734
|
+
declare const getDatabaseList: (variables: GetDatabaseListVariables, signal?: AbortSignal) => Promise<ListDatabasesResponse>;
|
735
|
+
declare type CreateDatabasePathParams = {
|
735
736
|
/**
|
736
737
|
* Workspace ID
|
737
738
|
*/
|
@@ -741,14 +742,14 @@ declare type CPCreateDatabasePathParams = {
|
|
741
742
|
*/
|
742
743
|
dbName: DBName$1;
|
743
744
|
};
|
744
|
-
declare type
|
745
|
+
declare type CreateDatabaseError = ErrorWrapper$1<{
|
745
746
|
status: 400;
|
746
747
|
payload: BadRequestError$1;
|
747
748
|
} | {
|
748
749
|
status: 401;
|
749
750
|
payload: AuthError$1;
|
750
751
|
}>;
|
751
|
-
declare type
|
752
|
+
declare type CreateDatabaseResponse = {
|
752
753
|
/**
|
753
754
|
* @minLength 1
|
754
755
|
*/
|
@@ -756,7 +757,7 @@ declare type CPCreateDatabaseResponse = {
|
|
756
757
|
branchName?: string;
|
757
758
|
status: MigrationStatus$1;
|
758
759
|
};
|
759
|
-
declare type
|
760
|
+
declare type CreateDatabaseRequestBody = {
|
760
761
|
/**
|
761
762
|
* @minLength 1
|
762
763
|
*/
|
@@ -770,15 +771,15 @@ declare type CPCreateDatabaseRequestBody = {
|
|
770
771
|
};
|
771
772
|
metadata?: BranchMetadata$1;
|
772
773
|
};
|
773
|
-
declare type
|
774
|
-
body:
|
775
|
-
pathParams:
|
774
|
+
declare type CreateDatabaseVariables = {
|
775
|
+
body: CreateDatabaseRequestBody;
|
776
|
+
pathParams: CreateDatabasePathParams;
|
776
777
|
} & ControlPlaneFetcherExtraProps;
|
777
778
|
/**
|
778
779
|
* Create Database with identifier name
|
779
780
|
*/
|
780
|
-
declare const
|
781
|
-
declare type
|
781
|
+
declare const createDatabase: (variables: CreateDatabaseVariables, signal?: AbortSignal) => Promise<CreateDatabaseResponse>;
|
782
|
+
declare type DeleteDatabasePathParams = {
|
782
783
|
/**
|
783
784
|
* Workspace ID
|
784
785
|
*/
|
@@ -788,7 +789,7 @@ declare type CPDeleteDatabasePathParams = {
|
|
788
789
|
*/
|
789
790
|
dbName: DBName$1;
|
790
791
|
};
|
791
|
-
declare type
|
792
|
+
declare type DeleteDatabaseError = ErrorWrapper$1<{
|
792
793
|
status: 400;
|
793
794
|
payload: BadRequestError$1;
|
794
795
|
} | {
|
@@ -798,17 +799,17 @@ declare type CPDeleteDatabaseError = ErrorWrapper$1<{
|
|
798
799
|
status: 404;
|
799
800
|
payload: SimpleError$1;
|
800
801
|
}>;
|
801
|
-
declare type
|
802
|
+
declare type DeleteDatabaseResponse = {
|
802
803
|
status: MigrationStatus$1;
|
803
804
|
};
|
804
|
-
declare type
|
805
|
-
pathParams:
|
805
|
+
declare type DeleteDatabaseVariables = {
|
806
|
+
pathParams: DeleteDatabasePathParams;
|
806
807
|
} & ControlPlaneFetcherExtraProps;
|
807
808
|
/**
|
808
809
|
* Delete a database and all of its branches and tables permanently.
|
809
810
|
*/
|
810
|
-
declare const
|
811
|
-
declare type
|
811
|
+
declare const deleteDatabase: (variables: DeleteDatabaseVariables, signal?: AbortSignal) => Promise<DeleteDatabaseResponse>;
|
812
|
+
declare type GetDatabaseMetadataPathParams = {
|
812
813
|
/**
|
813
814
|
* Workspace ID
|
814
815
|
*/
|
@@ -818,7 +819,7 @@ declare type CPGetCPDatabaseMetadataPathParams = {
|
|
818
819
|
*/
|
819
820
|
dbName: DBName$1;
|
820
821
|
};
|
821
|
-
declare type
|
822
|
+
declare type GetDatabaseMetadataError = ErrorWrapper$1<{
|
822
823
|
status: 400;
|
823
824
|
payload: BadRequestError$1;
|
824
825
|
} | {
|
@@ -828,14 +829,14 @@ declare type CPGetCPDatabaseMetadataError = ErrorWrapper$1<{
|
|
828
829
|
status: 404;
|
829
830
|
payload: SimpleError$1;
|
830
831
|
}>;
|
831
|
-
declare type
|
832
|
-
pathParams:
|
832
|
+
declare type GetDatabaseMetadataVariables = {
|
833
|
+
pathParams: GetDatabaseMetadataPathParams;
|
833
834
|
} & ControlPlaneFetcherExtraProps;
|
834
835
|
/**
|
835
836
|
* Retrieve metadata of the given database
|
836
837
|
*/
|
837
|
-
declare const
|
838
|
-
declare type
|
838
|
+
declare const getDatabaseMetadata: (variables: GetDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
839
|
+
declare type UpdateDatabaseMetadataPathParams = {
|
839
840
|
/**
|
840
841
|
* Workspace ID
|
841
842
|
*/
|
@@ -845,7 +846,7 @@ declare type CPUpdateCPDatabaseMetadataPathParams = {
|
|
845
846
|
*/
|
846
847
|
dbName: DBName$1;
|
847
848
|
};
|
848
|
-
declare type
|
849
|
+
declare type UpdateDatabaseMetadataError = ErrorWrapper$1<{
|
849
850
|
status: 400;
|
850
851
|
payload: BadRequestError$1;
|
851
852
|
} | {
|
@@ -855,7 +856,7 @@ declare type CPUpdateCPDatabaseMetadataError = ErrorWrapper$1<{
|
|
855
856
|
status: 404;
|
856
857
|
payload: SimpleError$1;
|
857
858
|
}>;
|
858
|
-
declare type
|
859
|
+
declare type UpdateDatabaseMetadataRequestBody = {
|
859
860
|
ui?: {
|
860
861
|
/**
|
861
862
|
* @minLength 1
|
@@ -863,14 +864,14 @@ declare type CPUpdateCPDatabaseMetadataRequestBody = {
|
|
863
864
|
color?: string;
|
864
865
|
};
|
865
866
|
};
|
866
|
-
declare type
|
867
|
-
body?:
|
868
|
-
pathParams:
|
867
|
+
declare type UpdateDatabaseMetadataVariables = {
|
868
|
+
body?: UpdateDatabaseMetadataRequestBody;
|
869
|
+
pathParams: UpdateDatabaseMetadataPathParams;
|
869
870
|
} & ControlPlaneFetcherExtraProps;
|
870
871
|
/**
|
871
872
|
* Update the color of the selected database
|
872
873
|
*/
|
873
|
-
declare const
|
874
|
+
declare const updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
874
875
|
declare type ListRegionsPathParams = {
|
875
876
|
/**
|
876
877
|
* Workspace ID
|
@@ -900,7 +901,7 @@ declare const listRegions: (variables: ListRegionsVariables, signal?: AbortSigna
|
|
900
901
|
/**
|
901
902
|
* Metadata of databases
|
902
903
|
*/
|
903
|
-
declare type
|
904
|
+
declare type DEPRECATEDDatabaseMetadata = {
|
904
905
|
/**
|
905
906
|
* The machine-readable name of a database
|
906
907
|
*/
|
@@ -923,11 +924,11 @@ declare type DatabaseMetadata = {
|
|
923
924
|
color?: string;
|
924
925
|
};
|
925
926
|
};
|
926
|
-
declare type
|
927
|
+
declare type DEPRECATEDListDatabasesResponse = {
|
927
928
|
/**
|
928
929
|
* A list of databases in a Xata workspace
|
929
930
|
*/
|
930
|
-
databases?:
|
931
|
+
databases?: DEPRECATEDDatabaseMetadata[];
|
931
932
|
};
|
932
933
|
declare type ListBranchesResponse = {
|
933
934
|
databaseName: string;
|
@@ -982,9 +983,6 @@ declare type Schema = {
|
|
982
983
|
tables: Table[];
|
983
984
|
tablesOrder?: string[];
|
984
985
|
};
|
985
|
-
/**
|
986
|
-
* @x-internal true
|
987
|
-
*/
|
988
986
|
declare type SchemaEditScript = {
|
989
987
|
sourceMigrationID?: string;
|
990
988
|
targetMigrationID?: string;
|
@@ -1001,6 +999,7 @@ declare type Column = {
|
|
1001
999
|
type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object' | 'datetime';
|
1002
1000
|
link?: ColumnLink;
|
1003
1001
|
notNull?: boolean;
|
1002
|
+
defaultValue?: string;
|
1004
1003
|
unique?: boolean;
|
1005
1004
|
columns?: Column[];
|
1006
1005
|
};
|
@@ -1071,9 +1070,6 @@ declare type ColumnMigration = {
|
|
1071
1070
|
old: Column;
|
1072
1071
|
['new']: Column;
|
1073
1072
|
};
|
1074
|
-
/**
|
1075
|
-
* @x-internal true
|
1076
|
-
*/
|
1077
1073
|
declare type Commit = {
|
1078
1074
|
title?: string;
|
1079
1075
|
message?: string;
|
@@ -1088,8 +1084,6 @@ declare type Commit = {
|
|
1088
1084
|
declare type MigrationStatus = 'completed' | 'pending' | 'failed';
|
1089
1085
|
/**
|
1090
1086
|
* Branch schema migration.
|
1091
|
-
*
|
1092
|
-
* @x-internal true
|
1093
1087
|
*/
|
1094
1088
|
declare type Migration = {
|
1095
1089
|
parentID?: string;
|
@@ -1097,13 +1091,8 @@ declare type Migration = {
|
|
1097
1091
|
};
|
1098
1092
|
/**
|
1099
1093
|
* Branch schema migration operations.
|
1100
|
-
*
|
1101
|
-
* @x-internal true
|
1102
1094
|
*/
|
1103
1095
|
declare type MigrationOp = MigrationTableOp | MigrationColumnOp;
|
1104
|
-
/**
|
1105
|
-
* @x-internal true
|
1106
|
-
*/
|
1107
1096
|
declare type MigrationTableOp = {
|
1108
1097
|
addTable: TableOpAdd;
|
1109
1098
|
} | {
|
@@ -1111,9 +1100,6 @@ declare type MigrationTableOp = {
|
|
1111
1100
|
} | {
|
1112
1101
|
renameTable: TableOpRename;
|
1113
1102
|
};
|
1114
|
-
/**
|
1115
|
-
* @x-internal true
|
1116
|
-
*/
|
1117
1103
|
declare type MigrationColumnOp = {
|
1118
1104
|
addColumn: ColumnOpAdd;
|
1119
1105
|
} | {
|
@@ -1121,42 +1107,24 @@ declare type MigrationColumnOp = {
|
|
1121
1107
|
} | {
|
1122
1108
|
renameColumn: ColumnOpRename;
|
1123
1109
|
};
|
1124
|
-
/**
|
1125
|
-
* @x-internal true
|
1126
|
-
*/
|
1127
1110
|
declare type TableOpAdd = {
|
1128
1111
|
table: string;
|
1129
1112
|
};
|
1130
|
-
/**
|
1131
|
-
* @x-internal true
|
1132
|
-
*/
|
1133
1113
|
declare type TableOpRemove = {
|
1134
1114
|
table: string;
|
1135
1115
|
};
|
1136
|
-
/**
|
1137
|
-
* @x-internal true
|
1138
|
-
*/
|
1139
1116
|
declare type TableOpRename = {
|
1140
1117
|
oldName: string;
|
1141
1118
|
newName: string;
|
1142
1119
|
};
|
1143
|
-
/**
|
1144
|
-
* @x-internal true
|
1145
|
-
*/
|
1146
1120
|
declare type ColumnOpAdd = {
|
1147
1121
|
table: string;
|
1148
1122
|
column: Column;
|
1149
1123
|
};
|
1150
|
-
/**
|
1151
|
-
* @x-internal true
|
1152
|
-
*/
|
1153
1124
|
declare type ColumnOpRemove = {
|
1154
1125
|
table: string;
|
1155
1126
|
column: string;
|
1156
1127
|
};
|
1157
|
-
/**
|
1158
|
-
* @x-internal true
|
1159
|
-
*/
|
1160
1128
|
declare type ColumnOpRename = {
|
1161
1129
|
table: string;
|
1162
1130
|
oldName: string;
|
@@ -1271,6 +1239,10 @@ declare type FilterExpression = {
|
|
1271
1239
|
*
|
1272
1240
|
* @example {"all_users":{"count":"*"}}
|
1273
1241
|
* @example {"total_created":{"count":"created_at"}}
|
1242
|
+
* @example {"min_cost":{"min":"cost"}}
|
1243
|
+
* @example {"max_happiness":{"max":"happiness"}}
|
1244
|
+
* @example {"total_revenue":{"sum":"revenue"}}
|
1245
|
+
* @example {"average_speed":{"average":"speed"}}
|
1274
1246
|
* @x-go-type xbquery.SummaryList
|
1275
1247
|
*/
|
1276
1248
|
declare type SummaryExpressionList = {
|
@@ -1284,11 +1256,28 @@ declare type SummaryExpressionList = {
|
|
1284
1256
|
* an object, i.e. if `settings` is an object with `dark_mode` as a field, you may summarize
|
1285
1257
|
* `settings.dark_mode` but not `settings` nor `settings.*`.
|
1286
1258
|
*
|
1287
|
-
* We currently support
|
1288
|
-
*
|
1259
|
+
* We currently support several aggregation functions. Not all functions can be run on all column
|
1260
|
+
* types.
|
1261
|
+
*
|
1262
|
+
* - `count` is used to count the number of records in each group. Use `{"count": "*"}` to count
|
1263
|
+
* all columns present, otherwise `{"count": "<column_path>"}` to count the number of non-null
|
1264
|
+
* values are present at column path.
|
1289
1265
|
*
|
1290
|
-
*
|
1291
|
-
*
|
1266
|
+
* Count can be used on any column type, and always returns an int.
|
1267
|
+
*
|
1268
|
+
* - `min` calculates the minimum value in each group. `min` is compatible with most types;
|
1269
|
+
* string, multiple, text, email, int, float, and datetime. It returns a value of the same
|
1270
|
+
* type as operated on. This means that `{"lowest_latency": {"min": "latency"}}` where
|
1271
|
+
* `latency` is an int, will always return an int.
|
1272
|
+
*
|
1273
|
+
* - `max` calculates the maximum value in each group. `max` shares the same compatibility as
|
1274
|
+
* `min`.
|
1275
|
+
*
|
1276
|
+
* - `sum` adds up all values in a group. `sum` can be run on `int` and `float` types, and will
|
1277
|
+
* return a value of the same type as requested.
|
1278
|
+
*
|
1279
|
+
* - `average` averages all values in a group. `average` can be run on `int` and `float` types, and
|
1280
|
+
* always returns a float.
|
1292
1281
|
*
|
1293
1282
|
* @example {"count":"deleted_at"}
|
1294
1283
|
* @x-go-type xbquery.Summary
|
@@ -1597,11 +1586,11 @@ declare type PageConfig = {
|
|
1597
1586
|
/**
|
1598
1587
|
* Query the first page from the cursor.
|
1599
1588
|
*/
|
1600
|
-
|
1589
|
+
start?: string;
|
1601
1590
|
/**
|
1602
1591
|
* Query the last page from the cursor.
|
1603
1592
|
*/
|
1604
|
-
|
1593
|
+
end?: string;
|
1605
1594
|
/**
|
1606
1595
|
* Set page size. If the size is missing it is read from the cursor. If no cursor is given Xata will choose the default page size.
|
1607
1596
|
*
|
@@ -1693,6 +1682,128 @@ declare type AggResponse$1 = (number | null) | {
|
|
1693
1682
|
[key: string]: AggResponse$1;
|
1694
1683
|
})[];
|
1695
1684
|
};
|
1685
|
+
/**
|
1686
|
+
* A transaction operation
|
1687
|
+
*/
|
1688
|
+
declare type TransactionOperation = {
|
1689
|
+
insert: TransactionInsert;
|
1690
|
+
} | {
|
1691
|
+
update: TransactionUpdate;
|
1692
|
+
} | {
|
1693
|
+
['delete']: TransactionDelete;
|
1694
|
+
};
|
1695
|
+
/**
|
1696
|
+
* Insert operation
|
1697
|
+
*
|
1698
|
+
* @x-go-type TxOperation
|
1699
|
+
*/
|
1700
|
+
declare type TransactionInsert = {
|
1701
|
+
/**
|
1702
|
+
* The table name
|
1703
|
+
*/
|
1704
|
+
table: string;
|
1705
|
+
/**
|
1706
|
+
* The record to insert. The `id` field is optional; when specified, it will be used as the ID for the record.
|
1707
|
+
*/
|
1708
|
+
record: {
|
1709
|
+
[key: string]: any;
|
1710
|
+
};
|
1711
|
+
/**
|
1712
|
+
* The version of the record you expect to be overwriting. Only valid with an
|
1713
|
+
* explicit ID is also set in the `record` key.
|
1714
|
+
*/
|
1715
|
+
ifVersion?: number;
|
1716
|
+
/**
|
1717
|
+
* createOnly is used to change how Xata acts when an explicit ID is set in the `record` key.
|
1718
|
+
*
|
1719
|
+
* If `createOnly` is set to `true`, Xata will only attempt to insert the record. If there's a conflict, Xata
|
1720
|
+
* will cancel the transaction.
|
1721
|
+
*
|
1722
|
+
* If `createOnly` is set to `false`, Xata will attempt to insert the record. If there's no
|
1723
|
+
* conflict, the record is inserted. If there is a conflict, Xata will replace the record.
|
1724
|
+
*/
|
1725
|
+
createOnly?: boolean;
|
1726
|
+
};
|
1727
|
+
/**
|
1728
|
+
* Update operation
|
1729
|
+
*
|
1730
|
+
* @x-go-type TxOperation
|
1731
|
+
*/
|
1732
|
+
declare type TransactionUpdate = {
|
1733
|
+
/**
|
1734
|
+
* The table name
|
1735
|
+
*/
|
1736
|
+
table: string;
|
1737
|
+
id: RecordID;
|
1738
|
+
/**
|
1739
|
+
* The fields of the record you'd like to update
|
1740
|
+
*/
|
1741
|
+
fields: {
|
1742
|
+
[key: string]: any;
|
1743
|
+
};
|
1744
|
+
/**
|
1745
|
+
* The version of the record you expect to be updating
|
1746
|
+
*/
|
1747
|
+
ifVersion?: number;
|
1748
|
+
/**
|
1749
|
+
* Xata will insert this record if it cannot be found.
|
1750
|
+
*/
|
1751
|
+
upsert?: boolean;
|
1752
|
+
};
|
1753
|
+
/**
|
1754
|
+
* A delete operation. The transaction will continue if no record matches the ID.
|
1755
|
+
*
|
1756
|
+
* @x-go-type TxOperation
|
1757
|
+
*/
|
1758
|
+
declare type TransactionDelete = {
|
1759
|
+
/**
|
1760
|
+
* The table name
|
1761
|
+
*/
|
1762
|
+
table: string;
|
1763
|
+
id: RecordID;
|
1764
|
+
};
|
1765
|
+
/**
|
1766
|
+
* A result from an insert operation.
|
1767
|
+
*/
|
1768
|
+
declare type TransactionResultInsert = {
|
1769
|
+
/**
|
1770
|
+
* The number of affected rows
|
1771
|
+
*/
|
1772
|
+
rows: number;
|
1773
|
+
id: RecordID;
|
1774
|
+
};
|
1775
|
+
/**
|
1776
|
+
* A result from an update operation.
|
1777
|
+
*/
|
1778
|
+
declare type TransactionResultUpdate = {
|
1779
|
+
/**
|
1780
|
+
* The number of affected rows
|
1781
|
+
*/
|
1782
|
+
rows: number;
|
1783
|
+
id: RecordID;
|
1784
|
+
};
|
1785
|
+
/**
|
1786
|
+
* A result from a delete operation.
|
1787
|
+
*/
|
1788
|
+
declare type TransactionResultDelete = {
|
1789
|
+
/**
|
1790
|
+
* The number of affected rows
|
1791
|
+
*/
|
1792
|
+
rows: number;
|
1793
|
+
};
|
1794
|
+
/**
|
1795
|
+
* An error message from a failing transaction operation
|
1796
|
+
*/
|
1797
|
+
declare type TransactionError = {
|
1798
|
+
/**
|
1799
|
+
* The index of the failing operation
|
1800
|
+
*/
|
1801
|
+
index?: number;
|
1802
|
+
/**
|
1803
|
+
* The error message
|
1804
|
+
*/
|
1805
|
+
message: string;
|
1806
|
+
};
|
1696
1807
|
/**
|
1697
1808
|
* @format date-time
|
1698
1809
|
* @x-go-type string
|
@@ -1769,6 +1880,24 @@ declare type SearchResponse = {
|
|
1769
1880
|
records: XataRecord$1[];
|
1770
1881
|
warning?: string;
|
1771
1882
|
};
|
1883
|
+
/**
|
1884
|
+
* @x-go-type TxResponse
|
1885
|
+
*/
|
1886
|
+
declare type TransactionSucceeded = {
|
1887
|
+
/**
|
1888
|
+
* An ordered array of results from the submitted operations that were executed
|
1889
|
+
*/
|
1890
|
+
results: (TransactionResultInsert | TransactionResultUpdate | TransactionResultDelete)[];
|
1891
|
+
};
|
1892
|
+
/**
|
1893
|
+
* @x-go-type TxResponse
|
1894
|
+
*/
|
1895
|
+
declare type TransactionFailed = {
|
1896
|
+
/**
|
1897
|
+
* An array of errors from the submitted operations.
|
1898
|
+
*/
|
1899
|
+
errors: TransactionError[];
|
1900
|
+
};
|
1772
1901
|
declare type BadRequestError = {
|
1773
1902
|
id?: string;
|
1774
1903
|
message: string;
|
@@ -1802,24 +1931,24 @@ declare type ErrorWrapper<TError> = TError | {
|
|
1802
1931
|
* @version 1.0
|
1803
1932
|
*/
|
1804
1933
|
|
1805
|
-
declare type
|
1934
|
+
declare type DEPRECATEDgetDatabaseListPathParams = {
|
1806
1935
|
workspace: string;
|
1807
1936
|
region: string;
|
1808
1937
|
};
|
1809
|
-
declare type
|
1938
|
+
declare type DEPRECATEDgetDatabaseListError = ErrorWrapper<{
|
1810
1939
|
status: 400;
|
1811
1940
|
payload: BadRequestError;
|
1812
1941
|
} | {
|
1813
1942
|
status: 401;
|
1814
1943
|
payload: AuthError;
|
1815
1944
|
}>;
|
1816
|
-
declare type
|
1817
|
-
pathParams:
|
1945
|
+
declare type DEPRECATEDgetDatabaseListVariables = {
|
1946
|
+
pathParams: DEPRECATEDgetDatabaseListPathParams;
|
1818
1947
|
} & DataPlaneFetcherExtraProps;
|
1819
1948
|
/**
|
1820
1949
|
* List all databases available in your Workspace.
|
1821
1950
|
*/
|
1822
|
-
declare const
|
1951
|
+
declare const dEPRECATEDgetDatabaseList: (variables: DEPRECATEDgetDatabaseListVariables, signal?: AbortSignal) => Promise<DEPRECATEDListDatabasesResponse>;
|
1823
1952
|
declare type GetBranchListPathParams = {
|
1824
1953
|
/**
|
1825
1954
|
* The Database Name
|
@@ -1845,7 +1974,7 @@ declare type GetBranchListVariables = {
|
|
1845
1974
|
* List all available Branches
|
1846
1975
|
*/
|
1847
1976
|
declare const getBranchList: (variables: GetBranchListVariables, signal?: AbortSignal) => Promise<ListBranchesResponse>;
|
1848
|
-
declare type
|
1977
|
+
declare type DEPRECATEDcreateDatabasePathParams = {
|
1849
1978
|
/**
|
1850
1979
|
* The Database Name
|
1851
1980
|
*/
|
@@ -1853,14 +1982,14 @@ declare type CreateDatabasePathParams = {
|
|
1853
1982
|
workspace: string;
|
1854
1983
|
region: string;
|
1855
1984
|
};
|
1856
|
-
declare type
|
1985
|
+
declare type DEPRECATEDcreateDatabaseError = ErrorWrapper<{
|
1857
1986
|
status: 400;
|
1858
1987
|
payload: BadRequestError;
|
1859
1988
|
} | {
|
1860
1989
|
status: 401;
|
1861
1990
|
payload: AuthError;
|
1862
1991
|
}>;
|
1863
|
-
declare type
|
1992
|
+
declare type DEPRECATEDcreateDatabaseResponse = {
|
1864
1993
|
/**
|
1865
1994
|
* @minLength 1
|
1866
1995
|
*/
|
@@ -1868,7 +1997,7 @@ declare type CreateDatabaseResponse = {
|
|
1868
1997
|
branchName?: string;
|
1869
1998
|
status: MigrationStatus;
|
1870
1999
|
};
|
1871
|
-
declare type
|
2000
|
+
declare type DEPRECATEDcreateDatabaseRequestBody = {
|
1872
2001
|
/**
|
1873
2002
|
* @minLength 1
|
1874
2003
|
*/
|
@@ -1878,15 +2007,15 @@ declare type CreateDatabaseRequestBody = {
|
|
1878
2007
|
};
|
1879
2008
|
metadata?: BranchMetadata;
|
1880
2009
|
};
|
1881
|
-
declare type
|
1882
|
-
body?:
|
1883
|
-
pathParams:
|
2010
|
+
declare type DEPRECATEDcreateDatabaseVariables = {
|
2011
|
+
body?: DEPRECATEDcreateDatabaseRequestBody;
|
2012
|
+
pathParams: DEPRECATEDcreateDatabasePathParams;
|
1884
2013
|
} & DataPlaneFetcherExtraProps;
|
1885
2014
|
/**
|
1886
2015
|
* Create Database with identifier name
|
1887
2016
|
*/
|
1888
|
-
declare const
|
1889
|
-
declare type
|
2017
|
+
declare const dEPRECATEDcreateDatabase: (variables: DEPRECATEDcreateDatabaseVariables, signal?: AbortSignal) => Promise<DEPRECATEDcreateDatabaseResponse>;
|
2018
|
+
declare type DEPRECATEDdeleteDatabasePathParams = {
|
1890
2019
|
/**
|
1891
2020
|
* The Database Name
|
1892
2021
|
*/
|
@@ -1894,7 +2023,7 @@ declare type DeleteDatabasePathParams = {
|
|
1894
2023
|
workspace: string;
|
1895
2024
|
region: string;
|
1896
2025
|
};
|
1897
|
-
declare type
|
2026
|
+
declare type DEPRECATEDdeleteDatabaseError = ErrorWrapper<{
|
1898
2027
|
status: 400;
|
1899
2028
|
payload: BadRequestError;
|
1900
2029
|
} | {
|
@@ -1904,17 +2033,17 @@ declare type DeleteDatabaseError = ErrorWrapper<{
|
|
1904
2033
|
status: 404;
|
1905
2034
|
payload: SimpleError;
|
1906
2035
|
}>;
|
1907
|
-
declare type
|
2036
|
+
declare type DEPRECATEDdeleteDatabaseResponse = {
|
1908
2037
|
status: MigrationStatus;
|
1909
2038
|
};
|
1910
|
-
declare type
|
1911
|
-
pathParams:
|
2039
|
+
declare type DEPRECATEDdeleteDatabaseVariables = {
|
2040
|
+
pathParams: DEPRECATEDdeleteDatabasePathParams;
|
1912
2041
|
} & DataPlaneFetcherExtraProps;
|
1913
2042
|
/**
|
1914
2043
|
* Delete a database and all of its branches and tables permanently.
|
1915
2044
|
*/
|
1916
|
-
declare const
|
1917
|
-
declare type
|
2045
|
+
declare const dEPRECATEDdeleteDatabase: (variables: DEPRECATEDdeleteDatabaseVariables, signal?: AbortSignal) => Promise<DEPRECATEDdeleteDatabaseResponse>;
|
2046
|
+
declare type DEPRECATEDgetDatabaseMetadataPathParams = {
|
1918
2047
|
/**
|
1919
2048
|
* The Database Name
|
1920
2049
|
*/
|
@@ -1922,7 +2051,7 @@ declare type GetDatabaseMetadataPathParams = {
|
|
1922
2051
|
workspace: string;
|
1923
2052
|
region: string;
|
1924
2053
|
};
|
1925
|
-
declare type
|
2054
|
+
declare type DEPRECATEDgetDatabaseMetadataError = ErrorWrapper<{
|
1926
2055
|
status: 400;
|
1927
2056
|
payload: BadRequestError;
|
1928
2057
|
} | {
|
@@ -1932,14 +2061,14 @@ declare type GetDatabaseMetadataError = ErrorWrapper<{
|
|
1932
2061
|
status: 404;
|
1933
2062
|
payload: SimpleError;
|
1934
2063
|
}>;
|
1935
|
-
declare type
|
1936
|
-
pathParams:
|
2064
|
+
declare type DEPRECATEDgetDatabaseMetadataVariables = {
|
2065
|
+
pathParams: DEPRECATEDgetDatabaseMetadataPathParams;
|
1937
2066
|
} & DataPlaneFetcherExtraProps;
|
1938
2067
|
/**
|
1939
2068
|
* Retrieve metadata of the given database
|
1940
2069
|
*/
|
1941
|
-
declare const
|
1942
|
-
declare type
|
2070
|
+
declare const dEPRECATEDgetDatabaseMetadata: (variables: DEPRECATEDgetDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DEPRECATEDDatabaseMetadata>;
|
2071
|
+
declare type DEPRECATEDupdateDatabaseMetadataPathParams = {
|
1943
2072
|
/**
|
1944
2073
|
* The Database Name
|
1945
2074
|
*/
|
@@ -1947,7 +2076,7 @@ declare type UpdateDatabaseMetadataPathParams = {
|
|
1947
2076
|
workspace: string;
|
1948
2077
|
region: string;
|
1949
2078
|
};
|
1950
|
-
declare type
|
2079
|
+
declare type DEPRECATEDupdateDatabaseMetadataError = ErrorWrapper<{
|
1951
2080
|
status: 400;
|
1952
2081
|
payload: BadRequestError;
|
1953
2082
|
} | {
|
@@ -1957,7 +2086,7 @@ declare type UpdateDatabaseMetadataError = ErrorWrapper<{
|
|
1957
2086
|
status: 404;
|
1958
2087
|
payload: SimpleError;
|
1959
2088
|
}>;
|
1960
|
-
declare type
|
2089
|
+
declare type DEPRECATEDupdateDatabaseMetadataRequestBody = {
|
1961
2090
|
ui?: {
|
1962
2091
|
/**
|
1963
2092
|
* @minLength 1
|
@@ -1965,14 +2094,14 @@ declare type UpdateDatabaseMetadataRequestBody = {
|
|
1965
2094
|
color?: string;
|
1966
2095
|
};
|
1967
2096
|
};
|
1968
|
-
declare type
|
1969
|
-
body?:
|
1970
|
-
pathParams:
|
2097
|
+
declare type DEPRECATEDupdateDatabaseMetadataVariables = {
|
2098
|
+
body?: DEPRECATEDupdateDatabaseMetadataRequestBody;
|
2099
|
+
pathParams: DEPRECATEDupdateDatabaseMetadataPathParams;
|
1971
2100
|
} & DataPlaneFetcherExtraProps;
|
1972
2101
|
/**
|
1973
2102
|
* Update the color of the selected database
|
1974
2103
|
*/
|
1975
|
-
declare const
|
2104
|
+
declare const dEPRECATEDupdateDatabaseMetadata: (variables: DEPRECATEDupdateDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DEPRECATEDDatabaseMetadata>;
|
1976
2105
|
declare type GetBranchDetailsPathParams = {
|
1977
2106
|
/**
|
1978
2107
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2430,6 +2559,32 @@ declare type ExecuteBranchMigrationPlanVariables = {
|
|
2430
2559
|
* Apply a migration plan to the branch
|
2431
2560
|
*/
|
2432
2561
|
declare const executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
2562
|
+
declare type BranchTransactionPathParams = {
|
2563
|
+
/**
|
2564
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2565
|
+
*/
|
2566
|
+
dbBranchName: DBBranchName;
|
2567
|
+
workspace: string;
|
2568
|
+
region: string;
|
2569
|
+
};
|
2570
|
+
declare type BranchTransactionError = ErrorWrapper<{
|
2571
|
+
status: 400;
|
2572
|
+
payload: TransactionFailed;
|
2573
|
+
} | {
|
2574
|
+
status: 401;
|
2575
|
+
payload: AuthError;
|
2576
|
+
} | {
|
2577
|
+
status: 404;
|
2578
|
+
payload: SimpleError;
|
2579
|
+
}>;
|
2580
|
+
declare type BranchTransactionRequestBody = {
|
2581
|
+
operations: TransactionOperation[];
|
2582
|
+
};
|
2583
|
+
declare type BranchTransactionVariables = {
|
2584
|
+
body: BranchTransactionRequestBody;
|
2585
|
+
pathParams: BranchTransactionPathParams;
|
2586
|
+
} & DataPlaneFetcherExtraProps;
|
2587
|
+
declare const branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal) => Promise<TransactionSucceeded>;
|
2433
2588
|
declare type QueryMigrationRequestsPathParams = {
|
2434
2589
|
/**
|
2435
2590
|
* The Database Name
|
@@ -3561,6 +3716,12 @@ declare type QueryTableRequestBody = {
|
|
3561
3716
|
sort?: SortExpression;
|
3562
3717
|
page?: PageConfig;
|
3563
3718
|
columns?: ColumnsProjection;
|
3719
|
+
/**
|
3720
|
+
* The consistency level for this request.
|
3721
|
+
*
|
3722
|
+
* @default strong
|
3723
|
+
*/
|
3724
|
+
consistency?: 'strong' | 'eventual';
|
3564
3725
|
};
|
3565
3726
|
declare type QueryTableVariables = {
|
3566
3727
|
body?: QueryTableRequestBody;
|
@@ -3609,7 +3770,6 @@ declare type QueryTableVariables = {
|
|
3609
3770
|
*
|
3610
3771
|
* ```json {"truncate": true}
|
3611
3772
|
* {
|
3612
|
-
* "formatVersion": "1.0",
|
3613
3773
|
* "tables": [
|
3614
3774
|
* {
|
3615
3775
|
* "name": "teams",
|
@@ -4247,12 +4407,14 @@ declare type QueryTableVariables = {
|
|
4247
4407
|
*
|
4248
4408
|
* - `after`: Return the next page 'after' the current cursor
|
4249
4409
|
* - `before`: Return the previous page 'before' the current cursor.
|
4250
|
-
* - `
|
4251
|
-
*
|
4410
|
+
* - `start`: Resets the given cursor position to the beginning of the query result set.
|
4411
|
+
* Will return the first N records from the query result, where N is the `page.size` parameter.
|
4412
|
+
* - `end`: Resets the give cursor position to the end for the query result set.
|
4413
|
+
* Returns the last N records from the query result, where N is the `page.size` parameter.
|
4252
4414
|
*
|
4253
4415
|
* The request will fail if an invalid cursor value is given to `page.before`,
|
4254
|
-
* `page.after`, `page.
|
4255
|
-
* used if `page.
|
4416
|
+
* `page.after`, `page.start` , or `page.end`. No other cursor setting can be
|
4417
|
+
* used if `page.start` or `page.end` is set in a query.
|
4256
4418
|
*
|
4257
4419
|
* If both `page.before` and `page.after` parameters are present we treat the
|
4258
4420
|
* request as a range query. The range query will return all entries after
|
@@ -4274,14 +4436,14 @@ declare type QueryTableVariables = {
|
|
4274
4436
|
* returned is empty, but `page.meta.cursor` will include a cursor that can be
|
4275
4437
|
* used to "tail" the table from the end waiting for new data to be inserted.
|
4276
4438
|
* - `page.before=end`: This cursor returns the last page.
|
4277
|
-
* - `page.
|
4278
|
-
* first page without a cursor but `filter` and `sort` . Yet the `page.
|
4439
|
+
* - `page.start=<cursor>`: Start at the beginning of the result set of the <cursor> query. This is equivalent to querying the
|
4440
|
+
* first page without a cursor but applying `filter` and `sort` . Yet the `page.start`
|
4279
4441
|
* cursor can be convenient at times as user code does not need to remember the
|
4280
4442
|
* filter, sort, columns or page size configuration. All these information are
|
4281
4443
|
* read from the cursor.
|
4282
|
-
* - `page.
|
4444
|
+
* - `page.end=<cursor>`: Move to the end of the result set of the <cursor> query. This is equivalent to querying the
|
4283
4445
|
* last page with `page.before=end`, `filter`, and `sort` . Yet the
|
4284
|
-
* `page.
|
4446
|
+
* `page.end` cursor can be more convenient at times as user code does not
|
4285
4447
|
* need to remember the filter, sort, columns or page size configuration. All
|
4286
4448
|
* these information are read from the cursor.
|
4287
4449
|
*
|
@@ -4426,6 +4588,12 @@ declare type SummarizeTableRequestBody = {
|
|
4426
4588
|
summaries?: SummaryExpressionList;
|
4427
4589
|
sort?: SortExpression;
|
4428
4590
|
summariesFilter?: FilterExpression;
|
4591
|
+
/**
|
4592
|
+
* The consistency level for this request.
|
4593
|
+
*
|
4594
|
+
* @default strong
|
4595
|
+
*/
|
4596
|
+
consistency?: 'strong' | 'eventual';
|
4429
4597
|
page?: {
|
4430
4598
|
/**
|
4431
4599
|
* The number of records returned by summarize. If the amount of data you have exceeds this, or you have
|
@@ -4483,7 +4651,8 @@ declare type SummarizeTableVariables = {
|
|
4483
4651
|
* `columns`: tells Xata how to create each group. If you add `product_id`
|
4484
4652
|
* we will create a new group for every unique `product_id`.
|
4485
4653
|
*
|
4486
|
-
* `summaries`: tells Xata which calculations to run on each group.
|
4654
|
+
* `summaries`: tells Xata which calculations to run on each group. Xata
|
4655
|
+
* currently supports count, min, max, sum, average.
|
4487
4656
|
*
|
4488
4657
|
* `sort`: tells Xata in which order you'd like to see results. You may
|
4489
4658
|
* sort by fields specified in `columns` as well as the summary names
|
@@ -4491,8 +4660,8 @@ declare type SummarizeTableVariables = {
|
|
4491
4660
|
*
|
4492
4661
|
* note: Sorting on summarized values can be slower on very large tables;
|
4493
4662
|
* this will impact your rate limit significantly more than other queries.
|
4494
|
-
* Try use `filter`
|
4495
|
-
*
|
4663
|
+
* Try use `filter` to reduce the amount of data being processed in order
|
4664
|
+
* to reduce impact on your limits.
|
4496
4665
|
*
|
4497
4666
|
* `summariesFilter`: tells Xata how to filter the results of a summary.
|
4498
4667
|
* It has the same syntax as `filter`, however, by using `summariesFilter`
|
@@ -4561,6 +4730,7 @@ declare const operationsByTag: {
|
|
4561
4730
|
resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal | undefined) => Promise<ResolveBranchResponse>;
|
4562
4731
|
};
|
4563
4732
|
records: {
|
4733
|
+
branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal | undefined) => Promise<TransactionSucceeded>;
|
4564
4734
|
insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
4565
4735
|
getRecord: (variables: GetRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
|
4566
4736
|
insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
@@ -4570,11 +4740,11 @@ declare const operationsByTag: {
|
|
4570
4740
|
bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal | undefined) => Promise<BulkInsertResponse>;
|
4571
4741
|
};
|
4572
4742
|
database: {
|
4573
|
-
|
4574
|
-
|
4575
|
-
|
4576
|
-
|
4577
|
-
|
4743
|
+
dEPRECATEDgetDatabaseList: (variables: DEPRECATEDgetDatabaseListVariables, signal?: AbortSignal | undefined) => Promise<DEPRECATEDListDatabasesResponse>;
|
4744
|
+
dEPRECATEDcreateDatabase: (variables: DEPRECATEDcreateDatabaseVariables, signal?: AbortSignal | undefined) => Promise<DEPRECATEDcreateDatabaseResponse>;
|
4745
|
+
dEPRECATEDdeleteDatabase: (variables: DEPRECATEDdeleteDatabaseVariables, signal?: AbortSignal | undefined) => Promise<DEPRECATEDdeleteDatabaseResponse>;
|
4746
|
+
dEPRECATEDgetDatabaseMetadata: (variables: DEPRECATEDgetDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DEPRECATEDDatabaseMetadata>;
|
4747
|
+
dEPRECATEDupdateDatabaseMetadata: (variables: DEPRECATEDupdateDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DEPRECATEDDatabaseMetadata>;
|
4578
4748
|
};
|
4579
4749
|
migrations: {
|
4580
4750
|
getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal | undefined) => Promise<GetBranchMigrationHistoryResponse>;
|
@@ -4644,11 +4814,11 @@ declare const operationsByTag: {
|
|
4644
4814
|
resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
4645
4815
|
};
|
4646
4816
|
databases: {
|
4647
|
-
|
4648
|
-
|
4649
|
-
|
4650
|
-
|
4651
|
-
|
4817
|
+
getDatabaseList: (variables: GetDatabaseListVariables, signal?: AbortSignal | undefined) => Promise<ListDatabasesResponse>;
|
4818
|
+
createDatabase: (variables: CreateDatabaseVariables, signal?: AbortSignal | undefined) => Promise<CreateDatabaseResponse>;
|
4819
|
+
deleteDatabase: (variables: DeleteDatabaseVariables, signal?: AbortSignal | undefined) => Promise<DeleteDatabaseResponse>;
|
4820
|
+
getDatabaseMetadata: (variables: GetDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
|
4821
|
+
updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
|
4652
4822
|
listRegions: (variables: ListRegionsVariables, signal?: AbortSignal | undefined) => Promise<ListRegionsResponse>;
|
4653
4823
|
};
|
4654
4824
|
};
|
@@ -4682,6 +4852,8 @@ type responses_SchemaUpdateResponse = SchemaUpdateResponse;
|
|
4682
4852
|
type responses_SummarizeResponse = SummarizeResponse;
|
4683
4853
|
type responses_AggResponse = AggResponse;
|
4684
4854
|
type responses_SearchResponse = SearchResponse;
|
4855
|
+
type responses_TransactionSucceeded = TransactionSucceeded;
|
4856
|
+
type responses_TransactionFailed = TransactionFailed;
|
4685
4857
|
declare namespace responses {
|
4686
4858
|
export {
|
4687
4859
|
responses_AuthError as AuthError,
|
@@ -4698,6 +4870,8 @@ declare namespace responses {
|
|
4698
4870
|
responses_SummarizeResponse as SummarizeResponse,
|
4699
4871
|
responses_AggResponse as AggResponse,
|
4700
4872
|
responses_SearchResponse as SearchResponse,
|
4873
|
+
responses_TransactionSucceeded as TransactionSucceeded,
|
4874
|
+
responses_TransactionFailed as TransactionFailed,
|
4701
4875
|
};
|
4702
4876
|
}
|
4703
4877
|
|
@@ -4706,8 +4880,8 @@ type schemas_BranchName = BranchName;
|
|
4706
4880
|
type schemas_DBName = DBName;
|
4707
4881
|
type schemas_DateTime = DateTime;
|
4708
4882
|
type schemas_MigrationStatus = MigrationStatus;
|
4709
|
-
type
|
4710
|
-
type
|
4883
|
+
type schemas_DEPRECATEDDatabaseMetadata = DEPRECATEDDatabaseMetadata;
|
4884
|
+
type schemas_DEPRECATEDListDatabasesResponse = DEPRECATEDListDatabasesResponse;
|
4711
4885
|
type schemas_ListBranchesResponse = ListBranchesResponse;
|
4712
4886
|
type schemas_ListGitBranchesResponse = ListGitBranchesResponse;
|
4713
4887
|
type schemas_Branch = Branch;
|
@@ -4775,6 +4949,14 @@ type schemas_RecordMeta = RecordMeta;
|
|
4775
4949
|
type schemas_RecordID = RecordID;
|
4776
4950
|
type schemas_TableRename = TableRename;
|
4777
4951
|
type schemas_RecordsMetadata = RecordsMetadata;
|
4952
|
+
type schemas_TransactionOperation = TransactionOperation;
|
4953
|
+
type schemas_TransactionInsert = TransactionInsert;
|
4954
|
+
type schemas_TransactionUpdate = TransactionUpdate;
|
4955
|
+
type schemas_TransactionDelete = TransactionDelete;
|
4956
|
+
type schemas_TransactionResultInsert = TransactionResultInsert;
|
4957
|
+
type schemas_TransactionResultUpdate = TransactionResultUpdate;
|
4958
|
+
type schemas_TransactionResultDelete = TransactionResultDelete;
|
4959
|
+
type schemas_TransactionError = TransactionError;
|
4778
4960
|
type schemas_User = User;
|
4779
4961
|
type schemas_UserID = UserID;
|
4780
4962
|
type schemas_UserWithID = UserWithID;
|
@@ -4788,8 +4970,8 @@ type schemas_InviteID = InviteID;
|
|
4788
4970
|
type schemas_WorkspaceInvite = WorkspaceInvite;
|
4789
4971
|
type schemas_WorkspaceMembers = WorkspaceMembers;
|
4790
4972
|
type schemas_InviteKey = InviteKey;
|
4791
|
-
type
|
4792
|
-
type
|
4973
|
+
type schemas_DatabaseMetadata = DatabaseMetadata;
|
4974
|
+
type schemas_ListDatabasesResponse = ListDatabasesResponse;
|
4793
4975
|
type schemas_ListRegionsResponse = ListRegionsResponse;
|
4794
4976
|
type schemas_Region = Region;
|
4795
4977
|
declare namespace schemas {
|
@@ -4799,8 +4981,8 @@ declare namespace schemas {
|
|
4799
4981
|
schemas_DBName as DBName,
|
4800
4982
|
schemas_DateTime as DateTime,
|
4801
4983
|
schemas_MigrationStatus as MigrationStatus,
|
4802
|
-
|
4803
|
-
|
4984
|
+
schemas_DEPRECATEDDatabaseMetadata as DEPRECATEDDatabaseMetadata,
|
4985
|
+
schemas_DEPRECATEDListDatabasesResponse as DEPRECATEDListDatabasesResponse,
|
4804
4986
|
schemas_ListBranchesResponse as ListBranchesResponse,
|
4805
4987
|
schemas_ListGitBranchesResponse as ListGitBranchesResponse,
|
4806
4988
|
schemas_Branch as Branch,
|
@@ -4872,6 +5054,14 @@ declare namespace schemas {
|
|
4872
5054
|
schemas_TableRename as TableRename,
|
4873
5055
|
schemas_RecordsMetadata as RecordsMetadata,
|
4874
5056
|
AggResponse$1 as AggResponse,
|
5057
|
+
schemas_TransactionOperation as TransactionOperation,
|
5058
|
+
schemas_TransactionInsert as TransactionInsert,
|
5059
|
+
schemas_TransactionUpdate as TransactionUpdate,
|
5060
|
+
schemas_TransactionDelete as TransactionDelete,
|
5061
|
+
schemas_TransactionResultInsert as TransactionResultInsert,
|
5062
|
+
schemas_TransactionResultUpdate as TransactionResultUpdate,
|
5063
|
+
schemas_TransactionResultDelete as TransactionResultDelete,
|
5064
|
+
schemas_TransactionError as TransactionError,
|
4875
5065
|
XataRecord$1 as XataRecord,
|
4876
5066
|
schemas_User as User,
|
4877
5067
|
schemas_UserID as UserID,
|
@@ -4886,8 +5076,8 @@ declare namespace schemas {
|
|
4886
5076
|
schemas_WorkspaceInvite as WorkspaceInvite,
|
4887
5077
|
schemas_WorkspaceMembers as WorkspaceMembers,
|
4888
5078
|
schemas_InviteKey as InviteKey,
|
4889
|
-
|
4890
|
-
|
5079
|
+
schemas_DatabaseMetadata as DatabaseMetadata,
|
5080
|
+
schemas_ListDatabasesResponse as ListDatabasesResponse,
|
4891
5081
|
schemas_ListRegionsResponse as ListRegionsResponse,
|
4892
5082
|
schemas_Region as Region,
|
4893
5083
|
};
|
@@ -5222,7 +5412,7 @@ declare class RecordsApi {
|
|
5222
5412
|
declare class SearchAndFilterApi {
|
5223
5413
|
private extraProps;
|
5224
5414
|
constructor(extraProps: ApiExtraProps);
|
5225
|
-
queryTable({ workspace, region, database, branch, table, filter, sort, page, columns }: {
|
5415
|
+
queryTable({ workspace, region, database, branch, table, filter, sort, page, columns, consistency }: {
|
5226
5416
|
workspace: WorkspaceID;
|
5227
5417
|
region: string;
|
5228
5418
|
database: DBName;
|
@@ -5232,6 +5422,7 @@ declare class SearchAndFilterApi {
|
|
5232
5422
|
sort?: SortExpression;
|
5233
5423
|
page?: PageConfig;
|
5234
5424
|
columns?: ColumnsProjection;
|
5425
|
+
consistency?: 'strong' | 'eventual';
|
5235
5426
|
}): Promise<QueryResponse>;
|
5236
5427
|
searchTable({ workspace, region, database, branch, table, query, fuzziness, target, prefix, filter, highlight, boosters }: {
|
5237
5428
|
workspace: WorkspaceID;
|
@@ -5263,7 +5454,7 @@ declare class SearchAndFilterApi {
|
|
5263
5454
|
prefix?: PrefixExpression;
|
5264
5455
|
highlight?: HighlightExpression;
|
5265
5456
|
}): Promise<SearchResponse>;
|
5266
|
-
summarizeTable({ workspace, region, database, branch, table, filter, columns, summaries, sort, summariesFilter, page }: {
|
5457
|
+
summarizeTable({ workspace, region, database, branch, table, filter, columns, summaries, sort, summariesFilter, page, consistency }: {
|
5267
5458
|
workspace: WorkspaceID;
|
5268
5459
|
region: string;
|
5269
5460
|
database: DBName;
|
@@ -5277,6 +5468,7 @@ declare class SearchAndFilterApi {
|
|
5277
5468
|
page?: {
|
5278
5469
|
size?: number;
|
5279
5470
|
};
|
5471
|
+
consistency?: 'strong' | 'eventual';
|
5280
5472
|
}): Promise<SummarizeResponse>;
|
5281
5473
|
aggregateTable({ workspace, region, database, branch, table, filter, aggs }: {
|
5282
5474
|
workspace: WorkspaceID;
|
@@ -5429,25 +5621,25 @@ declare class DatabaseApi {
|
|
5429
5621
|
constructor(extraProps: ApiExtraProps);
|
5430
5622
|
getDatabaseList({ workspace }: {
|
5431
5623
|
workspace: WorkspaceID;
|
5432
|
-
}): Promise<
|
5624
|
+
}): Promise<ListDatabasesResponse>;
|
5433
5625
|
createDatabase({ workspace, database, data }: {
|
5434
5626
|
workspace: WorkspaceID;
|
5435
5627
|
database: DBName;
|
5436
|
-
data:
|
5628
|
+
data: CreateDatabaseRequestBody;
|
5437
5629
|
}): Promise<CreateDatabaseResponse>;
|
5438
5630
|
deleteDatabase({ workspace, database }: {
|
5439
5631
|
workspace: WorkspaceID;
|
5440
5632
|
database: DBName;
|
5441
|
-
}): Promise<
|
5633
|
+
}): Promise<DeleteDatabaseResponse>;
|
5442
5634
|
getDatabaseMetadata({ workspace, database }: {
|
5443
5635
|
workspace: WorkspaceID;
|
5444
5636
|
database: DBName;
|
5445
|
-
}): Promise<
|
5637
|
+
}): Promise<DatabaseMetadata>;
|
5446
5638
|
updateDatabaseMetadata({ workspace, database, metadata }: {
|
5447
5639
|
workspace: WorkspaceID;
|
5448
5640
|
database: DBName;
|
5449
5641
|
metadata: DatabaseMetadata;
|
5450
|
-
}): Promise<
|
5642
|
+
}): Promise<DatabaseMetadata>;
|
5451
5643
|
listRegions({ workspace }: {
|
5452
5644
|
workspace: WorkspaceID;
|
5453
5645
|
}): Promise<ListRegionsResponse>;
|
@@ -5604,13 +5796,13 @@ declare type XataRecordMetadata = {
|
|
5604
5796
|
};
|
5605
5797
|
declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
|
5606
5798
|
declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;
|
5607
|
-
declare type EditableData<O extends XataRecord> = Identifiable & Omit<{
|
5799
|
+
declare type EditableData<O extends XataRecord> = Identifiable & Partial<Omit<{
|
5608
5800
|
[K in keyof O]: O[K] extends XataRecord ? {
|
5609
5801
|
id: string;
|
5610
5802
|
} | string : NonNullable<O[K]> extends XataRecord ? {
|
5611
5803
|
id: string;
|
5612
5804
|
} | string | null | undefined : O[K];
|
5613
|
-
}, keyof XataRecord
|
5805
|
+
}, keyof XataRecord>>;
|
5614
5806
|
|
5615
5807
|
/**
|
5616
5808
|
* PropertyMatchFilter
|
@@ -5985,6 +6177,10 @@ declare type SortFilterBase<T extends XataRecord, Columns extends string = Colum
|
|
5985
6177
|
|
5986
6178
|
declare type SummarizeExpression<O extends XataRecord> = ExactlyOne<{
|
5987
6179
|
count: ColumnsByValue<O, any> | '*';
|
6180
|
+
min: ColumnsByValue<O, string | number | Date | any[]>;
|
6181
|
+
max: ColumnsByValue<O, string | number | Date | any[]>;
|
6182
|
+
sum: ColumnsByValue<O, number>;
|
6183
|
+
average: ColumnsByValue<O, number>;
|
5988
6184
|
}>;
|
5989
6185
|
declare type SummarizeParams<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>, Columns extends SelectableColumn<Record>[]> = {
|
5990
6186
|
summaries?: Expression;
|
@@ -6004,18 +6200,19 @@ declare type SummarizeExpressionResultTypes<Value> = {
|
|
6004
6200
|
min: Value;
|
6005
6201
|
max: Value;
|
6006
6202
|
sum: number;
|
6007
|
-
|
6203
|
+
average: number;
|
6008
6204
|
};
|
6009
6205
|
declare type SummarizeSort<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>> = SingleOrArray<SortFilter<Record, ColumnsByValue<Record, any> | StringKeys<Expression>>>;
|
6010
6206
|
declare type SummarizeValuePick<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>> = {
|
6011
6207
|
[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;
|
6012
6208
|
};
|
6013
|
-
declare type SummarizeFilter<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>> = Filter<Record
|
6209
|
+
declare type SummarizeFilter<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>> = Filter<Record & SummarizeValuePick<Record, Expression>>;
|
6014
6210
|
declare type SummarizeResultItem<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>, Columns extends SelectableColumn<Record>[]> = SummarizeValuePick<Record, Expression> & SelectedPick<Record, Columns>;
|
6015
6211
|
|
6016
6212
|
declare type BaseOptions<T extends XataRecord> = {
|
6017
6213
|
columns?: SelectableColumn<T>[];
|
6018
6214
|
cache?: number;
|
6215
|
+
fetchOptions?: Record<string, unknown>;
|
6019
6216
|
};
|
6020
6217
|
declare type CursorQueryOptions = {
|
6021
6218
|
pagination?: CursorNavigationOptions & OffsetNavigationOptions;
|
@@ -6257,17 +6454,17 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
6257
6454
|
*/
|
6258
6455
|
previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
6259
6456
|
/**
|
6260
|
-
* Retrieve
|
6457
|
+
* Retrieve start page of records
|
6261
6458
|
*
|
6262
6459
|
* @returns A new page object
|
6263
6460
|
*/
|
6264
|
-
|
6461
|
+
startPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
6265
6462
|
/**
|
6266
6463
|
* Retrieve last page of records
|
6267
6464
|
*
|
6268
6465
|
* @returns A new page object
|
6269
6466
|
*/
|
6270
|
-
|
6467
|
+
endPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
6271
6468
|
/**
|
6272
6469
|
* @returns Boolean indicating if there is a next page
|
6273
6470
|
*/
|
@@ -6285,8 +6482,8 @@ interface Paginable<Record extends XataRecord, Result extends XataRecord = Recor
|
|
6285
6482
|
records: RecordArray<Result>;
|
6286
6483
|
nextPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
6287
6484
|
previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
6288
|
-
|
6289
|
-
|
6485
|
+
startPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
6486
|
+
endPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
6290
6487
|
hasNextPage(): boolean;
|
6291
6488
|
}
|
6292
6489
|
/**
|
@@ -6319,19 +6516,19 @@ declare class Page<Record extends XataRecord, Result extends XataRecord = Record
|
|
6319
6516
|
*/
|
6320
6517
|
previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
6321
6518
|
/**
|
6322
|
-
* Retrieves the
|
6519
|
+
* Retrieves the start page of results.
|
6323
6520
|
* @param size Maximum number of results to be retrieved.
|
6324
6521
|
* @param offset Number of results to skip when retrieving the results.
|
6325
|
-
* @returns The
|
6522
|
+
* @returns The start page or results.
|
6326
6523
|
*/
|
6327
|
-
|
6524
|
+
startPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
6328
6525
|
/**
|
6329
|
-
* Retrieves the
|
6526
|
+
* Retrieves the end page of results.
|
6330
6527
|
* @param size Maximum number of results to be retrieved.
|
6331
6528
|
* @param offset Number of results to skip when retrieving the results.
|
6332
|
-
* @returns The
|
6529
|
+
* @returns The end page or results.
|
6333
6530
|
*/
|
6334
|
-
|
6531
|
+
endPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
6335
6532
|
/**
|
6336
6533
|
* Shortcut method to check if there will be additional results if the next page of results is retrieved.
|
6337
6534
|
* @returns Whether or not there will be additional results in the next page of results.
|
@@ -6339,9 +6536,9 @@ declare class Page<Record extends XataRecord, Result extends XataRecord = Record
|
|
6339
6536
|
hasNextPage(): boolean;
|
6340
6537
|
}
|
6341
6538
|
declare type CursorNavigationOptions = {
|
6342
|
-
|
6539
|
+
start?: string;
|
6343
6540
|
} | {
|
6344
|
-
|
6541
|
+
end?: string;
|
6345
6542
|
} | {
|
6346
6543
|
after?: string;
|
6347
6544
|
before?: string;
|
@@ -6374,17 +6571,17 @@ declare class RecordArray<Result extends XataRecord> extends Array<Result> {
|
|
6374
6571
|
*/
|
6375
6572
|
previousPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
|
6376
6573
|
/**
|
6377
|
-
* Retrieve
|
6574
|
+
* Retrieve start page of records
|
6378
6575
|
*
|
6379
6576
|
* @returns A new array of objects
|
6380
6577
|
*/
|
6381
|
-
|
6578
|
+
startPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
|
6382
6579
|
/**
|
6383
|
-
* Retrieve
|
6580
|
+
* Retrieve end page of records
|
6384
6581
|
*
|
6385
6582
|
* @returns A new array of objects
|
6386
6583
|
*/
|
6387
|
-
|
6584
|
+
endPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
|
6388
6585
|
/**
|
6389
6586
|
* @returns Boolean indicating if there is a next page
|
6390
6587
|
*/
|
@@ -7200,6 +7397,7 @@ declare type BaseClientOptions = {
|
|
7200
7397
|
branch?: BranchStrategyOption;
|
7201
7398
|
cache?: CacheImpl;
|
7202
7399
|
trace?: TraceFunction;
|
7400
|
+
enableBrowser?: boolean;
|
7203
7401
|
};
|
7204
7402
|
declare const buildClient: <Plugins extends Record<string, XataPlugin> = {}>(plugins?: Plugins | undefined) => ClientConstructor<Plugins>;
|
7205
7403
|
interface ClientConstructor<Plugins extends Record<string, XataPlugin>> {
|
@@ -7324,4 +7522,4 @@ declare class XataError extends Error {
|
|
7324
7522
|
constructor(message: string, status: number);
|
7325
7523
|
}
|
7326
7524
|
|
7327
|
-
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, AggregateTableError, AggregateTablePathParams, AggregateTableRequestBody, AggregateTableVariables, ApiExtraProps, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CPCreateDatabaseError, CPCreateDatabasePathParams, CPCreateDatabaseRequestBody, CPCreateDatabaseResponse, CPCreateDatabaseVariables, CPDeleteDatabaseError, CPDeleteDatabasePathParams, CPDeleteDatabaseResponse, 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, DeleteBranchResponse, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseResponse, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableResponse, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchSchemaHistoryError, GetBranchSchemaHistoryPathParams, GetBranchSchemaHistoryRequestBody, GetBranchSchemaHistoryResponse, GetBranchSchemaHistoryVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetDatabaseMetadataError, GetDatabaseMetadataPathParams, GetDatabaseMetadataVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetMigrationRequestError, GetMigrationRequestIsMergedError, GetMigrationRequestIsMergedPathParams, GetMigrationRequestIsMergedResponse, GetMigrationRequestIsMergedVariables, GetMigrationRequestPathParams, GetMigrationRequestVariables, GetRecordError, GetRecordPathParams, GetRecordQueryParams, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, HostProvider, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, Link, ListMigrationRequestsCommitsError, ListMigrationRequestsCommitsPathParams, ListMigrationRequestsCommitsRequestBody, ListMigrationRequestsCommitsResponse, ListMigrationRequestsCommitsVariables, ListRegionsError, ListRegionsPathParams, ListRegionsVariables, MergeMigrationRequestError, MergeMigrationRequestPathParams, MergeMigrationRequestVariables, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, PreviewBranchSchemaEditError, PreviewBranchSchemaEditPathParams, PreviewBranchSchemaEditRequestBody, PreviewBranchSchemaEditResponse, PreviewBranchSchemaEditVariables, Query, QueryMigrationRequestsError, QueryMigrationRequestsPathParams, QueryMigrationRequestsRequestBody, QueryMigrationRequestsResponse, QueryMigrationRequestsVariables, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RecordArray, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaInference, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SearchTableError, SearchTablePathParams, SearchTableRequestBody, SearchTableVariables, SearchXataRecord, SelectableColumn, SelectedPick, Serializer, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, SummarizeTableError, SummarizeTablePathParams, SummarizeTableRequestBody, SummarizeTableVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, UpdateBranchSchemaVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateDatabaseMetadataError, UpdateDatabaseMetadataPathParams, UpdateDatabaseMetadataRequestBody, UpdateDatabaseMetadataVariables, UpdateMigrationRequestError, UpdateMigrationRequestPathParams, UpdateMigrationRequestRequestBody, UpdateMigrationRequestVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberInviteError, UpdateWorkspaceMemberInvitePathParams, UpdateWorkspaceMemberInviteRequestBody, UpdateWorkspaceMemberInviteVariables, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, 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, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID };
|
7525
|
+
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, AggregateTableError, AggregateTablePathParams, AggregateTableRequestBody, AggregateTableVariables, ApiExtraProps, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BranchTransactionError, BranchTransactionPathParams, BranchTransactionRequestBody, BranchTransactionVariables, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, ColumnsByValue, CompareBranchSchemasError, CompareBranchSchemasPathParams, CompareBranchSchemasVariables, CompareBranchWithUserSchemaError, CompareBranchWithUserSchemaPathParams, CompareBranchWithUserSchemaRequestBody, CompareBranchWithUserSchemaVariables, CompareMigrationRequestError, CompareMigrationRequestPathParams, CompareMigrationRequestVariables, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchResponse, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateMigrationRequestError, CreateMigrationRequestPathParams, CreateMigrationRequestRequestBody, CreateMigrationRequestResponse, CreateMigrationRequestVariables, CreateTableError, CreateTablePathParams, CreateTableResponse, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DEPRECATEDcreateDatabaseError, DEPRECATEDcreateDatabasePathParams, DEPRECATEDcreateDatabaseRequestBody, DEPRECATEDcreateDatabaseResponse, DEPRECATEDcreateDatabaseVariables, DEPRECATEDdeleteDatabaseError, DEPRECATEDdeleteDatabasePathParams, DEPRECATEDdeleteDatabaseResponse, DEPRECATEDdeleteDatabaseVariables, DEPRECATEDgetDatabaseListError, DEPRECATEDgetDatabaseListPathParams, DEPRECATEDgetDatabaseListVariables, DEPRECATEDgetDatabaseMetadataError, DEPRECATEDgetDatabaseMetadataPathParams, DEPRECATEDgetDatabaseMetadataVariables, DEPRECATEDupdateDatabaseMetadataError, DEPRECATEDupdateDatabaseMetadataPathParams, DEPRECATEDupdateDatabaseMetadataRequestBody, DEPRECATEDupdateDatabaseMetadataVariables, DeleteBranchError, DeleteBranchPathParams, DeleteBranchResponse, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseResponse, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableResponse, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchSchemaHistoryError, GetBranchSchemaHistoryPathParams, GetBranchSchemaHistoryRequestBody, GetBranchSchemaHistoryResponse, GetBranchSchemaHistoryVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetDatabaseMetadataError, GetDatabaseMetadataPathParams, GetDatabaseMetadataVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetMigrationRequestError, GetMigrationRequestIsMergedError, GetMigrationRequestIsMergedPathParams, GetMigrationRequestIsMergedResponse, GetMigrationRequestIsMergedVariables, GetMigrationRequestPathParams, GetMigrationRequestVariables, GetRecordError, GetRecordPathParams, GetRecordQueryParams, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, HostProvider, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, Link, ListMigrationRequestsCommitsError, ListMigrationRequestsCommitsPathParams, ListMigrationRequestsCommitsRequestBody, ListMigrationRequestsCommitsResponse, ListMigrationRequestsCommitsVariables, ListRegionsError, ListRegionsPathParams, ListRegionsVariables, MergeMigrationRequestError, MergeMigrationRequestPathParams, MergeMigrationRequestVariables, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, PreviewBranchSchemaEditError, PreviewBranchSchemaEditPathParams, PreviewBranchSchemaEditRequestBody, PreviewBranchSchemaEditResponse, PreviewBranchSchemaEditVariables, Query, QueryMigrationRequestsError, QueryMigrationRequestsPathParams, QueryMigrationRequestsRequestBody, QueryMigrationRequestsResponse, QueryMigrationRequestsVariables, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RecordArray, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaInference, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SearchTableError, SearchTablePathParams, SearchTableRequestBody, SearchTableVariables, SearchXataRecord, SelectableColumn, SelectedPick, Serializer, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, SummarizeTableError, SummarizeTablePathParams, SummarizeTableRequestBody, SummarizeTableVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, UpdateBranchSchemaVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateDatabaseMetadataError, UpdateDatabaseMetadataPathParams, UpdateDatabaseMetadataRequestBody, UpdateDatabaseMetadataVariables, UpdateMigrationRequestError, UpdateMigrationRequestPathParams, UpdateMigrationRequestRequestBody, UpdateMigrationRequestVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberInviteError, UpdateWorkspaceMemberInvitePathParams, UpdateWorkspaceMemberInviteRequestBody, UpdateWorkspaceMemberInviteVariables, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, branchTransaction, buildClient, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, dEPRECATEDcreateDatabase, dEPRECATEDdeleteDatabase, dEPRECATEDgetDatabaseList, dEPRECATEDgetDatabaseMetadata, dEPRECATEDupdateDatabaseMetadata, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID };
|