@xata.io/client 0.0.0-alpha.vf54f8ba → 0.0.0-alpha.vf5a6674
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 +6 -0
- package/dist/index.cjs +346 -199
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +784 -483
- package/dist/index.mjs +346 -200
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
@@ -25,6 +25,8 @@ declare type FetcherExtraProps = {
|
|
25
25
|
apiKey: string;
|
26
26
|
trace: TraceFunction;
|
27
27
|
signal?: AbortSignal;
|
28
|
+
clientID?: string;
|
29
|
+
sessionID?: string;
|
28
30
|
};
|
29
31
|
declare type ErrorWrapper<TError> = TError | {
|
30
32
|
status: 'unknown';
|
@@ -332,16 +334,14 @@ declare type ColumnMigration = {
|
|
332
334
|
* @x-internal true
|
333
335
|
*/
|
334
336
|
declare type Commit = {
|
335
|
-
|
336
|
-
|
337
|
-
|
338
|
-
|
339
|
-
|
340
|
-
|
341
|
-
|
342
|
-
|
343
|
-
modifiedAt?: DateTime;
|
344
|
-
};
|
337
|
+
title?: string;
|
338
|
+
message?: string;
|
339
|
+
id: string;
|
340
|
+
parentID?: string;
|
341
|
+
mergeParentID?: string;
|
342
|
+
status: string;
|
343
|
+
createdAt: DateTime;
|
344
|
+
modifiedAt?: DateTime;
|
345
345
|
operations: MigrationOp[];
|
346
346
|
};
|
347
347
|
/**
|
@@ -977,7 +977,16 @@ declare type CPListDatabasesResponse = {
|
|
977
977
|
/**
|
978
978
|
* A list of databases in a Xata workspace
|
979
979
|
*/
|
980
|
-
databases
|
980
|
+
databases: CPDatabaseMetadata[];
|
981
|
+
};
|
982
|
+
declare type ListRegionsResponse = {
|
983
|
+
/**
|
984
|
+
* A list of regions where databases can be created
|
985
|
+
*/
|
986
|
+
regions: Region[];
|
987
|
+
};
|
988
|
+
declare type Region = {
|
989
|
+
id: string;
|
981
990
|
};
|
982
991
|
/**
|
983
992
|
* Xata Table Record Metadata
|
@@ -1073,6 +1082,8 @@ type schemas_TableRename = TableRename;
|
|
1073
1082
|
type schemas_RecordsMetadata = RecordsMetadata;
|
1074
1083
|
type schemas_CPDatabaseMetadata = CPDatabaseMetadata;
|
1075
1084
|
type schemas_CPListDatabasesResponse = CPListDatabasesResponse;
|
1085
|
+
type schemas_ListRegionsResponse = ListRegionsResponse;
|
1086
|
+
type schemas_Region = Region;
|
1076
1087
|
declare namespace schemas {
|
1077
1088
|
export {
|
1078
1089
|
schemas_User as User,
|
@@ -1166,6 +1177,8 @@ declare namespace schemas {
|
|
1166
1177
|
AggResponse$1 as AggResponse,
|
1167
1178
|
schemas_CPDatabaseMetadata as CPDatabaseMetadata,
|
1168
1179
|
schemas_CPListDatabasesResponse as CPListDatabasesResponse,
|
1180
|
+
schemas_ListRegionsResponse as ListRegionsResponse,
|
1181
|
+
schemas_Region as Region,
|
1169
1182
|
XataRecord$1 as XataRecord,
|
1170
1183
|
};
|
1171
1184
|
}
|
@@ -1405,23 +1418,6 @@ declare type DeleteUserAPIKeyVariables = {
|
|
1405
1418
|
* Delete an existing API key
|
1406
1419
|
*/
|
1407
1420
|
declare const deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal) => Promise<undefined>;
|
1408
|
-
declare type CreateWorkspaceError = ErrorWrapper<{
|
1409
|
-
status: 400;
|
1410
|
-
payload: BadRequestError;
|
1411
|
-
} | {
|
1412
|
-
status: 401;
|
1413
|
-
payload: AuthError;
|
1414
|
-
} | {
|
1415
|
-
status: 404;
|
1416
|
-
payload: SimpleError;
|
1417
|
-
}>;
|
1418
|
-
declare type CreateWorkspaceVariables = {
|
1419
|
-
body: WorkspaceMeta;
|
1420
|
-
} & FetcherExtraProps;
|
1421
|
-
/**
|
1422
|
-
* Creates a new workspace with the user requesting it as its single owner.
|
1423
|
-
*/
|
1424
|
-
declare const createWorkspace: (variables: CreateWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
1425
1421
|
declare type GetWorkspacesListError = ErrorWrapper<{
|
1426
1422
|
status: 400;
|
1427
1423
|
payload: BadRequestError;
|
@@ -1445,6 +1441,23 @@ declare type GetWorkspacesListVariables = FetcherExtraProps;
|
|
1445
1441
|
* Retrieve the list of workspaces the user belongs to
|
1446
1442
|
*/
|
1447
1443
|
declare const getWorkspacesList: (variables: GetWorkspacesListVariables, signal?: AbortSignal) => Promise<GetWorkspacesListResponse>;
|
1444
|
+
declare type CreateWorkspaceError = ErrorWrapper<{
|
1445
|
+
status: 400;
|
1446
|
+
payload: BadRequestError;
|
1447
|
+
} | {
|
1448
|
+
status: 401;
|
1449
|
+
payload: AuthError;
|
1450
|
+
} | {
|
1451
|
+
status: 404;
|
1452
|
+
payload: SimpleError;
|
1453
|
+
}>;
|
1454
|
+
declare type CreateWorkspaceVariables = {
|
1455
|
+
body: WorkspaceMeta;
|
1456
|
+
} & FetcherExtraProps;
|
1457
|
+
/**
|
1458
|
+
* Creates a new workspace with the user requesting it as its single owner.
|
1459
|
+
*/
|
1460
|
+
declare const createWorkspace: (variables: CreateWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
1448
1461
|
declare type GetWorkspacePathParams = {
|
1449
1462
|
/**
|
1450
1463
|
* Workspace ID
|
@@ -1691,17 +1704,17 @@ declare type CancelWorkspaceMemberInviteVariables = {
|
|
1691
1704
|
* This operation provides a way to cancel invites by deleting them. Already accepted invites cannot be deleted.
|
1692
1705
|
*/
|
1693
1706
|
declare const cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
1694
|
-
declare type
|
1707
|
+
declare type AcceptWorkspaceMemberInvitePathParams = {
|
1695
1708
|
/**
|
1696
1709
|
* Workspace ID
|
1697
1710
|
*/
|
1698
1711
|
workspaceId: WorkspaceID;
|
1699
1712
|
/**
|
1700
|
-
* Invite
|
1713
|
+
* Invite Key (secret) for the invited user
|
1701
1714
|
*/
|
1702
|
-
|
1715
|
+
inviteKey: InviteKey;
|
1703
1716
|
};
|
1704
|
-
declare type
|
1717
|
+
declare type AcceptWorkspaceMemberInviteError = ErrorWrapper<{
|
1705
1718
|
status: 400;
|
1706
1719
|
payload: BadRequestError;
|
1707
1720
|
} | {
|
@@ -1711,24 +1724,24 @@ declare type ResendWorkspaceMemberInviteError = ErrorWrapper<{
|
|
1711
1724
|
status: 404;
|
1712
1725
|
payload: SimpleError;
|
1713
1726
|
}>;
|
1714
|
-
declare type
|
1715
|
-
pathParams:
|
1727
|
+
declare type AcceptWorkspaceMemberInviteVariables = {
|
1728
|
+
pathParams: AcceptWorkspaceMemberInvitePathParams;
|
1716
1729
|
} & FetcherExtraProps;
|
1717
1730
|
/**
|
1718
|
-
*
|
1731
|
+
* Accept the invitation to join a workspace. If the operation succeeds the user will be a member of the workspace
|
1719
1732
|
*/
|
1720
|
-
declare const
|
1721
|
-
declare type
|
1733
|
+
declare const acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
1734
|
+
declare type ResendWorkspaceMemberInvitePathParams = {
|
1722
1735
|
/**
|
1723
1736
|
* Workspace ID
|
1724
1737
|
*/
|
1725
1738
|
workspaceId: WorkspaceID;
|
1726
1739
|
/**
|
1727
|
-
* Invite
|
1740
|
+
* Invite identifier
|
1728
1741
|
*/
|
1729
|
-
|
1742
|
+
inviteId: InviteID;
|
1730
1743
|
};
|
1731
|
-
declare type
|
1744
|
+
declare type ResendWorkspaceMemberInviteError = ErrorWrapper<{
|
1732
1745
|
status: 400;
|
1733
1746
|
payload: BadRequestError;
|
1734
1747
|
} | {
|
@@ -1738,13 +1751,13 @@ declare type AcceptWorkspaceMemberInviteError = ErrorWrapper<{
|
|
1738
1751
|
status: 404;
|
1739
1752
|
payload: SimpleError;
|
1740
1753
|
}>;
|
1741
|
-
declare type
|
1742
|
-
pathParams:
|
1754
|
+
declare type ResendWorkspaceMemberInviteVariables = {
|
1755
|
+
pathParams: ResendWorkspaceMemberInvitePathParams;
|
1743
1756
|
} & FetcherExtraProps;
|
1744
1757
|
/**
|
1745
|
-
*
|
1758
|
+
* This operation provides a way to resend an Invite notification. Invite notifications can only be sent for Invites not yet accepted.
|
1746
1759
|
*/
|
1747
|
-
declare const
|
1760
|
+
declare const resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
1748
1761
|
declare type GetDatabaseListPathParams = {
|
1749
1762
|
workspace: string;
|
1750
1763
|
};
|
@@ -1906,6 +1919,175 @@ declare type UpdateDatabaseMetadataVariables = {
|
|
1906
1919
|
* Update the color of the selected database
|
1907
1920
|
*/
|
1908
1921
|
declare const updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
1922
|
+
declare type GetBranchDetailsPathParams = {
|
1923
|
+
/**
|
1924
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
1925
|
+
*/
|
1926
|
+
dbBranchName: DBBranchName;
|
1927
|
+
workspace: string;
|
1928
|
+
};
|
1929
|
+
declare type GetBranchDetailsError = ErrorWrapper<{
|
1930
|
+
status: 400;
|
1931
|
+
payload: BadRequestError;
|
1932
|
+
} | {
|
1933
|
+
status: 401;
|
1934
|
+
payload: AuthError;
|
1935
|
+
} | {
|
1936
|
+
status: 404;
|
1937
|
+
payload: SimpleError;
|
1938
|
+
}>;
|
1939
|
+
declare type GetBranchDetailsVariables = {
|
1940
|
+
pathParams: GetBranchDetailsPathParams;
|
1941
|
+
} & FetcherExtraProps;
|
1942
|
+
declare const getBranchDetails: (variables: GetBranchDetailsVariables, signal?: AbortSignal) => Promise<DBBranch>;
|
1943
|
+
declare type CreateBranchPathParams = {
|
1944
|
+
/**
|
1945
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
1946
|
+
*/
|
1947
|
+
dbBranchName: DBBranchName;
|
1948
|
+
workspace: string;
|
1949
|
+
};
|
1950
|
+
declare type CreateBranchQueryParams = {
|
1951
|
+
/**
|
1952
|
+
* Name of source branch to branch the new schema from
|
1953
|
+
*/
|
1954
|
+
from?: string;
|
1955
|
+
};
|
1956
|
+
declare type CreateBranchError = ErrorWrapper<{
|
1957
|
+
status: 400;
|
1958
|
+
payload: BadRequestError;
|
1959
|
+
} | {
|
1960
|
+
status: 401;
|
1961
|
+
payload: AuthError;
|
1962
|
+
} | {
|
1963
|
+
status: 404;
|
1964
|
+
payload: SimpleError;
|
1965
|
+
}>;
|
1966
|
+
declare type CreateBranchResponse = {
|
1967
|
+
/**
|
1968
|
+
* @minLength 1
|
1969
|
+
*/
|
1970
|
+
databaseName: string;
|
1971
|
+
branchName: string;
|
1972
|
+
};
|
1973
|
+
declare type CreateBranchRequestBody = {
|
1974
|
+
/**
|
1975
|
+
* Select the branch to fork from. Defaults to 'main'
|
1976
|
+
*/
|
1977
|
+
from?: string;
|
1978
|
+
metadata?: BranchMetadata;
|
1979
|
+
};
|
1980
|
+
declare type CreateBranchVariables = {
|
1981
|
+
body?: CreateBranchRequestBody;
|
1982
|
+
pathParams: CreateBranchPathParams;
|
1983
|
+
queryParams?: CreateBranchQueryParams;
|
1984
|
+
} & FetcherExtraProps;
|
1985
|
+
declare const createBranch: (variables: CreateBranchVariables, signal?: AbortSignal) => Promise<CreateBranchResponse>;
|
1986
|
+
declare type DeleteBranchPathParams = {
|
1987
|
+
/**
|
1988
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
1989
|
+
*/
|
1990
|
+
dbBranchName: DBBranchName;
|
1991
|
+
workspace: string;
|
1992
|
+
};
|
1993
|
+
declare type DeleteBranchError = ErrorWrapper<{
|
1994
|
+
status: 400;
|
1995
|
+
payload: BadRequestError;
|
1996
|
+
} | {
|
1997
|
+
status: 401;
|
1998
|
+
payload: AuthError;
|
1999
|
+
} | {
|
2000
|
+
status: 404;
|
2001
|
+
payload: SimpleError;
|
2002
|
+
}>;
|
2003
|
+
declare type DeleteBranchVariables = {
|
2004
|
+
pathParams: DeleteBranchPathParams;
|
2005
|
+
} & FetcherExtraProps;
|
2006
|
+
/**
|
2007
|
+
* Delete the branch in the database and all its resources
|
2008
|
+
*/
|
2009
|
+
declare const deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal) => Promise<undefined>;
|
2010
|
+
declare type UpdateBranchMetadataPathParams = {
|
2011
|
+
/**
|
2012
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2013
|
+
*/
|
2014
|
+
dbBranchName: DBBranchName;
|
2015
|
+
workspace: string;
|
2016
|
+
};
|
2017
|
+
declare type UpdateBranchMetadataError = ErrorWrapper<{
|
2018
|
+
status: 400;
|
2019
|
+
payload: BadRequestError;
|
2020
|
+
} | {
|
2021
|
+
status: 401;
|
2022
|
+
payload: AuthError;
|
2023
|
+
} | {
|
2024
|
+
status: 404;
|
2025
|
+
payload: SimpleError;
|
2026
|
+
}>;
|
2027
|
+
declare type UpdateBranchMetadataVariables = {
|
2028
|
+
body?: BranchMetadata;
|
2029
|
+
pathParams: UpdateBranchMetadataPathParams;
|
2030
|
+
} & FetcherExtraProps;
|
2031
|
+
/**
|
2032
|
+
* Update the branch metadata
|
2033
|
+
*/
|
2034
|
+
declare const updateBranchMetadata: (variables: UpdateBranchMetadataVariables, signal?: AbortSignal) => Promise<undefined>;
|
2035
|
+
declare type GetBranchMetadataPathParams = {
|
2036
|
+
/**
|
2037
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2038
|
+
*/
|
2039
|
+
dbBranchName: DBBranchName;
|
2040
|
+
workspace: string;
|
2041
|
+
};
|
2042
|
+
declare type GetBranchMetadataError = ErrorWrapper<{
|
2043
|
+
status: 400;
|
2044
|
+
payload: BadRequestError;
|
2045
|
+
} | {
|
2046
|
+
status: 401;
|
2047
|
+
payload: AuthError;
|
2048
|
+
} | {
|
2049
|
+
status: 404;
|
2050
|
+
payload: SimpleError;
|
2051
|
+
}>;
|
2052
|
+
declare type GetBranchMetadataVariables = {
|
2053
|
+
pathParams: GetBranchMetadataPathParams;
|
2054
|
+
} & FetcherExtraProps;
|
2055
|
+
declare const getBranchMetadata: (variables: GetBranchMetadataVariables, signal?: AbortSignal) => Promise<BranchMetadata>;
|
2056
|
+
declare type GetBranchStatsPathParams = {
|
2057
|
+
/**
|
2058
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2059
|
+
*/
|
2060
|
+
dbBranchName: DBBranchName;
|
2061
|
+
workspace: string;
|
2062
|
+
};
|
2063
|
+
declare type GetBranchStatsError = ErrorWrapper<{
|
2064
|
+
status: 400;
|
2065
|
+
payload: SimpleError;
|
2066
|
+
} | {
|
2067
|
+
status: 401;
|
2068
|
+
payload: AuthError;
|
2069
|
+
} | {
|
2070
|
+
status: 404;
|
2071
|
+
payload: SimpleError;
|
2072
|
+
}>;
|
2073
|
+
declare type GetBranchStatsResponse = {
|
2074
|
+
timestamp: string;
|
2075
|
+
interval: string;
|
2076
|
+
resolution: string;
|
2077
|
+
numberOfRecords?: MetricsDatapoint[];
|
2078
|
+
writesOverTime?: MetricsDatapoint[];
|
2079
|
+
readsOverTime?: MetricsDatapoint[];
|
2080
|
+
readLatency?: MetricsLatency;
|
2081
|
+
writeLatency?: MetricsLatency;
|
2082
|
+
warning?: string;
|
2083
|
+
};
|
2084
|
+
declare type GetBranchStatsVariables = {
|
2085
|
+
pathParams: GetBranchStatsPathParams;
|
2086
|
+
} & FetcherExtraProps;
|
2087
|
+
/**
|
2088
|
+
* Get branch usage metrics.
|
2089
|
+
*/
|
2090
|
+
declare const getBranchStats: (variables: GetBranchStatsVariables, signal?: AbortSignal) => Promise<GetBranchStatsResponse>;
|
1909
2091
|
declare type GetGitBranchesMappingPathParams = {
|
1910
2092
|
/**
|
1911
2093
|
* The Database Name
|
@@ -2093,11 +2275,95 @@ declare type ResolveBranchVariables = {
|
|
2093
2275
|
* ```
|
2094
2276
|
*/
|
2095
2277
|
declare const resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal) => Promise<ResolveBranchResponse>;
|
2096
|
-
declare type
|
2278
|
+
declare type GetBranchMigrationHistoryPathParams = {
|
2097
2279
|
/**
|
2098
|
-
* The
|
2280
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2099
2281
|
*/
|
2100
|
-
|
2282
|
+
dbBranchName: DBBranchName;
|
2283
|
+
workspace: string;
|
2284
|
+
};
|
2285
|
+
declare type GetBranchMigrationHistoryError = ErrorWrapper<{
|
2286
|
+
status: 400;
|
2287
|
+
payload: BadRequestError;
|
2288
|
+
} | {
|
2289
|
+
status: 401;
|
2290
|
+
payload: AuthError;
|
2291
|
+
} | {
|
2292
|
+
status: 404;
|
2293
|
+
payload: SimpleError;
|
2294
|
+
}>;
|
2295
|
+
declare type GetBranchMigrationHistoryResponse = {
|
2296
|
+
startedFrom?: StartedFromMetadata;
|
2297
|
+
migrations?: BranchMigration[];
|
2298
|
+
};
|
2299
|
+
declare type GetBranchMigrationHistoryRequestBody = {
|
2300
|
+
limit?: number;
|
2301
|
+
startFrom?: string;
|
2302
|
+
};
|
2303
|
+
declare type GetBranchMigrationHistoryVariables = {
|
2304
|
+
body?: GetBranchMigrationHistoryRequestBody;
|
2305
|
+
pathParams: GetBranchMigrationHistoryPathParams;
|
2306
|
+
} & FetcherExtraProps;
|
2307
|
+
declare const getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal) => Promise<GetBranchMigrationHistoryResponse>;
|
2308
|
+
declare type GetBranchMigrationPlanPathParams = {
|
2309
|
+
/**
|
2310
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2311
|
+
*/
|
2312
|
+
dbBranchName: DBBranchName;
|
2313
|
+
workspace: string;
|
2314
|
+
};
|
2315
|
+
declare type GetBranchMigrationPlanError = ErrorWrapper<{
|
2316
|
+
status: 400;
|
2317
|
+
payload: BadRequestError;
|
2318
|
+
} | {
|
2319
|
+
status: 401;
|
2320
|
+
payload: AuthError;
|
2321
|
+
} | {
|
2322
|
+
status: 404;
|
2323
|
+
payload: SimpleError;
|
2324
|
+
}>;
|
2325
|
+
declare type GetBranchMigrationPlanVariables = {
|
2326
|
+
body: Schema;
|
2327
|
+
pathParams: GetBranchMigrationPlanPathParams;
|
2328
|
+
} & FetcherExtraProps;
|
2329
|
+
/**
|
2330
|
+
* Compute a migration plan from a target schema the branch should be migrated too.
|
2331
|
+
*/
|
2332
|
+
declare const getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<BranchMigrationPlan>;
|
2333
|
+
declare type ExecuteBranchMigrationPlanPathParams = {
|
2334
|
+
/**
|
2335
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2336
|
+
*/
|
2337
|
+
dbBranchName: DBBranchName;
|
2338
|
+
workspace: string;
|
2339
|
+
};
|
2340
|
+
declare type ExecuteBranchMigrationPlanError = ErrorWrapper<{
|
2341
|
+
status: 400;
|
2342
|
+
payload: BadRequestError;
|
2343
|
+
} | {
|
2344
|
+
status: 401;
|
2345
|
+
payload: AuthError;
|
2346
|
+
} | {
|
2347
|
+
status: 404;
|
2348
|
+
payload: SimpleError;
|
2349
|
+
}>;
|
2350
|
+
declare type ExecuteBranchMigrationPlanRequestBody = {
|
2351
|
+
version: number;
|
2352
|
+
migration: BranchMigration;
|
2353
|
+
};
|
2354
|
+
declare type ExecuteBranchMigrationPlanVariables = {
|
2355
|
+
body: ExecuteBranchMigrationPlanRequestBody;
|
2356
|
+
pathParams: ExecuteBranchMigrationPlanPathParams;
|
2357
|
+
} & FetcherExtraProps;
|
2358
|
+
/**
|
2359
|
+
* Apply a migration plan to the branch
|
2360
|
+
*/
|
2361
|
+
declare const executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<undefined>;
|
2362
|
+
declare type QueryMigrationRequestsPathParams = {
|
2363
|
+
/**
|
2364
|
+
* The Database Name
|
2365
|
+
*/
|
2366
|
+
dbName: DBName;
|
2101
2367
|
workspace: string;
|
2102
2368
|
};
|
2103
2369
|
declare type QueryMigrationRequestsError = ErrorWrapper<{
|
@@ -2368,178 +2634,14 @@ declare type MergeMigrationRequestVariables = {
|
|
2368
2634
|
pathParams: MergeMigrationRequestPathParams;
|
2369
2635
|
} & FetcherExtraProps;
|
2370
2636
|
declare const mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal) => Promise<Commit>;
|
2371
|
-
declare type
|
2372
|
-
/**
|
2373
|
-
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2374
|
-
*/
|
2375
|
-
dbBranchName: DBBranchName;
|
2376
|
-
workspace: string;
|
2377
|
-
};
|
2378
|
-
declare type GetBranchDetailsError = ErrorWrapper<{
|
2379
|
-
status: 400;
|
2380
|
-
payload: BadRequestError;
|
2381
|
-
} | {
|
2382
|
-
status: 401;
|
2383
|
-
payload: AuthError;
|
2384
|
-
} | {
|
2385
|
-
status: 404;
|
2386
|
-
payload: SimpleError;
|
2387
|
-
}>;
|
2388
|
-
declare type GetBranchDetailsVariables = {
|
2389
|
-
pathParams: GetBranchDetailsPathParams;
|
2390
|
-
} & FetcherExtraProps;
|
2391
|
-
declare const getBranchDetails: (variables: GetBranchDetailsVariables, signal?: AbortSignal) => Promise<DBBranch>;
|
2392
|
-
declare type CreateBranchPathParams = {
|
2393
|
-
/**
|
2394
|
-
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2395
|
-
*/
|
2396
|
-
dbBranchName: DBBranchName;
|
2397
|
-
workspace: string;
|
2398
|
-
};
|
2399
|
-
declare type CreateBranchQueryParams = {
|
2400
|
-
/**
|
2401
|
-
* Name of source branch to branch the new schema from
|
2402
|
-
*/
|
2403
|
-
from?: string;
|
2404
|
-
};
|
2405
|
-
declare type CreateBranchError = ErrorWrapper<{
|
2406
|
-
status: 400;
|
2407
|
-
payload: BadRequestError;
|
2408
|
-
} | {
|
2409
|
-
status: 401;
|
2410
|
-
payload: AuthError;
|
2411
|
-
} | {
|
2412
|
-
status: 404;
|
2413
|
-
payload: SimpleError;
|
2414
|
-
}>;
|
2415
|
-
declare type CreateBranchResponse = {
|
2416
|
-
/**
|
2417
|
-
* @minLength 1
|
2418
|
-
*/
|
2419
|
-
databaseName: string;
|
2420
|
-
branchName: string;
|
2421
|
-
};
|
2422
|
-
declare type CreateBranchRequestBody = {
|
2423
|
-
/**
|
2424
|
-
* Select the branch to fork from. Defaults to 'main'
|
2425
|
-
*/
|
2426
|
-
from?: string;
|
2427
|
-
metadata?: BranchMetadata;
|
2428
|
-
};
|
2429
|
-
declare type CreateBranchVariables = {
|
2430
|
-
body?: CreateBranchRequestBody;
|
2431
|
-
pathParams: CreateBranchPathParams;
|
2432
|
-
queryParams?: CreateBranchQueryParams;
|
2433
|
-
} & FetcherExtraProps;
|
2434
|
-
declare const createBranch: (variables: CreateBranchVariables, signal?: AbortSignal) => Promise<CreateBranchResponse>;
|
2435
|
-
declare type DeleteBranchPathParams = {
|
2436
|
-
/**
|
2437
|
-
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2438
|
-
*/
|
2439
|
-
dbBranchName: DBBranchName;
|
2440
|
-
workspace: string;
|
2441
|
-
};
|
2442
|
-
declare type DeleteBranchError = ErrorWrapper<{
|
2443
|
-
status: 400;
|
2444
|
-
payload: BadRequestError;
|
2445
|
-
} | {
|
2446
|
-
status: 401;
|
2447
|
-
payload: AuthError;
|
2448
|
-
} | {
|
2449
|
-
status: 404;
|
2450
|
-
payload: SimpleError;
|
2451
|
-
}>;
|
2452
|
-
declare type DeleteBranchVariables = {
|
2453
|
-
pathParams: DeleteBranchPathParams;
|
2454
|
-
} & FetcherExtraProps;
|
2455
|
-
/**
|
2456
|
-
* Delete the branch in the database and all its resources
|
2457
|
-
*/
|
2458
|
-
declare const deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal) => Promise<undefined>;
|
2459
|
-
declare type UpdateBranchMetadataPathParams = {
|
2460
|
-
/**
|
2461
|
-
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2462
|
-
*/
|
2463
|
-
dbBranchName: DBBranchName;
|
2464
|
-
workspace: string;
|
2465
|
-
};
|
2466
|
-
declare type UpdateBranchMetadataError = ErrorWrapper<{
|
2467
|
-
status: 400;
|
2468
|
-
payload: BadRequestError;
|
2469
|
-
} | {
|
2470
|
-
status: 401;
|
2471
|
-
payload: AuthError;
|
2472
|
-
} | {
|
2473
|
-
status: 404;
|
2474
|
-
payload: SimpleError;
|
2475
|
-
}>;
|
2476
|
-
declare type UpdateBranchMetadataVariables = {
|
2477
|
-
body?: BranchMetadata;
|
2478
|
-
pathParams: UpdateBranchMetadataPathParams;
|
2479
|
-
} & FetcherExtraProps;
|
2480
|
-
/**
|
2481
|
-
* Update the branch metadata
|
2482
|
-
*/
|
2483
|
-
declare const updateBranchMetadata: (variables: UpdateBranchMetadataVariables, signal?: AbortSignal) => Promise<undefined>;
|
2484
|
-
declare type GetBranchMetadataPathParams = {
|
2485
|
-
/**
|
2486
|
-
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2487
|
-
*/
|
2488
|
-
dbBranchName: DBBranchName;
|
2489
|
-
workspace: string;
|
2490
|
-
};
|
2491
|
-
declare type GetBranchMetadataError = ErrorWrapper<{
|
2492
|
-
status: 400;
|
2493
|
-
payload: BadRequestError;
|
2494
|
-
} | {
|
2495
|
-
status: 401;
|
2496
|
-
payload: AuthError;
|
2497
|
-
} | {
|
2498
|
-
status: 404;
|
2499
|
-
payload: SimpleError;
|
2500
|
-
}>;
|
2501
|
-
declare type GetBranchMetadataVariables = {
|
2502
|
-
pathParams: GetBranchMetadataPathParams;
|
2503
|
-
} & FetcherExtraProps;
|
2504
|
-
declare const getBranchMetadata: (variables: GetBranchMetadataVariables, signal?: AbortSignal) => Promise<BranchMetadata>;
|
2505
|
-
declare type GetBranchMigrationHistoryPathParams = {
|
2506
|
-
/**
|
2507
|
-
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2508
|
-
*/
|
2509
|
-
dbBranchName: DBBranchName;
|
2510
|
-
workspace: string;
|
2511
|
-
};
|
2512
|
-
declare type GetBranchMigrationHistoryError = ErrorWrapper<{
|
2513
|
-
status: 400;
|
2514
|
-
payload: BadRequestError;
|
2515
|
-
} | {
|
2516
|
-
status: 401;
|
2517
|
-
payload: AuthError;
|
2518
|
-
} | {
|
2519
|
-
status: 404;
|
2520
|
-
payload: SimpleError;
|
2521
|
-
}>;
|
2522
|
-
declare type GetBranchMigrationHistoryResponse = {
|
2523
|
-
startedFrom?: StartedFromMetadata;
|
2524
|
-
migrations?: BranchMigration[];
|
2525
|
-
};
|
2526
|
-
declare type GetBranchMigrationHistoryRequestBody = {
|
2527
|
-
limit?: number;
|
2528
|
-
startFrom?: string;
|
2529
|
-
};
|
2530
|
-
declare type GetBranchMigrationHistoryVariables = {
|
2531
|
-
body?: GetBranchMigrationHistoryRequestBody;
|
2532
|
-
pathParams: GetBranchMigrationHistoryPathParams;
|
2533
|
-
} & FetcherExtraProps;
|
2534
|
-
declare const getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal) => Promise<GetBranchMigrationHistoryResponse>;
|
2535
|
-
declare type ExecuteBranchMigrationPlanPathParams = {
|
2637
|
+
declare type GetBranchSchemaHistoryPathParams = {
|
2536
2638
|
/**
|
2537
2639
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2538
2640
|
*/
|
2539
2641
|
dbBranchName: DBBranchName;
|
2540
2642
|
workspace: string;
|
2541
2643
|
};
|
2542
|
-
declare type
|
2644
|
+
declare type GetBranchSchemaHistoryError = ErrorWrapper<{
|
2543
2645
|
status: 400;
|
2544
2646
|
payload: BadRequestError;
|
2545
2647
|
} | {
|
@@ -2549,43 +2651,42 @@ declare type ExecuteBranchMigrationPlanError = ErrorWrapper<{
|
|
2549
2651
|
status: 404;
|
2550
2652
|
payload: SimpleError;
|
2551
2653
|
}>;
|
2552
|
-
declare type
|
2553
|
-
|
2554
|
-
|
2654
|
+
declare type GetBranchSchemaHistoryResponse = {
|
2655
|
+
meta: {
|
2656
|
+
/**
|
2657
|
+
* last record id
|
2658
|
+
*/
|
2659
|
+
cursor: string;
|
2660
|
+
/**
|
2661
|
+
* true if more records can be fetch
|
2662
|
+
*/
|
2663
|
+
more: boolean;
|
2664
|
+
};
|
2665
|
+
logs: Commit[];
|
2555
2666
|
};
|
2556
|
-
declare type
|
2557
|
-
|
2558
|
-
|
2559
|
-
|
2560
|
-
|
2561
|
-
|
2562
|
-
|
2563
|
-
|
2564
|
-
|
2565
|
-
|
2566
|
-
|
2567
|
-
|
2568
|
-
|
2569
|
-
|
2667
|
+
declare type GetBranchSchemaHistoryRequestBody = {
|
2668
|
+
page?: {
|
2669
|
+
/**
|
2670
|
+
* Query the next page that follow the cursor.
|
2671
|
+
*/
|
2672
|
+
after?: string;
|
2673
|
+
/**
|
2674
|
+
* Query the previous page before the cursor.
|
2675
|
+
*/
|
2676
|
+
before?: string;
|
2677
|
+
/**
|
2678
|
+
* Set page size. If the size is missing it is read from the cursor. If no cursor is given xata will choose the default page size.
|
2679
|
+
*
|
2680
|
+
* @default 20
|
2681
|
+
*/
|
2682
|
+
size?: number;
|
2683
|
+
};
|
2570
2684
|
};
|
2571
|
-
declare type
|
2572
|
-
|
2573
|
-
|
2574
|
-
} | {
|
2575
|
-
status: 401;
|
2576
|
-
payload: AuthError;
|
2577
|
-
} | {
|
2578
|
-
status: 404;
|
2579
|
-
payload: SimpleError;
|
2580
|
-
}>;
|
2581
|
-
declare type GetBranchMigrationPlanVariables = {
|
2582
|
-
body: Schema;
|
2583
|
-
pathParams: GetBranchMigrationPlanPathParams;
|
2685
|
+
declare type GetBranchSchemaHistoryVariables = {
|
2686
|
+
body?: GetBranchSchemaHistoryRequestBody;
|
2687
|
+
pathParams: GetBranchSchemaHistoryPathParams;
|
2584
2688
|
} & FetcherExtraProps;
|
2585
|
-
|
2586
|
-
* Compute a migration plan from a target schema the branch should be migrated too.
|
2587
|
-
*/
|
2588
|
-
declare const getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<BranchMigrationPlan>;
|
2689
|
+
declare const getBranchSchemaHistory: (variables: GetBranchSchemaHistoryVariables, signal?: AbortSignal) => Promise<GetBranchSchemaHistoryResponse>;
|
2589
2690
|
declare type CompareBranchWithUserSchemaPathParams = {
|
2590
2691
|
/**
|
2591
2692
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2722,94 +2823,6 @@ declare type ApplyBranchSchemaEditVariables = {
|
|
2722
2823
|
pathParams: ApplyBranchSchemaEditPathParams;
|
2723
2824
|
} & FetcherExtraProps;
|
2724
2825
|
declare const applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal) => Promise<ApplyBranchSchemaEditResponse>;
|
2725
|
-
declare type GetBranchSchemaHistoryPathParams = {
|
2726
|
-
/**
|
2727
|
-
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2728
|
-
*/
|
2729
|
-
dbBranchName: DBBranchName;
|
2730
|
-
workspace: string;
|
2731
|
-
};
|
2732
|
-
declare type GetBranchSchemaHistoryError = ErrorWrapper<{
|
2733
|
-
status: 400;
|
2734
|
-
payload: BadRequestError;
|
2735
|
-
} | {
|
2736
|
-
status: 401;
|
2737
|
-
payload: AuthError;
|
2738
|
-
} | {
|
2739
|
-
status: 404;
|
2740
|
-
payload: SimpleError;
|
2741
|
-
}>;
|
2742
|
-
declare type GetBranchSchemaHistoryResponse = {
|
2743
|
-
meta: {
|
2744
|
-
/**
|
2745
|
-
* last record id
|
2746
|
-
*/
|
2747
|
-
cursor: string;
|
2748
|
-
/**
|
2749
|
-
* true if more records can be fetch
|
2750
|
-
*/
|
2751
|
-
more: boolean;
|
2752
|
-
};
|
2753
|
-
logs: Commit[];
|
2754
|
-
};
|
2755
|
-
declare type GetBranchSchemaHistoryRequestBody = {
|
2756
|
-
page?: {
|
2757
|
-
/**
|
2758
|
-
* Query the next page that follow the cursor.
|
2759
|
-
*/
|
2760
|
-
after?: string;
|
2761
|
-
/**
|
2762
|
-
* Query the previous page before the cursor.
|
2763
|
-
*/
|
2764
|
-
before?: string;
|
2765
|
-
/**
|
2766
|
-
* Set page size. If the size is missing it is read from the cursor. If no cursor is given xata will choose the default page size.
|
2767
|
-
*
|
2768
|
-
* @default 20
|
2769
|
-
*/
|
2770
|
-
size?: number;
|
2771
|
-
};
|
2772
|
-
};
|
2773
|
-
declare type GetBranchSchemaHistoryVariables = {
|
2774
|
-
body?: GetBranchSchemaHistoryRequestBody;
|
2775
|
-
pathParams: GetBranchSchemaHistoryPathParams;
|
2776
|
-
} & FetcherExtraProps;
|
2777
|
-
declare const getBranchSchemaHistory: (variables: GetBranchSchemaHistoryVariables, signal?: AbortSignal) => Promise<GetBranchSchemaHistoryResponse>;
|
2778
|
-
declare type GetBranchStatsPathParams = {
|
2779
|
-
/**
|
2780
|
-
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2781
|
-
*/
|
2782
|
-
dbBranchName: DBBranchName;
|
2783
|
-
workspace: string;
|
2784
|
-
};
|
2785
|
-
declare type GetBranchStatsError = ErrorWrapper<{
|
2786
|
-
status: 400;
|
2787
|
-
payload: SimpleError;
|
2788
|
-
} | {
|
2789
|
-
status: 401;
|
2790
|
-
payload: AuthError;
|
2791
|
-
} | {
|
2792
|
-
status: 404;
|
2793
|
-
payload: SimpleError;
|
2794
|
-
}>;
|
2795
|
-
declare type GetBranchStatsResponse = {
|
2796
|
-
timestamp: string;
|
2797
|
-
interval: string;
|
2798
|
-
resolution: string;
|
2799
|
-
numberOfRecords?: MetricsDatapoint[];
|
2800
|
-
writesOverTime?: MetricsDatapoint[];
|
2801
|
-
readsOverTime?: MetricsDatapoint[];
|
2802
|
-
readLatency?: MetricsLatency;
|
2803
|
-
writeLatency?: MetricsLatency;
|
2804
|
-
warning?: string;
|
2805
|
-
};
|
2806
|
-
declare type GetBranchStatsVariables = {
|
2807
|
-
pathParams: GetBranchStatsPathParams;
|
2808
|
-
} & FetcherExtraProps;
|
2809
|
-
/**
|
2810
|
-
* Get branch usage metrics.
|
2811
|
-
*/
|
2812
|
-
declare const getBranchStats: (variables: GetBranchStatsVariables, signal?: AbortSignal) => Promise<GetBranchStatsResponse>;
|
2813
2826
|
declare type CreateTablePathParams = {
|
2814
2827
|
/**
|
2815
2828
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3073,7 +3086,7 @@ declare type GetColumnVariables = {
|
|
3073
3086
|
* Get the definition of a single column. To refer to sub-objects, the column name can contain dots. For example `address.country`.
|
3074
3087
|
*/
|
3075
3088
|
declare const getColumn: (variables: GetColumnVariables, signal?: AbortSignal) => Promise<Column>;
|
3076
|
-
declare type
|
3089
|
+
declare type UpdateColumnPathParams = {
|
3077
3090
|
/**
|
3078
3091
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3079
3092
|
*/
|
@@ -3088,7 +3101,7 @@ declare type DeleteColumnPathParams = {
|
|
3088
3101
|
columnName: ColumnName;
|
3089
3102
|
workspace: string;
|
3090
3103
|
};
|
3091
|
-
declare type
|
3104
|
+
declare type UpdateColumnError = ErrorWrapper<{
|
3092
3105
|
status: 400;
|
3093
3106
|
payload: BadRequestError;
|
3094
3107
|
} | {
|
@@ -3098,14 +3111,21 @@ declare type DeleteColumnError = ErrorWrapper<{
|
|
3098
3111
|
status: 404;
|
3099
3112
|
payload: SimpleError;
|
3100
3113
|
}>;
|
3101
|
-
declare type
|
3102
|
-
|
3114
|
+
declare type UpdateColumnRequestBody = {
|
3115
|
+
/**
|
3116
|
+
* @minLength 1
|
3117
|
+
*/
|
3118
|
+
name: string;
|
3119
|
+
};
|
3120
|
+
declare type UpdateColumnVariables = {
|
3121
|
+
body: UpdateColumnRequestBody;
|
3122
|
+
pathParams: UpdateColumnPathParams;
|
3103
3123
|
} & FetcherExtraProps;
|
3104
3124
|
/**
|
3105
|
-
*
|
3125
|
+
* 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`.
|
3106
3126
|
*/
|
3107
|
-
declare const
|
3108
|
-
declare type
|
3127
|
+
declare const updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal) => Promise<MigrationIdResponse>;
|
3128
|
+
declare type DeleteColumnPathParams = {
|
3109
3129
|
/**
|
3110
3130
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3111
3131
|
*/
|
@@ -3120,7 +3140,7 @@ declare type UpdateColumnPathParams = {
|
|
3120
3140
|
columnName: ColumnName;
|
3121
3141
|
workspace: string;
|
3122
3142
|
};
|
3123
|
-
declare type
|
3143
|
+
declare type DeleteColumnError = ErrorWrapper<{
|
3124
3144
|
status: 400;
|
3125
3145
|
payload: BadRequestError;
|
3126
3146
|
} | {
|
@@ -3130,20 +3150,13 @@ declare type UpdateColumnError = ErrorWrapper<{
|
|
3130
3150
|
status: 404;
|
3131
3151
|
payload: SimpleError;
|
3132
3152
|
}>;
|
3133
|
-
declare type
|
3134
|
-
|
3135
|
-
* @minLength 1
|
3136
|
-
*/
|
3137
|
-
name: string;
|
3138
|
-
};
|
3139
|
-
declare type UpdateColumnVariables = {
|
3140
|
-
body: UpdateColumnRequestBody;
|
3141
|
-
pathParams: UpdateColumnPathParams;
|
3153
|
+
declare type DeleteColumnVariables = {
|
3154
|
+
pathParams: DeleteColumnPathParams;
|
3142
3155
|
} & FetcherExtraProps;
|
3143
3156
|
/**
|
3144
|
-
*
|
3157
|
+
* Deletes the specified column. To refer to sub-objects, the column name can contain dots. For example `address.country`.
|
3145
3158
|
*/
|
3146
|
-
declare const
|
3159
|
+
declare const deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal) => Promise<MigrationIdResponse>;
|
3147
3160
|
declare type InsertRecordPathParams = {
|
3148
3161
|
/**
|
3149
3162
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3180,6 +3193,45 @@ declare type InsertRecordVariables = {
|
|
3180
3193
|
* Insert a new Record into the Table
|
3181
3194
|
*/
|
3182
3195
|
declare const insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
3196
|
+
declare type GetRecordPathParams = {
|
3197
|
+
/**
|
3198
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3199
|
+
*/
|
3200
|
+
dbBranchName: DBBranchName;
|
3201
|
+
/**
|
3202
|
+
* The Table name
|
3203
|
+
*/
|
3204
|
+
tableName: TableName;
|
3205
|
+
/**
|
3206
|
+
* The Record name
|
3207
|
+
*/
|
3208
|
+
recordId: RecordID;
|
3209
|
+
workspace: string;
|
3210
|
+
};
|
3211
|
+
declare type GetRecordQueryParams = {
|
3212
|
+
/**
|
3213
|
+
* Column filters
|
3214
|
+
*/
|
3215
|
+
columns?: ColumnsProjection;
|
3216
|
+
};
|
3217
|
+
declare type GetRecordError = ErrorWrapper<{
|
3218
|
+
status: 400;
|
3219
|
+
payload: BadRequestError;
|
3220
|
+
} | {
|
3221
|
+
status: 401;
|
3222
|
+
payload: AuthError;
|
3223
|
+
} | {
|
3224
|
+
status: 404;
|
3225
|
+
payload: SimpleError;
|
3226
|
+
}>;
|
3227
|
+
declare type GetRecordVariables = {
|
3228
|
+
pathParams: GetRecordPathParams;
|
3229
|
+
queryParams?: GetRecordQueryParams;
|
3230
|
+
} & FetcherExtraProps;
|
3231
|
+
/**
|
3232
|
+
* Retrieve record by ID
|
3233
|
+
*/
|
3234
|
+
declare const getRecord: (variables: GetRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
|
3183
3235
|
declare type InsertRecordWithIDPathParams = {
|
3184
3236
|
/**
|
3185
3237
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3343,45 +3395,6 @@ declare type DeleteRecordVariables = {
|
|
3343
3395
|
queryParams?: DeleteRecordQueryParams;
|
3344
3396
|
} & FetcherExtraProps;
|
3345
3397
|
declare const deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
|
3346
|
-
declare type GetRecordPathParams = {
|
3347
|
-
/**
|
3348
|
-
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3349
|
-
*/
|
3350
|
-
dbBranchName: DBBranchName;
|
3351
|
-
/**
|
3352
|
-
* The Table name
|
3353
|
-
*/
|
3354
|
-
tableName: TableName;
|
3355
|
-
/**
|
3356
|
-
* The Record name
|
3357
|
-
*/
|
3358
|
-
recordId: RecordID;
|
3359
|
-
workspace: string;
|
3360
|
-
};
|
3361
|
-
declare type GetRecordQueryParams = {
|
3362
|
-
/**
|
3363
|
-
* Column filters
|
3364
|
-
*/
|
3365
|
-
columns?: ColumnsProjection;
|
3366
|
-
};
|
3367
|
-
declare type GetRecordError = ErrorWrapper<{
|
3368
|
-
status: 400;
|
3369
|
-
payload: BadRequestError;
|
3370
|
-
} | {
|
3371
|
-
status: 401;
|
3372
|
-
payload: AuthError;
|
3373
|
-
} | {
|
3374
|
-
status: 404;
|
3375
|
-
payload: SimpleError;
|
3376
|
-
}>;
|
3377
|
-
declare type GetRecordVariables = {
|
3378
|
-
pathParams: GetRecordPathParams;
|
3379
|
-
queryParams?: GetRecordQueryParams;
|
3380
|
-
} & FetcherExtraProps;
|
3381
|
-
/**
|
3382
|
-
* Retrieve record by ID
|
3383
|
-
*/
|
3384
|
-
declare const getRecord: (variables: GetRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
|
3385
3398
|
declare type BulkInsertTableRecordsPathParams = {
|
3386
3399
|
/**
|
3387
3400
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -4190,18 +4203,14 @@ declare type QueryTableVariables = {
|
|
4190
4203
|
* ```
|
4191
4204
|
*/
|
4192
4205
|
declare const queryTable: (variables: QueryTableVariables, signal?: AbortSignal) => Promise<QueryResponse>;
|
4193
|
-
declare type
|
4206
|
+
declare type SearchBranchPathParams = {
|
4194
4207
|
/**
|
4195
4208
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4196
4209
|
*/
|
4197
4210
|
dbBranchName: DBBranchName;
|
4198
|
-
/**
|
4199
|
-
* The Table name
|
4200
|
-
*/
|
4201
|
-
tableName: TableName;
|
4202
4211
|
workspace: string;
|
4203
4212
|
};
|
4204
|
-
declare type
|
4213
|
+
declare type SearchBranchError = ErrorWrapper<{
|
4205
4214
|
status: 400;
|
4206
4215
|
payload: BadRequestError;
|
4207
4216
|
} | {
|
@@ -4211,7 +4220,19 @@ declare type SearchTableError = ErrorWrapper<{
|
|
4211
4220
|
status: 404;
|
4212
4221
|
payload: SimpleError;
|
4213
4222
|
}>;
|
4214
|
-
declare type
|
4223
|
+
declare type SearchBranchRequestBody = {
|
4224
|
+
/**
|
4225
|
+
* An array with the tables in which to search. By default, all tables are included. Optionally, filters can be included that apply to each table.
|
4226
|
+
*/
|
4227
|
+
tables?: (string | {
|
4228
|
+
/**
|
4229
|
+
* The name of the table.
|
4230
|
+
*/
|
4231
|
+
table: string;
|
4232
|
+
filter?: FilterExpression;
|
4233
|
+
target?: TargetExpression;
|
4234
|
+
boosters?: BoosterExpression[];
|
4235
|
+
})[];
|
4215
4236
|
/**
|
4216
4237
|
* The query string.
|
4217
4238
|
*
|
@@ -4219,32 +4240,29 @@ declare type SearchTableRequestBody = {
|
|
4219
4240
|
*/
|
4220
4241
|
query: string;
|
4221
4242
|
fuzziness?: FuzzinessExpression;
|
4222
|
-
target?: TargetExpression;
|
4223
4243
|
prefix?: PrefixExpression;
|
4224
|
-
filter?: FilterExpression;
|
4225
4244
|
highlight?: HighlightExpression;
|
4226
|
-
boosters?: BoosterExpression[];
|
4227
4245
|
};
|
4228
|
-
declare type
|
4229
|
-
body:
|
4230
|
-
pathParams:
|
4246
|
+
declare type SearchBranchVariables = {
|
4247
|
+
body: SearchBranchRequestBody;
|
4248
|
+
pathParams: SearchBranchPathParams;
|
4231
4249
|
} & FetcherExtraProps;
|
4232
4250
|
/**
|
4233
|
-
* Run a free text search operation
|
4234
|
-
*
|
4235
|
-
* The endpoint accepts a `query` parameter that is used for the free text search and a set of structured filters (via the `filter` parameter) that are applied before the search. The `filter` parameter uses the same syntax as the [query endpoint](/api-reference/db/db_branch_name/tables/table_name/) with the following exceptions:
|
4236
|
-
* * filters `$contains`, `$startsWith`, `$endsWith` don't work on columns of type `text`
|
4237
|
-
* * filtering on columns of type `multiple` is currently unsupported
|
4251
|
+
* Run a free text search operation across the database branch.
|
4238
4252
|
*/
|
4239
|
-
declare const
|
4240
|
-
declare type
|
4253
|
+
declare const searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
4254
|
+
declare type SearchTablePathParams = {
|
4241
4255
|
/**
|
4242
4256
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4243
4257
|
*/
|
4244
|
-
dbBranchName: DBBranchName;
|
4258
|
+
dbBranchName: DBBranchName;
|
4259
|
+
/**
|
4260
|
+
* The Table name
|
4261
|
+
*/
|
4262
|
+
tableName: TableName;
|
4245
4263
|
workspace: string;
|
4246
4264
|
};
|
4247
|
-
declare type
|
4265
|
+
declare type SearchTableError = ErrorWrapper<{
|
4248
4266
|
status: 400;
|
4249
4267
|
payload: BadRequestError;
|
4250
4268
|
} | {
|
@@ -4254,19 +4272,7 @@ declare type SearchBranchError = ErrorWrapper<{
|
|
4254
4272
|
status: 404;
|
4255
4273
|
payload: SimpleError;
|
4256
4274
|
}>;
|
4257
|
-
declare type
|
4258
|
-
/**
|
4259
|
-
* An array with the tables in which to search. By default, all tables are included. Optionally, filters can be included that apply to each table.
|
4260
|
-
*/
|
4261
|
-
tables?: (string | {
|
4262
|
-
/**
|
4263
|
-
* The name of the table.
|
4264
|
-
*/
|
4265
|
-
table: string;
|
4266
|
-
filter?: FilterExpression;
|
4267
|
-
target?: TargetExpression;
|
4268
|
-
boosters?: BoosterExpression[];
|
4269
|
-
})[];
|
4275
|
+
declare type SearchTableRequestBody = {
|
4270
4276
|
/**
|
4271
4277
|
* The query string.
|
4272
4278
|
*
|
@@ -4274,17 +4280,24 @@ declare type SearchBranchRequestBody = {
|
|
4274
4280
|
*/
|
4275
4281
|
query: string;
|
4276
4282
|
fuzziness?: FuzzinessExpression;
|
4283
|
+
target?: TargetExpression;
|
4277
4284
|
prefix?: PrefixExpression;
|
4285
|
+
filter?: FilterExpression;
|
4278
4286
|
highlight?: HighlightExpression;
|
4287
|
+
boosters?: BoosterExpression[];
|
4279
4288
|
};
|
4280
|
-
declare type
|
4281
|
-
body:
|
4282
|
-
pathParams:
|
4289
|
+
declare type SearchTableVariables = {
|
4290
|
+
body: SearchTableRequestBody;
|
4291
|
+
pathParams: SearchTablePathParams;
|
4283
4292
|
} & FetcherExtraProps;
|
4284
4293
|
/**
|
4285
|
-
* Run a free text search operation
|
4294
|
+
* Run a free text search operation in a particular table.
|
4295
|
+
*
|
4296
|
+
* The endpoint accepts a `query` parameter that is used for the free text search and a set of structured filters (via the `filter` parameter) that are applied before the search. The `filter` parameter uses the same syntax as the [query endpoint](/api-reference/db/db_branch_name/tables/table_name/) with the following exceptions:
|
4297
|
+
* * filters `$contains`, `$startsWith`, `$endsWith` don't work on columns of type `text`
|
4298
|
+
* * filtering on columns of type `multiple` is currently unsupported
|
4286
4299
|
*/
|
4287
|
-
declare const
|
4300
|
+
declare const searchTable: (variables: SearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
4288
4301
|
declare type SummarizeTablePathParams = {
|
4289
4302
|
/**
|
4290
4303
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -4307,7 +4320,7 @@ declare type SummarizeTableError = ErrorWrapper<{
|
|
4307
4320
|
payload: SimpleError;
|
4308
4321
|
}>;
|
4309
4322
|
declare type SummarizeTableRequestBody = {
|
4310
|
-
|
4323
|
+
filter?: FilterExpression;
|
4311
4324
|
columns?: ColumnsProjection;
|
4312
4325
|
summaries?: SummaryExpressionList;
|
4313
4326
|
sort?: SortExpression;
|
@@ -4352,7 +4365,7 @@ declare type SummarizeTableVariables = {
|
|
4352
4365
|
* will count all rows in each group with non-null product names.
|
4353
4366
|
* - Set `sort: [{"total_sales": "desc"}]` in order to bring the rows with
|
4354
4367
|
* the highest total_sales field to the top.
|
4355
|
-
* - Set `
|
4368
|
+
* - Set `summariesFilter: {"total_sales": {"$ge": 10}}` to only send back data
|
4356
4369
|
* with greater than or equal to 10 units.
|
4357
4370
|
*
|
4358
4371
|
* `columns`: tells Xata how to create each group. If you add `product_id`
|
@@ -4572,29 +4585,53 @@ declare type CPUpdateCPDatabaseMetadataVariables = {
|
|
4572
4585
|
* Update the color of the selected database
|
4573
4586
|
*/
|
4574
4587
|
declare const cPUpdateCPDatabaseMetadata: (variables: CPUpdateCPDatabaseMetadataVariables, signal?: AbortSignal) => Promise<CPDatabaseMetadata>;
|
4588
|
+
declare type ListRegionsPathParams = {
|
4589
|
+
/**
|
4590
|
+
* Workspace ID
|
4591
|
+
*/
|
4592
|
+
workspaceId: WorkspaceID;
|
4593
|
+
};
|
4594
|
+
declare type ListRegionsError = ErrorWrapper<{
|
4595
|
+
status: 400;
|
4596
|
+
payload: BadRequestError;
|
4597
|
+
} | {
|
4598
|
+
status: 401;
|
4599
|
+
payload: AuthError;
|
4600
|
+
}>;
|
4601
|
+
declare type ListRegionsVariables = {
|
4602
|
+
pathParams: ListRegionsPathParams;
|
4603
|
+
} & FetcherExtraProps;
|
4604
|
+
/**
|
4605
|
+
* List regions available to create a database on
|
4606
|
+
*/
|
4607
|
+
declare const listRegions: (variables: ListRegionsVariables, signal?: AbortSignal) => Promise<ListRegionsResponse>;
|
4575
4608
|
declare const operationsByTag: {
|
4576
4609
|
users: {
|
4577
4610
|
getUser: (variables: GetUserVariables, signal?: AbortSignal) => Promise<UserWithID>;
|
4578
4611
|
updateUser: (variables: UpdateUserVariables, signal?: AbortSignal) => Promise<UserWithID>;
|
4579
4612
|
deleteUser: (variables: DeleteUserVariables, signal?: AbortSignal) => Promise<undefined>;
|
4613
|
+
};
|
4614
|
+
authentication: {
|
4580
4615
|
getUserAPIKeys: (variables: GetUserAPIKeysVariables, signal?: AbortSignal) => Promise<GetUserAPIKeysResponse>;
|
4581
4616
|
createUserAPIKey: (variables: CreateUserAPIKeyVariables, signal?: AbortSignal) => Promise<CreateUserAPIKeyResponse>;
|
4582
4617
|
deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal) => Promise<undefined>;
|
4583
4618
|
};
|
4584
4619
|
workspaces: {
|
4585
|
-
createWorkspace: (variables: CreateWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
4586
4620
|
getWorkspacesList: (variables: GetWorkspacesListVariables, signal?: AbortSignal) => Promise<GetWorkspacesListResponse>;
|
4621
|
+
createWorkspace: (variables: CreateWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
4587
4622
|
getWorkspace: (variables: GetWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
4588
4623
|
updateWorkspace: (variables: UpdateWorkspaceVariables, signal?: AbortSignal) => Promise<Workspace>;
|
4589
4624
|
deleteWorkspace: (variables: DeleteWorkspaceVariables, signal?: AbortSignal) => Promise<undefined>;
|
4590
4625
|
getWorkspaceMembersList: (variables: GetWorkspaceMembersListVariables, signal?: AbortSignal) => Promise<WorkspaceMembers>;
|
4591
4626
|
updateWorkspaceMemberRole: (variables: UpdateWorkspaceMemberRoleVariables, signal?: AbortSignal) => Promise<undefined>;
|
4592
4627
|
removeWorkspaceMember: (variables: RemoveWorkspaceMemberVariables, signal?: AbortSignal) => Promise<undefined>;
|
4628
|
+
};
|
4629
|
+
invites: {
|
4593
4630
|
inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables, signal?: AbortSignal) => Promise<WorkspaceInvite>;
|
4594
4631
|
updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<WorkspaceInvite>;
|
4595
4632
|
cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
4596
|
-
resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
4597
4633
|
acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
4634
|
+
resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
4598
4635
|
};
|
4599
4636
|
database: {
|
4600
4637
|
getDatabaseList: (variables: GetDatabaseListVariables, signal?: AbortSignal) => Promise<ListDatabasesResponse>;
|
@@ -4602,10 +4639,6 @@ declare const operationsByTag: {
|
|
4602
4639
|
deleteDatabase: (variables: DeleteDatabaseVariables, signal?: AbortSignal) => Promise<undefined>;
|
4603
4640
|
getDatabaseMetadata: (variables: GetDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
4604
4641
|
updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
4605
|
-
getGitBranchesMapping: (variables: GetGitBranchesMappingVariables, signal?: AbortSignal) => Promise<ListGitBranchesResponse>;
|
4606
|
-
addGitBranchesEntry: (variables: AddGitBranchesEntryVariables, signal?: AbortSignal) => Promise<AddGitBranchesEntryResponse>;
|
4607
|
-
removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables, signal?: AbortSignal) => Promise<undefined>;
|
4608
|
-
resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal) => Promise<ResolveBranchResponse>;
|
4609
4642
|
};
|
4610
4643
|
branch: {
|
4611
4644
|
getBranchList: (variables: GetBranchListVariables, signal?: AbortSignal) => Promise<ListBranchesResponse>;
|
@@ -4615,6 +4648,21 @@ declare const operationsByTag: {
|
|
4615
4648
|
updateBranchMetadata: (variables: UpdateBranchMetadataVariables, signal?: AbortSignal) => Promise<undefined>;
|
4616
4649
|
getBranchMetadata: (variables: GetBranchMetadataVariables, signal?: AbortSignal) => Promise<BranchMetadata>;
|
4617
4650
|
getBranchStats: (variables: GetBranchStatsVariables, signal?: AbortSignal) => Promise<GetBranchStatsResponse>;
|
4651
|
+
getGitBranchesMapping: (variables: GetGitBranchesMappingVariables, signal?: AbortSignal) => Promise<ListGitBranchesResponse>;
|
4652
|
+
addGitBranchesEntry: (variables: AddGitBranchesEntryVariables, signal?: AbortSignal) => Promise<AddGitBranchesEntryResponse>;
|
4653
|
+
removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables, signal?: AbortSignal) => Promise<undefined>;
|
4654
|
+
resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal) => Promise<ResolveBranchResponse>;
|
4655
|
+
};
|
4656
|
+
migrations: {
|
4657
|
+
getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal) => Promise<GetBranchMigrationHistoryResponse>;
|
4658
|
+
getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<BranchMigrationPlan>;
|
4659
|
+
executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<undefined>;
|
4660
|
+
getBranchSchemaHistory: (variables: GetBranchSchemaHistoryVariables, signal?: AbortSignal) => Promise<GetBranchSchemaHistoryResponse>;
|
4661
|
+
compareBranchWithUserSchema: (variables: CompareBranchWithUserSchemaVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
4662
|
+
compareBranchSchemas: (variables: CompareBranchSchemasVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
4663
|
+
updateBranchSchema: (variables: UpdateBranchSchemaVariables, signal?: AbortSignal) => Promise<UpdateBranchSchemaResponse>;
|
4664
|
+
previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables, signal?: AbortSignal) => Promise<PreviewBranchSchemaEditResponse>;
|
4665
|
+
applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal) => Promise<ApplyBranchSchemaEditResponse>;
|
4618
4666
|
};
|
4619
4667
|
migrationRequests: {
|
4620
4668
|
queryMigrationRequests: (variables: QueryMigrationRequestsVariables, signal?: AbortSignal) => Promise<QueryMigrationRequestsResponse>;
|
@@ -4626,17 +4674,6 @@ declare const operationsByTag: {
|
|
4626
4674
|
getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables, signal?: AbortSignal) => Promise<GetMigrationRequestIsMergedResponse>;
|
4627
4675
|
mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal) => Promise<Commit>;
|
4628
4676
|
};
|
4629
|
-
branchSchema: {
|
4630
|
-
getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal) => Promise<GetBranchMigrationHistoryResponse>;
|
4631
|
-
executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<undefined>;
|
4632
|
-
getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<BranchMigrationPlan>;
|
4633
|
-
compareBranchWithUserSchema: (variables: CompareBranchWithUserSchemaVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
4634
|
-
compareBranchSchemas: (variables: CompareBranchSchemasVariables, signal?: AbortSignal) => Promise<SchemaCompareResponse>;
|
4635
|
-
updateBranchSchema: (variables: UpdateBranchSchemaVariables, signal?: AbortSignal) => Promise<UpdateBranchSchemaResponse>;
|
4636
|
-
previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables, signal?: AbortSignal) => Promise<PreviewBranchSchemaEditResponse>;
|
4637
|
-
applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal) => Promise<ApplyBranchSchemaEditResponse>;
|
4638
|
-
getBranchSchemaHistory: (variables: GetBranchSchemaHistoryVariables, signal?: AbortSignal) => Promise<GetBranchSchemaHistoryResponse>;
|
4639
|
-
};
|
4640
4677
|
table: {
|
4641
4678
|
createTable: (variables: CreateTableVariables, signal?: AbortSignal) => Promise<CreateTableResponse>;
|
4642
4679
|
deleteTable: (variables: DeleteTableVariables, signal?: AbortSignal) => Promise<undefined>;
|
@@ -4646,20 +4683,22 @@ declare const operationsByTag: {
|
|
4646
4683
|
getTableColumns: (variables: GetTableColumnsVariables, signal?: AbortSignal) => Promise<GetTableColumnsResponse>;
|
4647
4684
|
addTableColumn: (variables: AddTableColumnVariables, signal?: AbortSignal) => Promise<MigrationIdResponse>;
|
4648
4685
|
getColumn: (variables: GetColumnVariables, signal?: AbortSignal) => Promise<Column>;
|
4649
|
-
deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal) => Promise<MigrationIdResponse>;
|
4650
4686
|
updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal) => Promise<MigrationIdResponse>;
|
4687
|
+
deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal) => Promise<MigrationIdResponse>;
|
4651
4688
|
};
|
4652
4689
|
records: {
|
4653
4690
|
insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
4691
|
+
getRecord: (variables: GetRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
|
4654
4692
|
insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
4655
4693
|
updateRecordWithID: (variables: UpdateRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
4656
4694
|
upsertRecordWithID: (variables: UpsertRecordWithIDVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
4657
4695
|
deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
|
4658
|
-
getRecord: (variables: GetRecordVariables, signal?: AbortSignal) => Promise<XataRecord$1>;
|
4659
4696
|
bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal) => Promise<BulkInsertResponse>;
|
4697
|
+
};
|
4698
|
+
searchAndFilter: {
|
4660
4699
|
queryTable: (variables: QueryTableVariables, signal?: AbortSignal) => Promise<QueryResponse>;
|
4661
|
-
searchTable: (variables: SearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
4662
4700
|
searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
4701
|
+
searchTable: (variables: SearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
4663
4702
|
summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal) => Promise<SummarizeResponse>;
|
4664
4703
|
aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal) => Promise<AggResponse>;
|
4665
4704
|
};
|
@@ -4669,6 +4708,7 @@ declare const operationsByTag: {
|
|
4669
4708
|
cPDeleteDatabase: (variables: CPDeleteDatabaseVariables, signal?: AbortSignal) => Promise<undefined>;
|
4670
4709
|
cPGetCPDatabaseMetadata: (variables: CPGetCPDatabaseMetadataVariables, signal?: AbortSignal) => Promise<CPDatabaseMetadata>;
|
4671
4710
|
cPUpdateCPDatabaseMetadata: (variables: CPUpdateCPDatabaseMetadataVariables, signal?: AbortSignal) => Promise<CPDatabaseMetadata>;
|
4711
|
+
listRegions: (variables: ListRegionsVariables, signal?: AbortSignal) => Promise<ListRegionsResponse>;
|
4672
4712
|
};
|
4673
4713
|
};
|
4674
4714
|
|
@@ -4693,13 +4733,17 @@ declare class XataApiClient {
|
|
4693
4733
|
#private;
|
4694
4734
|
constructor(options?: XataApiClientOptions);
|
4695
4735
|
get user(): UserApi;
|
4736
|
+
get authentication(): AuthenticationApi;
|
4696
4737
|
get workspaces(): WorkspaceApi;
|
4697
|
-
get
|
4738
|
+
get invites(): InvitesApi;
|
4739
|
+
get database(): DatabaseApi;
|
4698
4740
|
get branches(): BranchApi;
|
4741
|
+
get migrations(): MigrationsApi;
|
4742
|
+
get migrationRequests(): MigrationRequestsApi;
|
4699
4743
|
get tables(): TableApi;
|
4700
4744
|
get records(): RecordsApi;
|
4701
|
-
get
|
4702
|
-
get
|
4745
|
+
get searchAndFilter(): SearchAndFilterApi;
|
4746
|
+
get databases(): DatabasesApi;
|
4703
4747
|
}
|
4704
4748
|
declare class UserApi {
|
4705
4749
|
private extraProps;
|
@@ -4707,6 +4751,10 @@ declare class UserApi {
|
|
4707
4751
|
getUser(): Promise<UserWithID>;
|
4708
4752
|
updateUser(user: User): Promise<UserWithID>;
|
4709
4753
|
deleteUser(): Promise<void>;
|
4754
|
+
}
|
4755
|
+
declare class AuthenticationApi {
|
4756
|
+
private extraProps;
|
4757
|
+
constructor(extraProps: FetcherExtraProps);
|
4710
4758
|
getUserAPIKeys(): Promise<GetUserAPIKeysResponse>;
|
4711
4759
|
createUserAPIKey(keyName: APIKeyName): Promise<CreateUserAPIKeyResponse>;
|
4712
4760
|
deleteUserAPIKey(keyName: APIKeyName): Promise<void>;
|
@@ -4714,19 +4762,23 @@ declare class UserApi {
|
|
4714
4762
|
declare class WorkspaceApi {
|
4715
4763
|
private extraProps;
|
4716
4764
|
constructor(extraProps: FetcherExtraProps);
|
4717
|
-
createWorkspace(workspaceMeta: WorkspaceMeta): Promise<Workspace>;
|
4718
4765
|
getWorkspacesList(): Promise<GetWorkspacesListResponse>;
|
4766
|
+
createWorkspace(workspaceMeta: WorkspaceMeta): Promise<Workspace>;
|
4719
4767
|
getWorkspace(workspaceId: WorkspaceID): Promise<Workspace>;
|
4720
4768
|
updateWorkspace(workspaceId: WorkspaceID, workspaceMeta: WorkspaceMeta): Promise<Workspace>;
|
4721
4769
|
deleteWorkspace(workspaceId: WorkspaceID): Promise<void>;
|
4722
4770
|
getWorkspaceMembersList(workspaceId: WorkspaceID): Promise<WorkspaceMembers>;
|
4723
4771
|
updateWorkspaceMemberRole(workspaceId: WorkspaceID, userId: UserID, role: Role): Promise<void>;
|
4724
4772
|
removeWorkspaceMember(workspaceId: WorkspaceID, userId: UserID): Promise<void>;
|
4773
|
+
}
|
4774
|
+
declare class InvitesApi {
|
4775
|
+
private extraProps;
|
4776
|
+
constructor(extraProps: FetcherExtraProps);
|
4725
4777
|
inviteWorkspaceMember(workspaceId: WorkspaceID, email: string, role: Role): Promise<WorkspaceInvite>;
|
4726
4778
|
updateWorkspaceMemberInvite(workspaceId: WorkspaceID, inviteId: InviteID, role: Role): Promise<WorkspaceInvite>;
|
4727
4779
|
cancelWorkspaceMemberInvite(workspaceId: WorkspaceID, inviteId: InviteID): Promise<void>;
|
4728
|
-
resendWorkspaceMemberInvite(workspaceId: WorkspaceID, inviteId: InviteID): Promise<void>;
|
4729
4780
|
acceptWorkspaceMemberInvite(workspaceId: WorkspaceID, inviteKey: InviteKey): Promise<void>;
|
4781
|
+
resendWorkspaceMemberInvite(workspaceId: WorkspaceID, inviteId: InviteID): Promise<void>;
|
4730
4782
|
}
|
4731
4783
|
declare class DatabaseApi {
|
4732
4784
|
private extraProps;
|
@@ -4736,10 +4788,6 @@ declare class DatabaseApi {
|
|
4736
4788
|
deleteDatabase(workspace: WorkspaceID, dbName: DBName): Promise<void>;
|
4737
4789
|
getDatabaseMetadata(workspace: WorkspaceID, dbName: DBName): Promise<DatabaseMetadata>;
|
4738
4790
|
updateDatabaseMetadata(workspace: WorkspaceID, dbName: DBName, options?: UpdateDatabaseMetadataRequestBody): Promise<DatabaseMetadata>;
|
4739
|
-
getGitBranchesMapping(workspace: WorkspaceID, dbName: DBName): Promise<ListGitBranchesResponse>;
|
4740
|
-
addGitBranchesEntry(workspace: WorkspaceID, dbName: DBName, body: AddGitBranchesEntryRequestBody): Promise<AddGitBranchesEntryResponse>;
|
4741
|
-
removeGitBranchesEntry(workspace: WorkspaceID, dbName: DBName, gitBranch: string): Promise<void>;
|
4742
|
-
resolveBranch(workspace: WorkspaceID, dbName: DBName, gitBranch?: string, fallbackBranch?: string): Promise<ResolveBranchResponse>;
|
4743
4791
|
}
|
4744
4792
|
declare class BranchApi {
|
4745
4793
|
private extraProps;
|
@@ -4751,6 +4799,10 @@ declare class BranchApi {
|
|
4751
4799
|
updateBranchMetadata(workspace: WorkspaceID, database: DBName, branch: BranchName, metadata?: BranchMetadata): Promise<void>;
|
4752
4800
|
getBranchMetadata(workspace: WorkspaceID, database: DBName, branch: BranchName): Promise<BranchMetadata>;
|
4753
4801
|
getBranchStats(workspace: WorkspaceID, database: DBName, branch: BranchName): Promise<GetBranchStatsResponse>;
|
4802
|
+
getGitBranchesMapping(workspace: WorkspaceID, dbName: DBName): Promise<ListGitBranchesResponse>;
|
4803
|
+
addGitBranchesEntry(workspace: WorkspaceID, dbName: DBName, body: AddGitBranchesEntryRequestBody): Promise<AddGitBranchesEntryResponse>;
|
4804
|
+
removeGitBranchesEntry(workspace: WorkspaceID, dbName: DBName, gitBranch: string): Promise<void>;
|
4805
|
+
resolveBranch(workspace: WorkspaceID, dbName: DBName, gitBranch?: string, fallbackBranch?: string): Promise<ResolveBranchResponse>;
|
4754
4806
|
}
|
4755
4807
|
declare class TableApi {
|
4756
4808
|
private extraProps;
|
@@ -4763,23 +4815,28 @@ declare class TableApi {
|
|
4763
4815
|
getTableColumns(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName): Promise<GetTableColumnsResponse>;
|
4764
4816
|
addTableColumn(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, column: Column): Promise<MigrationIdResponse>;
|
4765
4817
|
getColumn(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, columnName: ColumnName): Promise<Column>;
|
4766
|
-
deleteColumn(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, columnName: ColumnName): Promise<MigrationIdResponse>;
|
4767
4818
|
updateColumn(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, columnName: ColumnName, options: UpdateColumnRequestBody): Promise<MigrationIdResponse>;
|
4819
|
+
deleteColumn(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, columnName: ColumnName): Promise<MigrationIdResponse>;
|
4768
4820
|
}
|
4769
4821
|
declare class RecordsApi {
|
4770
4822
|
private extraProps;
|
4771
4823
|
constructor(extraProps: FetcherExtraProps);
|
4772
4824
|
insertRecord(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, record: Record<string, any>, options?: InsertRecordQueryParams): Promise<RecordUpdateResponse>;
|
4825
|
+
getRecord(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID, options?: GetRecordQueryParams): Promise<XataRecord$1>;
|
4773
4826
|
insertRecordWithID(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID, record: Record<string, any>, options?: InsertRecordWithIDQueryParams): Promise<RecordUpdateResponse>;
|
4774
4827
|
updateRecordWithID(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID, record: Record<string, any>, options?: UpdateRecordWithIDQueryParams): Promise<RecordUpdateResponse>;
|
4775
4828
|
upsertRecordWithID(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID, record: Record<string, any>, options?: UpsertRecordWithIDQueryParams): Promise<RecordUpdateResponse>;
|
4776
4829
|
deleteRecord(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID, options?: DeleteRecordQueryParams): Promise<RecordUpdateResponse>;
|
4777
|
-
getRecord(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID, options?: GetRecordQueryParams): Promise<XataRecord$1>;
|
4778
4830
|
bulkInsertTableRecords(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, records: Record<string, any>[], options?: BulkInsertTableRecordsQueryParams): Promise<BulkInsertResponse>;
|
4831
|
+
}
|
4832
|
+
declare class SearchAndFilterApi {
|
4833
|
+
private extraProps;
|
4834
|
+
constructor(extraProps: FetcherExtraProps);
|
4779
4835
|
queryTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: QueryTableRequestBody): Promise<QueryResponse>;
|
4780
4836
|
searchTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: SearchTableRequestBody): Promise<SearchResponse>;
|
4781
4837
|
searchBranch(workspace: WorkspaceID, database: DBName, branch: BranchName, query: SearchBranchRequestBody): Promise<SearchResponse>;
|
4782
4838
|
summarizeTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: SummarizeTableRequestBody): Promise<SummarizeResponse>;
|
4839
|
+
aggregateTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: AggregateTableRequestBody): Promise<AggResponse>;
|
4783
4840
|
}
|
4784
4841
|
declare class MigrationRequestsApi {
|
4785
4842
|
private extraProps;
|
@@ -4793,18 +4850,37 @@ declare class MigrationRequestsApi {
|
|
4793
4850
|
getMigrationRequestIsMerged(workspace: WorkspaceID, database: DBName, migrationRequest: number): Promise<GetMigrationRequestIsMergedResponse>;
|
4794
4851
|
mergeMigrationRequest(workspace: WorkspaceID, database: DBName, migrationRequest: number): Promise<Commit>;
|
4795
4852
|
}
|
4796
|
-
declare class
|
4853
|
+
declare class MigrationsApi {
|
4797
4854
|
private extraProps;
|
4798
4855
|
constructor(extraProps: FetcherExtraProps);
|
4799
4856
|
getBranchMigrationHistory(workspace: WorkspaceID, database: DBName, branch: BranchName, options?: GetBranchMigrationHistoryRequestBody): Promise<GetBranchMigrationHistoryResponse>;
|
4800
|
-
executeBranchMigrationPlan(workspace: WorkspaceID, database: DBName, branch: BranchName, migrationPlan: ExecuteBranchMigrationPlanRequestBody): Promise<void>;
|
4801
4857
|
getBranchMigrationPlan(workspace: WorkspaceID, database: DBName, branch: BranchName, schema: Schema): Promise<BranchMigrationPlan>;
|
4858
|
+
executeBranchMigrationPlan(workspace: WorkspaceID, database: DBName, branch: BranchName, migrationPlan: ExecuteBranchMigrationPlanRequestBody): Promise<void>;
|
4859
|
+
getBranchSchemaHistory(workspace: WorkspaceID, database: DBName, branch: BranchName, options?: GetBranchSchemaHistoryRequestBody): Promise<GetBranchSchemaHistoryResponse>;
|
4802
4860
|
compareBranchWithUserSchema(workspace: WorkspaceID, database: DBName, branch: BranchName, schema: Schema): Promise<SchemaCompareResponse>;
|
4803
4861
|
compareBranchSchemas(workspace: WorkspaceID, database: DBName, branch: BranchName, branchName: BranchName, schema: Schema): Promise<SchemaCompareResponse>;
|
4804
4862
|
updateBranchSchema(workspace: WorkspaceID, database: DBName, branch: BranchName, migration: Migration): Promise<UpdateBranchSchemaResponse>;
|
4805
4863
|
previewBranchSchemaEdit(workspace: WorkspaceID, database: DBName, branch: BranchName, migration: Migration): Promise<PreviewBranchSchemaEditResponse>;
|
4806
4864
|
applyBranchSchemaEdit(workspace: WorkspaceID, database: DBName, branch: BranchName, edits: SchemaEditScript): Promise<ApplyBranchSchemaEditResponse>;
|
4807
|
-
|
4865
|
+
}
|
4866
|
+
declare class DatabasesApi {
|
4867
|
+
private extraProps;
|
4868
|
+
constructor(extraProps: FetcherExtraProps);
|
4869
|
+
/**
|
4870
|
+
*
|
4871
|
+
* cPGetDatabaseList,
|
4872
|
+
cPCreateDatabase,
|
4873
|
+
cPDeleteDatabase,
|
4874
|
+
cPGetCPDatabaseMetadata,
|
4875
|
+
cPUpdateCPDatabaseMetadata,
|
4876
|
+
listRegions
|
4877
|
+
*/
|
4878
|
+
getDatabaseList(workspaceId: WorkspaceID): Promise<CPListDatabasesResponse>;
|
4879
|
+
createDatabase(workspaceId: WorkspaceID, dbName: DBName, options: CPCreateDatabaseRequestBody): Promise<CPCreateDatabaseResponse>;
|
4880
|
+
deleteDatabase(workspaceId: WorkspaceID, dbName: DBName): Promise<void>;
|
4881
|
+
getDatabaseMetadata(workspaceId: WorkspaceID, dbName: DBName): Promise<CPDatabaseMetadata>;
|
4882
|
+
updateDatabaseMetadata(workspaceId: WorkspaceID, dbName: DBName, metadata: CPDatabaseMetadata): Promise<CPDatabaseMetadata>;
|
4883
|
+
listRegions(workspaceId: WorkspaceID): Promise<ListRegionsResponse>;
|
4808
4884
|
}
|
4809
4885
|
|
4810
4886
|
declare class XataApiPlugin implements XataPlugin {
|
@@ -4822,13 +4898,28 @@ declare type RequiredBy<T, K extends keyof T> = T & {
|
|
4822
4898
|
};
|
4823
4899
|
declare type GetArrayInnerType<T extends readonly any[]> = T[number];
|
4824
4900
|
declare type SingleOrArray<T> = T | T[];
|
4901
|
+
declare type Dictionary<T> = Record<string, T>;
|
4825
4902
|
declare type OmitBy<T, K extends keyof T> = T extends any ? Omit<T, K> : never;
|
4826
4903
|
declare type Without<T, U> = {
|
4827
4904
|
[P in Exclude<keyof T, keyof U>]?: never;
|
4828
4905
|
};
|
4829
4906
|
declare type ExclusiveOr<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
|
4907
|
+
declare type Explode<T> = keyof T extends infer K ? K extends unknown ? {
|
4908
|
+
[I in keyof T]: I extends K ? T[I] : never;
|
4909
|
+
} : never : never;
|
4910
|
+
declare type AtMostOne<T> = Explode<Partial<T>>;
|
4911
|
+
declare type AtLeastOne<T, U = {
|
4912
|
+
[K in keyof T]: Pick<T, K>;
|
4913
|
+
}> = Partial<T> & U[keyof U];
|
4914
|
+
declare type ExactlyOne<T> = AtMostOne<T> & AtLeastOne<T>;
|
4830
4915
|
|
4831
4916
|
declare type SelectableColumn<O, RecursivePath extends any[] = []> = '*' | 'id' | DataProps<O> | NestedColumns<O, RecursivePath>;
|
4917
|
+
declare type WildcardColumns<O> = Values<{
|
4918
|
+
[K in SelectableColumn<O>]: K extends `${string}*` ? K : never;
|
4919
|
+
}>;
|
4920
|
+
declare type ColumnsByValue<O, Value> = Values<{
|
4921
|
+
[K in SelectableColumn<O>]: ValueAtColumn<O, K> extends infer C ? C extends Value ? K extends WildcardColumns<O> ? never : K : never : never;
|
4922
|
+
}>;
|
4832
4923
|
declare type SelectedPick<O extends XataRecord, Key extends SelectableColumn<O>[]> = XataRecord<O> & UnionToIntersection<Values<{
|
4833
4924
|
[K in Key[number]]: NestedValueAtColumn<O, K> & XataRecord<O>;
|
4834
4925
|
}>>;
|
@@ -4947,7 +5038,7 @@ declare type EditableData<O extends XataRecord> = Identifiable & Omit<{
|
|
4947
5038
|
}
|
4948
5039
|
*/
|
4949
5040
|
declare type PropertyAccessFilter<Record> = {
|
4950
|
-
[key in
|
5041
|
+
[key in ColumnsByValue<Record, any>]?: NestedApiFilter<ValueAtColumn<Record, key>> | PropertyFilter<ValueAtColumn<Record, key>>;
|
4951
5042
|
};
|
4952
5043
|
declare type PropertyFilter<T> = T | {
|
4953
5044
|
$is: T;
|
@@ -5009,7 +5100,7 @@ declare type AggregatorFilter<T> = {
|
|
5009
5100
|
* Example: { filter: { $exists: "settings" } }
|
5010
5101
|
*/
|
5011
5102
|
declare type ExistanceFilter<Record> = {
|
5012
|
-
[key in '$exists' | '$notExists']?:
|
5103
|
+
[key in '$exists' | '$notExists']?: ColumnsByValue<Record, any>;
|
5013
5104
|
};
|
5014
5105
|
declare type BaseApiFilter<Record> = PropertyAccessFilter<Record> | AggregatorFilter<Record> | ExistanceFilter<Record>;
|
5015
5106
|
/**
|
@@ -5116,15 +5207,215 @@ declare type ExtractTables<Schemas extends Record<string, BaseData>, Tables exte
|
|
5116
5207
|
table: infer Table;
|
5117
5208
|
} ? ReturnTable<Table, Tables> : never;
|
5118
5209
|
|
5210
|
+
/**
|
5211
|
+
* The description of a single aggregation operation. The key represents the
|
5212
|
+
*/
|
5213
|
+
declare type AggregationExpression<O extends XataRecord> = ExactlyOne<{
|
5214
|
+
count: CountAggregation<O>;
|
5215
|
+
sum: SumAggregation<O>;
|
5216
|
+
max: MaxAggregation<O>;
|
5217
|
+
min: MinAggregation<O>;
|
5218
|
+
average: AverageAggregation<O>;
|
5219
|
+
uniqueCount: UniqueCountAggregation<O>;
|
5220
|
+
dateHistogram: DateHistogramAggregation<O>;
|
5221
|
+
topValues: TopValuesAggregation<O>;
|
5222
|
+
numericHistogram: NumericHistogramAggregation<O>;
|
5223
|
+
}>;
|
5224
|
+
declare type AggregationResult<Record extends XataRecord, Expression extends Dictionary<AggregationExpression<Record>>> = {
|
5225
|
+
aggs: {
|
5226
|
+
[K in keyof Expression]: AggregationResultItem<Record, Expression[K]>;
|
5227
|
+
};
|
5228
|
+
};
|
5229
|
+
declare type AggregationExpressionType<T extends AggregationExpression<any>> = keyof T;
|
5230
|
+
declare type AggregationResultItem<Record extends XataRecord, Expression extends AggregationExpression<Record>> = AggregationExpressionType<Expression> extends infer Type ? Type extends keyof AggregationExpressionResultTypes ? AggregationExpressionResultTypes[Type] : never : never;
|
5231
|
+
/**
|
5232
|
+
* Count the number of records with an optional filter.
|
5233
|
+
*/
|
5234
|
+
declare type CountAggregation<O extends XataRecord> = {
|
5235
|
+
filter?: Filter<O>;
|
5236
|
+
} | '*';
|
5237
|
+
/**
|
5238
|
+
* The sum of the numeric values in a particular column.
|
5239
|
+
*/
|
5240
|
+
declare type SumAggregation<O extends XataRecord> = {
|
5241
|
+
/**
|
5242
|
+
* The column on which to compute the sum. Must be a numeric type.
|
5243
|
+
*/
|
5244
|
+
column: ColumnsByValue<O, number>;
|
5245
|
+
};
|
5246
|
+
/**
|
5247
|
+
* The max of the numeric values in a particular column.
|
5248
|
+
*/
|
5249
|
+
declare type MaxAggregation<O extends XataRecord> = {
|
5250
|
+
/**
|
5251
|
+
* The column on which to compute the max. Must be a numeric type.
|
5252
|
+
*/
|
5253
|
+
column: ColumnsByValue<O, number>;
|
5254
|
+
};
|
5255
|
+
/**
|
5256
|
+
* The min of the numeric values in a particular column.
|
5257
|
+
*/
|
5258
|
+
declare type MinAggregation<O extends XataRecord> = {
|
5259
|
+
/**
|
5260
|
+
* The column on which to compute the min. Must be a numeric type.
|
5261
|
+
*/
|
5262
|
+
column: ColumnsByValue<O, number>;
|
5263
|
+
};
|
5264
|
+
/**
|
5265
|
+
* The average of the numeric values in a particular column.
|
5266
|
+
*/
|
5267
|
+
declare type AverageAggregation<O extends XataRecord> = {
|
5268
|
+
/**
|
5269
|
+
* The column on which to compute the average. Must be a numeric type.
|
5270
|
+
*/
|
5271
|
+
column: ColumnsByValue<O, number>;
|
5272
|
+
};
|
5273
|
+
/**
|
5274
|
+
* Count the number of distinct values in a particular column.
|
5275
|
+
*/
|
5276
|
+
declare type UniqueCountAggregation<O extends XataRecord> = {
|
5277
|
+
/**
|
5278
|
+
* The column from where to count the unique values.
|
5279
|
+
*/
|
5280
|
+
column: ColumnsByValue<O, any>;
|
5281
|
+
/**
|
5282
|
+
* The threshold under which the unique count is exact. If the number of unique
|
5283
|
+
* values in the column is higher than this threshold, the results are approximative.
|
5284
|
+
* Maximum value is 40,000, default value is 3000.
|
5285
|
+
*/
|
5286
|
+
precisionThreshold?: number;
|
5287
|
+
};
|
5288
|
+
/**
|
5289
|
+
* Split data into buckets by a datetime column. Accepts sub-aggregations for each bucket.
|
5290
|
+
*/
|
5291
|
+
declare type DateHistogramAggregation<O extends XataRecord> = {
|
5292
|
+
/**
|
5293
|
+
* The column to use for bucketing. Must be of type datetime.
|
5294
|
+
*/
|
5295
|
+
column: ColumnsByValue<O, Date>;
|
5296
|
+
/**
|
5297
|
+
* The fixed interval to use when bucketing.
|
5298
|
+
* It is fromatted as number + units, for example: `5d`, `20m`, `10s`.
|
5299
|
+
*
|
5300
|
+
* @pattern ^(\d+)(d|h|m|s|ms)$
|
5301
|
+
*/
|
5302
|
+
interval?: string;
|
5303
|
+
/**
|
5304
|
+
* The calendar-aware interval to use when bucketing. Possible values are: `minute`,
|
5305
|
+
* `hour`, `day`, `week`, `month`, `quarter`, `year`.
|
5306
|
+
*/
|
5307
|
+
calendarInterval?: 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year';
|
5308
|
+
/**
|
5309
|
+
* The timezone to use for bucketing. By default, UTC is assumed.
|
5310
|
+
* The accepted format is as an ISO 8601 UTC offset. For example: `+01:00` or
|
5311
|
+
* `-08:00`.
|
5312
|
+
*
|
5313
|
+
* @pattern ^[+-][01]\d:[0-5]\d$
|
5314
|
+
*/
|
5315
|
+
timezone?: string;
|
5316
|
+
aggs?: Dictionary<AggregationExpression<O>>;
|
5317
|
+
};
|
5318
|
+
/**
|
5319
|
+
* Split data into buckets by the unique values in a column. Accepts sub-aggregations for each bucket.
|
5320
|
+
* The top values as ordered by the number of records (`$count``) are returned.
|
5321
|
+
*/
|
5322
|
+
declare type TopValuesAggregation<O extends XataRecord> = {
|
5323
|
+
/**
|
5324
|
+
* The column to use for bucketing. Accepted types are `string`, `email`, `int`, `float`, or `bool`.
|
5325
|
+
*/
|
5326
|
+
column: ColumnsByValue<O, string | number | boolean>;
|
5327
|
+
aggs?: Dictionary<AggregationExpression<O>>;
|
5328
|
+
/**
|
5329
|
+
* The maximum number of unique values to return.
|
5330
|
+
*
|
5331
|
+
* @default 10
|
5332
|
+
* @maximum 1000
|
5333
|
+
*/
|
5334
|
+
size?: number;
|
5335
|
+
};
|
5336
|
+
/**
|
5337
|
+
* Split data into buckets by dynamic numeric ranges. Accepts sub-aggregations for each bucket.
|
5338
|
+
*/
|
5339
|
+
declare type NumericHistogramAggregation<O extends XataRecord> = {
|
5340
|
+
/**
|
5341
|
+
* The column to use for bucketing. Must be of numeric type.
|
5342
|
+
*/
|
5343
|
+
column: ColumnsByValue<O, number>;
|
5344
|
+
/**
|
5345
|
+
* The numeric interval to use for bucketing. The resulting buckets will be ranges
|
5346
|
+
* with this value as size.
|
5347
|
+
*
|
5348
|
+
* @minimum 0
|
5349
|
+
*/
|
5350
|
+
interval: number;
|
5351
|
+
/**
|
5352
|
+
* By default the bucket keys start with 0 and then continue in `interval` steps. The bucket
|
5353
|
+
* boundaries can be shiftend by using the offset option. For example, if the `interval` is 100,
|
5354
|
+
* but you prefer the bucket boundaries to be `[50, 150), [150, 250), etc.`, you can set `offset`
|
5355
|
+
* to 50.
|
5356
|
+
*
|
5357
|
+
* @default 0
|
5358
|
+
*/
|
5359
|
+
offset?: number;
|
5360
|
+
aggs?: Dictionary<AggregationExpression<O>>;
|
5361
|
+
};
|
5362
|
+
declare type AggregationExpressionResultTypes = {
|
5363
|
+
count: number;
|
5364
|
+
sum: number | null;
|
5365
|
+
max: number | null;
|
5366
|
+
min: number | null;
|
5367
|
+
average: number | null;
|
5368
|
+
uniqueCount: number;
|
5369
|
+
dateHistogram: ComplexAggregationResult;
|
5370
|
+
topValues: ComplexAggregationResult;
|
5371
|
+
numericHistogram: ComplexAggregationResult;
|
5372
|
+
};
|
5373
|
+
declare type ComplexAggregationResult = {
|
5374
|
+
values: Array<{
|
5375
|
+
$key: string | number;
|
5376
|
+
$count: number;
|
5377
|
+
[key: string]: any;
|
5378
|
+
}>;
|
5379
|
+
};
|
5380
|
+
|
5119
5381
|
declare type SortDirection = 'asc' | 'desc';
|
5120
|
-
declare type SortFilterExtended<T extends XataRecord
|
5121
|
-
column:
|
5382
|
+
declare type SortFilterExtended<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = {
|
5383
|
+
column: Columns;
|
5122
5384
|
direction?: SortDirection;
|
5123
5385
|
};
|
5124
|
-
declare type SortFilter<T extends XataRecord
|
5125
|
-
declare type SortFilterBase<T extends XataRecord
|
5126
|
-
[Key in
|
5127
|
-
|
5386
|
+
declare type SortFilter<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = Columns | SortFilterExtended<T, Columns> | SortFilterBase<T, Columns>;
|
5387
|
+
declare type SortFilterBase<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = Values<{
|
5388
|
+
[Key in Columns]: {
|
5389
|
+
[K in Key]: SortDirection;
|
5390
|
+
};
|
5391
|
+
}>;
|
5392
|
+
|
5393
|
+
declare type SummarizeExpression<O extends XataRecord> = ExactlyOne<{
|
5394
|
+
count: ColumnsByValue<O, any> | '*';
|
5395
|
+
}>;
|
5396
|
+
declare type SummarizeParams<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>, Columns extends SelectableColumn<Record>[]> = {
|
5397
|
+
summaries?: Expression;
|
5398
|
+
summariesFilter?: SummarizeFilter<Record, Expression>;
|
5399
|
+
filter?: Filter<Record>;
|
5400
|
+
columns?: Columns;
|
5401
|
+
sort?: SummarizeSort<Record, Expression>;
|
5402
|
+
};
|
5403
|
+
declare type SummarizeResult<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>, Columns extends SelectableColumn<Record>[]> = {
|
5404
|
+
summaries: SummarizeResultItem<Record, Expression, Columns>[];
|
5405
|
+
};
|
5406
|
+
declare type SummarizeExpressionResultTypes<Value> = {
|
5407
|
+
count: number;
|
5408
|
+
min: Value;
|
5409
|
+
max: Value;
|
5410
|
+
sum: number;
|
5411
|
+
avg: number;
|
5412
|
+
};
|
5413
|
+
declare type SummarizeSort<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>> = SingleOrArray<SortFilter<Record, SelectableColumn<Record> | StringKeys<Expression>>>;
|
5414
|
+
declare type SummarizeValuePick<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>> = {
|
5415
|
+
[K in StringKeys<Expression>]: StringKeys<Expression[K]> extends infer SummarizeOperation ? SummarizeOperation extends keyof Expression[K] ? Expression[K][SummarizeOperation] extends infer Column ? Column extends SelectableColumn<Record> ? SummarizeOperation extends keyof SummarizeExpressionResultTypes<any> ? SummarizeExpressionResultTypes<ValueAtColumn<Record, Column>>[SummarizeOperation] : never : never : never : never : never;
|
5416
|
+
};
|
5417
|
+
declare type SummarizeFilter<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>> = Filter<Record> & Filter<SummarizeValuePick<Record, Expression>>;
|
5418
|
+
declare type SummarizeResultItem<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>, Columns extends SelectableColumn<Record>[]> = SummarizeValuePick<Record, Expression> & SelectedPick<Record, Columns>;
|
5128
5419
|
|
5129
5420
|
declare type BaseOptions<T extends XataRecord> = {
|
5130
5421
|
columns?: SelectableColumn<T>[];
|
@@ -5138,7 +5429,7 @@ declare type CursorQueryOptions = {
|
|
5138
5429
|
declare type OffsetQueryOptions<T extends XataRecord> = {
|
5139
5430
|
pagination?: OffsetNavigationOptions;
|
5140
5431
|
filter?: FilterExpression;
|
5141
|
-
sort?:
|
5432
|
+
sort?: SingleOrArray<SortFilter<T>>;
|
5142
5433
|
};
|
5143
5434
|
declare type QueryOptions<T extends XataRecord> = BaseOptions<T> & (CursorQueryOptions | OffsetQueryOptions<T>);
|
5144
5435
|
/**
|
@@ -5151,7 +5442,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
5151
5442
|
#private;
|
5152
5443
|
readonly meta: PaginationQueryMeta;
|
5153
5444
|
readonly records: RecordArray<Result>;
|
5154
|
-
constructor(repository:
|
5445
|
+
constructor(repository: RestRepository<Record> | null, table: {
|
5155
5446
|
name: string;
|
5156
5447
|
schema?: Table;
|
5157
5448
|
}, data: Partial<QueryOptions<Record>>, rawParent?: Partial<QueryOptions<Record>>);
|
@@ -5214,7 +5505,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
5214
5505
|
* @param direction The direction. Either ascending or descending.
|
5215
5506
|
* @returns A new Query object.
|
5216
5507
|
*/
|
5217
|
-
sort<F extends
|
5508
|
+
sort<F extends ColumnsByValue<Record, any>>(column: F, direction?: SortDirection): Query<Record, Result>;
|
5218
5509
|
/**
|
5219
5510
|
* Builds a new query specifying the set of columns to be returned in the query response.
|
5220
5511
|
* @param columns Array of column names to be returned by the query.
|
@@ -5350,6 +5641,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
5350
5641
|
* @throws if there are no results.
|
5351
5642
|
*/
|
5352
5643
|
getFirstOrThrow(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'>): Promise<Result>;
|
5644
|
+
summarize<Expression extends Dictionary<SummarizeExpression<Record>>, Columns extends SelectableColumn<Record>[]>(params?: SummarizeParams<Record, Expression, Columns>): Promise<SummarizeResult<Record, Expression, Columns>>;
|
5353
5645
|
/**
|
5354
5646
|
* Builds a new query object adding a cache TTL in milliseconds.
|
5355
5647
|
* @param ttl The cache TTL in milliseconds.
|
@@ -5909,6 +6201,13 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
5909
6201
|
filter?: Filter<Record>;
|
5910
6202
|
boosters?: Boosters<Record>[];
|
5911
6203
|
}): Promise<SearchXataRecord<SelectedPick<Record, ['*']>>[]>;
|
6204
|
+
/**
|
6205
|
+
* Aggregates records in the table.
|
6206
|
+
* @param expression The aggregations to perform.
|
6207
|
+
* @param filter The filter to apply to the queried records.
|
6208
|
+
* @returns The requested aggregations.
|
6209
|
+
*/
|
6210
|
+
abstract aggregate<Expression extends Dictionary<AggregationExpression<Record>>>(expression?: Expression, filter?: Filter<Record>): Promise<AggregationResult<Record, Expression>>;
|
5912
6211
|
abstract query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
|
5913
6212
|
}
|
5914
6213
|
declare class RestRepository<Record extends XataRecord> extends Query<Record, SelectedPick<Record, ['*']>> implements Repository<Record> {
|
@@ -5982,7 +6281,9 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
|
|
5982
6281
|
filter?: Filter<Record>;
|
5983
6282
|
boosters?: Boosters<Record>[];
|
5984
6283
|
}): Promise<any>;
|
6284
|
+
aggregate<Expression extends Dictionary<AggregationExpression<Record>>>(aggs?: Expression, filter?: Filter<Record>): Promise<any>;
|
5985
6285
|
query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
|
6286
|
+
summarizeTable<Result extends XataRecord>(query: Query<Record, Result>, summaries?: Dictionary<SummarizeExpression<Record>>, summariesFilter?: FilterExpression): Promise<SummarizeResponse>;
|
5986
6287
|
}
|
5987
6288
|
|
5988
6289
|
declare type BaseSchema = {
|
@@ -6096,11 +6397,11 @@ declare const le: <T extends ComparableType>(value: T) => ComparableTypeFilter<T
|
|
6096
6397
|
/**
|
6097
6398
|
* Operator to restrict results to only values that are not null.
|
6098
6399
|
*/
|
6099
|
-
declare const exists: <T>(column
|
6400
|
+
declare const exists: <T>(column?: ColumnsByValue<T, any> | undefined) => ExistanceFilter<T>;
|
6100
6401
|
/**
|
6101
6402
|
* Operator to restrict results to only values that are null.
|
6102
6403
|
*/
|
6103
|
-
declare const notExists: <T>(column
|
6404
|
+
declare const notExists: <T>(column?: ColumnsByValue<T, any> | undefined) => ExistanceFilter<T>;
|
6104
6405
|
/**
|
6105
6406
|
* Operator to restrict results to only values that start with the given prefix.
|
6106
6407
|
*/
|
@@ -6294,4 +6595,4 @@ declare class XataError extends Error {
|
|
6294
6595
|
constructor(message: string, status: number);
|
6295
6596
|
}
|
6296
6597
|
|
6297
|
-
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, AggregateTableError, AggregateTablePathParams, AggregateTableRequestBody, AggregateTableVariables, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditResponse, ApplyBranchSchemaEditVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CPCreateDatabaseError, CPCreateDatabasePathParams, CPCreateDatabaseRequestBody, CPCreateDatabaseResponse, CPCreateDatabaseVariables, CPDeleteDatabaseError, CPDeleteDatabasePathParams, CPDeleteDatabaseVariables, CPGetCPDatabaseMetadataError, CPGetCPDatabaseMetadataPathParams, CPGetCPDatabaseMetadataVariables, CPGetDatabaseListError, CPGetDatabaseListPathParams, CPGetDatabaseListVariables, CPUpdateCPDatabaseMetadataError, CPUpdateCPDatabaseMetadataPathParams, CPUpdateCPDatabaseMetadataRequestBody, CPUpdateCPDatabaseMetadataVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, CompareBranchSchemasError, CompareBranchSchemasPathParams, CompareBranchSchemasVariables, CompareBranchWithUserSchemaError, CompareBranchWithUserSchemaPathParams, CompareBranchWithUserSchemaRequestBody, CompareBranchWithUserSchemaVariables, CompareMigrationRequestError, CompareMigrationRequestPathParams, CompareMigrationRequestVariables, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchResponse, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateMigrationRequestError, CreateMigrationRequestPathParams, CreateMigrationRequestRequestBody, CreateMigrationRequestResponse, CreateMigrationRequestVariables, CreateTableError, CreateTablePathParams, CreateTableResponse, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchSchemaHistoryError, GetBranchSchemaHistoryPathParams, GetBranchSchemaHistoryRequestBody, GetBranchSchemaHistoryResponse, GetBranchSchemaHistoryVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetDatabaseMetadataError, GetDatabaseMetadataPathParams, GetDatabaseMetadataVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetMigrationRequestError, GetMigrationRequestIsMergedError, GetMigrationRequestIsMergedPathParams, GetMigrationRequestIsMergedResponse, GetMigrationRequestIsMergedVariables, GetMigrationRequestPathParams, GetMigrationRequestVariables, GetRecordError, GetRecordPathParams, GetRecordQueryParams, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, HostProvider, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, Link, ListMigrationRequestsCommitsError, ListMigrationRequestsCommitsPathParams, ListMigrationRequestsCommitsRequestBody, ListMigrationRequestsCommitsResponse, ListMigrationRequestsCommitsVariables, MergeMigrationRequestError, MergeMigrationRequestPathParams, MergeMigrationRequestVariables, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, PreviewBranchSchemaEditError, PreviewBranchSchemaEditPathParams, PreviewBranchSchemaEditRequestBody, PreviewBranchSchemaEditResponse, PreviewBranchSchemaEditVariables, Query, QueryMigrationRequestsError, QueryMigrationRequestsPathParams, QueryMigrationRequestsRequestBody, QueryMigrationRequestsResponse, QueryMigrationRequestsVariables, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RecordArray, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaInference, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SearchTableError, SearchTablePathParams, SearchTableRequestBody, SearchTableVariables, SearchXataRecord, SelectableColumn, SelectedPick, Serializer, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, SummarizeTableError, SummarizeTablePathParams, SummarizeTableRequestBody, SummarizeTableVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, UpdateBranchSchemaResponse, UpdateBranchSchemaVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateDatabaseMetadataError, UpdateDatabaseMetadataPathParams, UpdateDatabaseMetadataRequestBody, UpdateDatabaseMetadataVariables, UpdateMigrationRequestError, UpdateMigrationRequestPathParams, UpdateMigrationRequestRequestBody, UpdateMigrationRequestVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberInviteError, UpdateWorkspaceMemberInvitePathParams, UpdateWorkspaceMemberInviteRequestBody, UpdateWorkspaceMemberInviteVariables, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, buildClient, buildWorkerRunner, bulkInsertTableRecords, cPCreateDatabase, cPDeleteDatabase, cPGetCPDatabaseMetadata, cPGetDatabaseList, cPUpdateCPDatabaseMetadata, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, pattern, previewBranchSchemaEdit, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID };
|
6598
|
+
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, AggregateTableError, AggregateTablePathParams, AggregateTableRequestBody, AggregateTableVariables, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditResponse, ApplyBranchSchemaEditVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CPCreateDatabaseError, CPCreateDatabasePathParams, CPCreateDatabaseRequestBody, CPCreateDatabaseResponse, CPCreateDatabaseVariables, CPDeleteDatabaseError, CPDeleteDatabasePathParams, CPDeleteDatabaseVariables, CPGetCPDatabaseMetadataError, CPGetCPDatabaseMetadataPathParams, CPGetCPDatabaseMetadataVariables, CPGetDatabaseListError, CPGetDatabaseListPathParams, CPGetDatabaseListVariables, CPUpdateCPDatabaseMetadataError, CPUpdateCPDatabaseMetadataPathParams, CPUpdateCPDatabaseMetadataRequestBody, CPUpdateCPDatabaseMetadataVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, ColumnsByValue, CompareBranchSchemasError, CompareBranchSchemasPathParams, CompareBranchSchemasVariables, CompareBranchWithUserSchemaError, CompareBranchWithUserSchemaPathParams, CompareBranchWithUserSchemaRequestBody, CompareBranchWithUserSchemaVariables, CompareMigrationRequestError, CompareMigrationRequestPathParams, CompareMigrationRequestVariables, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchResponse, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateMigrationRequestError, CreateMigrationRequestPathParams, CreateMigrationRequestRequestBody, CreateMigrationRequestResponse, CreateMigrationRequestVariables, CreateTableError, CreateTablePathParams, CreateTableResponse, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchSchemaHistoryError, GetBranchSchemaHistoryPathParams, GetBranchSchemaHistoryRequestBody, GetBranchSchemaHistoryResponse, GetBranchSchemaHistoryVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetDatabaseMetadataError, GetDatabaseMetadataPathParams, GetDatabaseMetadataVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetMigrationRequestError, GetMigrationRequestIsMergedError, GetMigrationRequestIsMergedPathParams, GetMigrationRequestIsMergedResponse, GetMigrationRequestIsMergedVariables, GetMigrationRequestPathParams, GetMigrationRequestVariables, GetRecordError, GetRecordPathParams, GetRecordQueryParams, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, HostProvider, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, Link, ListMigrationRequestsCommitsError, ListMigrationRequestsCommitsPathParams, ListMigrationRequestsCommitsRequestBody, ListMigrationRequestsCommitsResponse, ListMigrationRequestsCommitsVariables, ListRegionsError, ListRegionsPathParams, ListRegionsVariables, MergeMigrationRequestError, MergeMigrationRequestPathParams, MergeMigrationRequestVariables, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, PreviewBranchSchemaEditError, PreviewBranchSchemaEditPathParams, PreviewBranchSchemaEditRequestBody, PreviewBranchSchemaEditResponse, PreviewBranchSchemaEditVariables, Query, QueryMigrationRequestsError, QueryMigrationRequestsPathParams, QueryMigrationRequestsRequestBody, QueryMigrationRequestsResponse, QueryMigrationRequestsVariables, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RecordArray, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaInference, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SearchTableError, SearchTablePathParams, SearchTableRequestBody, SearchTableVariables, SearchXataRecord, SelectableColumn, SelectedPick, Serializer, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, SummarizeTableError, SummarizeTablePathParams, SummarizeTableRequestBody, SummarizeTableVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, UpdateBranchSchemaResponse, UpdateBranchSchemaVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateDatabaseMetadataError, UpdateDatabaseMetadataPathParams, UpdateDatabaseMetadataRequestBody, UpdateDatabaseMetadataVariables, UpdateMigrationRequestError, UpdateMigrationRequestPathParams, UpdateMigrationRequestRequestBody, UpdateMigrationRequestVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberInviteError, UpdateWorkspaceMemberInvitePathParams, UpdateWorkspaceMemberInviteRequestBody, UpdateWorkspaceMemberInviteVariables, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, buildClient, buildWorkerRunner, bulkInsertTableRecords, cPCreateDatabase, cPDeleteDatabase, cPGetCPDatabaseMetadata, cPGetDatabaseList, cPUpdateCPDatabaseMetadata, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, 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 };
|