@xata.io/client 0.0.0-alpha.vf1de7db → 0.0.0-alpha.vf1f4abe
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 +12 -0
- package/dist/index.cjs +182 -146
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +214 -387
- package/dist/index.mjs +179 -142
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
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,7 @@ declare type FetcherExtraProps = {
|
|
23
24
|
fetchImpl: FetchImpl;
|
24
25
|
apiKey: string;
|
25
26
|
trace: TraceFunction;
|
27
|
+
signal?: AbortSignal;
|
26
28
|
};
|
27
29
|
declare type ErrorWrapper<TError> = TError | {
|
28
30
|
status: 'unknown';
|
@@ -107,7 +109,7 @@ declare type WorkspaceMeta = {
|
|
107
109
|
declare type Workspace = WorkspaceMeta & {
|
108
110
|
id: WorkspaceID;
|
109
111
|
memberCount: number;
|
110
|
-
plan: 'free';
|
112
|
+
plan: 'free' | 'pro';
|
111
113
|
};
|
112
114
|
declare type WorkspaceMember = {
|
113
115
|
userId: UserID;
|
@@ -772,38 +774,6 @@ declare type RecordsMetadata = {
|
|
772
774
|
more: boolean;
|
773
775
|
};
|
774
776
|
};
|
775
|
-
/**
|
776
|
-
* Metadata of databases
|
777
|
-
*/
|
778
|
-
declare type CPDatabaseMetadata = {
|
779
|
-
/**
|
780
|
-
* The machine-readable name of a database
|
781
|
-
*/
|
782
|
-
name: string;
|
783
|
-
/**
|
784
|
-
* Region where this database is hosted
|
785
|
-
*/
|
786
|
-
region: string;
|
787
|
-
/**
|
788
|
-
* The time this database was created
|
789
|
-
*/
|
790
|
-
createdAt: DateTime;
|
791
|
-
/**
|
792
|
-
* Metadata about the database for display in Xata user interfaces
|
793
|
-
*/
|
794
|
-
ui?: {
|
795
|
-
/**
|
796
|
-
* The user-selected color for this database across interfaces
|
797
|
-
*/
|
798
|
-
color?: string;
|
799
|
-
};
|
800
|
-
};
|
801
|
-
declare type CPListDatabasesResponse = {
|
802
|
-
/**
|
803
|
-
* A list of databases in a Xata workspace
|
804
|
-
*/
|
805
|
-
databases?: CPDatabaseMetadata[];
|
806
|
-
};
|
807
777
|
/**
|
808
778
|
* Xata Table Record Metadata
|
809
779
|
*/
|
@@ -885,8 +855,6 @@ type schemas_RecordMeta = RecordMeta;
|
|
885
855
|
type schemas_RecordID = RecordID;
|
886
856
|
type schemas_TableRename = TableRename;
|
887
857
|
type schemas_RecordsMetadata = RecordsMetadata;
|
888
|
-
type schemas_CPDatabaseMetadata = CPDatabaseMetadata;
|
889
|
-
type schemas_CPListDatabasesResponse = CPListDatabasesResponse;
|
890
858
|
declare namespace schemas {
|
891
859
|
export {
|
892
860
|
schemas_User as User,
|
@@ -966,8 +934,6 @@ declare namespace schemas {
|
|
966
934
|
schemas_RecordID as RecordID,
|
967
935
|
schemas_TableRename as TableRename,
|
968
936
|
schemas_RecordsMetadata as RecordsMetadata,
|
969
|
-
schemas_CPDatabaseMetadata as CPDatabaseMetadata,
|
970
|
-
schemas_CPListDatabasesResponse as CPListDatabasesResponse,
|
971
937
|
XataRecord$1 as XataRecord,
|
972
938
|
};
|
973
939
|
}
|
@@ -1092,7 +1058,7 @@ declare type GetUserVariables = FetcherExtraProps;
|
|
1092
1058
|
/**
|
1093
1059
|
* Return details of the user making the request
|
1094
1060
|
*/
|
1095
|
-
declare const getUser: (variables: GetUserVariables) => Promise<UserWithID>;
|
1061
|
+
declare const getUser: (variables: GetUserVariables, signal?: AbortSignal) => Promise<UserWithID>;
|
1096
1062
|
declare type UpdateUserError = ErrorWrapper<{
|
1097
1063
|
status: 400;
|
1098
1064
|
payload: BadRequestError;
|
@@ -1109,7 +1075,7 @@ declare type UpdateUserVariables = {
|
|
1109
1075
|
/**
|
1110
1076
|
* Update user info
|
1111
1077
|
*/
|
1112
|
-
declare const updateUser: (variables: UpdateUserVariables) => Promise<UserWithID>;
|
1078
|
+
declare const updateUser: (variables: UpdateUserVariables, signal?: AbortSignal) => Promise<UserWithID>;
|
1113
1079
|
declare type DeleteUserError = ErrorWrapper<{
|
1114
1080
|
status: 400;
|
1115
1081
|
payload: BadRequestError;
|
@@ -1124,7 +1090,7 @@ declare type DeleteUserVariables = FetcherExtraProps;
|
|
1124
1090
|
/**
|
1125
1091
|
* Delete the user making the request
|
1126
1092
|
*/
|
1127
|
-
declare const deleteUser: (variables: DeleteUserVariables) => Promise<undefined>;
|
1093
|
+
declare const deleteUser: (variables: DeleteUserVariables, signal?: AbortSignal) => Promise<undefined>;
|
1128
1094
|
declare type GetUserAPIKeysError = ErrorWrapper<{
|
1129
1095
|
status: 400;
|
1130
1096
|
payload: BadRequestError;
|
@@ -1145,7 +1111,7 @@ declare type GetUserAPIKeysVariables = FetcherExtraProps;
|
|
1145
1111
|
/**
|
1146
1112
|
* Retrieve a list of existing user API keys
|
1147
1113
|
*/
|
1148
|
-
declare const getUserAPIKeys: (variables: GetUserAPIKeysVariables) => Promise<GetUserAPIKeysResponse>;
|
1114
|
+
declare const getUserAPIKeys: (variables: GetUserAPIKeysVariables, signal?: AbortSignal) => Promise<GetUserAPIKeysResponse>;
|
1149
1115
|
declare type CreateUserAPIKeyPathParams = {
|
1150
1116
|
/**
|
1151
1117
|
* API Key name
|
@@ -1173,7 +1139,7 @@ declare type CreateUserAPIKeyVariables = {
|
|
1173
1139
|
/**
|
1174
1140
|
* Create and return new API key
|
1175
1141
|
*/
|
1176
|
-
declare const createUserAPIKey: (variables: CreateUserAPIKeyVariables) => Promise<CreateUserAPIKeyResponse>;
|
1142
|
+
declare const createUserAPIKey: (variables: CreateUserAPIKeyVariables, signal?: AbortSignal) => Promise<CreateUserAPIKeyResponse>;
|
1177
1143
|
declare type DeleteUserAPIKeyPathParams = {
|
1178
1144
|
/**
|
1179
1145
|
* API Key name
|
@@ -1196,7 +1162,7 @@ declare type DeleteUserAPIKeyVariables = {
|
|
1196
1162
|
/**
|
1197
1163
|
* Delete an existing API key
|
1198
1164
|
*/
|
1199
|
-
declare const deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables) => Promise<undefined>;
|
1165
|
+
declare const deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal) => Promise<undefined>;
|
1200
1166
|
declare type CreateWorkspaceError = ErrorWrapper<{
|
1201
1167
|
status: 400;
|
1202
1168
|
payload: BadRequestError;
|
@@ -1213,7 +1179,7 @@ declare type CreateWorkspaceVariables = {
|
|
1213
1179
|
/**
|
1214
1180
|
* Creates a new workspace with the user requesting it as its single owner.
|
1215
1181
|
*/
|
1216
|
-
declare const createWorkspace: (variables: CreateWorkspaceVariables) => Promise<Workspace>;
|
1182
|
+
declare const createWorkspace: (variables: CreateWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
1217
1183
|
declare type GetWorkspacesListError = ErrorWrapper<{
|
1218
1184
|
status: 400;
|
1219
1185
|
payload: BadRequestError;
|
@@ -1236,10 +1202,10 @@ declare type GetWorkspacesListVariables = FetcherExtraProps;
|
|
1236
1202
|
/**
|
1237
1203
|
* Retrieve the list of workspaces the user belongs to
|
1238
1204
|
*/
|
1239
|
-
declare const getWorkspacesList: (variables: GetWorkspacesListVariables) => Promise<GetWorkspacesListResponse>;
|
1205
|
+
declare const getWorkspacesList: (variables: GetWorkspacesListVariables, signal?: AbortSignal) => Promise<GetWorkspacesListResponse>;
|
1240
1206
|
declare type GetWorkspacePathParams = {
|
1241
1207
|
/**
|
1242
|
-
* Workspace
|
1208
|
+
* Workspace ID
|
1243
1209
|
*/
|
1244
1210
|
workspaceId: WorkspaceID;
|
1245
1211
|
};
|
@@ -1259,10 +1225,10 @@ declare type GetWorkspaceVariables = {
|
|
1259
1225
|
/**
|
1260
1226
|
* Retrieve workspace info from a workspace ID
|
1261
1227
|
*/
|
1262
|
-
declare const getWorkspace: (variables: GetWorkspaceVariables) => Promise<Workspace>;
|
1228
|
+
declare const getWorkspace: (variables: GetWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
1263
1229
|
declare type UpdateWorkspacePathParams = {
|
1264
1230
|
/**
|
1265
|
-
* Workspace
|
1231
|
+
* Workspace ID
|
1266
1232
|
*/
|
1267
1233
|
workspaceId: WorkspaceID;
|
1268
1234
|
};
|
@@ -1283,10 +1249,10 @@ declare type UpdateWorkspaceVariables = {
|
|
1283
1249
|
/**
|
1284
1250
|
* Update workspace info
|
1285
1251
|
*/
|
1286
|
-
declare const updateWorkspace: (variables: UpdateWorkspaceVariables) => Promise<Workspace>;
|
1252
|
+
declare const updateWorkspace: (variables: UpdateWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
1287
1253
|
declare type DeleteWorkspacePathParams = {
|
1288
1254
|
/**
|
1289
|
-
* Workspace
|
1255
|
+
* Workspace ID
|
1290
1256
|
*/
|
1291
1257
|
workspaceId: WorkspaceID;
|
1292
1258
|
};
|
@@ -1306,10 +1272,10 @@ declare type DeleteWorkspaceVariables = {
|
|
1306
1272
|
/**
|
1307
1273
|
* Delete the workspace with the provided ID
|
1308
1274
|
*/
|
1309
|
-
declare const deleteWorkspace: (variables: DeleteWorkspaceVariables) => Promise<undefined>;
|
1275
|
+
declare const deleteWorkspace: (variables: DeleteWorkspaceVariables, signal?: AbortSignal) => Promise<undefined>;
|
1310
1276
|
declare type GetWorkspaceMembersListPathParams = {
|
1311
1277
|
/**
|
1312
|
-
* Workspace
|
1278
|
+
* Workspace ID
|
1313
1279
|
*/
|
1314
1280
|
workspaceId: WorkspaceID;
|
1315
1281
|
};
|
@@ -1329,10 +1295,10 @@ declare type GetWorkspaceMembersListVariables = {
|
|
1329
1295
|
/**
|
1330
1296
|
* Retrieve the list of members of the given workspace
|
1331
1297
|
*/
|
1332
|
-
declare const getWorkspaceMembersList: (variables: GetWorkspaceMembersListVariables) => Promise<WorkspaceMembers>;
|
1298
|
+
declare const getWorkspaceMembersList: (variables: GetWorkspaceMembersListVariables, signal?: AbortSignal) => Promise<WorkspaceMembers>;
|
1333
1299
|
declare type UpdateWorkspaceMemberRolePathParams = {
|
1334
1300
|
/**
|
1335
|
-
* Workspace
|
1301
|
+
* Workspace ID
|
1336
1302
|
*/
|
1337
1303
|
workspaceId: WorkspaceID;
|
1338
1304
|
/**
|
@@ -1360,10 +1326,10 @@ declare type UpdateWorkspaceMemberRoleVariables = {
|
|
1360
1326
|
/**
|
1361
1327
|
* 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.
|
1362
1328
|
*/
|
1363
|
-
declare const updateWorkspaceMemberRole: (variables: UpdateWorkspaceMemberRoleVariables) => Promise<undefined>;
|
1329
|
+
declare const updateWorkspaceMemberRole: (variables: UpdateWorkspaceMemberRoleVariables, signal?: AbortSignal) => Promise<undefined>;
|
1364
1330
|
declare type RemoveWorkspaceMemberPathParams = {
|
1365
1331
|
/**
|
1366
|
-
* Workspace
|
1332
|
+
* Workspace ID
|
1367
1333
|
*/
|
1368
1334
|
workspaceId: WorkspaceID;
|
1369
1335
|
/**
|
@@ -1387,10 +1353,10 @@ declare type RemoveWorkspaceMemberVariables = {
|
|
1387
1353
|
/**
|
1388
1354
|
* Remove the member from the workspace
|
1389
1355
|
*/
|
1390
|
-
declare const removeWorkspaceMember: (variables: RemoveWorkspaceMemberVariables) => Promise<undefined>;
|
1356
|
+
declare const removeWorkspaceMember: (variables: RemoveWorkspaceMemberVariables, signal?: AbortSignal) => Promise<undefined>;
|
1391
1357
|
declare type InviteWorkspaceMemberPathParams = {
|
1392
1358
|
/**
|
1393
|
-
* Workspace
|
1359
|
+
* Workspace ID
|
1394
1360
|
*/
|
1395
1361
|
workspaceId: WorkspaceID;
|
1396
1362
|
};
|
@@ -1421,10 +1387,10 @@ declare type InviteWorkspaceMemberVariables = {
|
|
1421
1387
|
/**
|
1422
1388
|
* Invite some user to join the workspace with the given role
|
1423
1389
|
*/
|
1424
|
-
declare const inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables) => Promise<WorkspaceInvite>;
|
1390
|
+
declare const inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables, signal?: AbortSignal) => Promise<WorkspaceInvite>;
|
1425
1391
|
declare type UpdateWorkspaceMemberInvitePathParams = {
|
1426
1392
|
/**
|
1427
|
-
* Workspace
|
1393
|
+
* Workspace ID
|
1428
1394
|
*/
|
1429
1395
|
workspaceId: WorkspaceID;
|
1430
1396
|
/**
|
@@ -1455,10 +1421,10 @@ declare type UpdateWorkspaceMemberInviteVariables = {
|
|
1455
1421
|
/**
|
1456
1422
|
* 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.
|
1457
1423
|
*/
|
1458
|
-
declare const updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables) => Promise<WorkspaceInvite>;
|
1424
|
+
declare const updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<WorkspaceInvite>;
|
1459
1425
|
declare type CancelWorkspaceMemberInvitePathParams = {
|
1460
1426
|
/**
|
1461
|
-
* Workspace
|
1427
|
+
* Workspace ID
|
1462
1428
|
*/
|
1463
1429
|
workspaceId: WorkspaceID;
|
1464
1430
|
/**
|
@@ -1482,10 +1448,10 @@ declare type CancelWorkspaceMemberInviteVariables = {
|
|
1482
1448
|
/**
|
1483
1449
|
* This operation provides a way to cancel invites by deleting them. Already accepted invites cannot be deleted.
|
1484
1450
|
*/
|
1485
|
-
declare const cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables) => Promise<undefined>;
|
1451
|
+
declare const cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
1486
1452
|
declare type ResendWorkspaceMemberInvitePathParams = {
|
1487
1453
|
/**
|
1488
|
-
* Workspace
|
1454
|
+
* Workspace ID
|
1489
1455
|
*/
|
1490
1456
|
workspaceId: WorkspaceID;
|
1491
1457
|
/**
|
@@ -1509,10 +1475,10 @@ declare type ResendWorkspaceMemberInviteVariables = {
|
|
1509
1475
|
/**
|
1510
1476
|
* This operation provides a way to resend an Invite notification. Invite notifications can only be sent for Invites not yet accepted.
|
1511
1477
|
*/
|
1512
|
-
declare const resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables) => Promise<undefined>;
|
1478
|
+
declare const resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
1513
1479
|
declare type AcceptWorkspaceMemberInvitePathParams = {
|
1514
1480
|
/**
|
1515
|
-
* Workspace
|
1481
|
+
* Workspace ID
|
1516
1482
|
*/
|
1517
1483
|
workspaceId: WorkspaceID;
|
1518
1484
|
/**
|
@@ -1536,7 +1502,7 @@ declare type AcceptWorkspaceMemberInviteVariables = {
|
|
1536
1502
|
/**
|
1537
1503
|
* Accept the invitation to join a workspace. If the operation succeeds the user will be a member of the workspace
|
1538
1504
|
*/
|
1539
|
-
declare const acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables) => Promise<undefined>;
|
1505
|
+
declare const acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
1540
1506
|
declare type GetDatabaseListPathParams = {
|
1541
1507
|
workspace: string;
|
1542
1508
|
};
|
@@ -1553,7 +1519,7 @@ declare type GetDatabaseListVariables = {
|
|
1553
1519
|
/**
|
1554
1520
|
* List all databases available in your Workspace.
|
1555
1521
|
*/
|
1556
|
-
declare const getDatabaseList: (variables: GetDatabaseListVariables) => Promise<ListDatabasesResponse>;
|
1522
|
+
declare const getDatabaseList: (variables: GetDatabaseListVariables, signal?: AbortSignal) => Promise<ListDatabasesResponse>;
|
1557
1523
|
declare type GetBranchListPathParams = {
|
1558
1524
|
/**
|
1559
1525
|
* The Database Name
|
@@ -1577,7 +1543,7 @@ declare type GetBranchListVariables = {
|
|
1577
1543
|
/**
|
1578
1544
|
* List all available Branches
|
1579
1545
|
*/
|
1580
|
-
declare const getBranchList: (variables: GetBranchListVariables) => Promise<ListBranchesResponse>;
|
1546
|
+
declare const getBranchList: (variables: GetBranchListVariables, signal?: AbortSignal) => Promise<ListBranchesResponse>;
|
1581
1547
|
declare type CreateDatabasePathParams = {
|
1582
1548
|
/**
|
1583
1549
|
* The Database Name
|
@@ -1616,7 +1582,7 @@ declare type CreateDatabaseVariables = {
|
|
1616
1582
|
/**
|
1617
1583
|
* Create Database with identifier name
|
1618
1584
|
*/
|
1619
|
-
declare const createDatabase: (variables: CreateDatabaseVariables) => Promise<CreateDatabaseResponse>;
|
1585
|
+
declare const createDatabase: (variables: CreateDatabaseVariables, signal?: AbortSignal) => Promise<CreateDatabaseResponse>;
|
1620
1586
|
declare type DeleteDatabasePathParams = {
|
1621
1587
|
/**
|
1622
1588
|
* The Database Name
|
@@ -1640,7 +1606,7 @@ declare type DeleteDatabaseVariables = {
|
|
1640
1606
|
/**
|
1641
1607
|
* Delete a database and all of its branches and tables permanently.
|
1642
1608
|
*/
|
1643
|
-
declare const deleteDatabase: (variables: DeleteDatabaseVariables) => Promise<undefined>;
|
1609
|
+
declare const deleteDatabase: (variables: DeleteDatabaseVariables, signal?: AbortSignal) => Promise<undefined>;
|
1644
1610
|
declare type GetDatabaseMetadataPathParams = {
|
1645
1611
|
/**
|
1646
1612
|
* The Database Name
|
@@ -1664,7 +1630,7 @@ declare type GetDatabaseMetadataVariables = {
|
|
1664
1630
|
/**
|
1665
1631
|
* Retrieve metadata of the given database
|
1666
1632
|
*/
|
1667
|
-
declare const getDatabaseMetadata: (variables: GetDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
|
1633
|
+
declare const getDatabaseMetadata: (variables: GetDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
1668
1634
|
declare type UpdateDatabaseMetadataPathParams = {
|
1669
1635
|
/**
|
1670
1636
|
* The Database Name
|
@@ -1697,7 +1663,7 @@ declare type UpdateDatabaseMetadataVariables = {
|
|
1697
1663
|
/**
|
1698
1664
|
* Update the color of the selected database
|
1699
1665
|
*/
|
1700
|
-
declare const updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
|
1666
|
+
declare const updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
1701
1667
|
declare type GetGitBranchesMappingPathParams = {
|
1702
1668
|
/**
|
1703
1669
|
* The Database Name
|
@@ -1739,7 +1705,7 @@ declare type GetGitBranchesMappingVariables = {
|
|
1739
1705
|
* }
|
1740
1706
|
* ```
|
1741
1707
|
*/
|
1742
|
-
declare const getGitBranchesMapping: (variables: GetGitBranchesMappingVariables) => Promise<ListGitBranchesResponse>;
|
1708
|
+
declare const getGitBranchesMapping: (variables: GetGitBranchesMappingVariables, signal?: AbortSignal) => Promise<ListGitBranchesResponse>;
|
1743
1709
|
declare type AddGitBranchesEntryPathParams = {
|
1744
1710
|
/**
|
1745
1711
|
* The Database Name
|
@@ -1789,7 +1755,7 @@ declare type AddGitBranchesEntryVariables = {
|
|
1789
1755
|
* }
|
1790
1756
|
* ```
|
1791
1757
|
*/
|
1792
|
-
declare const addGitBranchesEntry: (variables: AddGitBranchesEntryVariables) => Promise<AddGitBranchesEntryResponse>;
|
1758
|
+
declare const addGitBranchesEntry: (variables: AddGitBranchesEntryVariables, signal?: AbortSignal) => Promise<AddGitBranchesEntryResponse>;
|
1793
1759
|
declare type RemoveGitBranchesEntryPathParams = {
|
1794
1760
|
/**
|
1795
1761
|
* The Database Name
|
@@ -1823,7 +1789,7 @@ declare type RemoveGitBranchesEntryVariables = {
|
|
1823
1789
|
* // DELETE https://tutorial-ng7s8c.xata.sh/dbs/demo/gitBranches?gitBranch=fix%2Fbug123
|
1824
1790
|
* ```
|
1825
1791
|
*/
|
1826
|
-
declare const removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables) => Promise<undefined>;
|
1792
|
+
declare const removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables, signal?: AbortSignal) => Promise<undefined>;
|
1827
1793
|
declare type ResolveBranchPathParams = {
|
1828
1794
|
/**
|
1829
1795
|
* The Database Name
|
@@ -1884,7 +1850,7 @@ declare type ResolveBranchVariables = {
|
|
1884
1850
|
* }
|
1885
1851
|
* ```
|
1886
1852
|
*/
|
1887
|
-
declare const resolveBranch: (variables: ResolveBranchVariables) => Promise<ResolveBranchResponse>;
|
1853
|
+
declare const resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal) => Promise<ResolveBranchResponse>;
|
1888
1854
|
declare type QueryMigrationRequestsPathParams = {
|
1889
1855
|
/**
|
1890
1856
|
* The Database Name
|
@@ -1916,7 +1882,7 @@ declare type QueryMigrationRequestsVariables = {
|
|
1916
1882
|
body?: QueryMigrationRequestsRequestBody;
|
1917
1883
|
pathParams: QueryMigrationRequestsPathParams;
|
1918
1884
|
} & FetcherExtraProps;
|
1919
|
-
declare const queryMigrationRequests: (variables: QueryMigrationRequestsVariables) => Promise<QueryMigrationRequestsResponse>;
|
1885
|
+
declare const queryMigrationRequests: (variables: QueryMigrationRequestsVariables, signal?: AbortSignal) => Promise<QueryMigrationRequestsResponse>;
|
1920
1886
|
declare type CreateMigrationRequestPathParams = {
|
1921
1887
|
/**
|
1922
1888
|
* The Database Name
|
@@ -1959,7 +1925,7 @@ declare type CreateMigrationRequestVariables = {
|
|
1959
1925
|
body: CreateMigrationRequestRequestBody;
|
1960
1926
|
pathParams: CreateMigrationRequestPathParams;
|
1961
1927
|
} & FetcherExtraProps;
|
1962
|
-
declare const createMigrationRequest: (variables: CreateMigrationRequestVariables) => Promise<CreateMigrationRequestResponse>;
|
1928
|
+
declare const createMigrationRequest: (variables: CreateMigrationRequestVariables, signal?: AbortSignal) => Promise<CreateMigrationRequestResponse>;
|
1963
1929
|
declare type GetMigrationRequestPathParams = {
|
1964
1930
|
/**
|
1965
1931
|
* The Database Name
|
@@ -1984,7 +1950,7 @@ declare type GetMigrationRequestError = ErrorWrapper<{
|
|
1984
1950
|
declare type GetMigrationRequestVariables = {
|
1985
1951
|
pathParams: GetMigrationRequestPathParams;
|
1986
1952
|
} & FetcherExtraProps;
|
1987
|
-
declare const getMigrationRequest: (variables: GetMigrationRequestVariables) => Promise<MigrationRequest>;
|
1953
|
+
declare const getMigrationRequest: (variables: GetMigrationRequestVariables, signal?: AbortSignal) => Promise<MigrationRequest>;
|
1988
1954
|
declare type UpdateMigrationRequestPathParams = {
|
1989
1955
|
/**
|
1990
1956
|
* The Database Name
|
@@ -2024,7 +1990,7 @@ declare type UpdateMigrationRequestVariables = {
|
|
2024
1990
|
body?: UpdateMigrationRequestRequestBody;
|
2025
1991
|
pathParams: UpdateMigrationRequestPathParams;
|
2026
1992
|
} & FetcherExtraProps;
|
2027
|
-
declare const updateMigrationRequest: (variables: UpdateMigrationRequestVariables) => Promise<undefined>;
|
1993
|
+
declare const updateMigrationRequest: (variables: UpdateMigrationRequestVariables, signal?: AbortSignal) => Promise<undefined>;
|
2028
1994
|
declare type ListMigrationRequestsCommitsPathParams = {
|
2029
1995
|
/**
|
2030
1996
|
* The Database Name
|
@@ -2081,7 +2047,7 @@ declare type ListMigrationRequestsCommitsVariables = {
|
|
2081
2047
|
body?: ListMigrationRequestsCommitsRequestBody;
|
2082
2048
|
pathParams: ListMigrationRequestsCommitsPathParams;
|
2083
2049
|
} & FetcherExtraProps;
|
2084
|
-
declare const listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables) => Promise<ListMigrationRequestsCommitsResponse>;
|
2050
|
+
declare const listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables, signal?: AbortSignal) => Promise<ListMigrationRequestsCommitsResponse>;
|
2085
2051
|
declare type CompareMigrationRequestPathParams = {
|
2086
2052
|
/**
|
2087
2053
|
* The Database Name
|
@@ -2106,7 +2072,7 @@ declare type CompareMigrationRequestError = ErrorWrapper<{
|
|
2106
2072
|
declare type CompareMigrationRequestVariables = {
|
2107
2073
|
pathParams: CompareMigrationRequestPathParams;
|
2108
2074
|
} & FetcherExtraProps;
|
2109
|
-
declare const compareMigrationRequest: (variables: CompareMigrationRequestVariables) => Promise<SchemaCompareResponse>;
|
2075
|
+
declare const compareMigrationRequest: (variables: CompareMigrationRequestVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
2110
2076
|
declare type GetMigrationRequestIsMergedPathParams = {
|
2111
2077
|
/**
|
2112
2078
|
* The Database Name
|
@@ -2134,7 +2100,7 @@ declare type GetMigrationRequestIsMergedResponse = {
|
|
2134
2100
|
declare type GetMigrationRequestIsMergedVariables = {
|
2135
2101
|
pathParams: GetMigrationRequestIsMergedPathParams;
|
2136
2102
|
} & FetcherExtraProps;
|
2137
|
-
declare const getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables) => Promise<GetMigrationRequestIsMergedResponse>;
|
2103
|
+
declare const getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables, signal?: AbortSignal) => Promise<GetMigrationRequestIsMergedResponse>;
|
2138
2104
|
declare type MergeMigrationRequestPathParams = {
|
2139
2105
|
/**
|
2140
2106
|
* The Database Name
|
@@ -2159,7 +2125,7 @@ declare type MergeMigrationRequestError = ErrorWrapper<{
|
|
2159
2125
|
declare type MergeMigrationRequestVariables = {
|
2160
2126
|
pathParams: MergeMigrationRequestPathParams;
|
2161
2127
|
} & FetcherExtraProps;
|
2162
|
-
declare const mergeMigrationRequest: (variables: MergeMigrationRequestVariables) => Promise<Commit>;
|
2128
|
+
declare const mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal) => Promise<Commit>;
|
2163
2129
|
declare type GetBranchDetailsPathParams = {
|
2164
2130
|
/**
|
2165
2131
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2180,7 +2146,7 @@ declare type GetBranchDetailsError = ErrorWrapper<{
|
|
2180
2146
|
declare type GetBranchDetailsVariables = {
|
2181
2147
|
pathParams: GetBranchDetailsPathParams;
|
2182
2148
|
} & FetcherExtraProps;
|
2183
|
-
declare const getBranchDetails: (variables: GetBranchDetailsVariables) => Promise<DBBranch>;
|
2149
|
+
declare const getBranchDetails: (variables: GetBranchDetailsVariables, signal?: AbortSignal) => Promise<DBBranch>;
|
2184
2150
|
declare type CreateBranchPathParams = {
|
2185
2151
|
/**
|
2186
2152
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2223,7 +2189,7 @@ declare type CreateBranchVariables = {
|
|
2223
2189
|
pathParams: CreateBranchPathParams;
|
2224
2190
|
queryParams?: CreateBranchQueryParams;
|
2225
2191
|
} & FetcherExtraProps;
|
2226
|
-
declare const createBranch: (variables: CreateBranchVariables) => Promise<CreateBranchResponse>;
|
2192
|
+
declare const createBranch: (variables: CreateBranchVariables, signal?: AbortSignal) => Promise<CreateBranchResponse>;
|
2227
2193
|
declare type DeleteBranchPathParams = {
|
2228
2194
|
/**
|
2229
2195
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2247,7 +2213,7 @@ declare type DeleteBranchVariables = {
|
|
2247
2213
|
/**
|
2248
2214
|
* Delete the branch in the database and all its resources
|
2249
2215
|
*/
|
2250
|
-
declare const deleteBranch: (variables: DeleteBranchVariables) => Promise<undefined>;
|
2216
|
+
declare const deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal) => Promise<undefined>;
|
2251
2217
|
declare type UpdateBranchMetadataPathParams = {
|
2252
2218
|
/**
|
2253
2219
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2272,7 +2238,7 @@ declare type UpdateBranchMetadataVariables = {
|
|
2272
2238
|
/**
|
2273
2239
|
* Update the branch metadata
|
2274
2240
|
*/
|
2275
|
-
declare const updateBranchMetadata: (variables: UpdateBranchMetadataVariables) => Promise<undefined>;
|
2241
|
+
declare const updateBranchMetadata: (variables: UpdateBranchMetadataVariables, signal?: AbortSignal) => Promise<undefined>;
|
2276
2242
|
declare type GetBranchMetadataPathParams = {
|
2277
2243
|
/**
|
2278
2244
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2293,7 +2259,7 @@ declare type GetBranchMetadataError = ErrorWrapper<{
|
|
2293
2259
|
declare type GetBranchMetadataVariables = {
|
2294
2260
|
pathParams: GetBranchMetadataPathParams;
|
2295
2261
|
} & FetcherExtraProps;
|
2296
|
-
declare const getBranchMetadata: (variables: GetBranchMetadataVariables) => Promise<BranchMetadata>;
|
2262
|
+
declare const getBranchMetadata: (variables: GetBranchMetadataVariables, signal?: AbortSignal) => Promise<BranchMetadata>;
|
2297
2263
|
declare type GetBranchMigrationHistoryPathParams = {
|
2298
2264
|
/**
|
2299
2265
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2323,7 +2289,7 @@ declare type GetBranchMigrationHistoryVariables = {
|
|
2323
2289
|
body?: GetBranchMigrationHistoryRequestBody;
|
2324
2290
|
pathParams: GetBranchMigrationHistoryPathParams;
|
2325
2291
|
} & FetcherExtraProps;
|
2326
|
-
declare const getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables) => Promise<GetBranchMigrationHistoryResponse>;
|
2292
|
+
declare const getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal) => Promise<GetBranchMigrationHistoryResponse>;
|
2327
2293
|
declare type ExecuteBranchMigrationPlanPathParams = {
|
2328
2294
|
/**
|
2329
2295
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2352,7 +2318,7 @@ declare type ExecuteBranchMigrationPlanVariables = {
|
|
2352
2318
|
/**
|
2353
2319
|
* Apply a migration plan to the branch
|
2354
2320
|
*/
|
2355
|
-
declare const executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables) => Promise<undefined>;
|
2321
|
+
declare const executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<undefined>;
|
2356
2322
|
declare type GetBranchMigrationPlanPathParams = {
|
2357
2323
|
/**
|
2358
2324
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2377,7 +2343,7 @@ declare type GetBranchMigrationPlanVariables = {
|
|
2377
2343
|
/**
|
2378
2344
|
* Compute a migration plan from a target schema the branch should be migrated too.
|
2379
2345
|
*/
|
2380
|
-
declare const getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables) => Promise<BranchMigrationPlan>;
|
2346
|
+
declare const getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<BranchMigrationPlan>;
|
2381
2347
|
declare type CompareBranchWithUserSchemaPathParams = {
|
2382
2348
|
/**
|
2383
2349
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2402,7 +2368,7 @@ declare type CompareBranchWithUserSchemaVariables = {
|
|
2402
2368
|
body: CompareBranchWithUserSchemaRequestBody;
|
2403
2369
|
pathParams: CompareBranchWithUserSchemaPathParams;
|
2404
2370
|
} & FetcherExtraProps;
|
2405
|
-
declare const compareBranchWithUserSchema: (variables: CompareBranchWithUserSchemaVariables) => Promise<SchemaCompareResponse>;
|
2371
|
+
declare const compareBranchWithUserSchema: (variables: CompareBranchWithUserSchemaVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
2406
2372
|
declare type CompareBranchSchemasPathParams = {
|
2407
2373
|
/**
|
2408
2374
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2428,7 +2394,7 @@ declare type CompareBranchSchemasVariables = {
|
|
2428
2394
|
body?: Record<string, any>;
|
2429
2395
|
pathParams: CompareBranchSchemasPathParams;
|
2430
2396
|
} & FetcherExtraProps;
|
2431
|
-
declare const compareBranchSchemas: (variables: CompareBranchSchemasVariables) => Promise<SchemaCompareResponse>;
|
2397
|
+
declare const compareBranchSchemas: (variables: CompareBranchSchemasVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
2432
2398
|
declare type UpdateBranchSchemaPathParams = {
|
2433
2399
|
/**
|
2434
2400
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2454,7 +2420,7 @@ declare type UpdateBranchSchemaVariables = {
|
|
2454
2420
|
body: Migration;
|
2455
2421
|
pathParams: UpdateBranchSchemaPathParams;
|
2456
2422
|
} & FetcherExtraProps;
|
2457
|
-
declare const updateBranchSchema: (variables: UpdateBranchSchemaVariables) => Promise<UpdateBranchSchemaResponse>;
|
2423
|
+
declare const updateBranchSchema: (variables: UpdateBranchSchemaVariables, signal?: AbortSignal) => Promise<UpdateBranchSchemaResponse>;
|
2458
2424
|
declare type PreviewBranchSchemaEditPathParams = {
|
2459
2425
|
/**
|
2460
2426
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2484,7 +2450,7 @@ declare type PreviewBranchSchemaEditVariables = {
|
|
2484
2450
|
body?: PreviewBranchSchemaEditRequestBody;
|
2485
2451
|
pathParams: PreviewBranchSchemaEditPathParams;
|
2486
2452
|
} & FetcherExtraProps;
|
2487
|
-
declare const previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables) => Promise<PreviewBranchSchemaEditResponse>;
|
2453
|
+
declare const previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables, signal?: AbortSignal) => Promise<PreviewBranchSchemaEditResponse>;
|
2488
2454
|
declare type ApplyBranchSchemaEditPathParams = {
|
2489
2455
|
/**
|
2490
2456
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2513,7 +2479,7 @@ declare type ApplyBranchSchemaEditVariables = {
|
|
2513
2479
|
body: ApplyBranchSchemaEditRequestBody;
|
2514
2480
|
pathParams: ApplyBranchSchemaEditPathParams;
|
2515
2481
|
} & FetcherExtraProps;
|
2516
|
-
declare const applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables) => Promise<ApplyBranchSchemaEditResponse>;
|
2482
|
+
declare const applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal) => Promise<ApplyBranchSchemaEditResponse>;
|
2517
2483
|
declare type GetBranchSchemaHistoryPathParams = {
|
2518
2484
|
/**
|
2519
2485
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2566,7 +2532,7 @@ declare type GetBranchSchemaHistoryVariables = {
|
|
2566
2532
|
body?: GetBranchSchemaHistoryRequestBody;
|
2567
2533
|
pathParams: GetBranchSchemaHistoryPathParams;
|
2568
2534
|
} & FetcherExtraProps;
|
2569
|
-
declare const getBranchSchemaHistory: (variables: GetBranchSchemaHistoryVariables) => Promise<GetBranchSchemaHistoryResponse>;
|
2535
|
+
declare const getBranchSchemaHistory: (variables: GetBranchSchemaHistoryVariables, signal?: AbortSignal) => Promise<GetBranchSchemaHistoryResponse>;
|
2570
2536
|
declare type GetBranchStatsPathParams = {
|
2571
2537
|
/**
|
2572
2538
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2601,7 +2567,7 @@ declare type GetBranchStatsVariables = {
|
|
2601
2567
|
/**
|
2602
2568
|
* Get branch usage metrics.
|
2603
2569
|
*/
|
2604
|
-
declare const getBranchStats: (variables: GetBranchStatsVariables) => Promise<GetBranchStatsResponse>;
|
2570
|
+
declare const getBranchStats: (variables: GetBranchStatsVariables, signal?: AbortSignal) => Promise<GetBranchStatsResponse>;
|
2605
2571
|
declare type CreateTablePathParams = {
|
2606
2572
|
/**
|
2607
2573
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2639,7 +2605,7 @@ declare type CreateTableVariables = {
|
|
2639
2605
|
/**
|
2640
2606
|
* Creates a new table with the given name. Returns 422 if a table with the same name already exists.
|
2641
2607
|
*/
|
2642
|
-
declare const createTable: (variables: CreateTableVariables) => Promise<CreateTableResponse>;
|
2608
|
+
declare const createTable: (variables: CreateTableVariables, signal?: AbortSignal) => Promise<CreateTableResponse>;
|
2643
2609
|
declare type DeleteTablePathParams = {
|
2644
2610
|
/**
|
2645
2611
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2664,7 +2630,7 @@ declare type DeleteTableVariables = {
|
|
2664
2630
|
/**
|
2665
2631
|
* Deletes the table with the given name.
|
2666
2632
|
*/
|
2667
|
-
declare const deleteTable: (variables: DeleteTableVariables) => Promise<undefined>;
|
2633
|
+
declare const deleteTable: (variables: DeleteTableVariables, signal?: AbortSignal) => Promise<undefined>;
|
2668
2634
|
declare type UpdateTablePathParams = {
|
2669
2635
|
/**
|
2670
2636
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2709,7 +2675,7 @@ declare type UpdateTableVariables = {
|
|
2709
2675
|
* }
|
2710
2676
|
* ```
|
2711
2677
|
*/
|
2712
|
-
declare const updateTable: (variables: UpdateTableVariables) => Promise<undefined>;
|
2678
|
+
declare const updateTable: (variables: UpdateTableVariables, signal?: AbortSignal) => Promise<undefined>;
|
2713
2679
|
declare type GetTableSchemaPathParams = {
|
2714
2680
|
/**
|
2715
2681
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2737,7 +2703,7 @@ declare type GetTableSchemaResponse = {
|
|
2737
2703
|
declare type GetTableSchemaVariables = {
|
2738
2704
|
pathParams: GetTableSchemaPathParams;
|
2739
2705
|
} & FetcherExtraProps;
|
2740
|
-
declare const getTableSchema: (variables: GetTableSchemaVariables) => Promise<GetTableSchemaResponse>;
|
2706
|
+
declare const getTableSchema: (variables: GetTableSchemaVariables, signal?: AbortSignal) => Promise<GetTableSchemaResponse>;
|
2741
2707
|
declare type SetTableSchemaPathParams = {
|
2742
2708
|
/**
|
2743
2709
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2769,7 +2735,7 @@ declare type SetTableSchemaVariables = {
|
|
2769
2735
|
body: SetTableSchemaRequestBody;
|
2770
2736
|
pathParams: SetTableSchemaPathParams;
|
2771
2737
|
} & FetcherExtraProps;
|
2772
|
-
declare const setTableSchema: (variables: SetTableSchemaVariables) => Promise<undefined>;
|
2738
|
+
declare const setTableSchema: (variables: SetTableSchemaVariables, signal?: AbortSignal) => Promise<undefined>;
|
2773
2739
|
declare type GetTableColumnsPathParams = {
|
2774
2740
|
/**
|
2775
2741
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2801,7 +2767,7 @@ declare type GetTableColumnsVariables = {
|
|
2801
2767
|
* Retrieves the list of table columns and their definition. This endpoint returns the column list with object columns being reported with their
|
2802
2768
|
* full dot-separated path (flattened).
|
2803
2769
|
*/
|
2804
|
-
declare const getTableColumns: (variables: GetTableColumnsVariables) => Promise<GetTableColumnsResponse>;
|
2770
|
+
declare const getTableColumns: (variables: GetTableColumnsVariables, signal?: AbortSignal) => Promise<GetTableColumnsResponse>;
|
2805
2771
|
declare type AddTableColumnPathParams = {
|
2806
2772
|
/**
|
2807
2773
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2832,7 +2798,7 @@ declare type AddTableColumnVariables = {
|
|
2832
2798
|
* contain the full path separated by dots. If the parent objects do not exists, they will be automatically created. For example,
|
2833
2799
|
* passing `"name": "address.city"` will auto-create the `address` object if it doesn't exist.
|
2834
2800
|
*/
|
2835
|
-
declare const addTableColumn: (variables: AddTableColumnVariables) => Promise<MigrationIdResponse>;
|
2801
|
+
declare const addTableColumn: (variables: AddTableColumnVariables, signal?: AbortSignal) => Promise<MigrationIdResponse>;
|
2836
2802
|
declare type GetColumnPathParams = {
|
2837
2803
|
/**
|
2838
2804
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2864,7 +2830,7 @@ declare type GetColumnVariables = {
|
|
2864
2830
|
/**
|
2865
2831
|
* Get the definition of a single column. To refer to sub-objects, the column name can contain dots. For example `address.country`.
|
2866
2832
|
*/
|
2867
|
-
declare const getColumn: (variables: GetColumnVariables) => Promise<Column>;
|
2833
|
+
declare const getColumn: (variables: GetColumnVariables, signal?: AbortSignal) => Promise<Column>;
|
2868
2834
|
declare type DeleteColumnPathParams = {
|
2869
2835
|
/**
|
2870
2836
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2896,7 +2862,7 @@ declare type DeleteColumnVariables = {
|
|
2896
2862
|
/**
|
2897
2863
|
* Deletes the specified column. To refer to sub-objects, the column name can contain dots. For example `address.country`.
|
2898
2864
|
*/
|
2899
|
-
declare const deleteColumn: (variables: DeleteColumnVariables) => Promise<MigrationIdResponse>;
|
2865
|
+
declare const deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal) => Promise<MigrationIdResponse>;
|
2900
2866
|
declare type UpdateColumnPathParams = {
|
2901
2867
|
/**
|
2902
2868
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2935,7 +2901,7 @@ declare type UpdateColumnVariables = {
|
|
2935
2901
|
/**
|
2936
2902
|
* 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`.
|
2937
2903
|
*/
|
2938
|
-
declare const updateColumn: (variables: UpdateColumnVariables) => Promise<MigrationIdResponse>;
|
2904
|
+
declare const updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal) => Promise<MigrationIdResponse>;
|
2939
2905
|
declare type InsertRecordPathParams = {
|
2940
2906
|
/**
|
2941
2907
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2971,7 +2937,7 @@ declare type InsertRecordVariables = {
|
|
2971
2937
|
/**
|
2972
2938
|
* Insert a new Record into the Table
|
2973
2939
|
*/
|
2974
|
-
declare const insertRecord: (variables: InsertRecordVariables) => Promise<RecordUpdateResponse>;
|
2940
|
+
declare const insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
2975
2941
|
declare type InsertRecordWithIDPathParams = {
|
2976
2942
|
/**
|
2977
2943
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3016,7 +2982,7 @@ declare type InsertRecordWithIDVariables = {
|
|
3016
2982
|
/**
|
3017
2983
|
* 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.
|
3018
2984
|
*/
|
3019
|
-
declare const insertRecordWithID: (variables: InsertRecordWithIDVariables) => Promise<RecordUpdateResponse>;
|
2985
|
+
declare const insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
3020
2986
|
declare type UpdateRecordWithIDPathParams = {
|
3021
2987
|
/**
|
3022
2988
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3057,7 +3023,7 @@ declare type UpdateRecordWithIDVariables = {
|
|
3057
3023
|
pathParams: UpdateRecordWithIDPathParams;
|
3058
3024
|
queryParams?: UpdateRecordWithIDQueryParams;
|
3059
3025
|
} & FetcherExtraProps;
|
3060
|
-
declare const updateRecordWithID: (variables: UpdateRecordWithIDVariables) => Promise<RecordUpdateResponse>;
|
3026
|
+
declare const updateRecordWithID: (variables: UpdateRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
3061
3027
|
declare type UpsertRecordWithIDPathParams = {
|
3062
3028
|
/**
|
3063
3029
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3098,7 +3064,7 @@ declare type UpsertRecordWithIDVariables = {
|
|
3098
3064
|
pathParams: UpsertRecordWithIDPathParams;
|
3099
3065
|
queryParams?: UpsertRecordWithIDQueryParams;
|
3100
3066
|
} & FetcherExtraProps;
|
3101
|
-
declare const upsertRecordWithID: (variables: UpsertRecordWithIDVariables) => Promise<RecordUpdateResponse>;
|
3067
|
+
declare const upsertRecordWithID: (variables: UpsertRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
3102
3068
|
declare type DeleteRecordPathParams = {
|
3103
3069
|
/**
|
3104
3070
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3134,7 +3100,7 @@ declare type DeleteRecordVariables = {
|
|
3134
3100
|
pathParams: DeleteRecordPathParams;
|
3135
3101
|
queryParams?: DeleteRecordQueryParams;
|
3136
3102
|
} & FetcherExtraProps;
|
3137
|
-
declare const deleteRecord: (variables: DeleteRecordVariables) => Promise<XataRecord$1>;
|
3103
|
+
declare const deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
|
3138
3104
|
declare type GetRecordPathParams = {
|
3139
3105
|
/**
|
3140
3106
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3173,7 +3139,7 @@ declare type GetRecordVariables = {
|
|
3173
3139
|
/**
|
3174
3140
|
* Retrieve record by ID
|
3175
3141
|
*/
|
3176
|
-
declare const getRecord: (variables: GetRecordVariables) => Promise<XataRecord$1>;
|
3142
|
+
declare const getRecord: (variables: GetRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
|
3177
3143
|
declare type BulkInsertTableRecordsPathParams = {
|
3178
3144
|
/**
|
3179
3145
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3215,7 +3181,7 @@ declare type BulkInsertTableRecordsVariables = {
|
|
3215
3181
|
/**
|
3216
3182
|
* Bulk insert records
|
3217
3183
|
*/
|
3218
|
-
declare const bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables) => Promise<BulkInsertResponse>;
|
3184
|
+
declare const bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal) => Promise<BulkInsertResponse>;
|
3219
3185
|
declare type QueryTablePathParams = {
|
3220
3186
|
/**
|
3221
3187
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3981,7 +3947,7 @@ declare type QueryTableVariables = {
|
|
3981
3947
|
* }
|
3982
3948
|
* ```
|
3983
3949
|
*/
|
3984
|
-
declare const queryTable: (variables: QueryTableVariables) => Promise<QueryResponse>;
|
3950
|
+
declare const queryTable: (variables: QueryTableVariables, signal?: AbortSignal) => Promise<QueryResponse>;
|
3985
3951
|
declare type SearchTablePathParams = {
|
3986
3952
|
/**
|
3987
3953
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -4028,7 +3994,7 @@ declare type SearchTableVariables = {
|
|
4028
3994
|
* * filters `$contains`, `$startsWith`, `$endsWith` don't work on columns of type `text`
|
4029
3995
|
* * filtering on columns of type `multiple` is currently unsupported
|
4030
3996
|
*/
|
4031
|
-
declare const searchTable: (variables: SearchTableVariables) => Promise<SearchResponse>;
|
3997
|
+
declare const searchTable: (variables: SearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
4032
3998
|
declare type SearchBranchPathParams = {
|
4033
3999
|
/**
|
4034
4000
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -4076,7 +4042,7 @@ declare type SearchBranchVariables = {
|
|
4076
4042
|
/**
|
4077
4043
|
* Run a free text search operation across the database branch.
|
4078
4044
|
*/
|
4079
|
-
declare const searchBranch: (variables: SearchBranchVariables) => Promise<SearchResponse>;
|
4045
|
+
declare const searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
4080
4046
|
declare type SummarizeTablePathParams = {
|
4081
4047
|
/**
|
4082
4048
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -4103,6 +4069,7 @@ declare type SummarizeTableRequestBody = {
|
|
4103
4069
|
columns?: ColumnsProjection;
|
4104
4070
|
summaries?: SummaryExpressionList;
|
4105
4071
|
sort?: SortExpression;
|
4072
|
+
summariesFilter?: FilterExpression;
|
4106
4073
|
};
|
4107
4074
|
declare type SummarizeTableVariables = {
|
4108
4075
|
body?: SummarizeTableRequestBody;
|
@@ -4110,298 +4077,154 @@ declare type SummarizeTableVariables = {
|
|
4110
4077
|
} & FetcherExtraProps;
|
4111
4078
|
/**
|
4112
4079
|
* This endpoint allows you to (optionally) define groups, and then to run
|
4113
|
-
* calculations on the values in each group. This is most helpful when
|
4114
|
-
* like to understand the data you have in your database.
|
4080
|
+
* calculations on the values in each group. This is most helpful when
|
4081
|
+
* you'd like to understand the data you have in your database.
|
4115
4082
|
*
|
4116
|
-
* A group is a combination of unique values. If you create a group for
|
4117
|
-
* `product_name`, we will return one row for every combination
|
4118
|
-
* `product_name` you have in your database. When you
|
4119
|
-
* you define these groups and ask Xata to
|
4083
|
+
* A group is a combination of unique values. If you create a group for
|
4084
|
+
* `sold_by`, `product_name`, we will return one row for every combination
|
4085
|
+
* of `sold_by` and `product_name` you have in your database. When you
|
4086
|
+
* want to calculate statistics, you define these groups and ask Xata to
|
4087
|
+
* calculate data on each group.
|
4120
4088
|
*
|
4121
4089
|
* **Some questions you can ask of your data:**
|
4122
4090
|
*
|
4123
4091
|
* How many records do I have in this table?
|
4124
|
-
* - Set `columns: []` as we we want data from the entire table, so we ask
|
4125
|
-
*
|
4126
|
-
*
|
4127
|
-
*
|
4128
|
-
*
|
4129
|
-
*
|
4130
|
-
*
|
4131
|
-
*
|
4132
|
-
*
|
4133
|
-
*
|
4134
|
-
*
|
4135
|
-
*
|
4136
|
-
*
|
4137
|
-
* - Set `
|
4138
|
-
*
|
4139
|
-
*
|
4140
|
-
*
|
4141
|
-
* a
|
4092
|
+
* - Set `columns: []` as we we want data from the entire table, so we ask
|
4093
|
+
* for no groups.
|
4094
|
+
* - Set `summaries: {"total": {"count": "*"}}` in order to see the count
|
4095
|
+
* of all records. We use `count: *` here we'd like to know the total
|
4096
|
+
* amount of rows; ignoring whether they are `null` or not.
|
4097
|
+
*
|
4098
|
+
* What are the top total sales for each product in July 2022 and sold
|
4099
|
+
* more than 10 units?
|
4100
|
+
* - Set `filter: {soldAt: {
|
4101
|
+
* "$ge": "2022-07-01T00:00:00.000Z",
|
4102
|
+
* "$lt": "2022-08-01T00:00:00.000Z"}
|
4103
|
+
* }`
|
4104
|
+
* in order to limit the result set to sales recorded in July 2022.
|
4105
|
+
* - Set `columns: [product_name]` as we'd like to run calculations on
|
4106
|
+
* each unique product name in our table. Setting `columns` like this will
|
4107
|
+
* produce one row per unique product name.
|
4108
|
+
* - Set `summaries: {"total_sales": {"count": "product_name"}}` as we'd
|
4109
|
+
* like to create a field called "total_sales" for each group. This field
|
4110
|
+
* will count all rows in each group with non-null product names.
|
4111
|
+
* - Set `sort: [{"total_sales": "desc"}]` in order to bring the rows with
|
4112
|
+
* the highest total_sales field to the top.
|
4113
|
+
* - Set `having: {"total_sales": {"$ge": 10}}` to only send back data
|
4114
|
+
* with greater than or equal to 10 units.
|
4115
|
+
*
|
4116
|
+
* `columns`: tells Xata how to create each group. If you add `product_id`
|
4117
|
+
* we will create a new group for every unique `product_id`.
|
4142
4118
|
*
|
4143
4119
|
* `summaries`: tells Xata which calculations to run on each group.
|
4144
4120
|
*
|
4145
|
-
* `sort`: tells Xata in which order you'd like to see results. You may
|
4146
|
-
* specified in `columns` as well as the summary names
|
4121
|
+
* `sort`: tells Xata in which order you'd like to see results. You may
|
4122
|
+
* sort by fields specified in `columns` as well as the summary names
|
4123
|
+
* defined in `summaries`.
|
4147
4124
|
*
|
4148
|
-
* note: Sorting on summarized values can be slower on very large tables;
|
4149
|
-
* your rate limit significantly more than other queries.
|
4150
|
-
*
|
4151
|
-
|
4152
|
-
|
4153
|
-
|
4154
|
-
|
4155
|
-
|
4156
|
-
|
4157
|
-
|
4158
|
-
|
4159
|
-
|
4160
|
-
status: 400;
|
4161
|
-
payload: BadRequestError;
|
4162
|
-
} | {
|
4163
|
-
status: 401;
|
4164
|
-
payload: AuthError;
|
4165
|
-
}>;
|
4166
|
-
declare type CPgetDatabaseListVariables = {
|
4167
|
-
pathParams: CPgetDatabaseListPathParams;
|
4168
|
-
} & FetcherExtraProps;
|
4169
|
-
/**
|
4170
|
-
* List all databases available in your Workspace.
|
4171
|
-
*/
|
4172
|
-
declare const cPgetDatabaseList: (variables: CPgetDatabaseListVariables) => Promise<CPListDatabasesResponse>;
|
4173
|
-
declare type CPcreateDatabasePathParams = {
|
4174
|
-
/**
|
4175
|
-
* Workspace name
|
4176
|
-
*/
|
4177
|
-
workspaceId: WorkspaceID;
|
4178
|
-
/**
|
4179
|
-
* The Database Name
|
4180
|
-
*/
|
4181
|
-
dbName: DBName;
|
4182
|
-
};
|
4183
|
-
declare type CPcreateDatabaseError = ErrorWrapper<{
|
4184
|
-
status: 400;
|
4185
|
-
payload: BadRequestError;
|
4186
|
-
} | {
|
4187
|
-
status: 401;
|
4188
|
-
payload: AuthError;
|
4189
|
-
}>;
|
4190
|
-
declare type CPcreateDatabaseResponse = {
|
4191
|
-
/**
|
4192
|
-
* @minLength 1
|
4193
|
-
*/
|
4194
|
-
databaseName?: string;
|
4195
|
-
branchName?: string;
|
4196
|
-
};
|
4197
|
-
declare type CPcreateDatabaseRequestBody = {
|
4198
|
-
/**
|
4199
|
-
* @minLength 1
|
4200
|
-
*/
|
4201
|
-
branchName?: string;
|
4202
|
-
/**
|
4203
|
-
* @minLength 1
|
4204
|
-
*/
|
4205
|
-
region: string;
|
4206
|
-
ui?: {
|
4207
|
-
color?: string;
|
4208
|
-
};
|
4209
|
-
metadata?: BranchMetadata;
|
4210
|
-
};
|
4211
|
-
declare type CPcreateDatabaseVariables = {
|
4212
|
-
body: CPcreateDatabaseRequestBody;
|
4213
|
-
pathParams: CPcreateDatabasePathParams;
|
4214
|
-
} & FetcherExtraProps;
|
4215
|
-
/**
|
4216
|
-
* Create Database with identifier name
|
4217
|
-
*/
|
4218
|
-
declare const cPcreateDatabase: (variables: CPcreateDatabaseVariables) => Promise<CPcreateDatabaseResponse>;
|
4219
|
-
declare type CPdeleteDatabasePathParams = {
|
4220
|
-
/**
|
4221
|
-
* Workspace name
|
4222
|
-
*/
|
4223
|
-
workspaceId: WorkspaceID;
|
4224
|
-
/**
|
4225
|
-
* The Database Name
|
4226
|
-
*/
|
4227
|
-
dbName: DBName;
|
4228
|
-
};
|
4229
|
-
declare type CPdeleteDatabaseError = ErrorWrapper<{
|
4230
|
-
status: 400;
|
4231
|
-
payload: BadRequestError;
|
4232
|
-
} | {
|
4233
|
-
status: 401;
|
4234
|
-
payload: AuthError;
|
4235
|
-
} | {
|
4236
|
-
status: 404;
|
4237
|
-
payload: SimpleError;
|
4238
|
-
}>;
|
4239
|
-
declare type CPdeleteDatabaseVariables = {
|
4240
|
-
pathParams: CPdeleteDatabasePathParams;
|
4241
|
-
} & FetcherExtraProps;
|
4242
|
-
/**
|
4243
|
-
* Delete a database and all of its branches and tables permanently.
|
4244
|
-
*/
|
4245
|
-
declare const cPdeleteDatabase: (variables: CPdeleteDatabaseVariables) => Promise<undefined>;
|
4246
|
-
declare type CPgetCPDatabaseMetadataPathParams = {
|
4247
|
-
/**
|
4248
|
-
* Workspace name
|
4249
|
-
*/
|
4250
|
-
workspaceId: WorkspaceID;
|
4251
|
-
/**
|
4252
|
-
* The Database Name
|
4253
|
-
*/
|
4254
|
-
dbName: DBName;
|
4255
|
-
};
|
4256
|
-
declare type CPgetCPDatabaseMetadataError = ErrorWrapper<{
|
4257
|
-
status: 400;
|
4258
|
-
payload: BadRequestError;
|
4259
|
-
} | {
|
4260
|
-
status: 401;
|
4261
|
-
payload: AuthError;
|
4262
|
-
} | {
|
4263
|
-
status: 404;
|
4264
|
-
payload: SimpleError;
|
4265
|
-
}>;
|
4266
|
-
declare type CPgetCPDatabaseMetadataVariables = {
|
4267
|
-
pathParams: CPgetCPDatabaseMetadataPathParams;
|
4268
|
-
} & FetcherExtraProps;
|
4269
|
-
/**
|
4270
|
-
* Retrieve metadata of the given database
|
4271
|
-
*/
|
4272
|
-
declare const cPgetCPDatabaseMetadata: (variables: CPgetCPDatabaseMetadataVariables) => Promise<CPDatabaseMetadata>;
|
4273
|
-
declare type CPupdateCPDatabaseMetadataPathParams = {
|
4274
|
-
/**
|
4275
|
-
* Workspace name
|
4276
|
-
*/
|
4277
|
-
workspaceId: WorkspaceID;
|
4278
|
-
/**
|
4279
|
-
* The Database Name
|
4280
|
-
*/
|
4281
|
-
dbName: DBName;
|
4282
|
-
};
|
4283
|
-
declare type CPupdateCPDatabaseMetadataError = ErrorWrapper<{
|
4284
|
-
status: 400;
|
4285
|
-
payload: BadRequestError;
|
4286
|
-
} | {
|
4287
|
-
status: 401;
|
4288
|
-
payload: AuthError;
|
4289
|
-
} | {
|
4290
|
-
status: 404;
|
4291
|
-
payload: SimpleError;
|
4292
|
-
}>;
|
4293
|
-
declare type CPupdateCPDatabaseMetadataRequestBody = {
|
4294
|
-
ui?: {
|
4295
|
-
/**
|
4296
|
-
* @minLength 1
|
4297
|
-
*/
|
4298
|
-
color?: string;
|
4299
|
-
};
|
4300
|
-
};
|
4301
|
-
declare type CPupdateCPDatabaseMetadataVariables = {
|
4302
|
-
body?: CPupdateCPDatabaseMetadataRequestBody;
|
4303
|
-
pathParams: CPupdateCPDatabaseMetadataPathParams;
|
4304
|
-
} & FetcherExtraProps;
|
4305
|
-
/**
|
4306
|
-
* Update the color of the selected database
|
4125
|
+
* note: Sorting on summarized values can be slower on very large tables;
|
4126
|
+
* this will impact your rate limit significantly more than other queries.
|
4127
|
+
* Try use `filter` [coming soon] to reduce the amount of data being
|
4128
|
+
* processed in order to reduce impact on your limits.
|
4129
|
+
*
|
4130
|
+
* `summariesFilter`: tells Xata how to filter the results of a summary.
|
4131
|
+
* It has the same syntax as `filter`, however, by using `summariesFilter`
|
4132
|
+
* you may also filter on the results of a query.
|
4133
|
+
*
|
4134
|
+
* note: This is a much slower to use than `filter`. We recommend using
|
4135
|
+
* `filter` wherever possible and `summariesFilter` when it's not
|
4136
|
+
* possible to use `filter`.
|
4307
4137
|
*/
|
4308
|
-
declare const
|
4138
|
+
declare const summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal) => Promise<SummarizeResponse>;
|
4309
4139
|
declare const operationsByTag: {
|
4310
4140
|
users: {
|
4311
|
-
getUser: (variables: GetUserVariables) => Promise<UserWithID>;
|
4312
|
-
updateUser: (variables: UpdateUserVariables) => Promise<UserWithID>;
|
4313
|
-
deleteUser: (variables: DeleteUserVariables) => Promise<undefined>;
|
4314
|
-
getUserAPIKeys: (variables: GetUserAPIKeysVariables) => Promise<GetUserAPIKeysResponse>;
|
4315
|
-
createUserAPIKey: (variables: CreateUserAPIKeyVariables) => Promise<CreateUserAPIKeyResponse>;
|
4316
|
-
deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables) => Promise<undefined>;
|
4141
|
+
getUser: (variables: GetUserVariables, signal?: AbortSignal) => Promise<UserWithID>;
|
4142
|
+
updateUser: (variables: UpdateUserVariables, signal?: AbortSignal) => Promise<UserWithID>;
|
4143
|
+
deleteUser: (variables: DeleteUserVariables, signal?: AbortSignal) => Promise<undefined>;
|
4144
|
+
getUserAPIKeys: (variables: GetUserAPIKeysVariables, signal?: AbortSignal) => Promise<GetUserAPIKeysResponse>;
|
4145
|
+
createUserAPIKey: (variables: CreateUserAPIKeyVariables, signal?: AbortSignal) => Promise<CreateUserAPIKeyResponse>;
|
4146
|
+
deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal) => Promise<undefined>;
|
4317
4147
|
};
|
4318
4148
|
workspaces: {
|
4319
|
-
createWorkspace: (variables: CreateWorkspaceVariables) => Promise<Workspace>;
|
4320
|
-
getWorkspacesList: (variables: GetWorkspacesListVariables) => Promise<GetWorkspacesListResponse>;
|
4321
|
-
getWorkspace: (variables: GetWorkspaceVariables) => Promise<Workspace>;
|
4322
|
-
updateWorkspace: (variables: UpdateWorkspaceVariables) => Promise<Workspace>;
|
4323
|
-
deleteWorkspace: (variables: DeleteWorkspaceVariables) => Promise<undefined>;
|
4324
|
-
getWorkspaceMembersList: (variables: GetWorkspaceMembersListVariables) => Promise<WorkspaceMembers>;
|
4325
|
-
updateWorkspaceMemberRole: (variables: UpdateWorkspaceMemberRoleVariables) => Promise<undefined>;
|
4326
|
-
removeWorkspaceMember: (variables: RemoveWorkspaceMemberVariables) => Promise<undefined>;
|
4327
|
-
inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables) => Promise<WorkspaceInvite>;
|
4328
|
-
updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables) => Promise<WorkspaceInvite>;
|
4329
|
-
cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables) => Promise<undefined>;
|
4330
|
-
resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables) => Promise<undefined>;
|
4331
|
-
acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables) => Promise<undefined>;
|
4149
|
+
createWorkspace: (variables: CreateWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
4150
|
+
getWorkspacesList: (variables: GetWorkspacesListVariables, signal?: AbortSignal) => Promise<GetWorkspacesListResponse>;
|
4151
|
+
getWorkspace: (variables: GetWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
4152
|
+
updateWorkspace: (variables: UpdateWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
4153
|
+
deleteWorkspace: (variables: DeleteWorkspaceVariables, signal?: AbortSignal) => Promise<undefined>;
|
4154
|
+
getWorkspaceMembersList: (variables: GetWorkspaceMembersListVariables, signal?: AbortSignal) => Promise<WorkspaceMembers>;
|
4155
|
+
updateWorkspaceMemberRole: (variables: UpdateWorkspaceMemberRoleVariables, signal?: AbortSignal) => Promise<undefined>;
|
4156
|
+
removeWorkspaceMember: (variables: RemoveWorkspaceMemberVariables, signal?: AbortSignal) => Promise<undefined>;
|
4157
|
+
inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables, signal?: AbortSignal) => Promise<WorkspaceInvite>;
|
4158
|
+
updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<WorkspaceInvite>;
|
4159
|
+
cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
4160
|
+
resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
4161
|
+
acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
4332
4162
|
};
|
4333
4163
|
database: {
|
4334
|
-
getDatabaseList: (variables: GetDatabaseListVariables) => Promise<ListDatabasesResponse>;
|
4335
|
-
createDatabase: (variables: CreateDatabaseVariables) => Promise<CreateDatabaseResponse>;
|
4336
|
-
deleteDatabase: (variables: DeleteDatabaseVariables) => Promise<undefined>;
|
4337
|
-
getDatabaseMetadata: (variables: GetDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
|
4338
|
-
updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
|
4339
|
-
getGitBranchesMapping: (variables: GetGitBranchesMappingVariables) => Promise<ListGitBranchesResponse>;
|
4340
|
-
addGitBranchesEntry: (variables: AddGitBranchesEntryVariables) => Promise<AddGitBranchesEntryResponse>;
|
4341
|
-
removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables) => Promise<undefined>;
|
4342
|
-
resolveBranch: (variables: ResolveBranchVariables) => Promise<ResolveBranchResponse>;
|
4164
|
+
getDatabaseList: (variables: GetDatabaseListVariables, signal?: AbortSignal) => Promise<ListDatabasesResponse>;
|
4165
|
+
createDatabase: (variables: CreateDatabaseVariables, signal?: AbortSignal) => Promise<CreateDatabaseResponse>;
|
4166
|
+
deleteDatabase: (variables: DeleteDatabaseVariables, signal?: AbortSignal) => Promise<undefined>;
|
4167
|
+
getDatabaseMetadata: (variables: GetDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
4168
|
+
updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
4169
|
+
getGitBranchesMapping: (variables: GetGitBranchesMappingVariables, signal?: AbortSignal) => Promise<ListGitBranchesResponse>;
|
4170
|
+
addGitBranchesEntry: (variables: AddGitBranchesEntryVariables, signal?: AbortSignal) => Promise<AddGitBranchesEntryResponse>;
|
4171
|
+
removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables, signal?: AbortSignal) => Promise<undefined>;
|
4172
|
+
resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal) => Promise<ResolveBranchResponse>;
|
4343
4173
|
};
|
4344
4174
|
branch: {
|
4345
|
-
getBranchList: (variables: GetBranchListVariables) => Promise<ListBranchesResponse>;
|
4346
|
-
getBranchDetails: (variables: GetBranchDetailsVariables) => Promise<DBBranch>;
|
4347
|
-
createBranch: (variables: CreateBranchVariables) => Promise<CreateBranchResponse>;
|
4348
|
-
deleteBranch: (variables: DeleteBranchVariables) => Promise<undefined>;
|
4349
|
-
updateBranchMetadata: (variables: UpdateBranchMetadataVariables) => Promise<undefined>;
|
4350
|
-
getBranchMetadata: (variables: GetBranchMetadataVariables) => Promise<BranchMetadata>;
|
4351
|
-
getBranchStats: (variables: GetBranchStatsVariables) => Promise<GetBranchStatsResponse>;
|
4175
|
+
getBranchList: (variables: GetBranchListVariables, signal?: AbortSignal) => Promise<ListBranchesResponse>;
|
4176
|
+
getBranchDetails: (variables: GetBranchDetailsVariables, signal?: AbortSignal) => Promise<DBBranch>;
|
4177
|
+
createBranch: (variables: CreateBranchVariables, signal?: AbortSignal) => Promise<CreateBranchResponse>;
|
4178
|
+
deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal) => Promise<undefined>;
|
4179
|
+
updateBranchMetadata: (variables: UpdateBranchMetadataVariables, signal?: AbortSignal) => Promise<undefined>;
|
4180
|
+
getBranchMetadata: (variables: GetBranchMetadataVariables, signal?: AbortSignal) => Promise<BranchMetadata>;
|
4181
|
+
getBranchStats: (variables: GetBranchStatsVariables, signal?: AbortSignal) => Promise<GetBranchStatsResponse>;
|
4352
4182
|
};
|
4353
4183
|
migrationRequests: {
|
4354
|
-
queryMigrationRequests: (variables: QueryMigrationRequestsVariables) => Promise<QueryMigrationRequestsResponse>;
|
4355
|
-
createMigrationRequest: (variables: CreateMigrationRequestVariables) => Promise<CreateMigrationRequestResponse>;
|
4356
|
-
getMigrationRequest: (variables: GetMigrationRequestVariables) => Promise<MigrationRequest>;
|
4357
|
-
updateMigrationRequest: (variables: UpdateMigrationRequestVariables) => Promise<undefined>;
|
4358
|
-
listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables) => Promise<ListMigrationRequestsCommitsResponse>;
|
4359
|
-
compareMigrationRequest: (variables: CompareMigrationRequestVariables) => Promise<SchemaCompareResponse>;
|
4360
|
-
getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables) => Promise<GetMigrationRequestIsMergedResponse>;
|
4361
|
-
mergeMigrationRequest: (variables: MergeMigrationRequestVariables) => Promise<Commit>;
|
4184
|
+
queryMigrationRequests: (variables: QueryMigrationRequestsVariables, signal?: AbortSignal) => Promise<QueryMigrationRequestsResponse>;
|
4185
|
+
createMigrationRequest: (variables: CreateMigrationRequestVariables, signal?: AbortSignal) => Promise<CreateMigrationRequestResponse>;
|
4186
|
+
getMigrationRequest: (variables: GetMigrationRequestVariables, signal?: AbortSignal) => Promise<MigrationRequest>;
|
4187
|
+
updateMigrationRequest: (variables: UpdateMigrationRequestVariables, signal?: AbortSignal) => Promise<undefined>;
|
4188
|
+
listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables, signal?: AbortSignal) => Promise<ListMigrationRequestsCommitsResponse>;
|
4189
|
+
compareMigrationRequest: (variables: CompareMigrationRequestVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
4190
|
+
getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables, signal?: AbortSignal) => Promise<GetMigrationRequestIsMergedResponse>;
|
4191
|
+
mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal) => Promise<Commit>;
|
4362
4192
|
};
|
4363
4193
|
branchSchema: {
|
4364
|
-
getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables) => Promise<GetBranchMigrationHistoryResponse>;
|
4365
|
-
executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables) => Promise<undefined>;
|
4366
|
-
getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables) => Promise<BranchMigrationPlan>;
|
4367
|
-
compareBranchWithUserSchema: (variables: CompareBranchWithUserSchemaVariables) => Promise<SchemaCompareResponse>;
|
4368
|
-
compareBranchSchemas: (variables: CompareBranchSchemasVariables) => Promise<SchemaCompareResponse>;
|
4369
|
-
updateBranchSchema: (variables: UpdateBranchSchemaVariables) => Promise<UpdateBranchSchemaResponse>;
|
4370
|
-
previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables) => Promise<PreviewBranchSchemaEditResponse>;
|
4371
|
-
applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables) => Promise<ApplyBranchSchemaEditResponse>;
|
4372
|
-
getBranchSchemaHistory: (variables: GetBranchSchemaHistoryVariables) => Promise<GetBranchSchemaHistoryResponse>;
|
4194
|
+
getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal) => Promise<GetBranchMigrationHistoryResponse>;
|
4195
|
+
executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<undefined>;
|
4196
|
+
getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<BranchMigrationPlan>;
|
4197
|
+
compareBranchWithUserSchema: (variables: CompareBranchWithUserSchemaVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
4198
|
+
compareBranchSchemas: (variables: CompareBranchSchemasVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
4199
|
+
updateBranchSchema: (variables: UpdateBranchSchemaVariables, signal?: AbortSignal) => Promise<UpdateBranchSchemaResponse>;
|
4200
|
+
previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables, signal?: AbortSignal) => Promise<PreviewBranchSchemaEditResponse>;
|
4201
|
+
applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal) => Promise<ApplyBranchSchemaEditResponse>;
|
4202
|
+
getBranchSchemaHistory: (variables: GetBranchSchemaHistoryVariables, signal?: AbortSignal) => Promise<GetBranchSchemaHistoryResponse>;
|
4373
4203
|
};
|
4374
4204
|
table: {
|
4375
|
-
createTable: (variables: CreateTableVariables) => Promise<CreateTableResponse>;
|
4376
|
-
deleteTable: (variables: DeleteTableVariables) => Promise<undefined>;
|
4377
|
-
updateTable: (variables: UpdateTableVariables) => Promise<undefined>;
|
4378
|
-
getTableSchema: (variables: GetTableSchemaVariables) => Promise<GetTableSchemaResponse>;
|
4379
|
-
setTableSchema: (variables: SetTableSchemaVariables) => Promise<undefined>;
|
4380
|
-
getTableColumns: (variables: GetTableColumnsVariables) => Promise<GetTableColumnsResponse>;
|
4381
|
-
addTableColumn: (variables: AddTableColumnVariables) => Promise<MigrationIdResponse>;
|
4382
|
-
getColumn: (variables: GetColumnVariables) => Promise<Column>;
|
4383
|
-
deleteColumn: (variables: DeleteColumnVariables) => Promise<MigrationIdResponse>;
|
4384
|
-
updateColumn: (variables: UpdateColumnVariables) => Promise<MigrationIdResponse>;
|
4205
|
+
createTable: (variables: CreateTableVariables, signal?: AbortSignal) => Promise<CreateTableResponse>;
|
4206
|
+
deleteTable: (variables: DeleteTableVariables, signal?: AbortSignal) => Promise<undefined>;
|
4207
|
+
updateTable: (variables: UpdateTableVariables, signal?: AbortSignal) => Promise<undefined>;
|
4208
|
+
getTableSchema: (variables: GetTableSchemaVariables, signal?: AbortSignal) => Promise<GetTableSchemaResponse>;
|
4209
|
+
setTableSchema: (variables: SetTableSchemaVariables, signal?: AbortSignal) => Promise<undefined>;
|
4210
|
+
getTableColumns: (variables: GetTableColumnsVariables, signal?: AbortSignal) => Promise<GetTableColumnsResponse>;
|
4211
|
+
addTableColumn: (variables: AddTableColumnVariables, signal?: AbortSignal) => Promise<MigrationIdResponse>;
|
4212
|
+
getColumn: (variables: GetColumnVariables, signal?: AbortSignal) => Promise<Column>;
|
4213
|
+
deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal) => Promise<MigrationIdResponse>;
|
4214
|
+
updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal) => Promise<MigrationIdResponse>;
|
4385
4215
|
};
|
4386
4216
|
records: {
|
4387
|
-
insertRecord: (variables: InsertRecordVariables) => Promise<RecordUpdateResponse>;
|
4388
|
-
insertRecordWithID: (variables: InsertRecordWithIDVariables) => Promise<RecordUpdateResponse>;
|
4389
|
-
updateRecordWithID: (variables: UpdateRecordWithIDVariables) => Promise<RecordUpdateResponse>;
|
4390
|
-
upsertRecordWithID: (variables: UpsertRecordWithIDVariables) => Promise<RecordUpdateResponse>;
|
4391
|
-
deleteRecord: (variables: DeleteRecordVariables) => Promise<XataRecord$1>;
|
4392
|
-
getRecord: (variables: GetRecordVariables) => Promise<XataRecord$1>;
|
4393
|
-
bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables) => Promise<BulkInsertResponse>;
|
4394
|
-
queryTable: (variables: QueryTableVariables) => Promise<QueryResponse>;
|
4395
|
-
searchTable: (variables: SearchTableVariables) => Promise<SearchResponse>;
|
4396
|
-
searchBranch: (variables: SearchBranchVariables) => Promise<SearchResponse>;
|
4397
|
-
summarizeTable: (variables: SummarizeTableVariables) => Promise<SummarizeResponse>;
|
4398
|
-
};
|
4399
|
-
databases: {
|
4400
|
-
cPgetDatabaseList: (variables: CPgetDatabaseListVariables) => Promise<CPListDatabasesResponse>;
|
4401
|
-
cPcreateDatabase: (variables: CPcreateDatabaseVariables) => Promise<CPcreateDatabaseResponse>;
|
4402
|
-
cPdeleteDatabase: (variables: CPdeleteDatabaseVariables) => Promise<undefined>;
|
4403
|
-
cPgetCPDatabaseMetadata: (variables: CPgetCPDatabaseMetadataVariables) => Promise<CPDatabaseMetadata>;
|
4404
|
-
cPupdateCPDatabaseMetadata: (variables: CPupdateCPDatabaseMetadataVariables) => Promise<CPDatabaseMetadata>;
|
4217
|
+
insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
4218
|
+
insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
4219
|
+
updateRecordWithID: (variables: UpdateRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
4220
|
+
upsertRecordWithID: (variables: UpsertRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
4221
|
+
deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
|
4222
|
+
getRecord: (variables: GetRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
|
4223
|
+
bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal) => Promise<BulkInsertResponse>;
|
4224
|
+
queryTable: (variables: QueryTableVariables, signal?: AbortSignal) => Promise<QueryResponse>;
|
4225
|
+
searchTable: (variables: SearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
4226
|
+
searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
4227
|
+
summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal) => Promise<SummarizeResponse>;
|
4405
4228
|
};
|
4406
4229
|
};
|
4407
4230
|
|
@@ -4411,6 +4234,10 @@ declare type ProviderBuilder = {
|
|
4411
4234
|
workspaces: string;
|
4412
4235
|
};
|
4413
4236
|
declare type HostProvider = HostAliases | ProviderBuilder;
|
4237
|
+
declare function getHostUrl(provider: HostProvider, type: keyof ProviderBuilder): string;
|
4238
|
+
declare function isHostProviderAlias(alias: HostProvider | string): alias is HostAliases;
|
4239
|
+
declare function isHostProviderBuilder(builder: HostProvider): builder is ProviderBuilder;
|
4240
|
+
declare function parseProviderString(provider?: string): HostProvider | null;
|
4414
4241
|
|
4415
4242
|
interface XataApiClientOptions {
|
4416
4243
|
fetch?: FetchImpl;
|
@@ -6023,4 +5850,4 @@ declare class XataError extends Error {
|
|
6023
5850
|
constructor(message: string, status: number);
|
6024
5851
|
}
|
6025
5852
|
|
6026
|
-
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, CPcreateDatabaseError, CPcreateDatabasePathParams, CPcreateDatabaseRequestBody, CPcreateDatabaseResponse, CPcreateDatabaseVariables, CPdeleteDatabaseError, CPdeleteDatabasePathParams, CPdeleteDatabaseVariables, CPgetCPDatabaseMetadataError, CPgetCPDatabaseMetadataPathParams, CPgetCPDatabaseMetadataVariables, CPgetDatabaseListError, CPgetDatabaseListPathParams, CPgetDatabaseListVariables, CPupdateCPDatabaseMetadataError, CPupdateCPDatabaseMetadataPathParams, CPupdateCPDatabaseMetadataRequestBody, CPupdateCPDatabaseMetadataVariables, 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, 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, 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 };
|
5853
|
+
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, 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, 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, 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 };
|