@xata.io/client 0.0.0-alpha.ve91fd39 → 0.0.0-alpha.ve95339c
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/.turbo/turbo-add-version.log +1 -1
- package/.turbo/turbo-build.log +4 -4
- package/CHANGELOG.md +158 -2
- package/dist/index.cjs +1039 -104
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +1867 -417
- package/dist/index.mjs +1011 -105
- package/dist/index.mjs.map +1 -1
- package/package.json +6 -3
- package/.eslintrc.cjs +0 -13
- package/rollup.config.mjs +0 -44
- package/tsconfig.json +0 -23
package/dist/index.d.ts
CHANGED
|
@@ -37,7 +37,7 @@ type TraceFunction = <T>(name: string, fn: (options: {
|
|
|
37
37
|
}) => T, options?: AttributeDictionary) => Promise<T>;
|
|
38
38
|
|
|
39
39
|
type RequestInit = {
|
|
40
|
-
body?:
|
|
40
|
+
body?: any;
|
|
41
41
|
headers?: Record<string, string>;
|
|
42
42
|
method?: string;
|
|
43
43
|
signal?: any;
|
|
@@ -47,6 +47,8 @@ type Response = {
|
|
|
47
47
|
status: number;
|
|
48
48
|
url: string;
|
|
49
49
|
json(): Promise<any>;
|
|
50
|
+
text(): Promise<string>;
|
|
51
|
+
blob(): Promise<Blob>;
|
|
50
52
|
headers?: {
|
|
51
53
|
get(name: string): string | null;
|
|
52
54
|
};
|
|
@@ -81,6 +83,8 @@ type FetcherExtraProps = {
|
|
|
81
83
|
clientName?: string;
|
|
82
84
|
xataAgentExtra?: Record<string, string>;
|
|
83
85
|
fetchOptions?: Record<string, unknown>;
|
|
86
|
+
rawResponse?: boolean;
|
|
87
|
+
headers?: Record<string, unknown>;
|
|
84
88
|
};
|
|
85
89
|
|
|
86
90
|
type ControlPlaneFetcherExtraProps = {
|
|
@@ -105,6 +109,26 @@ type ErrorWrapper$1<TError> = TError | {
|
|
|
105
109
|
*
|
|
106
110
|
* @version 1.0
|
|
107
111
|
*/
|
|
112
|
+
type OAuthResponseType = 'code';
|
|
113
|
+
type OAuthScope = 'admin:all';
|
|
114
|
+
type AuthorizationCodeResponse = {
|
|
115
|
+
state?: string;
|
|
116
|
+
redirectUri?: string;
|
|
117
|
+
scopes?: OAuthScope[];
|
|
118
|
+
clientId?: string;
|
|
119
|
+
/**
|
|
120
|
+
* @format date-time
|
|
121
|
+
*/
|
|
122
|
+
expires?: string;
|
|
123
|
+
code?: string;
|
|
124
|
+
};
|
|
125
|
+
type AuthorizationCodeRequest = {
|
|
126
|
+
state?: string;
|
|
127
|
+
redirectUri?: string;
|
|
128
|
+
scopes?: OAuthScope[];
|
|
129
|
+
clientId: string;
|
|
130
|
+
responseType: OAuthResponseType;
|
|
131
|
+
};
|
|
108
132
|
type User = {
|
|
109
133
|
/**
|
|
110
134
|
* @format email
|
|
@@ -129,6 +153,31 @@ type DateTime$1 = string;
|
|
|
129
153
|
* @pattern [a-zA-Z0-9_\-~]*
|
|
130
154
|
*/
|
|
131
155
|
type APIKeyName = string;
|
|
156
|
+
type OAuthClientPublicDetails = {
|
|
157
|
+
name?: string;
|
|
158
|
+
description?: string;
|
|
159
|
+
icon?: string;
|
|
160
|
+
clientId: string;
|
|
161
|
+
};
|
|
162
|
+
type OAuthClientID = string;
|
|
163
|
+
type OAuthAccessToken = {
|
|
164
|
+
token: string;
|
|
165
|
+
scopes: string[];
|
|
166
|
+
/**
|
|
167
|
+
* @format date-time
|
|
168
|
+
*/
|
|
169
|
+
createdAt: string;
|
|
170
|
+
/**
|
|
171
|
+
* @format date-time
|
|
172
|
+
*/
|
|
173
|
+
updatedAt: string;
|
|
174
|
+
/**
|
|
175
|
+
* @format date-time
|
|
176
|
+
*/
|
|
177
|
+
expiresAt: string;
|
|
178
|
+
clientId: string;
|
|
179
|
+
};
|
|
180
|
+
type AccessToken = string;
|
|
132
181
|
/**
|
|
133
182
|
* @pattern ^([a-zA-Z0-9][a-zA-Z0-9_\-~]+-)?[a-zA-Z0-9]{6}
|
|
134
183
|
* @x-go-type auth.WorkspaceID
|
|
@@ -180,6 +229,117 @@ type WorkspaceMembers = {
|
|
|
180
229
|
* @pattern ^ik_[a-zA-Z0-9]+
|
|
181
230
|
*/
|
|
182
231
|
type InviteKey = string;
|
|
232
|
+
/**
|
|
233
|
+
* @x-internal true
|
|
234
|
+
* @pattern [a-zA-Z0-9_-~:]+
|
|
235
|
+
*/
|
|
236
|
+
type ClusterID = string;
|
|
237
|
+
/**
|
|
238
|
+
* @x-internal true
|
|
239
|
+
*/
|
|
240
|
+
type ClusterShortMetadata = {
|
|
241
|
+
id: ClusterID;
|
|
242
|
+
state: string;
|
|
243
|
+
region: string;
|
|
244
|
+
name: string;
|
|
245
|
+
/**
|
|
246
|
+
* @format int64
|
|
247
|
+
*/
|
|
248
|
+
branches: number;
|
|
249
|
+
};
|
|
250
|
+
/**
|
|
251
|
+
* @x-internal true
|
|
252
|
+
*/
|
|
253
|
+
type ListClustersResponse = {
|
|
254
|
+
clusters: ClusterShortMetadata[];
|
|
255
|
+
};
|
|
256
|
+
/**
|
|
257
|
+
* @x-internal true
|
|
258
|
+
*/
|
|
259
|
+
type AutoscalingConfig = {
|
|
260
|
+
enabled: boolean;
|
|
261
|
+
/**
|
|
262
|
+
* @format int64
|
|
263
|
+
*/
|
|
264
|
+
minCapacity: number;
|
|
265
|
+
/**
|
|
266
|
+
* @format int64
|
|
267
|
+
*/
|
|
268
|
+
maxCapacity: number;
|
|
269
|
+
};
|
|
270
|
+
/**
|
|
271
|
+
* @x-internal true
|
|
272
|
+
*/
|
|
273
|
+
type MaintenanceConfig = {
|
|
274
|
+
autoMinorVersionUpgrade?: boolean;
|
|
275
|
+
maintenanceWindow?: string;
|
|
276
|
+
plannedChangesWindow?: string;
|
|
277
|
+
};
|
|
278
|
+
/**
|
|
279
|
+
* @x-internal true
|
|
280
|
+
*/
|
|
281
|
+
type ClusterConfiguration = {
|
|
282
|
+
instanceType: string;
|
|
283
|
+
/**
|
|
284
|
+
* @format int64
|
|
285
|
+
*/
|
|
286
|
+
replicas?: number;
|
|
287
|
+
deletionProtection?: boolean;
|
|
288
|
+
autoscaling?: AutoscalingConfig;
|
|
289
|
+
maintenance?: MaintenanceConfig;
|
|
290
|
+
};
|
|
291
|
+
/**
|
|
292
|
+
* @x-internal true
|
|
293
|
+
*/
|
|
294
|
+
type ClusterCreateDetails = {
|
|
295
|
+
/**
|
|
296
|
+
* @minLength 1
|
|
297
|
+
*/
|
|
298
|
+
region: string;
|
|
299
|
+
/**
|
|
300
|
+
* @maxLength 63
|
|
301
|
+
* @minLength 1
|
|
302
|
+
* @pattern [a-zA-Z0-9_-~:]+
|
|
303
|
+
*/
|
|
304
|
+
name: string;
|
|
305
|
+
configuration: ClusterConfiguration;
|
|
306
|
+
};
|
|
307
|
+
/**
|
|
308
|
+
* @x-internal true
|
|
309
|
+
*/
|
|
310
|
+
type ClusterResponse = {
|
|
311
|
+
state: string;
|
|
312
|
+
clusterID: string;
|
|
313
|
+
};
|
|
314
|
+
/**
|
|
315
|
+
* @x-internal true
|
|
316
|
+
*/
|
|
317
|
+
type ClusterMetadata = {
|
|
318
|
+
id: ClusterID;
|
|
319
|
+
state: string;
|
|
320
|
+
region: string;
|
|
321
|
+
name: string;
|
|
322
|
+
/**
|
|
323
|
+
* @format int64
|
|
324
|
+
*/
|
|
325
|
+
branches: number;
|
|
326
|
+
configuration?: ClusterConfiguration;
|
|
327
|
+
};
|
|
328
|
+
/**
|
|
329
|
+
* @x-internal true
|
|
330
|
+
*/
|
|
331
|
+
type ClusterUpdateDetails = {
|
|
332
|
+
id: ClusterID;
|
|
333
|
+
/**
|
|
334
|
+
* @maxLength 63
|
|
335
|
+
* @minLength 1
|
|
336
|
+
* @pattern [a-zA-Z0-9_-~:]+
|
|
337
|
+
*/
|
|
338
|
+
name?: string;
|
|
339
|
+
configuration?: ClusterConfiguration;
|
|
340
|
+
state?: string;
|
|
341
|
+
region?: string;
|
|
342
|
+
};
|
|
183
343
|
/**
|
|
184
344
|
* Metadata of databases
|
|
185
345
|
*/
|
|
@@ -260,6 +420,7 @@ type DatabaseGithubSettings = {
|
|
|
260
420
|
};
|
|
261
421
|
type Region = {
|
|
262
422
|
id: string;
|
|
423
|
+
name: string;
|
|
263
424
|
};
|
|
264
425
|
type ListRegionsResponse = {
|
|
265
426
|
/**
|
|
@@ -295,6 +456,53 @@ type SimpleError$1 = {
|
|
|
295
456
|
* @version 1.0
|
|
296
457
|
*/
|
|
297
458
|
|
|
459
|
+
type GetAuthorizationCodeQueryParams = {
|
|
460
|
+
clientID: string;
|
|
461
|
+
responseType: OAuthResponseType;
|
|
462
|
+
redirectUri?: string;
|
|
463
|
+
scopes?: OAuthScope[];
|
|
464
|
+
state?: string;
|
|
465
|
+
};
|
|
466
|
+
type GetAuthorizationCodeError = ErrorWrapper$1<{
|
|
467
|
+
status: 400;
|
|
468
|
+
payload: BadRequestError$1;
|
|
469
|
+
} | {
|
|
470
|
+
status: 401;
|
|
471
|
+
payload: AuthError$1;
|
|
472
|
+
} | {
|
|
473
|
+
status: 404;
|
|
474
|
+
payload: SimpleError$1;
|
|
475
|
+
} | {
|
|
476
|
+
status: 409;
|
|
477
|
+
payload: SimpleError$1;
|
|
478
|
+
}>;
|
|
479
|
+
type GetAuthorizationCodeVariables = {
|
|
480
|
+
queryParams: GetAuthorizationCodeQueryParams;
|
|
481
|
+
} & ControlPlaneFetcherExtraProps;
|
|
482
|
+
/**
|
|
483
|
+
* Creates, stores and returns an authorization code to be used by a third party app. Supporting use of GET is required by OAuth2 spec
|
|
484
|
+
*/
|
|
485
|
+
declare const getAuthorizationCode: (variables: GetAuthorizationCodeVariables, signal?: AbortSignal) => Promise<AuthorizationCodeResponse>;
|
|
486
|
+
type GrantAuthorizationCodeError = ErrorWrapper$1<{
|
|
487
|
+
status: 400;
|
|
488
|
+
payload: BadRequestError$1;
|
|
489
|
+
} | {
|
|
490
|
+
status: 401;
|
|
491
|
+
payload: AuthError$1;
|
|
492
|
+
} | {
|
|
493
|
+
status: 404;
|
|
494
|
+
payload: SimpleError$1;
|
|
495
|
+
} | {
|
|
496
|
+
status: 409;
|
|
497
|
+
payload: SimpleError$1;
|
|
498
|
+
}>;
|
|
499
|
+
type GrantAuthorizationCodeVariables = {
|
|
500
|
+
body: AuthorizationCodeRequest;
|
|
501
|
+
} & ControlPlaneFetcherExtraProps;
|
|
502
|
+
/**
|
|
503
|
+
* Creates, stores and returns an authorization code to be used by a third party app
|
|
504
|
+
*/
|
|
505
|
+
declare const grantAuthorizationCode: (variables: GrantAuthorizationCodeVariables, signal?: AbortSignal) => Promise<AuthorizationCodeResponse>;
|
|
298
506
|
type GetUserError = ErrorWrapper$1<{
|
|
299
507
|
status: 400;
|
|
300
508
|
payload: BadRequestError$1;
|
|
@@ -414,6 +622,115 @@ type DeleteUserAPIKeyVariables = {
|
|
|
414
622
|
* Delete an existing API key
|
|
415
623
|
*/
|
|
416
624
|
declare const deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal) => Promise<undefined>;
|
|
625
|
+
type GetUserOAuthClientsError = ErrorWrapper$1<{
|
|
626
|
+
status: 400;
|
|
627
|
+
payload: BadRequestError$1;
|
|
628
|
+
} | {
|
|
629
|
+
status: 401;
|
|
630
|
+
payload: AuthError$1;
|
|
631
|
+
} | {
|
|
632
|
+
status: 404;
|
|
633
|
+
payload: SimpleError$1;
|
|
634
|
+
}>;
|
|
635
|
+
type GetUserOAuthClientsResponse = {
|
|
636
|
+
clients?: OAuthClientPublicDetails[];
|
|
637
|
+
};
|
|
638
|
+
type GetUserOAuthClientsVariables = ControlPlaneFetcherExtraProps;
|
|
639
|
+
/**
|
|
640
|
+
* Retrieve the list of OAuth Clients that a user has authorized
|
|
641
|
+
*/
|
|
642
|
+
declare const getUserOAuthClients: (variables: GetUserOAuthClientsVariables, signal?: AbortSignal) => Promise<GetUserOAuthClientsResponse>;
|
|
643
|
+
type DeleteUserOAuthClientPathParams = {
|
|
644
|
+
clientId: OAuthClientID;
|
|
645
|
+
};
|
|
646
|
+
type DeleteUserOAuthClientError = ErrorWrapper$1<{
|
|
647
|
+
status: 400;
|
|
648
|
+
payload: BadRequestError$1;
|
|
649
|
+
} | {
|
|
650
|
+
status: 401;
|
|
651
|
+
payload: AuthError$1;
|
|
652
|
+
} | {
|
|
653
|
+
status: 404;
|
|
654
|
+
payload: SimpleError$1;
|
|
655
|
+
}>;
|
|
656
|
+
type DeleteUserOAuthClientVariables = {
|
|
657
|
+
pathParams: DeleteUserOAuthClientPathParams;
|
|
658
|
+
} & ControlPlaneFetcherExtraProps;
|
|
659
|
+
/**
|
|
660
|
+
* Delete the oauth client for the user and revoke all access
|
|
661
|
+
*/
|
|
662
|
+
declare const deleteUserOAuthClient: (variables: DeleteUserOAuthClientVariables, signal?: AbortSignal) => Promise<undefined>;
|
|
663
|
+
type GetUserOAuthAccessTokensError = ErrorWrapper$1<{
|
|
664
|
+
status: 400;
|
|
665
|
+
payload: BadRequestError$1;
|
|
666
|
+
} | {
|
|
667
|
+
status: 401;
|
|
668
|
+
payload: AuthError$1;
|
|
669
|
+
} | {
|
|
670
|
+
status: 404;
|
|
671
|
+
payload: SimpleError$1;
|
|
672
|
+
}>;
|
|
673
|
+
type GetUserOAuthAccessTokensResponse = {
|
|
674
|
+
accessTokens: OAuthAccessToken[];
|
|
675
|
+
};
|
|
676
|
+
type GetUserOAuthAccessTokensVariables = ControlPlaneFetcherExtraProps;
|
|
677
|
+
/**
|
|
678
|
+
* Retrieve the list of valid OAuth Access Tokens on the current user's account
|
|
679
|
+
*/
|
|
680
|
+
declare const getUserOAuthAccessTokens: (variables: GetUserOAuthAccessTokensVariables, signal?: AbortSignal) => Promise<GetUserOAuthAccessTokensResponse>;
|
|
681
|
+
type DeleteOAuthAccessTokenPathParams = {
|
|
682
|
+
token: AccessToken;
|
|
683
|
+
};
|
|
684
|
+
type DeleteOAuthAccessTokenError = ErrorWrapper$1<{
|
|
685
|
+
status: 400;
|
|
686
|
+
payload: BadRequestError$1;
|
|
687
|
+
} | {
|
|
688
|
+
status: 401;
|
|
689
|
+
payload: AuthError$1;
|
|
690
|
+
} | {
|
|
691
|
+
status: 404;
|
|
692
|
+
payload: SimpleError$1;
|
|
693
|
+
} | {
|
|
694
|
+
status: 409;
|
|
695
|
+
payload: SimpleError$1;
|
|
696
|
+
}>;
|
|
697
|
+
type DeleteOAuthAccessTokenVariables = {
|
|
698
|
+
pathParams: DeleteOAuthAccessTokenPathParams;
|
|
699
|
+
} & ControlPlaneFetcherExtraProps;
|
|
700
|
+
/**
|
|
701
|
+
* Expires the access token for a third party app
|
|
702
|
+
*/
|
|
703
|
+
declare const deleteOAuthAccessToken: (variables: DeleteOAuthAccessTokenVariables, signal?: AbortSignal) => Promise<undefined>;
|
|
704
|
+
type UpdateOAuthAccessTokenPathParams = {
|
|
705
|
+
token: AccessToken;
|
|
706
|
+
};
|
|
707
|
+
type UpdateOAuthAccessTokenError = ErrorWrapper$1<{
|
|
708
|
+
status: 400;
|
|
709
|
+
payload: BadRequestError$1;
|
|
710
|
+
} | {
|
|
711
|
+
status: 401;
|
|
712
|
+
payload: AuthError$1;
|
|
713
|
+
} | {
|
|
714
|
+
status: 404;
|
|
715
|
+
payload: SimpleError$1;
|
|
716
|
+
} | {
|
|
717
|
+
status: 409;
|
|
718
|
+
payload: SimpleError$1;
|
|
719
|
+
}>;
|
|
720
|
+
type UpdateOAuthAccessTokenRequestBody = {
|
|
721
|
+
/**
|
|
722
|
+
* expiration time of the token as a unix timestamp
|
|
723
|
+
*/
|
|
724
|
+
expires: number;
|
|
725
|
+
};
|
|
726
|
+
type UpdateOAuthAccessTokenVariables = {
|
|
727
|
+
body: UpdateOAuthAccessTokenRequestBody;
|
|
728
|
+
pathParams: UpdateOAuthAccessTokenPathParams;
|
|
729
|
+
} & ControlPlaneFetcherExtraProps;
|
|
730
|
+
/**
|
|
731
|
+
* Updates partially the access token for a third party app
|
|
732
|
+
*/
|
|
733
|
+
declare const updateOAuthAccessToken: (variables: UpdateOAuthAccessTokenVariables, signal?: AbortSignal) => Promise<OAuthAccessToken>;
|
|
417
734
|
type GetWorkspacesListError = ErrorWrapper$1<{
|
|
418
735
|
status: 400;
|
|
419
736
|
payload: BadRequestError$1;
|
|
@@ -787,6 +1104,99 @@ type ResendWorkspaceMemberInviteVariables = {
|
|
|
787
1104
|
* This operation provides a way to resend an Invite notification. Invite notifications can only be sent for Invites not yet accepted.
|
|
788
1105
|
*/
|
|
789
1106
|
declare const resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
|
1107
|
+
type ListClustersPathParams = {
|
|
1108
|
+
/**
|
|
1109
|
+
* Workspace ID
|
|
1110
|
+
*/
|
|
1111
|
+
workspaceId: WorkspaceID;
|
|
1112
|
+
};
|
|
1113
|
+
type ListClustersError = ErrorWrapper$1<{
|
|
1114
|
+
status: 400;
|
|
1115
|
+
payload: BadRequestError$1;
|
|
1116
|
+
} | {
|
|
1117
|
+
status: 401;
|
|
1118
|
+
payload: AuthError$1;
|
|
1119
|
+
}>;
|
|
1120
|
+
type ListClustersVariables = {
|
|
1121
|
+
pathParams: ListClustersPathParams;
|
|
1122
|
+
} & ControlPlaneFetcherExtraProps;
|
|
1123
|
+
/**
|
|
1124
|
+
* List all clusters available in your Workspace.
|
|
1125
|
+
*/
|
|
1126
|
+
declare const listClusters: (variables: ListClustersVariables, signal?: AbortSignal) => Promise<ListClustersResponse>;
|
|
1127
|
+
type CreateClusterPathParams = {
|
|
1128
|
+
/**
|
|
1129
|
+
* Workspace ID
|
|
1130
|
+
*/
|
|
1131
|
+
workspaceId: WorkspaceID;
|
|
1132
|
+
};
|
|
1133
|
+
type CreateClusterError = ErrorWrapper$1<{
|
|
1134
|
+
status: 400;
|
|
1135
|
+
payload: BadRequestError$1;
|
|
1136
|
+
} | {
|
|
1137
|
+
status: 401;
|
|
1138
|
+
payload: AuthError$1;
|
|
1139
|
+
} | {
|
|
1140
|
+
status: 422;
|
|
1141
|
+
payload: SimpleError$1;
|
|
1142
|
+
} | {
|
|
1143
|
+
status: 423;
|
|
1144
|
+
payload: SimpleError$1;
|
|
1145
|
+
}>;
|
|
1146
|
+
type CreateClusterVariables = {
|
|
1147
|
+
body: ClusterCreateDetails;
|
|
1148
|
+
pathParams: CreateClusterPathParams;
|
|
1149
|
+
} & ControlPlaneFetcherExtraProps;
|
|
1150
|
+
declare const createCluster: (variables: CreateClusterVariables, signal?: AbortSignal) => Promise<ClusterResponse>;
|
|
1151
|
+
type GetClusterPathParams = {
|
|
1152
|
+
/**
|
|
1153
|
+
* Workspace ID
|
|
1154
|
+
*/
|
|
1155
|
+
workspaceId: WorkspaceID;
|
|
1156
|
+
/**
|
|
1157
|
+
* Cluster ID
|
|
1158
|
+
*/
|
|
1159
|
+
clusterId: ClusterID;
|
|
1160
|
+
};
|
|
1161
|
+
type GetClusterError = ErrorWrapper$1<{
|
|
1162
|
+
status: 400;
|
|
1163
|
+
payload: BadRequestError$1;
|
|
1164
|
+
} | {
|
|
1165
|
+
status: 401;
|
|
1166
|
+
payload: AuthError$1;
|
|
1167
|
+
}>;
|
|
1168
|
+
type GetClusterVariables = {
|
|
1169
|
+
pathParams: GetClusterPathParams;
|
|
1170
|
+
} & ControlPlaneFetcherExtraProps;
|
|
1171
|
+
/**
|
|
1172
|
+
* Retrieve metadata for given cluster ID
|
|
1173
|
+
*/
|
|
1174
|
+
declare const getCluster: (variables: GetClusterVariables, signal?: AbortSignal) => Promise<ClusterMetadata>;
|
|
1175
|
+
type UpdateClusterPathParams = {
|
|
1176
|
+
/**
|
|
1177
|
+
* Workspace ID
|
|
1178
|
+
*/
|
|
1179
|
+
workspaceId: WorkspaceID;
|
|
1180
|
+
/**
|
|
1181
|
+
* Cluster ID
|
|
1182
|
+
*/
|
|
1183
|
+
clusterId: ClusterID;
|
|
1184
|
+
};
|
|
1185
|
+
type UpdateClusterError = ErrorWrapper$1<{
|
|
1186
|
+
status: 400;
|
|
1187
|
+
payload: BadRequestError$1;
|
|
1188
|
+
} | {
|
|
1189
|
+
status: 401;
|
|
1190
|
+
payload: AuthError$1;
|
|
1191
|
+
}>;
|
|
1192
|
+
type UpdateClusterVariables = {
|
|
1193
|
+
body: ClusterUpdateDetails;
|
|
1194
|
+
pathParams: UpdateClusterPathParams;
|
|
1195
|
+
} & ControlPlaneFetcherExtraProps;
|
|
1196
|
+
/**
|
|
1197
|
+
* Update cluster for given cluster ID
|
|
1198
|
+
*/
|
|
1199
|
+
declare const updateCluster: (variables: UpdateClusterVariables, signal?: AbortSignal) => Promise<ClusterMetadata>;
|
|
790
1200
|
type GetDatabaseListPathParams = {
|
|
791
1201
|
/**
|
|
792
1202
|
* Workspace ID
|
|
@@ -953,6 +1363,43 @@ type UpdateDatabaseMetadataVariables = {
|
|
|
953
1363
|
* Update the color of the selected database
|
|
954
1364
|
*/
|
|
955
1365
|
declare const updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
|
1366
|
+
type RenameDatabasePathParams = {
|
|
1367
|
+
/**
|
|
1368
|
+
* Workspace ID
|
|
1369
|
+
*/
|
|
1370
|
+
workspaceId: WorkspaceID;
|
|
1371
|
+
/**
|
|
1372
|
+
* The Database Name
|
|
1373
|
+
*/
|
|
1374
|
+
dbName: DBName$1;
|
|
1375
|
+
};
|
|
1376
|
+
type RenameDatabaseError = ErrorWrapper$1<{
|
|
1377
|
+
status: 400;
|
|
1378
|
+
payload: BadRequestError$1;
|
|
1379
|
+
} | {
|
|
1380
|
+
status: 401;
|
|
1381
|
+
payload: AuthError$1;
|
|
1382
|
+
} | {
|
|
1383
|
+
status: 422;
|
|
1384
|
+
payload: SimpleError$1;
|
|
1385
|
+
} | {
|
|
1386
|
+
status: 423;
|
|
1387
|
+
payload: SimpleError$1;
|
|
1388
|
+
}>;
|
|
1389
|
+
type RenameDatabaseRequestBody = {
|
|
1390
|
+
/**
|
|
1391
|
+
* @minLength 1
|
|
1392
|
+
*/
|
|
1393
|
+
newName: string;
|
|
1394
|
+
};
|
|
1395
|
+
type RenameDatabaseVariables = {
|
|
1396
|
+
body: RenameDatabaseRequestBody;
|
|
1397
|
+
pathParams: RenameDatabasePathParams;
|
|
1398
|
+
} & ControlPlaneFetcherExtraProps;
|
|
1399
|
+
/**
|
|
1400
|
+
* Change the name of an existing database
|
|
1401
|
+
*/
|
|
1402
|
+
declare const renameDatabase: (variables: RenameDatabaseVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
|
956
1403
|
type GetDatabaseGithubSettingsPathParams = {
|
|
957
1404
|
/**
|
|
958
1405
|
* Workspace ID
|
|
@@ -1134,19 +1581,24 @@ type ColumnVector = {
|
|
|
1134
1581
|
*/
|
|
1135
1582
|
dimension: number;
|
|
1136
1583
|
};
|
|
1584
|
+
type ColumnFile = {
|
|
1585
|
+
defaultPublicAccess?: boolean;
|
|
1586
|
+
};
|
|
1137
1587
|
type Column = {
|
|
1138
1588
|
name: string;
|
|
1139
|
-
type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object' | 'datetime' | 'vector' | 'file[]' | 'file' | '
|
|
1589
|
+
type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object' | 'datetime' | 'vector' | 'file[]' | 'file' | 'json';
|
|
1140
1590
|
link?: ColumnLink;
|
|
1141
1591
|
vector?: ColumnVector;
|
|
1592
|
+
file?: ColumnFile;
|
|
1593
|
+
['file[]']?: ColumnFile;
|
|
1142
1594
|
notNull?: boolean;
|
|
1143
1595
|
defaultValue?: string;
|
|
1144
1596
|
unique?: boolean;
|
|
1145
1597
|
columns?: Column[];
|
|
1146
1598
|
};
|
|
1147
1599
|
type RevLink = {
|
|
1148
|
-
linkID: string;
|
|
1149
1600
|
table: string;
|
|
1601
|
+
column: string;
|
|
1150
1602
|
};
|
|
1151
1603
|
type Table = {
|
|
1152
1604
|
id?: string;
|
|
@@ -1268,9 +1720,11 @@ type FilterPredicateOp = {
|
|
|
1268
1720
|
$gt?: FilterRangeValue;
|
|
1269
1721
|
$ge?: FilterRangeValue;
|
|
1270
1722
|
$contains?: string;
|
|
1723
|
+
$iContains?: string;
|
|
1271
1724
|
$startsWith?: string;
|
|
1272
1725
|
$endsWith?: string;
|
|
1273
1726
|
$pattern?: string;
|
|
1727
|
+
$iPattern?: string;
|
|
1274
1728
|
};
|
|
1275
1729
|
/**
|
|
1276
1730
|
* @maxProperties 2
|
|
@@ -1293,7 +1747,7 @@ type FilterColumnIncludes = {
|
|
|
1293
1747
|
$includesNone?: FilterPredicate;
|
|
1294
1748
|
};
|
|
1295
1749
|
type FilterColumn = FilterColumnIncludes | FilterPredicate | FilterList;
|
|
1296
|
-
type SortOrder = 'asc' | 'desc';
|
|
1750
|
+
type SortOrder = 'asc' | 'desc' | 'random';
|
|
1297
1751
|
type SortExpression = string[] | {
|
|
1298
1752
|
[key: string]: SortOrder;
|
|
1299
1753
|
} | {
|
|
@@ -1391,9 +1845,13 @@ type RecordsMetadata = {
|
|
|
1391
1845
|
*/
|
|
1392
1846
|
cursor: string;
|
|
1393
1847
|
/**
|
|
1394
|
-
* true if more records can be
|
|
1848
|
+
* true if more records can be fetched
|
|
1395
1849
|
*/
|
|
1396
1850
|
more: boolean;
|
|
1851
|
+
/**
|
|
1852
|
+
* the number of records returned per page
|
|
1853
|
+
*/
|
|
1854
|
+
size: number;
|
|
1397
1855
|
};
|
|
1398
1856
|
};
|
|
1399
1857
|
type TableOpAdd = {
|
|
@@ -1442,7 +1900,7 @@ type Commit = {
|
|
|
1442
1900
|
message?: string;
|
|
1443
1901
|
id: string;
|
|
1444
1902
|
parentID?: string;
|
|
1445
|
-
checksum
|
|
1903
|
+
checksum: string;
|
|
1446
1904
|
mergeParentID?: string;
|
|
1447
1905
|
createdAt: DateTime;
|
|
1448
1906
|
operations: MigrationOp[];
|
|
@@ -1474,7 +1932,7 @@ type MigrationObject = {
|
|
|
1474
1932
|
message?: string;
|
|
1475
1933
|
id: string;
|
|
1476
1934
|
parentID?: string;
|
|
1477
|
-
checksum
|
|
1935
|
+
checksum: string;
|
|
1478
1936
|
operations: MigrationOp[];
|
|
1479
1937
|
};
|
|
1480
1938
|
/**
|
|
@@ -1550,9 +2008,27 @@ type TransactionUpdateOp = {
|
|
|
1550
2008
|
columns?: string[];
|
|
1551
2009
|
};
|
|
1552
2010
|
/**
|
|
1553
|
-
* A delete operation. The transaction will continue if no record matches the ID.
|
|
2011
|
+
* A delete operation. The transaction will continue if no record matches the ID by default. To override this behaviour, set failIfMissing to true.
|
|
1554
2012
|
*/
|
|
1555
2013
|
type TransactionDeleteOp = {
|
|
2014
|
+
/**
|
|
2015
|
+
* The table name
|
|
2016
|
+
*/
|
|
2017
|
+
table: string;
|
|
2018
|
+
id: RecordID;
|
|
2019
|
+
/**
|
|
2020
|
+
* If true, the transaction will fail when the record doesn't exist.
|
|
2021
|
+
*/
|
|
2022
|
+
failIfMissing?: boolean;
|
|
2023
|
+
/**
|
|
2024
|
+
* If set, the call will return the requested fields as part of the response.
|
|
2025
|
+
*/
|
|
2026
|
+
columns?: string[];
|
|
2027
|
+
};
|
|
2028
|
+
/**
|
|
2029
|
+
* Get by id operation.
|
|
2030
|
+
*/
|
|
2031
|
+
type TransactionGetOp = {
|
|
1556
2032
|
/**
|
|
1557
2033
|
* The table name
|
|
1558
2034
|
*/
|
|
@@ -1572,6 +2048,8 @@ type TransactionOperation$1 = {
|
|
|
1572
2048
|
update: TransactionUpdateOp;
|
|
1573
2049
|
} | {
|
|
1574
2050
|
['delete']: TransactionDeleteOp;
|
|
2051
|
+
} | {
|
|
2052
|
+
get: TransactionGetOp;
|
|
1575
2053
|
};
|
|
1576
2054
|
/**
|
|
1577
2055
|
* Fields to return in the transaction result.
|
|
@@ -1623,11 +2101,21 @@ type TransactionResultDelete = {
|
|
|
1623
2101
|
rows: number;
|
|
1624
2102
|
columns?: TransactionResultColumns;
|
|
1625
2103
|
};
|
|
2104
|
+
/**
|
|
2105
|
+
* A result from a get operation.
|
|
2106
|
+
*/
|
|
2107
|
+
type TransactionResultGet = {
|
|
2108
|
+
/**
|
|
2109
|
+
* The type of operation who's result is being returned.
|
|
2110
|
+
*/
|
|
2111
|
+
operation: 'get';
|
|
2112
|
+
columns?: TransactionResultColumns;
|
|
2113
|
+
};
|
|
1626
2114
|
/**
|
|
1627
2115
|
* An ordered array of results from the submitted operations.
|
|
1628
2116
|
*/
|
|
1629
2117
|
type TransactionSuccess = {
|
|
1630
|
-
results: (TransactionResultInsert | TransactionResultUpdate | TransactionResultDelete)[];
|
|
2118
|
+
results: (TransactionResultInsert | TransactionResultUpdate | TransactionResultDelete | TransactionResultGet)[];
|
|
1631
2119
|
};
|
|
1632
2120
|
/**
|
|
1633
2121
|
* An error message from a failing transaction operation
|
|
@@ -1643,7 +2131,7 @@ type TransactionError = {
|
|
|
1643
2131
|
message: string;
|
|
1644
2132
|
};
|
|
1645
2133
|
/**
|
|
1646
|
-
* An array of errors, with
|
|
2134
|
+
* An array of errors, with indices, from the transaction.
|
|
1647
2135
|
*/
|
|
1648
2136
|
type TransactionFailure = {
|
|
1649
2137
|
/**
|
|
@@ -1662,27 +2150,36 @@ type ObjectValue = {
|
|
|
1662
2150
|
[key: string]: string | boolean | number | string[] | number[] | DateTime | ObjectValue;
|
|
1663
2151
|
};
|
|
1664
2152
|
/**
|
|
1665
|
-
*
|
|
2153
|
+
* Unique file identifier
|
|
1666
2154
|
*
|
|
1667
|
-
* @
|
|
2155
|
+
* @maxLength 255
|
|
2156
|
+
* @minLength 1
|
|
2157
|
+
* @pattern [a-zA-Z0-9_-~:]+
|
|
2158
|
+
*/
|
|
2159
|
+
type FileItemID = string;
|
|
2160
|
+
/**
|
|
2161
|
+
* File name
|
|
2162
|
+
*
|
|
2163
|
+
* @maxLength 1024
|
|
2164
|
+
* @minLength 0
|
|
2165
|
+
* @pattern [0-9a-zA-Z!\-_\.\*'\(\)]*
|
|
2166
|
+
*/
|
|
2167
|
+
type FileName = string;
|
|
2168
|
+
/**
|
|
2169
|
+
* Media type
|
|
2170
|
+
*
|
|
2171
|
+
* @maxLength 255
|
|
2172
|
+
* @minLength 3
|
|
2173
|
+
* @pattern ^\w+/[-+.\w]+$
|
|
2174
|
+
*/
|
|
2175
|
+
type MediaType = string;
|
|
2176
|
+
/**
|
|
2177
|
+
* Object representing a file in an array
|
|
1668
2178
|
*/
|
|
1669
2179
|
type InputFileEntry = {
|
|
1670
|
-
|
|
1671
|
-
|
|
1672
|
-
|
|
1673
|
-
* @maxLength 1024
|
|
1674
|
-
* @minLength 1
|
|
1675
|
-
* @pattern [0-9a-zA-Z!\-_\.\*'\(\)]+
|
|
1676
|
-
*/
|
|
1677
|
-
name: string;
|
|
1678
|
-
/**
|
|
1679
|
-
* Media type
|
|
1680
|
-
*
|
|
1681
|
-
* @maxLength 255
|
|
1682
|
-
* @minLength 3
|
|
1683
|
-
* @pattern ^\w+/[-+.\w]+$
|
|
1684
|
-
*/
|
|
1685
|
-
mediaType?: string;
|
|
2180
|
+
id?: FileItemID;
|
|
2181
|
+
name?: FileName;
|
|
2182
|
+
mediaType?: MediaType;
|
|
1686
2183
|
/**
|
|
1687
2184
|
* Base64 encoded content
|
|
1688
2185
|
*
|
|
@@ -1704,11 +2201,34 @@ type InputFileEntry = {
|
|
|
1704
2201
|
* @maxItems 50
|
|
1705
2202
|
*/
|
|
1706
2203
|
type InputFileArray = InputFileEntry[];
|
|
2204
|
+
/**
|
|
2205
|
+
* Object representing a file
|
|
2206
|
+
*
|
|
2207
|
+
* @x-go-type file.InputFile
|
|
2208
|
+
*/
|
|
2209
|
+
type InputFile = {
|
|
2210
|
+
name: FileName;
|
|
2211
|
+
mediaType?: MediaType;
|
|
2212
|
+
/**
|
|
2213
|
+
* Base64 encoded content
|
|
2214
|
+
*
|
|
2215
|
+
* @maxLength 20971520
|
|
2216
|
+
*/
|
|
2217
|
+
base64Content?: string;
|
|
2218
|
+
/**
|
|
2219
|
+
* Enable public access to the file
|
|
2220
|
+
*/
|
|
2221
|
+
enablePublicUrl?: boolean;
|
|
2222
|
+
/**
|
|
2223
|
+
* Time to live for signed URLs
|
|
2224
|
+
*/
|
|
2225
|
+
signedUrlTimeout?: number;
|
|
2226
|
+
};
|
|
1707
2227
|
/**
|
|
1708
2228
|
* Xata input record
|
|
1709
2229
|
*/
|
|
1710
2230
|
type DataInputRecord = {
|
|
1711
|
-
[key: string]: RecordID | string | boolean | number | string[] | number[] | DateTime | ObjectValue | InputFileArray |
|
|
2231
|
+
[key: string]: RecordID | string | boolean | number | string[] | number[] | DateTime | ObjectValue | InputFileArray | InputFile | null;
|
|
1712
2232
|
};
|
|
1713
2233
|
/**
|
|
1714
2234
|
* Xata Table Record Metadata
|
|
@@ -1720,6 +2240,14 @@ type RecordMeta = {
|
|
|
1720
2240
|
* The record's version. Can be used for optimistic concurrency control.
|
|
1721
2241
|
*/
|
|
1722
2242
|
version: number;
|
|
2243
|
+
/**
|
|
2244
|
+
* The time when the record was created.
|
|
2245
|
+
*/
|
|
2246
|
+
createdAt?: string;
|
|
2247
|
+
/**
|
|
2248
|
+
* The time when the record was last updated.
|
|
2249
|
+
*/
|
|
2250
|
+
updatedAt?: string;
|
|
1723
2251
|
/**
|
|
1724
2252
|
* The record's table name. APIs that return records from multiple tables will set this field accordingly.
|
|
1725
2253
|
*/
|
|
@@ -1742,6 +2270,47 @@ type RecordMeta = {
|
|
|
1742
2270
|
warnings?: string[];
|
|
1743
2271
|
};
|
|
1744
2272
|
};
|
|
2273
|
+
/**
|
|
2274
|
+
* File metadata
|
|
2275
|
+
*/
|
|
2276
|
+
type FileResponse = {
|
|
2277
|
+
id?: FileItemID;
|
|
2278
|
+
name: FileName;
|
|
2279
|
+
mediaType: MediaType;
|
|
2280
|
+
/**
|
|
2281
|
+
* @format int64
|
|
2282
|
+
*/
|
|
2283
|
+
size: number;
|
|
2284
|
+
/**
|
|
2285
|
+
* @format int64
|
|
2286
|
+
*/
|
|
2287
|
+
version: number;
|
|
2288
|
+
attributes?: Record<string, any>;
|
|
2289
|
+
};
|
|
2290
|
+
type QueryColumnsProjection = (string | ProjectionConfig)[];
|
|
2291
|
+
/**
|
|
2292
|
+
* A structured projection that allows for some configuration.
|
|
2293
|
+
*/
|
|
2294
|
+
type ProjectionConfig = {
|
|
2295
|
+
/**
|
|
2296
|
+
* The name of the column to project or a reverse link specification, see [API Guide](https://xata.io/docs/concepts/data-model#links-and-relations).
|
|
2297
|
+
*/
|
|
2298
|
+
name?: string;
|
|
2299
|
+
columns?: QueryColumnsProjection;
|
|
2300
|
+
/**
|
|
2301
|
+
* An alias for the projected field, this is how it will be returned in the response.
|
|
2302
|
+
*/
|
|
2303
|
+
as?: string;
|
|
2304
|
+
sort?: SortExpression;
|
|
2305
|
+
/**
|
|
2306
|
+
* @default 20
|
|
2307
|
+
*/
|
|
2308
|
+
limit?: number;
|
|
2309
|
+
/**
|
|
2310
|
+
* @default 0
|
|
2311
|
+
*/
|
|
2312
|
+
offset?: number;
|
|
2313
|
+
};
|
|
1745
2314
|
/**
|
|
1746
2315
|
* The target expression is used to filter the search results by the target columns.
|
|
1747
2316
|
*/
|
|
@@ -1772,7 +2341,7 @@ type ValueBooster$1 = {
|
|
|
1772
2341
|
*/
|
|
1773
2342
|
value: string | number | boolean;
|
|
1774
2343
|
/**
|
|
1775
|
-
* The factor with which to multiply the
|
|
2344
|
+
* The factor with which to multiply the added boost.
|
|
1776
2345
|
*/
|
|
1777
2346
|
factor: number;
|
|
1778
2347
|
/**
|
|
@@ -1814,7 +2383,8 @@ type NumericBooster$1 = {
|
|
|
1814
2383
|
/**
|
|
1815
2384
|
* Boost records based on the value of a datetime column. It is configured via "origin", "scale", and "decay". The further away from the "origin",
|
|
1816
2385
|
* the more the score is decayed. The decay function uses an exponential function. For example if origin is "now", and scale is 10 days and decay is 0.5, it
|
|
1817
|
-
* should be interpreted as: a record with a date 10 days before/after origin will
|
|
2386
|
+
* should be interpreted as: a record with a date 10 days before/after origin will be boosted 2 times less than a record with the date at origin.
|
|
2387
|
+
* The result of the exponential function is a boost between 0 and 1. The "factor" allows you to control how impactful this boost is, by multiplying it with a given value.
|
|
1818
2388
|
*/
|
|
1819
2389
|
type DateBooster$1 = {
|
|
1820
2390
|
/**
|
|
@@ -1827,7 +2397,7 @@ type DateBooster$1 = {
|
|
|
1827
2397
|
*/
|
|
1828
2398
|
origin?: string;
|
|
1829
2399
|
/**
|
|
1830
|
-
* The duration at which distance from origin the score is decayed with factor, using an exponential function. It is
|
|
2400
|
+
* The duration at which distance from origin the score is decayed with factor, using an exponential function. It is formatted as number + units, for example: `5d`, `20m`, `10s`.
|
|
1831
2401
|
*
|
|
1832
2402
|
* @pattern ^(\d+)(d|h|m|s|ms)$
|
|
1833
2403
|
*/
|
|
@@ -1836,6 +2406,12 @@ type DateBooster$1 = {
|
|
|
1836
2406
|
* The decay factor to expect at "scale" distance from the "origin".
|
|
1837
2407
|
*/
|
|
1838
2408
|
decay: number;
|
|
2409
|
+
/**
|
|
2410
|
+
* The factor with which to multiply the added boost.
|
|
2411
|
+
*
|
|
2412
|
+
* @minimum 0
|
|
2413
|
+
*/
|
|
2414
|
+
factor?: number;
|
|
1839
2415
|
/**
|
|
1840
2416
|
* Only apply this booster to the records for which the provided filter matches.
|
|
1841
2417
|
*/
|
|
@@ -1856,7 +2432,7 @@ type BoosterExpression = {
|
|
|
1856
2432
|
/**
|
|
1857
2433
|
* Maximum [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) for the search terms. The Levenshtein
|
|
1858
2434
|
* distance is the number of one character changes needed to make two strings equal. The default is 1, meaning that single
|
|
1859
|
-
* character typos per word are
|
|
2435
|
+
* character typos per word are tolerated by search. You can set it to 0 to remove the typo tolerance or set it to 2
|
|
1860
2436
|
* to allow two typos in a word.
|
|
1861
2437
|
*
|
|
1862
2438
|
* @default 1
|
|
@@ -1993,6 +2569,16 @@ type AverageAgg = {
|
|
|
1993
2569
|
*/
|
|
1994
2570
|
column: string;
|
|
1995
2571
|
};
|
|
2572
|
+
/**
|
|
2573
|
+
* Calculate given percentiles of the numeric values in a particular column.
|
|
2574
|
+
*/
|
|
2575
|
+
type PercentilesAgg = {
|
|
2576
|
+
/**
|
|
2577
|
+
* The column on which to compute the average. Must be a numeric type.
|
|
2578
|
+
*/
|
|
2579
|
+
column: string;
|
|
2580
|
+
percentiles: number[];
|
|
2581
|
+
};
|
|
1996
2582
|
/**
|
|
1997
2583
|
* Count the number of distinct values in a particular column.
|
|
1998
2584
|
*/
|
|
@@ -2003,7 +2589,7 @@ type UniqueCountAgg = {
|
|
|
2003
2589
|
column: string;
|
|
2004
2590
|
/**
|
|
2005
2591
|
* The threshold under which the unique count is exact. If the number of unique
|
|
2006
|
-
* values in the column is higher than this threshold, the results are
|
|
2592
|
+
* values in the column is higher than this threshold, the results are approximate.
|
|
2007
2593
|
* Maximum value is 40,000, default value is 3000.
|
|
2008
2594
|
*/
|
|
2009
2595
|
precisionThreshold?: number;
|
|
@@ -2026,7 +2612,7 @@ type DateHistogramAgg = {
|
|
|
2026
2612
|
column: string;
|
|
2027
2613
|
/**
|
|
2028
2614
|
* The fixed interval to use when bucketing.
|
|
2029
|
-
* It is
|
|
2615
|
+
* It is formatted as number + units, for example: `5d`, `20m`, `10s`.
|
|
2030
2616
|
*
|
|
2031
2617
|
* @pattern ^(\d+)(d|h|m|s|ms)$
|
|
2032
2618
|
*/
|
|
@@ -2081,7 +2667,7 @@ type NumericHistogramAgg = {
|
|
|
2081
2667
|
interval: number;
|
|
2082
2668
|
/**
|
|
2083
2669
|
* By default the bucket keys start with 0 and then continue in `interval` steps. The bucket
|
|
2084
|
-
* boundaries can be
|
|
2670
|
+
* boundaries can be shifted by using the offset option. For example, if the `interval` is 100,
|
|
2085
2671
|
* but you prefer the bucket boundaries to be `[50, 150), [150, 250), etc.`, you can set `offset`
|
|
2086
2672
|
* to 50.
|
|
2087
2673
|
*
|
|
@@ -2107,6 +2693,8 @@ type AggExpression = {
|
|
|
2107
2693
|
min?: MinAgg;
|
|
2108
2694
|
} | {
|
|
2109
2695
|
average?: AverageAgg;
|
|
2696
|
+
} | {
|
|
2697
|
+
percentiles?: PercentilesAgg;
|
|
2110
2698
|
} | {
|
|
2111
2699
|
uniqueCount?: UniqueCountAgg;
|
|
2112
2700
|
} | {
|
|
@@ -2122,7 +2710,27 @@ type AggResponse$1 = (number | null) | {
|
|
|
2122
2710
|
$count: number;
|
|
2123
2711
|
} & {
|
|
2124
2712
|
[key: string]: AggResponse$1;
|
|
2125
|
-
})[]
|
|
2713
|
+
})[] | {
|
|
2714
|
+
[key: string]: number;
|
|
2715
|
+
};
|
|
2716
|
+
};
|
|
2717
|
+
/**
|
|
2718
|
+
* File identifier in access URLs
|
|
2719
|
+
*
|
|
2720
|
+
* @maxLength 296
|
|
2721
|
+
* @minLength 88
|
|
2722
|
+
* @pattern [a-v0-9=]+
|
|
2723
|
+
*/
|
|
2724
|
+
type FileAccessID = string;
|
|
2725
|
+
/**
|
|
2726
|
+
* File signature
|
|
2727
|
+
*/
|
|
2728
|
+
type FileSignature = string;
|
|
2729
|
+
/**
|
|
2730
|
+
* Xata Table SQL Record
|
|
2731
|
+
*/
|
|
2732
|
+
type SQLRecord = {
|
|
2733
|
+
[key: string]: any;
|
|
2126
2734
|
};
|
|
2127
2735
|
/**
|
|
2128
2736
|
* Xata Table Record Metadata
|
|
@@ -2169,12 +2777,19 @@ type SchemaCompareResponse = {
|
|
|
2169
2777
|
target: Schema;
|
|
2170
2778
|
edits: SchemaEditScript;
|
|
2171
2779
|
};
|
|
2780
|
+
type RateLimitError = {
|
|
2781
|
+
id?: string;
|
|
2782
|
+
message: string;
|
|
2783
|
+
};
|
|
2172
2784
|
type RecordUpdateResponse = XataRecord$1 | {
|
|
2173
2785
|
id: string;
|
|
2174
2786
|
xata: {
|
|
2175
2787
|
version: number;
|
|
2788
|
+
createdAt: string;
|
|
2789
|
+
updatedAt: string;
|
|
2176
2790
|
};
|
|
2177
2791
|
};
|
|
2792
|
+
type PutFileResponse = FileResponse;
|
|
2178
2793
|
type RecordResponse = XataRecord$1;
|
|
2179
2794
|
type BulkInsertResponse = {
|
|
2180
2795
|
recordIDs: string[];
|
|
@@ -2191,13 +2806,17 @@ type QueryResponse = {
|
|
|
2191
2806
|
records: XataRecord$1[];
|
|
2192
2807
|
meta: RecordsMetadata;
|
|
2193
2808
|
};
|
|
2809
|
+
type ServiceUnavailableError = {
|
|
2810
|
+
id?: string;
|
|
2811
|
+
message: string;
|
|
2812
|
+
};
|
|
2194
2813
|
type SearchResponse = {
|
|
2195
2814
|
records: XataRecord$1[];
|
|
2196
2815
|
warning?: string;
|
|
2197
|
-
|
|
2198
|
-
|
|
2199
|
-
|
|
2200
|
-
|
|
2816
|
+
/**
|
|
2817
|
+
* The total count of records matched. It will be accurately returned up to 10000 records.
|
|
2818
|
+
*/
|
|
2819
|
+
totalCount: number;
|
|
2201
2820
|
};
|
|
2202
2821
|
type SummarizeResponse = {
|
|
2203
2822
|
summaries: Record<string, any>[];
|
|
@@ -2210,6 +2829,10 @@ type AggResponse = {
|
|
|
2210
2829
|
[key: string]: AggResponse$1;
|
|
2211
2830
|
};
|
|
2212
2831
|
};
|
|
2832
|
+
type SQLResponse = {
|
|
2833
|
+
records?: SQLRecord[];
|
|
2834
|
+
warning?: string;
|
|
2835
|
+
};
|
|
2213
2836
|
|
|
2214
2837
|
type DataPlaneFetcherExtraProps = {
|
|
2215
2838
|
apiUrl: string;
|
|
@@ -2222,6 +2845,8 @@ type DataPlaneFetcherExtraProps = {
|
|
|
2222
2845
|
sessionID?: string;
|
|
2223
2846
|
clientName?: string;
|
|
2224
2847
|
xataAgentExtra?: Record<string, string>;
|
|
2848
|
+
rawResponse?: boolean;
|
|
2849
|
+
headers?: Record<string, unknown>;
|
|
2225
2850
|
};
|
|
2226
2851
|
type ErrorWrapper<TError> = TError | {
|
|
2227
2852
|
status: 'unknown';
|
|
@@ -3256,6 +3881,18 @@ type PushBranchMigrationsVariables = {
|
|
|
3256
3881
|
body: PushBranchMigrationsRequestBody;
|
|
3257
3882
|
pathParams: PushBranchMigrationsPathParams;
|
|
3258
3883
|
} & DataPlaneFetcherExtraProps;
|
|
3884
|
+
/**
|
|
3885
|
+
* The `schema/push` API accepts a list of migrations to be applied to the
|
|
3886
|
+
* current branch. A list of applicable migrations can be fetched using
|
|
3887
|
+
* the `schema/history` API from another branch or database.
|
|
3888
|
+
*
|
|
3889
|
+
* The most recent migration must be part of the list or referenced (via
|
|
3890
|
+
* `parentID`) by the first migration in the list of migrations to be pushed.
|
|
3891
|
+
*
|
|
3892
|
+
* Each migration in the list has an `id`, `parentID`, and `checksum`. The
|
|
3893
|
+
* checksum for migrations are generated and verified by xata. The
|
|
3894
|
+
* operation fails if any migration in the list has an invalid checksum.
|
|
3895
|
+
*/
|
|
3259
3896
|
declare const pushBranchMigrations: (variables: PushBranchMigrationsVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
|
3260
3897
|
type CreateTablePathParams = {
|
|
3261
3898
|
/**
|
|
@@ -3449,7 +4086,211 @@ type GetTableColumnsPathParams = {
|
|
|
3449
4086
|
workspace: string;
|
|
3450
4087
|
region: string;
|
|
3451
4088
|
};
|
|
3452
|
-
type GetTableColumnsError = ErrorWrapper<{
|
|
4089
|
+
type GetTableColumnsError = ErrorWrapper<{
|
|
4090
|
+
status: 400;
|
|
4091
|
+
payload: BadRequestError;
|
|
4092
|
+
} | {
|
|
4093
|
+
status: 401;
|
|
4094
|
+
payload: AuthError;
|
|
4095
|
+
} | {
|
|
4096
|
+
status: 404;
|
|
4097
|
+
payload: SimpleError;
|
|
4098
|
+
}>;
|
|
4099
|
+
type GetTableColumnsResponse = {
|
|
4100
|
+
columns: Column[];
|
|
4101
|
+
};
|
|
4102
|
+
type GetTableColumnsVariables = {
|
|
4103
|
+
pathParams: GetTableColumnsPathParams;
|
|
4104
|
+
} & DataPlaneFetcherExtraProps;
|
|
4105
|
+
/**
|
|
4106
|
+
* Retrieves the list of table columns and their definition. This endpoint returns the column list with object columns being reported with their
|
|
4107
|
+
* full dot-separated path (flattened).
|
|
4108
|
+
*/
|
|
4109
|
+
declare const getTableColumns: (variables: GetTableColumnsVariables, signal?: AbortSignal) => Promise<GetTableColumnsResponse>;
|
|
4110
|
+
type AddTableColumnPathParams = {
|
|
4111
|
+
/**
|
|
4112
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
|
4113
|
+
*/
|
|
4114
|
+
dbBranchName: DBBranchName;
|
|
4115
|
+
/**
|
|
4116
|
+
* The Table name
|
|
4117
|
+
*/
|
|
4118
|
+
tableName: TableName;
|
|
4119
|
+
workspace: string;
|
|
4120
|
+
region: string;
|
|
4121
|
+
};
|
|
4122
|
+
type AddTableColumnError = ErrorWrapper<{
|
|
4123
|
+
status: 400;
|
|
4124
|
+
payload: BadRequestError;
|
|
4125
|
+
} | {
|
|
4126
|
+
status: 401;
|
|
4127
|
+
payload: AuthError;
|
|
4128
|
+
} | {
|
|
4129
|
+
status: 404;
|
|
4130
|
+
payload: SimpleError;
|
|
4131
|
+
}>;
|
|
4132
|
+
type AddTableColumnVariables = {
|
|
4133
|
+
body: Column;
|
|
4134
|
+
pathParams: AddTableColumnPathParams;
|
|
4135
|
+
} & DataPlaneFetcherExtraProps;
|
|
4136
|
+
/**
|
|
4137
|
+
* Adds a new column to the table. The body of the request should contain the column definition.
|
|
4138
|
+
*/
|
|
4139
|
+
declare const addTableColumn: (variables: AddTableColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
|
4140
|
+
type GetColumnPathParams = {
|
|
4141
|
+
/**
|
|
4142
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
|
4143
|
+
*/
|
|
4144
|
+
dbBranchName: DBBranchName;
|
|
4145
|
+
/**
|
|
4146
|
+
* The Table name
|
|
4147
|
+
*/
|
|
4148
|
+
tableName: TableName;
|
|
4149
|
+
/**
|
|
4150
|
+
* The Column name
|
|
4151
|
+
*/
|
|
4152
|
+
columnName: ColumnName;
|
|
4153
|
+
workspace: string;
|
|
4154
|
+
region: string;
|
|
4155
|
+
};
|
|
4156
|
+
type GetColumnError = ErrorWrapper<{
|
|
4157
|
+
status: 400;
|
|
4158
|
+
payload: BadRequestError;
|
|
4159
|
+
} | {
|
|
4160
|
+
status: 401;
|
|
4161
|
+
payload: AuthError;
|
|
4162
|
+
} | {
|
|
4163
|
+
status: 404;
|
|
4164
|
+
payload: SimpleError;
|
|
4165
|
+
}>;
|
|
4166
|
+
type GetColumnVariables = {
|
|
4167
|
+
pathParams: GetColumnPathParams;
|
|
4168
|
+
} & DataPlaneFetcherExtraProps;
|
|
4169
|
+
/**
|
|
4170
|
+
* Get the definition of a single column.
|
|
4171
|
+
*/
|
|
4172
|
+
declare const getColumn: (variables: GetColumnVariables, signal?: AbortSignal) => Promise<Column>;
|
|
4173
|
+
type UpdateColumnPathParams = {
|
|
4174
|
+
/**
|
|
4175
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
|
4176
|
+
*/
|
|
4177
|
+
dbBranchName: DBBranchName;
|
|
4178
|
+
/**
|
|
4179
|
+
* The Table name
|
|
4180
|
+
*/
|
|
4181
|
+
tableName: TableName;
|
|
4182
|
+
/**
|
|
4183
|
+
* The Column name
|
|
4184
|
+
*/
|
|
4185
|
+
columnName: ColumnName;
|
|
4186
|
+
workspace: string;
|
|
4187
|
+
region: string;
|
|
4188
|
+
};
|
|
4189
|
+
type UpdateColumnError = ErrorWrapper<{
|
|
4190
|
+
status: 400;
|
|
4191
|
+
payload: BadRequestError;
|
|
4192
|
+
} | {
|
|
4193
|
+
status: 401;
|
|
4194
|
+
payload: AuthError;
|
|
4195
|
+
} | {
|
|
4196
|
+
status: 404;
|
|
4197
|
+
payload: SimpleError;
|
|
4198
|
+
}>;
|
|
4199
|
+
type UpdateColumnRequestBody = {
|
|
4200
|
+
/**
|
|
4201
|
+
* @minLength 1
|
|
4202
|
+
*/
|
|
4203
|
+
name: string;
|
|
4204
|
+
};
|
|
4205
|
+
type UpdateColumnVariables = {
|
|
4206
|
+
body: UpdateColumnRequestBody;
|
|
4207
|
+
pathParams: UpdateColumnPathParams;
|
|
4208
|
+
} & DataPlaneFetcherExtraProps;
|
|
4209
|
+
/**
|
|
4210
|
+
* Update column with partial data. Can be used for renaming the column by providing a new "name" field.
|
|
4211
|
+
*/
|
|
4212
|
+
declare const updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
|
4213
|
+
type DeleteColumnPathParams = {
|
|
4214
|
+
/**
|
|
4215
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
|
4216
|
+
*/
|
|
4217
|
+
dbBranchName: DBBranchName;
|
|
4218
|
+
/**
|
|
4219
|
+
* The Table name
|
|
4220
|
+
*/
|
|
4221
|
+
tableName: TableName;
|
|
4222
|
+
/**
|
|
4223
|
+
* The Column name
|
|
4224
|
+
*/
|
|
4225
|
+
columnName: ColumnName;
|
|
4226
|
+
workspace: string;
|
|
4227
|
+
region: string;
|
|
4228
|
+
};
|
|
4229
|
+
type DeleteColumnError = ErrorWrapper<{
|
|
4230
|
+
status: 400;
|
|
4231
|
+
payload: BadRequestError;
|
|
4232
|
+
} | {
|
|
4233
|
+
status: 401;
|
|
4234
|
+
payload: AuthError;
|
|
4235
|
+
} | {
|
|
4236
|
+
status: 404;
|
|
4237
|
+
payload: SimpleError;
|
|
4238
|
+
}>;
|
|
4239
|
+
type DeleteColumnVariables = {
|
|
4240
|
+
pathParams: DeleteColumnPathParams;
|
|
4241
|
+
} & DataPlaneFetcherExtraProps;
|
|
4242
|
+
/**
|
|
4243
|
+
* Deletes the specified column.
|
|
4244
|
+
*/
|
|
4245
|
+
declare const deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
|
4246
|
+
type BranchTransactionPathParams = {
|
|
4247
|
+
/**
|
|
4248
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
|
4249
|
+
*/
|
|
4250
|
+
dbBranchName: DBBranchName;
|
|
4251
|
+
workspace: string;
|
|
4252
|
+
region: string;
|
|
4253
|
+
};
|
|
4254
|
+
type BranchTransactionError = ErrorWrapper<{
|
|
4255
|
+
status: 400;
|
|
4256
|
+
payload: TransactionFailure;
|
|
4257
|
+
} | {
|
|
4258
|
+
status: 401;
|
|
4259
|
+
payload: AuthError;
|
|
4260
|
+
} | {
|
|
4261
|
+
status: 404;
|
|
4262
|
+
payload: SimpleError;
|
|
4263
|
+
} | {
|
|
4264
|
+
status: 429;
|
|
4265
|
+
payload: RateLimitError;
|
|
4266
|
+
}>;
|
|
4267
|
+
type BranchTransactionRequestBody = {
|
|
4268
|
+
operations: TransactionOperation$1[];
|
|
4269
|
+
};
|
|
4270
|
+
type BranchTransactionVariables = {
|
|
4271
|
+
body: BranchTransactionRequestBody;
|
|
4272
|
+
pathParams: BranchTransactionPathParams;
|
|
4273
|
+
} & DataPlaneFetcherExtraProps;
|
|
4274
|
+
declare const branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal) => Promise<TransactionSuccess>;
|
|
4275
|
+
type InsertRecordPathParams = {
|
|
4276
|
+
/**
|
|
4277
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
|
4278
|
+
*/
|
|
4279
|
+
dbBranchName: DBBranchName;
|
|
4280
|
+
/**
|
|
4281
|
+
* The Table name
|
|
4282
|
+
*/
|
|
4283
|
+
tableName: TableName;
|
|
4284
|
+
workspace: string;
|
|
4285
|
+
region: string;
|
|
4286
|
+
};
|
|
4287
|
+
type InsertRecordQueryParams = {
|
|
4288
|
+
/**
|
|
4289
|
+
* Column filters
|
|
4290
|
+
*/
|
|
4291
|
+
columns?: ColumnsProjection;
|
|
4292
|
+
};
|
|
4293
|
+
type InsertRecordError = ErrorWrapper<{
|
|
3453
4294
|
status: 400;
|
|
3454
4295
|
payload: BadRequestError;
|
|
3455
4296
|
} | {
|
|
@@ -3459,18 +4300,16 @@ type GetTableColumnsError = ErrorWrapper<{
|
|
|
3459
4300
|
status: 404;
|
|
3460
4301
|
payload: SimpleError;
|
|
3461
4302
|
}>;
|
|
3462
|
-
type
|
|
3463
|
-
|
|
3464
|
-
|
|
3465
|
-
|
|
3466
|
-
pathParams: GetTableColumnsPathParams;
|
|
4303
|
+
type InsertRecordVariables = {
|
|
4304
|
+
body?: DataInputRecord;
|
|
4305
|
+
pathParams: InsertRecordPathParams;
|
|
4306
|
+
queryParams?: InsertRecordQueryParams;
|
|
3467
4307
|
} & DataPlaneFetcherExtraProps;
|
|
3468
4308
|
/**
|
|
3469
|
-
*
|
|
3470
|
-
* full dot-separated path (flattened).
|
|
4309
|
+
* Insert a new Record into the Table
|
|
3471
4310
|
*/
|
|
3472
|
-
declare const
|
|
3473
|
-
type
|
|
4311
|
+
declare const insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
|
4312
|
+
type GetFileItemPathParams = {
|
|
3474
4313
|
/**
|
|
3475
4314
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
|
3476
4315
|
*/
|
|
@@ -3479,10 +4318,22 @@ type AddTableColumnPathParams = {
|
|
|
3479
4318
|
* The Table name
|
|
3480
4319
|
*/
|
|
3481
4320
|
tableName: TableName;
|
|
4321
|
+
/**
|
|
4322
|
+
* The Record name
|
|
4323
|
+
*/
|
|
4324
|
+
recordId: RecordID;
|
|
4325
|
+
/**
|
|
4326
|
+
* The Column name
|
|
4327
|
+
*/
|
|
4328
|
+
columnName: ColumnName;
|
|
4329
|
+
/**
|
|
4330
|
+
* The File Identifier
|
|
4331
|
+
*/
|
|
4332
|
+
fileId: FileItemID;
|
|
3482
4333
|
workspace: string;
|
|
3483
4334
|
region: string;
|
|
3484
4335
|
};
|
|
3485
|
-
type
|
|
4336
|
+
type GetFileItemError = ErrorWrapper<{
|
|
3486
4337
|
status: 400;
|
|
3487
4338
|
payload: BadRequestError;
|
|
3488
4339
|
} | {
|
|
@@ -3492,17 +4343,14 @@ type AddTableColumnError = ErrorWrapper<{
|
|
|
3492
4343
|
status: 404;
|
|
3493
4344
|
payload: SimpleError;
|
|
3494
4345
|
}>;
|
|
3495
|
-
type
|
|
3496
|
-
|
|
3497
|
-
pathParams: AddTableColumnPathParams;
|
|
4346
|
+
type GetFileItemVariables = {
|
|
4347
|
+
pathParams: GetFileItemPathParams;
|
|
3498
4348
|
} & DataPlaneFetcherExtraProps;
|
|
3499
4349
|
/**
|
|
3500
|
-
*
|
|
3501
|
-
* contain the full path separated by dots. If the parent objects do not exists, they will be automatically created. For example,
|
|
3502
|
-
* passing `"name": "address.city"` will auto-create the `address` object if it doesn't exist.
|
|
4350
|
+
* Retrieves file content from an array by file ID
|
|
3503
4351
|
*/
|
|
3504
|
-
declare const
|
|
3505
|
-
type
|
|
4352
|
+
declare const getFileItem: (variables: GetFileItemVariables, signal?: AbortSignal) => Promise<Blob>;
|
|
4353
|
+
type PutFileItemPathParams = {
|
|
3506
4354
|
/**
|
|
3507
4355
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
|
3508
4356
|
*/
|
|
@@ -3511,14 +4359,22 @@ type GetColumnPathParams = {
|
|
|
3511
4359
|
* The Table name
|
|
3512
4360
|
*/
|
|
3513
4361
|
tableName: TableName;
|
|
4362
|
+
/**
|
|
4363
|
+
* The Record name
|
|
4364
|
+
*/
|
|
4365
|
+
recordId: RecordID;
|
|
3514
4366
|
/**
|
|
3515
4367
|
* The Column name
|
|
3516
4368
|
*/
|
|
3517
4369
|
columnName: ColumnName;
|
|
4370
|
+
/**
|
|
4371
|
+
* The File Identifier
|
|
4372
|
+
*/
|
|
4373
|
+
fileId: FileItemID;
|
|
3518
4374
|
workspace: string;
|
|
3519
4375
|
region: string;
|
|
3520
4376
|
};
|
|
3521
|
-
type
|
|
4377
|
+
type PutFileItemError = ErrorWrapper<{
|
|
3522
4378
|
status: 400;
|
|
3523
4379
|
payload: BadRequestError;
|
|
3524
4380
|
} | {
|
|
@@ -3527,15 +4383,19 @@ type GetColumnError = ErrorWrapper<{
|
|
|
3527
4383
|
} | {
|
|
3528
4384
|
status: 404;
|
|
3529
4385
|
payload: SimpleError;
|
|
4386
|
+
} | {
|
|
4387
|
+
status: 422;
|
|
4388
|
+
payload: SimpleError;
|
|
3530
4389
|
}>;
|
|
3531
|
-
type
|
|
3532
|
-
|
|
4390
|
+
type PutFileItemVariables = {
|
|
4391
|
+
body?: Blob;
|
|
4392
|
+
pathParams: PutFileItemPathParams;
|
|
3533
4393
|
} & DataPlaneFetcherExtraProps;
|
|
3534
4394
|
/**
|
|
3535
|
-
*
|
|
4395
|
+
* Uploads the file content to an array given the file ID
|
|
3536
4396
|
*/
|
|
3537
|
-
declare const
|
|
3538
|
-
type
|
|
4397
|
+
declare const putFileItem: (variables: PutFileItemVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
|
4398
|
+
type DeleteFileItemPathParams = {
|
|
3539
4399
|
/**
|
|
3540
4400
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
|
3541
4401
|
*/
|
|
@@ -3544,14 +4404,22 @@ type UpdateColumnPathParams = {
|
|
|
3544
4404
|
* The Table name
|
|
3545
4405
|
*/
|
|
3546
4406
|
tableName: TableName;
|
|
4407
|
+
/**
|
|
4408
|
+
* The Record name
|
|
4409
|
+
*/
|
|
4410
|
+
recordId: RecordID;
|
|
3547
4411
|
/**
|
|
3548
4412
|
* The Column name
|
|
3549
4413
|
*/
|
|
3550
4414
|
columnName: ColumnName;
|
|
4415
|
+
/**
|
|
4416
|
+
* The File Identifier
|
|
4417
|
+
*/
|
|
4418
|
+
fileId: FileItemID;
|
|
3551
4419
|
workspace: string;
|
|
3552
4420
|
region: string;
|
|
3553
4421
|
};
|
|
3554
|
-
type
|
|
4422
|
+
type DeleteFileItemError = ErrorWrapper<{
|
|
3555
4423
|
status: 400;
|
|
3556
4424
|
payload: BadRequestError;
|
|
3557
4425
|
} | {
|
|
@@ -3561,21 +4429,14 @@ type UpdateColumnError = ErrorWrapper<{
|
|
|
3561
4429
|
status: 404;
|
|
3562
4430
|
payload: SimpleError;
|
|
3563
4431
|
}>;
|
|
3564
|
-
type
|
|
3565
|
-
|
|
3566
|
-
* @minLength 1
|
|
3567
|
-
*/
|
|
3568
|
-
name: string;
|
|
3569
|
-
};
|
|
3570
|
-
type UpdateColumnVariables = {
|
|
3571
|
-
body: UpdateColumnRequestBody;
|
|
3572
|
-
pathParams: UpdateColumnPathParams;
|
|
4432
|
+
type DeleteFileItemVariables = {
|
|
4433
|
+
pathParams: DeleteFileItemPathParams;
|
|
3573
4434
|
} & DataPlaneFetcherExtraProps;
|
|
3574
4435
|
/**
|
|
3575
|
-
*
|
|
4436
|
+
* Deletes an item from an file array column given the file ID
|
|
3576
4437
|
*/
|
|
3577
|
-
declare const
|
|
3578
|
-
type
|
|
4438
|
+
declare const deleteFileItem: (variables: DeleteFileItemVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
|
4439
|
+
type GetFilePathParams = {
|
|
3579
4440
|
/**
|
|
3580
4441
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
|
3581
4442
|
*/
|
|
@@ -3584,6 +4445,10 @@ type DeleteColumnPathParams = {
|
|
|
3584
4445
|
* The Table name
|
|
3585
4446
|
*/
|
|
3586
4447
|
tableName: TableName;
|
|
4448
|
+
/**
|
|
4449
|
+
* The Record name
|
|
4450
|
+
*/
|
|
4451
|
+
recordId: RecordID;
|
|
3587
4452
|
/**
|
|
3588
4453
|
* The Column name
|
|
3589
4454
|
*/
|
|
@@ -3591,7 +4456,7 @@ type DeleteColumnPathParams = {
|
|
|
3591
4456
|
workspace: string;
|
|
3592
4457
|
region: string;
|
|
3593
4458
|
};
|
|
3594
|
-
type
|
|
4459
|
+
type GetFileError = ErrorWrapper<{
|
|
3595
4460
|
status: 400;
|
|
3596
4461
|
payload: BadRequestError;
|
|
3597
4462
|
} | {
|
|
@@ -3601,40 +4466,55 @@ type DeleteColumnError = ErrorWrapper<{
|
|
|
3601
4466
|
status: 404;
|
|
3602
4467
|
payload: SimpleError;
|
|
3603
4468
|
}>;
|
|
3604
|
-
type
|
|
3605
|
-
pathParams:
|
|
4469
|
+
type GetFileVariables = {
|
|
4470
|
+
pathParams: GetFilePathParams;
|
|
3606
4471
|
} & DataPlaneFetcherExtraProps;
|
|
3607
4472
|
/**
|
|
3608
|
-
*
|
|
4473
|
+
* Retrieves the file content from a file column
|
|
3609
4474
|
*/
|
|
3610
|
-
declare const
|
|
3611
|
-
type
|
|
4475
|
+
declare const getFile: (variables: GetFileVariables, signal?: AbortSignal) => Promise<Blob>;
|
|
4476
|
+
type PutFilePathParams = {
|
|
3612
4477
|
/**
|
|
3613
4478
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
|
3614
4479
|
*/
|
|
3615
4480
|
dbBranchName: DBBranchName;
|
|
4481
|
+
/**
|
|
4482
|
+
* The Table name
|
|
4483
|
+
*/
|
|
4484
|
+
tableName: TableName;
|
|
4485
|
+
/**
|
|
4486
|
+
* The Record name
|
|
4487
|
+
*/
|
|
4488
|
+
recordId: RecordID;
|
|
4489
|
+
/**
|
|
4490
|
+
* The Column name
|
|
4491
|
+
*/
|
|
4492
|
+
columnName: ColumnName;
|
|
3616
4493
|
workspace: string;
|
|
3617
4494
|
region: string;
|
|
3618
4495
|
};
|
|
3619
|
-
type
|
|
4496
|
+
type PutFileError = ErrorWrapper<{
|
|
3620
4497
|
status: 400;
|
|
3621
|
-
payload:
|
|
4498
|
+
payload: BadRequestError;
|
|
3622
4499
|
} | {
|
|
3623
4500
|
status: 401;
|
|
3624
4501
|
payload: AuthError;
|
|
3625
4502
|
} | {
|
|
3626
4503
|
status: 404;
|
|
3627
4504
|
payload: SimpleError;
|
|
4505
|
+
} | {
|
|
4506
|
+
status: 422;
|
|
4507
|
+
payload: SimpleError;
|
|
3628
4508
|
}>;
|
|
3629
|
-
type
|
|
3630
|
-
|
|
3631
|
-
|
|
3632
|
-
type BranchTransactionVariables = {
|
|
3633
|
-
body: BranchTransactionRequestBody;
|
|
3634
|
-
pathParams: BranchTransactionPathParams;
|
|
4509
|
+
type PutFileVariables = {
|
|
4510
|
+
body?: Blob;
|
|
4511
|
+
pathParams: PutFilePathParams;
|
|
3635
4512
|
} & DataPlaneFetcherExtraProps;
|
|
3636
|
-
|
|
3637
|
-
|
|
4513
|
+
/**
|
|
4514
|
+
* Uploads the file content to the given file column
|
|
4515
|
+
*/
|
|
4516
|
+
declare const putFile: (variables: PutFileVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
|
4517
|
+
type DeleteFilePathParams = {
|
|
3638
4518
|
/**
|
|
3639
4519
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
|
3640
4520
|
*/
|
|
@@ -3643,16 +4523,18 @@ type InsertRecordPathParams = {
|
|
|
3643
4523
|
* The Table name
|
|
3644
4524
|
*/
|
|
3645
4525
|
tableName: TableName;
|
|
3646
|
-
workspace: string;
|
|
3647
|
-
region: string;
|
|
3648
|
-
};
|
|
3649
|
-
type InsertRecordQueryParams = {
|
|
3650
4526
|
/**
|
|
3651
|
-
*
|
|
4527
|
+
* The Record name
|
|
3652
4528
|
*/
|
|
3653
|
-
|
|
4529
|
+
recordId: RecordID;
|
|
4530
|
+
/**
|
|
4531
|
+
* The Column name
|
|
4532
|
+
*/
|
|
4533
|
+
columnName: ColumnName;
|
|
4534
|
+
workspace: string;
|
|
4535
|
+
region: string;
|
|
3654
4536
|
};
|
|
3655
|
-
type
|
|
4537
|
+
type DeleteFileError = ErrorWrapper<{
|
|
3656
4538
|
status: 400;
|
|
3657
4539
|
payload: BadRequestError;
|
|
3658
4540
|
} | {
|
|
@@ -3662,15 +4544,13 @@ type InsertRecordError = ErrorWrapper<{
|
|
|
3662
4544
|
status: 404;
|
|
3663
4545
|
payload: SimpleError;
|
|
3664
4546
|
}>;
|
|
3665
|
-
type
|
|
3666
|
-
|
|
3667
|
-
pathParams: InsertRecordPathParams;
|
|
3668
|
-
queryParams?: InsertRecordQueryParams;
|
|
4547
|
+
type DeleteFileVariables = {
|
|
4548
|
+
pathParams: DeleteFilePathParams;
|
|
3669
4549
|
} & DataPlaneFetcherExtraProps;
|
|
3670
4550
|
/**
|
|
3671
|
-
*
|
|
4551
|
+
* Deletes a file referred in a file column
|
|
3672
4552
|
*/
|
|
3673
|
-
declare const
|
|
4553
|
+
declare const deleteFile: (variables: DeleteFileVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
|
3674
4554
|
type GetRecordPathParams = {
|
|
3675
4555
|
/**
|
|
3676
4556
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
|
@@ -3942,12 +4822,15 @@ type QueryTableError = ErrorWrapper<{
|
|
|
3942
4822
|
} | {
|
|
3943
4823
|
status: 404;
|
|
3944
4824
|
payload: SimpleError;
|
|
4825
|
+
} | {
|
|
4826
|
+
status: 503;
|
|
4827
|
+
payload: ServiceUnavailableError;
|
|
3945
4828
|
}>;
|
|
3946
4829
|
type QueryTableRequestBody = {
|
|
3947
4830
|
filter?: FilterExpression;
|
|
3948
4831
|
sort?: SortExpression;
|
|
3949
4832
|
page?: PageConfig;
|
|
3950
|
-
columns?:
|
|
4833
|
+
columns?: QueryColumnsProjection;
|
|
3951
4834
|
/**
|
|
3952
4835
|
* The consistency level for this request.
|
|
3953
4836
|
*
|
|
@@ -4611,25 +5494,40 @@ type QueryTableVariables = {
|
|
|
4611
5494
|
* }
|
|
4612
5495
|
* ```
|
|
4613
5496
|
*
|
|
4614
|
-
*
|
|
5497
|
+
* It is also possible to sort results randomly:
|
|
5498
|
+
*
|
|
5499
|
+
* ```json
|
|
5500
|
+
* POST /db/demo:main/tables/table/query
|
|
5501
|
+
* {
|
|
5502
|
+
* "sort": {
|
|
5503
|
+
* "*": "random"
|
|
5504
|
+
* }
|
|
5505
|
+
* }
|
|
5506
|
+
* ```
|
|
4615
5507
|
*
|
|
4616
|
-
*
|
|
4617
|
-
* cursor pagination is needed in order to retrieve all of their results. The offset pagination method is limited to 1000 records.
|
|
5508
|
+
* Note that a random sort does not apply to a specific column, hence the special column name `"*"`.
|
|
4618
5509
|
*
|
|
4619
|
-
*
|
|
5510
|
+
* A random sort can be combined with an ascending or descending sort on a specific column:
|
|
4620
5511
|
*
|
|
4621
5512
|
* ```json
|
|
4622
5513
|
* POST /db/demo:main/tables/table/query
|
|
4623
5514
|
* {
|
|
4624
|
-
* "
|
|
4625
|
-
*
|
|
4626
|
-
*
|
|
4627
|
-
*
|
|
5515
|
+
* "sort": [
|
|
5516
|
+
* {
|
|
5517
|
+
* "name": "desc"
|
|
5518
|
+
* },
|
|
5519
|
+
* {
|
|
5520
|
+
* "*": "random"
|
|
5521
|
+
* }
|
|
5522
|
+
* ]
|
|
4628
5523
|
* }
|
|
4629
5524
|
* ```
|
|
4630
5525
|
*
|
|
4631
|
-
*
|
|
4632
|
-
*
|
|
5526
|
+
* This will sort on the `name` column, breaking ties randomly.
|
|
5527
|
+
*
|
|
5528
|
+
* ### Pagination
|
|
5529
|
+
*
|
|
5530
|
+
* We offer cursor pagination and offset pagination. The cursor pagination method can be used for sequential scrolling with unrestricted depth. The offset pagination can be used to skip pages and is limited to 1000 records.
|
|
4633
5531
|
*
|
|
4634
5532
|
* Example of cursor pagination:
|
|
4635
5533
|
*
|
|
@@ -4683,18 +5581,46 @@ type QueryTableVariables = {
|
|
|
4683
5581
|
* `filter` or `sort` is set. The columns returned and page size can be changed
|
|
4684
5582
|
* anytime by passing the `columns` or `page.size` settings to the next query.
|
|
4685
5583
|
*
|
|
5584
|
+
* In the following example of size + offset pagination we retrieve the third page of up to 100 results:
|
|
5585
|
+
*
|
|
5586
|
+
* ```json
|
|
5587
|
+
* POST /db/demo:main/tables/table/query
|
|
5588
|
+
* {
|
|
5589
|
+
* "page": {
|
|
5590
|
+
* "size": 100,
|
|
5591
|
+
* "offset": 200
|
|
5592
|
+
* }
|
|
5593
|
+
* }
|
|
5594
|
+
* ```
|
|
5595
|
+
*
|
|
5596
|
+
* The `page.size` parameter represents the maximum number of records returned by this query. It has a default value of 20 and a maximum value of 200.
|
|
5597
|
+
* The `page.offset` parameter represents the number of matching records to skip. It has a default value of 0 and a maximum value of 800.
|
|
5598
|
+
*
|
|
5599
|
+
* Cursor pagination also works in combination with offset pagination. For example, starting from a specific cursor position, using a page size of 200 and an offset of 800, you can skip up to 5 pages of 200 records forwards or backwards from the cursor's position:
|
|
5600
|
+
*
|
|
5601
|
+
* ```json
|
|
5602
|
+
* POST /db/demo:main/tables/table/query
|
|
5603
|
+
* {
|
|
5604
|
+
* "page": {
|
|
5605
|
+
* "size": 200,
|
|
5606
|
+
* "offset": 800,
|
|
5607
|
+
* "after": "fMoxCsIwFIDh3WP8c4amDai5hO5SJCRNfaVSeC9b6d1FD"
|
|
5608
|
+
* }
|
|
5609
|
+
* }
|
|
5610
|
+
* ```
|
|
5611
|
+
*
|
|
4686
5612
|
* **Special cursors:**
|
|
4687
5613
|
*
|
|
4688
5614
|
* - `page.after=end`: Result points past the last entry. The list of records
|
|
4689
5615
|
* returned is empty, but `page.meta.cursor` will include a cursor that can be
|
|
4690
5616
|
* used to "tail" the table from the end waiting for new data to be inserted.
|
|
4691
5617
|
* - `page.before=end`: This cursor returns the last page.
|
|
4692
|
-
* - `page.start
|
|
5618
|
+
* - `page.start=$cursor`: Start at the beginning of the result set of the $cursor query. This is equivalent to querying the
|
|
4693
5619
|
* first page without a cursor but applying `filter` and `sort` . Yet the `page.start`
|
|
4694
5620
|
* cursor can be convenient at times as user code does not need to remember the
|
|
4695
5621
|
* filter, sort, columns or page size configuration. All these information are
|
|
4696
5622
|
* read from the cursor.
|
|
4697
|
-
* - `page.end
|
|
5623
|
+
* - `page.end=$cursor`: Move to the end of the result set of the $cursor query. This is equivalent to querying the
|
|
4698
5624
|
* last page with `page.before=end`, `filter`, and `sort` . Yet the
|
|
4699
5625
|
* `page.end` cursor can be more convenient at times as user code does not
|
|
4700
5626
|
* need to remember the filter, sort, columns or page size configuration. All
|
|
@@ -4733,6 +5659,9 @@ type SearchBranchError = ErrorWrapper<{
|
|
|
4733
5659
|
} | {
|
|
4734
5660
|
status: 404;
|
|
4735
5661
|
payload: SimpleError;
|
|
5662
|
+
} | {
|
|
5663
|
+
status: 503;
|
|
5664
|
+
payload: ServiceUnavailableError;
|
|
4736
5665
|
}>;
|
|
4737
5666
|
type SearchBranchRequestBody = {
|
|
4738
5667
|
/**
|
|
@@ -4815,46 +5744,6 @@ type SearchTableVariables = {
|
|
|
4815
5744
|
* * filtering on columns of type `multiple` is currently unsupported
|
|
4816
5745
|
*/
|
|
4817
5746
|
declare const searchTable: (variables: SearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
|
4818
|
-
type SqlQueryPathParams = {
|
|
4819
|
-
/**
|
|
4820
|
-
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
|
4821
|
-
*/
|
|
4822
|
-
dbBranchName: DBBranchName;
|
|
4823
|
-
workspace: string;
|
|
4824
|
-
region: string;
|
|
4825
|
-
};
|
|
4826
|
-
type SqlQueryError = ErrorWrapper<{
|
|
4827
|
-
status: 400;
|
|
4828
|
-
payload: BadRequestError;
|
|
4829
|
-
} | {
|
|
4830
|
-
status: 401;
|
|
4831
|
-
payload: AuthError;
|
|
4832
|
-
} | {
|
|
4833
|
-
status: 404;
|
|
4834
|
-
payload: SimpleError;
|
|
4835
|
-
}>;
|
|
4836
|
-
type SqlQueryRequestBody = {
|
|
4837
|
-
/**
|
|
4838
|
-
* The query string.
|
|
4839
|
-
*
|
|
4840
|
-
* @minLength 1
|
|
4841
|
-
*/
|
|
4842
|
-
query: string;
|
|
4843
|
-
/**
|
|
4844
|
-
* The consistency level for this request.
|
|
4845
|
-
*
|
|
4846
|
-
* @default strong
|
|
4847
|
-
*/
|
|
4848
|
-
consistency?: 'strong' | 'eventual';
|
|
4849
|
-
};
|
|
4850
|
-
type SqlQueryVariables = {
|
|
4851
|
-
body: SqlQueryRequestBody;
|
|
4852
|
-
pathParams: SqlQueryPathParams;
|
|
4853
|
-
} & DataPlaneFetcherExtraProps;
|
|
4854
|
-
/**
|
|
4855
|
-
* Run an SQL query across the database branch.
|
|
4856
|
-
*/
|
|
4857
|
-
declare const sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<QueryResponse>;
|
|
4858
5747
|
type VectorSearchTablePathParams = {
|
|
4859
5748
|
/**
|
|
4860
5749
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
|
@@ -4944,7 +5833,11 @@ type AskTableResponse = {
|
|
|
4944
5833
|
/**
|
|
4945
5834
|
* The answer to the input question
|
|
4946
5835
|
*/
|
|
4947
|
-
answer
|
|
5836
|
+
answer: string;
|
|
5837
|
+
/**
|
|
5838
|
+
* The session ID for the chat session.
|
|
5839
|
+
*/
|
|
5840
|
+
sessionId: string;
|
|
4948
5841
|
};
|
|
4949
5842
|
type AskTableRequestBody = {
|
|
4950
5843
|
/**
|
|
@@ -4991,14 +5884,69 @@ type AskTableRequestBody = {
|
|
|
4991
5884
|
};
|
|
4992
5885
|
rules?: string[];
|
|
4993
5886
|
};
|
|
4994
|
-
type AskTableVariables = {
|
|
4995
|
-
body: AskTableRequestBody;
|
|
4996
|
-
pathParams: AskTablePathParams;
|
|
5887
|
+
type AskTableVariables = {
|
|
5888
|
+
body: AskTableRequestBody;
|
|
5889
|
+
pathParams: AskTablePathParams;
|
|
5890
|
+
} & DataPlaneFetcherExtraProps;
|
|
5891
|
+
/**
|
|
5892
|
+
* Ask your table a question. If the `Accept` header is set to `text/event-stream`, Xata will stream the results back as SSE's.
|
|
5893
|
+
*/
|
|
5894
|
+
declare const askTable: (variables: AskTableVariables, signal?: AbortSignal) => Promise<AskTableResponse>;
|
|
5895
|
+
type AskTableSessionPathParams = {
|
|
5896
|
+
/**
|
|
5897
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
|
5898
|
+
*/
|
|
5899
|
+
dbBranchName: DBBranchName;
|
|
5900
|
+
/**
|
|
5901
|
+
* The Table name
|
|
5902
|
+
*/
|
|
5903
|
+
tableName: TableName;
|
|
5904
|
+
/**
|
|
5905
|
+
* @maxLength 36
|
|
5906
|
+
* @minLength 36
|
|
5907
|
+
*/
|
|
5908
|
+
sessionId: string;
|
|
5909
|
+
workspace: string;
|
|
5910
|
+
region: string;
|
|
5911
|
+
};
|
|
5912
|
+
type AskTableSessionError = ErrorWrapper<{
|
|
5913
|
+
status: 400;
|
|
5914
|
+
payload: BadRequestError;
|
|
5915
|
+
} | {
|
|
5916
|
+
status: 401;
|
|
5917
|
+
payload: AuthError;
|
|
5918
|
+
} | {
|
|
5919
|
+
status: 404;
|
|
5920
|
+
payload: SimpleError;
|
|
5921
|
+
} | {
|
|
5922
|
+
status: 429;
|
|
5923
|
+
payload: RateLimitError;
|
|
5924
|
+
} | {
|
|
5925
|
+
status: 503;
|
|
5926
|
+
payload: ServiceUnavailableError;
|
|
5927
|
+
}>;
|
|
5928
|
+
type AskTableSessionResponse = {
|
|
5929
|
+
/**
|
|
5930
|
+
* The answer to the input question
|
|
5931
|
+
*/
|
|
5932
|
+
answer: string;
|
|
5933
|
+
};
|
|
5934
|
+
type AskTableSessionRequestBody = {
|
|
5935
|
+
/**
|
|
5936
|
+
* The question you'd like to ask.
|
|
5937
|
+
*
|
|
5938
|
+
* @minLength 3
|
|
5939
|
+
*/
|
|
5940
|
+
message?: string;
|
|
5941
|
+
};
|
|
5942
|
+
type AskTableSessionVariables = {
|
|
5943
|
+
body?: AskTableSessionRequestBody;
|
|
5944
|
+
pathParams: AskTableSessionPathParams;
|
|
4997
5945
|
} & DataPlaneFetcherExtraProps;
|
|
4998
5946
|
/**
|
|
4999
|
-
* Ask
|
|
5947
|
+
* Ask a follow-up question. If the `Accept` header is set to `text/event-stream`, Xata will stream the results back as SSE's.
|
|
5000
5948
|
*/
|
|
5001
|
-
declare const
|
|
5949
|
+
declare const askTableSession: (variables: AskTableSessionVariables, signal?: AbortSignal) => Promise<AskTableSessionResponse>;
|
|
5002
5950
|
type SummarizeTablePathParams = {
|
|
5003
5951
|
/**
|
|
5004
5952
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
|
@@ -5155,6 +6103,85 @@ type AggregateTableVariables = {
|
|
|
5155
6103
|
* For usage, see the [API Guide](https://xata.io/docs/api-guide/aggregate).
|
|
5156
6104
|
*/
|
|
5157
6105
|
declare const aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal) => Promise<AggResponse>;
|
|
6106
|
+
type FileAccessPathParams = {
|
|
6107
|
+
/**
|
|
6108
|
+
* The File Access Identifier
|
|
6109
|
+
*/
|
|
6110
|
+
fileId: FileAccessID;
|
|
6111
|
+
workspace: string;
|
|
6112
|
+
region: string;
|
|
6113
|
+
};
|
|
6114
|
+
type FileAccessQueryParams = {
|
|
6115
|
+
/**
|
|
6116
|
+
* File access signature
|
|
6117
|
+
*/
|
|
6118
|
+
verify?: FileSignature;
|
|
6119
|
+
};
|
|
6120
|
+
type FileAccessError = ErrorWrapper<{
|
|
6121
|
+
status: 400;
|
|
6122
|
+
payload: BadRequestError;
|
|
6123
|
+
} | {
|
|
6124
|
+
status: 401;
|
|
6125
|
+
payload: AuthError;
|
|
6126
|
+
} | {
|
|
6127
|
+
status: 404;
|
|
6128
|
+
payload: SimpleError;
|
|
6129
|
+
}>;
|
|
6130
|
+
type FileAccessVariables = {
|
|
6131
|
+
pathParams: FileAccessPathParams;
|
|
6132
|
+
queryParams?: FileAccessQueryParams;
|
|
6133
|
+
} & DataPlaneFetcherExtraProps;
|
|
6134
|
+
/**
|
|
6135
|
+
* Retrieve file content by access id
|
|
6136
|
+
*/
|
|
6137
|
+
declare const fileAccess: (variables: FileAccessVariables, signal?: AbortSignal) => Promise<Blob>;
|
|
6138
|
+
type SqlQueryPathParams = {
|
|
6139
|
+
/**
|
|
6140
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
|
6141
|
+
*/
|
|
6142
|
+
dbBranchName: DBBranchName;
|
|
6143
|
+
workspace: string;
|
|
6144
|
+
region: string;
|
|
6145
|
+
};
|
|
6146
|
+
type SqlQueryError = ErrorWrapper<{
|
|
6147
|
+
status: 400;
|
|
6148
|
+
payload: BadRequestError;
|
|
6149
|
+
} | {
|
|
6150
|
+
status: 401;
|
|
6151
|
+
payload: AuthError;
|
|
6152
|
+
} | {
|
|
6153
|
+
status: 404;
|
|
6154
|
+
payload: SimpleError;
|
|
6155
|
+
} | {
|
|
6156
|
+
status: 503;
|
|
6157
|
+
payload: ServiceUnavailableError;
|
|
6158
|
+
}>;
|
|
6159
|
+
type SqlQueryRequestBody = {
|
|
6160
|
+
/**
|
|
6161
|
+
* The SQL statement.
|
|
6162
|
+
*
|
|
6163
|
+
* @minLength 1
|
|
6164
|
+
*/
|
|
6165
|
+
statement: string;
|
|
6166
|
+
/**
|
|
6167
|
+
* The query parameter list.
|
|
6168
|
+
*/
|
|
6169
|
+
params?: any[] | null;
|
|
6170
|
+
/**
|
|
6171
|
+
* The consistency level for this request.
|
|
6172
|
+
*
|
|
6173
|
+
* @default strong
|
|
6174
|
+
*/
|
|
6175
|
+
consistency?: 'strong' | 'eventual';
|
|
6176
|
+
};
|
|
6177
|
+
type SqlQueryVariables = {
|
|
6178
|
+
body: SqlQueryRequestBody;
|
|
6179
|
+
pathParams: SqlQueryPathParams;
|
|
6180
|
+
} & DataPlaneFetcherExtraProps;
|
|
6181
|
+
/**
|
|
6182
|
+
* Run an SQL query across the database branch.
|
|
6183
|
+
*/
|
|
6184
|
+
declare const sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<SQLResponse>;
|
|
5158
6185
|
|
|
5159
6186
|
declare const operationsByTag: {
|
|
5160
6187
|
branch: {
|
|
@@ -5215,16 +6242,37 @@ declare const operationsByTag: {
|
|
|
5215
6242
|
updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
|
5216
6243
|
deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
|
5217
6244
|
};
|
|
6245
|
+
files: {
|
|
6246
|
+
getFileItem: (variables: GetFileItemVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
|
|
6247
|
+
putFileItem: (variables: PutFileItemVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
|
|
6248
|
+
deleteFileItem: (variables: DeleteFileItemVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
|
|
6249
|
+
getFile: (variables: GetFileVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
|
|
6250
|
+
putFile: (variables: PutFileVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
|
|
6251
|
+
deleteFile: (variables: DeleteFileVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
|
|
6252
|
+
fileAccess: (variables: FileAccessVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
|
|
6253
|
+
};
|
|
5218
6254
|
searchAndFilter: {
|
|
5219
6255
|
queryTable: (variables: QueryTableVariables, signal?: AbortSignal | undefined) => Promise<QueryResponse>;
|
|
5220
6256
|
searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
|
|
5221
6257
|
searchTable: (variables: SearchTableVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
|
|
5222
|
-
sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal | undefined) => Promise<QueryResponse>;
|
|
5223
6258
|
vectorSearchTable: (variables: VectorSearchTableVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
|
|
5224
6259
|
askTable: (variables: AskTableVariables, signal?: AbortSignal | undefined) => Promise<AskTableResponse>;
|
|
6260
|
+
askTableSession: (variables: AskTableSessionVariables, signal?: AbortSignal | undefined) => Promise<AskTableSessionResponse>;
|
|
5225
6261
|
summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal | undefined) => Promise<SummarizeResponse>;
|
|
5226
6262
|
aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal | undefined) => Promise<AggResponse>;
|
|
5227
6263
|
};
|
|
6264
|
+
sql: {
|
|
6265
|
+
sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal | undefined) => Promise<SQLResponse>;
|
|
6266
|
+
};
|
|
6267
|
+
oAuth: {
|
|
6268
|
+
getAuthorizationCode: (variables: GetAuthorizationCodeVariables, signal?: AbortSignal | undefined) => Promise<AuthorizationCodeResponse>;
|
|
6269
|
+
grantAuthorizationCode: (variables: GrantAuthorizationCodeVariables, signal?: AbortSignal | undefined) => Promise<AuthorizationCodeResponse>;
|
|
6270
|
+
getUserOAuthClients: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetUserOAuthClientsResponse>;
|
|
6271
|
+
deleteUserOAuthClient: (variables: DeleteUserOAuthClientVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
|
6272
|
+
getUserOAuthAccessTokens: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetUserOAuthAccessTokensResponse>;
|
|
6273
|
+
deleteOAuthAccessToken: (variables: DeleteOAuthAccessTokenVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
|
6274
|
+
updateOAuthAccessToken: (variables: UpdateOAuthAccessTokenVariables, signal?: AbortSignal | undefined) => Promise<OAuthAccessToken>;
|
|
6275
|
+
};
|
|
5228
6276
|
users: {
|
|
5229
6277
|
getUser: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<UserWithID>;
|
|
5230
6278
|
updateUser: (variables: UpdateUserVariables, signal?: AbortSignal | undefined) => Promise<UserWithID>;
|
|
@@ -5252,12 +6300,19 @@ declare const operationsByTag: {
|
|
|
5252
6300
|
acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
|
5253
6301
|
resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
|
5254
6302
|
};
|
|
6303
|
+
xbcontrolOther: {
|
|
6304
|
+
listClusters: (variables: ListClustersVariables, signal?: AbortSignal | undefined) => Promise<ListClustersResponse>;
|
|
6305
|
+
createCluster: (variables: CreateClusterVariables, signal?: AbortSignal | undefined) => Promise<ClusterResponse>;
|
|
6306
|
+
getCluster: (variables: GetClusterVariables, signal?: AbortSignal | undefined) => Promise<ClusterMetadata>;
|
|
6307
|
+
updateCluster: (variables: UpdateClusterVariables, signal?: AbortSignal | undefined) => Promise<ClusterMetadata>;
|
|
6308
|
+
};
|
|
5255
6309
|
databases: {
|
|
5256
6310
|
getDatabaseList: (variables: GetDatabaseListVariables, signal?: AbortSignal | undefined) => Promise<ListDatabasesResponse>;
|
|
5257
6311
|
createDatabase: (variables: CreateDatabaseVariables, signal?: AbortSignal | undefined) => Promise<CreateDatabaseResponse>;
|
|
5258
6312
|
deleteDatabase: (variables: DeleteDatabaseVariables, signal?: AbortSignal | undefined) => Promise<DeleteDatabaseResponse>;
|
|
5259
6313
|
getDatabaseMetadata: (variables: GetDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
|
|
5260
6314
|
updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
|
|
6315
|
+
renameDatabase: (variables: RenameDatabaseVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
|
|
5261
6316
|
getDatabaseGithubSettings: (variables: GetDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<DatabaseGithubSettings>;
|
|
5262
6317
|
updateDatabaseGithubSettings: (variables: UpdateDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<DatabaseGithubSettings>;
|
|
5263
6318
|
deleteDatabaseGithubSettings: (variables: DeleteDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
|
@@ -5287,38 +6342,29 @@ type responses_BadRequestError = BadRequestError;
|
|
|
5287
6342
|
type responses_BranchMigrationPlan = BranchMigrationPlan;
|
|
5288
6343
|
type responses_BulkError = BulkError;
|
|
5289
6344
|
type responses_BulkInsertResponse = BulkInsertResponse;
|
|
6345
|
+
type responses_PutFileResponse = PutFileResponse;
|
|
5290
6346
|
type responses_QueryResponse = QueryResponse;
|
|
5291
6347
|
type responses_RateLimitError = RateLimitError;
|
|
5292
6348
|
type responses_RecordResponse = RecordResponse;
|
|
5293
6349
|
type responses_RecordUpdateResponse = RecordUpdateResponse;
|
|
6350
|
+
type responses_SQLResponse = SQLResponse;
|
|
5294
6351
|
type responses_SchemaCompareResponse = SchemaCompareResponse;
|
|
5295
6352
|
type responses_SchemaUpdateResponse = SchemaUpdateResponse;
|
|
5296
6353
|
type responses_SearchResponse = SearchResponse;
|
|
6354
|
+
type responses_ServiceUnavailableError = ServiceUnavailableError;
|
|
5297
6355
|
type responses_SimpleError = SimpleError;
|
|
5298
6356
|
type responses_SummarizeResponse = SummarizeResponse;
|
|
5299
6357
|
declare namespace responses {
|
|
5300
|
-
export {
|
|
5301
|
-
responses_AggResponse as AggResponse,
|
|
5302
|
-
responses_AuthError as AuthError,
|
|
5303
|
-
responses_BadRequestError as BadRequestError,
|
|
5304
|
-
responses_BranchMigrationPlan as BranchMigrationPlan,
|
|
5305
|
-
responses_BulkError as BulkError,
|
|
5306
|
-
responses_BulkInsertResponse as BulkInsertResponse,
|
|
5307
|
-
responses_QueryResponse as QueryResponse,
|
|
5308
|
-
responses_RateLimitError as RateLimitError,
|
|
5309
|
-
responses_RecordResponse as RecordResponse,
|
|
5310
|
-
responses_RecordUpdateResponse as RecordUpdateResponse,
|
|
5311
|
-
responses_SchemaCompareResponse as SchemaCompareResponse,
|
|
5312
|
-
responses_SchemaUpdateResponse as SchemaUpdateResponse,
|
|
5313
|
-
responses_SearchResponse as SearchResponse,
|
|
5314
|
-
responses_SimpleError as SimpleError,
|
|
5315
|
-
responses_SummarizeResponse as SummarizeResponse,
|
|
5316
|
-
};
|
|
6358
|
+
export type { responses_AggResponse as AggResponse, responses_AuthError as AuthError, responses_BadRequestError as BadRequestError, responses_BranchMigrationPlan as BranchMigrationPlan, responses_BulkError as BulkError, responses_BulkInsertResponse as BulkInsertResponse, responses_PutFileResponse as PutFileResponse, responses_QueryResponse as QueryResponse, responses_RateLimitError as RateLimitError, responses_RecordResponse as RecordResponse, responses_RecordUpdateResponse as RecordUpdateResponse, responses_SQLResponse as SQLResponse, responses_SchemaCompareResponse as SchemaCompareResponse, responses_SchemaUpdateResponse as SchemaUpdateResponse, responses_SearchResponse as SearchResponse, responses_ServiceUnavailableError as ServiceUnavailableError, responses_SimpleError as SimpleError, responses_SummarizeResponse as SummarizeResponse };
|
|
5317
6359
|
}
|
|
5318
6360
|
|
|
5319
6361
|
type schemas_APIKeyName = APIKeyName;
|
|
6362
|
+
type schemas_AccessToken = AccessToken;
|
|
5320
6363
|
type schemas_AggExpression = AggExpression;
|
|
5321
6364
|
type schemas_AggExpressionMap = AggExpressionMap;
|
|
6365
|
+
type schemas_AuthorizationCodeRequest = AuthorizationCodeRequest;
|
|
6366
|
+
type schemas_AuthorizationCodeResponse = AuthorizationCodeResponse;
|
|
6367
|
+
type schemas_AutoscalingConfig = AutoscalingConfig;
|
|
5322
6368
|
type schemas_AverageAgg = AverageAgg;
|
|
5323
6369
|
type schemas_BoosterExpression = BoosterExpression;
|
|
5324
6370
|
type schemas_Branch = Branch;
|
|
@@ -5327,7 +6373,15 @@ type schemas_BranchMigration = BranchMigration;
|
|
|
5327
6373
|
type schemas_BranchName = BranchName;
|
|
5328
6374
|
type schemas_BranchOp = BranchOp;
|
|
5329
6375
|
type schemas_BranchWithCopyID = BranchWithCopyID;
|
|
6376
|
+
type schemas_ClusterConfiguration = ClusterConfiguration;
|
|
6377
|
+
type schemas_ClusterCreateDetails = ClusterCreateDetails;
|
|
6378
|
+
type schemas_ClusterID = ClusterID;
|
|
6379
|
+
type schemas_ClusterMetadata = ClusterMetadata;
|
|
6380
|
+
type schemas_ClusterResponse = ClusterResponse;
|
|
6381
|
+
type schemas_ClusterShortMetadata = ClusterShortMetadata;
|
|
6382
|
+
type schemas_ClusterUpdateDetails = ClusterUpdateDetails;
|
|
5330
6383
|
type schemas_Column = Column;
|
|
6384
|
+
type schemas_ColumnFile = ColumnFile;
|
|
5331
6385
|
type schemas_ColumnLink = ColumnLink;
|
|
5332
6386
|
type schemas_ColumnMigration = ColumnMigration;
|
|
5333
6387
|
type schemas_ColumnName = ColumnName;
|
|
@@ -5346,6 +6400,11 @@ type schemas_DatabaseGithubSettings = DatabaseGithubSettings;
|
|
|
5346
6400
|
type schemas_DatabaseMetadata = DatabaseMetadata;
|
|
5347
6401
|
type schemas_DateHistogramAgg = DateHistogramAgg;
|
|
5348
6402
|
type schemas_DateTime = DateTime;
|
|
6403
|
+
type schemas_FileAccessID = FileAccessID;
|
|
6404
|
+
type schemas_FileItemID = FileItemID;
|
|
6405
|
+
type schemas_FileName = FileName;
|
|
6406
|
+
type schemas_FileResponse = FileResponse;
|
|
6407
|
+
type schemas_FileSignature = FileSignature;
|
|
5349
6408
|
type schemas_FilterColumn = FilterColumn;
|
|
5350
6409
|
type schemas_FilterColumnIncludes = FilterColumnIncludes;
|
|
5351
6410
|
type schemas_FilterExpression = FilterExpression;
|
|
@@ -5357,15 +6416,19 @@ type schemas_FilterRangeValue = FilterRangeValue;
|
|
|
5357
6416
|
type schemas_FilterValue = FilterValue;
|
|
5358
6417
|
type schemas_FuzzinessExpression = FuzzinessExpression;
|
|
5359
6418
|
type schemas_HighlightExpression = HighlightExpression;
|
|
6419
|
+
type schemas_InputFile = InputFile;
|
|
5360
6420
|
type schemas_InputFileArray = InputFileArray;
|
|
5361
6421
|
type schemas_InputFileEntry = InputFileEntry;
|
|
5362
6422
|
type schemas_InviteID = InviteID;
|
|
5363
6423
|
type schemas_InviteKey = InviteKey;
|
|
5364
6424
|
type schemas_ListBranchesResponse = ListBranchesResponse;
|
|
6425
|
+
type schemas_ListClustersResponse = ListClustersResponse;
|
|
5365
6426
|
type schemas_ListDatabasesResponse = ListDatabasesResponse;
|
|
5366
6427
|
type schemas_ListGitBranchesResponse = ListGitBranchesResponse;
|
|
5367
6428
|
type schemas_ListRegionsResponse = ListRegionsResponse;
|
|
6429
|
+
type schemas_MaintenanceConfig = MaintenanceConfig;
|
|
5368
6430
|
type schemas_MaxAgg = MaxAgg;
|
|
6431
|
+
type schemas_MediaType = MediaType;
|
|
5369
6432
|
type schemas_MetricsDatapoint = MetricsDatapoint;
|
|
5370
6433
|
type schemas_MetricsLatency = MetricsLatency;
|
|
5371
6434
|
type schemas_Migration = Migration;
|
|
@@ -5378,15 +6441,24 @@ type schemas_MigrationStatus = MigrationStatus;
|
|
|
5378
6441
|
type schemas_MigrationTableOp = MigrationTableOp;
|
|
5379
6442
|
type schemas_MinAgg = MinAgg;
|
|
5380
6443
|
type schemas_NumericHistogramAgg = NumericHistogramAgg;
|
|
6444
|
+
type schemas_OAuthAccessToken = OAuthAccessToken;
|
|
6445
|
+
type schemas_OAuthClientID = OAuthClientID;
|
|
6446
|
+
type schemas_OAuthClientPublicDetails = OAuthClientPublicDetails;
|
|
6447
|
+
type schemas_OAuthResponseType = OAuthResponseType;
|
|
6448
|
+
type schemas_OAuthScope = OAuthScope;
|
|
5381
6449
|
type schemas_ObjectValue = ObjectValue;
|
|
5382
6450
|
type schemas_PageConfig = PageConfig;
|
|
6451
|
+
type schemas_PercentilesAgg = PercentilesAgg;
|
|
5383
6452
|
type schemas_PrefixExpression = PrefixExpression;
|
|
6453
|
+
type schemas_ProjectionConfig = ProjectionConfig;
|
|
6454
|
+
type schemas_QueryColumnsProjection = QueryColumnsProjection;
|
|
5384
6455
|
type schemas_RecordID = RecordID;
|
|
5385
6456
|
type schemas_RecordMeta = RecordMeta;
|
|
5386
6457
|
type schemas_RecordsMetadata = RecordsMetadata;
|
|
5387
6458
|
type schemas_Region = Region;
|
|
5388
6459
|
type schemas_RevLink = RevLink;
|
|
5389
6460
|
type schemas_Role = Role;
|
|
6461
|
+
type schemas_SQLRecord = SQLRecord;
|
|
5390
6462
|
type schemas_Schema = Schema;
|
|
5391
6463
|
type schemas_SchemaEditScript = SchemaEditScript;
|
|
5392
6464
|
type schemas_SearchPageConfig = SearchPageConfig;
|
|
@@ -5408,9 +6480,11 @@ type schemas_TopValuesAgg = TopValuesAgg;
|
|
|
5408
6480
|
type schemas_TransactionDeleteOp = TransactionDeleteOp;
|
|
5409
6481
|
type schemas_TransactionError = TransactionError;
|
|
5410
6482
|
type schemas_TransactionFailure = TransactionFailure;
|
|
6483
|
+
type schemas_TransactionGetOp = TransactionGetOp;
|
|
5411
6484
|
type schemas_TransactionInsertOp = TransactionInsertOp;
|
|
5412
6485
|
type schemas_TransactionResultColumns = TransactionResultColumns;
|
|
5413
6486
|
type schemas_TransactionResultDelete = TransactionResultDelete;
|
|
6487
|
+
type schemas_TransactionResultGet = TransactionResultGet;
|
|
5414
6488
|
type schemas_TransactionResultInsert = TransactionResultInsert;
|
|
5415
6489
|
type schemas_TransactionResultUpdate = TransactionResultUpdate;
|
|
5416
6490
|
type schemas_TransactionSuccess = TransactionSuccess;
|
|
@@ -5426,123 +6500,7 @@ type schemas_WorkspaceMember = WorkspaceMember;
|
|
|
5426
6500
|
type schemas_WorkspaceMembers = WorkspaceMembers;
|
|
5427
6501
|
type schemas_WorkspaceMeta = WorkspaceMeta;
|
|
5428
6502
|
declare namespace schemas {
|
|
5429
|
-
export {
|
|
5430
|
-
schemas_APIKeyName as APIKeyName,
|
|
5431
|
-
schemas_AggExpression as AggExpression,
|
|
5432
|
-
schemas_AggExpressionMap as AggExpressionMap,
|
|
5433
|
-
AggResponse$1 as AggResponse,
|
|
5434
|
-
schemas_AverageAgg as AverageAgg,
|
|
5435
|
-
schemas_BoosterExpression as BoosterExpression,
|
|
5436
|
-
schemas_Branch as Branch,
|
|
5437
|
-
schemas_BranchMetadata as BranchMetadata,
|
|
5438
|
-
schemas_BranchMigration as BranchMigration,
|
|
5439
|
-
schemas_BranchName as BranchName,
|
|
5440
|
-
schemas_BranchOp as BranchOp,
|
|
5441
|
-
schemas_BranchWithCopyID as BranchWithCopyID,
|
|
5442
|
-
schemas_Column as Column,
|
|
5443
|
-
schemas_ColumnLink as ColumnLink,
|
|
5444
|
-
schemas_ColumnMigration as ColumnMigration,
|
|
5445
|
-
schemas_ColumnName as ColumnName,
|
|
5446
|
-
schemas_ColumnOpAdd as ColumnOpAdd,
|
|
5447
|
-
schemas_ColumnOpRemove as ColumnOpRemove,
|
|
5448
|
-
schemas_ColumnOpRename as ColumnOpRename,
|
|
5449
|
-
schemas_ColumnVector as ColumnVector,
|
|
5450
|
-
schemas_ColumnsProjection as ColumnsProjection,
|
|
5451
|
-
schemas_Commit as Commit,
|
|
5452
|
-
schemas_CountAgg as CountAgg,
|
|
5453
|
-
schemas_DBBranch as DBBranch,
|
|
5454
|
-
schemas_DBBranchName as DBBranchName,
|
|
5455
|
-
schemas_DBName as DBName,
|
|
5456
|
-
schemas_DataInputRecord as DataInputRecord,
|
|
5457
|
-
schemas_DatabaseGithubSettings as DatabaseGithubSettings,
|
|
5458
|
-
schemas_DatabaseMetadata as DatabaseMetadata,
|
|
5459
|
-
DateBooster$1 as DateBooster,
|
|
5460
|
-
schemas_DateHistogramAgg as DateHistogramAgg,
|
|
5461
|
-
schemas_DateTime as DateTime,
|
|
5462
|
-
schemas_FilterColumn as FilterColumn,
|
|
5463
|
-
schemas_FilterColumnIncludes as FilterColumnIncludes,
|
|
5464
|
-
schemas_FilterExpression as FilterExpression,
|
|
5465
|
-
schemas_FilterList as FilterList,
|
|
5466
|
-
schemas_FilterPredicate as FilterPredicate,
|
|
5467
|
-
schemas_FilterPredicateOp as FilterPredicateOp,
|
|
5468
|
-
schemas_FilterPredicateRangeOp as FilterPredicateRangeOp,
|
|
5469
|
-
schemas_FilterRangeValue as FilterRangeValue,
|
|
5470
|
-
schemas_FilterValue as FilterValue,
|
|
5471
|
-
schemas_FuzzinessExpression as FuzzinessExpression,
|
|
5472
|
-
schemas_HighlightExpression as HighlightExpression,
|
|
5473
|
-
schemas_InputFileArray as InputFileArray,
|
|
5474
|
-
schemas_InputFileEntry as InputFileEntry,
|
|
5475
|
-
schemas_InviteID as InviteID,
|
|
5476
|
-
schemas_InviteKey as InviteKey,
|
|
5477
|
-
schemas_ListBranchesResponse as ListBranchesResponse,
|
|
5478
|
-
schemas_ListDatabasesResponse as ListDatabasesResponse,
|
|
5479
|
-
schemas_ListGitBranchesResponse as ListGitBranchesResponse,
|
|
5480
|
-
schemas_ListRegionsResponse as ListRegionsResponse,
|
|
5481
|
-
schemas_MaxAgg as MaxAgg,
|
|
5482
|
-
schemas_MetricsDatapoint as MetricsDatapoint,
|
|
5483
|
-
schemas_MetricsLatency as MetricsLatency,
|
|
5484
|
-
schemas_Migration as Migration,
|
|
5485
|
-
schemas_MigrationColumnOp as MigrationColumnOp,
|
|
5486
|
-
schemas_MigrationObject as MigrationObject,
|
|
5487
|
-
schemas_MigrationOp as MigrationOp,
|
|
5488
|
-
schemas_MigrationRequest as MigrationRequest,
|
|
5489
|
-
schemas_MigrationRequestNumber as MigrationRequestNumber,
|
|
5490
|
-
schemas_MigrationStatus as MigrationStatus,
|
|
5491
|
-
schemas_MigrationTableOp as MigrationTableOp,
|
|
5492
|
-
schemas_MinAgg as MinAgg,
|
|
5493
|
-
NumericBooster$1 as NumericBooster,
|
|
5494
|
-
schemas_NumericHistogramAgg as NumericHistogramAgg,
|
|
5495
|
-
schemas_ObjectValue as ObjectValue,
|
|
5496
|
-
schemas_PageConfig as PageConfig,
|
|
5497
|
-
schemas_PrefixExpression as PrefixExpression,
|
|
5498
|
-
schemas_RecordID as RecordID,
|
|
5499
|
-
schemas_RecordMeta as RecordMeta,
|
|
5500
|
-
schemas_RecordsMetadata as RecordsMetadata,
|
|
5501
|
-
schemas_Region as Region,
|
|
5502
|
-
schemas_RevLink as RevLink,
|
|
5503
|
-
schemas_Role as Role,
|
|
5504
|
-
schemas_Schema as Schema,
|
|
5505
|
-
schemas_SchemaEditScript as SchemaEditScript,
|
|
5506
|
-
schemas_SearchPageConfig as SearchPageConfig,
|
|
5507
|
-
schemas_SortExpression as SortExpression,
|
|
5508
|
-
schemas_SortOrder as SortOrder,
|
|
5509
|
-
schemas_StartedFromMetadata as StartedFromMetadata,
|
|
5510
|
-
schemas_SumAgg as SumAgg,
|
|
5511
|
-
schemas_SummaryExpression as SummaryExpression,
|
|
5512
|
-
schemas_SummaryExpressionList as SummaryExpressionList,
|
|
5513
|
-
schemas_Table as Table,
|
|
5514
|
-
schemas_TableMigration as TableMigration,
|
|
5515
|
-
schemas_TableName as TableName,
|
|
5516
|
-
schemas_TableOpAdd as TableOpAdd,
|
|
5517
|
-
schemas_TableOpRemove as TableOpRemove,
|
|
5518
|
-
schemas_TableOpRename as TableOpRename,
|
|
5519
|
-
schemas_TableRename as TableRename,
|
|
5520
|
-
schemas_TargetExpression as TargetExpression,
|
|
5521
|
-
schemas_TopValuesAgg as TopValuesAgg,
|
|
5522
|
-
schemas_TransactionDeleteOp as TransactionDeleteOp,
|
|
5523
|
-
schemas_TransactionError as TransactionError,
|
|
5524
|
-
schemas_TransactionFailure as TransactionFailure,
|
|
5525
|
-
schemas_TransactionInsertOp as TransactionInsertOp,
|
|
5526
|
-
TransactionOperation$1 as TransactionOperation,
|
|
5527
|
-
schemas_TransactionResultColumns as TransactionResultColumns,
|
|
5528
|
-
schemas_TransactionResultDelete as TransactionResultDelete,
|
|
5529
|
-
schemas_TransactionResultInsert as TransactionResultInsert,
|
|
5530
|
-
schemas_TransactionResultUpdate as TransactionResultUpdate,
|
|
5531
|
-
schemas_TransactionSuccess as TransactionSuccess,
|
|
5532
|
-
schemas_TransactionUpdateOp as TransactionUpdateOp,
|
|
5533
|
-
schemas_UniqueCountAgg as UniqueCountAgg,
|
|
5534
|
-
schemas_User as User,
|
|
5535
|
-
schemas_UserID as UserID,
|
|
5536
|
-
schemas_UserWithID as UserWithID,
|
|
5537
|
-
ValueBooster$1 as ValueBooster,
|
|
5538
|
-
schemas_Workspace as Workspace,
|
|
5539
|
-
schemas_WorkspaceID as WorkspaceID,
|
|
5540
|
-
schemas_WorkspaceInvite as WorkspaceInvite,
|
|
5541
|
-
schemas_WorkspaceMember as WorkspaceMember,
|
|
5542
|
-
schemas_WorkspaceMembers as WorkspaceMembers,
|
|
5543
|
-
schemas_WorkspaceMeta as WorkspaceMeta,
|
|
5544
|
-
XataRecord$1 as XataRecord,
|
|
5545
|
-
};
|
|
6503
|
+
export type { schemas_APIKeyName as APIKeyName, schemas_AccessToken as AccessToken, schemas_AggExpression as AggExpression, schemas_AggExpressionMap as AggExpressionMap, AggResponse$1 as AggResponse, schemas_AuthorizationCodeRequest as AuthorizationCodeRequest, schemas_AuthorizationCodeResponse as AuthorizationCodeResponse, schemas_AutoscalingConfig as AutoscalingConfig, schemas_AverageAgg as AverageAgg, schemas_BoosterExpression as BoosterExpression, schemas_Branch as Branch, schemas_BranchMetadata as BranchMetadata, schemas_BranchMigration as BranchMigration, schemas_BranchName as BranchName, schemas_BranchOp as BranchOp, schemas_BranchWithCopyID as BranchWithCopyID, schemas_ClusterConfiguration as ClusterConfiguration, schemas_ClusterCreateDetails as ClusterCreateDetails, schemas_ClusterID as ClusterID, schemas_ClusterMetadata as ClusterMetadata, schemas_ClusterResponse as ClusterResponse, schemas_ClusterShortMetadata as ClusterShortMetadata, schemas_ClusterUpdateDetails as ClusterUpdateDetails, schemas_Column as Column, schemas_ColumnFile as ColumnFile, schemas_ColumnLink as ColumnLink, schemas_ColumnMigration as ColumnMigration, schemas_ColumnName as ColumnName, schemas_ColumnOpAdd as ColumnOpAdd, schemas_ColumnOpRemove as ColumnOpRemove, schemas_ColumnOpRename as ColumnOpRename, schemas_ColumnVector as ColumnVector, schemas_ColumnsProjection as ColumnsProjection, schemas_Commit as Commit, schemas_CountAgg as CountAgg, schemas_DBBranch as DBBranch, schemas_DBBranchName as DBBranchName, schemas_DBName as DBName, schemas_DataInputRecord as DataInputRecord, schemas_DatabaseGithubSettings as DatabaseGithubSettings, schemas_DatabaseMetadata as DatabaseMetadata, DateBooster$1 as DateBooster, schemas_DateHistogramAgg as DateHistogramAgg, schemas_DateTime as DateTime, schemas_FileAccessID as FileAccessID, schemas_FileItemID as FileItemID, schemas_FileName as FileName, schemas_FileResponse as FileResponse, schemas_FileSignature as FileSignature, schemas_FilterColumn as FilterColumn, schemas_FilterColumnIncludes as FilterColumnIncludes, schemas_FilterExpression as FilterExpression, schemas_FilterList as FilterList, schemas_FilterPredicate as FilterPredicate, schemas_FilterPredicateOp as FilterPredicateOp, schemas_FilterPredicateRangeOp as FilterPredicateRangeOp, schemas_FilterRangeValue as FilterRangeValue, schemas_FilterValue as FilterValue, schemas_FuzzinessExpression as FuzzinessExpression, schemas_HighlightExpression as HighlightExpression, schemas_InputFile as InputFile, schemas_InputFileArray as InputFileArray, schemas_InputFileEntry as InputFileEntry, schemas_InviteID as InviteID, schemas_InviteKey as InviteKey, schemas_ListBranchesResponse as ListBranchesResponse, schemas_ListClustersResponse as ListClustersResponse, schemas_ListDatabasesResponse as ListDatabasesResponse, schemas_ListGitBranchesResponse as ListGitBranchesResponse, schemas_ListRegionsResponse as ListRegionsResponse, schemas_MaintenanceConfig as MaintenanceConfig, schemas_MaxAgg as MaxAgg, schemas_MediaType as MediaType, schemas_MetricsDatapoint as MetricsDatapoint, schemas_MetricsLatency as MetricsLatency, schemas_Migration as Migration, schemas_MigrationColumnOp as MigrationColumnOp, schemas_MigrationObject as MigrationObject, schemas_MigrationOp as MigrationOp, schemas_MigrationRequest as MigrationRequest, schemas_MigrationRequestNumber as MigrationRequestNumber, schemas_MigrationStatus as MigrationStatus, schemas_MigrationTableOp as MigrationTableOp, schemas_MinAgg as MinAgg, NumericBooster$1 as NumericBooster, schemas_NumericHistogramAgg as NumericHistogramAgg, schemas_OAuthAccessToken as OAuthAccessToken, schemas_OAuthClientID as OAuthClientID, schemas_OAuthClientPublicDetails as OAuthClientPublicDetails, schemas_OAuthResponseType as OAuthResponseType, schemas_OAuthScope as OAuthScope, schemas_ObjectValue as ObjectValue, schemas_PageConfig as PageConfig, schemas_PercentilesAgg as PercentilesAgg, schemas_PrefixExpression as PrefixExpression, schemas_ProjectionConfig as ProjectionConfig, schemas_QueryColumnsProjection as QueryColumnsProjection, schemas_RecordID as RecordID, schemas_RecordMeta as RecordMeta, schemas_RecordsMetadata as RecordsMetadata, schemas_Region as Region, schemas_RevLink as RevLink, schemas_Role as Role, schemas_SQLRecord as SQLRecord, schemas_Schema as Schema, schemas_SchemaEditScript as SchemaEditScript, schemas_SearchPageConfig as SearchPageConfig, schemas_SortExpression as SortExpression, schemas_SortOrder as SortOrder, schemas_StartedFromMetadata as StartedFromMetadata, schemas_SumAgg as SumAgg, schemas_SummaryExpression as SummaryExpression, schemas_SummaryExpressionList as SummaryExpressionList, schemas_Table as Table, schemas_TableMigration as TableMigration, schemas_TableName as TableName, schemas_TableOpAdd as TableOpAdd, schemas_TableOpRemove as TableOpRemove, schemas_TableOpRename as TableOpRename, schemas_TableRename as TableRename, schemas_TargetExpression as TargetExpression, schemas_TopValuesAgg as TopValuesAgg, schemas_TransactionDeleteOp as TransactionDeleteOp, schemas_TransactionError as TransactionError, schemas_TransactionFailure as TransactionFailure, schemas_TransactionGetOp as TransactionGetOp, schemas_TransactionInsertOp as TransactionInsertOp, TransactionOperation$1 as TransactionOperation, schemas_TransactionResultColumns as TransactionResultColumns, schemas_TransactionResultDelete as TransactionResultDelete, schemas_TransactionResultGet as TransactionResultGet, schemas_TransactionResultInsert as TransactionResultInsert, schemas_TransactionResultUpdate as TransactionResultUpdate, schemas_TransactionSuccess as TransactionSuccess, schemas_TransactionUpdateOp as TransactionUpdateOp, schemas_UniqueCountAgg as UniqueCountAgg, schemas_User as User, schemas_UserID as UserID, schemas_UserWithID as UserWithID, ValueBooster$1 as ValueBooster, schemas_Workspace as Workspace, schemas_WorkspaceID as WorkspaceID, schemas_WorkspaceInvite as WorkspaceInvite, schemas_WorkspaceMember as WorkspaceMember, schemas_WorkspaceMembers as WorkspaceMembers, schemas_WorkspaceMeta as WorkspaceMeta, XataRecord$1 as XataRecord };
|
|
5546
6504
|
}
|
|
5547
6505
|
|
|
5548
6506
|
type ApiExtraProps = Omit<FetcherExtraProps, 'endpoint'>;
|
|
@@ -5567,6 +6525,7 @@ declare class XataApiClient {
|
|
|
5567
6525
|
get migrationRequests(): MigrationRequestsApi;
|
|
5568
6526
|
get tables(): TableApi;
|
|
5569
6527
|
get records(): RecordsApi;
|
|
6528
|
+
get files(): FilesApi;
|
|
5570
6529
|
get searchAndFilter(): SearchAndFilterApi;
|
|
5571
6530
|
}
|
|
5572
6531
|
declare class UserApi {
|
|
@@ -5888,6 +6847,75 @@ declare class RecordsApi {
|
|
|
5888
6847
|
operations: TransactionOperation$1[];
|
|
5889
6848
|
}): Promise<TransactionSuccess>;
|
|
5890
6849
|
}
|
|
6850
|
+
declare class FilesApi {
|
|
6851
|
+
private extraProps;
|
|
6852
|
+
constructor(extraProps: ApiExtraProps);
|
|
6853
|
+
getFileItem({ workspace, region, database, branch, table, record, column, fileId }: {
|
|
6854
|
+
workspace: WorkspaceID;
|
|
6855
|
+
region: string;
|
|
6856
|
+
database: DBName;
|
|
6857
|
+
branch: BranchName;
|
|
6858
|
+
table: TableName;
|
|
6859
|
+
record: RecordID;
|
|
6860
|
+
column: ColumnName;
|
|
6861
|
+
fileId: string;
|
|
6862
|
+
}): Promise<any>;
|
|
6863
|
+
putFileItem({ workspace, region, database, branch, table, record, column, fileId, file }: {
|
|
6864
|
+
workspace: WorkspaceID;
|
|
6865
|
+
region: string;
|
|
6866
|
+
database: DBName;
|
|
6867
|
+
branch: BranchName;
|
|
6868
|
+
table: TableName;
|
|
6869
|
+
record: RecordID;
|
|
6870
|
+
column: ColumnName;
|
|
6871
|
+
fileId: string;
|
|
6872
|
+
file: any;
|
|
6873
|
+
}): Promise<PutFileResponse>;
|
|
6874
|
+
deleteFileItem({ workspace, region, database, branch, table, record, column, fileId }: {
|
|
6875
|
+
workspace: WorkspaceID;
|
|
6876
|
+
region: string;
|
|
6877
|
+
database: DBName;
|
|
6878
|
+
branch: BranchName;
|
|
6879
|
+
table: TableName;
|
|
6880
|
+
record: RecordID;
|
|
6881
|
+
column: ColumnName;
|
|
6882
|
+
fileId: string;
|
|
6883
|
+
}): Promise<PutFileResponse>;
|
|
6884
|
+
getFile({ workspace, region, database, branch, table, record, column }: {
|
|
6885
|
+
workspace: WorkspaceID;
|
|
6886
|
+
region: string;
|
|
6887
|
+
database: DBName;
|
|
6888
|
+
branch: BranchName;
|
|
6889
|
+
table: TableName;
|
|
6890
|
+
record: RecordID;
|
|
6891
|
+
column: ColumnName;
|
|
6892
|
+
}): Promise<any>;
|
|
6893
|
+
putFile({ workspace, region, database, branch, table, record, column, file }: {
|
|
6894
|
+
workspace: WorkspaceID;
|
|
6895
|
+
region: string;
|
|
6896
|
+
database: DBName;
|
|
6897
|
+
branch: BranchName;
|
|
6898
|
+
table: TableName;
|
|
6899
|
+
record: RecordID;
|
|
6900
|
+
column: ColumnName;
|
|
6901
|
+
file: Blob;
|
|
6902
|
+
}): Promise<PutFileResponse>;
|
|
6903
|
+
deleteFile({ workspace, region, database, branch, table, record, column }: {
|
|
6904
|
+
workspace: WorkspaceID;
|
|
6905
|
+
region: string;
|
|
6906
|
+
database: DBName;
|
|
6907
|
+
branch: BranchName;
|
|
6908
|
+
table: TableName;
|
|
6909
|
+
record: RecordID;
|
|
6910
|
+
column: ColumnName;
|
|
6911
|
+
}): Promise<PutFileResponse>;
|
|
6912
|
+
fileAccess({ workspace, region, fileId, verify }: {
|
|
6913
|
+
workspace: WorkspaceID;
|
|
6914
|
+
region: string;
|
|
6915
|
+
fileId: string;
|
|
6916
|
+
verify?: FileSignature;
|
|
6917
|
+
}): Promise<any>;
|
|
6918
|
+
}
|
|
5891
6919
|
declare class SearchAndFilterApi {
|
|
5892
6920
|
private extraProps;
|
|
5893
6921
|
constructor(extraProps: ApiExtraProps);
|
|
@@ -5953,6 +6981,15 @@ declare class SearchAndFilterApi {
|
|
|
5953
6981
|
table: TableName;
|
|
5954
6982
|
options: AskTableRequestBody;
|
|
5955
6983
|
}): Promise<AskTableResponse>;
|
|
6984
|
+
askTableSession({ workspace, region, database, branch, table, sessionId, message }: {
|
|
6985
|
+
workspace: WorkspaceID;
|
|
6986
|
+
region: string;
|
|
6987
|
+
database: DBName;
|
|
6988
|
+
branch: BranchName;
|
|
6989
|
+
table: TableName;
|
|
6990
|
+
sessionId: string;
|
|
6991
|
+
message: string;
|
|
6992
|
+
}): Promise<AskTableSessionResponse>;
|
|
5956
6993
|
summarizeTable({ workspace, region, database, branch, table, filter, columns, summaries, sort, summariesFilter, page, consistency }: {
|
|
5957
6994
|
workspace: WorkspaceID;
|
|
5958
6995
|
region: string;
|
|
@@ -6131,10 +7168,11 @@ declare class DatabaseApi {
|
|
|
6131
7168
|
getDatabaseList({ workspace }: {
|
|
6132
7169
|
workspace: WorkspaceID;
|
|
6133
7170
|
}): Promise<ListDatabasesResponse>;
|
|
6134
|
-
createDatabase({ workspace, database, data }: {
|
|
7171
|
+
createDatabase({ workspace, database, data, headers }: {
|
|
6135
7172
|
workspace: WorkspaceID;
|
|
6136
7173
|
database: DBName;
|
|
6137
7174
|
data: CreateDatabaseRequestBody;
|
|
7175
|
+
headers?: Record<string, string>;
|
|
6138
7176
|
}): Promise<CreateDatabaseResponse>;
|
|
6139
7177
|
deleteDatabase({ workspace, database }: {
|
|
6140
7178
|
workspace: WorkspaceID;
|
|
@@ -6149,6 +7187,11 @@ declare class DatabaseApi {
|
|
|
6149
7187
|
database: DBName;
|
|
6150
7188
|
metadata: DatabaseMetadata;
|
|
6151
7189
|
}): Promise<DatabaseMetadata>;
|
|
7190
|
+
renameDatabase({ workspace, database, newName }: {
|
|
7191
|
+
workspace: WorkspaceID;
|
|
7192
|
+
database: DBName;
|
|
7193
|
+
newName: DBName;
|
|
7194
|
+
}): Promise<DatabaseMetadata>;
|
|
6152
7195
|
getDatabaseGithubSettings({ workspace, database }: {
|
|
6153
7196
|
workspace: WorkspaceID;
|
|
6154
7197
|
database: DBName;
|
|
@@ -6204,35 +7247,296 @@ type Narrowable = string | number | bigint | boolean;
|
|
|
6204
7247
|
type Try<A1, A2, Catch = never> = A1 extends A2 ? A1 : Catch;
|
|
6205
7248
|
type Narrow<A> = Try<A, [], NarrowRaw<A>>;
|
|
6206
7249
|
|
|
6207
|
-
|
|
7250
|
+
interface ImageTransformations {
|
|
7251
|
+
/**
|
|
7252
|
+
* Whether to preserve animation frames from input files. Default is true.
|
|
7253
|
+
* Setting it to false reduces animations to still images. This setting is
|
|
7254
|
+
* recommended when enlarging images or processing arbitrary user content,
|
|
7255
|
+
* because large GIF animations can weigh tens or even hundreds of megabytes.
|
|
7256
|
+
* It is also useful to set anim:false when using format:"json" to get the
|
|
7257
|
+
* response quicker without the number of frames.
|
|
7258
|
+
*/
|
|
7259
|
+
anim?: boolean;
|
|
7260
|
+
/**
|
|
7261
|
+
* Background color to add underneath the image. Applies only to images with
|
|
7262
|
+
* transparency (such as PNG). Accepts any CSS color (#RRGGBB, rgba(…),
|
|
7263
|
+
* hsl(…), etc.)
|
|
7264
|
+
*/
|
|
7265
|
+
background?: string;
|
|
7266
|
+
/**
|
|
7267
|
+
* Radius of a blur filter (approximate gaussian). Maximum supported radius
|
|
7268
|
+
* is 250.
|
|
7269
|
+
*/
|
|
7270
|
+
blur?: number;
|
|
7271
|
+
/**
|
|
7272
|
+
* Increase brightness by a factor. A value of 1.0 equals no change, a value
|
|
7273
|
+
* of 0.5 equals half brightness, and a value of 2.0 equals twice as bright.
|
|
7274
|
+
* 0 is ignored.
|
|
7275
|
+
*/
|
|
7276
|
+
brightness?: number;
|
|
7277
|
+
/**
|
|
7278
|
+
* Slightly reduces latency on a cache miss by selecting a
|
|
7279
|
+
* quickest-to-compress file format, at a cost of increased file size and
|
|
7280
|
+
* lower image quality. It will usually override the format option and choose
|
|
7281
|
+
* JPEG over WebP or AVIF. We do not recommend using this option, except in
|
|
7282
|
+
* unusual circumstances like resizing uncacheable dynamically-generated
|
|
7283
|
+
* images.
|
|
7284
|
+
*/
|
|
7285
|
+
compression?: 'fast';
|
|
7286
|
+
/**
|
|
7287
|
+
* Increase contrast by a factor. A value of 1.0 equals no change, a value of
|
|
7288
|
+
* 0.5 equals low contrast, and a value of 2.0 equals high contrast. 0 is
|
|
7289
|
+
* ignored.
|
|
7290
|
+
*/
|
|
7291
|
+
contrast?: number;
|
|
7292
|
+
/**
|
|
7293
|
+
* Download file. Forces browser to download the image.
|
|
7294
|
+
* Value is used for the download file name. Extension is optional.
|
|
7295
|
+
*/
|
|
7296
|
+
download?: string;
|
|
7297
|
+
/**
|
|
7298
|
+
* Device Pixel Ratio. Default 1. Multiplier for width/height that makes it
|
|
7299
|
+
* easier to specify higher-DPI sizes in <img srcset>.
|
|
7300
|
+
*/
|
|
7301
|
+
dpr?: number;
|
|
7302
|
+
/**
|
|
7303
|
+
* Resizing mode as a string. It affects interpretation of width and height
|
|
7304
|
+
* options:
|
|
7305
|
+
* - scale-down: Similar to contain, but the image is never enlarged. If
|
|
7306
|
+
* the image is larger than given width or height, it will be resized.
|
|
7307
|
+
* Otherwise its original size will be kept.
|
|
7308
|
+
* - contain: Resizes to maximum size that fits within the given width and
|
|
7309
|
+
* height. If only a single dimension is given (e.g. only width), the
|
|
7310
|
+
* image will be shrunk or enlarged to exactly match that dimension.
|
|
7311
|
+
* Aspect ratio is always preserved.
|
|
7312
|
+
* - cover: Resizes (shrinks or enlarges) to fill the entire area of width
|
|
7313
|
+
* and height. If the image has an aspect ratio different from the ratio
|
|
7314
|
+
* of width and height, it will be cropped to fit.
|
|
7315
|
+
* - crop: The image will be shrunk and cropped to fit within the area
|
|
7316
|
+
* specified by width and height. The image will not be enlarged. For images
|
|
7317
|
+
* smaller than the given dimensions it's the same as scale-down. For
|
|
7318
|
+
* images larger than the given dimensions, it's the same as cover.
|
|
7319
|
+
* See also trim.
|
|
7320
|
+
* - pad: Resizes to the maximum size that fits within the given width and
|
|
7321
|
+
* height, and then fills the remaining area with a background color
|
|
7322
|
+
* (white by default). Use of this mode is not recommended, as the same
|
|
7323
|
+
* effect can be more efficiently achieved with the contain mode and the
|
|
7324
|
+
* CSS object-fit: contain property.
|
|
7325
|
+
*/
|
|
7326
|
+
fit?: 'scale-down' | 'contain' | 'cover' | 'crop' | 'pad';
|
|
7327
|
+
/**
|
|
7328
|
+
* Output format to generate. It can be:
|
|
7329
|
+
* - avif: generate images in AVIF format.
|
|
7330
|
+
* - webp: generate images in Google WebP format. Set quality to 100 to get
|
|
7331
|
+
* the WebP-lossless format.
|
|
7332
|
+
* - json: instead of generating an image, outputs information about the
|
|
7333
|
+
* image, in JSON format. The JSON object will contain image size
|
|
7334
|
+
* (before and after resizing), source image’s MIME type, file size, etc.
|
|
7335
|
+
* - jpeg: generate images in JPEG format.
|
|
7336
|
+
* - png: generate images in PNG format.
|
|
7337
|
+
*/
|
|
7338
|
+
format?: 'auto' | 'avif' | 'webp' | 'json' | 'jpeg' | 'png';
|
|
7339
|
+
/**
|
|
7340
|
+
* Increase exposure by a factor. A value of 1.0 equals no change, a value of
|
|
7341
|
+
* 0.5 darkens the image, and a value of 2.0 lightens the image. 0 is ignored.
|
|
7342
|
+
*/
|
|
7343
|
+
gamma?: number;
|
|
7344
|
+
/**
|
|
7345
|
+
* When cropping with fit: "cover", this defines the side or point that should
|
|
7346
|
+
* be left uncropped. The value is either a string
|
|
7347
|
+
* "left", "right", "top", "bottom", "auto", or "center" (the default),
|
|
7348
|
+
* or an object {x, y} containing focal point coordinates in the original
|
|
7349
|
+
* image expressed as fractions ranging from 0.0 (top or left) to 1.0
|
|
7350
|
+
* (bottom or right), 0.5 being the center. {fit: "cover", gravity: "top"} will
|
|
7351
|
+
* crop bottom or left and right sides as necessary, but won’t crop anything
|
|
7352
|
+
* from the top. {fit: "cover", gravity: {x:0.5, y:0.2}} will crop each side to
|
|
7353
|
+
* preserve as much as possible around a point at 20% of the height of the
|
|
7354
|
+
* source image.
|
|
7355
|
+
*/
|
|
7356
|
+
gravity?: 'left' | 'right' | 'top' | 'bottom' | 'center' | 'auto' | {
|
|
7357
|
+
x: number;
|
|
7358
|
+
y: number;
|
|
7359
|
+
};
|
|
7360
|
+
/**
|
|
7361
|
+
* Maximum height in image pixels. The value must be an integer.
|
|
7362
|
+
*/
|
|
7363
|
+
height?: number;
|
|
7364
|
+
/**
|
|
7365
|
+
* What EXIF data should be preserved in the output image. Note that EXIF
|
|
7366
|
+
* rotation and embedded color profiles are always applied ("baked in" into
|
|
7367
|
+
* the image), and aren't affected by this option. Note that if the Polish
|
|
7368
|
+
* feature is enabled, all metadata may have been removed already and this
|
|
7369
|
+
* option may have no effect.
|
|
7370
|
+
* - keep: Preserve most of EXIF metadata, including GPS location if there's
|
|
7371
|
+
* any.
|
|
7372
|
+
* - copyright: Only keep the copyright tag, and discard everything else.
|
|
7373
|
+
* This is the default behavior for JPEG files.
|
|
7374
|
+
* - none: Discard all invisible EXIF metadata. Currently WebP and PNG
|
|
7375
|
+
* output formats always discard metadata.
|
|
7376
|
+
*/
|
|
7377
|
+
metadata?: 'keep' | 'copyright' | 'none';
|
|
7378
|
+
/**
|
|
7379
|
+
* Quality setting from 1-100 (useful values are in 60-90 range). Lower values
|
|
7380
|
+
* make images look worse, but load faster. The default is 85. It applies only
|
|
7381
|
+
* to JPEG and WebP images. It doesn’t have any effect on PNG.
|
|
7382
|
+
*/
|
|
7383
|
+
quality?: number;
|
|
7384
|
+
/**
|
|
7385
|
+
* Number of degrees (90, 180, 270) to rotate the image by. width and height
|
|
7386
|
+
* options refer to axes after rotation.
|
|
7387
|
+
*/
|
|
7388
|
+
rotate?: 0 | 90 | 180 | 270 | 360;
|
|
7389
|
+
/**
|
|
7390
|
+
* Strength of sharpening filter to apply to the image. Floating-point
|
|
7391
|
+
* number between 0 (no sharpening, default) and 10 (maximum). 1.0 is a
|
|
7392
|
+
* recommended value for downscaled images.
|
|
7393
|
+
*/
|
|
7394
|
+
sharpen?: number;
|
|
7395
|
+
/**
|
|
7396
|
+
* An object with four properties {left, top, right, bottom} that specify
|
|
7397
|
+
* a number of pixels to cut off on each side. Allows removal of borders
|
|
7398
|
+
* or cutting out a specific fragment of an image. Trimming is performed
|
|
7399
|
+
* before resizing or rotation. Takes dpr into account.
|
|
7400
|
+
*/
|
|
7401
|
+
trim?: {
|
|
7402
|
+
left?: number;
|
|
7403
|
+
top?: number;
|
|
7404
|
+
right?: number;
|
|
7405
|
+
bottom?: number;
|
|
7406
|
+
};
|
|
7407
|
+
/**
|
|
7408
|
+
* Maximum width in image pixels. The value must be an integer.
|
|
7409
|
+
*/
|
|
7410
|
+
width?: number;
|
|
7411
|
+
}
|
|
7412
|
+
declare function transformImage(url: string, ...transformations: ImageTransformations[]): string;
|
|
7413
|
+
declare function transformImage(url: string | undefined, ...transformations: ImageTransformations[]): string | undefined;
|
|
7414
|
+
|
|
7415
|
+
type XataFileEditableFields = Partial<Pick<XataArrayFile, keyof InputFileEntry>>;
|
|
7416
|
+
type XataFileFields = Partial<Pick<XataArrayFile, {
|
|
7417
|
+
[K in StringKeys<XataArrayFile>]: XataArrayFile[K] extends Function ? never : K;
|
|
7418
|
+
}[keyof XataArrayFile]>>;
|
|
7419
|
+
declare class XataFile {
|
|
7420
|
+
/**
|
|
7421
|
+
* Identifier of the file.
|
|
7422
|
+
*/
|
|
7423
|
+
id?: string;
|
|
7424
|
+
/**
|
|
7425
|
+
* Name of the file.
|
|
7426
|
+
*/
|
|
7427
|
+
name: string;
|
|
7428
|
+
/**
|
|
7429
|
+
* Media type of the file.
|
|
7430
|
+
*/
|
|
7431
|
+
mediaType: string;
|
|
7432
|
+
/**
|
|
7433
|
+
* Base64 encoded content of the file.
|
|
7434
|
+
*/
|
|
7435
|
+
base64Content?: string;
|
|
7436
|
+
/**
|
|
7437
|
+
* Whether to enable public url for the file.
|
|
7438
|
+
*/
|
|
7439
|
+
enablePublicUrl: boolean;
|
|
7440
|
+
/**
|
|
7441
|
+
* Timeout for the signed url.
|
|
7442
|
+
*/
|
|
7443
|
+
signedUrlTimeout: number;
|
|
7444
|
+
/**
|
|
7445
|
+
* Size of the file.
|
|
7446
|
+
*/
|
|
7447
|
+
size?: number;
|
|
7448
|
+
/**
|
|
7449
|
+
* Version of the file.
|
|
7450
|
+
*/
|
|
7451
|
+
version: number;
|
|
7452
|
+
/**
|
|
7453
|
+
* Url of the file.
|
|
7454
|
+
*/
|
|
7455
|
+
url: string;
|
|
7456
|
+
/**
|
|
7457
|
+
* Signed url of the file.
|
|
7458
|
+
*/
|
|
7459
|
+
signedUrl?: string;
|
|
7460
|
+
/**
|
|
7461
|
+
* Attributes of the file.
|
|
7462
|
+
*/
|
|
7463
|
+
attributes: Record<string, any>;
|
|
7464
|
+
constructor(file: Partial<XataFile>);
|
|
7465
|
+
static fromBuffer(buffer: Buffer, options?: XataFileEditableFields): XataFile;
|
|
7466
|
+
toBuffer(): Buffer;
|
|
7467
|
+
static fromArrayBuffer(arrayBuffer: ArrayBuffer, options?: XataFileEditableFields): XataFile;
|
|
7468
|
+
toArrayBuffer(): ArrayBuffer;
|
|
7469
|
+
static fromUint8Array(uint8Array: Uint8Array, options?: XataFileEditableFields): XataFile;
|
|
7470
|
+
toUint8Array(): Uint8Array;
|
|
7471
|
+
static fromBlob(file: Blob, options?: XataFileEditableFields): Promise<XataFile>;
|
|
7472
|
+
toBlob(): Blob;
|
|
7473
|
+
static fromString(string: string, options?: XataFileEditableFields): XataFile;
|
|
7474
|
+
toString(): string;
|
|
7475
|
+
static fromBase64(base64Content: string, options?: XataFileEditableFields): XataFile;
|
|
7476
|
+
toBase64(): string;
|
|
7477
|
+
transform(...options: ImageTransformations[]): {
|
|
7478
|
+
url: string;
|
|
7479
|
+
signedUrl: string | undefined;
|
|
7480
|
+
metadataUrl: string;
|
|
7481
|
+
metadataSignedUrl: string | undefined;
|
|
7482
|
+
};
|
|
7483
|
+
}
|
|
7484
|
+
type XataArrayFile = Identifiable & XataFile;
|
|
7485
|
+
|
|
7486
|
+
type SelectableColumn<O, RecursivePath extends any[] = []> = '*' | 'id' | `xata.${'version' | 'createdAt' | 'updatedAt'}` | DataProps<O> | NestedColumns<O, RecursivePath>;
|
|
7487
|
+
type ExpandedColumnNotation = {
|
|
7488
|
+
name: string;
|
|
7489
|
+
columns?: SelectableColumn<any>[];
|
|
7490
|
+
as?: string;
|
|
7491
|
+
limit?: number;
|
|
7492
|
+
offset?: number;
|
|
7493
|
+
order?: {
|
|
7494
|
+
column: string;
|
|
7495
|
+
order: 'asc' | 'desc';
|
|
7496
|
+
}[];
|
|
7497
|
+
};
|
|
7498
|
+
type SelectableColumnWithObjectNotation<O, RecursivePath extends any[] = []> = SelectableColumn<O, RecursivePath> | ExpandedColumnNotation;
|
|
7499
|
+
declare function isValidExpandedColumn(column: any): column is ExpandedColumnNotation;
|
|
7500
|
+
declare function isValidSelectableColumns(columns: any): columns is SelectableColumn<any>[];
|
|
7501
|
+
type StringColumns<T> = T extends string ? T : never;
|
|
7502
|
+
type ProjectionColumns<T> = T extends string ? never : T extends {
|
|
7503
|
+
as: infer As;
|
|
7504
|
+
} ? NonNullable<As> extends string ? NonNullable<As> : never : never;
|
|
6208
7505
|
type WildcardColumns<O> = Values<{
|
|
6209
7506
|
[K in SelectableColumn<O>]: K extends `${string}*` ? K : never;
|
|
6210
7507
|
}>;
|
|
6211
7508
|
type ColumnsByValue<O, Value> = Values<{
|
|
6212
7509
|
[K in SelectableColumn<O>]: ValueAtColumn<O, K> extends infer C ? C extends Value ? K extends WildcardColumns<O> ? never : K : never : never;
|
|
6213
7510
|
}>;
|
|
6214
|
-
type SelectedPick<O extends XataRecord, Key extends
|
|
6215
|
-
[K in Key[number]]: NestedValueAtColumn<O, K> & XataRecord<O>;
|
|
7511
|
+
type SelectedPick<O extends XataRecord, Key extends SelectableColumnWithObjectNotation<O>[]> = XataRecord<O> & UnionToIntersection<Values<{
|
|
7512
|
+
[K in StringColumns<Key[number]>]: NestedValueAtColumn<O, K> & XataRecord<O>;
|
|
7513
|
+
}>> & UnionToIntersection<Values<{
|
|
7514
|
+
[K in ProjectionColumns<Key[number]>]: {
|
|
7515
|
+
[Key in K]: {
|
|
7516
|
+
records: (Record<string, any> & XataRecord<O>)[];
|
|
7517
|
+
};
|
|
7518
|
+
};
|
|
6216
7519
|
}>>;
|
|
6217
|
-
type ValueAtColumn<
|
|
7520
|
+
type ValueAtColumn<Object, Key> = Key extends '*' ? Values<Object> : Key extends 'id' ? string : Key extends 'xata.version' ? number : Key extends 'xata.createdAt' ? Date : Key extends 'xata.updatedAt' ? Date : Key extends keyof Object ? Object[Key] : Key extends `${infer K}.${infer V}` ? K extends keyof Object ? Values<NonNullable<Object[K]> extends infer Item ? Item extends Record<string, any> ? V extends SelectableColumn<Item> ? {
|
|
6218
7521
|
V: ValueAtColumn<Item, V>;
|
|
6219
|
-
} : never :
|
|
7522
|
+
} : never : Object[K] : never> : never : never;
|
|
6220
7523
|
type MAX_RECURSION = 2;
|
|
6221
7524
|
type NestedColumns<O, RecursivePath extends any[]> = RecursivePath['length'] extends MAX_RECURSION ? never : If<IsObject<O>, Values<{
|
|
6222
|
-
[K in DataProps<O>]: NonNullable<O[K]> extends infer Item ? If<IsArray<Item>, K,
|
|
6223
|
-
If<IsObject<Item>, Item extends XataRecord ? SelectableColumn<Item, [...RecursivePath, Item]> extends infer Column ? Column extends string ? K | `${K}.${Column}` : never : never : Item extends Date ? K : `${K}.${StringKeys<Item> | '*'}`, // This allows usage of objects that are not links
|
|
7525
|
+
[K in DataProps<O>]: NonNullable<O[K]> extends infer Item ? If<IsArray<Item>, Item extends (infer Type)[] ? Type extends XataArrayFile ? K | `${K}.${keyof XataFileFields | '*'}` : K | `${K}.${StringKeys<Type> | '*'}` : never, If<IsObject<Item>, Item extends XataRecord ? SelectableColumn<Item, [...RecursivePath, Item]> extends infer Column ? Column extends string ? K | `${K}.${Column}` : never : never : Item extends Date ? K : Item extends XataFile ? K | `${K}.${keyof XataFileFields | '*'}` : `${K}.${StringKeys<Item> | '*'}`, // This allows usage of objects that are not links
|
|
6224
7526
|
K>> : never;
|
|
6225
7527
|
}>, never>;
|
|
6226
7528
|
type DataProps<O> = Exclude<StringKeys<O>, StringKeys<XataRecord>>;
|
|
6227
7529
|
type NestedValueAtColumn<O, Key extends SelectableColumn<O>> = Key extends `${infer N}.${infer M}` ? N extends DataProps<O> ? {
|
|
6228
|
-
[K in N]: M extends SelectableColumn<NonNullable<O[K]>> ? NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M> & XataRecord> : ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M>> : unknown;
|
|
7530
|
+
[K in N]: M extends SelectableColumn<NonNullable<O[K]>> ? NonNullable<O[K]> extends XataFile ? ForwardNullable<O[K], XataFile> : NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M> & XataRecord> : ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M>> : NonNullable<O[K]> extends (infer ArrayType)[] ? ArrayType extends XataArrayFile ? ForwardNullable<O[K], XataArrayFile[]> : M extends SelectableColumn<NonNullable<ArrayType>> ? ForwardNullable<O[K], NestedValueAtColumn<NonNullable<ArrayType>, M>[]> : unknown : unknown;
|
|
6229
7531
|
} : unknown : Key extends DataProps<O> ? {
|
|
6230
|
-
[K in Key]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], SelectedPick<NonNullable<O[K]>, ['*']>> : O[K];
|
|
7532
|
+
[K in Key]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], Omit<SelectedPick<NonNullable<O[K]>, ['*']>, 'xata' | 'getMetadata'>> : O[K];
|
|
6231
7533
|
} : Key extends '*' ? {
|
|
6232
7534
|
[K in StringKeys<O>]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], Link<NonNullable<O[K]>>> : O[K];
|
|
6233
7535
|
} : unknown;
|
|
6234
7536
|
type ForwardNullable<T, R> = T extends NonNullable<T> ? R : R | null;
|
|
6235
7537
|
|
|
7538
|
+
declare const RecordColumnTypes: readonly ["bool", "int", "float", "string", "text", "email", "multiple", "link", "object", "datetime", "vector", "file[]", "file", "json"];
|
|
7539
|
+
type Identifier = string;
|
|
6236
7540
|
/**
|
|
6237
7541
|
* Represents an identifiable record from the database.
|
|
6238
7542
|
*/
|
|
@@ -6240,7 +7544,7 @@ interface Identifiable {
|
|
|
6240
7544
|
/**
|
|
6241
7545
|
* Unique id of this record.
|
|
6242
7546
|
*/
|
|
6243
|
-
id:
|
|
7547
|
+
id: Identifier;
|
|
6244
7548
|
}
|
|
6245
7549
|
interface BaseData {
|
|
6246
7550
|
[key: string]: any;
|
|
@@ -6249,8 +7553,13 @@ interface BaseData {
|
|
|
6249
7553
|
* Represents a persisted record from the database.
|
|
6250
7554
|
*/
|
|
6251
7555
|
interface XataRecord<OriginalRecord extends XataRecord<any> = XataRecord<any>> extends Identifiable {
|
|
7556
|
+
/**
|
|
7557
|
+
* Metadata of this record.
|
|
7558
|
+
*/
|
|
7559
|
+
xata: XataRecordMetadata;
|
|
6252
7560
|
/**
|
|
6253
7561
|
* Get metadata of this record.
|
|
7562
|
+
* @deprecated Use `xata` property instead.
|
|
6254
7563
|
*/
|
|
6255
7564
|
getMetadata(): XataRecordMetadata;
|
|
6256
7565
|
/**
|
|
@@ -6329,7 +7638,14 @@ type XataRecordMetadata = {
|
|
|
6329
7638
|
* Number that is increased every time the record is updated.
|
|
6330
7639
|
*/
|
|
6331
7640
|
version: number;
|
|
6332
|
-
|
|
7641
|
+
/**
|
|
7642
|
+
* Timestamp when the record was created.
|
|
7643
|
+
*/
|
|
7644
|
+
createdAt: Date;
|
|
7645
|
+
/**
|
|
7646
|
+
* Timestamp when the record was last updated.
|
|
7647
|
+
*/
|
|
7648
|
+
updatedAt: Date;
|
|
6333
7649
|
};
|
|
6334
7650
|
declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
|
|
6335
7651
|
declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;
|
|
@@ -6342,19 +7658,51 @@ type NumericOperator = ExclusiveOr<{
|
|
|
6342
7658
|
}, {
|
|
6343
7659
|
$divide?: number;
|
|
6344
7660
|
}>>>;
|
|
7661
|
+
type InputXataFile = Partial<XataArrayFile> | Promise<Partial<XataArrayFile>>;
|
|
6345
7662
|
type EditableDataFields<T> = T extends XataRecord ? {
|
|
6346
|
-
id:
|
|
6347
|
-
} |
|
|
6348
|
-
id:
|
|
6349
|
-
} |
|
|
7663
|
+
id: Identifier;
|
|
7664
|
+
} | Identifier : NonNullable<T> extends XataRecord ? {
|
|
7665
|
+
id: Identifier;
|
|
7666
|
+
} | Identifier | null | undefined : T extends Date ? string | Date : NonNullable<T> extends Date ? string | Date | null | undefined : T extends XataFile ? InputXataFile : T extends XataFile[] ? InputXataFile[] : T extends number ? number | NumericOperator : T;
|
|
6350
7667
|
type EditableData<O extends XataRecord> = Identifiable & Partial<Omit<{
|
|
6351
7668
|
[K in keyof O]: EditableDataFields<O[K]>;
|
|
6352
7669
|
}, keyof XataRecord>>;
|
|
6353
|
-
type
|
|
6354
|
-
|
|
7670
|
+
type JSONDataFile = {
|
|
7671
|
+
[K in keyof XataFile]: XataFile[K] extends Function ? never : XataFile[K];
|
|
7672
|
+
};
|
|
7673
|
+
type JSONDataFields<T> = T extends XataFile ? JSONDataFile : NonNullable<T> extends XataFile ? JSONDataFile | null | undefined : T extends XataRecord ? JSONData<T> : NonNullable<T> extends XataRecord ? JSONData<T> | null | undefined : T extends Date ? string : NonNullable<T> extends Date ? string | null | undefined : T;
|
|
7674
|
+
type JSONDataBase = Identifiable & {
|
|
7675
|
+
/**
|
|
7676
|
+
* Metadata about the record.
|
|
7677
|
+
*/
|
|
7678
|
+
xata: {
|
|
7679
|
+
/**
|
|
7680
|
+
* Timestamp when the record was created.
|
|
7681
|
+
*/
|
|
7682
|
+
createdAt: string;
|
|
7683
|
+
/**
|
|
7684
|
+
* Timestamp when the record was last updated.
|
|
7685
|
+
*/
|
|
7686
|
+
updatedAt: string;
|
|
7687
|
+
/**
|
|
7688
|
+
* Number that is increased every time the record is updated.
|
|
7689
|
+
*/
|
|
7690
|
+
version: number;
|
|
7691
|
+
};
|
|
7692
|
+
};
|
|
7693
|
+
type JSONData<O> = JSONDataBase & Partial<Omit<{
|
|
6355
7694
|
[K in keyof O]: JSONDataFields<O[K]>;
|
|
6356
7695
|
}, keyof XataRecord>>;
|
|
6357
7696
|
|
|
7697
|
+
type JSONValue<Value> = Value & {
|
|
7698
|
+
__json: true;
|
|
7699
|
+
};
|
|
7700
|
+
|
|
7701
|
+
type JSONFilterColumns<Record> = Values<{
|
|
7702
|
+
[K in keyof Record]: NonNullable<Record[K]> extends JSONValue<any> ? K extends string ? `${K}->${string}` : never : never;
|
|
7703
|
+
}>;
|
|
7704
|
+
type FilterColumns<T> = ColumnsByValue<T, any> | `xata.${keyof XataRecordMetadata}`;
|
|
7705
|
+
type FilterValueAtColumn<Record, F> = NonNullable<ValueAtColumn<Record, F>> extends JSONValue<any> ? PropertyFilter<any> : Filter<NonNullable<ValueAtColumn<Record, F>>>;
|
|
6358
7706
|
/**
|
|
6359
7707
|
* PropertyMatchFilter
|
|
6360
7708
|
* Example:
|
|
@@ -6374,7 +7722,9 @@ type JSONData<O> = Identifiable & Partial<Omit<{
|
|
|
6374
7722
|
}
|
|
6375
7723
|
*/
|
|
6376
7724
|
type PropertyAccessFilter<Record> = {
|
|
6377
|
-
[key in
|
|
7725
|
+
[key in FilterColumns<Record>]?: NestedApiFilter<ValueAtColumn<Record, key>> | PropertyFilter<ValueAtColumn<Record, key>>;
|
|
7726
|
+
} & {
|
|
7727
|
+
[key in JSONFilterColumns<Record>]?: PropertyFilter<Record[keyof Record]>;
|
|
6378
7728
|
};
|
|
6379
7729
|
type PropertyFilter<T> = T | {
|
|
6380
7730
|
$is: T;
|
|
@@ -6391,7 +7741,7 @@ type IncludesFilter<T> = PropertyFilter<T> | {
|
|
|
6391
7741
|
}>;
|
|
6392
7742
|
};
|
|
6393
7743
|
type StringTypeFilter = {
|
|
6394
|
-
[key in '$contains' | '$pattern' | '$startsWith' | '$endsWith']?: string;
|
|
7744
|
+
[key in '$contains' | '$iContains' | '$pattern' | '$iPattern' | '$startsWith' | '$endsWith']?: string;
|
|
6395
7745
|
};
|
|
6396
7746
|
type ComparableType = number | Date;
|
|
6397
7747
|
type ComparableTypeFilter<T extends ComparableType> = {
|
|
@@ -6436,7 +7786,7 @@ type AggregatorFilter<T> = {
|
|
|
6436
7786
|
* Example: { filter: { $exists: "settings" } }
|
|
6437
7787
|
*/
|
|
6438
7788
|
type ExistanceFilter<Record> = {
|
|
6439
|
-
[key in '$exists' | '$notExists']?:
|
|
7789
|
+
[key in '$exists' | '$notExists']?: FilterColumns<Record>;
|
|
6440
7790
|
};
|
|
6441
7791
|
type BaseApiFilter<Record> = PropertyAccessFilter<Record> | AggregatorFilter<Record> | ExistanceFilter<Record>;
|
|
6442
7792
|
/**
|
|
@@ -6453,6 +7803,12 @@ type DateBooster = {
|
|
|
6453
7803
|
origin?: string;
|
|
6454
7804
|
scale: string;
|
|
6455
7805
|
decay: number;
|
|
7806
|
+
/**
|
|
7807
|
+
* The factor with which to multiply the added boost.
|
|
7808
|
+
*
|
|
7809
|
+
* @minimum 0
|
|
7810
|
+
*/
|
|
7811
|
+
factor?: number;
|
|
6456
7812
|
};
|
|
6457
7813
|
type NumericBooster = {
|
|
6458
7814
|
factor: number;
|
|
@@ -6597,6 +7953,7 @@ type AggregationExpression<O extends XataRecord> = ExactlyOne<{
|
|
|
6597
7953
|
max: MaxAggregation<O>;
|
|
6598
7954
|
min: MinAggregation<O>;
|
|
6599
7955
|
average: AverageAggregation<O>;
|
|
7956
|
+
percentiles: PercentilesAggregation<O>;
|
|
6600
7957
|
uniqueCount: UniqueCountAggregation<O>;
|
|
6601
7958
|
dateHistogram: DateHistogramAggregation<O>;
|
|
6602
7959
|
topValues: TopValuesAggregation<O>;
|
|
@@ -6651,6 +8008,16 @@ type AverageAggregation<O extends XataRecord> = {
|
|
|
6651
8008
|
*/
|
|
6652
8009
|
column: ColumnsByValue<O, number>;
|
|
6653
8010
|
};
|
|
8011
|
+
/**
|
|
8012
|
+
* Calculate given percentiles of the numeric values in a particular column.
|
|
8013
|
+
*/
|
|
8014
|
+
type PercentilesAggregation<O extends XataRecord> = {
|
|
8015
|
+
/**
|
|
8016
|
+
* The column on which to compute the average. Must be a numeric type.
|
|
8017
|
+
*/
|
|
8018
|
+
column: ColumnsByValue<O, number>;
|
|
8019
|
+
percentiles: number[];
|
|
8020
|
+
};
|
|
6654
8021
|
/**
|
|
6655
8022
|
* Count the number of distinct values in a particular column.
|
|
6656
8023
|
*/
|
|
@@ -6746,6 +8113,11 @@ type AggregationExpressionResultTypes = {
|
|
|
6746
8113
|
max: number | null;
|
|
6747
8114
|
min: number | null;
|
|
6748
8115
|
average: number | null;
|
|
8116
|
+
percentiles: {
|
|
8117
|
+
values: {
|
|
8118
|
+
[key: string]: number;
|
|
8119
|
+
};
|
|
8120
|
+
};
|
|
6749
8121
|
uniqueCount: number;
|
|
6750
8122
|
dateHistogram: ComplexAggregationResult;
|
|
6751
8123
|
topValues: ComplexAggregationResult;
|
|
@@ -6760,7 +8132,7 @@ type ComplexAggregationResult = {
|
|
|
6760
8132
|
};
|
|
6761
8133
|
|
|
6762
8134
|
type KeywordAskOptions<Record extends XataRecord> = {
|
|
6763
|
-
searchType
|
|
8135
|
+
searchType?: 'keyword';
|
|
6764
8136
|
search?: {
|
|
6765
8137
|
fuzziness?: FuzzinessExpression;
|
|
6766
8138
|
target?: TargetColumn<Record>[];
|
|
@@ -6770,7 +8142,7 @@ type KeywordAskOptions<Record extends XataRecord> = {
|
|
|
6770
8142
|
};
|
|
6771
8143
|
};
|
|
6772
8144
|
type VectorAskOptions<Record extends XataRecord> = {
|
|
6773
|
-
searchType
|
|
8145
|
+
searchType?: 'vector';
|
|
6774
8146
|
vectorSearch?: {
|
|
6775
8147
|
/**
|
|
6776
8148
|
* The column to use for vector search. It must be of type `vector`.
|
|
@@ -6786,20 +8158,30 @@ type VectorAskOptions<Record extends XataRecord> = {
|
|
|
6786
8158
|
type TypeAskOptions<Record extends XataRecord> = KeywordAskOptions<Record> | VectorAskOptions<Record>;
|
|
6787
8159
|
type BaseAskOptions = {
|
|
6788
8160
|
rules?: string[];
|
|
8161
|
+
sessionId?: string;
|
|
6789
8162
|
};
|
|
6790
8163
|
type AskOptions<Record extends XataRecord> = TypeAskOptions<Record> & BaseAskOptions;
|
|
6791
8164
|
type AskResult = {
|
|
6792
8165
|
answer?: string;
|
|
6793
8166
|
records?: string[];
|
|
8167
|
+
sessionId?: string;
|
|
6794
8168
|
};
|
|
6795
8169
|
|
|
6796
8170
|
type SortDirection = 'asc' | 'desc';
|
|
6797
|
-
type
|
|
8171
|
+
type RandomFilter = {
|
|
8172
|
+
'*': 'random';
|
|
8173
|
+
};
|
|
8174
|
+
type RandomFilterExtended = {
|
|
8175
|
+
column: '*';
|
|
8176
|
+
direction: 'random';
|
|
8177
|
+
};
|
|
8178
|
+
type SortColumns<T extends XataRecord> = ColumnsByValue<T, any> | `xata.${keyof XataRecordMetadata}`;
|
|
8179
|
+
type SortFilterExtended<T extends XataRecord, Columns extends string = SortColumns<T>> = RandomFilterExtended | {
|
|
6798
8180
|
column: Columns;
|
|
6799
8181
|
direction?: SortDirection;
|
|
6800
8182
|
};
|
|
6801
|
-
type SortFilter<T extends XataRecord, Columns extends string =
|
|
6802
|
-
type SortFilterBase<T extends XataRecord, Columns extends string =
|
|
8183
|
+
type SortFilter<T extends XataRecord, Columns extends string = SortColumns<T>> = Columns | SortFilterExtended<T, Columns> | SortFilterBase<T, Columns> | RandomFilter;
|
|
8184
|
+
type SortFilterBase<T extends XataRecord, Columns extends string = SortColumns<T>> = Values<{
|
|
6803
8185
|
[Key in Columns]: {
|
|
6804
8186
|
[K in Key]: SortDirection;
|
|
6805
8187
|
};
|
|
@@ -6841,7 +8223,7 @@ type SummarizeFilter<Record extends XataRecord, Expression extends Dictionary<Su
|
|
|
6841
8223
|
type SummarizeResultItem<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>, Columns extends SelectableColumn<Record>[]> = SummarizeValuePick<Record, Expression> & SelectedPick<Record, Columns>;
|
|
6842
8224
|
|
|
6843
8225
|
type BaseOptions<T extends XataRecord> = {
|
|
6844
|
-
columns?:
|
|
8226
|
+
columns?: SelectableColumnWithObjectNotation<T>[];
|
|
6845
8227
|
consistency?: 'strong' | 'eventual';
|
|
6846
8228
|
cache?: number;
|
|
6847
8229
|
fetchOptions?: Record<string, unknown>;
|
|
@@ -6909,7 +8291,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
|
6909
8291
|
* @param value The value to filter.
|
|
6910
8292
|
* @returns A new Query object.
|
|
6911
8293
|
*/
|
|
6912
|
-
filter<F extends
|
|
8294
|
+
filter<F extends FilterColumns<Record> | JSONFilterColumns<Record>>(column: F, value: FilterValueAtColumn<Record, F>): Query<Record, Result>;
|
|
6913
8295
|
/**
|
|
6914
8296
|
* Builds a new query object adding one or more constraints. Examples:
|
|
6915
8297
|
*
|
|
@@ -6930,13 +8312,15 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
|
6930
8312
|
* @param direction The direction. Either ascending or descending.
|
|
6931
8313
|
* @returns A new Query object.
|
|
6932
8314
|
*/
|
|
6933
|
-
sort<F extends
|
|
8315
|
+
sort<F extends SortColumns<Record>>(column: F, direction: SortDirection): Query<Record, Result>;
|
|
8316
|
+
sort(column: '*', direction: 'random'): Query<Record, Result>;
|
|
8317
|
+
sort<F extends SortColumns<Record>>(column: F): Query<Record, Result>;
|
|
6934
8318
|
/**
|
|
6935
8319
|
* Builds a new query specifying the set of columns to be returned in the query response.
|
|
6936
8320
|
* @param columns Array of column names to be returned by the query.
|
|
6937
8321
|
* @returns A new Query object.
|
|
6938
8322
|
*/
|
|
6939
|
-
select<K extends
|
|
8323
|
+
select<K extends SelectableColumnWithObjectNotation<Record>>(columns: K[]): Query<Record, SelectedPick<Record, K[]>>;
|
|
6940
8324
|
/**
|
|
6941
8325
|
* Get paginated results
|
|
6942
8326
|
*
|
|
@@ -6956,7 +8340,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
|
6956
8340
|
* @param options Pagination options
|
|
6957
8341
|
* @returns A page of results
|
|
6958
8342
|
*/
|
|
6959
|
-
getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, typeof options['columns']>>>;
|
|
8343
|
+
getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, (typeof options)['columns']>>>;
|
|
6960
8344
|
/**
|
|
6961
8345
|
* Get results in an iterator
|
|
6962
8346
|
*
|
|
@@ -6987,7 +8371,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
|
6987
8371
|
*/
|
|
6988
8372
|
getIterator<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
|
|
6989
8373
|
batchSize?: number;
|
|
6990
|
-
}>(options: Options): AsyncGenerator<SelectedPick<Record, typeof options['columns']>[]>;
|
|
8374
|
+
}>(options: Options): AsyncGenerator<SelectedPick<Record, (typeof options)['columns']>[]>;
|
|
6991
8375
|
/**
|
|
6992
8376
|
* Performs the query in the database and returns a set of results.
|
|
6993
8377
|
* @returns An array of records from the database.
|
|
@@ -6998,7 +8382,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
|
6998
8382
|
* @param options Additional options to be used when performing the query.
|
|
6999
8383
|
* @returns An array of records from the database.
|
|
7000
8384
|
*/
|
|
7001
|
-
getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<RecordArray<SelectedPick<Record, typeof options['columns']>>>;
|
|
8385
|
+
getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<RecordArray<SelectedPick<Record, (typeof options)['columns']>>>;
|
|
7002
8386
|
/**
|
|
7003
8387
|
* Performs the query in the database and returns a set of results.
|
|
7004
8388
|
* @param options Additional options to be used when performing the query.
|
|
@@ -7019,7 +8403,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
|
7019
8403
|
*/
|
|
7020
8404
|
getAll<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
|
|
7021
8405
|
batchSize?: number;
|
|
7022
|
-
}>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
|
|
8406
|
+
}>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']>[]>;
|
|
7023
8407
|
/**
|
|
7024
8408
|
* Performs the query in the database and returns all the results.
|
|
7025
8409
|
* Warning: If there are a large number of results, this method can have performance implications.
|
|
@@ -7039,7 +8423,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
|
7039
8423
|
* @param options Additional options to be used when performing the query.
|
|
7040
8424
|
* @returns The first record that matches the query, or null if no record matched the query.
|
|
7041
8425
|
*/
|
|
7042
|
-
getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']> | null>;
|
|
8426
|
+
getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']> | null>;
|
|
7043
8427
|
/**
|
|
7044
8428
|
* Performs the query in the database and returns the first result.
|
|
7045
8429
|
* @param options Additional options to be used when performing the query.
|
|
@@ -7058,7 +8442,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
|
7058
8442
|
* @returns The first record that matches the query, or null if no record matched the query.
|
|
7059
8443
|
* @throws if there are no results.
|
|
7060
8444
|
*/
|
|
7061
|
-
getFirstOrThrow<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>>;
|
|
8445
|
+
getFirstOrThrow<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']>>;
|
|
7062
8446
|
/**
|
|
7063
8447
|
* Performs the query in the database and returns the first result.
|
|
7064
8448
|
* @param options Additional options to be used when performing the query.
|
|
@@ -7107,6 +8491,7 @@ type PaginationQueryMeta = {
|
|
|
7107
8491
|
page: {
|
|
7108
8492
|
cursor: string;
|
|
7109
8493
|
more: boolean;
|
|
8494
|
+
size: number;
|
|
7110
8495
|
};
|
|
7111
8496
|
};
|
|
7112
8497
|
interface Paginable<Record extends XataRecord, Result extends XataRecord = Record> {
|
|
@@ -7179,9 +8564,9 @@ type OffsetNavigationOptions = {
|
|
|
7179
8564
|
size?: number;
|
|
7180
8565
|
offset?: number;
|
|
7181
8566
|
};
|
|
7182
|
-
declare const PAGINATION_MAX_SIZE =
|
|
8567
|
+
declare const PAGINATION_MAX_SIZE = 1000;
|
|
7183
8568
|
declare const PAGINATION_DEFAULT_SIZE = 20;
|
|
7184
|
-
declare const PAGINATION_MAX_OFFSET =
|
|
8569
|
+
declare const PAGINATION_MAX_OFFSET = 49000;
|
|
7185
8570
|
declare const PAGINATION_DEFAULT_OFFSET = 0;
|
|
7186
8571
|
declare function isCursorPaginationOptions(options: Record<string, unknown> | undefined | null): options is CursorNavigationOptions;
|
|
7187
8572
|
declare class RecordArray<Result extends XataRecord> extends Array<Result> {
|
|
@@ -7239,7 +8624,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7239
8624
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
|
7240
8625
|
* @returns The full persisted record.
|
|
7241
8626
|
*/
|
|
7242
|
-
abstract create<K extends SelectableColumn<Record>>(id:
|
|
8627
|
+
abstract create<K extends SelectableColumn<Record>>(id: Identifier, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
|
|
7243
8628
|
ifVersion?: number;
|
|
7244
8629
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
|
7245
8630
|
/**
|
|
@@ -7248,7 +8633,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7248
8633
|
* @param object Object containing the column names with their values to be stored in the table.
|
|
7249
8634
|
* @returns The full persisted record.
|
|
7250
8635
|
*/
|
|
7251
|
-
abstract create(id:
|
|
8636
|
+
abstract create(id: Identifier, object: Omit<EditableData<Record>, 'id'>, options?: {
|
|
7252
8637
|
ifVersion?: number;
|
|
7253
8638
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
|
7254
8639
|
/**
|
|
@@ -7270,26 +8655,26 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7270
8655
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
|
7271
8656
|
* @returns The persisted record for the given id or null if the record could not be found.
|
|
7272
8657
|
*/
|
|
7273
|
-
abstract read<K extends SelectableColumn<Record>>(id:
|
|
8658
|
+
abstract read<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
|
|
7274
8659
|
/**
|
|
7275
8660
|
* Queries a single record from the table given its unique id.
|
|
7276
8661
|
* @param id The unique id.
|
|
7277
8662
|
* @returns The persisted record for the given id or null if the record could not be found.
|
|
7278
8663
|
*/
|
|
7279
|
-
abstract read(id:
|
|
8664
|
+
abstract read(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
|
|
7280
8665
|
/**
|
|
7281
8666
|
* Queries multiple records from the table given their unique id.
|
|
7282
8667
|
* @param ids The unique ids array.
|
|
7283
8668
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
|
7284
8669
|
* @returns The persisted records for the given ids in order (if a record could not be found null is returned).
|
|
7285
8670
|
*/
|
|
7286
|
-
abstract read<K extends SelectableColumn<Record>>(ids:
|
|
8671
|
+
abstract read<K extends SelectableColumn<Record>>(ids: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
|
7287
8672
|
/**
|
|
7288
8673
|
* Queries multiple records from the table given their unique id.
|
|
7289
8674
|
* @param ids The unique ids array.
|
|
7290
8675
|
* @returns The persisted records for the given ids in order (if a record could not be found null is returned).
|
|
7291
8676
|
*/
|
|
7292
|
-
abstract read(ids:
|
|
8677
|
+
abstract read(ids: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
|
7293
8678
|
/**
|
|
7294
8679
|
* Queries a single record from the table by the id in the object.
|
|
7295
8680
|
* @param object Object containing the id of the record.
|
|
@@ -7323,14 +8708,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7323
8708
|
* @returns The persisted record for the given id.
|
|
7324
8709
|
* @throws If the record could not be found.
|
|
7325
8710
|
*/
|
|
7326
|
-
abstract readOrThrow<K extends SelectableColumn<Record>>(id:
|
|
8711
|
+
abstract readOrThrow<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
|
7327
8712
|
/**
|
|
7328
8713
|
* Queries a single record from the table given its unique id.
|
|
7329
8714
|
* @param id The unique id.
|
|
7330
8715
|
* @returns The persisted record for the given id.
|
|
7331
8716
|
* @throws If the record could not be found.
|
|
7332
8717
|
*/
|
|
7333
|
-
abstract readOrThrow(id:
|
|
8718
|
+
abstract readOrThrow(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
|
7334
8719
|
/**
|
|
7335
8720
|
* Queries multiple records from the table given their unique id.
|
|
7336
8721
|
* @param ids The unique ids array.
|
|
@@ -7338,14 +8723,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7338
8723
|
* @returns The persisted records for the given ids in order.
|
|
7339
8724
|
* @throws If one or more records could not be found.
|
|
7340
8725
|
*/
|
|
7341
|
-
abstract readOrThrow<K extends SelectableColumn<Record>>(ids:
|
|
8726
|
+
abstract readOrThrow<K extends SelectableColumn<Record>>(ids: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
|
7342
8727
|
/**
|
|
7343
8728
|
* Queries multiple records from the table given their unique id.
|
|
7344
8729
|
* @param ids The unique ids array.
|
|
7345
8730
|
* @returns The persisted records for the given ids in order.
|
|
7346
8731
|
* @throws If one or more records could not be found.
|
|
7347
8732
|
*/
|
|
7348
|
-
abstract readOrThrow(ids:
|
|
8733
|
+
abstract readOrThrow(ids: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
|
7349
8734
|
/**
|
|
7350
8735
|
* Queries a single record from the table by the id in the object.
|
|
7351
8736
|
* @param object Object containing the id of the record.
|
|
@@ -7400,7 +8785,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7400
8785
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
|
7401
8786
|
* @returns The full persisted record, null if the record could not be found.
|
|
7402
8787
|
*/
|
|
7403
|
-
abstract update<K extends SelectableColumn<Record>>(id:
|
|
8788
|
+
abstract update<K extends SelectableColumn<Record>>(id: Identifier, object: Partial<EditableData<Record>>, columns: K[], options?: {
|
|
7404
8789
|
ifVersion?: number;
|
|
7405
8790
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
|
|
7406
8791
|
/**
|
|
@@ -7409,7 +8794,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7409
8794
|
* @param object The column names and their values that have to be updated.
|
|
7410
8795
|
* @returns The full persisted record, null if the record could not be found.
|
|
7411
8796
|
*/
|
|
7412
|
-
abstract update(id:
|
|
8797
|
+
abstract update(id: Identifier, object: Partial<EditableData<Record>>, options?: {
|
|
7413
8798
|
ifVersion?: number;
|
|
7414
8799
|
}): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
|
|
7415
8800
|
/**
|
|
@@ -7452,7 +8837,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7452
8837
|
* @returns The full persisted record.
|
|
7453
8838
|
* @throws If the record could not be found.
|
|
7454
8839
|
*/
|
|
7455
|
-
abstract updateOrThrow<K extends SelectableColumn<Record>>(id:
|
|
8840
|
+
abstract updateOrThrow<K extends SelectableColumn<Record>>(id: Identifier, object: Partial<EditableData<Record>>, columns: K[], options?: {
|
|
7456
8841
|
ifVersion?: number;
|
|
7457
8842
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
|
7458
8843
|
/**
|
|
@@ -7462,7 +8847,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7462
8847
|
* @returns The full persisted record.
|
|
7463
8848
|
* @throws If the record could not be found.
|
|
7464
8849
|
*/
|
|
7465
|
-
abstract updateOrThrow(id:
|
|
8850
|
+
abstract updateOrThrow(id: Identifier, object: Partial<EditableData<Record>>, options?: {
|
|
7466
8851
|
ifVersion?: number;
|
|
7467
8852
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
|
7468
8853
|
/**
|
|
@@ -7487,7 +8872,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7487
8872
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
|
7488
8873
|
* @returns The full persisted record.
|
|
7489
8874
|
*/
|
|
7490
|
-
abstract createOrUpdate<K extends SelectableColumn<Record>>(object: EditableData<Record> & Identifiable
|
|
8875
|
+
abstract createOrUpdate<K extends SelectableColumn<Record>>(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, columns: K[], options?: {
|
|
7491
8876
|
ifVersion?: number;
|
|
7492
8877
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
|
7493
8878
|
/**
|
|
@@ -7496,7 +8881,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7496
8881
|
* @param object Object containing the column names with their values to be persisted in the table.
|
|
7497
8882
|
* @returns The full persisted record.
|
|
7498
8883
|
*/
|
|
7499
|
-
abstract createOrUpdate(object: EditableData<Record> & Identifiable
|
|
8884
|
+
abstract createOrUpdate(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, options?: {
|
|
7500
8885
|
ifVersion?: number;
|
|
7501
8886
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
|
7502
8887
|
/**
|
|
@@ -7507,7 +8892,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7507
8892
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
|
7508
8893
|
* @returns The full persisted record.
|
|
7509
8894
|
*/
|
|
7510
|
-
abstract createOrUpdate<K extends SelectableColumn<Record>>(id:
|
|
8895
|
+
abstract createOrUpdate<K extends SelectableColumn<Record>>(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
|
|
7511
8896
|
ifVersion?: number;
|
|
7512
8897
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
|
7513
8898
|
/**
|
|
@@ -7517,7 +8902,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7517
8902
|
* @param object The column names and the values to be persisted.
|
|
7518
8903
|
* @returns The full persisted record.
|
|
7519
8904
|
*/
|
|
7520
|
-
abstract createOrUpdate(id:
|
|
8905
|
+
abstract createOrUpdate(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, options?: {
|
|
7521
8906
|
ifVersion?: number;
|
|
7522
8907
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
|
7523
8908
|
/**
|
|
@@ -7527,14 +8912,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7527
8912
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
|
7528
8913
|
* @returns Array of the persisted records.
|
|
7529
8914
|
*/
|
|
7530
|
-
abstract createOrUpdate<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Identifiable
|
|
8915
|
+
abstract createOrUpdate<K extends SelectableColumn<Record>>(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
|
7531
8916
|
/**
|
|
7532
8917
|
* Creates or updates a single record. If a record exists with the given id,
|
|
7533
8918
|
* it will be partially updated, otherwise a new record will be created.
|
|
7534
8919
|
* @param objects Array of objects with the column names and the values to be stored in the table.
|
|
7535
8920
|
* @returns Array of the persisted records.
|
|
7536
8921
|
*/
|
|
7537
|
-
abstract createOrUpdate(objects: Array<EditableData<Record> & Identifiable
|
|
8922
|
+
abstract createOrUpdate(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
|
7538
8923
|
/**
|
|
7539
8924
|
* Creates or replaces a single record. If a record exists with the given id,
|
|
7540
8925
|
* it will be replaced, otherwise a new record will be created.
|
|
@@ -7542,7 +8927,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7542
8927
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
|
7543
8928
|
* @returns The full persisted record.
|
|
7544
8929
|
*/
|
|
7545
|
-
abstract createOrReplace<K extends SelectableColumn<Record>>(object: EditableData<Record> & Identifiable
|
|
8930
|
+
abstract createOrReplace<K extends SelectableColumn<Record>>(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, columns: K[], options?: {
|
|
7546
8931
|
ifVersion?: number;
|
|
7547
8932
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
|
7548
8933
|
/**
|
|
@@ -7551,7 +8936,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7551
8936
|
* @param object Object containing the column names with their values to be persisted in the table.
|
|
7552
8937
|
* @returns The full persisted record.
|
|
7553
8938
|
*/
|
|
7554
|
-
abstract createOrReplace(object: EditableData<Record> & Identifiable
|
|
8939
|
+
abstract createOrReplace(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, options?: {
|
|
7555
8940
|
ifVersion?: number;
|
|
7556
8941
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
|
7557
8942
|
/**
|
|
@@ -7562,7 +8947,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7562
8947
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
|
7563
8948
|
* @returns The full persisted record.
|
|
7564
8949
|
*/
|
|
7565
|
-
abstract createOrReplace<K extends SelectableColumn<Record>>(id:
|
|
8950
|
+
abstract createOrReplace<K extends SelectableColumn<Record>>(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
|
|
7566
8951
|
ifVersion?: number;
|
|
7567
8952
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
|
7568
8953
|
/**
|
|
@@ -7572,7 +8957,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7572
8957
|
* @param object The column names and the values to be persisted.
|
|
7573
8958
|
* @returns The full persisted record.
|
|
7574
8959
|
*/
|
|
7575
|
-
abstract createOrReplace(id:
|
|
8960
|
+
abstract createOrReplace(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, options?: {
|
|
7576
8961
|
ifVersion?: number;
|
|
7577
8962
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
|
7578
8963
|
/**
|
|
@@ -7582,14 +8967,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7582
8967
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
|
7583
8968
|
* @returns Array of the persisted records.
|
|
7584
8969
|
*/
|
|
7585
|
-
abstract createOrReplace<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Identifiable
|
|
8970
|
+
abstract createOrReplace<K extends SelectableColumn<Record>>(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
|
7586
8971
|
/**
|
|
7587
8972
|
* Creates or replaces a single record. If a record exists with the given id,
|
|
7588
8973
|
* it will be replaced, otherwise a new record will be created.
|
|
7589
8974
|
* @param objects Array of objects with the column names and the values to be stored in the table.
|
|
7590
8975
|
* @returns Array of the persisted records.
|
|
7591
8976
|
*/
|
|
7592
|
-
abstract createOrReplace(objects: Array<EditableData<Record> & Identifiable
|
|
8977
|
+
abstract createOrReplace(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
|
7593
8978
|
/**
|
|
7594
8979
|
* Deletes a record given its unique id.
|
|
7595
8980
|
* @param object An object with a unique id.
|
|
@@ -7609,13 +8994,13 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7609
8994
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
|
7610
8995
|
* @returns The deleted record, null if the record could not be found.
|
|
7611
8996
|
*/
|
|
7612
|
-
abstract delete<K extends SelectableColumn<Record>>(id:
|
|
8997
|
+
abstract delete<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
|
|
7613
8998
|
/**
|
|
7614
8999
|
* Deletes a record given a unique id.
|
|
7615
9000
|
* @param id The unique id.
|
|
7616
9001
|
* @returns The deleted record, null if the record could not be found.
|
|
7617
9002
|
*/
|
|
7618
|
-
abstract delete(id:
|
|
9003
|
+
abstract delete(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
|
|
7619
9004
|
/**
|
|
7620
9005
|
* Deletes multiple records given an array of objects with ids.
|
|
7621
9006
|
* @param objects An array of objects with unique ids.
|
|
@@ -7635,13 +9020,13 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7635
9020
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
|
7636
9021
|
* @returns Array of the deleted records in order (if a record could not be found null is returned).
|
|
7637
9022
|
*/
|
|
7638
|
-
abstract delete<K extends SelectableColumn<Record>>(objects:
|
|
9023
|
+
abstract delete<K extends SelectableColumn<Record>>(objects: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
|
7639
9024
|
/**
|
|
7640
9025
|
* Deletes multiple records given an array of unique ids.
|
|
7641
9026
|
* @param objects An array of ids.
|
|
7642
9027
|
* @returns Array of the deleted records in order (if a record could not be found null is returned).
|
|
7643
9028
|
*/
|
|
7644
|
-
abstract delete(objects:
|
|
9029
|
+
abstract delete(objects: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
|
7645
9030
|
/**
|
|
7646
9031
|
* Deletes a record given its unique id.
|
|
7647
9032
|
* @param object An object with a unique id.
|
|
@@ -7664,14 +9049,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7664
9049
|
* @returns The deleted record, null if the record could not be found.
|
|
7665
9050
|
* @throws If the record could not be found.
|
|
7666
9051
|
*/
|
|
7667
|
-
abstract deleteOrThrow<K extends SelectableColumn<Record>>(id:
|
|
9052
|
+
abstract deleteOrThrow<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
|
7668
9053
|
/**
|
|
7669
9054
|
* Deletes a record given a unique id.
|
|
7670
9055
|
* @param id The unique id.
|
|
7671
9056
|
* @returns The deleted record, null if the record could not be found.
|
|
7672
9057
|
* @throws If the record could not be found.
|
|
7673
9058
|
*/
|
|
7674
|
-
abstract deleteOrThrow(id:
|
|
9059
|
+
abstract deleteOrThrow(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
|
7675
9060
|
/**
|
|
7676
9061
|
* Deletes multiple records given an array of objects with ids.
|
|
7677
9062
|
* @param objects An array of objects with unique ids.
|
|
@@ -7694,14 +9079,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7694
9079
|
* @returns Array of the deleted records in order (if a record could not be found null is returned).
|
|
7695
9080
|
* @throws If one or more records could not be found.
|
|
7696
9081
|
*/
|
|
7697
|
-
abstract deleteOrThrow<K extends SelectableColumn<Record>>(objects:
|
|
9082
|
+
abstract deleteOrThrow<K extends SelectableColumn<Record>>(objects: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
|
7698
9083
|
/**
|
|
7699
9084
|
* Deletes multiple records given an array of unique ids.
|
|
7700
9085
|
* @param objects An array of ids.
|
|
7701
9086
|
* @returns Array of the deleted records in order.
|
|
7702
9087
|
* @throws If one or more records could not be found.
|
|
7703
9088
|
*/
|
|
7704
|
-
abstract deleteOrThrow(objects:
|
|
9089
|
+
abstract deleteOrThrow(objects: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
|
7705
9090
|
/**
|
|
7706
9091
|
* Search for records in the table.
|
|
7707
9092
|
* @param query The query to search for.
|
|
@@ -7752,6 +9137,10 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
|
7752
9137
|
* Experimental: Ask the database to perform a natural language question.
|
|
7753
9138
|
*/
|
|
7754
9139
|
abstract ask(question: string, options?: AskOptions<Record>): Promise<AskResult>;
|
|
9140
|
+
/**
|
|
9141
|
+
* Experimental: Ask the database to perform a natural language question.
|
|
9142
|
+
*/
|
|
9143
|
+
abstract ask(question: string, options: AskOptions<Record>): Promise<AskResult>;
|
|
7755
9144
|
/**
|
|
7756
9145
|
* Experimental: Ask the database to perform a natural language question.
|
|
7757
9146
|
*/
|
|
@@ -7774,26 +9163,26 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
|
|
|
7774
9163
|
create(object: EditableData<Record> & Partial<Identifiable>, options?: {
|
|
7775
9164
|
ifVersion?: number;
|
|
7776
9165
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
|
7777
|
-
create<K extends SelectableColumn<Record>>(id:
|
|
9166
|
+
create<K extends SelectableColumn<Record>>(id: Identifier, object: EditableData<Record>, columns: K[], options?: {
|
|
7778
9167
|
ifVersion?: number;
|
|
7779
9168
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
|
7780
|
-
create(id:
|
|
9169
|
+
create(id: Identifier, object: EditableData<Record>, options?: {
|
|
7781
9170
|
ifVersion?: number;
|
|
7782
9171
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
|
7783
9172
|
create<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
|
7784
9173
|
create(objects: Array<EditableData<Record> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
|
7785
|
-
read<K extends SelectableColumn<Record>>(id:
|
|
9174
|
+
read<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
|
|
7786
9175
|
read(id: string): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
|
|
7787
|
-
read<K extends SelectableColumn<Record>>(ids:
|
|
7788
|
-
read(ids:
|
|
9176
|
+
read<K extends SelectableColumn<Record>>(ids: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
|
9177
|
+
read(ids: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
|
7789
9178
|
read<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
|
|
7790
9179
|
read(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
|
|
7791
9180
|
read<K extends SelectableColumn<Record>>(objects: Identifiable[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
|
7792
9181
|
read(objects: Identifiable[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
|
7793
|
-
readOrThrow<K extends SelectableColumn<Record>>(id:
|
|
7794
|
-
readOrThrow(id:
|
|
7795
|
-
readOrThrow<K extends SelectableColumn<Record>>(ids:
|
|
7796
|
-
readOrThrow(ids:
|
|
9182
|
+
readOrThrow<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
|
9183
|
+
readOrThrow(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
|
9184
|
+
readOrThrow<K extends SelectableColumn<Record>>(ids: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
|
9185
|
+
readOrThrow(ids: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
|
7797
9186
|
readOrThrow<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
|
7798
9187
|
readOrThrow(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
|
7799
9188
|
readOrThrow<K extends SelectableColumn<Record>>(objects: Identifiable[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
|
@@ -7804,10 +9193,10 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
|
|
|
7804
9193
|
update(object: Partial<EditableData<Record>> & Identifiable, options?: {
|
|
7805
9194
|
ifVersion?: number;
|
|
7806
9195
|
}): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
|
|
7807
|
-
update<K extends SelectableColumn<Record>>(id:
|
|
9196
|
+
update<K extends SelectableColumn<Record>>(id: Identifier, object: Partial<EditableData<Record>>, columns: K[], options?: {
|
|
7808
9197
|
ifVersion?: number;
|
|
7809
9198
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
|
|
7810
|
-
update(id:
|
|
9199
|
+
update(id: Identifier, object: Partial<EditableData<Record>>, options?: {
|
|
7811
9200
|
ifVersion?: number;
|
|
7812
9201
|
}): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
|
|
7813
9202
|
update<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
|
@@ -7818,58 +9207,58 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
|
|
|
7818
9207
|
updateOrThrow(object: Partial<EditableData<Record>> & Identifiable, options?: {
|
|
7819
9208
|
ifVersion?: number;
|
|
7820
9209
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
|
7821
|
-
updateOrThrow<K extends SelectableColumn<Record>>(id:
|
|
9210
|
+
updateOrThrow<K extends SelectableColumn<Record>>(id: Identifier, object: Partial<EditableData<Record>>, columns: K[], options?: {
|
|
7822
9211
|
ifVersion?: number;
|
|
7823
9212
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
|
7824
|
-
updateOrThrow(id:
|
|
9213
|
+
updateOrThrow(id: Identifier, object: Partial<EditableData<Record>>, options?: {
|
|
7825
9214
|
ifVersion?: number;
|
|
7826
9215
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
|
7827
9216
|
updateOrThrow<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
|
7828
9217
|
updateOrThrow(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
|
7829
|
-
createOrUpdate<K extends SelectableColumn<Record>>(object: EditableData<Record> & Identifiable
|
|
9218
|
+
createOrUpdate<K extends SelectableColumn<Record>>(object: EditableData<Record> & Partial<Identifiable>, columns: K[], options?: {
|
|
7830
9219
|
ifVersion?: number;
|
|
7831
9220
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
|
7832
|
-
createOrUpdate(object: EditableData<Record> & Identifiable
|
|
9221
|
+
createOrUpdate(object: EditableData<Record> & Partial<Identifiable>, options?: {
|
|
7833
9222
|
ifVersion?: number;
|
|
7834
9223
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
|
7835
|
-
createOrUpdate<K extends SelectableColumn<Record>>(id:
|
|
9224
|
+
createOrUpdate<K extends SelectableColumn<Record>>(id: Identifier, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
|
|
7836
9225
|
ifVersion?: number;
|
|
7837
9226
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
|
7838
|
-
createOrUpdate(id:
|
|
9227
|
+
createOrUpdate(id: Identifier, object: Omit<EditableData<Record>, 'id'>, options?: {
|
|
7839
9228
|
ifVersion?: number;
|
|
7840
9229
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
|
7841
|
-
createOrUpdate<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Identifiable
|
|
7842
|
-
createOrUpdate(objects: Array<EditableData<Record> & Identifiable
|
|
7843
|
-
createOrReplace<K extends SelectableColumn<Record>>(object: EditableData<Record> & Identifiable
|
|
9230
|
+
createOrUpdate<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
|
9231
|
+
createOrUpdate(objects: Array<EditableData<Record> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
|
9232
|
+
createOrReplace<K extends SelectableColumn<Record>>(object: EditableData<Record> & Partial<Identifiable>, columns: K[], options?: {
|
|
7844
9233
|
ifVersion?: number;
|
|
7845
9234
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
|
7846
|
-
createOrReplace(object: EditableData<Record> & Identifiable
|
|
9235
|
+
createOrReplace(object: EditableData<Record> & Partial<Identifiable>, options?: {
|
|
7847
9236
|
ifVersion?: number;
|
|
7848
9237
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
|
7849
|
-
createOrReplace<K extends SelectableColumn<Record>>(id:
|
|
9238
|
+
createOrReplace<K extends SelectableColumn<Record>>(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
|
|
7850
9239
|
ifVersion?: number;
|
|
7851
9240
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
|
7852
|
-
createOrReplace(id:
|
|
9241
|
+
createOrReplace(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, options?: {
|
|
7853
9242
|
ifVersion?: number;
|
|
7854
9243
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
|
7855
|
-
createOrReplace<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Identifiable
|
|
7856
|
-
createOrReplace(objects: Array<EditableData<Record> & Identifiable
|
|
9244
|
+
createOrReplace<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
|
9245
|
+
createOrReplace(objects: Array<EditableData<Record> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
|
7857
9246
|
delete<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
|
|
7858
9247
|
delete(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
|
|
7859
|
-
delete<K extends SelectableColumn<Record>>(id:
|
|
7860
|
-
delete(id:
|
|
9248
|
+
delete<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
|
|
9249
|
+
delete(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
|
|
7861
9250
|
delete<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
|
7862
9251
|
delete(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
|
7863
|
-
delete<K extends SelectableColumn<Record>>(objects:
|
|
7864
|
-
delete(objects:
|
|
9252
|
+
delete<K extends SelectableColumn<Record>>(objects: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
|
9253
|
+
delete(objects: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
|
7865
9254
|
deleteOrThrow<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
|
7866
9255
|
deleteOrThrow(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
|
7867
|
-
deleteOrThrow<K extends SelectableColumn<Record>>(id:
|
|
7868
|
-
deleteOrThrow(id:
|
|
9256
|
+
deleteOrThrow<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
|
9257
|
+
deleteOrThrow(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
|
7869
9258
|
deleteOrThrow<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
|
7870
9259
|
deleteOrThrow(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
|
7871
|
-
deleteOrThrow<K extends SelectableColumn<Record>>(objects:
|
|
7872
|
-
deleteOrThrow(objects:
|
|
9260
|
+
deleteOrThrow<K extends SelectableColumn<Record>>(objects: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
|
9261
|
+
deleteOrThrow(objects: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
|
7873
9262
|
search(query: string, options?: {
|
|
7874
9263
|
fuzziness?: FuzzinessExpression;
|
|
7875
9264
|
prefix?: PrefixExpression;
|
|
@@ -7945,7 +9334,7 @@ type PropertyType<Tables, Properties, PropertyName extends PropertyKey> = Proper
|
|
|
7945
9334
|
} : {
|
|
7946
9335
|
[K in PropertyName]?: InnerType<Type, ObjectColumns, Tables, LinkedTable> | null;
|
|
7947
9336
|
} : never : never;
|
|
7948
|
-
type InnerType<Type, ObjectColumns, Tables, LinkedTable> = Type extends 'string' | 'text' | 'email' ? string : Type extends 'int' | 'float' ? number : Type extends 'bool' ? boolean : Type extends 'datetime' ? Date : Type extends 'multiple' ? string[] : Type extends 'vector' ? number[] : Type extends 'object' ? ObjectColumns extends readonly unknown[] ? ObjectColumns[number] extends {
|
|
9337
|
+
type InnerType<Type, ObjectColumns, Tables, LinkedTable> = Type extends 'string' | 'text' | 'email' ? string : Type extends 'int' | 'float' ? number : Type extends 'bool' ? boolean : Type extends 'datetime' ? Date : Type extends 'multiple' ? string[] : Type extends 'vector' ? number[] : Type extends 'file' ? XataFile : Type extends 'file[]' ? XataArrayFile[] : Type extends 'json' ? JSONValue<any> : Type extends 'object' ? ObjectColumns extends readonly unknown[] ? ObjectColumns[number] extends {
|
|
7949
9338
|
name: string;
|
|
7950
9339
|
type: string;
|
|
7951
9340
|
} ? UnionToIntersection<Values<{
|
|
@@ -8003,11 +9392,11 @@ declare const le: <T extends ComparableType>(value: T) => ComparableTypeFilter<T
|
|
|
8003
9392
|
/**
|
|
8004
9393
|
* Operator to restrict results to only values that are not null.
|
|
8005
9394
|
*/
|
|
8006
|
-
declare const exists: <T>(column?:
|
|
9395
|
+
declare const exists: <T>(column?: FilterColumns<T> | undefined) => ExistanceFilter<T>;
|
|
8007
9396
|
/**
|
|
8008
9397
|
* Operator to restrict results to only values that are null.
|
|
8009
9398
|
*/
|
|
8010
|
-
declare const notExists: <T>(column?:
|
|
9399
|
+
declare const notExists: <T>(column?: FilterColumns<T> | undefined) => ExistanceFilter<T>;
|
|
8011
9400
|
/**
|
|
8012
9401
|
* Operator to restrict results to only values that start with the given prefix.
|
|
8013
9402
|
*/
|
|
@@ -8020,6 +9409,10 @@ declare const endsWith: (value: string) => StringTypeFilter;
|
|
|
8020
9409
|
* Operator to restrict results to only values that match the given pattern.
|
|
8021
9410
|
*/
|
|
8022
9411
|
declare const pattern: (value: string) => StringTypeFilter;
|
|
9412
|
+
/**
|
|
9413
|
+
* Operator to restrict results to only values that match the given pattern (case insensitive).
|
|
9414
|
+
*/
|
|
9415
|
+
declare const iPattern: (value: string) => StringTypeFilter;
|
|
8023
9416
|
/**
|
|
8024
9417
|
* Operator to restrict results to only values that are equal to the given value.
|
|
8025
9418
|
*/
|
|
@@ -8036,6 +9429,10 @@ declare const isNot: <T>(value: T) => PropertyFilter<T>;
|
|
|
8036
9429
|
* Operator to restrict results to only values that contain the given value.
|
|
8037
9430
|
*/
|
|
8038
9431
|
declare const contains: (value: string) => StringTypeFilter;
|
|
9432
|
+
/**
|
|
9433
|
+
* Operator to restrict results to only values that contain the given value (case insensitive).
|
|
9434
|
+
*/
|
|
9435
|
+
declare const iContains: (value: string) => StringTypeFilter;
|
|
8039
9436
|
/**
|
|
8040
9437
|
* Operator to restrict results if some array items match the predicate.
|
|
8041
9438
|
*/
|
|
@@ -8065,6 +9462,56 @@ declare class SchemaPlugin<Schemas extends Record<string, XataRecord>> extends X
|
|
|
8065
9462
|
build(pluginOptions: XataPluginOptions): SchemaPluginResult<Schemas>;
|
|
8066
9463
|
}
|
|
8067
9464
|
|
|
9465
|
+
type BinaryFile = string | Blob | ArrayBuffer;
|
|
9466
|
+
type FilesPluginResult<Schemas extends Record<string, BaseData>> = {
|
|
9467
|
+
download: <Tables extends StringKeys<Schemas>>(location: DownloadDestination<Schemas, Tables>) => Promise<Blob>;
|
|
9468
|
+
upload: <Tables extends StringKeys<Schemas>>(location: UploadDestination<Schemas, Tables>, file: BinaryFile, options?: {
|
|
9469
|
+
mediaType?: string;
|
|
9470
|
+
}) => Promise<FileResponse>;
|
|
9471
|
+
delete: <Tables extends StringKeys<Schemas>>(location: DownloadDestination<Schemas, Tables>) => Promise<FileResponse>;
|
|
9472
|
+
};
|
|
9473
|
+
type UploadDestination<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = Values<{
|
|
9474
|
+
[Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
|
|
9475
|
+
table: Model;
|
|
9476
|
+
column: ColumnsByValue<Schemas[Model], XataFile>;
|
|
9477
|
+
record: string;
|
|
9478
|
+
} | {
|
|
9479
|
+
table: Model;
|
|
9480
|
+
column: ColumnsByValue<Schemas[Model], XataArrayFile[]>;
|
|
9481
|
+
record: string;
|
|
9482
|
+
fileId?: string;
|
|
9483
|
+
};
|
|
9484
|
+
}>;
|
|
9485
|
+
type DownloadDestination<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = Values<{
|
|
9486
|
+
[Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
|
|
9487
|
+
table: Model;
|
|
9488
|
+
column: ColumnsByValue<Schemas[Model], XataFile>;
|
|
9489
|
+
record: string;
|
|
9490
|
+
} | {
|
|
9491
|
+
table: Model;
|
|
9492
|
+
column: ColumnsByValue<Schemas[Model], XataArrayFile[]>;
|
|
9493
|
+
record: string;
|
|
9494
|
+
fileId: string;
|
|
9495
|
+
};
|
|
9496
|
+
}>;
|
|
9497
|
+
declare class FilesPlugin<Schemas extends Record<string, XataRecord>> extends XataPlugin {
|
|
9498
|
+
build(pluginOptions: XataPluginOptions): FilesPluginResult<Schemas>;
|
|
9499
|
+
}
|
|
9500
|
+
|
|
9501
|
+
type SQLQueryParams<T = any[]> = {
|
|
9502
|
+
statement: string;
|
|
9503
|
+
params?: T;
|
|
9504
|
+
consistency?: 'strong' | 'eventual';
|
|
9505
|
+
};
|
|
9506
|
+
type SQLQuery = TemplateStringsArray | SQLQueryParams | string;
|
|
9507
|
+
type SQLPluginResult = <T>(query: SQLQuery, ...parameters: any[]) => Promise<{
|
|
9508
|
+
records: T[];
|
|
9509
|
+
warning?: string;
|
|
9510
|
+
}>;
|
|
9511
|
+
declare class SQLPlugin extends XataPlugin {
|
|
9512
|
+
build(pluginOptions: XataPluginOptions): SQLPluginResult;
|
|
9513
|
+
}
|
|
9514
|
+
|
|
8068
9515
|
type TransactionOperation<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = {
|
|
8069
9516
|
insert: Values<{
|
|
8070
9517
|
[Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
|
|
@@ -8097,6 +9544,7 @@ type UpdateTransactionOperation<O extends XataRecord> = {
|
|
|
8097
9544
|
};
|
|
8098
9545
|
type DeleteTransactionOperation = {
|
|
8099
9546
|
id: string;
|
|
9547
|
+
failIfMissing?: boolean;
|
|
8100
9548
|
};
|
|
8101
9549
|
type TransactionOperationSingleResult<Schema extends Record<string, BaseData>, Table extends StringKeys<Schema>, Operation extends TransactionOperation<Schema, Table>> = Operation extends {
|
|
8102
9550
|
insert: {
|
|
@@ -8164,6 +9612,8 @@ interface ClientConstructor<Plugins extends Record<string, XataPlugin>> {
|
|
|
8164
9612
|
db: Awaited<ReturnType<SchemaPlugin<Schemas>['build']>>;
|
|
8165
9613
|
search: Awaited<ReturnType<SearchPlugin<Schemas>['build']>>;
|
|
8166
9614
|
transactions: Awaited<ReturnType<TransactionPlugin<Schemas>['build']>>;
|
|
9615
|
+
sql: Awaited<ReturnType<SQLPlugin['build']>>;
|
|
9616
|
+
files: Awaited<ReturnType<FilesPlugin<Schemas>['build']>>;
|
|
8167
9617
|
}, keyof Plugins> & {
|
|
8168
9618
|
[Key in StringKeys<NonNullable<Plugins>>]: Awaited<ReturnType<NonNullable<Plugins>[Key]['build']>>;
|
|
8169
9619
|
} & {
|
|
@@ -8204,20 +9654,20 @@ declare function getPreviewBranch(): string | undefined;
|
|
|
8204
9654
|
|
|
8205
9655
|
interface Body {
|
|
8206
9656
|
arrayBuffer(): Promise<ArrayBuffer>;
|
|
8207
|
-
blob(): Promise<Blob>;
|
|
9657
|
+
blob(): Promise<Blob$1>;
|
|
8208
9658
|
formData(): Promise<FormData>;
|
|
8209
9659
|
json(): Promise<any>;
|
|
8210
9660
|
text(): Promise<string>;
|
|
8211
9661
|
}
|
|
8212
|
-
interface Blob {
|
|
9662
|
+
interface Blob$1 {
|
|
8213
9663
|
readonly size: number;
|
|
8214
9664
|
readonly type: string;
|
|
8215
9665
|
arrayBuffer(): Promise<ArrayBuffer>;
|
|
8216
|
-
slice(start?: number, end?: number, contentType?: string): Blob;
|
|
9666
|
+
slice(start?: number, end?: number, contentType?: string): Blob$1;
|
|
8217
9667
|
text(): Promise<string>;
|
|
8218
9668
|
}
|
|
8219
9669
|
/** Provides information about files and allows JavaScript in a web page to access their content. */
|
|
8220
|
-
interface File extends Blob {
|
|
9670
|
+
interface File extends Blob$1 {
|
|
8221
9671
|
readonly lastModified: number;
|
|
8222
9672
|
readonly name: string;
|
|
8223
9673
|
readonly webkitRelativePath: string;
|
|
@@ -8225,12 +9675,12 @@ interface File extends Blob {
|
|
|
8225
9675
|
type FormDataEntryValue = File | string;
|
|
8226
9676
|
/** Provides a way to easily construct a set of key/value pairs representing form fields and their values, which can then be easily sent using the XMLHttpRequest.send() method. It uses the same format a form would use if the encoding type were set to "multipart/form-data". */
|
|
8227
9677
|
interface FormData {
|
|
8228
|
-
append(name: string, value: string | Blob, fileName?: string): void;
|
|
9678
|
+
append(name: string, value: string | Blob$1, fileName?: string): void;
|
|
8229
9679
|
delete(name: string): void;
|
|
8230
9680
|
get(name: string): FormDataEntryValue | null;
|
|
8231
9681
|
getAll(name: string): FormDataEntryValue[];
|
|
8232
9682
|
has(name: string): boolean;
|
|
8233
|
-
set(name: string, value: string | Blob, fileName?: string): void;
|
|
9683
|
+
set(name: string, value: string | Blob$1, fileName?: string): void;
|
|
8234
9684
|
forEach(callbackfn: (value: FormDataEntryValue, key: string, parent: FormData) => void, thisArg?: any): void;
|
|
8235
9685
|
}
|
|
8236
9686
|
/** This Fetch API interface allows you to perform various actions on HTTP request and response headers. These actions include retrieving, setting, adding to, and removing. A Headers object has an associated header list, which is initially empty and consists of zero or more name and value pairs. You can add to this using methods like append() (see Examples.) In all methods of this interface, header names are matched by case-insensitive byte sequence. */
|
|
@@ -8287,4 +9737,4 @@ declare class XataError extends Error {
|
|
|
8287
9737
|
constructor(message: string, status: number);
|
|
8288
9738
|
}
|
|
8289
9739
|
|
|
8290
|
-
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, AggregateTableError, AggregateTablePathParams, AggregateTableRequestBody, AggregateTableVariables, ApiExtraProps, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditVariables, AskOptions, AskResult, AskTableError, AskTablePathParams, AskTableRequestBody, AskTableResponse, AskTableVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BranchTransactionError, BranchTransactionPathParams, BranchTransactionRequestBody, BranchTransactionVariables, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, ColumnsByValue, CompareBranchSchemasError, CompareBranchSchemasPathParams, CompareBranchSchemasRequestBody, CompareBranchSchemasVariables, CompareBranchWithUserSchemaError, CompareBranchWithUserSchemaPathParams, CompareBranchWithUserSchemaRequestBody, CompareBranchWithUserSchemaVariables, CompareMigrationRequestError, CompareMigrationRequestPathParams, CompareMigrationRequestVariables, CopyBranchError, CopyBranchPathParams, CopyBranchRequestBody, CopyBranchVariables, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchResponse, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateMigrationRequestError, CreateMigrationRequestPathParams, CreateMigrationRequestRequestBody, CreateMigrationRequestResponse, CreateMigrationRequestVariables, CreateTableError, CreateTablePathParams, CreateTableResponse, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchResponse, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabaseGithubSettingsError, DeleteDatabaseGithubSettingsPathParams, DeleteDatabaseGithubSettingsVariables, DeleteDatabasePathParams, DeleteDatabaseResponse, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableResponse, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, DeserializedType, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherError, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchSchemaHistoryError, GetBranchSchemaHistoryPathParams, GetBranchSchemaHistoryRequestBody, GetBranchSchemaHistoryResponse, GetBranchSchemaHistoryVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseGithubSettingsError, GetDatabaseGithubSettingsPathParams, GetDatabaseGithubSettingsVariables, 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, KeywordAskOptions, 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, PushBranchMigrationsError, PushBranchMigrationsPathParams, PushBranchMigrationsRequestBody, PushBranchMigrationsVariables, Query, QueryMigrationRequestsError, QueryMigrationRequestsPathParams, QueryMigrationRequestsRequestBody, QueryMigrationRequestsResponse, QueryMigrationRequestsVariables, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RecordArray, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaInference, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SearchTableError, SearchTablePathParams, SearchTableRequestBody, SearchTableVariables, SearchXataRecord, SelectableColumn, SelectedPick, SerializedString, Serializer, SerializerResult, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, SqlQueryError, SqlQueryPathParams, SqlQueryRequestBody, SqlQueryVariables, SummarizeTableError, SummarizeTablePathParams, SummarizeTableRequestBody, SummarizeTableVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, UpdateBranchSchemaVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateDatabaseGithubSettingsError, UpdateDatabaseGithubSettingsPathParams, UpdateDatabaseGithubSettingsVariables, 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, VectorAskOptions, VectorSearchTableError, VectorSearchTablePathParams, VectorSearchTableRequestBody, VectorSearchTableVariables, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, askTable, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, pushBranchMigrations, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, sqlQuery, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
|
|
9740
|
+
export { type AcceptWorkspaceMemberInviteError, type AcceptWorkspaceMemberInvitePathParams, type AcceptWorkspaceMemberInviteVariables, type AddGitBranchesEntryError, type AddGitBranchesEntryPathParams, type AddGitBranchesEntryRequestBody, type AddGitBranchesEntryResponse, type AddGitBranchesEntryVariables, type AddTableColumnError, type AddTableColumnPathParams, type AddTableColumnVariables, type AggregateTableError, type AggregateTablePathParams, type AggregateTableRequestBody, type AggregateTableVariables, type ApiExtraProps, type ApplyBranchSchemaEditError, type ApplyBranchSchemaEditPathParams, type ApplyBranchSchemaEditRequestBody, type ApplyBranchSchemaEditVariables, type AskOptions, type AskResult, type AskTableError, type AskTablePathParams, type AskTableRequestBody, type AskTableResponse, type AskTableSessionError, type AskTableSessionPathParams, type AskTableSessionRequestBody, type AskTableSessionResponse, type AskTableSessionVariables, type AskTableVariables, BaseClient, type BaseClientOptions, type BaseData, type BaseSchema, type BinaryFile, type BranchTransactionError, type BranchTransactionPathParams, type BranchTransactionRequestBody, type BranchTransactionVariables, type BulkInsertTableRecordsError, type BulkInsertTableRecordsPathParams, type BulkInsertTableRecordsQueryParams, type BulkInsertTableRecordsRequestBody, type BulkInsertTableRecordsVariables, type CacheImpl, type CancelWorkspaceMemberInviteError, type CancelWorkspaceMemberInvitePathParams, type CancelWorkspaceMemberInviteVariables, type ClientConstructor, type ColumnsByValue, type CompareBranchSchemasError, type CompareBranchSchemasPathParams, type CompareBranchSchemasRequestBody, type CompareBranchSchemasVariables, type CompareBranchWithUserSchemaError, type CompareBranchWithUserSchemaPathParams, type CompareBranchWithUserSchemaRequestBody, type CompareBranchWithUserSchemaVariables, type CompareMigrationRequestError, type CompareMigrationRequestPathParams, type CompareMigrationRequestVariables, type CopyBranchError, type CopyBranchPathParams, type CopyBranchRequestBody, type CopyBranchVariables, type CreateBranchError, type CreateBranchPathParams, type CreateBranchQueryParams, type CreateBranchRequestBody, type CreateBranchResponse, type CreateBranchVariables, type CreateClusterError, type CreateClusterPathParams, type CreateClusterVariables, type CreateDatabaseError, type CreateDatabasePathParams, type CreateDatabaseRequestBody, type CreateDatabaseResponse, type CreateDatabaseVariables, type CreateMigrationRequestError, type CreateMigrationRequestPathParams, type CreateMigrationRequestRequestBody, type CreateMigrationRequestResponse, type CreateMigrationRequestVariables, type CreateTableError, type CreateTablePathParams, type CreateTableResponse, type CreateTableVariables, type CreateUserAPIKeyError, type CreateUserAPIKeyPathParams, type CreateUserAPIKeyResponse, type CreateUserAPIKeyVariables, type CreateWorkspaceError, type CreateWorkspaceVariables, type CursorNavigationOptions, type DeleteBranchError, type DeleteBranchPathParams, type DeleteBranchResponse, type DeleteBranchVariables, type DeleteColumnError, type DeleteColumnPathParams, type DeleteColumnVariables, type DeleteDatabaseError, type DeleteDatabaseGithubSettingsError, type DeleteDatabaseGithubSettingsPathParams, type DeleteDatabaseGithubSettingsVariables, type DeleteDatabasePathParams, type DeleteDatabaseResponse, type DeleteDatabaseVariables, type DeleteFileError, type DeleteFileItemError, type DeleteFileItemPathParams, type DeleteFileItemVariables, type DeleteFilePathParams, type DeleteFileVariables, type DeleteOAuthAccessTokenError, type DeleteOAuthAccessTokenPathParams, type DeleteOAuthAccessTokenVariables, type DeleteRecordError, type DeleteRecordPathParams, type DeleteRecordQueryParams, type DeleteRecordVariables, type DeleteTableError, type DeleteTablePathParams, type DeleteTableResponse, type DeleteTableVariables, type DeleteUserAPIKeyError, type DeleteUserAPIKeyPathParams, type DeleteUserAPIKeyVariables, type DeleteUserError, type DeleteUserOAuthClientError, type DeleteUserOAuthClientPathParams, type DeleteUserOAuthClientVariables, type DeleteUserVariables, type DeleteWorkspaceError, type DeleteWorkspacePathParams, type DeleteWorkspaceVariables, type DeserializedType, type DownloadDestination, type EditableData, type ExecuteBranchMigrationPlanError, type ExecuteBranchMigrationPlanPathParams, type ExecuteBranchMigrationPlanRequestBody, type ExecuteBranchMigrationPlanVariables, type FetchImpl, FetcherError, type FetcherExtraProps, type FileAccessError, type FileAccessPathParams, type FileAccessQueryParams, type FileAccessVariables, FilesPlugin, type FilesPluginResult, type GetAuthorizationCodeError, type GetAuthorizationCodeQueryParams, type GetAuthorizationCodeVariables, type GetBranchDetailsError, type GetBranchDetailsPathParams, type GetBranchDetailsVariables, type GetBranchListError, type GetBranchListPathParams, type GetBranchListVariables, type GetBranchMetadataError, type GetBranchMetadataPathParams, type GetBranchMetadataVariables, type GetBranchMigrationHistoryError, type GetBranchMigrationHistoryPathParams, type GetBranchMigrationHistoryRequestBody, type GetBranchMigrationHistoryResponse, type GetBranchMigrationHistoryVariables, type GetBranchMigrationPlanError, type GetBranchMigrationPlanPathParams, type GetBranchMigrationPlanVariables, type GetBranchSchemaHistoryError, type GetBranchSchemaHistoryPathParams, type GetBranchSchemaHistoryRequestBody, type GetBranchSchemaHistoryResponse, type GetBranchSchemaHistoryVariables, type GetBranchStatsError, type GetBranchStatsPathParams, type GetBranchStatsResponse, type GetBranchStatsVariables, type GetClusterError, type GetClusterPathParams, type GetClusterVariables, type GetColumnError, type GetColumnPathParams, type GetColumnVariables, type GetDatabaseGithubSettingsError, type GetDatabaseGithubSettingsPathParams, type GetDatabaseGithubSettingsVariables, type GetDatabaseListError, type GetDatabaseListPathParams, type GetDatabaseListVariables, type GetDatabaseMetadataError, type GetDatabaseMetadataPathParams, type GetDatabaseMetadataVariables, type GetFileError, type GetFileItemError, type GetFileItemPathParams, type GetFileItemVariables, type GetFilePathParams, type GetFileVariables, type GetGitBranchesMappingError, type GetGitBranchesMappingPathParams, type GetGitBranchesMappingVariables, type GetMigrationRequestError, type GetMigrationRequestIsMergedError, type GetMigrationRequestIsMergedPathParams, type GetMigrationRequestIsMergedResponse, type GetMigrationRequestIsMergedVariables, type GetMigrationRequestPathParams, type GetMigrationRequestVariables, type GetRecordError, type GetRecordPathParams, type GetRecordQueryParams, type GetRecordVariables, type GetTableColumnsError, type GetTableColumnsPathParams, type GetTableColumnsResponse, type GetTableColumnsVariables, type GetTableSchemaError, type GetTableSchemaPathParams, type GetTableSchemaResponse, type GetTableSchemaVariables, type GetUserAPIKeysError, type GetUserAPIKeysResponse, type GetUserAPIKeysVariables, type GetUserError, type GetUserOAuthAccessTokensError, type GetUserOAuthAccessTokensResponse, type GetUserOAuthAccessTokensVariables, type GetUserOAuthClientsError, type GetUserOAuthClientsResponse, type GetUserOAuthClientsVariables, type GetUserVariables, type GetWorkspaceError, type GetWorkspaceMembersListError, type GetWorkspaceMembersListPathParams, type GetWorkspaceMembersListVariables, type GetWorkspacePathParams, type GetWorkspaceVariables, type GetWorkspacesListError, type GetWorkspacesListResponse, type GetWorkspacesListVariables, type GrantAuthorizationCodeError, type GrantAuthorizationCodeVariables, type HostProvider, type Identifiable, type ImageTransformations, type InsertRecordError, type InsertRecordPathParams, type InsertRecordQueryParams, type InsertRecordVariables, type InsertRecordWithIDError, type InsertRecordWithIDPathParams, type InsertRecordWithIDQueryParams, type InsertRecordWithIDVariables, type InviteWorkspaceMemberError, type InviteWorkspaceMemberPathParams, type InviteWorkspaceMemberRequestBody, type InviteWorkspaceMemberVariables, type JSONData, type KeywordAskOptions, type Link, type ListClustersError, type ListClustersPathParams, type ListClustersVariables, type ListMigrationRequestsCommitsError, type ListMigrationRequestsCommitsPathParams, type ListMigrationRequestsCommitsRequestBody, type ListMigrationRequestsCommitsResponse, type ListMigrationRequestsCommitsVariables, type ListRegionsError, type ListRegionsPathParams, type ListRegionsVariables, type MergeMigrationRequestError, type MergeMigrationRequestPathParams, type MergeMigrationRequestVariables, type OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, type Paginable, type PaginationQueryMeta, type PreviewBranchSchemaEditError, type PreviewBranchSchemaEditPathParams, type PreviewBranchSchemaEditRequestBody, type PreviewBranchSchemaEditResponse, type PreviewBranchSchemaEditVariables, type PushBranchMigrationsError, type PushBranchMigrationsPathParams, type PushBranchMigrationsRequestBody, type PushBranchMigrationsVariables, type PutFileError, type PutFileItemError, type PutFileItemPathParams, type PutFileItemVariables, type PutFilePathParams, type PutFileVariables, Query, type QueryMigrationRequestsError, type QueryMigrationRequestsPathParams, type QueryMigrationRequestsRequestBody, type QueryMigrationRequestsResponse, type QueryMigrationRequestsVariables, type QueryTableError, type QueryTablePathParams, type QueryTableRequestBody, type QueryTableVariables, RecordArray, RecordColumnTypes, type RemoveGitBranchesEntryError, type RemoveGitBranchesEntryPathParams, type RemoveGitBranchesEntryQueryParams, type RemoveGitBranchesEntryVariables, type RemoveWorkspaceMemberError, type RemoveWorkspaceMemberPathParams, type RemoveWorkspaceMemberVariables, type RenameDatabaseError, type RenameDatabasePathParams, type RenameDatabaseRequestBody, type RenameDatabaseVariables, Repository, type ResendWorkspaceMemberInviteError, type ResendWorkspaceMemberInvitePathParams, type ResendWorkspaceMemberInviteVariables, type ResolveBranchError, type ResolveBranchPathParams, type ResolveBranchQueryParams, type ResolveBranchResponse, type ResolveBranchVariables, responses as Responses, RestRepository, SQLPlugin, type SQLPluginResult, type SQLQuery, type SQLQueryParams, type SchemaDefinition, type SchemaInference, SchemaPlugin, type SchemaPluginResult, schemas as Schemas, type SearchBranchError, type SearchBranchPathParams, type SearchBranchRequestBody, type SearchBranchVariables, type SearchOptions, SearchPlugin, type SearchPluginResult, type SearchTableError, type SearchTablePathParams, type SearchTableRequestBody, type SearchTableVariables, type SearchXataRecord, type SelectableColumn, type SelectableColumnWithObjectNotation, type SelectedPick, type SerializedString, Serializer, type SerializerResult, type SetTableSchemaError, type SetTableSchemaPathParams, type SetTableSchemaRequestBody, type SetTableSchemaVariables, SimpleCache, type SimpleCacheOptions, type SqlQueryError, type SqlQueryPathParams, type SqlQueryRequestBody, type SqlQueryVariables, type SummarizeTableError, type SummarizeTablePathParams, type SummarizeTableRequestBody, type SummarizeTableVariables, type UpdateBranchMetadataError, type UpdateBranchMetadataPathParams, type UpdateBranchMetadataVariables, type UpdateBranchSchemaError, type UpdateBranchSchemaPathParams, type UpdateBranchSchemaVariables, type UpdateClusterError, type UpdateClusterPathParams, type UpdateClusterVariables, type UpdateColumnError, type UpdateColumnPathParams, type UpdateColumnRequestBody, type UpdateColumnVariables, type UpdateDatabaseGithubSettingsError, type UpdateDatabaseGithubSettingsPathParams, type UpdateDatabaseGithubSettingsVariables, type UpdateDatabaseMetadataError, type UpdateDatabaseMetadataPathParams, type UpdateDatabaseMetadataRequestBody, type UpdateDatabaseMetadataVariables, type UpdateMigrationRequestError, type UpdateMigrationRequestPathParams, type UpdateMigrationRequestRequestBody, type UpdateMigrationRequestVariables, type UpdateOAuthAccessTokenError, type UpdateOAuthAccessTokenPathParams, type UpdateOAuthAccessTokenRequestBody, type UpdateOAuthAccessTokenVariables, type UpdateRecordWithIDError, type UpdateRecordWithIDPathParams, type UpdateRecordWithIDQueryParams, type UpdateRecordWithIDVariables, type UpdateTableError, type UpdateTablePathParams, type UpdateTableRequestBody, type UpdateTableVariables, type UpdateUserError, type UpdateUserVariables, type UpdateWorkspaceError, type UpdateWorkspaceMemberInviteError, type UpdateWorkspaceMemberInvitePathParams, type UpdateWorkspaceMemberInviteRequestBody, type UpdateWorkspaceMemberInviteVariables, type UpdateWorkspaceMemberRoleError, type UpdateWorkspaceMemberRolePathParams, type UpdateWorkspaceMemberRoleRequestBody, type UpdateWorkspaceMemberRoleVariables, type UpdateWorkspacePathParams, type UpdateWorkspaceVariables, type UploadDestination, type UpsertRecordWithIDError, type UpsertRecordWithIDPathParams, type UpsertRecordWithIDQueryParams, type UpsertRecordWithIDVariables, type ValueAtColumn, type VectorAskOptions, type VectorSearchTableError, type VectorSearchTablePathParams, type VectorSearchTableRequestBody, type VectorSearchTableVariables, XataApiClient, type XataApiClientOptions, XataApiPlugin, type XataArrayFile, XataError, XataFile, XataPlugin, type XataPluginOptions, type XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, askTable, askTableSession, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createCluster, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteFile, deleteFileItem, deleteOAuthAccessToken, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteUserOAuthClient, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, fileAccess, ge, getAPIKey, getAuthorizationCode, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getCluster, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getFile, getFileItem, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getUserOAuthAccessTokens, getUserOAuthClients, getWorkspace, getWorkspaceMembersList, getWorkspacesList, grantAuthorizationCode, greaterEquals, greaterThan, greaterThanEquals, gt, gte, iContains, iPattern, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isValidExpandedColumn, isValidSelectableColumns, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listClusters, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, pushBranchMigrations, putFile, putFileItem, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, renameDatabase, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, sqlQuery, startsWith, summarizeTable, transformImage, updateBranchMetadata, updateBranchSchema, updateCluster, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateOAuthAccessToken, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
|