@xata.io/client 0.0.0-alpha.vfc4a5e4 → 0.0.0-alpha.vfc4cc60
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 -9
- package/CHANGELOG.md +125 -1
- package/dist/index.cjs +644 -190
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +1141 -362
- package/dist/index.mjs +621 -189
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
@@ -109,6 +109,26 @@ type ErrorWrapper$1<TError> = TError | {
|
|
109
109
|
*
|
110
110
|
* @version 1.0
|
111
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
|
+
};
|
112
132
|
type User = {
|
113
133
|
/**
|
114
134
|
* @format email
|
@@ -133,6 +153,31 @@ type DateTime$1 = string;
|
|
133
153
|
* @pattern [a-zA-Z0-9_\-~]*
|
134
154
|
*/
|
135
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;
|
136
181
|
/**
|
137
182
|
* @pattern ^([a-zA-Z0-9][a-zA-Z0-9_\-~]+-)?[a-zA-Z0-9]{6}
|
138
183
|
* @x-go-type auth.WorkspaceID
|
@@ -142,6 +187,7 @@ type WorkspaceID = string;
|
|
142
187
|
* @x-go-type auth.Role
|
143
188
|
*/
|
144
189
|
type Role = 'owner' | 'maintainer';
|
190
|
+
type WorkspacePlan = 'free' | 'pro';
|
145
191
|
type WorkspaceMeta = {
|
146
192
|
name: string;
|
147
193
|
slug?: string;
|
@@ -149,7 +195,7 @@ type WorkspaceMeta = {
|
|
149
195
|
type Workspace = WorkspaceMeta & {
|
150
196
|
id: WorkspaceID;
|
151
197
|
memberCount: number;
|
152
|
-
plan:
|
198
|
+
plan: WorkspacePlan;
|
153
199
|
};
|
154
200
|
type WorkspaceMember = {
|
155
201
|
userId: UserID;
|
@@ -184,6 +230,170 @@ type WorkspaceMembers = {
|
|
184
230
|
* @pattern ^ik_[a-zA-Z0-9]+
|
185
231
|
*/
|
186
232
|
type InviteKey = string;
|
233
|
+
/**
|
234
|
+
* @x-internal true
|
235
|
+
* @pattern [a-zA-Z0-9_-~:]+
|
236
|
+
*/
|
237
|
+
type ClusterID = string;
|
238
|
+
/**
|
239
|
+
* @x-internal true
|
240
|
+
*/
|
241
|
+
type ClusterShortMetadata = {
|
242
|
+
id: ClusterID;
|
243
|
+
state: string;
|
244
|
+
region: string;
|
245
|
+
name: string;
|
246
|
+
/**
|
247
|
+
* @format int64
|
248
|
+
*/
|
249
|
+
branches: number;
|
250
|
+
};
|
251
|
+
/**
|
252
|
+
* @x-internal true
|
253
|
+
*/
|
254
|
+
type ListClustersResponse = {
|
255
|
+
clusters: ClusterShortMetadata[];
|
256
|
+
};
|
257
|
+
/**
|
258
|
+
* @x-internal true
|
259
|
+
*/
|
260
|
+
type AutoscalingConfig = {
|
261
|
+
/**
|
262
|
+
* @format double
|
263
|
+
* @default 2
|
264
|
+
*/
|
265
|
+
minCapacity?: number;
|
266
|
+
/**
|
267
|
+
* @format double
|
268
|
+
* @default 16
|
269
|
+
*/
|
270
|
+
maxCapacity?: number;
|
271
|
+
};
|
272
|
+
/**
|
273
|
+
* @x-internal true
|
274
|
+
*/
|
275
|
+
type WeeklyTimeWindow = {
|
276
|
+
day: 'mon' | 'tue' | 'wed' | 'thu' | 'fri' | 'sat' | 'sun';
|
277
|
+
/**
|
278
|
+
* @maximum 24
|
279
|
+
* @minimum 0
|
280
|
+
*/
|
281
|
+
hour: number;
|
282
|
+
/**
|
283
|
+
* @maximum 60
|
284
|
+
* @minimum 0
|
285
|
+
*/
|
286
|
+
minute: number;
|
287
|
+
/**
|
288
|
+
* @format float
|
289
|
+
* @maximum 23.5
|
290
|
+
* @minimum 0.5
|
291
|
+
*/
|
292
|
+
duration: number;
|
293
|
+
};
|
294
|
+
/**
|
295
|
+
* @x-internal true
|
296
|
+
*/
|
297
|
+
type DailyTimeWindow = {
|
298
|
+
/**
|
299
|
+
* @maximum 24
|
300
|
+
* @minimum 0
|
301
|
+
*/
|
302
|
+
hour: number;
|
303
|
+
/**
|
304
|
+
* @maximum 60
|
305
|
+
* @minimum 0
|
306
|
+
*/
|
307
|
+
minute: number;
|
308
|
+
/**
|
309
|
+
* @format float
|
310
|
+
*/
|
311
|
+
duration: number;
|
312
|
+
};
|
313
|
+
/**
|
314
|
+
* @x-internal true
|
315
|
+
*/
|
316
|
+
type MaintenanceConfig = {
|
317
|
+
/**
|
318
|
+
* @default false
|
319
|
+
*/
|
320
|
+
autoMinorVersionUpgrade?: boolean;
|
321
|
+
/**
|
322
|
+
* @default false
|
323
|
+
*/
|
324
|
+
applyImmediately?: boolean;
|
325
|
+
maintenanceWindow?: WeeklyTimeWindow;
|
326
|
+
backupWindow?: DailyTimeWindow;
|
327
|
+
};
|
328
|
+
/**
|
329
|
+
* @x-internal true
|
330
|
+
*/
|
331
|
+
type ClusterConfiguration = {
|
332
|
+
engineVersion: string;
|
333
|
+
instanceType: string;
|
334
|
+
/**
|
335
|
+
* @format int64
|
336
|
+
*/
|
337
|
+
replicas?: number;
|
338
|
+
/**
|
339
|
+
* @default false
|
340
|
+
*/
|
341
|
+
deletionProtection?: boolean;
|
342
|
+
autoscaling?: AutoscalingConfig;
|
343
|
+
maintenance?: MaintenanceConfig;
|
344
|
+
};
|
345
|
+
/**
|
346
|
+
* @x-internal true
|
347
|
+
*/
|
348
|
+
type ClusterCreateDetails = {
|
349
|
+
/**
|
350
|
+
* @minLength 1
|
351
|
+
*/
|
352
|
+
region: string;
|
353
|
+
/**
|
354
|
+
* @maxLength 63
|
355
|
+
* @minLength 1
|
356
|
+
* @pattern [a-zA-Z0-9_-~:]+
|
357
|
+
*/
|
358
|
+
name: string;
|
359
|
+
configuration: ClusterConfiguration;
|
360
|
+
};
|
361
|
+
/**
|
362
|
+
* @x-internal true
|
363
|
+
*/
|
364
|
+
type ClusterResponse = {
|
365
|
+
state: string;
|
366
|
+
clusterID: string;
|
367
|
+
};
|
368
|
+
/**
|
369
|
+
* @x-internal true
|
370
|
+
*/
|
371
|
+
type ClusterMetadata = {
|
372
|
+
id: ClusterID;
|
373
|
+
state: string;
|
374
|
+
region: string;
|
375
|
+
name: string;
|
376
|
+
/**
|
377
|
+
* @format int64
|
378
|
+
*/
|
379
|
+
branches: number;
|
380
|
+
configuration?: ClusterConfiguration;
|
381
|
+
};
|
382
|
+
/**
|
383
|
+
* @x-internal true
|
384
|
+
*/
|
385
|
+
type ClusterUpdateDetails = {
|
386
|
+
id: ClusterID;
|
387
|
+
/**
|
388
|
+
* @maxLength 63
|
389
|
+
* @minLength 1
|
390
|
+
* @pattern [a-zA-Z0-9_-~:]+
|
391
|
+
*/
|
392
|
+
name?: string;
|
393
|
+
configuration?: ClusterConfiguration;
|
394
|
+
state?: string;
|
395
|
+
region?: string;
|
396
|
+
};
|
187
397
|
/**
|
188
398
|
* Metadata of databases
|
189
399
|
*/
|
@@ -300,6 +510,53 @@ type SimpleError$1 = {
|
|
300
510
|
* @version 1.0
|
301
511
|
*/
|
302
512
|
|
513
|
+
type GetAuthorizationCodeQueryParams = {
|
514
|
+
clientID: string;
|
515
|
+
responseType: OAuthResponseType;
|
516
|
+
redirectUri?: string;
|
517
|
+
scopes?: OAuthScope[];
|
518
|
+
state?: string;
|
519
|
+
};
|
520
|
+
type GetAuthorizationCodeError = ErrorWrapper$1<{
|
521
|
+
status: 400;
|
522
|
+
payload: BadRequestError$1;
|
523
|
+
} | {
|
524
|
+
status: 401;
|
525
|
+
payload: AuthError$1;
|
526
|
+
} | {
|
527
|
+
status: 404;
|
528
|
+
payload: SimpleError$1;
|
529
|
+
} | {
|
530
|
+
status: 409;
|
531
|
+
payload: SimpleError$1;
|
532
|
+
}>;
|
533
|
+
type GetAuthorizationCodeVariables = {
|
534
|
+
queryParams: GetAuthorizationCodeQueryParams;
|
535
|
+
} & ControlPlaneFetcherExtraProps;
|
536
|
+
/**
|
537
|
+
* Creates, stores and returns an authorization code to be used by a third party app. Supporting use of GET is required by OAuth2 spec
|
538
|
+
*/
|
539
|
+
declare const getAuthorizationCode: (variables: GetAuthorizationCodeVariables, signal?: AbortSignal) => Promise<AuthorizationCodeResponse>;
|
540
|
+
type GrantAuthorizationCodeError = ErrorWrapper$1<{
|
541
|
+
status: 400;
|
542
|
+
payload: BadRequestError$1;
|
543
|
+
} | {
|
544
|
+
status: 401;
|
545
|
+
payload: AuthError$1;
|
546
|
+
} | {
|
547
|
+
status: 404;
|
548
|
+
payload: SimpleError$1;
|
549
|
+
} | {
|
550
|
+
status: 409;
|
551
|
+
payload: SimpleError$1;
|
552
|
+
}>;
|
553
|
+
type GrantAuthorizationCodeVariables = {
|
554
|
+
body: AuthorizationCodeRequest;
|
555
|
+
} & ControlPlaneFetcherExtraProps;
|
556
|
+
/**
|
557
|
+
* Creates, stores and returns an authorization code to be used by a third party app
|
558
|
+
*/
|
559
|
+
declare const grantAuthorizationCode: (variables: GrantAuthorizationCodeVariables, signal?: AbortSignal) => Promise<AuthorizationCodeResponse>;
|
303
560
|
type GetUserError = ErrorWrapper$1<{
|
304
561
|
status: 400;
|
305
562
|
payload: BadRequestError$1;
|
@@ -419,6 +676,115 @@ type DeleteUserAPIKeyVariables = {
|
|
419
676
|
* Delete an existing API key
|
420
677
|
*/
|
421
678
|
declare const deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal) => Promise<undefined>;
|
679
|
+
type GetUserOAuthClientsError = ErrorWrapper$1<{
|
680
|
+
status: 400;
|
681
|
+
payload: BadRequestError$1;
|
682
|
+
} | {
|
683
|
+
status: 401;
|
684
|
+
payload: AuthError$1;
|
685
|
+
} | {
|
686
|
+
status: 404;
|
687
|
+
payload: SimpleError$1;
|
688
|
+
}>;
|
689
|
+
type GetUserOAuthClientsResponse = {
|
690
|
+
clients?: OAuthClientPublicDetails[];
|
691
|
+
};
|
692
|
+
type GetUserOAuthClientsVariables = ControlPlaneFetcherExtraProps;
|
693
|
+
/**
|
694
|
+
* Retrieve the list of OAuth Clients that a user has authorized
|
695
|
+
*/
|
696
|
+
declare const getUserOAuthClients: (variables: GetUserOAuthClientsVariables, signal?: AbortSignal) => Promise<GetUserOAuthClientsResponse>;
|
697
|
+
type DeleteUserOAuthClientPathParams = {
|
698
|
+
clientId: OAuthClientID;
|
699
|
+
};
|
700
|
+
type DeleteUserOAuthClientError = ErrorWrapper$1<{
|
701
|
+
status: 400;
|
702
|
+
payload: BadRequestError$1;
|
703
|
+
} | {
|
704
|
+
status: 401;
|
705
|
+
payload: AuthError$1;
|
706
|
+
} | {
|
707
|
+
status: 404;
|
708
|
+
payload: SimpleError$1;
|
709
|
+
}>;
|
710
|
+
type DeleteUserOAuthClientVariables = {
|
711
|
+
pathParams: DeleteUserOAuthClientPathParams;
|
712
|
+
} & ControlPlaneFetcherExtraProps;
|
713
|
+
/**
|
714
|
+
* Delete the oauth client for the user and revoke all access
|
715
|
+
*/
|
716
|
+
declare const deleteUserOAuthClient: (variables: DeleteUserOAuthClientVariables, signal?: AbortSignal) => Promise<undefined>;
|
717
|
+
type GetUserOAuthAccessTokensError = ErrorWrapper$1<{
|
718
|
+
status: 400;
|
719
|
+
payload: BadRequestError$1;
|
720
|
+
} | {
|
721
|
+
status: 401;
|
722
|
+
payload: AuthError$1;
|
723
|
+
} | {
|
724
|
+
status: 404;
|
725
|
+
payload: SimpleError$1;
|
726
|
+
}>;
|
727
|
+
type GetUserOAuthAccessTokensResponse = {
|
728
|
+
accessTokens: OAuthAccessToken[];
|
729
|
+
};
|
730
|
+
type GetUserOAuthAccessTokensVariables = ControlPlaneFetcherExtraProps;
|
731
|
+
/**
|
732
|
+
* Retrieve the list of valid OAuth Access Tokens on the current user's account
|
733
|
+
*/
|
734
|
+
declare const getUserOAuthAccessTokens: (variables: GetUserOAuthAccessTokensVariables, signal?: AbortSignal) => Promise<GetUserOAuthAccessTokensResponse>;
|
735
|
+
type DeleteOAuthAccessTokenPathParams = {
|
736
|
+
token: AccessToken;
|
737
|
+
};
|
738
|
+
type DeleteOAuthAccessTokenError = ErrorWrapper$1<{
|
739
|
+
status: 400;
|
740
|
+
payload: BadRequestError$1;
|
741
|
+
} | {
|
742
|
+
status: 401;
|
743
|
+
payload: AuthError$1;
|
744
|
+
} | {
|
745
|
+
status: 404;
|
746
|
+
payload: SimpleError$1;
|
747
|
+
} | {
|
748
|
+
status: 409;
|
749
|
+
payload: SimpleError$1;
|
750
|
+
}>;
|
751
|
+
type DeleteOAuthAccessTokenVariables = {
|
752
|
+
pathParams: DeleteOAuthAccessTokenPathParams;
|
753
|
+
} & ControlPlaneFetcherExtraProps;
|
754
|
+
/**
|
755
|
+
* Expires the access token for a third party app
|
756
|
+
*/
|
757
|
+
declare const deleteOAuthAccessToken: (variables: DeleteOAuthAccessTokenVariables, signal?: AbortSignal) => Promise<undefined>;
|
758
|
+
type UpdateOAuthAccessTokenPathParams = {
|
759
|
+
token: AccessToken;
|
760
|
+
};
|
761
|
+
type UpdateOAuthAccessTokenError = ErrorWrapper$1<{
|
762
|
+
status: 400;
|
763
|
+
payload: BadRequestError$1;
|
764
|
+
} | {
|
765
|
+
status: 401;
|
766
|
+
payload: AuthError$1;
|
767
|
+
} | {
|
768
|
+
status: 404;
|
769
|
+
payload: SimpleError$1;
|
770
|
+
} | {
|
771
|
+
status: 409;
|
772
|
+
payload: SimpleError$1;
|
773
|
+
}>;
|
774
|
+
type UpdateOAuthAccessTokenRequestBody = {
|
775
|
+
/**
|
776
|
+
* expiration time of the token as a unix timestamp
|
777
|
+
*/
|
778
|
+
expires: number;
|
779
|
+
};
|
780
|
+
type UpdateOAuthAccessTokenVariables = {
|
781
|
+
body: UpdateOAuthAccessTokenRequestBody;
|
782
|
+
pathParams: UpdateOAuthAccessTokenPathParams;
|
783
|
+
} & ControlPlaneFetcherExtraProps;
|
784
|
+
/**
|
785
|
+
* Updates partially the access token for a third party app
|
786
|
+
*/
|
787
|
+
declare const updateOAuthAccessToken: (variables: UpdateOAuthAccessTokenVariables, signal?: AbortSignal) => Promise<OAuthAccessToken>;
|
422
788
|
type GetWorkspacesListError = ErrorWrapper$1<{
|
423
789
|
status: 400;
|
424
790
|
payload: BadRequestError$1;
|
@@ -435,6 +801,7 @@ type GetWorkspacesListResponse = {
|
|
435
801
|
name: string;
|
436
802
|
slug: string;
|
437
803
|
role: Role;
|
804
|
+
plan: WorkspacePlan;
|
438
805
|
}[];
|
439
806
|
};
|
440
807
|
type GetWorkspacesListVariables = ControlPlaneFetcherExtraProps;
|
@@ -792,6 +1159,99 @@ type ResendWorkspaceMemberInviteVariables = {
|
|
792
1159
|
* This operation provides a way to resend an Invite notification. Invite notifications can only be sent for Invites not yet accepted.
|
793
1160
|
*/
|
794
1161
|
declare const resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal) => Promise<undefined>;
|
1162
|
+
type ListClustersPathParams = {
|
1163
|
+
/**
|
1164
|
+
* Workspace ID
|
1165
|
+
*/
|
1166
|
+
workspaceId: WorkspaceID;
|
1167
|
+
};
|
1168
|
+
type ListClustersError = ErrorWrapper$1<{
|
1169
|
+
status: 400;
|
1170
|
+
payload: BadRequestError$1;
|
1171
|
+
} | {
|
1172
|
+
status: 401;
|
1173
|
+
payload: AuthError$1;
|
1174
|
+
}>;
|
1175
|
+
type ListClustersVariables = {
|
1176
|
+
pathParams: ListClustersPathParams;
|
1177
|
+
} & ControlPlaneFetcherExtraProps;
|
1178
|
+
/**
|
1179
|
+
* List all clusters available in your Workspace.
|
1180
|
+
*/
|
1181
|
+
declare const listClusters: (variables: ListClustersVariables, signal?: AbortSignal) => Promise<ListClustersResponse>;
|
1182
|
+
type CreateClusterPathParams = {
|
1183
|
+
/**
|
1184
|
+
* Workspace ID
|
1185
|
+
*/
|
1186
|
+
workspaceId: WorkspaceID;
|
1187
|
+
};
|
1188
|
+
type CreateClusterError = ErrorWrapper$1<{
|
1189
|
+
status: 400;
|
1190
|
+
payload: BadRequestError$1;
|
1191
|
+
} | {
|
1192
|
+
status: 401;
|
1193
|
+
payload: AuthError$1;
|
1194
|
+
} | {
|
1195
|
+
status: 422;
|
1196
|
+
payload: SimpleError$1;
|
1197
|
+
} | {
|
1198
|
+
status: 423;
|
1199
|
+
payload: SimpleError$1;
|
1200
|
+
}>;
|
1201
|
+
type CreateClusterVariables = {
|
1202
|
+
body: ClusterCreateDetails;
|
1203
|
+
pathParams: CreateClusterPathParams;
|
1204
|
+
} & ControlPlaneFetcherExtraProps;
|
1205
|
+
declare const createCluster: (variables: CreateClusterVariables, signal?: AbortSignal) => Promise<ClusterResponse>;
|
1206
|
+
type GetClusterPathParams = {
|
1207
|
+
/**
|
1208
|
+
* Workspace ID
|
1209
|
+
*/
|
1210
|
+
workspaceId: WorkspaceID;
|
1211
|
+
/**
|
1212
|
+
* Cluster ID
|
1213
|
+
*/
|
1214
|
+
clusterId: ClusterID;
|
1215
|
+
};
|
1216
|
+
type GetClusterError = ErrorWrapper$1<{
|
1217
|
+
status: 400;
|
1218
|
+
payload: BadRequestError$1;
|
1219
|
+
} | {
|
1220
|
+
status: 401;
|
1221
|
+
payload: AuthError$1;
|
1222
|
+
}>;
|
1223
|
+
type GetClusterVariables = {
|
1224
|
+
pathParams: GetClusterPathParams;
|
1225
|
+
} & ControlPlaneFetcherExtraProps;
|
1226
|
+
/**
|
1227
|
+
* Retrieve metadata for given cluster ID
|
1228
|
+
*/
|
1229
|
+
declare const getCluster: (variables: GetClusterVariables, signal?: AbortSignal) => Promise<ClusterMetadata>;
|
1230
|
+
type UpdateClusterPathParams = {
|
1231
|
+
/**
|
1232
|
+
* Workspace ID
|
1233
|
+
*/
|
1234
|
+
workspaceId: WorkspaceID;
|
1235
|
+
/**
|
1236
|
+
* Cluster ID
|
1237
|
+
*/
|
1238
|
+
clusterId: ClusterID;
|
1239
|
+
};
|
1240
|
+
type UpdateClusterError = ErrorWrapper$1<{
|
1241
|
+
status: 400;
|
1242
|
+
payload: BadRequestError$1;
|
1243
|
+
} | {
|
1244
|
+
status: 401;
|
1245
|
+
payload: AuthError$1;
|
1246
|
+
}>;
|
1247
|
+
type UpdateClusterVariables = {
|
1248
|
+
body: ClusterUpdateDetails;
|
1249
|
+
pathParams: UpdateClusterPathParams;
|
1250
|
+
} & ControlPlaneFetcherExtraProps;
|
1251
|
+
/**
|
1252
|
+
* Update cluster for given cluster ID
|
1253
|
+
*/
|
1254
|
+
declare const updateCluster: (variables: UpdateClusterVariables, signal?: AbortSignal) => Promise<ClusterMetadata>;
|
795
1255
|
type GetDatabaseListPathParams = {
|
796
1256
|
/**
|
797
1257
|
* Workspace ID
|
@@ -852,6 +1312,13 @@ type CreateDatabaseRequestBody = {
|
|
852
1312
|
* @minLength 1
|
853
1313
|
*/
|
854
1314
|
region: string;
|
1315
|
+
/**
|
1316
|
+
* The dedicated cluster where branches from this database will be created. Defaults to 'xata-cloud'.
|
1317
|
+
*
|
1318
|
+
* @minLength 1
|
1319
|
+
* @x-internal true
|
1320
|
+
*/
|
1321
|
+
defaultClusterID?: string;
|
855
1322
|
ui?: {
|
856
1323
|
color?: string;
|
857
1324
|
};
|
@@ -1106,6 +1573,25 @@ declare const listRegions: (variables: ListRegionsVariables, signal?: AbortSigna
|
|
1106
1573
|
*
|
1107
1574
|
* @version 1.0
|
1108
1575
|
*/
|
1576
|
+
/**
|
1577
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
1578
|
+
*
|
1579
|
+
* @maxLength 511
|
1580
|
+
* @minLength 1
|
1581
|
+
* @pattern [a-zA-Z0-9_\-~]+:[a-zA-Z0-9_\-~]+
|
1582
|
+
*/
|
1583
|
+
type DBBranchName = string;
|
1584
|
+
type PgRollMigrationStatus = 'no migrations' | 'in progress' | 'complete';
|
1585
|
+
type PgRollStatusResponse = {
|
1586
|
+
/**
|
1587
|
+
* The status of the most recent migration
|
1588
|
+
*/
|
1589
|
+
status: PgRollMigrationStatus;
|
1590
|
+
/**
|
1591
|
+
* The name of the most recent version
|
1592
|
+
*/
|
1593
|
+
version: string;
|
1594
|
+
};
|
1109
1595
|
/**
|
1110
1596
|
* @maxLength 255
|
1111
1597
|
* @minLength 1
|
@@ -1125,14 +1611,6 @@ type ListBranchesResponse = {
|
|
1125
1611
|
databaseName: string;
|
1126
1612
|
branches: Branch[];
|
1127
1613
|
};
|
1128
|
-
/**
|
1129
|
-
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
1130
|
-
*
|
1131
|
-
* @maxLength 511
|
1132
|
-
* @minLength 1
|
1133
|
-
* @pattern [a-zA-Z0-9_\-~]+:[a-zA-Z0-9_\-~]+
|
1134
|
-
*/
|
1135
|
-
type DBBranchName = string;
|
1136
1614
|
/**
|
1137
1615
|
* @maxLength 255
|
1138
1616
|
* @minLength 1
|
@@ -1181,7 +1659,7 @@ type ColumnFile = {
|
|
1181
1659
|
};
|
1182
1660
|
type Column = {
|
1183
1661
|
name: string;
|
1184
|
-
type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object' | 'datetime' | 'vector' | 'file[]' | 'file';
|
1662
|
+
type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object' | 'datetime' | 'vector' | 'file[]' | 'file' | 'json';
|
1185
1663
|
link?: ColumnLink;
|
1186
1664
|
vector?: ColumnVector;
|
1187
1665
|
file?: ColumnFile;
|
@@ -1192,8 +1670,8 @@ type Column = {
|
|
1192
1670
|
columns?: Column[];
|
1193
1671
|
};
|
1194
1672
|
type RevLink = {
|
1195
|
-
linkID: string;
|
1196
1673
|
table: string;
|
1674
|
+
column: string;
|
1197
1675
|
};
|
1198
1676
|
type Table = {
|
1199
1677
|
id?: string;
|
@@ -1315,9 +1793,11 @@ type FilterPredicateOp = {
|
|
1315
1793
|
$gt?: FilterRangeValue;
|
1316
1794
|
$ge?: FilterRangeValue;
|
1317
1795
|
$contains?: string;
|
1796
|
+
$iContains?: string;
|
1318
1797
|
$startsWith?: string;
|
1319
1798
|
$endsWith?: string;
|
1320
1799
|
$pattern?: string;
|
1800
|
+
$iPattern?: string;
|
1321
1801
|
};
|
1322
1802
|
/**
|
1323
1803
|
* @maxProperties 2
|
@@ -2066,12 +2546,6 @@ type SearchPageConfig = {
|
|
2066
2546
|
*/
|
2067
2547
|
offset?: number;
|
2068
2548
|
};
|
2069
|
-
/**
|
2070
|
-
* Xata Table SQL Record
|
2071
|
-
*/
|
2072
|
-
type SQLRecord = {
|
2073
|
-
[key: string]: any;
|
2074
|
-
};
|
2075
2549
|
/**
|
2076
2550
|
* A summary expression is the description of a single summary operation. It consists of a single
|
2077
2551
|
* key representing the operation, and a value representing the column to be operated on.
|
@@ -2168,6 +2642,16 @@ type AverageAgg = {
|
|
2168
2642
|
*/
|
2169
2643
|
column: string;
|
2170
2644
|
};
|
2645
|
+
/**
|
2646
|
+
* Calculate given percentiles of the numeric values in a particular column.
|
2647
|
+
*/
|
2648
|
+
type PercentilesAgg = {
|
2649
|
+
/**
|
2650
|
+
* The column on which to compute the average. Must be a numeric type.
|
2651
|
+
*/
|
2652
|
+
column: string;
|
2653
|
+
percentiles: number[];
|
2654
|
+
};
|
2171
2655
|
/**
|
2172
2656
|
* Count the number of distinct values in a particular column.
|
2173
2657
|
*/
|
@@ -2282,6 +2766,8 @@ type AggExpression = {
|
|
2282
2766
|
min?: MinAgg;
|
2283
2767
|
} | {
|
2284
2768
|
average?: AverageAgg;
|
2769
|
+
} | {
|
2770
|
+
percentiles?: PercentilesAgg;
|
2285
2771
|
} | {
|
2286
2772
|
uniqueCount?: UniqueCountAgg;
|
2287
2773
|
} | {
|
@@ -2297,7 +2783,9 @@ type AggResponse$1 = (number | null) | {
|
|
2297
2783
|
$count: number;
|
2298
2784
|
} & {
|
2299
2785
|
[key: string]: AggResponse$1;
|
2300
|
-
})[]
|
2786
|
+
})[] | {
|
2787
|
+
[key: string]: number;
|
2788
|
+
};
|
2301
2789
|
};
|
2302
2790
|
/**
|
2303
2791
|
* File identifier in access URLs
|
@@ -2311,6 +2799,12 @@ type FileAccessID = string;
|
|
2311
2799
|
* File signature
|
2312
2800
|
*/
|
2313
2801
|
type FileSignature = string;
|
2802
|
+
/**
|
2803
|
+
* Xata Table SQL Record
|
2804
|
+
*/
|
2805
|
+
type SQLRecord = {
|
2806
|
+
[key: string]: any;
|
2807
|
+
};
|
2314
2808
|
/**
|
2315
2809
|
* Xata Table Record Metadata
|
2316
2810
|
*/
|
@@ -2392,10 +2886,10 @@ type ServiceUnavailableError = {
|
|
2392
2886
|
type SearchResponse = {
|
2393
2887
|
records: XataRecord$1[];
|
2394
2888
|
warning?: string;
|
2395
|
-
|
2396
|
-
|
2397
|
-
|
2398
|
-
|
2889
|
+
/**
|
2890
|
+
* The total count of records matched. It will be accurately returned up to 10000 records.
|
2891
|
+
*/
|
2892
|
+
totalCount: number;
|
2399
2893
|
};
|
2400
2894
|
type SummarizeResponse = {
|
2401
2895
|
summaries: Record<string, any>[];
|
@@ -2408,6 +2902,18 @@ type AggResponse = {
|
|
2408
2902
|
[key: string]: AggResponse$1;
|
2409
2903
|
};
|
2410
2904
|
};
|
2905
|
+
type SQLResponse = {
|
2906
|
+
records?: SQLRecord[];
|
2907
|
+
/**
|
2908
|
+
* Name of the column and its PostgreSQL type
|
2909
|
+
*/
|
2910
|
+
columns?: Record<string, any>;
|
2911
|
+
/**
|
2912
|
+
* Number of selected columns
|
2913
|
+
*/
|
2914
|
+
total?: number;
|
2915
|
+
warning?: string;
|
2916
|
+
};
|
2411
2917
|
|
2412
2918
|
type DataPlaneFetcherExtraProps = {
|
2413
2919
|
apiUrl: string;
|
@@ -2420,18 +2926,71 @@ type DataPlaneFetcherExtraProps = {
|
|
2420
2926
|
sessionID?: string;
|
2421
2927
|
clientName?: string;
|
2422
2928
|
xataAgentExtra?: Record<string, string>;
|
2929
|
+
rawResponse?: boolean;
|
2930
|
+
headers?: Record<string, unknown>;
|
2423
2931
|
};
|
2424
2932
|
type ErrorWrapper<TError> = TError | {
|
2425
2933
|
status: 'unknown';
|
2426
2934
|
payload: string;
|
2427
2935
|
};
|
2428
|
-
|
2429
|
-
/**
|
2430
|
-
* Generated by @openapi-codegen
|
2431
|
-
*
|
2432
|
-
* @version 1.0
|
2433
|
-
*/
|
2434
|
-
|
2936
|
+
|
2937
|
+
/**
|
2938
|
+
* Generated by @openapi-codegen
|
2939
|
+
*
|
2940
|
+
* @version 1.0
|
2941
|
+
*/
|
2942
|
+
|
2943
|
+
type ApplyMigrationPathParams = {
|
2944
|
+
/**
|
2945
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2946
|
+
*/
|
2947
|
+
dbBranchName: DBBranchName;
|
2948
|
+
workspace: string;
|
2949
|
+
region: string;
|
2950
|
+
};
|
2951
|
+
type ApplyMigrationError = ErrorWrapper<{
|
2952
|
+
status: 400;
|
2953
|
+
payload: BadRequestError;
|
2954
|
+
} | {
|
2955
|
+
status: 401;
|
2956
|
+
payload: AuthError;
|
2957
|
+
} | {
|
2958
|
+
status: 404;
|
2959
|
+
payload: SimpleError;
|
2960
|
+
}>;
|
2961
|
+
type ApplyMigrationRequestBody = {
|
2962
|
+
[key: string]: any;
|
2963
|
+
}[];
|
2964
|
+
type ApplyMigrationVariables = {
|
2965
|
+
body?: ApplyMigrationRequestBody;
|
2966
|
+
pathParams: ApplyMigrationPathParams;
|
2967
|
+
} & DataPlaneFetcherExtraProps;
|
2968
|
+
/**
|
2969
|
+
* Applies a pgroll migration to the specified database.
|
2970
|
+
*/
|
2971
|
+
declare const applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal) => Promise<undefined>;
|
2972
|
+
type PgRollStatusPathParams = {
|
2973
|
+
/**
|
2974
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2975
|
+
*/
|
2976
|
+
dbBranchName: DBBranchName;
|
2977
|
+
workspace: string;
|
2978
|
+
region: string;
|
2979
|
+
};
|
2980
|
+
type PgRollStatusError = ErrorWrapper<{
|
2981
|
+
status: 400;
|
2982
|
+
payload: BadRequestError;
|
2983
|
+
} | {
|
2984
|
+
status: 401;
|
2985
|
+
payload: AuthError;
|
2986
|
+
} | {
|
2987
|
+
status: 404;
|
2988
|
+
payload: SimpleError;
|
2989
|
+
}>;
|
2990
|
+
type PgRollStatusVariables = {
|
2991
|
+
pathParams: PgRollStatusPathParams;
|
2992
|
+
} & DataPlaneFetcherExtraProps;
|
2993
|
+
declare const pgRollStatus: (variables: PgRollStatusVariables, signal?: AbortSignal) => Promise<PgRollStatusResponse>;
|
2435
2994
|
type GetBranchListPathParams = {
|
2436
2995
|
/**
|
2437
2996
|
* The Database Name
|
@@ -2519,6 +3078,13 @@ type CreateBranchRequestBody = {
|
|
2519
3078
|
* Select the branch to fork from. Defaults to 'main'
|
2520
3079
|
*/
|
2521
3080
|
from?: string;
|
3081
|
+
/**
|
3082
|
+
* Select the dedicated cluster to create on. Defaults to 'xata-cloud'
|
3083
|
+
*
|
3084
|
+
* @minLength 1
|
3085
|
+
* @x-internal true
|
3086
|
+
*/
|
3087
|
+
clusterID?: string;
|
2522
3088
|
metadata?: BranchMetadata;
|
2523
3089
|
};
|
2524
3090
|
type CreateBranchVariables = {
|
@@ -2558,6 +3124,31 @@ type DeleteBranchVariables = {
|
|
2558
3124
|
* Delete the branch in the database and all its resources
|
2559
3125
|
*/
|
2560
3126
|
declare const deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal) => Promise<DeleteBranchResponse>;
|
3127
|
+
type GetSchemaPathParams = {
|
3128
|
+
/**
|
3129
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3130
|
+
*/
|
3131
|
+
dbBranchName: DBBranchName;
|
3132
|
+
workspace: string;
|
3133
|
+
region: string;
|
3134
|
+
};
|
3135
|
+
type GetSchemaError = ErrorWrapper<{
|
3136
|
+
status: 400;
|
3137
|
+
payload: BadRequestError;
|
3138
|
+
} | {
|
3139
|
+
status: 401;
|
3140
|
+
payload: AuthError;
|
3141
|
+
} | {
|
3142
|
+
status: 404;
|
3143
|
+
payload: SimpleError;
|
3144
|
+
}>;
|
3145
|
+
type GetSchemaResponse = {
|
3146
|
+
schema: Record<string, any>;
|
3147
|
+
};
|
3148
|
+
type GetSchemaVariables = {
|
3149
|
+
pathParams: GetSchemaPathParams;
|
3150
|
+
} & DataPlaneFetcherExtraProps;
|
3151
|
+
declare const getSchema: (variables: GetSchemaVariables, signal?: AbortSignal) => Promise<GetSchemaResponse>;
|
2561
3152
|
type CopyBranchPathParams = {
|
2562
3153
|
/**
|
2563
3154
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -5188,12 +5779,12 @@ type QueryTableVariables = {
|
|
5188
5779
|
* returned is empty, but `page.meta.cursor` will include a cursor that can be
|
5189
5780
|
* used to "tail" the table from the end waiting for new data to be inserted.
|
5190
5781
|
* - `page.before=end`: This cursor returns the last page.
|
5191
|
-
* - `page.start
|
5782
|
+
* - `page.start=$cursor`: Start at the beginning of the result set of the $cursor query. This is equivalent to querying the
|
5192
5783
|
* first page without a cursor but applying `filter` and `sort` . Yet the `page.start`
|
5193
5784
|
* cursor can be convenient at times as user code does not need to remember the
|
5194
5785
|
* filter, sort, columns or page size configuration. All these information are
|
5195
5786
|
* read from the cursor.
|
5196
|
-
* - `page.end
|
5787
|
+
* - `page.end=$cursor`: Move to the end of the result set of the $cursor query. This is equivalent to querying the
|
5197
5788
|
* last page with `page.before=end`, `filter`, and `sort` . Yet the
|
5198
5789
|
* `page.end` cursor can be more convenient at times as user code does not
|
5199
5790
|
* need to remember the filter, sort, columns or page size configuration. All
|
@@ -5317,53 +5908,6 @@ type SearchTableVariables = {
|
|
5317
5908
|
* * filtering on columns of type `multiple` is currently unsupported
|
5318
5909
|
*/
|
5319
5910
|
declare const searchTable: (variables: SearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
5320
|
-
type SqlQueryPathParams = {
|
5321
|
-
/**
|
5322
|
-
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
5323
|
-
*/
|
5324
|
-
dbBranchName: DBBranchName;
|
5325
|
-
workspace: string;
|
5326
|
-
region: string;
|
5327
|
-
};
|
5328
|
-
type SqlQueryError = ErrorWrapper<{
|
5329
|
-
status: 400;
|
5330
|
-
payload: BadRequestError;
|
5331
|
-
} | {
|
5332
|
-
status: 401;
|
5333
|
-
payload: AuthError;
|
5334
|
-
} | {
|
5335
|
-
status: 404;
|
5336
|
-
payload: SimpleError;
|
5337
|
-
} | {
|
5338
|
-
status: 503;
|
5339
|
-
payload: ServiceUnavailableError;
|
5340
|
-
}>;
|
5341
|
-
type SqlQueryRequestBody = {
|
5342
|
-
/**
|
5343
|
-
* The query string.
|
5344
|
-
*
|
5345
|
-
* @minLength 1
|
5346
|
-
*/
|
5347
|
-
query: string;
|
5348
|
-
/**
|
5349
|
-
* The query parameter list.
|
5350
|
-
*/
|
5351
|
-
params?: any[] | null;
|
5352
|
-
/**
|
5353
|
-
* The consistency level for this request.
|
5354
|
-
*
|
5355
|
-
* @default strong
|
5356
|
-
*/
|
5357
|
-
consistency?: 'strong' | 'eventual';
|
5358
|
-
};
|
5359
|
-
type SqlQueryVariables = {
|
5360
|
-
body: SqlQueryRequestBody;
|
5361
|
-
pathParams: SqlQueryPathParams;
|
5362
|
-
} & DataPlaneFetcherExtraProps;
|
5363
|
-
/**
|
5364
|
-
* Run an SQL query across the database branch.
|
5365
|
-
*/
|
5366
|
-
declare const sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<SQLResponse>;
|
5367
5911
|
type VectorSearchTablePathParams = {
|
5368
5912
|
/**
|
5369
5913
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -5455,9 +5999,9 @@ type AskTableResponse = {
|
|
5455
5999
|
*/
|
5456
6000
|
answer: string;
|
5457
6001
|
/**
|
5458
|
-
* The session ID for the chat session.
|
6002
|
+
* The session ID for the chat session.
|
5459
6003
|
*/
|
5460
|
-
|
6004
|
+
sessionId: string;
|
5461
6005
|
};
|
5462
6006
|
type AskTableRequestBody = {
|
5463
6007
|
/**
|
@@ -5465,7 +6009,7 @@ type AskTableRequestBody = {
|
|
5465
6009
|
*
|
5466
6010
|
* @minLength 3
|
5467
6011
|
*/
|
5468
|
-
question
|
6012
|
+
question: string;
|
5469
6013
|
/**
|
5470
6014
|
* The type of search to use. If set to `keyword` (the default), the search can be configured by passing
|
5471
6015
|
* a `search` object with the following fields. For more details about each, see the Search endpoint documentation.
|
@@ -5505,14 +6049,14 @@ type AskTableRequestBody = {
|
|
5505
6049
|
rules?: string[];
|
5506
6050
|
};
|
5507
6051
|
type AskTableVariables = {
|
5508
|
-
body
|
6052
|
+
body: AskTableRequestBody;
|
5509
6053
|
pathParams: AskTablePathParams;
|
5510
6054
|
} & DataPlaneFetcherExtraProps;
|
5511
6055
|
/**
|
5512
6056
|
* Ask your table a question. If the `Accept` header is set to `text/event-stream`, Xata will stream the results back as SSE's.
|
5513
6057
|
*/
|
5514
6058
|
declare const askTable: (variables: AskTableVariables, signal?: AbortSignal) => Promise<AskTableResponse>;
|
5515
|
-
type
|
6059
|
+
type AskTableSessionPathParams = {
|
5516
6060
|
/**
|
5517
6061
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
5518
6062
|
*/
|
@@ -5529,7 +6073,7 @@ type ChatSessionMessagePathParams = {
|
|
5529
6073
|
workspace: string;
|
5530
6074
|
region: string;
|
5531
6075
|
};
|
5532
|
-
type
|
6076
|
+
type AskTableSessionError = ErrorWrapper<{
|
5533
6077
|
status: 400;
|
5534
6078
|
payload: BadRequestError;
|
5535
6079
|
} | {
|
@@ -5545,13 +6089,13 @@ type ChatSessionMessageError = ErrorWrapper<{
|
|
5545
6089
|
status: 503;
|
5546
6090
|
payload: ServiceUnavailableError;
|
5547
6091
|
}>;
|
5548
|
-
type
|
6092
|
+
type AskTableSessionResponse = {
|
5549
6093
|
/**
|
5550
6094
|
* The answer to the input question
|
5551
6095
|
*/
|
5552
|
-
answer
|
6096
|
+
answer: string;
|
5553
6097
|
};
|
5554
|
-
type
|
6098
|
+
type AskTableSessionRequestBody = {
|
5555
6099
|
/**
|
5556
6100
|
* The question you'd like to ask.
|
5557
6101
|
*
|
@@ -5559,14 +6103,14 @@ type ChatSessionMessageRequestBody = {
|
|
5559
6103
|
*/
|
5560
6104
|
message?: string;
|
5561
6105
|
};
|
5562
|
-
type
|
5563
|
-
body?:
|
5564
|
-
pathParams:
|
6106
|
+
type AskTableSessionVariables = {
|
6107
|
+
body?: AskTableSessionRequestBody;
|
6108
|
+
pathParams: AskTableSessionPathParams;
|
5565
6109
|
} & DataPlaneFetcherExtraProps;
|
5566
6110
|
/**
|
5567
6111
|
* Ask a follow-up question. If the `Accept` header is set to `text/event-stream`, Xata will stream the results back as SSE's.
|
5568
6112
|
*/
|
5569
|
-
declare const
|
6113
|
+
declare const askTableSession: (variables: AskTableSessionVariables, signal?: AbortSignal) => Promise<AskTableSessionResponse>;
|
5570
6114
|
type SummarizeTablePathParams = {
|
5571
6115
|
/**
|
5572
6116
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -5755,9 +6299,58 @@ type FileAccessVariables = {
|
|
5755
6299
|
* Retrieve file content by access id
|
5756
6300
|
*/
|
5757
6301
|
declare const fileAccess: (variables: FileAccessVariables, signal?: AbortSignal) => Promise<Blob>;
|
6302
|
+
type SqlQueryPathParams = {
|
6303
|
+
/**
|
6304
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
6305
|
+
*/
|
6306
|
+
dbBranchName: DBBranchName;
|
6307
|
+
workspace: string;
|
6308
|
+
region: string;
|
6309
|
+
};
|
6310
|
+
type SqlQueryError = ErrorWrapper<{
|
6311
|
+
status: 400;
|
6312
|
+
payload: BadRequestError;
|
6313
|
+
} | {
|
6314
|
+
status: 401;
|
6315
|
+
payload: AuthError;
|
6316
|
+
} | {
|
6317
|
+
status: 404;
|
6318
|
+
payload: SimpleError;
|
6319
|
+
} | {
|
6320
|
+
status: 503;
|
6321
|
+
payload: ServiceUnavailableError;
|
6322
|
+
}>;
|
6323
|
+
type SqlQueryRequestBody = {
|
6324
|
+
/**
|
6325
|
+
* The SQL statement.
|
6326
|
+
*
|
6327
|
+
* @minLength 1
|
6328
|
+
*/
|
6329
|
+
statement: string;
|
6330
|
+
/**
|
6331
|
+
* The query parameter list.
|
6332
|
+
*/
|
6333
|
+
params?: any[] | null;
|
6334
|
+
/**
|
6335
|
+
* The consistency level for this request.
|
6336
|
+
*
|
6337
|
+
* @default strong
|
6338
|
+
*/
|
6339
|
+
consistency?: 'strong' | 'eventual';
|
6340
|
+
};
|
6341
|
+
type SqlQueryVariables = {
|
6342
|
+
body: SqlQueryRequestBody;
|
6343
|
+
pathParams: SqlQueryPathParams;
|
6344
|
+
} & DataPlaneFetcherExtraProps;
|
6345
|
+
/**
|
6346
|
+
* Run an SQL query across the database branch.
|
6347
|
+
*/
|
6348
|
+
declare const sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<SQLResponse>;
|
5758
6349
|
|
5759
6350
|
declare const operationsByTag: {
|
5760
6351
|
branch: {
|
6352
|
+
applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
6353
|
+
pgRollStatus: (variables: PgRollStatusVariables, signal?: AbortSignal | undefined) => Promise<PgRollStatusResponse>;
|
5761
6354
|
getBranchList: (variables: GetBranchListVariables, signal?: AbortSignal | undefined) => Promise<ListBranchesResponse>;
|
5762
6355
|
getBranchDetails: (variables: GetBranchDetailsVariables, signal?: AbortSignal | undefined) => Promise<DBBranch>;
|
5763
6356
|
createBranch: (variables: CreateBranchVariables, signal?: AbortSignal | undefined) => Promise<CreateBranchResponse>;
|
@@ -5772,6 +6365,7 @@ declare const operationsByTag: {
|
|
5772
6365
|
resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal | undefined) => Promise<ResolveBranchResponse>;
|
5773
6366
|
};
|
5774
6367
|
migrations: {
|
6368
|
+
getSchema: (variables: GetSchemaVariables, signal?: AbortSignal | undefined) => Promise<GetSchemaResponse>;
|
5775
6369
|
getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal | undefined) => Promise<GetBranchMigrationHistoryResponse>;
|
5776
6370
|
getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables, signal?: AbortSignal | undefined) => Promise<BranchMigrationPlan>;
|
5777
6371
|
executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
@@ -5828,13 +6422,24 @@ declare const operationsByTag: {
|
|
5828
6422
|
queryTable: (variables: QueryTableVariables, signal?: AbortSignal | undefined) => Promise<QueryResponse>;
|
5829
6423
|
searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
|
5830
6424
|
searchTable: (variables: SearchTableVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
|
5831
|
-
sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal | undefined) => Promise<SQLResponse>;
|
5832
6425
|
vectorSearchTable: (variables: VectorSearchTableVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
|
5833
6426
|
askTable: (variables: AskTableVariables, signal?: AbortSignal | undefined) => Promise<AskTableResponse>;
|
5834
|
-
|
6427
|
+
askTableSession: (variables: AskTableSessionVariables, signal?: AbortSignal | undefined) => Promise<AskTableSessionResponse>;
|
5835
6428
|
summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal | undefined) => Promise<SummarizeResponse>;
|
5836
6429
|
aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal | undefined) => Promise<AggResponse>;
|
5837
6430
|
};
|
6431
|
+
sql: {
|
6432
|
+
sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal | undefined) => Promise<SQLResponse>;
|
6433
|
+
};
|
6434
|
+
oAuth: {
|
6435
|
+
getAuthorizationCode: (variables: GetAuthorizationCodeVariables, signal?: AbortSignal | undefined) => Promise<AuthorizationCodeResponse>;
|
6436
|
+
grantAuthorizationCode: (variables: GrantAuthorizationCodeVariables, signal?: AbortSignal | undefined) => Promise<AuthorizationCodeResponse>;
|
6437
|
+
getUserOAuthClients: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetUserOAuthClientsResponse>;
|
6438
|
+
deleteUserOAuthClient: (variables: DeleteUserOAuthClientVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
6439
|
+
getUserOAuthAccessTokens: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetUserOAuthAccessTokensResponse>;
|
6440
|
+
deleteOAuthAccessToken: (variables: DeleteOAuthAccessTokenVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
6441
|
+
updateOAuthAccessToken: (variables: UpdateOAuthAccessTokenVariables, signal?: AbortSignal | undefined) => Promise<OAuthAccessToken>;
|
6442
|
+
};
|
5838
6443
|
users: {
|
5839
6444
|
getUser: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<UserWithID>;
|
5840
6445
|
updateUser: (variables: UpdateUserVariables, signal?: AbortSignal | undefined) => Promise<UserWithID>;
|
@@ -5862,6 +6467,12 @@ declare const operationsByTag: {
|
|
5862
6467
|
acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
5863
6468
|
resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
5864
6469
|
};
|
6470
|
+
xbcontrolOther: {
|
6471
|
+
listClusters: (variables: ListClustersVariables, signal?: AbortSignal | undefined) => Promise<ListClustersResponse>;
|
6472
|
+
createCluster: (variables: CreateClusterVariables, signal?: AbortSignal | undefined) => Promise<ClusterResponse>;
|
6473
|
+
getCluster: (variables: GetClusterVariables, signal?: AbortSignal | undefined) => Promise<ClusterMetadata>;
|
6474
|
+
updateCluster: (variables: UpdateClusterVariables, signal?: AbortSignal | undefined) => Promise<ClusterMetadata>;
|
6475
|
+
};
|
5865
6476
|
databases: {
|
5866
6477
|
getDatabaseList: (variables: GetDatabaseListVariables, signal?: AbortSignal | undefined) => Promise<ListDatabasesResponse>;
|
5867
6478
|
createDatabase: (variables: CreateDatabaseVariables, signal?: AbortSignal | undefined) => Promise<CreateDatabaseResponse>;
|
@@ -5911,31 +6522,16 @@ type responses_ServiceUnavailableError = ServiceUnavailableError;
|
|
5911
6522
|
type responses_SimpleError = SimpleError;
|
5912
6523
|
type responses_SummarizeResponse = SummarizeResponse;
|
5913
6524
|
declare namespace responses {
|
5914
|
-
export {
|
5915
|
-
responses_AggResponse as AggResponse,
|
5916
|
-
responses_AuthError as AuthError,
|
5917
|
-
responses_BadRequestError as BadRequestError,
|
5918
|
-
responses_BranchMigrationPlan as BranchMigrationPlan,
|
5919
|
-
responses_BulkError as BulkError,
|
5920
|
-
responses_BulkInsertResponse as BulkInsertResponse,
|
5921
|
-
responses_PutFileResponse as PutFileResponse,
|
5922
|
-
responses_QueryResponse as QueryResponse,
|
5923
|
-
responses_RateLimitError as RateLimitError,
|
5924
|
-
responses_RecordResponse as RecordResponse,
|
5925
|
-
responses_RecordUpdateResponse as RecordUpdateResponse,
|
5926
|
-
responses_SQLResponse as SQLResponse,
|
5927
|
-
responses_SchemaCompareResponse as SchemaCompareResponse,
|
5928
|
-
responses_SchemaUpdateResponse as SchemaUpdateResponse,
|
5929
|
-
responses_SearchResponse as SearchResponse,
|
5930
|
-
responses_ServiceUnavailableError as ServiceUnavailableError,
|
5931
|
-
responses_SimpleError as SimpleError,
|
5932
|
-
responses_SummarizeResponse as SummarizeResponse,
|
5933
|
-
};
|
6525
|
+
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 };
|
5934
6526
|
}
|
5935
6527
|
|
5936
6528
|
type schemas_APIKeyName = APIKeyName;
|
6529
|
+
type schemas_AccessToken = AccessToken;
|
5937
6530
|
type schemas_AggExpression = AggExpression;
|
5938
6531
|
type schemas_AggExpressionMap = AggExpressionMap;
|
6532
|
+
type schemas_AuthorizationCodeRequest = AuthorizationCodeRequest;
|
6533
|
+
type schemas_AuthorizationCodeResponse = AuthorizationCodeResponse;
|
6534
|
+
type schemas_AutoscalingConfig = AutoscalingConfig;
|
5939
6535
|
type schemas_AverageAgg = AverageAgg;
|
5940
6536
|
type schemas_BoosterExpression = BoosterExpression;
|
5941
6537
|
type schemas_Branch = Branch;
|
@@ -5944,6 +6540,13 @@ type schemas_BranchMigration = BranchMigration;
|
|
5944
6540
|
type schemas_BranchName = BranchName;
|
5945
6541
|
type schemas_BranchOp = BranchOp;
|
5946
6542
|
type schemas_BranchWithCopyID = BranchWithCopyID;
|
6543
|
+
type schemas_ClusterConfiguration = ClusterConfiguration;
|
6544
|
+
type schemas_ClusterCreateDetails = ClusterCreateDetails;
|
6545
|
+
type schemas_ClusterID = ClusterID;
|
6546
|
+
type schemas_ClusterMetadata = ClusterMetadata;
|
6547
|
+
type schemas_ClusterResponse = ClusterResponse;
|
6548
|
+
type schemas_ClusterShortMetadata = ClusterShortMetadata;
|
6549
|
+
type schemas_ClusterUpdateDetails = ClusterUpdateDetails;
|
5947
6550
|
type schemas_Column = Column;
|
5948
6551
|
type schemas_ColumnFile = ColumnFile;
|
5949
6552
|
type schemas_ColumnLink = ColumnLink;
|
@@ -5959,6 +6562,7 @@ type schemas_CountAgg = CountAgg;
|
|
5959
6562
|
type schemas_DBBranch = DBBranch;
|
5960
6563
|
type schemas_DBBranchName = DBBranchName;
|
5961
6564
|
type schemas_DBName = DBName;
|
6565
|
+
type schemas_DailyTimeWindow = DailyTimeWindow;
|
5962
6566
|
type schemas_DataInputRecord = DataInputRecord;
|
5963
6567
|
type schemas_DatabaseGithubSettings = DatabaseGithubSettings;
|
5964
6568
|
type schemas_DatabaseMetadata = DatabaseMetadata;
|
@@ -5986,9 +6590,11 @@ type schemas_InputFileEntry = InputFileEntry;
|
|
5986
6590
|
type schemas_InviteID = InviteID;
|
5987
6591
|
type schemas_InviteKey = InviteKey;
|
5988
6592
|
type schemas_ListBranchesResponse = ListBranchesResponse;
|
6593
|
+
type schemas_ListClustersResponse = ListClustersResponse;
|
5989
6594
|
type schemas_ListDatabasesResponse = ListDatabasesResponse;
|
5990
6595
|
type schemas_ListGitBranchesResponse = ListGitBranchesResponse;
|
5991
6596
|
type schemas_ListRegionsResponse = ListRegionsResponse;
|
6597
|
+
type schemas_MaintenanceConfig = MaintenanceConfig;
|
5992
6598
|
type schemas_MaxAgg = MaxAgg;
|
5993
6599
|
type schemas_MediaType = MediaType;
|
5994
6600
|
type schemas_MetricsDatapoint = MetricsDatapoint;
|
@@ -6003,8 +6609,16 @@ type schemas_MigrationStatus = MigrationStatus;
|
|
6003
6609
|
type schemas_MigrationTableOp = MigrationTableOp;
|
6004
6610
|
type schemas_MinAgg = MinAgg;
|
6005
6611
|
type schemas_NumericHistogramAgg = NumericHistogramAgg;
|
6612
|
+
type schemas_OAuthAccessToken = OAuthAccessToken;
|
6613
|
+
type schemas_OAuthClientID = OAuthClientID;
|
6614
|
+
type schemas_OAuthClientPublicDetails = OAuthClientPublicDetails;
|
6615
|
+
type schemas_OAuthResponseType = OAuthResponseType;
|
6616
|
+
type schemas_OAuthScope = OAuthScope;
|
6006
6617
|
type schemas_ObjectValue = ObjectValue;
|
6007
6618
|
type schemas_PageConfig = PageConfig;
|
6619
|
+
type schemas_PercentilesAgg = PercentilesAgg;
|
6620
|
+
type schemas_PgRollMigrationStatus = PgRollMigrationStatus;
|
6621
|
+
type schemas_PgRollStatusResponse = PgRollStatusResponse;
|
6008
6622
|
type schemas_PrefixExpression = PrefixExpression;
|
6009
6623
|
type schemas_ProjectionConfig = ProjectionConfig;
|
6010
6624
|
type schemas_QueryColumnsProjection = QueryColumnsProjection;
|
@@ -6049,143 +6663,16 @@ type schemas_UniqueCountAgg = UniqueCountAgg;
|
|
6049
6663
|
type schemas_User = User;
|
6050
6664
|
type schemas_UserID = UserID;
|
6051
6665
|
type schemas_UserWithID = UserWithID;
|
6666
|
+
type schemas_WeeklyTimeWindow = WeeklyTimeWindow;
|
6052
6667
|
type schemas_Workspace = Workspace;
|
6053
6668
|
type schemas_WorkspaceID = WorkspaceID;
|
6054
6669
|
type schemas_WorkspaceInvite = WorkspaceInvite;
|
6055
6670
|
type schemas_WorkspaceMember = WorkspaceMember;
|
6056
6671
|
type schemas_WorkspaceMembers = WorkspaceMembers;
|
6057
6672
|
type schemas_WorkspaceMeta = WorkspaceMeta;
|
6673
|
+
type schemas_WorkspacePlan = WorkspacePlan;
|
6058
6674
|
declare namespace schemas {
|
6059
|
-
export {
|
6060
|
-
schemas_APIKeyName as APIKeyName,
|
6061
|
-
schemas_AggExpression as AggExpression,
|
6062
|
-
schemas_AggExpressionMap as AggExpressionMap,
|
6063
|
-
AggResponse$1 as AggResponse,
|
6064
|
-
schemas_AverageAgg as AverageAgg,
|
6065
|
-
schemas_BoosterExpression as BoosterExpression,
|
6066
|
-
schemas_Branch as Branch,
|
6067
|
-
schemas_BranchMetadata as BranchMetadata,
|
6068
|
-
schemas_BranchMigration as BranchMigration,
|
6069
|
-
schemas_BranchName as BranchName,
|
6070
|
-
schemas_BranchOp as BranchOp,
|
6071
|
-
schemas_BranchWithCopyID as BranchWithCopyID,
|
6072
|
-
schemas_Column as Column,
|
6073
|
-
schemas_ColumnFile as ColumnFile,
|
6074
|
-
schemas_ColumnLink as ColumnLink,
|
6075
|
-
schemas_ColumnMigration as ColumnMigration,
|
6076
|
-
schemas_ColumnName as ColumnName,
|
6077
|
-
schemas_ColumnOpAdd as ColumnOpAdd,
|
6078
|
-
schemas_ColumnOpRemove as ColumnOpRemove,
|
6079
|
-
schemas_ColumnOpRename as ColumnOpRename,
|
6080
|
-
schemas_ColumnVector as ColumnVector,
|
6081
|
-
schemas_ColumnsProjection as ColumnsProjection,
|
6082
|
-
schemas_Commit as Commit,
|
6083
|
-
schemas_CountAgg as CountAgg,
|
6084
|
-
schemas_DBBranch as DBBranch,
|
6085
|
-
schemas_DBBranchName as DBBranchName,
|
6086
|
-
schemas_DBName as DBName,
|
6087
|
-
schemas_DataInputRecord as DataInputRecord,
|
6088
|
-
schemas_DatabaseGithubSettings as DatabaseGithubSettings,
|
6089
|
-
schemas_DatabaseMetadata as DatabaseMetadata,
|
6090
|
-
DateBooster$1 as DateBooster,
|
6091
|
-
schemas_DateHistogramAgg as DateHistogramAgg,
|
6092
|
-
schemas_DateTime as DateTime,
|
6093
|
-
schemas_FileAccessID as FileAccessID,
|
6094
|
-
schemas_FileItemID as FileItemID,
|
6095
|
-
schemas_FileName as FileName,
|
6096
|
-
schemas_FileResponse as FileResponse,
|
6097
|
-
schemas_FileSignature as FileSignature,
|
6098
|
-
schemas_FilterColumn as FilterColumn,
|
6099
|
-
schemas_FilterColumnIncludes as FilterColumnIncludes,
|
6100
|
-
schemas_FilterExpression as FilterExpression,
|
6101
|
-
schemas_FilterList as FilterList,
|
6102
|
-
schemas_FilterPredicate as FilterPredicate,
|
6103
|
-
schemas_FilterPredicateOp as FilterPredicateOp,
|
6104
|
-
schemas_FilterPredicateRangeOp as FilterPredicateRangeOp,
|
6105
|
-
schemas_FilterRangeValue as FilterRangeValue,
|
6106
|
-
schemas_FilterValue as FilterValue,
|
6107
|
-
schemas_FuzzinessExpression as FuzzinessExpression,
|
6108
|
-
schemas_HighlightExpression as HighlightExpression,
|
6109
|
-
schemas_InputFile as InputFile,
|
6110
|
-
schemas_InputFileArray as InputFileArray,
|
6111
|
-
schemas_InputFileEntry as InputFileEntry,
|
6112
|
-
schemas_InviteID as InviteID,
|
6113
|
-
schemas_InviteKey as InviteKey,
|
6114
|
-
schemas_ListBranchesResponse as ListBranchesResponse,
|
6115
|
-
schemas_ListDatabasesResponse as ListDatabasesResponse,
|
6116
|
-
schemas_ListGitBranchesResponse as ListGitBranchesResponse,
|
6117
|
-
schemas_ListRegionsResponse as ListRegionsResponse,
|
6118
|
-
schemas_MaxAgg as MaxAgg,
|
6119
|
-
schemas_MediaType as MediaType,
|
6120
|
-
schemas_MetricsDatapoint as MetricsDatapoint,
|
6121
|
-
schemas_MetricsLatency as MetricsLatency,
|
6122
|
-
schemas_Migration as Migration,
|
6123
|
-
schemas_MigrationColumnOp as MigrationColumnOp,
|
6124
|
-
schemas_MigrationObject as MigrationObject,
|
6125
|
-
schemas_MigrationOp as MigrationOp,
|
6126
|
-
schemas_MigrationRequest as MigrationRequest,
|
6127
|
-
schemas_MigrationRequestNumber as MigrationRequestNumber,
|
6128
|
-
schemas_MigrationStatus as MigrationStatus,
|
6129
|
-
schemas_MigrationTableOp as MigrationTableOp,
|
6130
|
-
schemas_MinAgg as MinAgg,
|
6131
|
-
NumericBooster$1 as NumericBooster,
|
6132
|
-
schemas_NumericHistogramAgg as NumericHistogramAgg,
|
6133
|
-
schemas_ObjectValue as ObjectValue,
|
6134
|
-
schemas_PageConfig as PageConfig,
|
6135
|
-
schemas_PrefixExpression as PrefixExpression,
|
6136
|
-
schemas_ProjectionConfig as ProjectionConfig,
|
6137
|
-
schemas_QueryColumnsProjection as QueryColumnsProjection,
|
6138
|
-
schemas_RecordID as RecordID,
|
6139
|
-
schemas_RecordMeta as RecordMeta,
|
6140
|
-
schemas_RecordsMetadata as RecordsMetadata,
|
6141
|
-
schemas_Region as Region,
|
6142
|
-
schemas_RevLink as RevLink,
|
6143
|
-
schemas_Role as Role,
|
6144
|
-
schemas_SQLRecord as SQLRecord,
|
6145
|
-
schemas_Schema as Schema,
|
6146
|
-
schemas_SchemaEditScript as SchemaEditScript,
|
6147
|
-
schemas_SearchPageConfig as SearchPageConfig,
|
6148
|
-
schemas_SortExpression as SortExpression,
|
6149
|
-
schemas_SortOrder as SortOrder,
|
6150
|
-
schemas_StartedFromMetadata as StartedFromMetadata,
|
6151
|
-
schemas_SumAgg as SumAgg,
|
6152
|
-
schemas_SummaryExpression as SummaryExpression,
|
6153
|
-
schemas_SummaryExpressionList as SummaryExpressionList,
|
6154
|
-
schemas_Table as Table,
|
6155
|
-
schemas_TableMigration as TableMigration,
|
6156
|
-
schemas_TableName as TableName,
|
6157
|
-
schemas_TableOpAdd as TableOpAdd,
|
6158
|
-
schemas_TableOpRemove as TableOpRemove,
|
6159
|
-
schemas_TableOpRename as TableOpRename,
|
6160
|
-
schemas_TableRename as TableRename,
|
6161
|
-
schemas_TargetExpression as TargetExpression,
|
6162
|
-
schemas_TopValuesAgg as TopValuesAgg,
|
6163
|
-
schemas_TransactionDeleteOp as TransactionDeleteOp,
|
6164
|
-
schemas_TransactionError as TransactionError,
|
6165
|
-
schemas_TransactionFailure as TransactionFailure,
|
6166
|
-
schemas_TransactionGetOp as TransactionGetOp,
|
6167
|
-
schemas_TransactionInsertOp as TransactionInsertOp,
|
6168
|
-
TransactionOperation$1 as TransactionOperation,
|
6169
|
-
schemas_TransactionResultColumns as TransactionResultColumns,
|
6170
|
-
schemas_TransactionResultDelete as TransactionResultDelete,
|
6171
|
-
schemas_TransactionResultGet as TransactionResultGet,
|
6172
|
-
schemas_TransactionResultInsert as TransactionResultInsert,
|
6173
|
-
schemas_TransactionResultUpdate as TransactionResultUpdate,
|
6174
|
-
schemas_TransactionSuccess as TransactionSuccess,
|
6175
|
-
schemas_TransactionUpdateOp as TransactionUpdateOp,
|
6176
|
-
schemas_UniqueCountAgg as UniqueCountAgg,
|
6177
|
-
schemas_User as User,
|
6178
|
-
schemas_UserID as UserID,
|
6179
|
-
schemas_UserWithID as UserWithID,
|
6180
|
-
ValueBooster$1 as ValueBooster,
|
6181
|
-
schemas_Workspace as Workspace,
|
6182
|
-
schemas_WorkspaceID as WorkspaceID,
|
6183
|
-
schemas_WorkspaceInvite as WorkspaceInvite,
|
6184
|
-
schemas_WorkspaceMember as WorkspaceMember,
|
6185
|
-
schemas_WorkspaceMembers as WorkspaceMembers,
|
6186
|
-
schemas_WorkspaceMeta as WorkspaceMeta,
|
6187
|
-
XataRecord$1 as XataRecord,
|
6188
|
-
};
|
6675
|
+
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_DailyTimeWindow as DailyTimeWindow, 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_PgRollMigrationStatus as PgRollMigrationStatus, schemas_PgRollStatusResponse as PgRollStatusResponse, 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_WeeklyTimeWindow as WeeklyTimeWindow, schemas_Workspace as Workspace, schemas_WorkspaceID as WorkspaceID, schemas_WorkspaceInvite as WorkspaceInvite, schemas_WorkspaceMember as WorkspaceMember, schemas_WorkspaceMembers as WorkspaceMembers, schemas_WorkspaceMeta as WorkspaceMeta, schemas_WorkspacePlan as WorkspacePlan, XataRecord$1 as XataRecord };
|
6189
6676
|
}
|
6190
6677
|
|
6191
6678
|
type ApiExtraProps = Omit<FetcherExtraProps, 'endpoint'>;
|
@@ -6666,7 +7153,7 @@ declare class SearchAndFilterApi {
|
|
6666
7153
|
table: TableName;
|
6667
7154
|
options: AskTableRequestBody;
|
6668
7155
|
}): Promise<AskTableResponse>;
|
6669
|
-
|
7156
|
+
askTableSession({ workspace, region, database, branch, table, sessionId, message }: {
|
6670
7157
|
workspace: WorkspaceID;
|
6671
7158
|
region: string;
|
6672
7159
|
database: DBName;
|
@@ -6674,7 +7161,7 @@ declare class SearchAndFilterApi {
|
|
6674
7161
|
table: TableName;
|
6675
7162
|
sessionId: string;
|
6676
7163
|
message: string;
|
6677
|
-
}): Promise<
|
7164
|
+
}): Promise<AskTableSessionResponse>;
|
6678
7165
|
summarizeTable({ workspace, region, database, branch, table, filter, columns, summaries, sort, summariesFilter, page, consistency }: {
|
6679
7166
|
workspace: WorkspaceID;
|
6680
7167
|
region: string;
|
@@ -6853,10 +7340,11 @@ declare class DatabaseApi {
|
|
6853
7340
|
getDatabaseList({ workspace }: {
|
6854
7341
|
workspace: WorkspaceID;
|
6855
7342
|
}): Promise<ListDatabasesResponse>;
|
6856
|
-
createDatabase({ workspace, database, data }: {
|
7343
|
+
createDatabase({ workspace, database, data, headers }: {
|
6857
7344
|
workspace: WorkspaceID;
|
6858
7345
|
database: DBName;
|
6859
7346
|
data: CreateDatabaseRequestBody;
|
7347
|
+
headers?: Record<string, string>;
|
6860
7348
|
}): Promise<CreateDatabaseResponse>;
|
6861
7349
|
deleteDatabase({ workspace, database }: {
|
6862
7350
|
workspace: WorkspaceID;
|
@@ -6931,36 +7419,295 @@ type Narrowable = string | number | bigint | boolean;
|
|
6931
7419
|
type Try<A1, A2, Catch = never> = A1 extends A2 ? A1 : Catch;
|
6932
7420
|
type Narrow<A> = Try<A, [], NarrowRaw<A>>;
|
6933
7421
|
|
7422
|
+
interface ImageTransformations {
|
7423
|
+
/**
|
7424
|
+
* Whether to preserve animation frames from input files. Default is true.
|
7425
|
+
* Setting it to false reduces animations to still images. This setting is
|
7426
|
+
* recommended when enlarging images or processing arbitrary user content,
|
7427
|
+
* because large GIF animations can weigh tens or even hundreds of megabytes.
|
7428
|
+
* It is also useful to set anim:false when using format:"json" to get the
|
7429
|
+
* response quicker without the number of frames.
|
7430
|
+
*/
|
7431
|
+
anim?: boolean;
|
7432
|
+
/**
|
7433
|
+
* Background color to add underneath the image. Applies only to images with
|
7434
|
+
* transparency (such as PNG). Accepts any CSS color (#RRGGBB, rgba(…),
|
7435
|
+
* hsl(…), etc.)
|
7436
|
+
*/
|
7437
|
+
background?: string;
|
7438
|
+
/**
|
7439
|
+
* Radius of a blur filter (approximate gaussian). Maximum supported radius
|
7440
|
+
* is 250.
|
7441
|
+
*/
|
7442
|
+
blur?: number;
|
7443
|
+
/**
|
7444
|
+
* Increase brightness by a factor. A value of 1.0 equals no change, a value
|
7445
|
+
* of 0.5 equals half brightness, and a value of 2.0 equals twice as bright.
|
7446
|
+
* 0 is ignored.
|
7447
|
+
*/
|
7448
|
+
brightness?: number;
|
7449
|
+
/**
|
7450
|
+
* Slightly reduces latency on a cache miss by selecting a
|
7451
|
+
* quickest-to-compress file format, at a cost of increased file size and
|
7452
|
+
* lower image quality. It will usually override the format option and choose
|
7453
|
+
* JPEG over WebP or AVIF. We do not recommend using this option, except in
|
7454
|
+
* unusual circumstances like resizing uncacheable dynamically-generated
|
7455
|
+
* images.
|
7456
|
+
*/
|
7457
|
+
compression?: 'fast';
|
7458
|
+
/**
|
7459
|
+
* Increase contrast by a factor. A value of 1.0 equals no change, a value of
|
7460
|
+
* 0.5 equals low contrast, and a value of 2.0 equals high contrast. 0 is
|
7461
|
+
* ignored.
|
7462
|
+
*/
|
7463
|
+
contrast?: number;
|
7464
|
+
/**
|
7465
|
+
* Download file. Forces browser to download the image.
|
7466
|
+
* Value is used for the download file name. Extension is optional.
|
7467
|
+
*/
|
7468
|
+
download?: string;
|
7469
|
+
/**
|
7470
|
+
* Device Pixel Ratio. Default 1. Multiplier for width/height that makes it
|
7471
|
+
* easier to specify higher-DPI sizes in <img srcset>.
|
7472
|
+
*/
|
7473
|
+
dpr?: number;
|
7474
|
+
/**
|
7475
|
+
* Resizing mode as a string. It affects interpretation of width and height
|
7476
|
+
* options:
|
7477
|
+
* - scale-down: Similar to contain, but the image is never enlarged. If
|
7478
|
+
* the image is larger than given width or height, it will be resized.
|
7479
|
+
* Otherwise its original size will be kept.
|
7480
|
+
* - contain: Resizes to maximum size that fits within the given width and
|
7481
|
+
* height. If only a single dimension is given (e.g. only width), the
|
7482
|
+
* image will be shrunk or enlarged to exactly match that dimension.
|
7483
|
+
* Aspect ratio is always preserved.
|
7484
|
+
* - cover: Resizes (shrinks or enlarges) to fill the entire area of width
|
7485
|
+
* and height. If the image has an aspect ratio different from the ratio
|
7486
|
+
* of width and height, it will be cropped to fit.
|
7487
|
+
* - crop: The image will be shrunk and cropped to fit within the area
|
7488
|
+
* specified by width and height. The image will not be enlarged. For images
|
7489
|
+
* smaller than the given dimensions it's the same as scale-down. For
|
7490
|
+
* images larger than the given dimensions, it's the same as cover.
|
7491
|
+
* See also trim.
|
7492
|
+
* - pad: Resizes to the maximum size that fits within the given width and
|
7493
|
+
* height, and then fills the remaining area with a background color
|
7494
|
+
* (white by default). Use of this mode is not recommended, as the same
|
7495
|
+
* effect can be more efficiently achieved with the contain mode and the
|
7496
|
+
* CSS object-fit: contain property.
|
7497
|
+
*/
|
7498
|
+
fit?: 'scale-down' | 'contain' | 'cover' | 'crop' | 'pad';
|
7499
|
+
/**
|
7500
|
+
* Output format to generate. It can be:
|
7501
|
+
* - avif: generate images in AVIF format.
|
7502
|
+
* - webp: generate images in Google WebP format. Set quality to 100 to get
|
7503
|
+
* the WebP-lossless format.
|
7504
|
+
* - json: instead of generating an image, outputs information about the
|
7505
|
+
* image, in JSON format. The JSON object will contain image size
|
7506
|
+
* (before and after resizing), source image’s MIME type, file size, etc.
|
7507
|
+
* - jpeg: generate images in JPEG format.
|
7508
|
+
* - png: generate images in PNG format.
|
7509
|
+
*/
|
7510
|
+
format?: 'auto' | 'avif' | 'webp' | 'json' | 'jpeg' | 'png';
|
7511
|
+
/**
|
7512
|
+
* Increase exposure by a factor. A value of 1.0 equals no change, a value of
|
7513
|
+
* 0.5 darkens the image, and a value of 2.0 lightens the image. 0 is ignored.
|
7514
|
+
*/
|
7515
|
+
gamma?: number;
|
7516
|
+
/**
|
7517
|
+
* When cropping with fit: "cover", this defines the side or point that should
|
7518
|
+
* be left uncropped. The value is either a string
|
7519
|
+
* "left", "right", "top", "bottom", "auto", or "center" (the default),
|
7520
|
+
* or an object {x, y} containing focal point coordinates in the original
|
7521
|
+
* image expressed as fractions ranging from 0.0 (top or left) to 1.0
|
7522
|
+
* (bottom or right), 0.5 being the center. {fit: "cover", gravity: "top"} will
|
7523
|
+
* crop bottom or left and right sides as necessary, but won’t crop anything
|
7524
|
+
* from the top. {fit: "cover", gravity: {x:0.5, y:0.2}} will crop each side to
|
7525
|
+
* preserve as much as possible around a point at 20% of the height of the
|
7526
|
+
* source image.
|
7527
|
+
*/
|
7528
|
+
gravity?: 'left' | 'right' | 'top' | 'bottom' | 'center' | 'auto' | {
|
7529
|
+
x: number;
|
7530
|
+
y: number;
|
7531
|
+
};
|
7532
|
+
/**
|
7533
|
+
* Maximum height in image pixels. The value must be an integer.
|
7534
|
+
*/
|
7535
|
+
height?: number;
|
7536
|
+
/**
|
7537
|
+
* What EXIF data should be preserved in the output image. Note that EXIF
|
7538
|
+
* rotation and embedded color profiles are always applied ("baked in" into
|
7539
|
+
* the image), and aren't affected by this option. Note that if the Polish
|
7540
|
+
* feature is enabled, all metadata may have been removed already and this
|
7541
|
+
* option may have no effect.
|
7542
|
+
* - keep: Preserve most of EXIF metadata, including GPS location if there's
|
7543
|
+
* any.
|
7544
|
+
* - copyright: Only keep the copyright tag, and discard everything else.
|
7545
|
+
* This is the default behavior for JPEG files.
|
7546
|
+
* - none: Discard all invisible EXIF metadata. Currently WebP and PNG
|
7547
|
+
* output formats always discard metadata.
|
7548
|
+
*/
|
7549
|
+
metadata?: 'keep' | 'copyright' | 'none';
|
7550
|
+
/**
|
7551
|
+
* Quality setting from 1-100 (useful values are in 60-90 range). Lower values
|
7552
|
+
* make images look worse, but load faster. The default is 85. It applies only
|
7553
|
+
* to JPEG and WebP images. It doesn’t have any effect on PNG.
|
7554
|
+
*/
|
7555
|
+
quality?: number;
|
7556
|
+
/**
|
7557
|
+
* Number of degrees (90, 180, 270) to rotate the image by. width and height
|
7558
|
+
* options refer to axes after rotation.
|
7559
|
+
*/
|
7560
|
+
rotate?: 0 | 90 | 180 | 270 | 360;
|
7561
|
+
/**
|
7562
|
+
* Strength of sharpening filter to apply to the image. Floating-point
|
7563
|
+
* number between 0 (no sharpening, default) and 10 (maximum). 1.0 is a
|
7564
|
+
* recommended value for downscaled images.
|
7565
|
+
*/
|
7566
|
+
sharpen?: number;
|
7567
|
+
/**
|
7568
|
+
* An object with four properties {left, top, right, bottom} that specify
|
7569
|
+
* a number of pixels to cut off on each side. Allows removal of borders
|
7570
|
+
* or cutting out a specific fragment of an image. Trimming is performed
|
7571
|
+
* before resizing or rotation. Takes dpr into account.
|
7572
|
+
*/
|
7573
|
+
trim?: {
|
7574
|
+
left?: number;
|
7575
|
+
top?: number;
|
7576
|
+
right?: number;
|
7577
|
+
bottom?: number;
|
7578
|
+
};
|
7579
|
+
/**
|
7580
|
+
* Maximum width in image pixels. The value must be an integer.
|
7581
|
+
*/
|
7582
|
+
width?: number;
|
7583
|
+
}
|
7584
|
+
declare function transformImage(url: string, ...transformations: ImageTransformations[]): string;
|
7585
|
+
declare function transformImage(url: string | undefined, ...transformations: ImageTransformations[]): string | undefined;
|
7586
|
+
|
7587
|
+
type XataFileEditableFields = Partial<Pick<XataArrayFile, keyof InputFileEntry>>;
|
7588
|
+
type XataFileFields = Partial<Pick<XataArrayFile, {
|
7589
|
+
[K in StringKeys<XataArrayFile>]: XataArrayFile[K] extends Function ? never : K;
|
7590
|
+
}[keyof XataArrayFile]>>;
|
7591
|
+
declare class XataFile {
|
7592
|
+
/**
|
7593
|
+
* Identifier of the file.
|
7594
|
+
*/
|
7595
|
+
id?: string;
|
7596
|
+
/**
|
7597
|
+
* Name of the file.
|
7598
|
+
*/
|
7599
|
+
name: string;
|
7600
|
+
/**
|
7601
|
+
* Media type of the file.
|
7602
|
+
*/
|
7603
|
+
mediaType: string;
|
7604
|
+
/**
|
7605
|
+
* Base64 encoded content of the file.
|
7606
|
+
*/
|
7607
|
+
base64Content?: string;
|
7608
|
+
/**
|
7609
|
+
* Whether to enable public url for the file.
|
7610
|
+
*/
|
7611
|
+
enablePublicUrl: boolean;
|
7612
|
+
/**
|
7613
|
+
* Timeout for the signed url.
|
7614
|
+
*/
|
7615
|
+
signedUrlTimeout: number;
|
7616
|
+
/**
|
7617
|
+
* Size of the file.
|
7618
|
+
*/
|
7619
|
+
size?: number;
|
7620
|
+
/**
|
7621
|
+
* Version of the file.
|
7622
|
+
*/
|
7623
|
+
version: number;
|
7624
|
+
/**
|
7625
|
+
* Url of the file.
|
7626
|
+
*/
|
7627
|
+
url: string;
|
7628
|
+
/**
|
7629
|
+
* Signed url of the file.
|
7630
|
+
*/
|
7631
|
+
signedUrl?: string;
|
7632
|
+
/**
|
7633
|
+
* Attributes of the file.
|
7634
|
+
*/
|
7635
|
+
attributes: Record<string, any>;
|
7636
|
+
constructor(file: Partial<XataFile>);
|
7637
|
+
static fromBuffer(buffer: Buffer, options?: XataFileEditableFields): XataFile;
|
7638
|
+
toBuffer(): Buffer;
|
7639
|
+
static fromArrayBuffer(arrayBuffer: ArrayBuffer, options?: XataFileEditableFields): XataFile;
|
7640
|
+
toArrayBuffer(): ArrayBuffer;
|
7641
|
+
static fromUint8Array(uint8Array: Uint8Array, options?: XataFileEditableFields): XataFile;
|
7642
|
+
toUint8Array(): Uint8Array;
|
7643
|
+
static fromBlob(file: Blob, options?: XataFileEditableFields): Promise<XataFile>;
|
7644
|
+
toBlob(): Blob;
|
7645
|
+
static fromString(string: string, options?: XataFileEditableFields): XataFile;
|
7646
|
+
toString(): string;
|
7647
|
+
static fromBase64(base64Content: string, options?: XataFileEditableFields): XataFile;
|
7648
|
+
toBase64(): string;
|
7649
|
+
transform(...options: ImageTransformations[]): {
|
7650
|
+
url: string;
|
7651
|
+
signedUrl: string | undefined;
|
7652
|
+
metadataUrl: string;
|
7653
|
+
metadataSignedUrl: string | undefined;
|
7654
|
+
};
|
7655
|
+
}
|
7656
|
+
type XataArrayFile = Identifiable & XataFile;
|
7657
|
+
|
6934
7658
|
type SelectableColumn<O, RecursivePath extends any[] = []> = '*' | 'id' | `xata.${'version' | 'createdAt' | 'updatedAt'}` | DataProps<O> | NestedColumns<O, RecursivePath>;
|
7659
|
+
type ExpandedColumnNotation = {
|
7660
|
+
name: string;
|
7661
|
+
columns?: SelectableColumn<any>[];
|
7662
|
+
as?: string;
|
7663
|
+
limit?: number;
|
7664
|
+
offset?: number;
|
7665
|
+
order?: {
|
7666
|
+
column: string;
|
7667
|
+
order: 'asc' | 'desc';
|
7668
|
+
}[];
|
7669
|
+
};
|
7670
|
+
type SelectableColumnWithObjectNotation<O, RecursivePath extends any[] = []> = SelectableColumn<O, RecursivePath> | ExpandedColumnNotation;
|
7671
|
+
declare function isValidExpandedColumn(column: any): column is ExpandedColumnNotation;
|
7672
|
+
declare function isValidSelectableColumns(columns: any): columns is SelectableColumn<any>[];
|
7673
|
+
type StringColumns<T> = T extends string ? T : never;
|
7674
|
+
type ProjectionColumns<T> = T extends string ? never : T extends {
|
7675
|
+
as: infer As;
|
7676
|
+
} ? NonNullable<As> extends string ? NonNullable<As> : never : never;
|
6935
7677
|
type WildcardColumns<O> = Values<{
|
6936
7678
|
[K in SelectableColumn<O>]: K extends `${string}*` ? K : never;
|
6937
7679
|
}>;
|
6938
7680
|
type ColumnsByValue<O, Value> = Values<{
|
6939
7681
|
[K in SelectableColumn<O>]: ValueAtColumn<O, K> extends infer C ? C extends Value ? K extends WildcardColumns<O> ? never : K : never : never;
|
6940
7682
|
}>;
|
6941
|
-
type SelectedPick<O extends XataRecord, Key extends
|
6942
|
-
[K in Key[number]]: NestedValueAtColumn<O, K> & XataRecord<O>;
|
7683
|
+
type SelectedPick<O extends XataRecord, Key extends SelectableColumnWithObjectNotation<O>[]> = XataRecord<O> & UnionToIntersection<Values<{
|
7684
|
+
[K in StringColumns<Key[number]>]: NestedValueAtColumn<O, K> & XataRecord<O>;
|
7685
|
+
}>> & UnionToIntersection<Values<{
|
7686
|
+
[K in ProjectionColumns<Key[number]>]: {
|
7687
|
+
[Key in K]: {
|
7688
|
+
records: (Record<string, any> & XataRecord<O>)[];
|
7689
|
+
};
|
7690
|
+
};
|
6943
7691
|
}>>;
|
6944
|
-
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> ? {
|
6945
|
-
V: ValueAtColumn<Item, V>;
|
7692
|
+
type ValueAtColumn<Object, Key, RecursivePath extends any[] = []> = RecursivePath['length'] extends MAX_RECURSION ? never : 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> ? {
|
7693
|
+
V: ValueAtColumn<Item, V, [...RecursivePath, Item]>;
|
6946
7694
|
} : never : Object[K] : never> : never : never;
|
6947
|
-
type MAX_RECURSION =
|
7695
|
+
type MAX_RECURSION = 3;
|
6948
7696
|
type NestedColumns<O, RecursivePath extends any[]> = RecursivePath['length'] extends MAX_RECURSION ? never : If<IsObject<O>, Values<{
|
6949
|
-
[K in DataProps<O>]: NonNullable<O[K]> extends infer Item ? If<IsArray<Item>, K,
|
6950
|
-
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
|
7697
|
+
[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
|
6951
7698
|
K>> : never;
|
6952
7699
|
}>, never>;
|
6953
7700
|
type DataProps<O> = Exclude<StringKeys<O>, StringKeys<XataRecord>>;
|
6954
7701
|
type NestedValueAtColumn<O, Key extends SelectableColumn<O>> = Key extends `${infer N}.${infer M}` ? N extends DataProps<O> ? {
|
6955
|
-
[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;
|
7702
|
+
[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;
|
6956
7703
|
} : unknown : Key extends DataProps<O> ? {
|
6957
|
-
[K in Key]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], SelectedPick<NonNullable<O[K]>, ['*']>> : O[K];
|
7704
|
+
[K in Key]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], Omit<SelectedPick<NonNullable<O[K]>, ['*']>, 'xata' | 'getMetadata'>> : O[K];
|
6958
7705
|
} : Key extends '*' ? {
|
6959
7706
|
[K in StringKeys<O>]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], Link<NonNullable<O[K]>>> : O[K];
|
6960
7707
|
} : unknown;
|
6961
7708
|
type ForwardNullable<T, R> = T extends NonNullable<T> ? R : R | null;
|
6962
7709
|
|
6963
|
-
declare const RecordColumnTypes: readonly ["bool", "int", "float", "string", "text", "email", "multiple", "link", "object", "datetime", "vector", "file[]", "file"];
|
7710
|
+
declare const RecordColumnTypes: readonly ["bool", "int", "float", "string", "text", "email", "multiple", "link", "object", "datetime", "vector", "file[]", "file", "json"];
|
6964
7711
|
type Identifier = string;
|
6965
7712
|
/**
|
6966
7713
|
* Represents an identifiable record from the database.
|
@@ -7083,15 +7830,19 @@ type NumericOperator = ExclusiveOr<{
|
|
7083
7830
|
}, {
|
7084
7831
|
$divide?: number;
|
7085
7832
|
}>>>;
|
7833
|
+
type InputXataFile = Partial<XataArrayFile> | Promise<Partial<XataArrayFile>>;
|
7086
7834
|
type EditableDataFields<T> = T extends XataRecord ? {
|
7087
7835
|
id: Identifier;
|
7088
7836
|
} | Identifier : NonNullable<T> extends XataRecord ? {
|
7089
7837
|
id: Identifier;
|
7090
|
-
} | Identifier | null | undefined : T extends Date ? string | Date : NonNullable<T> extends Date ? string | Date | null | undefined : T extends number ? number | NumericOperator : T;
|
7838
|
+
} | 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;
|
7091
7839
|
type EditableData<O extends XataRecord> = Identifiable & Partial<Omit<{
|
7092
7840
|
[K in keyof O]: EditableDataFields<O[K]>;
|
7093
7841
|
}, keyof XataRecord>>;
|
7094
|
-
type
|
7842
|
+
type JSONDataFile = {
|
7843
|
+
[K in keyof XataFile]: XataFile[K] extends Function ? never : XataFile[K];
|
7844
|
+
};
|
7845
|
+
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;
|
7095
7846
|
type JSONDataBase = Identifiable & {
|
7096
7847
|
/**
|
7097
7848
|
* Metadata about the record.
|
@@ -7115,7 +7866,15 @@ type JSONData<O> = JSONDataBase & Partial<Omit<{
|
|
7115
7866
|
[K in keyof O]: JSONDataFields<O[K]>;
|
7116
7867
|
}, keyof XataRecord>>;
|
7117
7868
|
|
7869
|
+
type JSONValue<Value> = Value & {
|
7870
|
+
__json: true;
|
7871
|
+
};
|
7872
|
+
|
7873
|
+
type JSONFilterColumns<Record> = Values<{
|
7874
|
+
[K in keyof Record]: NonNullable<Record[K]> extends JSONValue<any> ? K extends string ? `${K}->${string}` : never : never;
|
7875
|
+
}>;
|
7118
7876
|
type FilterColumns<T> = ColumnsByValue<T, any> | `xata.${keyof XataRecordMetadata}`;
|
7877
|
+
type FilterValueAtColumn<Record, F> = NonNullable<ValueAtColumn<Record, F>> extends JSONValue<any> ? PropertyFilter<any> : Filter<NonNullable<ValueAtColumn<Record, F>>>;
|
7119
7878
|
/**
|
7120
7879
|
* PropertyMatchFilter
|
7121
7880
|
* Example:
|
@@ -7136,6 +7895,8 @@ type FilterColumns<T> = ColumnsByValue<T, any> | `xata.${keyof XataRecordMetadat
|
|
7136
7895
|
*/
|
7137
7896
|
type PropertyAccessFilter<Record> = {
|
7138
7897
|
[key in FilterColumns<Record>]?: NestedApiFilter<ValueAtColumn<Record, key>> | PropertyFilter<ValueAtColumn<Record, key>>;
|
7898
|
+
} & {
|
7899
|
+
[key in JSONFilterColumns<Record>]?: PropertyFilter<Record[keyof Record]>;
|
7139
7900
|
};
|
7140
7901
|
type PropertyFilter<T> = T | {
|
7141
7902
|
$is: T;
|
@@ -7152,7 +7913,7 @@ type IncludesFilter<T> = PropertyFilter<T> | {
|
|
7152
7913
|
}>;
|
7153
7914
|
};
|
7154
7915
|
type StringTypeFilter = {
|
7155
|
-
[key in '$contains' | '$pattern' | '$startsWith' | '$endsWith']?: string;
|
7916
|
+
[key in '$contains' | '$iContains' | '$pattern' | '$iPattern' | '$startsWith' | '$endsWith']?: string;
|
7156
7917
|
};
|
7157
7918
|
type ComparableType = number | Date;
|
7158
7919
|
type ComparableTypeFilter<T extends ComparableType> = {
|
@@ -7321,15 +8082,20 @@ type SearchOptions<Schemas extends Record<string, BaseData>, Tables extends Stri
|
|
7321
8082
|
}>>;
|
7322
8083
|
page?: SearchPageConfig;
|
7323
8084
|
};
|
8085
|
+
type TotalCount = Pick<SearchResponse, 'totalCount'>;
|
7324
8086
|
type SearchPluginResult<Schemas extends Record<string, BaseData>> = {
|
7325
|
-
all: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<
|
7326
|
-
|
7327
|
-
|
7328
|
-
|
8087
|
+
all: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<TotalCount & {
|
8088
|
+
records: Values<{
|
8089
|
+
[Model in ExtractTables<Schemas, Tables, GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>>]: {
|
8090
|
+
table: Model;
|
8091
|
+
record: Awaited<SearchXataRecord<SelectedPick<Schemas[Model] & XataRecord, ['*']>>>;
|
8092
|
+
};
|
8093
|
+
}>[];
|
8094
|
+
}>;
|
8095
|
+
byTable: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<TotalCount & {
|
8096
|
+
records: {
|
8097
|
+
[Model in ExtractTables<Schemas, Tables, GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>>]?: Awaited<SearchXataRecord<SelectedPick<Schemas[Model] & XataRecord, ['*']>>[]>;
|
7329
8098
|
};
|
7330
|
-
}>[]>;
|
7331
|
-
byTable: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<{
|
7332
|
-
[Model in ExtractTables<Schemas, Tables, GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>>]?: Awaited<SearchXataRecord<SelectedPick<Schemas[Model] & XataRecord, ['*']>>[]>;
|
7333
8099
|
}>;
|
7334
8100
|
};
|
7335
8101
|
declare class SearchPlugin<Schemas extends Record<string, XataRecord>> extends XataPlugin {
|
@@ -7364,6 +8130,7 @@ type AggregationExpression<O extends XataRecord> = ExactlyOne<{
|
|
7364
8130
|
max: MaxAggregation<O>;
|
7365
8131
|
min: MinAggregation<O>;
|
7366
8132
|
average: AverageAggregation<O>;
|
8133
|
+
percentiles: PercentilesAggregation<O>;
|
7367
8134
|
uniqueCount: UniqueCountAggregation<O>;
|
7368
8135
|
dateHistogram: DateHistogramAggregation<O>;
|
7369
8136
|
topValues: TopValuesAggregation<O>;
|
@@ -7418,6 +8185,16 @@ type AverageAggregation<O extends XataRecord> = {
|
|
7418
8185
|
*/
|
7419
8186
|
column: ColumnsByValue<O, number>;
|
7420
8187
|
};
|
8188
|
+
/**
|
8189
|
+
* Calculate given percentiles of the numeric values in a particular column.
|
8190
|
+
*/
|
8191
|
+
type PercentilesAggregation<O extends XataRecord> = {
|
8192
|
+
/**
|
8193
|
+
* The column on which to compute the average. Must be a numeric type.
|
8194
|
+
*/
|
8195
|
+
column: ColumnsByValue<O, number>;
|
8196
|
+
percentiles: number[];
|
8197
|
+
};
|
7421
8198
|
/**
|
7422
8199
|
* Count the number of distinct values in a particular column.
|
7423
8200
|
*/
|
@@ -7513,6 +8290,11 @@ type AggregationExpressionResultTypes = {
|
|
7513
8290
|
max: number | null;
|
7514
8291
|
min: number | null;
|
7515
8292
|
average: number | null;
|
8293
|
+
percentiles: {
|
8294
|
+
values: {
|
8295
|
+
[key: string]: number;
|
8296
|
+
};
|
8297
|
+
};
|
7516
8298
|
uniqueCount: number;
|
7517
8299
|
dateHistogram: ComplexAggregationResult;
|
7518
8300
|
topValues: ComplexAggregationResult;
|
@@ -7527,7 +8309,7 @@ type ComplexAggregationResult = {
|
|
7527
8309
|
};
|
7528
8310
|
|
7529
8311
|
type KeywordAskOptions<Record extends XataRecord> = {
|
7530
|
-
searchType
|
8312
|
+
searchType?: 'keyword';
|
7531
8313
|
search?: {
|
7532
8314
|
fuzziness?: FuzzinessExpression;
|
7533
8315
|
target?: TargetColumn<Record>[];
|
@@ -7537,7 +8319,7 @@ type KeywordAskOptions<Record extends XataRecord> = {
|
|
7537
8319
|
};
|
7538
8320
|
};
|
7539
8321
|
type VectorAskOptions<Record extends XataRecord> = {
|
7540
|
-
searchType
|
8322
|
+
searchType?: 'vector';
|
7541
8323
|
vectorSearch?: {
|
7542
8324
|
/**
|
7543
8325
|
* The column to use for vector search. It must be of type `vector`.
|
@@ -7553,11 +8335,13 @@ type VectorAskOptions<Record extends XataRecord> = {
|
|
7553
8335
|
type TypeAskOptions<Record extends XataRecord> = KeywordAskOptions<Record> | VectorAskOptions<Record>;
|
7554
8336
|
type BaseAskOptions = {
|
7555
8337
|
rules?: string[];
|
8338
|
+
sessionId?: string;
|
7556
8339
|
};
|
7557
8340
|
type AskOptions<Record extends XataRecord> = TypeAskOptions<Record> & BaseAskOptions;
|
7558
8341
|
type AskResult = {
|
7559
8342
|
answer?: string;
|
7560
8343
|
records?: string[];
|
8344
|
+
sessionId?: string;
|
7561
8345
|
};
|
7562
8346
|
|
7563
8347
|
type SortDirection = 'asc' | 'desc';
|
@@ -7616,7 +8400,7 @@ type SummarizeFilter<Record extends XataRecord, Expression extends Dictionary<Su
|
|
7616
8400
|
type SummarizeResultItem<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>, Columns extends SelectableColumn<Record>[]> = SummarizeValuePick<Record, Expression> & SelectedPick<Record, Columns>;
|
7617
8401
|
|
7618
8402
|
type BaseOptions<T extends XataRecord> = {
|
7619
|
-
columns?:
|
8403
|
+
columns?: SelectableColumnWithObjectNotation<T>[];
|
7620
8404
|
consistency?: 'strong' | 'eventual';
|
7621
8405
|
cache?: number;
|
7622
8406
|
fetchOptions?: Record<string, unknown>;
|
@@ -7684,7 +8468,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
7684
8468
|
* @param value The value to filter.
|
7685
8469
|
* @returns A new Query object.
|
7686
8470
|
*/
|
7687
|
-
filter<F extends
|
8471
|
+
filter<F extends FilterColumns<Record> | JSONFilterColumns<Record>>(column: F, value: FilterValueAtColumn<Record, F>): Query<Record, Result>;
|
7688
8472
|
/**
|
7689
8473
|
* Builds a new query object adding one or more constraints. Examples:
|
7690
8474
|
*
|
@@ -7705,15 +8489,15 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
7705
8489
|
* @param direction The direction. Either ascending or descending.
|
7706
8490
|
* @returns A new Query object.
|
7707
8491
|
*/
|
7708
|
-
sort<F extends
|
8492
|
+
sort<F extends SortColumns<Record>>(column: F, direction: SortDirection): Query<Record, Result>;
|
7709
8493
|
sort(column: '*', direction: 'random'): Query<Record, Result>;
|
7710
|
-
sort<F extends
|
8494
|
+
sort<F extends SortColumns<Record>>(column: F): Query<Record, Result>;
|
7711
8495
|
/**
|
7712
8496
|
* Builds a new query specifying the set of columns to be returned in the query response.
|
7713
8497
|
* @param columns Array of column names to be returned by the query.
|
7714
8498
|
* @returns A new Query object.
|
7715
8499
|
*/
|
7716
|
-
select<K extends
|
8500
|
+
select<K extends SelectableColumnWithObjectNotation<Record>>(columns: K[]): Query<Record, SelectedPick<Record, K[]>>;
|
7717
8501
|
/**
|
7718
8502
|
* Get paginated results
|
7719
8503
|
*
|
@@ -7957,9 +8741,9 @@ type OffsetNavigationOptions = {
|
|
7957
8741
|
size?: number;
|
7958
8742
|
offset?: number;
|
7959
8743
|
};
|
7960
|
-
declare const PAGINATION_MAX_SIZE =
|
8744
|
+
declare const PAGINATION_MAX_SIZE = 1000;
|
7961
8745
|
declare const PAGINATION_DEFAULT_SIZE = 20;
|
7962
|
-
declare const PAGINATION_MAX_OFFSET =
|
8746
|
+
declare const PAGINATION_MAX_OFFSET = 49000;
|
7963
8747
|
declare const PAGINATION_DEFAULT_OFFSET = 0;
|
7964
8748
|
declare function isCursorPaginationOptions(options: Record<string, unknown> | undefined | null): options is CursorNavigationOptions;
|
7965
8749
|
declare class RecordArray<Result extends XataRecord> extends Array<Result> {
|
@@ -8494,7 +9278,9 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
8494
9278
|
boosters?: Boosters<Record>[];
|
8495
9279
|
page?: SearchPageConfig;
|
8496
9280
|
target?: TargetColumn<Record>[];
|
8497
|
-
}): Promise<
|
9281
|
+
}): Promise<{
|
9282
|
+
records: SearchXataRecord<SelectedPick<Record, ['*']>>[];
|
9283
|
+
} & TotalCount>;
|
8498
9284
|
/**
|
8499
9285
|
* Search for vectors in the table.
|
8500
9286
|
* @param column The column to search for.
|
@@ -8518,7 +9304,9 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
8518
9304
|
*/
|
8519
9305
|
size?: number;
|
8520
9306
|
filter?: Filter<Record>;
|
8521
|
-
}): Promise<
|
9307
|
+
}): Promise<{
|
9308
|
+
records: SearchXataRecord<SelectedPick<Record, ['*']>>[];
|
9309
|
+
} & TotalCount>;
|
8522
9310
|
/**
|
8523
9311
|
* Aggregates records in the table.
|
8524
9312
|
* @param expression The aggregations to perform.
|
@@ -8530,6 +9318,10 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
8530
9318
|
* Experimental: Ask the database to perform a natural language question.
|
8531
9319
|
*/
|
8532
9320
|
abstract ask(question: string, options?: AskOptions<Record>): Promise<AskResult>;
|
9321
|
+
/**
|
9322
|
+
* Experimental: Ask the database to perform a natural language question.
|
9323
|
+
*/
|
9324
|
+
abstract ask(question: string, options: AskOptions<Record>): Promise<AskResult>;
|
8533
9325
|
/**
|
8534
9326
|
* Experimental: Ask the database to perform a natural language question.
|
8535
9327
|
*/
|
@@ -8656,15 +9448,22 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
|
|
8656
9448
|
boosters?: Boosters<Record>[];
|
8657
9449
|
page?: SearchPageConfig;
|
8658
9450
|
target?: TargetColumn<Record>[];
|
8659
|
-
}): Promise<
|
9451
|
+
}): Promise<{
|
9452
|
+
records: any;
|
9453
|
+
totalCount: number;
|
9454
|
+
}>;
|
8660
9455
|
vectorSearch<F extends ColumnsByValue<Record, number[]>>(column: F, query: number[], options?: {
|
8661
9456
|
similarityFunction?: string | undefined;
|
8662
9457
|
size?: number | undefined;
|
8663
9458
|
filter?: Filter<Record> | undefined;
|
8664
|
-
} | undefined): Promise<
|
9459
|
+
} | undefined): Promise<{
|
9460
|
+
records: SearchXataRecord<SelectedPick<Record, ['*']>>[];
|
9461
|
+
} & TotalCount>;
|
8665
9462
|
aggregate<Expression extends Dictionary<AggregationExpression<Record>>>(aggs?: Expression, filter?: Filter<Record>): Promise<any>;
|
8666
9463
|
query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
|
8667
|
-
summarizeTable<Result extends XataRecord>(query: Query<Record, Result>, summaries?: Dictionary<SummarizeExpression<Record>>, summariesFilter?: FilterExpression): Promise<
|
9464
|
+
summarizeTable<Result extends XataRecord>(query: Query<Record, Result>, summaries?: Dictionary<SummarizeExpression<Record>>, summariesFilter?: FilterExpression): Promise<{
|
9465
|
+
summaries: Record[];
|
9466
|
+
}>;
|
8668
9467
|
ask(question: string, options?: AskOptions<Record> & {
|
8669
9468
|
onMessage?: (message: AskResult) => void;
|
8670
9469
|
}): any;
|
@@ -8723,7 +9522,7 @@ type PropertyType<Tables, Properties, PropertyName extends PropertyKey> = Proper
|
|
8723
9522
|
} : {
|
8724
9523
|
[K in PropertyName]?: InnerType<Type, ObjectColumns, Tables, LinkedTable> | null;
|
8725
9524
|
} : never : never;
|
8726
|
-
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 {
|
9525
|
+
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 {
|
8727
9526
|
name: string;
|
8728
9527
|
type: string;
|
8729
9528
|
} ? UnionToIntersection<Values<{
|
@@ -8798,6 +9597,10 @@ declare const endsWith: (value: string) => StringTypeFilter;
|
|
8798
9597
|
* Operator to restrict results to only values that match the given pattern.
|
8799
9598
|
*/
|
8800
9599
|
declare const pattern: (value: string) => StringTypeFilter;
|
9600
|
+
/**
|
9601
|
+
* Operator to restrict results to only values that match the given pattern (case insensitive).
|
9602
|
+
*/
|
9603
|
+
declare const iPattern: (value: string) => StringTypeFilter;
|
8801
9604
|
/**
|
8802
9605
|
* Operator to restrict results to only values that are equal to the given value.
|
8803
9606
|
*/
|
@@ -8814,6 +9617,10 @@ declare const isNot: <T>(value: T) => PropertyFilter<T>;
|
|
8814
9617
|
* Operator to restrict results to only values that contain the given value.
|
8815
9618
|
*/
|
8816
9619
|
declare const contains: (value: string) => StringTypeFilter;
|
9620
|
+
/**
|
9621
|
+
* Operator to restrict results to only values that contain the given value (case insensitive).
|
9622
|
+
*/
|
9623
|
+
declare const iContains: (value: string) => StringTypeFilter;
|
8817
9624
|
/**
|
8818
9625
|
* Operator to restrict results if some array items match the predicate.
|
8819
9626
|
*/
|
@@ -8843,6 +9650,56 @@ declare class SchemaPlugin<Schemas extends Record<string, XataRecord>> extends X
|
|
8843
9650
|
build(pluginOptions: XataPluginOptions): SchemaPluginResult<Schemas>;
|
8844
9651
|
}
|
8845
9652
|
|
9653
|
+
type BinaryFile = string | Blob | ArrayBuffer | XataFile | Promise<XataFile>;
|
9654
|
+
type FilesPluginResult<Schemas extends Record<string, BaseData>> = {
|
9655
|
+
download: <Tables extends StringKeys<Schemas>>(location: DownloadDestination<Schemas, Tables>) => Promise<Blob>;
|
9656
|
+
upload: <Tables extends StringKeys<Schemas>>(location: UploadDestination<Schemas, Tables>, file: BinaryFile, options?: {
|
9657
|
+
mediaType?: string;
|
9658
|
+
}) => Promise<FileResponse>;
|
9659
|
+
delete: <Tables extends StringKeys<Schemas>>(location: DownloadDestination<Schemas, Tables>) => Promise<FileResponse>;
|
9660
|
+
};
|
9661
|
+
type UploadDestination<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = Values<{
|
9662
|
+
[Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
|
9663
|
+
table: Model;
|
9664
|
+
column: ColumnsByValue<Schemas[Model], XataFile>;
|
9665
|
+
record: string;
|
9666
|
+
} | {
|
9667
|
+
table: Model;
|
9668
|
+
column: ColumnsByValue<Schemas[Model], XataArrayFile[]>;
|
9669
|
+
record: string;
|
9670
|
+
fileId?: string;
|
9671
|
+
};
|
9672
|
+
}>;
|
9673
|
+
type DownloadDestination<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = Values<{
|
9674
|
+
[Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
|
9675
|
+
table: Model;
|
9676
|
+
column: ColumnsByValue<Schemas[Model], XataFile>;
|
9677
|
+
record: string;
|
9678
|
+
} | {
|
9679
|
+
table: Model;
|
9680
|
+
column: ColumnsByValue<Schemas[Model], XataArrayFile[]>;
|
9681
|
+
record: string;
|
9682
|
+
fileId: string;
|
9683
|
+
};
|
9684
|
+
}>;
|
9685
|
+
declare class FilesPlugin<Schemas extends Record<string, XataRecord>> extends XataPlugin {
|
9686
|
+
build(pluginOptions: XataPluginOptions): FilesPluginResult<Schemas>;
|
9687
|
+
}
|
9688
|
+
|
9689
|
+
type SQLQueryParams<T = any[]> = {
|
9690
|
+
statement: string;
|
9691
|
+
params?: T;
|
9692
|
+
consistency?: 'strong' | 'eventual';
|
9693
|
+
};
|
9694
|
+
type SQLQuery = TemplateStringsArray | SQLQueryParams | string;
|
9695
|
+
type SQLPluginResult = <T>(query: SQLQuery, ...parameters: any[]) => Promise<{
|
9696
|
+
records: T[];
|
9697
|
+
warning?: string;
|
9698
|
+
}>;
|
9699
|
+
declare class SQLPlugin extends XataPlugin {
|
9700
|
+
build(pluginOptions: XataPluginOptions): SQLPluginResult;
|
9701
|
+
}
|
9702
|
+
|
8846
9703
|
type TransactionOperation<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = {
|
8847
9704
|
insert: Values<{
|
8848
9705
|
[Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
|
@@ -8943,6 +9800,8 @@ interface ClientConstructor<Plugins extends Record<string, XataPlugin>> {
|
|
8943
9800
|
db: Awaited<ReturnType<SchemaPlugin<Schemas>['build']>>;
|
8944
9801
|
search: Awaited<ReturnType<SearchPlugin<Schemas>['build']>>;
|
8945
9802
|
transactions: Awaited<ReturnType<TransactionPlugin<Schemas>['build']>>;
|
9803
|
+
sql: Awaited<ReturnType<SQLPlugin['build']>>;
|
9804
|
+
files: Awaited<ReturnType<FilesPlugin<Schemas>['build']>>;
|
8946
9805
|
}, keyof Plugins> & {
|
8947
9806
|
[Key in StringKeys<NonNullable<Plugins>>]: Awaited<ReturnType<NonNullable<Plugins>[Key]['build']>>;
|
8948
9807
|
} & {
|
@@ -8981,89 +9840,9 @@ declare function buildPreviewBranchName({ org, branch }: {
|
|
8981
9840
|
}): string;
|
8982
9841
|
declare function getPreviewBranch(): string | undefined;
|
8983
9842
|
|
8984
|
-
interface Body {
|
8985
|
-
arrayBuffer(): Promise<ArrayBuffer>;
|
8986
|
-
blob(): Promise<Blob$1>;
|
8987
|
-
formData(): Promise<FormData>;
|
8988
|
-
json(): Promise<any>;
|
8989
|
-
text(): Promise<string>;
|
8990
|
-
}
|
8991
|
-
interface Blob$1 {
|
8992
|
-
readonly size: number;
|
8993
|
-
readonly type: string;
|
8994
|
-
arrayBuffer(): Promise<ArrayBuffer>;
|
8995
|
-
slice(start?: number, end?: number, contentType?: string): Blob$1;
|
8996
|
-
text(): Promise<string>;
|
8997
|
-
}
|
8998
|
-
/** Provides information about files and allows JavaScript in a web page to access their content. */
|
8999
|
-
interface File extends Blob$1 {
|
9000
|
-
readonly lastModified: number;
|
9001
|
-
readonly name: string;
|
9002
|
-
readonly webkitRelativePath: string;
|
9003
|
-
}
|
9004
|
-
type FormDataEntryValue = File | string;
|
9005
|
-
/** 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". */
|
9006
|
-
interface FormData {
|
9007
|
-
append(name: string, value: string | Blob$1, fileName?: string): void;
|
9008
|
-
delete(name: string): void;
|
9009
|
-
get(name: string): FormDataEntryValue | null;
|
9010
|
-
getAll(name: string): FormDataEntryValue[];
|
9011
|
-
has(name: string): boolean;
|
9012
|
-
set(name: string, value: string | Blob$1, fileName?: string): void;
|
9013
|
-
forEach(callbackfn: (value: FormDataEntryValue, key: string, parent: FormData) => void, thisArg?: any): void;
|
9014
|
-
}
|
9015
|
-
/** 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. */
|
9016
|
-
interface Headers {
|
9017
|
-
append(name: string, value: string): void;
|
9018
|
-
delete(name: string): void;
|
9019
|
-
get(name: string): string | null;
|
9020
|
-
has(name: string): boolean;
|
9021
|
-
set(name: string, value: string): void;
|
9022
|
-
forEach(callbackfn: (value: string, key: string, parent: Headers) => void, thisArg?: any): void;
|
9023
|
-
}
|
9024
|
-
interface Request extends Body {
|
9025
|
-
/** Returns the cache mode associated with request, which is a string indicating how the request will interact with the browser's cache when fetching. */
|
9026
|
-
readonly cache: 'default' | 'force-cache' | 'no-cache' | 'no-store' | 'only-if-cached' | 'reload';
|
9027
|
-
/** Returns the credentials mode associated with request, which is a string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. */
|
9028
|
-
readonly credentials: 'include' | 'omit' | 'same-origin';
|
9029
|
-
/** Returns the kind of resource requested by request, e.g., "document" or "script". */
|
9030
|
-
readonly destination: '' | 'audio' | 'audioworklet' | 'document' | 'embed' | 'font' | 'frame' | 'iframe' | 'image' | 'manifest' | 'object' | 'paintworklet' | 'report' | 'script' | 'sharedworker' | 'style' | 'track' | 'video' | 'worker' | 'xslt';
|
9031
|
-
/** Returns a Headers object consisting of the headers associated with request. Note that headers added in the network layer by the user agent will not be accounted for in this object, e.g., the "Host" header. */
|
9032
|
-
readonly headers: Headers;
|
9033
|
-
/** Returns request's subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. [SRI] */
|
9034
|
-
readonly integrity: string;
|
9035
|
-
/** Returns a boolean indicating whether or not request can outlive the global in which it was created. */
|
9036
|
-
readonly keepalive: boolean;
|
9037
|
-
/** Returns request's HTTP method, which is "GET" by default. */
|
9038
|
-
readonly method: string;
|
9039
|
-
/** Returns the mode associated with request, which is a string indicating whether the request will use CORS, or will be restricted to same-origin URLs. */
|
9040
|
-
readonly mode: 'cors' | 'navigate' | 'no-cors' | 'same-origin';
|
9041
|
-
/** Returns the redirect mode associated with request, which is a string indicating how redirects for the request will be handled during fetching. A request will follow redirects by default. */
|
9042
|
-
readonly redirect: 'error' | 'follow' | 'manual';
|
9043
|
-
/** Returns the referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to indicate no referrer, and "about:client" when defaulting to the global's default. This is used during fetching to determine the value of the `Referer` header of the request being made. */
|
9044
|
-
readonly referrer: string;
|
9045
|
-
/** Returns the referrer policy associated with request. This is used during fetching to compute the value of the request's referrer. */
|
9046
|
-
readonly referrerPolicy: '' | 'no-referrer' | 'no-referrer-when-downgrade' | 'origin' | 'origin-when-cross-origin' | 'same-origin' | 'strict-origin' | 'strict-origin-when-cross-origin' | 'unsafe-url';
|
9047
|
-
/** Returns the URL of request as a string. */
|
9048
|
-
readonly url: string;
|
9049
|
-
clone(): Request;
|
9050
|
-
}
|
9051
|
-
|
9052
|
-
type XataWorkerContext<XataClient> = {
|
9053
|
-
xata: XataClient;
|
9054
|
-
request: Request;
|
9055
|
-
env: Record<string, string | undefined>;
|
9056
|
-
};
|
9057
|
-
type RemoveFirst<T> = T extends [any, ...infer U] ? U : never;
|
9058
|
-
type WorkerRunnerConfig = {
|
9059
|
-
workspace: string;
|
9060
|
-
worker: string;
|
9061
|
-
};
|
9062
|
-
declare function buildWorkerRunner<XataClient>(config: WorkerRunnerConfig): <WorkerFunction extends (ctx: XataWorkerContext<XataClient>, ...args: any[]) => any>(name: string, worker: WorkerFunction) => (...args: RemoveFirst<Parameters<WorkerFunction>>) => Promise<SerializerResult<Awaited<ReturnType<WorkerFunction>>>>;
|
9063
|
-
|
9064
9843
|
declare class XataError extends Error {
|
9065
9844
|
readonly status: number;
|
9066
9845
|
constructor(message: string, status: number);
|
9067
9846
|
}
|
9068
9847
|
|
9069
|
-
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, ChatSessionMessageError, ChatSessionMessagePathParams, ChatSessionMessageRequestBody, ChatSessionMessageResponse, ChatSessionMessageVariables, 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, DeleteFileError, DeleteFileItemError, DeleteFileItemPathParams, DeleteFileItemVariables, DeleteFilePathParams, DeleteFileVariables, 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, FileAccessError, FileAccessPathParams, FileAccessQueryParams, FileAccessVariables, 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, GetFileError, GetFileItemError, GetFileItemPathParams, GetFileItemVariables, GetFilePathParams, GetFileVariables, 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, JSONData, 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, PutFileError, PutFileItemError, PutFileItemPathParams, PutFileItemVariables, PutFilePathParams, PutFileVariables, Query, QueryMigrationRequestsError, QueryMigrationRequestsPathParams, QueryMigrationRequestsRequestBody, QueryMigrationRequestsResponse, QueryMigrationRequestsVariables, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RecordArray, RecordColumnTypes, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, RenameDatabaseError, RenameDatabasePathParams, RenameDatabaseRequestBody, RenameDatabaseVariables, 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, chatSessionMessage, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteFile, deleteFileItem, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, fileAccess, ge, getAPIKey, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getFile, getFileItem, 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, putFile, putFileItem, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, renameDatabase, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, sqlQuery, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
|
9848
|
+
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 ApplyMigrationError, type ApplyMigrationPathParams, type ApplyMigrationRequestBody, type ApplyMigrationVariables, 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 DeleteTransactionOperation, 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 GetSchemaError, type GetSchemaPathParams, type GetSchemaResponse, type GetSchemaVariables, 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 InsertTransactionOperation, 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 PgRollStatusError, type PgRollStatusPathParams, type PgRollStatusVariables, 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 TotalCount, type TransactionOperation, TransactionPlugin, type TransactionPluginResult, type TransactionResults, 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 UpdateTransactionOperation, 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, applyMigration, askTable, askTableSession, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, 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, getSchema, 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, pgRollStatus, 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 };
|