@xata.io/client 0.0.0-alpha.vfbde008 → 0.0.0-alpha.vfc446ea
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-add-version.log +1 -1
- package/.turbo/turbo-build.log +4 -4
- package/CHANGELOG.md +136 -2
- package/dist/index.cjs +1439 -272
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +1825 -349
- package/dist/index.mjs +1412 -270
- package/dist/index.mjs.map +1 -1
- package/package.json +6 -3
- package/.eslintrc.cjs +0 -13
- package/rollup.config.mjs +0 -44
- package/tsconfig.json +0 -23
package/dist/index.d.ts
CHANGED
@@ -22,23 +22,22 @@ declare class SimpleCache implements CacheImpl {
|
|
22
22
|
clear(): Promise<void>;
|
23
23
|
}
|
24
24
|
|
25
|
+
declare abstract class XataPlugin {
|
26
|
+
abstract build(options: XataPluginOptions): unknown;
|
27
|
+
}
|
28
|
+
type XataPluginOptions = ApiExtraProps & {
|
29
|
+
cache: CacheImpl;
|
30
|
+
host: HostProvider;
|
31
|
+
};
|
32
|
+
|
25
33
|
type AttributeDictionary = Record<string, string | number | boolean | undefined>;
|
26
34
|
type TraceFunction = <T>(name: string, fn: (options: {
|
27
35
|
name?: string;
|
28
36
|
setAttributes: (attrs: AttributeDictionary) => void;
|
29
37
|
}) => T, options?: AttributeDictionary) => Promise<T>;
|
30
38
|
|
31
|
-
declare abstract class XataPlugin {
|
32
|
-
abstract build(options: XataPluginOptions): unknown | Promise<unknown>;
|
33
|
-
}
|
34
|
-
type XataPluginOptions = {
|
35
|
-
getFetchProps: () => Promise<ApiExtraProps>;
|
36
|
-
cache: CacheImpl;
|
37
|
-
trace?: TraceFunction;
|
38
|
-
};
|
39
|
-
|
40
39
|
type RequestInit = {
|
41
|
-
body?:
|
40
|
+
body?: any;
|
42
41
|
headers?: Record<string, string>;
|
43
42
|
method?: string;
|
44
43
|
signal?: any;
|
@@ -48,6 +47,8 @@ type Response = {
|
|
48
47
|
status: number;
|
49
48
|
url: string;
|
50
49
|
json(): Promise<any>;
|
50
|
+
text(): Promise<string>;
|
51
|
+
blob(): Promise<Blob>;
|
51
52
|
headers?: {
|
52
53
|
get(name: string): string | null;
|
53
54
|
};
|
@@ -73,7 +74,7 @@ type FetcherExtraProps = {
|
|
73
74
|
endpoint: 'controlPlane' | 'dataPlane';
|
74
75
|
apiUrl: string;
|
75
76
|
workspacesApiUrl: string | WorkspaceApiUrlBuilder;
|
76
|
-
|
77
|
+
fetch: FetchImpl;
|
77
78
|
apiKey: string;
|
78
79
|
trace: TraceFunction;
|
79
80
|
signal?: AbortSignal;
|
@@ -82,12 +83,14 @@ type FetcherExtraProps = {
|
|
82
83
|
clientName?: string;
|
83
84
|
xataAgentExtra?: Record<string, string>;
|
84
85
|
fetchOptions?: Record<string, unknown>;
|
86
|
+
rawResponse?: boolean;
|
87
|
+
headers?: Record<string, unknown>;
|
85
88
|
};
|
86
89
|
|
87
90
|
type ControlPlaneFetcherExtraProps = {
|
88
91
|
apiUrl: string;
|
89
92
|
workspacesApiUrl: string | WorkspaceApiUrlBuilder;
|
90
|
-
|
93
|
+
fetch: FetchImpl;
|
91
94
|
apiKey: string;
|
92
95
|
trace: TraceFunction;
|
93
96
|
signal?: AbortSignal;
|
@@ -106,6 +109,26 @@ type ErrorWrapper$1<TError> = TError | {
|
|
106
109
|
*
|
107
110
|
* @version 1.0
|
108
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
|
+
};
|
109
132
|
type User = {
|
110
133
|
/**
|
111
134
|
* @format email
|
@@ -130,6 +153,30 @@ type DateTime$1 = string;
|
|
130
153
|
* @pattern [a-zA-Z0-9_\-~]*
|
131
154
|
*/
|
132
155
|
type APIKeyName = string;
|
156
|
+
type OAuthClientPublicDetails = {
|
157
|
+
name?: string;
|
158
|
+
description?: string;
|
159
|
+
icon?: string;
|
160
|
+
clientId: string;
|
161
|
+
};
|
162
|
+
type OAuthAccessToken = {
|
163
|
+
token: string;
|
164
|
+
scopes: string[];
|
165
|
+
/**
|
166
|
+
* @format date-time
|
167
|
+
*/
|
168
|
+
createdAt: string;
|
169
|
+
/**
|
170
|
+
* @format date-time
|
171
|
+
*/
|
172
|
+
updatedAt: string;
|
173
|
+
/**
|
174
|
+
* @format date-time
|
175
|
+
*/
|
176
|
+
expiresAt: string;
|
177
|
+
clientId: string;
|
178
|
+
};
|
179
|
+
type AccessToken = string;
|
133
180
|
/**
|
134
181
|
* @pattern ^([a-zA-Z0-9][a-zA-Z0-9_\-~]+-)?[a-zA-Z0-9]{6}
|
135
182
|
* @x-go-type auth.WorkspaceID
|
@@ -261,6 +308,7 @@ type DatabaseGithubSettings = {
|
|
261
308
|
};
|
262
309
|
type Region = {
|
263
310
|
id: string;
|
311
|
+
name: string;
|
264
312
|
};
|
265
313
|
type ListRegionsResponse = {
|
266
314
|
/**
|
@@ -296,6 +344,53 @@ type SimpleError$1 = {
|
|
296
344
|
* @version 1.0
|
297
345
|
*/
|
298
346
|
|
347
|
+
type GetAuthorizationCodeQueryParams = {
|
348
|
+
clientID: string;
|
349
|
+
responseType: OAuthResponseType;
|
350
|
+
redirectUri?: string;
|
351
|
+
scopes?: OAuthScope[];
|
352
|
+
state?: string;
|
353
|
+
};
|
354
|
+
type GetAuthorizationCodeError = ErrorWrapper$1<{
|
355
|
+
status: 400;
|
356
|
+
payload: BadRequestError$1;
|
357
|
+
} | {
|
358
|
+
status: 401;
|
359
|
+
payload: AuthError$1;
|
360
|
+
} | {
|
361
|
+
status: 404;
|
362
|
+
payload: SimpleError$1;
|
363
|
+
} | {
|
364
|
+
status: 409;
|
365
|
+
payload: SimpleError$1;
|
366
|
+
}>;
|
367
|
+
type GetAuthorizationCodeVariables = {
|
368
|
+
queryParams: GetAuthorizationCodeQueryParams;
|
369
|
+
} & ControlPlaneFetcherExtraProps;
|
370
|
+
/**
|
371
|
+
* Creates, stores and returns an authorization code to be used by a third party app. Supporting use of GET is required by OAuth2 spec
|
372
|
+
*/
|
373
|
+
declare const getAuthorizationCode: (variables: GetAuthorizationCodeVariables, signal?: AbortSignal) => Promise<AuthorizationCodeResponse>;
|
374
|
+
type GrantAuthorizationCodeError = ErrorWrapper$1<{
|
375
|
+
status: 400;
|
376
|
+
payload: BadRequestError$1;
|
377
|
+
} | {
|
378
|
+
status: 401;
|
379
|
+
payload: AuthError$1;
|
380
|
+
} | {
|
381
|
+
status: 404;
|
382
|
+
payload: SimpleError$1;
|
383
|
+
} | {
|
384
|
+
status: 409;
|
385
|
+
payload: SimpleError$1;
|
386
|
+
}>;
|
387
|
+
type GrantAuthorizationCodeVariables = {
|
388
|
+
body: AuthorizationCodeRequest;
|
389
|
+
} & ControlPlaneFetcherExtraProps;
|
390
|
+
/**
|
391
|
+
* Creates, stores and returns an authorization code to be used by a third party app
|
392
|
+
*/
|
393
|
+
declare const grantAuthorizationCode: (variables: GrantAuthorizationCodeVariables, signal?: AbortSignal) => Promise<AuthorizationCodeResponse>;
|
299
394
|
type GetUserError = ErrorWrapper$1<{
|
300
395
|
status: 400;
|
301
396
|
payload: BadRequestError$1;
|
@@ -415,6 +510,95 @@ type DeleteUserAPIKeyVariables = {
|
|
415
510
|
* Delete an existing API key
|
416
511
|
*/
|
417
512
|
declare const deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal) => Promise<undefined>;
|
513
|
+
type GetUserOAuthClientsError = ErrorWrapper$1<{
|
514
|
+
status: 400;
|
515
|
+
payload: BadRequestError$1;
|
516
|
+
} | {
|
517
|
+
status: 401;
|
518
|
+
payload: AuthError$1;
|
519
|
+
} | {
|
520
|
+
status: 404;
|
521
|
+
payload: SimpleError$1;
|
522
|
+
}>;
|
523
|
+
type GetUserOAuthClientsResponse = {
|
524
|
+
clients?: OAuthClientPublicDetails[];
|
525
|
+
};
|
526
|
+
type GetUserOAuthClientsVariables = ControlPlaneFetcherExtraProps;
|
527
|
+
/**
|
528
|
+
* Retrieve the list of OAuth Clients that a user has authorized
|
529
|
+
*/
|
530
|
+
declare const getUserOAuthClients: (variables: GetUserOAuthClientsVariables, signal?: AbortSignal) => Promise<GetUserOAuthClientsResponse>;
|
531
|
+
type GetUserOAuthAccessTokensError = ErrorWrapper$1<{
|
532
|
+
status: 400;
|
533
|
+
payload: BadRequestError$1;
|
534
|
+
} | {
|
535
|
+
status: 401;
|
536
|
+
payload: AuthError$1;
|
537
|
+
} | {
|
538
|
+
status: 404;
|
539
|
+
payload: SimpleError$1;
|
540
|
+
}>;
|
541
|
+
type GetUserOAuthAccessTokensResponse = {
|
542
|
+
accessTokens: OAuthAccessToken[];
|
543
|
+
};
|
544
|
+
type GetUserOAuthAccessTokensVariables = ControlPlaneFetcherExtraProps;
|
545
|
+
/**
|
546
|
+
* Retrieve the list of valid OAuth Access Tokens on the current user's account
|
547
|
+
*/
|
548
|
+
declare const getUserOAuthAccessTokens: (variables: GetUserOAuthAccessTokensVariables, signal?: AbortSignal) => Promise<GetUserOAuthAccessTokensResponse>;
|
549
|
+
type DeleteOAuthAccessTokenPathParams = {
|
550
|
+
token: AccessToken;
|
551
|
+
};
|
552
|
+
type DeleteOAuthAccessTokenError = ErrorWrapper$1<{
|
553
|
+
status: 400;
|
554
|
+
payload: BadRequestError$1;
|
555
|
+
} | {
|
556
|
+
status: 401;
|
557
|
+
payload: AuthError$1;
|
558
|
+
} | {
|
559
|
+
status: 404;
|
560
|
+
payload: SimpleError$1;
|
561
|
+
} | {
|
562
|
+
status: 409;
|
563
|
+
payload: SimpleError$1;
|
564
|
+
}>;
|
565
|
+
type DeleteOAuthAccessTokenVariables = {
|
566
|
+
pathParams: DeleteOAuthAccessTokenPathParams;
|
567
|
+
} & ControlPlaneFetcherExtraProps;
|
568
|
+
/**
|
569
|
+
* Expires the access token for a third party app
|
570
|
+
*/
|
571
|
+
declare const deleteOAuthAccessToken: (variables: DeleteOAuthAccessTokenVariables, signal?: AbortSignal) => Promise<undefined>;
|
572
|
+
type UpdateOAuthAccessTokenPathParams = {
|
573
|
+
token: AccessToken;
|
574
|
+
};
|
575
|
+
type UpdateOAuthAccessTokenError = ErrorWrapper$1<{
|
576
|
+
status: 400;
|
577
|
+
payload: BadRequestError$1;
|
578
|
+
} | {
|
579
|
+
status: 401;
|
580
|
+
payload: AuthError$1;
|
581
|
+
} | {
|
582
|
+
status: 404;
|
583
|
+
payload: SimpleError$1;
|
584
|
+
} | {
|
585
|
+
status: 409;
|
586
|
+
payload: SimpleError$1;
|
587
|
+
}>;
|
588
|
+
type UpdateOAuthAccessTokenRequestBody = {
|
589
|
+
/**
|
590
|
+
* expiration time of the token as a unix timestamp
|
591
|
+
*/
|
592
|
+
expires: number;
|
593
|
+
};
|
594
|
+
type UpdateOAuthAccessTokenVariables = {
|
595
|
+
body: UpdateOAuthAccessTokenRequestBody;
|
596
|
+
pathParams: UpdateOAuthAccessTokenPathParams;
|
597
|
+
} & ControlPlaneFetcherExtraProps;
|
598
|
+
/**
|
599
|
+
* Updates partially the access token for a third party app
|
600
|
+
*/
|
601
|
+
declare const updateOAuthAccessToken: (variables: UpdateOAuthAccessTokenVariables, signal?: AbortSignal) => Promise<OAuthAccessToken>;
|
418
602
|
type GetWorkspacesListError = ErrorWrapper$1<{
|
419
603
|
status: 400;
|
420
604
|
payload: BadRequestError$1;
|
@@ -954,6 +1138,43 @@ type UpdateDatabaseMetadataVariables = {
|
|
954
1138
|
* Update the color of the selected database
|
955
1139
|
*/
|
956
1140
|
declare const updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
1141
|
+
type RenameDatabasePathParams = {
|
1142
|
+
/**
|
1143
|
+
* Workspace ID
|
1144
|
+
*/
|
1145
|
+
workspaceId: WorkspaceID;
|
1146
|
+
/**
|
1147
|
+
* The Database Name
|
1148
|
+
*/
|
1149
|
+
dbName: DBName$1;
|
1150
|
+
};
|
1151
|
+
type RenameDatabaseError = ErrorWrapper$1<{
|
1152
|
+
status: 400;
|
1153
|
+
payload: BadRequestError$1;
|
1154
|
+
} | {
|
1155
|
+
status: 401;
|
1156
|
+
payload: AuthError$1;
|
1157
|
+
} | {
|
1158
|
+
status: 422;
|
1159
|
+
payload: SimpleError$1;
|
1160
|
+
} | {
|
1161
|
+
status: 423;
|
1162
|
+
payload: SimpleError$1;
|
1163
|
+
}>;
|
1164
|
+
type RenameDatabaseRequestBody = {
|
1165
|
+
/**
|
1166
|
+
* @minLength 1
|
1167
|
+
*/
|
1168
|
+
newName: string;
|
1169
|
+
};
|
1170
|
+
type RenameDatabaseVariables = {
|
1171
|
+
body: RenameDatabaseRequestBody;
|
1172
|
+
pathParams: RenameDatabasePathParams;
|
1173
|
+
} & ControlPlaneFetcherExtraProps;
|
1174
|
+
/**
|
1175
|
+
* Change the name of an existing database
|
1176
|
+
*/
|
1177
|
+
declare const renameDatabase: (variables: RenameDatabaseVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
957
1178
|
type GetDatabaseGithubSettingsPathParams = {
|
958
1179
|
/**
|
959
1180
|
* Workspace ID
|
@@ -1135,19 +1356,24 @@ type ColumnVector = {
|
|
1135
1356
|
*/
|
1136
1357
|
dimension: number;
|
1137
1358
|
};
|
1359
|
+
type ColumnFile = {
|
1360
|
+
defaultPublicAccess?: boolean;
|
1361
|
+
};
|
1138
1362
|
type Column = {
|
1139
1363
|
name: string;
|
1140
|
-
type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object' | 'datetime' | 'vector';
|
1364
|
+
type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object' | 'datetime' | 'vector' | 'file[]' | 'file';
|
1141
1365
|
link?: ColumnLink;
|
1142
1366
|
vector?: ColumnVector;
|
1367
|
+
file?: ColumnFile;
|
1368
|
+
['file[]']?: ColumnFile;
|
1143
1369
|
notNull?: boolean;
|
1144
1370
|
defaultValue?: string;
|
1145
1371
|
unique?: boolean;
|
1146
1372
|
columns?: Column[];
|
1147
1373
|
};
|
1148
1374
|
type RevLink = {
|
1149
|
-
linkID: string;
|
1150
1375
|
table: string;
|
1376
|
+
column: string;
|
1151
1377
|
};
|
1152
1378
|
type Table = {
|
1153
1379
|
id?: string;
|
@@ -1174,6 +1400,11 @@ type DBBranch = {
|
|
1174
1400
|
schema: Schema;
|
1175
1401
|
};
|
1176
1402
|
type MigrationStatus = 'completed' | 'pending' | 'failed';
|
1403
|
+
type BranchWithCopyID = {
|
1404
|
+
branchName: BranchName;
|
1405
|
+
dbBranchID: string;
|
1406
|
+
copyID: string;
|
1407
|
+
};
|
1177
1408
|
type MetricsDatapoint = {
|
1178
1409
|
timestamp: string;
|
1179
1410
|
value: number;
|
@@ -1289,7 +1520,7 @@ type FilterColumnIncludes = {
|
|
1289
1520
|
$includesNone?: FilterPredicate;
|
1290
1521
|
};
|
1291
1522
|
type FilterColumn = FilterColumnIncludes | FilterPredicate | FilterList;
|
1292
|
-
type SortOrder = 'asc' | 'desc';
|
1523
|
+
type SortOrder = 'asc' | 'desc' | 'random';
|
1293
1524
|
type SortExpression = string[] | {
|
1294
1525
|
[key: string]: SortOrder;
|
1295
1526
|
} | {
|
@@ -1387,9 +1618,13 @@ type RecordsMetadata = {
|
|
1387
1618
|
*/
|
1388
1619
|
cursor: string;
|
1389
1620
|
/**
|
1390
|
-
* true if more records can be
|
1621
|
+
* true if more records can be fetched
|
1391
1622
|
*/
|
1392
1623
|
more: boolean;
|
1624
|
+
/**
|
1625
|
+
* the number of records returned per page
|
1626
|
+
*/
|
1627
|
+
size: number;
|
1393
1628
|
};
|
1394
1629
|
};
|
1395
1630
|
type TableOpAdd = {
|
@@ -1438,10 +1673,9 @@ type Commit = {
|
|
1438
1673
|
message?: string;
|
1439
1674
|
id: string;
|
1440
1675
|
parentID?: string;
|
1676
|
+
checksum: string;
|
1441
1677
|
mergeParentID?: string;
|
1442
|
-
status: MigrationStatus;
|
1443
1678
|
createdAt: DateTime;
|
1444
|
-
modifiedAt?: DateTime;
|
1445
1679
|
operations: MigrationOp[];
|
1446
1680
|
};
|
1447
1681
|
type SchemaEditScript = {
|
@@ -1449,6 +1683,16 @@ type SchemaEditScript = {
|
|
1449
1683
|
targetMigrationID?: string;
|
1450
1684
|
operations: MigrationOp[];
|
1451
1685
|
};
|
1686
|
+
type BranchOp = {
|
1687
|
+
id: string;
|
1688
|
+
parentID?: string;
|
1689
|
+
title?: string;
|
1690
|
+
message?: string;
|
1691
|
+
status: MigrationStatus;
|
1692
|
+
createdAt: DateTime;
|
1693
|
+
modifiedAt?: DateTime;
|
1694
|
+
migration?: Commit;
|
1695
|
+
};
|
1452
1696
|
/**
|
1453
1697
|
* Branch schema migration.
|
1454
1698
|
*/
|
@@ -1456,6 +1700,14 @@ type Migration = {
|
|
1456
1700
|
parentID?: string;
|
1457
1701
|
operations: MigrationOp[];
|
1458
1702
|
};
|
1703
|
+
type MigrationObject = {
|
1704
|
+
title?: string;
|
1705
|
+
message?: string;
|
1706
|
+
id: string;
|
1707
|
+
parentID?: string;
|
1708
|
+
checksum: string;
|
1709
|
+
operations: MigrationOp[];
|
1710
|
+
};
|
1459
1711
|
/**
|
1460
1712
|
* @pattern [a-zA-Z0-9_\-~\.]+
|
1461
1713
|
*/
|
@@ -1529,9 +1781,27 @@ type TransactionUpdateOp = {
|
|
1529
1781
|
columns?: string[];
|
1530
1782
|
};
|
1531
1783
|
/**
|
1532
|
-
* A delete operation. The transaction will continue if no record matches the ID.
|
1784
|
+
* A delete operation. The transaction will continue if no record matches the ID by default. To override this behaviour, set failIfMissing to true.
|
1533
1785
|
*/
|
1534
1786
|
type TransactionDeleteOp = {
|
1787
|
+
/**
|
1788
|
+
* The table name
|
1789
|
+
*/
|
1790
|
+
table: string;
|
1791
|
+
id: RecordID;
|
1792
|
+
/**
|
1793
|
+
* If true, the transaction will fail when the record doesn't exist.
|
1794
|
+
*/
|
1795
|
+
failIfMissing?: boolean;
|
1796
|
+
/**
|
1797
|
+
* If set, the call will return the requested fields as part of the response.
|
1798
|
+
*/
|
1799
|
+
columns?: string[];
|
1800
|
+
};
|
1801
|
+
/**
|
1802
|
+
* Get by id operation.
|
1803
|
+
*/
|
1804
|
+
type TransactionGetOp = {
|
1535
1805
|
/**
|
1536
1806
|
* The table name
|
1537
1807
|
*/
|
@@ -1551,6 +1821,8 @@ type TransactionOperation$1 = {
|
|
1551
1821
|
update: TransactionUpdateOp;
|
1552
1822
|
} | {
|
1553
1823
|
['delete']: TransactionDeleteOp;
|
1824
|
+
} | {
|
1825
|
+
get: TransactionGetOp;
|
1554
1826
|
};
|
1555
1827
|
/**
|
1556
1828
|
* Fields to return in the transaction result.
|
@@ -1602,11 +1874,21 @@ type TransactionResultDelete = {
|
|
1602
1874
|
rows: number;
|
1603
1875
|
columns?: TransactionResultColumns;
|
1604
1876
|
};
|
1877
|
+
/**
|
1878
|
+
* A result from a get operation.
|
1879
|
+
*/
|
1880
|
+
type TransactionResultGet = {
|
1881
|
+
/**
|
1882
|
+
* The type of operation who's result is being returned.
|
1883
|
+
*/
|
1884
|
+
operation: 'get';
|
1885
|
+
columns?: TransactionResultColumns;
|
1886
|
+
};
|
1605
1887
|
/**
|
1606
1888
|
* An ordered array of results from the submitted operations.
|
1607
1889
|
*/
|
1608
1890
|
type TransactionSuccess = {
|
1609
|
-
results: (TransactionResultInsert | TransactionResultUpdate | TransactionResultDelete)[];
|
1891
|
+
results: (TransactionResultInsert | TransactionResultUpdate | TransactionResultDelete | TransactionResultGet)[];
|
1610
1892
|
};
|
1611
1893
|
/**
|
1612
1894
|
* An error message from a failing transaction operation
|
@@ -1622,7 +1904,7 @@ type TransactionError = {
|
|
1622
1904
|
message: string;
|
1623
1905
|
};
|
1624
1906
|
/**
|
1625
|
-
* An array of errors, with
|
1907
|
+
* An array of errors, with indices, from the transaction.
|
1626
1908
|
*/
|
1627
1909
|
type TransactionFailure = {
|
1628
1910
|
/**
|
@@ -1634,6 +1916,93 @@ type TransactionFailure = {
|
|
1634
1916
|
*/
|
1635
1917
|
errors: TransactionError[];
|
1636
1918
|
};
|
1919
|
+
/**
|
1920
|
+
* Object column value
|
1921
|
+
*/
|
1922
|
+
type ObjectValue = {
|
1923
|
+
[key: string]: string | boolean | number | string[] | number[] | DateTime | ObjectValue;
|
1924
|
+
};
|
1925
|
+
/**
|
1926
|
+
* Unique file identifier
|
1927
|
+
*
|
1928
|
+
* @maxLength 255
|
1929
|
+
* @minLength 1
|
1930
|
+
* @pattern [a-zA-Z0-9_-~:]+
|
1931
|
+
*/
|
1932
|
+
type FileItemID = string;
|
1933
|
+
/**
|
1934
|
+
* File name
|
1935
|
+
*
|
1936
|
+
* @maxLength 1024
|
1937
|
+
* @minLength 0
|
1938
|
+
* @pattern [0-9a-zA-Z!\-_\.\*'\(\)]*
|
1939
|
+
*/
|
1940
|
+
type FileName = string;
|
1941
|
+
/**
|
1942
|
+
* Media type
|
1943
|
+
*
|
1944
|
+
* @maxLength 255
|
1945
|
+
* @minLength 3
|
1946
|
+
* @pattern ^\w+/[-+.\w]+$
|
1947
|
+
*/
|
1948
|
+
type MediaType = string;
|
1949
|
+
/**
|
1950
|
+
* Object representing a file in an array
|
1951
|
+
*/
|
1952
|
+
type InputFileEntry = {
|
1953
|
+
id?: FileItemID;
|
1954
|
+
name?: FileName;
|
1955
|
+
mediaType?: MediaType;
|
1956
|
+
/**
|
1957
|
+
* Base64 encoded content
|
1958
|
+
*
|
1959
|
+
* @maxLength 20971520
|
1960
|
+
*/
|
1961
|
+
base64Content?: string;
|
1962
|
+
/**
|
1963
|
+
* Enable public access to the file
|
1964
|
+
*/
|
1965
|
+
enablePublicUrl?: boolean;
|
1966
|
+
/**
|
1967
|
+
* Time to live for signed URLs
|
1968
|
+
*/
|
1969
|
+
signedUrlTimeout?: number;
|
1970
|
+
};
|
1971
|
+
/**
|
1972
|
+
* Array of file entries
|
1973
|
+
*
|
1974
|
+
* @maxItems 50
|
1975
|
+
*/
|
1976
|
+
type InputFileArray = InputFileEntry[];
|
1977
|
+
/**
|
1978
|
+
* Object representing a file
|
1979
|
+
*
|
1980
|
+
* @x-go-type file.InputFile
|
1981
|
+
*/
|
1982
|
+
type InputFile = {
|
1983
|
+
name: FileName;
|
1984
|
+
mediaType?: MediaType;
|
1985
|
+
/**
|
1986
|
+
* Base64 encoded content
|
1987
|
+
*
|
1988
|
+
* @maxLength 20971520
|
1989
|
+
*/
|
1990
|
+
base64Content?: string;
|
1991
|
+
/**
|
1992
|
+
* Enable public access to the file
|
1993
|
+
*/
|
1994
|
+
enablePublicUrl?: boolean;
|
1995
|
+
/**
|
1996
|
+
* Time to live for signed URLs
|
1997
|
+
*/
|
1998
|
+
signedUrlTimeout?: number;
|
1999
|
+
};
|
2000
|
+
/**
|
2001
|
+
* Xata input record
|
2002
|
+
*/
|
2003
|
+
type DataInputRecord = {
|
2004
|
+
[key: string]: RecordID | string | boolean | number | string[] | number[] | DateTime | ObjectValue | InputFileArray | InputFile | null;
|
2005
|
+
};
|
1637
2006
|
/**
|
1638
2007
|
* Xata Table Record Metadata
|
1639
2008
|
*/
|
@@ -1644,6 +2013,14 @@ type RecordMeta = {
|
|
1644
2013
|
* The record's version. Can be used for optimistic concurrency control.
|
1645
2014
|
*/
|
1646
2015
|
version: number;
|
2016
|
+
/**
|
2017
|
+
* The time when the record was created.
|
2018
|
+
*/
|
2019
|
+
createdAt?: string;
|
2020
|
+
/**
|
2021
|
+
* The time when the record was last updated.
|
2022
|
+
*/
|
2023
|
+
updatedAt?: string;
|
1647
2024
|
/**
|
1648
2025
|
* The record's table name. APIs that return records from multiple tables will set this field accordingly.
|
1649
2026
|
*/
|
@@ -1667,23 +2044,64 @@ type RecordMeta = {
|
|
1667
2044
|
};
|
1668
2045
|
};
|
1669
2046
|
/**
|
1670
|
-
*
|
2047
|
+
* File metadata
|
1671
2048
|
*/
|
1672
|
-
type
|
2049
|
+
type FileResponse = {
|
2050
|
+
id?: FileItemID;
|
2051
|
+
name: FileName;
|
2052
|
+
mediaType: MediaType;
|
1673
2053
|
/**
|
1674
|
-
*
|
2054
|
+
* @format int64
|
1675
2055
|
*/
|
1676
|
-
|
2056
|
+
size: number;
|
1677
2057
|
/**
|
1678
|
-
*
|
1679
|
-
*
|
1680
|
-
* @default 1
|
1681
|
-
* @maximum 10
|
1682
|
-
* @minimum 1
|
2058
|
+
* @format int64
|
1683
2059
|
*/
|
1684
|
-
|
1685
|
-
|
1686
|
-
|
2060
|
+
version: number;
|
2061
|
+
attributes?: Record<string, any>;
|
2062
|
+
};
|
2063
|
+
type QueryColumnsProjection = (string | ProjectionConfig)[];
|
2064
|
+
/**
|
2065
|
+
* A structured projection that allows for some configuration.
|
2066
|
+
*/
|
2067
|
+
type ProjectionConfig = {
|
2068
|
+
/**
|
2069
|
+
* The name of the column to project or a reverse link specification, see [API Guide](https://xata.io/docs/concepts/data-model#links-and-relations).
|
2070
|
+
*/
|
2071
|
+
name?: string;
|
2072
|
+
columns?: QueryColumnsProjection;
|
2073
|
+
/**
|
2074
|
+
* An alias for the projected field, this is how it will be returned in the response.
|
2075
|
+
*/
|
2076
|
+
as?: string;
|
2077
|
+
sort?: SortExpression;
|
2078
|
+
/**
|
2079
|
+
* @default 20
|
2080
|
+
*/
|
2081
|
+
limit?: number;
|
2082
|
+
/**
|
2083
|
+
* @default 0
|
2084
|
+
*/
|
2085
|
+
offset?: number;
|
2086
|
+
};
|
2087
|
+
/**
|
2088
|
+
* The target expression is used to filter the search results by the target columns.
|
2089
|
+
*/
|
2090
|
+
type TargetExpression = (string | {
|
2091
|
+
/**
|
2092
|
+
* The name of the column.
|
2093
|
+
*/
|
2094
|
+
column: string;
|
2095
|
+
/**
|
2096
|
+
* The weight of the column.
|
2097
|
+
*
|
2098
|
+
* @default 1
|
2099
|
+
* @maximum 10
|
2100
|
+
* @minimum 1
|
2101
|
+
*/
|
2102
|
+
weight?: number;
|
2103
|
+
})[];
|
2104
|
+
/**
|
1687
2105
|
* Boost records with a particular value for a column.
|
1688
2106
|
*/
|
1689
2107
|
type ValueBooster$1 = {
|
@@ -1696,7 +2114,7 @@ type ValueBooster$1 = {
|
|
1696
2114
|
*/
|
1697
2115
|
value: string | number | boolean;
|
1698
2116
|
/**
|
1699
|
-
* The factor with which to multiply the
|
2117
|
+
* The factor with which to multiply the added boost.
|
1700
2118
|
*/
|
1701
2119
|
factor: number;
|
1702
2120
|
/**
|
@@ -1738,7 +2156,8 @@ type NumericBooster$1 = {
|
|
1738
2156
|
/**
|
1739
2157
|
* Boost records based on the value of a datetime column. It is configured via "origin", "scale", and "decay". The further away from the "origin",
|
1740
2158
|
* the more the score is decayed. The decay function uses an exponential function. For example if origin is "now", and scale is 10 days and decay is 0.5, it
|
1741
|
-
* should be interpreted as: a record with a date 10 days before/after origin will
|
2159
|
+
* should be interpreted as: a record with a date 10 days before/after origin will be boosted 2 times less than a record with the date at origin.
|
2160
|
+
* The result of the exponential function is a boost between 0 and 1. The "factor" allows you to control how impactful this boost is, by multiplying it with a given value.
|
1742
2161
|
*/
|
1743
2162
|
type DateBooster$1 = {
|
1744
2163
|
/**
|
@@ -1751,7 +2170,7 @@ type DateBooster$1 = {
|
|
1751
2170
|
*/
|
1752
2171
|
origin?: string;
|
1753
2172
|
/**
|
1754
|
-
* The duration at which distance from origin the score is decayed with factor, using an exponential function. It is
|
2173
|
+
* The duration at which distance from origin the score is decayed with factor, using an exponential function. It is formatted as number + units, for example: `5d`, `20m`, `10s`.
|
1755
2174
|
*
|
1756
2175
|
* @pattern ^(\d+)(d|h|m|s|ms)$
|
1757
2176
|
*/
|
@@ -1760,6 +2179,12 @@ type DateBooster$1 = {
|
|
1760
2179
|
* The decay factor to expect at "scale" distance from the "origin".
|
1761
2180
|
*/
|
1762
2181
|
decay: number;
|
2182
|
+
/**
|
2183
|
+
* The factor with which to multiply the added boost.
|
2184
|
+
*
|
2185
|
+
* @minimum 0
|
2186
|
+
*/
|
2187
|
+
factor?: number;
|
1763
2188
|
/**
|
1764
2189
|
* Only apply this booster to the records for which the provided filter matches.
|
1765
2190
|
*/
|
@@ -1780,7 +2205,7 @@ type BoosterExpression = {
|
|
1780
2205
|
/**
|
1781
2206
|
* Maximum [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) for the search terms. The Levenshtein
|
1782
2207
|
* distance is the number of one character changes needed to make two strings equal. The default is 1, meaning that single
|
1783
|
-
* character typos per word are
|
2208
|
+
* character typos per word are tolerated by search. You can set it to 0 to remove the typo tolerance or set it to 2
|
1784
2209
|
* to allow two typos in a word.
|
1785
2210
|
*
|
1786
2211
|
* @default 1
|
@@ -1927,7 +2352,7 @@ type UniqueCountAgg = {
|
|
1927
2352
|
column: string;
|
1928
2353
|
/**
|
1929
2354
|
* The threshold under which the unique count is exact. If the number of unique
|
1930
|
-
* values in the column is higher than this threshold, the results are
|
2355
|
+
* values in the column is higher than this threshold, the results are approximate.
|
1931
2356
|
* Maximum value is 40,000, default value is 3000.
|
1932
2357
|
*/
|
1933
2358
|
precisionThreshold?: number;
|
@@ -1950,7 +2375,7 @@ type DateHistogramAgg = {
|
|
1950
2375
|
column: string;
|
1951
2376
|
/**
|
1952
2377
|
* The fixed interval to use when bucketing.
|
1953
|
-
* It is
|
2378
|
+
* It is formatted as number + units, for example: `5d`, `20m`, `10s`.
|
1954
2379
|
*
|
1955
2380
|
* @pattern ^(\d+)(d|h|m|s|ms)$
|
1956
2381
|
*/
|
@@ -2005,7 +2430,7 @@ type NumericHistogramAgg = {
|
|
2005
2430
|
interval: number;
|
2006
2431
|
/**
|
2007
2432
|
* By default the bucket keys start with 0 and then continue in `interval` steps. The bucket
|
2008
|
-
* boundaries can be
|
2433
|
+
* boundaries can be shifted by using the offset option. For example, if the `interval` is 100,
|
2009
2434
|
* but you prefer the bucket boundaries to be `[50, 150), [150, 250), etc.`, you can set `offset`
|
2010
2435
|
* to 50.
|
2011
2436
|
*
|
@@ -2048,6 +2473,24 @@ type AggResponse$1 = (number | null) | {
|
|
2048
2473
|
[key: string]: AggResponse$1;
|
2049
2474
|
})[];
|
2050
2475
|
};
|
2476
|
+
/**
|
2477
|
+
* File identifier in access URLs
|
2478
|
+
*
|
2479
|
+
* @maxLength 296
|
2480
|
+
* @minLength 88
|
2481
|
+
* @pattern [a-v0-9=]+
|
2482
|
+
*/
|
2483
|
+
type FileAccessID = string;
|
2484
|
+
/**
|
2485
|
+
* File signature
|
2486
|
+
*/
|
2487
|
+
type FileSignature = string;
|
2488
|
+
/**
|
2489
|
+
* Xata Table SQL Record
|
2490
|
+
*/
|
2491
|
+
type SQLRecord = {
|
2492
|
+
[key: string]: any;
|
2493
|
+
};
|
2051
2494
|
/**
|
2052
2495
|
* Xata Table Record Metadata
|
2053
2496
|
*/
|
@@ -2093,12 +2536,19 @@ type SchemaCompareResponse = {
|
|
2093
2536
|
target: Schema;
|
2094
2537
|
edits: SchemaEditScript;
|
2095
2538
|
};
|
2539
|
+
type RateLimitError = {
|
2540
|
+
id?: string;
|
2541
|
+
message: string;
|
2542
|
+
};
|
2096
2543
|
type RecordUpdateResponse = XataRecord$1 | {
|
2097
2544
|
id: string;
|
2098
2545
|
xata: {
|
2099
2546
|
version: number;
|
2547
|
+
createdAt: string;
|
2548
|
+
updatedAt: string;
|
2100
2549
|
};
|
2101
2550
|
};
|
2551
|
+
type PutFileResponse = FileResponse;
|
2102
2552
|
type RecordResponse = XataRecord$1;
|
2103
2553
|
type BulkInsertResponse = {
|
2104
2554
|
recordIDs: string[];
|
@@ -2115,9 +2565,17 @@ type QueryResponse = {
|
|
2115
2565
|
records: XataRecord$1[];
|
2116
2566
|
meta: RecordsMetadata;
|
2117
2567
|
};
|
2568
|
+
type ServiceUnavailableError = {
|
2569
|
+
id?: string;
|
2570
|
+
message: string;
|
2571
|
+
};
|
2118
2572
|
type SearchResponse = {
|
2119
2573
|
records: XataRecord$1[];
|
2120
2574
|
warning?: string;
|
2575
|
+
/**
|
2576
|
+
* The total count of records matched. It will be accurately returned up to 10000 records.
|
2577
|
+
*/
|
2578
|
+
totalCount: number;
|
2121
2579
|
};
|
2122
2580
|
type SummarizeResponse = {
|
2123
2581
|
summaries: Record<string, any>[];
|
@@ -2130,11 +2588,15 @@ type AggResponse = {
|
|
2130
2588
|
[key: string]: AggResponse$1;
|
2131
2589
|
};
|
2132
2590
|
};
|
2591
|
+
type SQLResponse = {
|
2592
|
+
records?: SQLRecord[];
|
2593
|
+
warning?: string;
|
2594
|
+
};
|
2133
2595
|
|
2134
2596
|
type DataPlaneFetcherExtraProps = {
|
2135
2597
|
apiUrl: string;
|
2136
2598
|
workspacesApiUrl: string | WorkspaceApiUrlBuilder;
|
2137
|
-
|
2599
|
+
fetch: FetchImpl;
|
2138
2600
|
apiKey: string;
|
2139
2601
|
trace: TraceFunction;
|
2140
2602
|
signal?: AbortSignal;
|
@@ -2142,6 +2604,8 @@ type DataPlaneFetcherExtraProps = {
|
|
2142
2604
|
sessionID?: string;
|
2143
2605
|
clientName?: string;
|
2144
2606
|
xataAgentExtra?: Record<string, string>;
|
2607
|
+
rawResponse?: boolean;
|
2608
|
+
headers?: Record<string, unknown>;
|
2145
2609
|
};
|
2146
2610
|
type ErrorWrapper<TError> = TError | {
|
2147
2611
|
status: 'unknown';
|
@@ -2280,6 +2744,36 @@ type DeleteBranchVariables = {
|
|
2280
2744
|
* Delete the branch in the database and all its resources
|
2281
2745
|
*/
|
2282
2746
|
declare const deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal) => Promise<DeleteBranchResponse>;
|
2747
|
+
type CopyBranchPathParams = {
|
2748
|
+
/**
|
2749
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2750
|
+
*/
|
2751
|
+
dbBranchName: DBBranchName;
|
2752
|
+
workspace: string;
|
2753
|
+
region: string;
|
2754
|
+
};
|
2755
|
+
type CopyBranchError = ErrorWrapper<{
|
2756
|
+
status: 400;
|
2757
|
+
payload: BadRequestError;
|
2758
|
+
} | {
|
2759
|
+
status: 401;
|
2760
|
+
payload: AuthError;
|
2761
|
+
} | {
|
2762
|
+
status: 404;
|
2763
|
+
payload: SimpleError;
|
2764
|
+
}>;
|
2765
|
+
type CopyBranchRequestBody = {
|
2766
|
+
destinationBranch: string;
|
2767
|
+
limit?: number;
|
2768
|
+
};
|
2769
|
+
type CopyBranchVariables = {
|
2770
|
+
body: CopyBranchRequestBody;
|
2771
|
+
pathParams: CopyBranchPathParams;
|
2772
|
+
} & DataPlaneFetcherExtraProps;
|
2773
|
+
/**
|
2774
|
+
* Create a copy of the branch
|
2775
|
+
*/
|
2776
|
+
declare const copyBranch: (variables: CopyBranchVariables, signal?: AbortSignal) => Promise<BranchWithCopyID>;
|
2283
2777
|
type UpdateBranchMetadataPathParams = {
|
2284
2778
|
/**
|
2285
2779
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2924,7 +3418,7 @@ type MergeMigrationRequestError = ErrorWrapper<{
|
|
2924
3418
|
type MergeMigrationRequestVariables = {
|
2925
3419
|
pathParams: MergeMigrationRequestPathParams;
|
2926
3420
|
} & DataPlaneFetcherExtraProps;
|
2927
|
-
declare const mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal) => Promise<
|
3421
|
+
declare const mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal) => Promise<BranchOp>;
|
2928
3422
|
type GetBranchSchemaHistoryPathParams = {
|
2929
3423
|
/**
|
2930
3424
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3121,6 +3615,44 @@ type ApplyBranchSchemaEditVariables = {
|
|
3121
3615
|
pathParams: ApplyBranchSchemaEditPathParams;
|
3122
3616
|
} & DataPlaneFetcherExtraProps;
|
3123
3617
|
declare const applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
3618
|
+
type PushBranchMigrationsPathParams = {
|
3619
|
+
/**
|
3620
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3621
|
+
*/
|
3622
|
+
dbBranchName: DBBranchName;
|
3623
|
+
workspace: string;
|
3624
|
+
region: string;
|
3625
|
+
};
|
3626
|
+
type PushBranchMigrationsError = ErrorWrapper<{
|
3627
|
+
status: 400;
|
3628
|
+
payload: BadRequestError;
|
3629
|
+
} | {
|
3630
|
+
status: 401;
|
3631
|
+
payload: AuthError;
|
3632
|
+
} | {
|
3633
|
+
status: 404;
|
3634
|
+
payload: SimpleError;
|
3635
|
+
}>;
|
3636
|
+
type PushBranchMigrationsRequestBody = {
|
3637
|
+
migrations: MigrationObject[];
|
3638
|
+
};
|
3639
|
+
type PushBranchMigrationsVariables = {
|
3640
|
+
body: PushBranchMigrationsRequestBody;
|
3641
|
+
pathParams: PushBranchMigrationsPathParams;
|
3642
|
+
} & DataPlaneFetcherExtraProps;
|
3643
|
+
/**
|
3644
|
+
* The `schema/push` API accepts a list of migrations to be applied to the
|
3645
|
+
* current branch. A list of applicable migrations can be fetched using
|
3646
|
+
* the `schema/history` API from another branch or database.
|
3647
|
+
*
|
3648
|
+
* The most recent migration must be part of the list or referenced (via
|
3649
|
+
* `parentID`) by the first migration in the list of migrations to be pushed.
|
3650
|
+
*
|
3651
|
+
* Each migration in the list has an `id`, `parentID`, and `checksum`. The
|
3652
|
+
* checksum for migrations are generated and verified by xata. The
|
3653
|
+
* operation fails if any migration in the list has an invalid checksum.
|
3654
|
+
*/
|
3655
|
+
declare const pushBranchMigrations: (variables: PushBranchMigrationsVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
3124
3656
|
type CreateTablePathParams = {
|
3125
3657
|
/**
|
3126
3658
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3361,9 +3893,7 @@ type AddTableColumnVariables = {
|
|
3361
3893
|
pathParams: AddTableColumnPathParams;
|
3362
3894
|
} & DataPlaneFetcherExtraProps;
|
3363
3895
|
/**
|
3364
|
-
* Adds a new column to the table. The body of the request should contain the column definition.
|
3365
|
-
* contain the full path separated by dots. If the parent objects do not exists, they will be automatically created. For example,
|
3366
|
-
* passing `"name": "address.city"` will auto-create the `address` object if it doesn't exist.
|
3896
|
+
* Adds a new column to the table. The body of the request should contain the column definition.
|
3367
3897
|
*/
|
3368
3898
|
declare const addTableColumn: (variables: AddTableColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
3369
3899
|
type GetColumnPathParams = {
|
@@ -3396,7 +3926,7 @@ type GetColumnVariables = {
|
|
3396
3926
|
pathParams: GetColumnPathParams;
|
3397
3927
|
} & DataPlaneFetcherExtraProps;
|
3398
3928
|
/**
|
3399
|
-
* Get the definition of a single column.
|
3929
|
+
* Get the definition of a single column.
|
3400
3930
|
*/
|
3401
3931
|
declare const getColumn: (variables: GetColumnVariables, signal?: AbortSignal) => Promise<Column>;
|
3402
3932
|
type UpdateColumnPathParams = {
|
@@ -3436,7 +3966,7 @@ type UpdateColumnVariables = {
|
|
3436
3966
|
pathParams: UpdateColumnPathParams;
|
3437
3967
|
} & DataPlaneFetcherExtraProps;
|
3438
3968
|
/**
|
3439
|
-
* Update column with partial data. Can be used for renaming the column by providing a new "name" field.
|
3969
|
+
* Update column with partial data. Can be used for renaming the column by providing a new "name" field.
|
3440
3970
|
*/
|
3441
3971
|
declare const updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
3442
3972
|
type DeleteColumnPathParams = {
|
@@ -3469,7 +3999,7 @@ type DeleteColumnVariables = {
|
|
3469
3999
|
pathParams: DeleteColumnPathParams;
|
3470
4000
|
} & DataPlaneFetcherExtraProps;
|
3471
4001
|
/**
|
3472
|
-
* Deletes the specified column.
|
4002
|
+
* Deletes the specified column.
|
3473
4003
|
*/
|
3474
4004
|
declare const deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
3475
4005
|
type BranchTransactionPathParams = {
|
@@ -3489,6 +4019,9 @@ type BranchTransactionError = ErrorWrapper<{
|
|
3489
4019
|
} | {
|
3490
4020
|
status: 404;
|
3491
4021
|
payload: SimpleError;
|
4022
|
+
} | {
|
4023
|
+
status: 429;
|
4024
|
+
payload: RateLimitError;
|
3492
4025
|
}>;
|
3493
4026
|
type BranchTransactionRequestBody = {
|
3494
4027
|
operations: TransactionOperation$1[];
|
@@ -3527,7 +4060,7 @@ type InsertRecordError = ErrorWrapper<{
|
|
3527
4060
|
payload: SimpleError;
|
3528
4061
|
}>;
|
3529
4062
|
type InsertRecordVariables = {
|
3530
|
-
body?:
|
4063
|
+
body?: DataInputRecord;
|
3531
4064
|
pathParams: InsertRecordPathParams;
|
3532
4065
|
queryParams?: InsertRecordQueryParams;
|
3533
4066
|
} & DataPlaneFetcherExtraProps;
|
@@ -3535,6 +4068,248 @@ type InsertRecordVariables = {
|
|
3535
4068
|
* Insert a new Record into the Table
|
3536
4069
|
*/
|
3537
4070
|
declare const insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
4071
|
+
type GetFileItemPathParams = {
|
4072
|
+
/**
|
4073
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4074
|
+
*/
|
4075
|
+
dbBranchName: DBBranchName;
|
4076
|
+
/**
|
4077
|
+
* The Table name
|
4078
|
+
*/
|
4079
|
+
tableName: TableName;
|
4080
|
+
/**
|
4081
|
+
* The Record name
|
4082
|
+
*/
|
4083
|
+
recordId: RecordID;
|
4084
|
+
/**
|
4085
|
+
* The Column name
|
4086
|
+
*/
|
4087
|
+
columnName: ColumnName;
|
4088
|
+
/**
|
4089
|
+
* The File Identifier
|
4090
|
+
*/
|
4091
|
+
fileId: FileItemID;
|
4092
|
+
workspace: string;
|
4093
|
+
region: string;
|
4094
|
+
};
|
4095
|
+
type GetFileItemError = ErrorWrapper<{
|
4096
|
+
status: 400;
|
4097
|
+
payload: BadRequestError;
|
4098
|
+
} | {
|
4099
|
+
status: 401;
|
4100
|
+
payload: AuthError;
|
4101
|
+
} | {
|
4102
|
+
status: 404;
|
4103
|
+
payload: SimpleError;
|
4104
|
+
}>;
|
4105
|
+
type GetFileItemVariables = {
|
4106
|
+
pathParams: GetFileItemPathParams;
|
4107
|
+
} & DataPlaneFetcherExtraProps;
|
4108
|
+
/**
|
4109
|
+
* Retrieves file content from an array by file ID
|
4110
|
+
*/
|
4111
|
+
declare const getFileItem: (variables: GetFileItemVariables, signal?: AbortSignal) => Promise<Blob>;
|
4112
|
+
type PutFileItemPathParams = {
|
4113
|
+
/**
|
4114
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4115
|
+
*/
|
4116
|
+
dbBranchName: DBBranchName;
|
4117
|
+
/**
|
4118
|
+
* The Table name
|
4119
|
+
*/
|
4120
|
+
tableName: TableName;
|
4121
|
+
/**
|
4122
|
+
* The Record name
|
4123
|
+
*/
|
4124
|
+
recordId: RecordID;
|
4125
|
+
/**
|
4126
|
+
* The Column name
|
4127
|
+
*/
|
4128
|
+
columnName: ColumnName;
|
4129
|
+
/**
|
4130
|
+
* The File Identifier
|
4131
|
+
*/
|
4132
|
+
fileId: FileItemID;
|
4133
|
+
workspace: string;
|
4134
|
+
region: string;
|
4135
|
+
};
|
4136
|
+
type PutFileItemError = ErrorWrapper<{
|
4137
|
+
status: 400;
|
4138
|
+
payload: BadRequestError;
|
4139
|
+
} | {
|
4140
|
+
status: 401;
|
4141
|
+
payload: AuthError;
|
4142
|
+
} | {
|
4143
|
+
status: 404;
|
4144
|
+
payload: SimpleError;
|
4145
|
+
} | {
|
4146
|
+
status: 422;
|
4147
|
+
payload: SimpleError;
|
4148
|
+
}>;
|
4149
|
+
type PutFileItemVariables = {
|
4150
|
+
body?: Blob;
|
4151
|
+
pathParams: PutFileItemPathParams;
|
4152
|
+
} & DataPlaneFetcherExtraProps;
|
4153
|
+
/**
|
4154
|
+
* Uploads the file content to an array given the file ID
|
4155
|
+
*/
|
4156
|
+
declare const putFileItem: (variables: PutFileItemVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
4157
|
+
type DeleteFileItemPathParams = {
|
4158
|
+
/**
|
4159
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4160
|
+
*/
|
4161
|
+
dbBranchName: DBBranchName;
|
4162
|
+
/**
|
4163
|
+
* The Table name
|
4164
|
+
*/
|
4165
|
+
tableName: TableName;
|
4166
|
+
/**
|
4167
|
+
* The Record name
|
4168
|
+
*/
|
4169
|
+
recordId: RecordID;
|
4170
|
+
/**
|
4171
|
+
* The Column name
|
4172
|
+
*/
|
4173
|
+
columnName: ColumnName;
|
4174
|
+
/**
|
4175
|
+
* The File Identifier
|
4176
|
+
*/
|
4177
|
+
fileId: FileItemID;
|
4178
|
+
workspace: string;
|
4179
|
+
region: string;
|
4180
|
+
};
|
4181
|
+
type DeleteFileItemError = ErrorWrapper<{
|
4182
|
+
status: 400;
|
4183
|
+
payload: BadRequestError;
|
4184
|
+
} | {
|
4185
|
+
status: 401;
|
4186
|
+
payload: AuthError;
|
4187
|
+
} | {
|
4188
|
+
status: 404;
|
4189
|
+
payload: SimpleError;
|
4190
|
+
}>;
|
4191
|
+
type DeleteFileItemVariables = {
|
4192
|
+
pathParams: DeleteFileItemPathParams;
|
4193
|
+
} & DataPlaneFetcherExtraProps;
|
4194
|
+
/**
|
4195
|
+
* Deletes an item from an file array column given the file ID
|
4196
|
+
*/
|
4197
|
+
declare const deleteFileItem: (variables: DeleteFileItemVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
4198
|
+
type GetFilePathParams = {
|
4199
|
+
/**
|
4200
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4201
|
+
*/
|
4202
|
+
dbBranchName: DBBranchName;
|
4203
|
+
/**
|
4204
|
+
* The Table name
|
4205
|
+
*/
|
4206
|
+
tableName: TableName;
|
4207
|
+
/**
|
4208
|
+
* The Record name
|
4209
|
+
*/
|
4210
|
+
recordId: RecordID;
|
4211
|
+
/**
|
4212
|
+
* The Column name
|
4213
|
+
*/
|
4214
|
+
columnName: ColumnName;
|
4215
|
+
workspace: string;
|
4216
|
+
region: string;
|
4217
|
+
};
|
4218
|
+
type GetFileError = ErrorWrapper<{
|
4219
|
+
status: 400;
|
4220
|
+
payload: BadRequestError;
|
4221
|
+
} | {
|
4222
|
+
status: 401;
|
4223
|
+
payload: AuthError;
|
4224
|
+
} | {
|
4225
|
+
status: 404;
|
4226
|
+
payload: SimpleError;
|
4227
|
+
}>;
|
4228
|
+
type GetFileVariables = {
|
4229
|
+
pathParams: GetFilePathParams;
|
4230
|
+
} & DataPlaneFetcherExtraProps;
|
4231
|
+
/**
|
4232
|
+
* Retrieves the file content from a file column
|
4233
|
+
*/
|
4234
|
+
declare const getFile: (variables: GetFileVariables, signal?: AbortSignal) => Promise<Blob>;
|
4235
|
+
type PutFilePathParams = {
|
4236
|
+
/**
|
4237
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4238
|
+
*/
|
4239
|
+
dbBranchName: DBBranchName;
|
4240
|
+
/**
|
4241
|
+
* The Table name
|
4242
|
+
*/
|
4243
|
+
tableName: TableName;
|
4244
|
+
/**
|
4245
|
+
* The Record name
|
4246
|
+
*/
|
4247
|
+
recordId: RecordID;
|
4248
|
+
/**
|
4249
|
+
* The Column name
|
4250
|
+
*/
|
4251
|
+
columnName: ColumnName;
|
4252
|
+
workspace: string;
|
4253
|
+
region: string;
|
4254
|
+
};
|
4255
|
+
type PutFileError = ErrorWrapper<{
|
4256
|
+
status: 400;
|
4257
|
+
payload: BadRequestError;
|
4258
|
+
} | {
|
4259
|
+
status: 401;
|
4260
|
+
payload: AuthError;
|
4261
|
+
} | {
|
4262
|
+
status: 404;
|
4263
|
+
payload: SimpleError;
|
4264
|
+
} | {
|
4265
|
+
status: 422;
|
4266
|
+
payload: SimpleError;
|
4267
|
+
}>;
|
4268
|
+
type PutFileVariables = {
|
4269
|
+
body?: Blob;
|
4270
|
+
pathParams: PutFilePathParams;
|
4271
|
+
} & DataPlaneFetcherExtraProps;
|
4272
|
+
/**
|
4273
|
+
* Uploads the file content to the given file column
|
4274
|
+
*/
|
4275
|
+
declare const putFile: (variables: PutFileVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
4276
|
+
type DeleteFilePathParams = {
|
4277
|
+
/**
|
4278
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4279
|
+
*/
|
4280
|
+
dbBranchName: DBBranchName;
|
4281
|
+
/**
|
4282
|
+
* The Table name
|
4283
|
+
*/
|
4284
|
+
tableName: TableName;
|
4285
|
+
/**
|
4286
|
+
* The Record name
|
4287
|
+
*/
|
4288
|
+
recordId: RecordID;
|
4289
|
+
/**
|
4290
|
+
* The Column name
|
4291
|
+
*/
|
4292
|
+
columnName: ColumnName;
|
4293
|
+
workspace: string;
|
4294
|
+
region: string;
|
4295
|
+
};
|
4296
|
+
type DeleteFileError = ErrorWrapper<{
|
4297
|
+
status: 400;
|
4298
|
+
payload: BadRequestError;
|
4299
|
+
} | {
|
4300
|
+
status: 401;
|
4301
|
+
payload: AuthError;
|
4302
|
+
} | {
|
4303
|
+
status: 404;
|
4304
|
+
payload: SimpleError;
|
4305
|
+
}>;
|
4306
|
+
type DeleteFileVariables = {
|
4307
|
+
pathParams: DeleteFilePathParams;
|
4308
|
+
} & DataPlaneFetcherExtraProps;
|
4309
|
+
/**
|
4310
|
+
* Deletes a file referred in a file column
|
4311
|
+
*/
|
4312
|
+
declare const deleteFile: (variables: DeleteFileVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
3538
4313
|
type GetRecordPathParams = {
|
3539
4314
|
/**
|
3540
4315
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3613,7 +4388,7 @@ type InsertRecordWithIDError = ErrorWrapper<{
|
|
3613
4388
|
payload: SimpleError;
|
3614
4389
|
}>;
|
3615
4390
|
type InsertRecordWithIDVariables = {
|
3616
|
-
body?:
|
4391
|
+
body?: DataInputRecord;
|
3617
4392
|
pathParams: InsertRecordWithIDPathParams;
|
3618
4393
|
queryParams?: InsertRecordWithIDQueryParams;
|
3619
4394
|
} & DataPlaneFetcherExtraProps;
|
@@ -3658,7 +4433,7 @@ type UpdateRecordWithIDError = ErrorWrapper<{
|
|
3658
4433
|
payload: SimpleError;
|
3659
4434
|
}>;
|
3660
4435
|
type UpdateRecordWithIDVariables = {
|
3661
|
-
body?:
|
4436
|
+
body?: DataInputRecord;
|
3662
4437
|
pathParams: UpdateRecordWithIDPathParams;
|
3663
4438
|
queryParams?: UpdateRecordWithIDQueryParams;
|
3664
4439
|
} & DataPlaneFetcherExtraProps;
|
@@ -3700,7 +4475,7 @@ type UpsertRecordWithIDError = ErrorWrapper<{
|
|
3700
4475
|
payload: SimpleError;
|
3701
4476
|
}>;
|
3702
4477
|
type UpsertRecordWithIDVariables = {
|
3703
|
-
body?:
|
4478
|
+
body?: DataInputRecord;
|
3704
4479
|
pathParams: UpsertRecordWithIDPathParams;
|
3705
4480
|
queryParams?: UpsertRecordWithIDQueryParams;
|
3706
4481
|
} & DataPlaneFetcherExtraProps;
|
@@ -3774,7 +4549,7 @@ type BulkInsertTableRecordsError = ErrorWrapper<{
|
|
3774
4549
|
payload: SimpleError;
|
3775
4550
|
}>;
|
3776
4551
|
type BulkInsertTableRecordsRequestBody = {
|
3777
|
-
records:
|
4552
|
+
records: DataInputRecord[];
|
3778
4553
|
};
|
3779
4554
|
type BulkInsertTableRecordsVariables = {
|
3780
4555
|
body: BulkInsertTableRecordsRequestBody;
|
@@ -3806,12 +4581,15 @@ type QueryTableError = ErrorWrapper<{
|
|
3806
4581
|
} | {
|
3807
4582
|
status: 404;
|
3808
4583
|
payload: SimpleError;
|
4584
|
+
} | {
|
4585
|
+
status: 503;
|
4586
|
+
payload: ServiceUnavailableError;
|
3809
4587
|
}>;
|
3810
4588
|
type QueryTableRequestBody = {
|
3811
4589
|
filter?: FilterExpression;
|
3812
4590
|
sort?: SortExpression;
|
3813
4591
|
page?: PageConfig;
|
3814
|
-
columns?:
|
4592
|
+
columns?: QueryColumnsProjection;
|
3815
4593
|
/**
|
3816
4594
|
* The consistency level for this request.
|
3817
4595
|
*
|
@@ -4475,25 +5253,40 @@ type QueryTableVariables = {
|
|
4475
5253
|
* }
|
4476
5254
|
* ```
|
4477
5255
|
*
|
4478
|
-
*
|
5256
|
+
* It is also possible to sort results randomly:
|
5257
|
+
*
|
5258
|
+
* ```json
|
5259
|
+
* POST /db/demo:main/tables/table/query
|
5260
|
+
* {
|
5261
|
+
* "sort": {
|
5262
|
+
* "*": "random"
|
5263
|
+
* }
|
5264
|
+
* }
|
5265
|
+
* ```
|
4479
5266
|
*
|
4480
|
-
*
|
4481
|
-
* cursor pagination is needed in order to retrieve all of their results. The offset pagination method is limited to 1000 records.
|
5267
|
+
* Note that a random sort does not apply to a specific column, hence the special column name `"*"`.
|
4482
5268
|
*
|
4483
|
-
*
|
5269
|
+
* A random sort can be combined with an ascending or descending sort on a specific column:
|
4484
5270
|
*
|
4485
5271
|
* ```json
|
4486
5272
|
* POST /db/demo:main/tables/table/query
|
4487
5273
|
* {
|
4488
|
-
* "
|
4489
|
-
*
|
4490
|
-
*
|
4491
|
-
*
|
5274
|
+
* "sort": [
|
5275
|
+
* {
|
5276
|
+
* "name": "desc"
|
5277
|
+
* },
|
5278
|
+
* {
|
5279
|
+
* "*": "random"
|
5280
|
+
* }
|
5281
|
+
* ]
|
4492
5282
|
* }
|
4493
5283
|
* ```
|
4494
5284
|
*
|
4495
|
-
*
|
4496
|
-
*
|
5285
|
+
* This will sort on the `name` column, breaking ties randomly.
|
5286
|
+
*
|
5287
|
+
* ### Pagination
|
5288
|
+
*
|
5289
|
+
* We offer cursor pagination and offset pagination. The cursor pagination method can be used for sequential scrolling with unrestricted depth. The offset pagination can be used to skip pages and is limited to 1000 records.
|
4497
5290
|
*
|
4498
5291
|
* Example of cursor pagination:
|
4499
5292
|
*
|
@@ -4547,6 +5340,34 @@ type QueryTableVariables = {
|
|
4547
5340
|
* `filter` or `sort` is set. The columns returned and page size can be changed
|
4548
5341
|
* anytime by passing the `columns` or `page.size` settings to the next query.
|
4549
5342
|
*
|
5343
|
+
* In the following example of size + offset pagination we retrieve the third page of up to 100 results:
|
5344
|
+
*
|
5345
|
+
* ```json
|
5346
|
+
* POST /db/demo:main/tables/table/query
|
5347
|
+
* {
|
5348
|
+
* "page": {
|
5349
|
+
* "size": 100,
|
5350
|
+
* "offset": 200
|
5351
|
+
* }
|
5352
|
+
* }
|
5353
|
+
* ```
|
5354
|
+
*
|
5355
|
+
* The `page.size` parameter represents the maximum number of records returned by this query. It has a default value of 20 and a maximum value of 200.
|
5356
|
+
* The `page.offset` parameter represents the number of matching records to skip. It has a default value of 0 and a maximum value of 800.
|
5357
|
+
*
|
5358
|
+
* Cursor pagination also works in combination with offset pagination. For example, starting from a specific cursor position, using a page size of 200 and an offset of 800, you can skip up to 5 pages of 200 records forwards or backwards from the cursor's position:
|
5359
|
+
*
|
5360
|
+
* ```json
|
5361
|
+
* POST /db/demo:main/tables/table/query
|
5362
|
+
* {
|
5363
|
+
* "page": {
|
5364
|
+
* "size": 200,
|
5365
|
+
* "offset": 800,
|
5366
|
+
* "after": "fMoxCsIwFIDh3WP8c4amDai5hO5SJCRNfaVSeC9b6d1FD"
|
5367
|
+
* }
|
5368
|
+
* }
|
5369
|
+
* ```
|
5370
|
+
*
|
4550
5371
|
* **Special cursors:**
|
4551
5372
|
*
|
4552
5373
|
* - `page.after=end`: Result points past the last entry. The list of records
|
@@ -4597,6 +5418,9 @@ type SearchBranchError = ErrorWrapper<{
|
|
4597
5418
|
} | {
|
4598
5419
|
status: 404;
|
4599
5420
|
payload: SimpleError;
|
5421
|
+
} | {
|
5422
|
+
status: 503;
|
5423
|
+
payload: ServiceUnavailableError;
|
4600
5424
|
}>;
|
4601
5425
|
type SearchBranchRequestBody = {
|
4602
5426
|
/**
|
@@ -4708,7 +5532,7 @@ type VectorSearchTableRequestBody = {
|
|
4708
5532
|
*/
|
4709
5533
|
queryVector: number[];
|
4710
5534
|
/**
|
4711
|
-
* The vector column in which to search.
|
5535
|
+
* The vector column in which to search. It must be of type `vector`.
|
4712
5536
|
*/
|
4713
5537
|
column: string;
|
4714
5538
|
/**
|
@@ -4739,6 +5563,149 @@ type VectorSearchTableVariables = {
|
|
4739
5563
|
* dimension as the vector column.
|
4740
5564
|
*/
|
4741
5565
|
declare const vectorSearchTable: (variables: VectorSearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
5566
|
+
type AskTablePathParams = {
|
5567
|
+
/**
|
5568
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
5569
|
+
*/
|
5570
|
+
dbBranchName: DBBranchName;
|
5571
|
+
/**
|
5572
|
+
* The Table name
|
5573
|
+
*/
|
5574
|
+
tableName: TableName;
|
5575
|
+
workspace: string;
|
5576
|
+
region: string;
|
5577
|
+
};
|
5578
|
+
type AskTableError = ErrorWrapper<{
|
5579
|
+
status: 400;
|
5580
|
+
payload: BadRequestError;
|
5581
|
+
} | {
|
5582
|
+
status: 401;
|
5583
|
+
payload: AuthError;
|
5584
|
+
} | {
|
5585
|
+
status: 404;
|
5586
|
+
payload: SimpleError;
|
5587
|
+
} | {
|
5588
|
+
status: 429;
|
5589
|
+
payload: RateLimitError;
|
5590
|
+
}>;
|
5591
|
+
type AskTableResponse = {
|
5592
|
+
/**
|
5593
|
+
* The answer to the input question
|
5594
|
+
*/
|
5595
|
+
answer: string;
|
5596
|
+
/**
|
5597
|
+
* The session ID for the chat session.
|
5598
|
+
*/
|
5599
|
+
sessionId: string;
|
5600
|
+
};
|
5601
|
+
type AskTableRequestBody = {
|
5602
|
+
/**
|
5603
|
+
* The question you'd like to ask.
|
5604
|
+
*
|
5605
|
+
* @minLength 3
|
5606
|
+
*/
|
5607
|
+
question: string;
|
5608
|
+
/**
|
5609
|
+
* The type of search to use. If set to `keyword` (the default), the search can be configured by passing
|
5610
|
+
* a `search` object with the following fields. For more details about each, see the Search endpoint documentation.
|
5611
|
+
* All fields are optional.
|
5612
|
+
* * fuzziness - typo tolerance
|
5613
|
+
* * target - columns to search into, and weights.
|
5614
|
+
* * prefix - prefix search type.
|
5615
|
+
* * filter - pre-filter before searching.
|
5616
|
+
* * boosters - control relevancy.
|
5617
|
+
* If set to `vector`, a `vectorSearch` object must be passed, with the following parameters. For more details, see the Vector
|
5618
|
+
* Search endpoint documentation. The `column` and `contentColumn` parameters are required.
|
5619
|
+
* * column - the vector column containing the embeddings.
|
5620
|
+
* * contentColumn - the column that contains the text from which the embeddings where computed.
|
5621
|
+
* * filter - pre-filter before searching.
|
5622
|
+
*
|
5623
|
+
* @default keyword
|
5624
|
+
*/
|
5625
|
+
searchType?: 'keyword' | 'vector';
|
5626
|
+
search?: {
|
5627
|
+
fuzziness?: FuzzinessExpression;
|
5628
|
+
target?: TargetExpression;
|
5629
|
+
prefix?: PrefixExpression;
|
5630
|
+
filter?: FilterExpression;
|
5631
|
+
boosters?: BoosterExpression[];
|
5632
|
+
};
|
5633
|
+
vectorSearch?: {
|
5634
|
+
/**
|
5635
|
+
* The column to use for vector search. It must be of type `vector`.
|
5636
|
+
*/
|
5637
|
+
column: string;
|
5638
|
+
/**
|
5639
|
+
* The column containing the text for vector search. Must be of type `text`.
|
5640
|
+
*/
|
5641
|
+
contentColumn: string;
|
5642
|
+
filter?: FilterExpression;
|
5643
|
+
};
|
5644
|
+
rules?: string[];
|
5645
|
+
};
|
5646
|
+
type AskTableVariables = {
|
5647
|
+
body: AskTableRequestBody;
|
5648
|
+
pathParams: AskTablePathParams;
|
5649
|
+
} & DataPlaneFetcherExtraProps;
|
5650
|
+
/**
|
5651
|
+
* Ask your table a question. If the `Accept` header is set to `text/event-stream`, Xata will stream the results back as SSE's.
|
5652
|
+
*/
|
5653
|
+
declare const askTable: (variables: AskTableVariables, signal?: AbortSignal) => Promise<AskTableResponse>;
|
5654
|
+
type AskTableSessionPathParams = {
|
5655
|
+
/**
|
5656
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
5657
|
+
*/
|
5658
|
+
dbBranchName: DBBranchName;
|
5659
|
+
/**
|
5660
|
+
* The Table name
|
5661
|
+
*/
|
5662
|
+
tableName: TableName;
|
5663
|
+
/**
|
5664
|
+
* @maxLength 36
|
5665
|
+
* @minLength 36
|
5666
|
+
*/
|
5667
|
+
sessionId: string;
|
5668
|
+
workspace: string;
|
5669
|
+
region: string;
|
5670
|
+
};
|
5671
|
+
type AskTableSessionError = ErrorWrapper<{
|
5672
|
+
status: 400;
|
5673
|
+
payload: BadRequestError;
|
5674
|
+
} | {
|
5675
|
+
status: 401;
|
5676
|
+
payload: AuthError;
|
5677
|
+
} | {
|
5678
|
+
status: 404;
|
5679
|
+
payload: SimpleError;
|
5680
|
+
} | {
|
5681
|
+
status: 429;
|
5682
|
+
payload: RateLimitError;
|
5683
|
+
} | {
|
5684
|
+
status: 503;
|
5685
|
+
payload: ServiceUnavailableError;
|
5686
|
+
}>;
|
5687
|
+
type AskTableSessionResponse = {
|
5688
|
+
/**
|
5689
|
+
* The answer to the input question
|
5690
|
+
*/
|
5691
|
+
answer: string;
|
5692
|
+
};
|
5693
|
+
type AskTableSessionRequestBody = {
|
5694
|
+
/**
|
5695
|
+
* The question you'd like to ask.
|
5696
|
+
*
|
5697
|
+
* @minLength 3
|
5698
|
+
*/
|
5699
|
+
message?: string;
|
5700
|
+
};
|
5701
|
+
type AskTableSessionVariables = {
|
5702
|
+
body?: AskTableSessionRequestBody;
|
5703
|
+
pathParams: AskTableSessionPathParams;
|
5704
|
+
} & DataPlaneFetcherExtraProps;
|
5705
|
+
/**
|
5706
|
+
* Ask a follow-up question. If the `Accept` header is set to `text/event-stream`, Xata will stream the results back as SSE's.
|
5707
|
+
*/
|
5708
|
+
declare const askTableSession: (variables: AskTableSessionVariables, signal?: AbortSignal) => Promise<AskTableSessionResponse>;
|
4742
5709
|
type SummarizeTablePathParams = {
|
4743
5710
|
/**
|
4744
5711
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -4853,20 +5820,89 @@ type SummarizeTableVariables = {
|
|
4853
5820
|
* `page.size`: tells Xata how many records to return. If unspecified, Xata
|
4854
5821
|
* will return the default size.
|
4855
5822
|
*/
|
4856
|
-
declare const summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal) => Promise<SummarizeResponse>;
|
4857
|
-
type AggregateTablePathParams = {
|
5823
|
+
declare const summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal) => Promise<SummarizeResponse>;
|
5824
|
+
type AggregateTablePathParams = {
|
5825
|
+
/**
|
5826
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
5827
|
+
*/
|
5828
|
+
dbBranchName: DBBranchName;
|
5829
|
+
/**
|
5830
|
+
* The Table name
|
5831
|
+
*/
|
5832
|
+
tableName: TableName;
|
5833
|
+
workspace: string;
|
5834
|
+
region: string;
|
5835
|
+
};
|
5836
|
+
type AggregateTableError = ErrorWrapper<{
|
5837
|
+
status: 400;
|
5838
|
+
payload: BadRequestError;
|
5839
|
+
} | {
|
5840
|
+
status: 401;
|
5841
|
+
payload: AuthError;
|
5842
|
+
} | {
|
5843
|
+
status: 404;
|
5844
|
+
payload: SimpleError;
|
5845
|
+
}>;
|
5846
|
+
type AggregateTableRequestBody = {
|
5847
|
+
filter?: FilterExpression;
|
5848
|
+
aggs?: AggExpressionMap;
|
5849
|
+
};
|
5850
|
+
type AggregateTableVariables = {
|
5851
|
+
body?: AggregateTableRequestBody;
|
5852
|
+
pathParams: AggregateTablePathParams;
|
5853
|
+
} & DataPlaneFetcherExtraProps;
|
5854
|
+
/**
|
5855
|
+
* This endpoint allows you to run aggregations (analytics) on the data from one table.
|
5856
|
+
* While the summary endpoint is served from a transactional store and the results are strongly
|
5857
|
+
* consistent, the aggregate endpoint is served from our columnar store and the results are
|
5858
|
+
* only eventually consistent. On the other hand, the aggregate endpoint uses a
|
5859
|
+
* store that is more appropiate for analytics, makes use of approximative algorithms
|
5860
|
+
* (e.g for cardinality), and is generally faster and can do more complex aggregations.
|
5861
|
+
*
|
5862
|
+
* For usage, see the [API Guide](https://xata.io/docs/api-guide/aggregate).
|
5863
|
+
*/
|
5864
|
+
declare const aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal) => Promise<AggResponse>;
|
5865
|
+
type FileAccessPathParams = {
|
5866
|
+
/**
|
5867
|
+
* The File Access Identifier
|
5868
|
+
*/
|
5869
|
+
fileId: FileAccessID;
|
5870
|
+
workspace: string;
|
5871
|
+
region: string;
|
5872
|
+
};
|
5873
|
+
type FileAccessQueryParams = {
|
5874
|
+
/**
|
5875
|
+
* File access signature
|
5876
|
+
*/
|
5877
|
+
verify?: FileSignature;
|
5878
|
+
};
|
5879
|
+
type FileAccessError = ErrorWrapper<{
|
5880
|
+
status: 400;
|
5881
|
+
payload: BadRequestError;
|
5882
|
+
} | {
|
5883
|
+
status: 401;
|
5884
|
+
payload: AuthError;
|
5885
|
+
} | {
|
5886
|
+
status: 404;
|
5887
|
+
payload: SimpleError;
|
5888
|
+
}>;
|
5889
|
+
type FileAccessVariables = {
|
5890
|
+
pathParams: FileAccessPathParams;
|
5891
|
+
queryParams?: FileAccessQueryParams;
|
5892
|
+
} & DataPlaneFetcherExtraProps;
|
5893
|
+
/**
|
5894
|
+
* Retrieve file content by access id
|
5895
|
+
*/
|
5896
|
+
declare const fileAccess: (variables: FileAccessVariables, signal?: AbortSignal) => Promise<Blob>;
|
5897
|
+
type SqlQueryPathParams = {
|
4858
5898
|
/**
|
4859
5899
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4860
5900
|
*/
|
4861
5901
|
dbBranchName: DBBranchName;
|
4862
|
-
/**
|
4863
|
-
* The Table name
|
4864
|
-
*/
|
4865
|
-
tableName: TableName;
|
4866
5902
|
workspace: string;
|
4867
5903
|
region: string;
|
4868
5904
|
};
|
4869
|
-
type
|
5905
|
+
type SqlQueryError = ErrorWrapper<{
|
4870
5906
|
status: 400;
|
4871
5907
|
payload: BadRequestError;
|
4872
5908
|
} | {
|
@@ -4875,26 +5911,36 @@ type AggregateTableError = ErrorWrapper<{
|
|
4875
5911
|
} | {
|
4876
5912
|
status: 404;
|
4877
5913
|
payload: SimpleError;
|
5914
|
+
} | {
|
5915
|
+
status: 503;
|
5916
|
+
payload: ServiceUnavailableError;
|
4878
5917
|
}>;
|
4879
|
-
type
|
4880
|
-
|
4881
|
-
|
5918
|
+
type SqlQueryRequestBody = {
|
5919
|
+
/**
|
5920
|
+
* The SQL statement.
|
5921
|
+
*
|
5922
|
+
* @minLength 1
|
5923
|
+
*/
|
5924
|
+
statement: string;
|
5925
|
+
/**
|
5926
|
+
* The query parameter list.
|
5927
|
+
*/
|
5928
|
+
params?: any[] | null;
|
5929
|
+
/**
|
5930
|
+
* The consistency level for this request.
|
5931
|
+
*
|
5932
|
+
* @default strong
|
5933
|
+
*/
|
5934
|
+
consistency?: 'strong' | 'eventual';
|
4882
5935
|
};
|
4883
|
-
type
|
4884
|
-
body
|
4885
|
-
pathParams:
|
5936
|
+
type SqlQueryVariables = {
|
5937
|
+
body: SqlQueryRequestBody;
|
5938
|
+
pathParams: SqlQueryPathParams;
|
4886
5939
|
} & DataPlaneFetcherExtraProps;
|
4887
5940
|
/**
|
4888
|
-
*
|
4889
|
-
* While the summary endpoint is served from a transactional store and the results are strongly
|
4890
|
-
* consistent, the aggregate endpoint is served from our columnar store and the results are
|
4891
|
-
* only eventually consistent. On the other hand, the aggregate endpoint uses a
|
4892
|
-
* store that is more appropiate for analytics, makes use of approximative algorithms
|
4893
|
-
* (e.g for cardinality), and is generally faster and can do more complex aggregations.
|
4894
|
-
*
|
4895
|
-
* For usage, see the [API Guide](https://xata.io/docs/api-guide/aggregate).
|
5941
|
+
* Run an SQL query across the database branch.
|
4896
5942
|
*/
|
4897
|
-
declare const
|
5943
|
+
declare const sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<SQLResponse>;
|
4898
5944
|
|
4899
5945
|
declare const operationsByTag: {
|
4900
5946
|
branch: {
|
@@ -4902,6 +5948,7 @@ declare const operationsByTag: {
|
|
4902
5948
|
getBranchDetails: (variables: GetBranchDetailsVariables, signal?: AbortSignal | undefined) => Promise<DBBranch>;
|
4903
5949
|
createBranch: (variables: CreateBranchVariables, signal?: AbortSignal | undefined) => Promise<CreateBranchResponse>;
|
4904
5950
|
deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal | undefined) => Promise<DeleteBranchResponse>;
|
5951
|
+
copyBranch: (variables: CopyBranchVariables, signal?: AbortSignal | undefined) => Promise<BranchWithCopyID>;
|
4905
5952
|
updateBranchMetadata: (variables: UpdateBranchMetadataVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
4906
5953
|
getBranchMetadata: (variables: GetBranchMetadataVariables, signal?: AbortSignal | undefined) => Promise<BranchMetadata>;
|
4907
5954
|
getBranchStats: (variables: GetBranchStatsVariables, signal?: AbortSignal | undefined) => Promise<GetBranchStatsResponse>;
|
@@ -4910,16 +5957,6 @@ declare const operationsByTag: {
|
|
4910
5957
|
removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
4911
5958
|
resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal | undefined) => Promise<ResolveBranchResponse>;
|
4912
5959
|
};
|
4913
|
-
records: {
|
4914
|
-
branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal | undefined) => Promise<TransactionSuccess>;
|
4915
|
-
insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
4916
|
-
getRecord: (variables: GetRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
|
4917
|
-
insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
4918
|
-
updateRecordWithID: (variables: UpdateRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
4919
|
-
upsertRecordWithID: (variables: UpsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
4920
|
-
deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
|
4921
|
-
bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal | undefined) => Promise<BulkInsertResponse>;
|
4922
|
-
};
|
4923
5960
|
migrations: {
|
4924
5961
|
getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal | undefined) => Promise<GetBranchMigrationHistoryResponse>;
|
4925
5962
|
getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables, signal?: AbortSignal | undefined) => Promise<BranchMigrationPlan>;
|
@@ -4930,6 +5967,17 @@ declare const operationsByTag: {
|
|
4930
5967
|
updateBranchSchema: (variables: UpdateBranchSchemaVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
4931
5968
|
previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables, signal?: AbortSignal | undefined) => Promise<PreviewBranchSchemaEditResponse>;
|
4932
5969
|
applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
5970
|
+
pushBranchMigrations: (variables: PushBranchMigrationsVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
5971
|
+
};
|
5972
|
+
records: {
|
5973
|
+
branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal | undefined) => Promise<TransactionSuccess>;
|
5974
|
+
insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
5975
|
+
getRecord: (variables: GetRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
|
5976
|
+
insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
5977
|
+
updateRecordWithID: (variables: UpdateRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
5978
|
+
upsertRecordWithID: (variables: UpsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
5979
|
+
deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
|
5980
|
+
bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal | undefined) => Promise<BulkInsertResponse>;
|
4933
5981
|
};
|
4934
5982
|
migrationRequests: {
|
4935
5983
|
queryMigrationRequests: (variables: QueryMigrationRequestsVariables, signal?: AbortSignal | undefined) => Promise<QueryMigrationRequestsResponse>;
|
@@ -4939,7 +5987,7 @@ declare const operationsByTag: {
|
|
4939
5987
|
listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables, signal?: AbortSignal | undefined) => Promise<ListMigrationRequestsCommitsResponse>;
|
4940
5988
|
compareMigrationRequest: (variables: CompareMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<SchemaCompareResponse>;
|
4941
5989
|
getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables, signal?: AbortSignal | undefined) => Promise<GetMigrationRequestIsMergedResponse>;
|
4942
|
-
mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<
|
5990
|
+
mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<BranchOp>;
|
4943
5991
|
};
|
4944
5992
|
table: {
|
4945
5993
|
createTable: (variables: CreateTableVariables, signal?: AbortSignal | undefined) => Promise<CreateTableResponse>;
|
@@ -4953,14 +6001,34 @@ declare const operationsByTag: {
|
|
4953
6001
|
updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
4954
6002
|
deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
4955
6003
|
};
|
6004
|
+
files: {
|
6005
|
+
getFileItem: (variables: GetFileItemVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
|
6006
|
+
putFileItem: (variables: PutFileItemVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
|
6007
|
+
deleteFileItem: (variables: DeleteFileItemVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
|
6008
|
+
getFile: (variables: GetFileVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
|
6009
|
+
putFile: (variables: PutFileVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
|
6010
|
+
deleteFile: (variables: DeleteFileVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
|
6011
|
+
fileAccess: (variables: FileAccessVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
|
6012
|
+
};
|
4956
6013
|
searchAndFilter: {
|
4957
6014
|
queryTable: (variables: QueryTableVariables, signal?: AbortSignal | undefined) => Promise<QueryResponse>;
|
4958
6015
|
searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
|
4959
6016
|
searchTable: (variables: SearchTableVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
|
4960
6017
|
vectorSearchTable: (variables: VectorSearchTableVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
|
6018
|
+
askTable: (variables: AskTableVariables, signal?: AbortSignal | undefined) => Promise<AskTableResponse>;
|
6019
|
+
askTableSession: (variables: AskTableSessionVariables, signal?: AbortSignal | undefined) => Promise<AskTableSessionResponse>;
|
4961
6020
|
summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal | undefined) => Promise<SummarizeResponse>;
|
4962
6021
|
aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal | undefined) => Promise<AggResponse>;
|
4963
6022
|
};
|
6023
|
+
sql: {
|
6024
|
+
sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal | undefined) => Promise<SQLResponse>;
|
6025
|
+
};
|
6026
|
+
authOther: {
|
6027
|
+
getAuthorizationCode: (variables: GetAuthorizationCodeVariables, signal?: AbortSignal | undefined) => Promise<AuthorizationCodeResponse>;
|
6028
|
+
grantAuthorizationCode: (variables: GrantAuthorizationCodeVariables, signal?: AbortSignal | undefined) => Promise<AuthorizationCodeResponse>;
|
6029
|
+
deleteOAuthAccessToken: (variables: DeleteOAuthAccessTokenVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
6030
|
+
updateOAuthAccessToken: (variables: UpdateOAuthAccessTokenVariables, signal?: AbortSignal | undefined) => Promise<OAuthAccessToken>;
|
6031
|
+
};
|
4964
6032
|
users: {
|
4965
6033
|
getUser: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<UserWithID>;
|
4966
6034
|
updateUser: (variables: UpdateUserVariables, signal?: AbortSignal | undefined) => Promise<UserWithID>;
|
@@ -4970,6 +6038,8 @@ declare const operationsByTag: {
|
|
4970
6038
|
getUserAPIKeys: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetUserAPIKeysResponse>;
|
4971
6039
|
createUserAPIKey: (variables: CreateUserAPIKeyVariables, signal?: AbortSignal | undefined) => Promise<CreateUserAPIKeyResponse>;
|
4972
6040
|
deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
6041
|
+
getUserOAuthClients: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetUserOAuthClientsResponse>;
|
6042
|
+
getUserOAuthAccessTokens: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetUserOAuthAccessTokensResponse>;
|
4973
6043
|
};
|
4974
6044
|
workspaces: {
|
4975
6045
|
getWorkspacesList: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetWorkspacesListResponse>;
|
@@ -4994,6 +6064,7 @@ declare const operationsByTag: {
|
|
4994
6064
|
deleteDatabase: (variables: DeleteDatabaseVariables, signal?: AbortSignal | undefined) => Promise<DeleteDatabaseResponse>;
|
4995
6065
|
getDatabaseMetadata: (variables: GetDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
|
4996
6066
|
updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
|
6067
|
+
renameDatabase: (variables: RenameDatabaseVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
|
4997
6068
|
getDatabaseGithubSettings: (variables: GetDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<DatabaseGithubSettings>;
|
4998
6069
|
updateDatabaseGithubSettings: (variables: UpdateDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<DatabaseGithubSettings>;
|
4999
6070
|
deleteDatabaseGithubSettings: (variables: DeleteDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
@@ -5001,7 +6072,7 @@ declare const operationsByTag: {
|
|
5001
6072
|
};
|
5002
6073
|
};
|
5003
6074
|
|
5004
|
-
type HostAliases = 'production' | 'staging';
|
6075
|
+
type HostAliases = 'production' | 'staging' | 'dev';
|
5005
6076
|
type ProviderBuilder = {
|
5006
6077
|
main: string;
|
5007
6078
|
workspaces: string;
|
@@ -5011,6 +6082,7 @@ declare function getHostUrl(provider: HostProvider, type: keyof ProviderBuilder)
|
|
5011
6082
|
declare function isHostProviderAlias(alias: HostProvider | string): alias is HostAliases;
|
5012
6083
|
declare function isHostProviderBuilder(builder: HostProvider): builder is ProviderBuilder;
|
5013
6084
|
declare function parseProviderString(provider?: string): HostProvider | null;
|
6085
|
+
declare function buildProviderString(provider: HostProvider): string;
|
5014
6086
|
declare function parseWorkspacesUrlParts(url: string): {
|
5015
6087
|
workspace: string;
|
5016
6088
|
region: string;
|
@@ -5022,43 +6094,38 @@ type responses_BadRequestError = BadRequestError;
|
|
5022
6094
|
type responses_BranchMigrationPlan = BranchMigrationPlan;
|
5023
6095
|
type responses_BulkError = BulkError;
|
5024
6096
|
type responses_BulkInsertResponse = BulkInsertResponse;
|
6097
|
+
type responses_PutFileResponse = PutFileResponse;
|
5025
6098
|
type responses_QueryResponse = QueryResponse;
|
6099
|
+
type responses_RateLimitError = RateLimitError;
|
5026
6100
|
type responses_RecordResponse = RecordResponse;
|
5027
6101
|
type responses_RecordUpdateResponse = RecordUpdateResponse;
|
6102
|
+
type responses_SQLResponse = SQLResponse;
|
5028
6103
|
type responses_SchemaCompareResponse = SchemaCompareResponse;
|
5029
6104
|
type responses_SchemaUpdateResponse = SchemaUpdateResponse;
|
5030
6105
|
type responses_SearchResponse = SearchResponse;
|
6106
|
+
type responses_ServiceUnavailableError = ServiceUnavailableError;
|
5031
6107
|
type responses_SimpleError = SimpleError;
|
5032
6108
|
type responses_SummarizeResponse = SummarizeResponse;
|
5033
6109
|
declare namespace responses {
|
5034
|
-
export {
|
5035
|
-
responses_AggResponse as AggResponse,
|
5036
|
-
responses_AuthError as AuthError,
|
5037
|
-
responses_BadRequestError as BadRequestError,
|
5038
|
-
responses_BranchMigrationPlan as BranchMigrationPlan,
|
5039
|
-
responses_BulkError as BulkError,
|
5040
|
-
responses_BulkInsertResponse as BulkInsertResponse,
|
5041
|
-
responses_QueryResponse as QueryResponse,
|
5042
|
-
responses_RecordResponse as RecordResponse,
|
5043
|
-
responses_RecordUpdateResponse as RecordUpdateResponse,
|
5044
|
-
responses_SchemaCompareResponse as SchemaCompareResponse,
|
5045
|
-
responses_SchemaUpdateResponse as SchemaUpdateResponse,
|
5046
|
-
responses_SearchResponse as SearchResponse,
|
5047
|
-
responses_SimpleError as SimpleError,
|
5048
|
-
responses_SummarizeResponse as SummarizeResponse,
|
5049
|
-
};
|
6110
|
+
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 };
|
5050
6111
|
}
|
5051
6112
|
|
5052
6113
|
type schemas_APIKeyName = APIKeyName;
|
6114
|
+
type schemas_AccessToken = AccessToken;
|
5053
6115
|
type schemas_AggExpression = AggExpression;
|
5054
6116
|
type schemas_AggExpressionMap = AggExpressionMap;
|
6117
|
+
type schemas_AuthorizationCodeRequest = AuthorizationCodeRequest;
|
6118
|
+
type schemas_AuthorizationCodeResponse = AuthorizationCodeResponse;
|
5055
6119
|
type schemas_AverageAgg = AverageAgg;
|
5056
6120
|
type schemas_BoosterExpression = BoosterExpression;
|
5057
6121
|
type schemas_Branch = Branch;
|
5058
6122
|
type schemas_BranchMetadata = BranchMetadata;
|
5059
6123
|
type schemas_BranchMigration = BranchMigration;
|
5060
6124
|
type schemas_BranchName = BranchName;
|
6125
|
+
type schemas_BranchOp = BranchOp;
|
6126
|
+
type schemas_BranchWithCopyID = BranchWithCopyID;
|
5061
6127
|
type schemas_Column = Column;
|
6128
|
+
type schemas_ColumnFile = ColumnFile;
|
5062
6129
|
type schemas_ColumnLink = ColumnLink;
|
5063
6130
|
type schemas_ColumnMigration = ColumnMigration;
|
5064
6131
|
type schemas_ColumnName = ColumnName;
|
@@ -5072,10 +6139,16 @@ type schemas_CountAgg = CountAgg;
|
|
5072
6139
|
type schemas_DBBranch = DBBranch;
|
5073
6140
|
type schemas_DBBranchName = DBBranchName;
|
5074
6141
|
type schemas_DBName = DBName;
|
6142
|
+
type schemas_DataInputRecord = DataInputRecord;
|
5075
6143
|
type schemas_DatabaseGithubSettings = DatabaseGithubSettings;
|
5076
6144
|
type schemas_DatabaseMetadata = DatabaseMetadata;
|
5077
6145
|
type schemas_DateHistogramAgg = DateHistogramAgg;
|
5078
6146
|
type schemas_DateTime = DateTime;
|
6147
|
+
type schemas_FileAccessID = FileAccessID;
|
6148
|
+
type schemas_FileItemID = FileItemID;
|
6149
|
+
type schemas_FileName = FileName;
|
6150
|
+
type schemas_FileResponse = FileResponse;
|
6151
|
+
type schemas_FileSignature = FileSignature;
|
5079
6152
|
type schemas_FilterColumn = FilterColumn;
|
5080
6153
|
type schemas_FilterColumnIncludes = FilterColumnIncludes;
|
5081
6154
|
type schemas_FilterExpression = FilterExpression;
|
@@ -5087,6 +6160,9 @@ type schemas_FilterRangeValue = FilterRangeValue;
|
|
5087
6160
|
type schemas_FilterValue = FilterValue;
|
5088
6161
|
type schemas_FuzzinessExpression = FuzzinessExpression;
|
5089
6162
|
type schemas_HighlightExpression = HighlightExpression;
|
6163
|
+
type schemas_InputFile = InputFile;
|
6164
|
+
type schemas_InputFileArray = InputFileArray;
|
6165
|
+
type schemas_InputFileEntry = InputFileEntry;
|
5090
6166
|
type schemas_InviteID = InviteID;
|
5091
6167
|
type schemas_InviteKey = InviteKey;
|
5092
6168
|
type schemas_ListBranchesResponse = ListBranchesResponse;
|
@@ -5094,10 +6170,12 @@ type schemas_ListDatabasesResponse = ListDatabasesResponse;
|
|
5094
6170
|
type schemas_ListGitBranchesResponse = ListGitBranchesResponse;
|
5095
6171
|
type schemas_ListRegionsResponse = ListRegionsResponse;
|
5096
6172
|
type schemas_MaxAgg = MaxAgg;
|
6173
|
+
type schemas_MediaType = MediaType;
|
5097
6174
|
type schemas_MetricsDatapoint = MetricsDatapoint;
|
5098
6175
|
type schemas_MetricsLatency = MetricsLatency;
|
5099
6176
|
type schemas_Migration = Migration;
|
5100
6177
|
type schemas_MigrationColumnOp = MigrationColumnOp;
|
6178
|
+
type schemas_MigrationObject = MigrationObject;
|
5101
6179
|
type schemas_MigrationOp = MigrationOp;
|
5102
6180
|
type schemas_MigrationRequest = MigrationRequest;
|
5103
6181
|
type schemas_MigrationRequestNumber = MigrationRequestNumber;
|
@@ -5105,14 +6183,22 @@ type schemas_MigrationStatus = MigrationStatus;
|
|
5105
6183
|
type schemas_MigrationTableOp = MigrationTableOp;
|
5106
6184
|
type schemas_MinAgg = MinAgg;
|
5107
6185
|
type schemas_NumericHistogramAgg = NumericHistogramAgg;
|
6186
|
+
type schemas_OAuthAccessToken = OAuthAccessToken;
|
6187
|
+
type schemas_OAuthClientPublicDetails = OAuthClientPublicDetails;
|
6188
|
+
type schemas_OAuthResponseType = OAuthResponseType;
|
6189
|
+
type schemas_OAuthScope = OAuthScope;
|
6190
|
+
type schemas_ObjectValue = ObjectValue;
|
5108
6191
|
type schemas_PageConfig = PageConfig;
|
5109
6192
|
type schemas_PrefixExpression = PrefixExpression;
|
6193
|
+
type schemas_ProjectionConfig = ProjectionConfig;
|
6194
|
+
type schemas_QueryColumnsProjection = QueryColumnsProjection;
|
5110
6195
|
type schemas_RecordID = RecordID;
|
5111
6196
|
type schemas_RecordMeta = RecordMeta;
|
5112
6197
|
type schemas_RecordsMetadata = RecordsMetadata;
|
5113
6198
|
type schemas_Region = Region;
|
5114
6199
|
type schemas_RevLink = RevLink;
|
5115
6200
|
type schemas_Role = Role;
|
6201
|
+
type schemas_SQLRecord = SQLRecord;
|
5116
6202
|
type schemas_Schema = Schema;
|
5117
6203
|
type schemas_SchemaEditScript = SchemaEditScript;
|
5118
6204
|
type schemas_SearchPageConfig = SearchPageConfig;
|
@@ -5134,9 +6220,11 @@ type schemas_TopValuesAgg = TopValuesAgg;
|
|
5134
6220
|
type schemas_TransactionDeleteOp = TransactionDeleteOp;
|
5135
6221
|
type schemas_TransactionError = TransactionError;
|
5136
6222
|
type schemas_TransactionFailure = TransactionFailure;
|
6223
|
+
type schemas_TransactionGetOp = TransactionGetOp;
|
5137
6224
|
type schemas_TransactionInsertOp = TransactionInsertOp;
|
5138
6225
|
type schemas_TransactionResultColumns = TransactionResultColumns;
|
5139
6226
|
type schemas_TransactionResultDelete = TransactionResultDelete;
|
6227
|
+
type schemas_TransactionResultGet = TransactionResultGet;
|
5140
6228
|
type schemas_TransactionResultInsert = TransactionResultInsert;
|
5141
6229
|
type schemas_TransactionResultUpdate = TransactionResultUpdate;
|
5142
6230
|
type schemas_TransactionSuccess = TransactionSuccess;
|
@@ -5152,116 +6240,7 @@ type schemas_WorkspaceMember = WorkspaceMember;
|
|
5152
6240
|
type schemas_WorkspaceMembers = WorkspaceMembers;
|
5153
6241
|
type schemas_WorkspaceMeta = WorkspaceMeta;
|
5154
6242
|
declare namespace schemas {
|
5155
|
-
export {
|
5156
|
-
schemas_APIKeyName as APIKeyName,
|
5157
|
-
schemas_AggExpression as AggExpression,
|
5158
|
-
schemas_AggExpressionMap as AggExpressionMap,
|
5159
|
-
AggResponse$1 as AggResponse,
|
5160
|
-
schemas_AverageAgg as AverageAgg,
|
5161
|
-
schemas_BoosterExpression as BoosterExpression,
|
5162
|
-
schemas_Branch as Branch,
|
5163
|
-
schemas_BranchMetadata as BranchMetadata,
|
5164
|
-
schemas_BranchMigration as BranchMigration,
|
5165
|
-
schemas_BranchName as BranchName,
|
5166
|
-
schemas_Column as Column,
|
5167
|
-
schemas_ColumnLink as ColumnLink,
|
5168
|
-
schemas_ColumnMigration as ColumnMigration,
|
5169
|
-
schemas_ColumnName as ColumnName,
|
5170
|
-
schemas_ColumnOpAdd as ColumnOpAdd,
|
5171
|
-
schemas_ColumnOpRemove as ColumnOpRemove,
|
5172
|
-
schemas_ColumnOpRename as ColumnOpRename,
|
5173
|
-
schemas_ColumnVector as ColumnVector,
|
5174
|
-
schemas_ColumnsProjection as ColumnsProjection,
|
5175
|
-
schemas_Commit as Commit,
|
5176
|
-
schemas_CountAgg as CountAgg,
|
5177
|
-
schemas_DBBranch as DBBranch,
|
5178
|
-
schemas_DBBranchName as DBBranchName,
|
5179
|
-
schemas_DBName as DBName,
|
5180
|
-
schemas_DatabaseGithubSettings as DatabaseGithubSettings,
|
5181
|
-
schemas_DatabaseMetadata as DatabaseMetadata,
|
5182
|
-
DateBooster$1 as DateBooster,
|
5183
|
-
schemas_DateHistogramAgg as DateHistogramAgg,
|
5184
|
-
schemas_DateTime as DateTime,
|
5185
|
-
schemas_FilterColumn as FilterColumn,
|
5186
|
-
schemas_FilterColumnIncludes as FilterColumnIncludes,
|
5187
|
-
schemas_FilterExpression as FilterExpression,
|
5188
|
-
schemas_FilterList as FilterList,
|
5189
|
-
schemas_FilterPredicate as FilterPredicate,
|
5190
|
-
schemas_FilterPredicateOp as FilterPredicateOp,
|
5191
|
-
schemas_FilterPredicateRangeOp as FilterPredicateRangeOp,
|
5192
|
-
schemas_FilterRangeValue as FilterRangeValue,
|
5193
|
-
schemas_FilterValue as FilterValue,
|
5194
|
-
schemas_FuzzinessExpression as FuzzinessExpression,
|
5195
|
-
schemas_HighlightExpression as HighlightExpression,
|
5196
|
-
schemas_InviteID as InviteID,
|
5197
|
-
schemas_InviteKey as InviteKey,
|
5198
|
-
schemas_ListBranchesResponse as ListBranchesResponse,
|
5199
|
-
schemas_ListDatabasesResponse as ListDatabasesResponse,
|
5200
|
-
schemas_ListGitBranchesResponse as ListGitBranchesResponse,
|
5201
|
-
schemas_ListRegionsResponse as ListRegionsResponse,
|
5202
|
-
schemas_MaxAgg as MaxAgg,
|
5203
|
-
schemas_MetricsDatapoint as MetricsDatapoint,
|
5204
|
-
schemas_MetricsLatency as MetricsLatency,
|
5205
|
-
schemas_Migration as Migration,
|
5206
|
-
schemas_MigrationColumnOp as MigrationColumnOp,
|
5207
|
-
schemas_MigrationOp as MigrationOp,
|
5208
|
-
schemas_MigrationRequest as MigrationRequest,
|
5209
|
-
schemas_MigrationRequestNumber as MigrationRequestNumber,
|
5210
|
-
schemas_MigrationStatus as MigrationStatus,
|
5211
|
-
schemas_MigrationTableOp as MigrationTableOp,
|
5212
|
-
schemas_MinAgg as MinAgg,
|
5213
|
-
NumericBooster$1 as NumericBooster,
|
5214
|
-
schemas_NumericHistogramAgg as NumericHistogramAgg,
|
5215
|
-
schemas_PageConfig as PageConfig,
|
5216
|
-
schemas_PrefixExpression as PrefixExpression,
|
5217
|
-
schemas_RecordID as RecordID,
|
5218
|
-
schemas_RecordMeta as RecordMeta,
|
5219
|
-
schemas_RecordsMetadata as RecordsMetadata,
|
5220
|
-
schemas_Region as Region,
|
5221
|
-
schemas_RevLink as RevLink,
|
5222
|
-
schemas_Role as Role,
|
5223
|
-
schemas_Schema as Schema,
|
5224
|
-
schemas_SchemaEditScript as SchemaEditScript,
|
5225
|
-
schemas_SearchPageConfig as SearchPageConfig,
|
5226
|
-
schemas_SortExpression as SortExpression,
|
5227
|
-
schemas_SortOrder as SortOrder,
|
5228
|
-
schemas_StartedFromMetadata as StartedFromMetadata,
|
5229
|
-
schemas_SumAgg as SumAgg,
|
5230
|
-
schemas_SummaryExpression as SummaryExpression,
|
5231
|
-
schemas_SummaryExpressionList as SummaryExpressionList,
|
5232
|
-
schemas_Table as Table,
|
5233
|
-
schemas_TableMigration as TableMigration,
|
5234
|
-
schemas_TableName as TableName,
|
5235
|
-
schemas_TableOpAdd as TableOpAdd,
|
5236
|
-
schemas_TableOpRemove as TableOpRemove,
|
5237
|
-
schemas_TableOpRename as TableOpRename,
|
5238
|
-
schemas_TableRename as TableRename,
|
5239
|
-
schemas_TargetExpression as TargetExpression,
|
5240
|
-
schemas_TopValuesAgg as TopValuesAgg,
|
5241
|
-
schemas_TransactionDeleteOp as TransactionDeleteOp,
|
5242
|
-
schemas_TransactionError as TransactionError,
|
5243
|
-
schemas_TransactionFailure as TransactionFailure,
|
5244
|
-
schemas_TransactionInsertOp as TransactionInsertOp,
|
5245
|
-
TransactionOperation$1 as TransactionOperation,
|
5246
|
-
schemas_TransactionResultColumns as TransactionResultColumns,
|
5247
|
-
schemas_TransactionResultDelete as TransactionResultDelete,
|
5248
|
-
schemas_TransactionResultInsert as TransactionResultInsert,
|
5249
|
-
schemas_TransactionResultUpdate as TransactionResultUpdate,
|
5250
|
-
schemas_TransactionSuccess as TransactionSuccess,
|
5251
|
-
schemas_TransactionUpdateOp as TransactionUpdateOp,
|
5252
|
-
schemas_UniqueCountAgg as UniqueCountAgg,
|
5253
|
-
schemas_User as User,
|
5254
|
-
schemas_UserID as UserID,
|
5255
|
-
schemas_UserWithID as UserWithID,
|
5256
|
-
ValueBooster$1 as ValueBooster,
|
5257
|
-
schemas_Workspace as Workspace,
|
5258
|
-
schemas_WorkspaceID as WorkspaceID,
|
5259
|
-
schemas_WorkspaceInvite as WorkspaceInvite,
|
5260
|
-
schemas_WorkspaceMember as WorkspaceMember,
|
5261
|
-
schemas_WorkspaceMembers as WorkspaceMembers,
|
5262
|
-
schemas_WorkspaceMeta as WorkspaceMeta,
|
5263
|
-
XataRecord$1 as XataRecord,
|
5264
|
-
};
|
6243
|
+
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_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_Column as Column, schemas_ColumnFile as ColumnFile, schemas_ColumnLink as ColumnLink, schemas_ColumnMigration as ColumnMigration, schemas_ColumnName as ColumnName, schemas_ColumnOpAdd as ColumnOpAdd, schemas_ColumnOpRemove as ColumnOpRemove, schemas_ColumnOpRename as ColumnOpRename, schemas_ColumnVector as ColumnVector, schemas_ColumnsProjection as ColumnsProjection, schemas_Commit as Commit, schemas_CountAgg as CountAgg, schemas_DBBranch as DBBranch, schemas_DBBranchName as DBBranchName, schemas_DBName as DBName, schemas_DataInputRecord as DataInputRecord, schemas_DatabaseGithubSettings as DatabaseGithubSettings, schemas_DatabaseMetadata as DatabaseMetadata, DateBooster$1 as DateBooster, schemas_DateHistogramAgg as DateHistogramAgg, schemas_DateTime as DateTime, schemas_FileAccessID as FileAccessID, schemas_FileItemID as FileItemID, schemas_FileName as FileName, schemas_FileResponse as FileResponse, schemas_FileSignature as FileSignature, schemas_FilterColumn as FilterColumn, schemas_FilterColumnIncludes as FilterColumnIncludes, schemas_FilterExpression as FilterExpression, schemas_FilterList as FilterList, schemas_FilterPredicate as FilterPredicate, schemas_FilterPredicateOp as FilterPredicateOp, schemas_FilterPredicateRangeOp as FilterPredicateRangeOp, schemas_FilterRangeValue as FilterRangeValue, schemas_FilterValue as FilterValue, schemas_FuzzinessExpression as FuzzinessExpression, schemas_HighlightExpression as HighlightExpression, schemas_InputFile as InputFile, schemas_InputFileArray as InputFileArray, schemas_InputFileEntry as InputFileEntry, schemas_InviteID as InviteID, schemas_InviteKey as InviteKey, schemas_ListBranchesResponse as ListBranchesResponse, schemas_ListDatabasesResponse as ListDatabasesResponse, schemas_ListGitBranchesResponse as ListGitBranchesResponse, schemas_ListRegionsResponse as ListRegionsResponse, 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_OAuthClientPublicDetails as OAuthClientPublicDetails, schemas_OAuthResponseType as OAuthResponseType, schemas_OAuthScope as OAuthScope, schemas_ObjectValue as ObjectValue, schemas_PageConfig as PageConfig, schemas_PrefixExpression as PrefixExpression, schemas_ProjectionConfig as ProjectionConfig, schemas_QueryColumnsProjection as QueryColumnsProjection, schemas_RecordID as RecordID, schemas_RecordMeta as RecordMeta, schemas_RecordsMetadata as RecordsMetadata, schemas_Region as Region, schemas_RevLink as RevLink, schemas_Role as Role, schemas_SQLRecord as SQLRecord, schemas_Schema as Schema, schemas_SchemaEditScript as SchemaEditScript, schemas_SearchPageConfig as SearchPageConfig, schemas_SortExpression as SortExpression, schemas_SortOrder as SortOrder, schemas_StartedFromMetadata as StartedFromMetadata, schemas_SumAgg as SumAgg, schemas_SummaryExpression as SummaryExpression, schemas_SummaryExpressionList as SummaryExpressionList, schemas_Table as Table, schemas_TableMigration as TableMigration, schemas_TableName as TableName, schemas_TableOpAdd as TableOpAdd, schemas_TableOpRemove as TableOpRemove, schemas_TableOpRename as TableOpRename, schemas_TableRename as TableRename, schemas_TargetExpression as TargetExpression, schemas_TopValuesAgg as TopValuesAgg, schemas_TransactionDeleteOp as TransactionDeleteOp, schemas_TransactionError as TransactionError, schemas_TransactionFailure as TransactionFailure, schemas_TransactionGetOp as TransactionGetOp, schemas_TransactionInsertOp as TransactionInsertOp, TransactionOperation$1 as TransactionOperation, schemas_TransactionResultColumns as TransactionResultColumns, schemas_TransactionResultDelete as TransactionResultDelete, schemas_TransactionResultGet as TransactionResultGet, schemas_TransactionResultInsert as TransactionResultInsert, schemas_TransactionResultUpdate as TransactionResultUpdate, schemas_TransactionSuccess as TransactionSuccess, schemas_TransactionUpdateOp as TransactionUpdateOp, schemas_UniqueCountAgg as UniqueCountAgg, schemas_User as User, schemas_UserID as UserID, schemas_UserWithID as UserWithID, ValueBooster$1 as ValueBooster, schemas_Workspace as Workspace, schemas_WorkspaceID as WorkspaceID, schemas_WorkspaceInvite as WorkspaceInvite, schemas_WorkspaceMember as WorkspaceMember, schemas_WorkspaceMembers as WorkspaceMembers, schemas_WorkspaceMeta as WorkspaceMeta, XataRecord$1 as XataRecord };
|
5265
6244
|
}
|
5266
6245
|
|
5267
6246
|
type ApiExtraProps = Omit<FetcherExtraProps, 'endpoint'>;
|
@@ -5286,6 +6265,7 @@ declare class XataApiClient {
|
|
5286
6265
|
get migrationRequests(): MigrationRequestsApi;
|
5287
6266
|
get tables(): TableApi;
|
5288
6267
|
get records(): RecordsApi;
|
6268
|
+
get files(): FilesApi;
|
5289
6269
|
get searchAndFilter(): SearchAndFilterApi;
|
5290
6270
|
}
|
5291
6271
|
declare class UserApi {
|
@@ -5392,6 +6372,14 @@ declare class BranchApi {
|
|
5392
6372
|
database: DBName;
|
5393
6373
|
branch: BranchName;
|
5394
6374
|
}): Promise<DeleteBranchResponse>;
|
6375
|
+
copyBranch({ workspace, region, database, branch, destinationBranch, limit }: {
|
6376
|
+
workspace: WorkspaceID;
|
6377
|
+
region: string;
|
6378
|
+
database: DBName;
|
6379
|
+
branch: BranchName;
|
6380
|
+
destinationBranch: BranchName;
|
6381
|
+
limit?: number;
|
6382
|
+
}): Promise<BranchWithCopyID>;
|
5395
6383
|
updateBranchMetadata({ workspace, region, database, branch, metadata }: {
|
5396
6384
|
workspace: WorkspaceID;
|
5397
6385
|
region: string;
|
@@ -5599,6 +6587,75 @@ declare class RecordsApi {
|
|
5599
6587
|
operations: TransactionOperation$1[];
|
5600
6588
|
}): Promise<TransactionSuccess>;
|
5601
6589
|
}
|
6590
|
+
declare class FilesApi {
|
6591
|
+
private extraProps;
|
6592
|
+
constructor(extraProps: ApiExtraProps);
|
6593
|
+
getFileItem({ workspace, region, database, branch, table, record, column, fileId }: {
|
6594
|
+
workspace: WorkspaceID;
|
6595
|
+
region: string;
|
6596
|
+
database: DBName;
|
6597
|
+
branch: BranchName;
|
6598
|
+
table: TableName;
|
6599
|
+
record: RecordID;
|
6600
|
+
column: ColumnName;
|
6601
|
+
fileId: string;
|
6602
|
+
}): Promise<any>;
|
6603
|
+
putFileItem({ workspace, region, database, branch, table, record, column, fileId, file }: {
|
6604
|
+
workspace: WorkspaceID;
|
6605
|
+
region: string;
|
6606
|
+
database: DBName;
|
6607
|
+
branch: BranchName;
|
6608
|
+
table: TableName;
|
6609
|
+
record: RecordID;
|
6610
|
+
column: ColumnName;
|
6611
|
+
fileId: string;
|
6612
|
+
file: any;
|
6613
|
+
}): Promise<PutFileResponse>;
|
6614
|
+
deleteFileItem({ workspace, region, database, branch, table, record, column, fileId }: {
|
6615
|
+
workspace: WorkspaceID;
|
6616
|
+
region: string;
|
6617
|
+
database: DBName;
|
6618
|
+
branch: BranchName;
|
6619
|
+
table: TableName;
|
6620
|
+
record: RecordID;
|
6621
|
+
column: ColumnName;
|
6622
|
+
fileId: string;
|
6623
|
+
}): Promise<PutFileResponse>;
|
6624
|
+
getFile({ workspace, region, database, branch, table, record, column }: {
|
6625
|
+
workspace: WorkspaceID;
|
6626
|
+
region: string;
|
6627
|
+
database: DBName;
|
6628
|
+
branch: BranchName;
|
6629
|
+
table: TableName;
|
6630
|
+
record: RecordID;
|
6631
|
+
column: ColumnName;
|
6632
|
+
}): Promise<any>;
|
6633
|
+
putFile({ workspace, region, database, branch, table, record, column, file }: {
|
6634
|
+
workspace: WorkspaceID;
|
6635
|
+
region: string;
|
6636
|
+
database: DBName;
|
6637
|
+
branch: BranchName;
|
6638
|
+
table: TableName;
|
6639
|
+
record: RecordID;
|
6640
|
+
column: ColumnName;
|
6641
|
+
file: Blob;
|
6642
|
+
}): Promise<PutFileResponse>;
|
6643
|
+
deleteFile({ workspace, region, database, branch, table, record, column }: {
|
6644
|
+
workspace: WorkspaceID;
|
6645
|
+
region: string;
|
6646
|
+
database: DBName;
|
6647
|
+
branch: BranchName;
|
6648
|
+
table: TableName;
|
6649
|
+
record: RecordID;
|
6650
|
+
column: ColumnName;
|
6651
|
+
}): Promise<PutFileResponse>;
|
6652
|
+
fileAccess({ workspace, region, fileId, verify }: {
|
6653
|
+
workspace: WorkspaceID;
|
6654
|
+
region: string;
|
6655
|
+
fileId: string;
|
6656
|
+
verify?: FileSignature;
|
6657
|
+
}): Promise<any>;
|
6658
|
+
}
|
5602
6659
|
declare class SearchAndFilterApi {
|
5603
6660
|
private extraProps;
|
5604
6661
|
constructor(extraProps: ApiExtraProps);
|
@@ -5644,6 +6701,35 @@ declare class SearchAndFilterApi {
|
|
5644
6701
|
prefix?: PrefixExpression;
|
5645
6702
|
highlight?: HighlightExpression;
|
5646
6703
|
}): Promise<SearchResponse>;
|
6704
|
+
vectorSearchTable({ workspace, region, database, branch, table, queryVector, column, similarityFunction, size, filter }: {
|
6705
|
+
workspace: WorkspaceID;
|
6706
|
+
region: string;
|
6707
|
+
database: DBName;
|
6708
|
+
branch: BranchName;
|
6709
|
+
table: TableName;
|
6710
|
+
queryVector: number[];
|
6711
|
+
column: string;
|
6712
|
+
similarityFunction?: string;
|
6713
|
+
size?: number;
|
6714
|
+
filter?: FilterExpression;
|
6715
|
+
}): Promise<SearchResponse>;
|
6716
|
+
askTable({ workspace, region, database, branch, table, options }: {
|
6717
|
+
workspace: WorkspaceID;
|
6718
|
+
region: string;
|
6719
|
+
database: DBName;
|
6720
|
+
branch: BranchName;
|
6721
|
+
table: TableName;
|
6722
|
+
options: AskTableRequestBody;
|
6723
|
+
}): Promise<AskTableResponse>;
|
6724
|
+
askTableSession({ workspace, region, database, branch, table, sessionId, message }: {
|
6725
|
+
workspace: WorkspaceID;
|
6726
|
+
region: string;
|
6727
|
+
database: DBName;
|
6728
|
+
branch: BranchName;
|
6729
|
+
table: TableName;
|
6730
|
+
sessionId: string;
|
6731
|
+
message: string;
|
6732
|
+
}): Promise<AskTableSessionResponse>;
|
5647
6733
|
summarizeTable({ workspace, region, database, branch, table, filter, columns, summaries, sort, summariesFilter, page, consistency }: {
|
5648
6734
|
workspace: WorkspaceID;
|
5649
6735
|
region: string;
|
@@ -5729,7 +6815,7 @@ declare class MigrationRequestsApi {
|
|
5729
6815
|
region: string;
|
5730
6816
|
database: DBName;
|
5731
6817
|
migrationRequest: MigrationRequestNumber;
|
5732
|
-
}): Promise<
|
6818
|
+
}): Promise<BranchOp>;
|
5733
6819
|
}
|
5734
6820
|
declare class MigrationsApi {
|
5735
6821
|
private extraProps;
|
@@ -5808,6 +6894,13 @@ declare class MigrationsApi {
|
|
5808
6894
|
branch: BranchName;
|
5809
6895
|
edits: SchemaEditScript;
|
5810
6896
|
}): Promise<SchemaUpdateResponse>;
|
6897
|
+
pushBranchMigrations({ workspace, region, database, branch, migrations }: {
|
6898
|
+
workspace: WorkspaceID;
|
6899
|
+
region: string;
|
6900
|
+
database: DBName;
|
6901
|
+
branch: BranchName;
|
6902
|
+
migrations: MigrationObject[];
|
6903
|
+
}): Promise<SchemaUpdateResponse>;
|
5811
6904
|
}
|
5812
6905
|
declare class DatabaseApi {
|
5813
6906
|
private extraProps;
|
@@ -5815,10 +6908,11 @@ declare class DatabaseApi {
|
|
5815
6908
|
getDatabaseList({ workspace }: {
|
5816
6909
|
workspace: WorkspaceID;
|
5817
6910
|
}): Promise<ListDatabasesResponse>;
|
5818
|
-
createDatabase({ workspace, database, data }: {
|
6911
|
+
createDatabase({ workspace, database, data, headers }: {
|
5819
6912
|
workspace: WorkspaceID;
|
5820
6913
|
database: DBName;
|
5821
6914
|
data: CreateDatabaseRequestBody;
|
6915
|
+
headers?: Record<string, string>;
|
5822
6916
|
}): Promise<CreateDatabaseResponse>;
|
5823
6917
|
deleteDatabase({ workspace, database }: {
|
5824
6918
|
workspace: WorkspaceID;
|
@@ -5833,6 +6927,11 @@ declare class DatabaseApi {
|
|
5833
6927
|
database: DBName;
|
5834
6928
|
metadata: DatabaseMetadata;
|
5835
6929
|
}): Promise<DatabaseMetadata>;
|
6930
|
+
renameDatabase({ workspace, database, newName }: {
|
6931
|
+
workspace: WorkspaceID;
|
6932
|
+
database: DBName;
|
6933
|
+
newName: DBName;
|
6934
|
+
}): Promise<DatabaseMetadata>;
|
5836
6935
|
getDatabaseGithubSettings({ workspace, database }: {
|
5837
6936
|
workspace: WorkspaceID;
|
5838
6937
|
database: DBName;
|
@@ -5852,7 +6951,7 @@ declare class DatabaseApi {
|
|
5852
6951
|
}
|
5853
6952
|
|
5854
6953
|
declare class XataApiPlugin implements XataPlugin {
|
5855
|
-
build(options: XataPluginOptions):
|
6954
|
+
build(options: XataPluginOptions): XataApiClient;
|
5856
6955
|
}
|
5857
6956
|
|
5858
6957
|
type StringKeys<O> = Extract<keyof O, string>;
|
@@ -5888,7 +6987,228 @@ type Narrowable = string | number | bigint | boolean;
|
|
5888
6987
|
type Try<A1, A2, Catch = never> = A1 extends A2 ? A1 : Catch;
|
5889
6988
|
type Narrow<A> = Try<A, [], NarrowRaw<A>>;
|
5890
6989
|
|
5891
|
-
|
6990
|
+
interface ImageTransformations {
|
6991
|
+
/**
|
6992
|
+
* Whether to preserve animation frames from input files. Default is true.
|
6993
|
+
* Setting it to false reduces animations to still images. This setting is
|
6994
|
+
* recommended when enlarging images or processing arbitrary user content,
|
6995
|
+
* because large GIF animations can weigh tens or even hundreds of megabytes.
|
6996
|
+
* It is also useful to set anim:false when using format:"json" to get the
|
6997
|
+
* response quicker without the number of frames.
|
6998
|
+
*/
|
6999
|
+
anim?: boolean;
|
7000
|
+
/**
|
7001
|
+
* Background color to add underneath the image. Applies only to images with
|
7002
|
+
* transparency (such as PNG). Accepts any CSS color (#RRGGBB, rgba(…),
|
7003
|
+
* hsl(…), etc.)
|
7004
|
+
*/
|
7005
|
+
background?: string;
|
7006
|
+
/**
|
7007
|
+
* Radius of a blur filter (approximate gaussian). Maximum supported radius
|
7008
|
+
* is 250.
|
7009
|
+
*/
|
7010
|
+
blur?: number;
|
7011
|
+
/**
|
7012
|
+
* Increase brightness by a factor. A value of 1.0 equals no change, a value
|
7013
|
+
* of 0.5 equals half brightness, and a value of 2.0 equals twice as bright.
|
7014
|
+
* 0 is ignored.
|
7015
|
+
*/
|
7016
|
+
brightness?: number;
|
7017
|
+
/**
|
7018
|
+
* Slightly reduces latency on a cache miss by selecting a
|
7019
|
+
* quickest-to-compress file format, at a cost of increased file size and
|
7020
|
+
* lower image quality. It will usually override the format option and choose
|
7021
|
+
* JPEG over WebP or AVIF. We do not recommend using this option, except in
|
7022
|
+
* unusual circumstances like resizing uncacheable dynamically-generated
|
7023
|
+
* images.
|
7024
|
+
*/
|
7025
|
+
compression?: 'fast';
|
7026
|
+
/**
|
7027
|
+
* Increase contrast by a factor. A value of 1.0 equals no change, a value of
|
7028
|
+
* 0.5 equals low contrast, and a value of 2.0 equals high contrast. 0 is
|
7029
|
+
* ignored.
|
7030
|
+
*/
|
7031
|
+
contrast?: number;
|
7032
|
+
/**
|
7033
|
+
* Device Pixel Ratio. Default 1. Multiplier for width/height that makes it
|
7034
|
+
* easier to specify higher-DPI sizes in <img srcset>.
|
7035
|
+
*/
|
7036
|
+
dpr?: number;
|
7037
|
+
/**
|
7038
|
+
* Resizing mode as a string. It affects interpretation of width and height
|
7039
|
+
* options:
|
7040
|
+
* - scale-down: Similar to contain, but the image is never enlarged. If
|
7041
|
+
* the image is larger than given width or height, it will be resized.
|
7042
|
+
* Otherwise its original size will be kept.
|
7043
|
+
* - contain: Resizes to maximum size that fits within the given width and
|
7044
|
+
* height. If only a single dimension is given (e.g. only width), the
|
7045
|
+
* image will be shrunk or enlarged to exactly match that dimension.
|
7046
|
+
* Aspect ratio is always preserved.
|
7047
|
+
* - cover: Resizes (shrinks or enlarges) to fill the entire area of width
|
7048
|
+
* and height. If the image has an aspect ratio different from the ratio
|
7049
|
+
* of width and height, it will be cropped to fit.
|
7050
|
+
* - crop: The image will be shrunk and cropped to fit within the area
|
7051
|
+
* specified by width and height. The image will not be enlarged. For images
|
7052
|
+
* smaller than the given dimensions it's the same as scale-down. For
|
7053
|
+
* images larger than the given dimensions, it's the same as cover.
|
7054
|
+
* See also trim.
|
7055
|
+
* - pad: Resizes to the maximum size that fits within the given width and
|
7056
|
+
* height, and then fills the remaining area with a background color
|
7057
|
+
* (white by default). Use of this mode is not recommended, as the same
|
7058
|
+
* effect can be more efficiently achieved with the contain mode and the
|
7059
|
+
* CSS object-fit: contain property.
|
7060
|
+
*/
|
7061
|
+
fit?: 'scale-down' | 'contain' | 'cover' | 'crop' | 'pad';
|
7062
|
+
/**
|
7063
|
+
* Output format to generate. It can be:
|
7064
|
+
* - avif: generate images in AVIF format.
|
7065
|
+
* - webp: generate images in Google WebP format. Set quality to 100 to get
|
7066
|
+
* the WebP-lossless format.
|
7067
|
+
* - json: instead of generating an image, outputs information about the
|
7068
|
+
* image, in JSON format. The JSON object will contain image size
|
7069
|
+
* (before and after resizing), source image’s MIME type, file size, etc.
|
7070
|
+
* - jpeg: generate images in JPEG format.
|
7071
|
+
* - png: generate images in PNG format.
|
7072
|
+
*/
|
7073
|
+
format?: 'auto' | 'avif' | 'webp' | 'json' | 'jpeg' | 'png';
|
7074
|
+
/**
|
7075
|
+
* Increase exposure by a factor. A value of 1.0 equals no change, a value of
|
7076
|
+
* 0.5 darkens the image, and a value of 2.0 lightens the image. 0 is ignored.
|
7077
|
+
*/
|
7078
|
+
gamma?: number;
|
7079
|
+
/**
|
7080
|
+
* When cropping with fit: "cover", this defines the side or point that should
|
7081
|
+
* be left uncropped. The value is either a string
|
7082
|
+
* "left", "right", "top", "bottom", "auto", or "center" (the default),
|
7083
|
+
* or an object {x, y} containing focal point coordinates in the original
|
7084
|
+
* image expressed as fractions ranging from 0.0 (top or left) to 1.0
|
7085
|
+
* (bottom or right), 0.5 being the center. {fit: "cover", gravity: "top"} will
|
7086
|
+
* crop bottom or left and right sides as necessary, but won’t crop anything
|
7087
|
+
* from the top. {fit: "cover", gravity: {x:0.5, y:0.2}} will crop each side to
|
7088
|
+
* preserve as much as possible around a point at 20% of the height of the
|
7089
|
+
* source image.
|
7090
|
+
*/
|
7091
|
+
gravity?: 'left' | 'right' | 'top' | 'bottom' | 'center' | 'auto' | {
|
7092
|
+
x: number;
|
7093
|
+
y: number;
|
7094
|
+
};
|
7095
|
+
/**
|
7096
|
+
* Maximum height in image pixels. The value must be an integer.
|
7097
|
+
*/
|
7098
|
+
height?: number;
|
7099
|
+
/**
|
7100
|
+
* What EXIF data should be preserved in the output image. Note that EXIF
|
7101
|
+
* rotation and embedded color profiles are always applied ("baked in" into
|
7102
|
+
* the image), and aren't affected by this option. Note that if the Polish
|
7103
|
+
* feature is enabled, all metadata may have been removed already and this
|
7104
|
+
* option may have no effect.
|
7105
|
+
* - keep: Preserve most of EXIF metadata, including GPS location if there's
|
7106
|
+
* any.
|
7107
|
+
* - copyright: Only keep the copyright tag, and discard everything else.
|
7108
|
+
* This is the default behavior for JPEG files.
|
7109
|
+
* - none: Discard all invisible EXIF metadata. Currently WebP and PNG
|
7110
|
+
* output formats always discard metadata.
|
7111
|
+
*/
|
7112
|
+
metadata?: 'keep' | 'copyright' | 'none';
|
7113
|
+
/**
|
7114
|
+
* Quality setting from 1-100 (useful values are in 60-90 range). Lower values
|
7115
|
+
* make images look worse, but load faster. The default is 85. It applies only
|
7116
|
+
* to JPEG and WebP images. It doesn’t have any effect on PNG.
|
7117
|
+
*/
|
7118
|
+
quality?: number;
|
7119
|
+
/**
|
7120
|
+
* Number of degrees (90, 180, 270) to rotate the image by. width and height
|
7121
|
+
* options refer to axes after rotation.
|
7122
|
+
*/
|
7123
|
+
rotate?: 0 | 90 | 180 | 270 | 360;
|
7124
|
+
/**
|
7125
|
+
* Strength of sharpening filter to apply to the image. Floating-point
|
7126
|
+
* number between 0 (no sharpening, default) and 10 (maximum). 1.0 is a
|
7127
|
+
* recommended value for downscaled images.
|
7128
|
+
*/
|
7129
|
+
sharpen?: number;
|
7130
|
+
/**
|
7131
|
+
* An object with four properties {left, top, right, bottom} that specify
|
7132
|
+
* a number of pixels to cut off on each side. Allows removal of borders
|
7133
|
+
* or cutting out a specific fragment of an image. Trimming is performed
|
7134
|
+
* before resizing or rotation. Takes dpr into account.
|
7135
|
+
*/
|
7136
|
+
trim?: {
|
7137
|
+
left?: number;
|
7138
|
+
top?: number;
|
7139
|
+
right?: number;
|
7140
|
+
bottom?: number;
|
7141
|
+
};
|
7142
|
+
/**
|
7143
|
+
* Maximum width in image pixels. The value must be an integer.
|
7144
|
+
*/
|
7145
|
+
width?: number;
|
7146
|
+
}
|
7147
|
+
declare function transformImage(url: string | undefined, transformations: ImageTransformations[]): string | undefined;
|
7148
|
+
|
7149
|
+
type XataFileEditableFields = Partial<Pick<XataArrayFile, keyof InputFileEntry>>;
|
7150
|
+
declare class XataFile {
|
7151
|
+
/**
|
7152
|
+
* Name of this file.
|
7153
|
+
*/
|
7154
|
+
name?: string;
|
7155
|
+
/**
|
7156
|
+
* Media type of this file.
|
7157
|
+
*/
|
7158
|
+
mediaType: string;
|
7159
|
+
/**
|
7160
|
+
* Base64 encoded content of this file.
|
7161
|
+
*/
|
7162
|
+
base64Content?: string;
|
7163
|
+
/**
|
7164
|
+
* Whether to enable public url for this file.
|
7165
|
+
*/
|
7166
|
+
enablePublicUrl?: boolean;
|
7167
|
+
/**
|
7168
|
+
* Timeout for the signed url.
|
7169
|
+
*/
|
7170
|
+
signedUrlTimeout?: number;
|
7171
|
+
/**
|
7172
|
+
* Size of this file.
|
7173
|
+
*/
|
7174
|
+
size?: number;
|
7175
|
+
/**
|
7176
|
+
* Version of this file.
|
7177
|
+
*/
|
7178
|
+
version?: number;
|
7179
|
+
/**
|
7180
|
+
* Url of this file.
|
7181
|
+
*/
|
7182
|
+
url?: string;
|
7183
|
+
/**
|
7184
|
+
* Signed url of this file.
|
7185
|
+
*/
|
7186
|
+
signedUrl?: string;
|
7187
|
+
/**
|
7188
|
+
* Attributes of this file.
|
7189
|
+
*/
|
7190
|
+
attributes?: Record<string, unknown>;
|
7191
|
+
constructor(file: Partial<XataFile>);
|
7192
|
+
static fromBuffer(buffer: Buffer, options?: XataFileEditableFields): XataFile;
|
7193
|
+
toBuffer(): Buffer;
|
7194
|
+
static fromArrayBuffer(arrayBuffer: ArrayBuffer, options?: XataFileEditableFields): XataFile;
|
7195
|
+
toArrayBuffer(): ArrayBuffer;
|
7196
|
+
static fromUint8Array(uint8Array: Uint8Array, options?: XataFileEditableFields): XataFile;
|
7197
|
+
toUint8Array(): Uint8Array;
|
7198
|
+
static fromBlob(file: Blob, options?: XataFileEditableFields): Promise<XataFile>;
|
7199
|
+
toBlob(): Blob;
|
7200
|
+
static fromString(string: string, options?: XataFileEditableFields): XataFile;
|
7201
|
+
toString(): string;
|
7202
|
+
static fromBase64(base64Content: string, options?: XataFileEditableFields): XataFile;
|
7203
|
+
toBase64(): string;
|
7204
|
+
transform(...options: ImageTransformations[]): {
|
7205
|
+
url: string | undefined;
|
7206
|
+
signedUrl: string | undefined;
|
7207
|
+
};
|
7208
|
+
}
|
7209
|
+
type XataArrayFile = Identifiable & XataFile;
|
7210
|
+
|
7211
|
+
type SelectableColumn<O, RecursivePath extends any[] = []> = '*' | 'id' | `xata.${'version' | 'createdAt' | 'updatedAt'}` | DataProps<O> | NestedColumns<O, RecursivePath>;
|
5892
7212
|
type WildcardColumns<O> = Values<{
|
5893
7213
|
[K in SelectableColumn<O>]: K extends `${string}*` ? K : never;
|
5894
7214
|
}>;
|
@@ -5898,25 +7218,26 @@ type ColumnsByValue<O, Value> = Values<{
|
|
5898
7218
|
type SelectedPick<O extends XataRecord, Key extends SelectableColumn<O>[]> = XataRecord<O> & UnionToIntersection<Values<{
|
5899
7219
|
[K in Key[number]]: NestedValueAtColumn<O, K> & XataRecord<O>;
|
5900
7220
|
}>>;
|
5901
|
-
type ValueAtColumn<
|
7221
|
+
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> ? {
|
5902
7222
|
V: ValueAtColumn<Item, V>;
|
5903
|
-
} : never :
|
7223
|
+
} : never : Object[K] : never> : never : never;
|
5904
7224
|
type MAX_RECURSION = 2;
|
5905
7225
|
type NestedColumns<O, RecursivePath extends any[]> = RecursivePath['length'] extends MAX_RECURSION ? never : If<IsObject<O>, Values<{
|
5906
|
-
[K in DataProps<O>]: NonNullable<O[K]> extends infer Item ? If<IsArray<Item>, K,
|
5907
|
-
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
|
7226
|
+
[K in DataProps<O>]: NonNullable<O[K]> extends infer Item ? If<IsArray<Item>, Item extends (infer Type)[] ? Type extends XataArrayFile ? K | `${K}.${keyof XataFileEditableFields | '*'}` : 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 XataFileEditableFields | '*'}` : `${K}.${StringKeys<Item> | '*'}`, // This allows usage of objects that are not links
|
5908
7227
|
K>> : never;
|
5909
7228
|
}>, never>;
|
5910
7229
|
type DataProps<O> = Exclude<StringKeys<O>, StringKeys<XataRecord>>;
|
5911
7230
|
type NestedValueAtColumn<O, Key extends SelectableColumn<O>> = Key extends `${infer N}.${infer M}` ? N extends DataProps<O> ? {
|
5912
|
-
[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;
|
7231
|
+
[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;
|
5913
7232
|
} : unknown : Key extends DataProps<O> ? {
|
5914
|
-
[K in Key]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], SelectedPick<NonNullable<O[K]>, ['*']>> : O[K];
|
7233
|
+
[K in Key]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], Omit<SelectedPick<NonNullable<O[K]>, ['*']>, 'xata' | 'getMetadata'>> : O[K];
|
5915
7234
|
} : Key extends '*' ? {
|
5916
7235
|
[K in StringKeys<O>]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], Link<NonNullable<O[K]>>> : O[K];
|
5917
7236
|
} : unknown;
|
5918
7237
|
type ForwardNullable<T, R> = T extends NonNullable<T> ? R : R | null;
|
5919
7238
|
|
7239
|
+
declare const RecordColumnTypes: readonly ["bool", "int", "float", "string", "text", "email", "multiple", "link", "object", "datetime", "vector", "file[]", "file"];
|
7240
|
+
type Identifier = string;
|
5920
7241
|
/**
|
5921
7242
|
* Represents an identifiable record from the database.
|
5922
7243
|
*/
|
@@ -5924,7 +7245,7 @@ interface Identifiable {
|
|
5924
7245
|
/**
|
5925
7246
|
* Unique id of this record.
|
5926
7247
|
*/
|
5927
|
-
id:
|
7248
|
+
id: Identifier;
|
5928
7249
|
}
|
5929
7250
|
interface BaseData {
|
5930
7251
|
[key: string]: any;
|
@@ -5933,8 +7254,13 @@ interface BaseData {
|
|
5933
7254
|
* Represents a persisted record from the database.
|
5934
7255
|
*/
|
5935
7256
|
interface XataRecord<OriginalRecord extends XataRecord<any> = XataRecord<any>> extends Identifiable {
|
7257
|
+
/**
|
7258
|
+
* Metadata of this record.
|
7259
|
+
*/
|
7260
|
+
xata: XataRecordMetadata;
|
5936
7261
|
/**
|
5937
7262
|
* Get metadata of this record.
|
7263
|
+
* @deprecated Use `xata` property instead.
|
5938
7264
|
*/
|
5939
7265
|
getMetadata(): XataRecordMetadata;
|
5940
7266
|
/**
|
@@ -6013,23 +7339,60 @@ type XataRecordMetadata = {
|
|
6013
7339
|
* Number that is increased every time the record is updated.
|
6014
7340
|
*/
|
6015
7341
|
version: number;
|
6016
|
-
|
7342
|
+
/**
|
7343
|
+
* Timestamp when the record was created.
|
7344
|
+
*/
|
7345
|
+
createdAt: Date;
|
7346
|
+
/**
|
7347
|
+
* Timestamp when the record was last updated.
|
7348
|
+
*/
|
7349
|
+
updatedAt: Date;
|
6017
7350
|
};
|
6018
7351
|
declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
|
6019
7352
|
declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;
|
7353
|
+
type NumericOperator = ExclusiveOr<{
|
7354
|
+
$increment?: number;
|
7355
|
+
}, ExclusiveOr<{
|
7356
|
+
$decrement?: number;
|
7357
|
+
}, ExclusiveOr<{
|
7358
|
+
$multiply?: number;
|
7359
|
+
}, {
|
7360
|
+
$divide?: number;
|
7361
|
+
}>>>;
|
7362
|
+
type InputXataFile = Partial<XataArrayFile> | Promise<Partial<XataArrayFile>>;
|
6020
7363
|
type EditableDataFields<T> = T extends XataRecord ? {
|
6021
|
-
id:
|
6022
|
-
} |
|
6023
|
-
id:
|
6024
|
-
} |
|
7364
|
+
id: Identifier;
|
7365
|
+
} | Identifier : NonNullable<T> extends XataRecord ? {
|
7366
|
+
id: Identifier;
|
7367
|
+
} | 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;
|
6025
7368
|
type EditableData<O extends XataRecord> = Identifiable & Partial<Omit<{
|
6026
7369
|
[K in keyof O]: EditableDataFields<O[K]>;
|
6027
7370
|
}, keyof XataRecord>>;
|
6028
7371
|
type JSONDataFields<T> = T extends XataRecord ? string : NonNullable<T> extends XataRecord ? string | null | undefined : T extends Date ? string : NonNullable<T> extends Date ? string | null | undefined : T;
|
6029
|
-
type
|
7372
|
+
type JSONDataBase = Identifiable & {
|
7373
|
+
/**
|
7374
|
+
* Metadata about the record.
|
7375
|
+
*/
|
7376
|
+
xata: {
|
7377
|
+
/**
|
7378
|
+
* Timestamp when the record was created.
|
7379
|
+
*/
|
7380
|
+
createdAt: string;
|
7381
|
+
/**
|
7382
|
+
* Timestamp when the record was last updated.
|
7383
|
+
*/
|
7384
|
+
updatedAt: string;
|
7385
|
+
/**
|
7386
|
+
* Number that is increased every time the record is updated.
|
7387
|
+
*/
|
7388
|
+
version: number;
|
7389
|
+
};
|
7390
|
+
};
|
7391
|
+
type JSONData<O> = JSONDataBase & Partial<Omit<{
|
6030
7392
|
[K in keyof O]: JSONDataFields<O[K]>;
|
6031
7393
|
}, keyof XataRecord>>;
|
6032
7394
|
|
7395
|
+
type FilterColumns<T> = ColumnsByValue<T, any> | `xata.${keyof XataRecordMetadata}`;
|
6033
7396
|
/**
|
6034
7397
|
* PropertyMatchFilter
|
6035
7398
|
* Example:
|
@@ -6049,7 +7412,7 @@ type JSONData<O> = Identifiable & Partial<Omit<{
|
|
6049
7412
|
}
|
6050
7413
|
*/
|
6051
7414
|
type PropertyAccessFilter<Record> = {
|
6052
|
-
[key in
|
7415
|
+
[key in FilterColumns<Record>]?: NestedApiFilter<ValueAtColumn<Record, key>> | PropertyFilter<ValueAtColumn<Record, key>>;
|
6053
7416
|
};
|
6054
7417
|
type PropertyFilter<T> = T | {
|
6055
7418
|
$is: T;
|
@@ -6111,7 +7474,7 @@ type AggregatorFilter<T> = {
|
|
6111
7474
|
* Example: { filter: { $exists: "settings" } }
|
6112
7475
|
*/
|
6113
7476
|
type ExistanceFilter<Record> = {
|
6114
|
-
[key in '$exists' | '$notExists']?:
|
7477
|
+
[key in '$exists' | '$notExists']?: FilterColumns<Record>;
|
6115
7478
|
};
|
6116
7479
|
type BaseApiFilter<Record> = PropertyAccessFilter<Record> | AggregatorFilter<Record> | ExistanceFilter<Record>;
|
6117
7480
|
/**
|
@@ -6128,6 +7491,12 @@ type DateBooster = {
|
|
6128
7491
|
origin?: string;
|
6129
7492
|
scale: string;
|
6130
7493
|
decay: number;
|
7494
|
+
/**
|
7495
|
+
* The factor with which to multiply the added boost.
|
7496
|
+
*
|
7497
|
+
* @minimum 0
|
7498
|
+
*/
|
7499
|
+
factor?: number;
|
6131
7500
|
};
|
6132
7501
|
type NumericBooster = {
|
6133
7502
|
factor: number;
|
@@ -6244,7 +7613,7 @@ declare class SearchPlugin<Schemas extends Record<string, XataRecord>> extends X
|
|
6244
7613
|
#private;
|
6245
7614
|
private db;
|
6246
7615
|
constructor(db: SchemaPluginResult<Schemas>, schemaTables?: Table[]);
|
6247
|
-
build(
|
7616
|
+
build(pluginOptions: XataPluginOptions): SearchPluginResult<Schemas>;
|
6248
7617
|
}
|
6249
7618
|
type SearchXataRecord<Record extends XataRecord> = Omit<Record, 'getMetadata'> & {
|
6250
7619
|
getMetadata: () => XataRecordMetadata & SearchExtraProperties;
|
@@ -6434,13 +7803,57 @@ type ComplexAggregationResult = {
|
|
6434
7803
|
}>;
|
6435
7804
|
};
|
6436
7805
|
|
7806
|
+
type KeywordAskOptions<Record extends XataRecord> = {
|
7807
|
+
searchType?: 'keyword';
|
7808
|
+
search?: {
|
7809
|
+
fuzziness?: FuzzinessExpression;
|
7810
|
+
target?: TargetColumn<Record>[];
|
7811
|
+
prefix?: PrefixExpression;
|
7812
|
+
filter?: Filter<Record>;
|
7813
|
+
boosters?: Boosters<Record>[];
|
7814
|
+
};
|
7815
|
+
};
|
7816
|
+
type VectorAskOptions<Record extends XataRecord> = {
|
7817
|
+
searchType?: 'vector';
|
7818
|
+
vectorSearch?: {
|
7819
|
+
/**
|
7820
|
+
* The column to use for vector search. It must be of type `vector`.
|
7821
|
+
*/
|
7822
|
+
column: string;
|
7823
|
+
/**
|
7824
|
+
* The column containing the text for vector search. Must be of type `text`.
|
7825
|
+
*/
|
7826
|
+
contentColumn: string;
|
7827
|
+
filter?: Filter<Record>;
|
7828
|
+
};
|
7829
|
+
};
|
7830
|
+
type TypeAskOptions<Record extends XataRecord> = KeywordAskOptions<Record> | VectorAskOptions<Record>;
|
7831
|
+
type BaseAskOptions = {
|
7832
|
+
rules?: string[];
|
7833
|
+
sessionId?: string;
|
7834
|
+
};
|
7835
|
+
type AskOptions<Record extends XataRecord> = TypeAskOptions<Record> & BaseAskOptions;
|
7836
|
+
type AskResult = {
|
7837
|
+
answer?: string;
|
7838
|
+
records?: string[];
|
7839
|
+
sessionId?: string;
|
7840
|
+
};
|
7841
|
+
|
6437
7842
|
type SortDirection = 'asc' | 'desc';
|
6438
|
-
type
|
7843
|
+
type RandomFilter = {
|
7844
|
+
'*': 'random';
|
7845
|
+
};
|
7846
|
+
type RandomFilterExtended = {
|
7847
|
+
column: '*';
|
7848
|
+
direction: 'random';
|
7849
|
+
};
|
7850
|
+
type SortColumns<T extends XataRecord> = ColumnsByValue<T, any> | `xata.${keyof XataRecordMetadata}`;
|
7851
|
+
type SortFilterExtended<T extends XataRecord, Columns extends string = SortColumns<T>> = RandomFilterExtended | {
|
6439
7852
|
column: Columns;
|
6440
7853
|
direction?: SortDirection;
|
6441
7854
|
};
|
6442
|
-
type SortFilter<T extends XataRecord, Columns extends string =
|
6443
|
-
type SortFilterBase<T extends XataRecord, Columns extends string =
|
7855
|
+
type SortFilter<T extends XataRecord, Columns extends string = SortColumns<T>> = Columns | SortFilterExtended<T, Columns> | SortFilterBase<T, Columns> | RandomFilter;
|
7856
|
+
type SortFilterBase<T extends XataRecord, Columns extends string = SortColumns<T>> = Values<{
|
6444
7857
|
[Key in Columns]: {
|
6445
7858
|
[K in Key]: SortDirection;
|
6446
7859
|
};
|
@@ -6571,7 +7984,9 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
6571
7984
|
* @param direction The direction. Either ascending or descending.
|
6572
7985
|
* @returns A new Query object.
|
6573
7986
|
*/
|
6574
|
-
sort<F extends ColumnsByValue<Record, any>>(column: F, direction
|
7987
|
+
sort<F extends ColumnsByValue<Record, any>>(column: F, direction: SortDirection): Query<Record, Result>;
|
7988
|
+
sort(column: '*', direction: 'random'): Query<Record, Result>;
|
7989
|
+
sort<F extends ColumnsByValue<Record, any>>(column: F): Query<Record, Result>;
|
6575
7990
|
/**
|
6576
7991
|
* Builds a new query specifying the set of columns to be returned in the query response.
|
6577
7992
|
* @param columns Array of column names to be returned by the query.
|
@@ -6597,7 +8012,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
6597
8012
|
* @param options Pagination options
|
6598
8013
|
* @returns A page of results
|
6599
8014
|
*/
|
6600
|
-
getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, typeof options['columns']>>>;
|
8015
|
+
getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, (typeof options)['columns']>>>;
|
6601
8016
|
/**
|
6602
8017
|
* Get results in an iterator
|
6603
8018
|
*
|
@@ -6628,7 +8043,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
6628
8043
|
*/
|
6629
8044
|
getIterator<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
|
6630
8045
|
batchSize?: number;
|
6631
|
-
}>(options: Options): AsyncGenerator<SelectedPick<Record, typeof options['columns']>[]>;
|
8046
|
+
}>(options: Options): AsyncGenerator<SelectedPick<Record, (typeof options)['columns']>[]>;
|
6632
8047
|
/**
|
6633
8048
|
* Performs the query in the database and returns a set of results.
|
6634
8049
|
* @returns An array of records from the database.
|
@@ -6639,7 +8054,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
6639
8054
|
* @param options Additional options to be used when performing the query.
|
6640
8055
|
* @returns An array of records from the database.
|
6641
8056
|
*/
|
6642
|
-
getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<RecordArray<SelectedPick<Record, typeof options['columns']>>>;
|
8057
|
+
getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<RecordArray<SelectedPick<Record, (typeof options)['columns']>>>;
|
6643
8058
|
/**
|
6644
8059
|
* Performs the query in the database and returns a set of results.
|
6645
8060
|
* @param options Additional options to be used when performing the query.
|
@@ -6660,7 +8075,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
6660
8075
|
*/
|
6661
8076
|
getAll<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
|
6662
8077
|
batchSize?: number;
|
6663
|
-
}>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
|
8078
|
+
}>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']>[]>;
|
6664
8079
|
/**
|
6665
8080
|
* Performs the query in the database and returns all the results.
|
6666
8081
|
* Warning: If there are a large number of results, this method can have performance implications.
|
@@ -6680,7 +8095,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
6680
8095
|
* @param options Additional options to be used when performing the query.
|
6681
8096
|
* @returns The first record that matches the query, or null if no record matched the query.
|
6682
8097
|
*/
|
6683
|
-
getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']> | null>;
|
8098
|
+
getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']> | null>;
|
6684
8099
|
/**
|
6685
8100
|
* Performs the query in the database and returns the first result.
|
6686
8101
|
* @param options Additional options to be used when performing the query.
|
@@ -6699,7 +8114,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
6699
8114
|
* @returns The first record that matches the query, or null if no record matched the query.
|
6700
8115
|
* @throws if there are no results.
|
6701
8116
|
*/
|
6702
|
-
getFirstOrThrow<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>>;
|
8117
|
+
getFirstOrThrow<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']>>;
|
6703
8118
|
/**
|
6704
8119
|
* Performs the query in the database and returns the first result.
|
6705
8120
|
* @param options Additional options to be used when performing the query.
|
@@ -6748,6 +8163,7 @@ type PaginationQueryMeta = {
|
|
6748
8163
|
page: {
|
6749
8164
|
cursor: string;
|
6750
8165
|
more: boolean;
|
8166
|
+
size: number;
|
6751
8167
|
};
|
6752
8168
|
};
|
6753
8169
|
interface Paginable<Record extends XataRecord, Result extends XataRecord = Record> {
|
@@ -6880,7 +8296,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
6880
8296
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
6881
8297
|
* @returns The full persisted record.
|
6882
8298
|
*/
|
6883
|
-
abstract create<K extends SelectableColumn<Record>>(id:
|
8299
|
+
abstract create<K extends SelectableColumn<Record>>(id: Identifier, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
|
6884
8300
|
ifVersion?: number;
|
6885
8301
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
6886
8302
|
/**
|
@@ -6889,7 +8305,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
6889
8305
|
* @param object Object containing the column names with their values to be stored in the table.
|
6890
8306
|
* @returns The full persisted record.
|
6891
8307
|
*/
|
6892
|
-
abstract create(id:
|
8308
|
+
abstract create(id: Identifier, object: Omit<EditableData<Record>, 'id'>, options?: {
|
6893
8309
|
ifVersion?: number;
|
6894
8310
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
6895
8311
|
/**
|
@@ -6911,26 +8327,26 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
6911
8327
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
6912
8328
|
* @returns The persisted record for the given id or null if the record could not be found.
|
6913
8329
|
*/
|
6914
|
-
abstract read<K extends SelectableColumn<Record>>(id:
|
8330
|
+
abstract read<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
|
6915
8331
|
/**
|
6916
8332
|
* Queries a single record from the table given its unique id.
|
6917
8333
|
* @param id The unique id.
|
6918
8334
|
* @returns The persisted record for the given id or null if the record could not be found.
|
6919
8335
|
*/
|
6920
|
-
abstract read(id:
|
8336
|
+
abstract read(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
|
6921
8337
|
/**
|
6922
8338
|
* Queries multiple records from the table given their unique id.
|
6923
8339
|
* @param ids The unique ids array.
|
6924
8340
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
6925
8341
|
* @returns The persisted records for the given ids in order (if a record could not be found null is returned).
|
6926
8342
|
*/
|
6927
|
-
abstract read<K extends SelectableColumn<Record>>(ids:
|
8343
|
+
abstract read<K extends SelectableColumn<Record>>(ids: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
6928
8344
|
/**
|
6929
8345
|
* Queries multiple records from the table given their unique id.
|
6930
8346
|
* @param ids The unique ids array.
|
6931
8347
|
* @returns The persisted records for the given ids in order (if a record could not be found null is returned).
|
6932
8348
|
*/
|
6933
|
-
abstract read(ids:
|
8349
|
+
abstract read(ids: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
6934
8350
|
/**
|
6935
8351
|
* Queries a single record from the table by the id in the object.
|
6936
8352
|
* @param object Object containing the id of the record.
|
@@ -6964,14 +8380,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
6964
8380
|
* @returns The persisted record for the given id.
|
6965
8381
|
* @throws If the record could not be found.
|
6966
8382
|
*/
|
6967
|
-
abstract readOrThrow<K extends SelectableColumn<Record>>(id:
|
8383
|
+
abstract readOrThrow<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
6968
8384
|
/**
|
6969
8385
|
* Queries a single record from the table given its unique id.
|
6970
8386
|
* @param id The unique id.
|
6971
8387
|
* @returns The persisted record for the given id.
|
6972
8388
|
* @throws If the record could not be found.
|
6973
8389
|
*/
|
6974
|
-
abstract readOrThrow(id:
|
8390
|
+
abstract readOrThrow(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
6975
8391
|
/**
|
6976
8392
|
* Queries multiple records from the table given their unique id.
|
6977
8393
|
* @param ids The unique ids array.
|
@@ -6979,14 +8395,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
6979
8395
|
* @returns The persisted records for the given ids in order.
|
6980
8396
|
* @throws If one or more records could not be found.
|
6981
8397
|
*/
|
6982
|
-
abstract readOrThrow<K extends SelectableColumn<Record>>(ids:
|
8398
|
+
abstract readOrThrow<K extends SelectableColumn<Record>>(ids: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
6983
8399
|
/**
|
6984
8400
|
* Queries multiple records from the table given their unique id.
|
6985
8401
|
* @param ids The unique ids array.
|
6986
8402
|
* @returns The persisted records for the given ids in order.
|
6987
8403
|
* @throws If one or more records could not be found.
|
6988
8404
|
*/
|
6989
|
-
abstract readOrThrow(ids:
|
8405
|
+
abstract readOrThrow(ids: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
6990
8406
|
/**
|
6991
8407
|
* Queries a single record from the table by the id in the object.
|
6992
8408
|
* @param object Object containing the id of the record.
|
@@ -7041,7 +8457,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
7041
8457
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
7042
8458
|
* @returns The full persisted record, null if the record could not be found.
|
7043
8459
|
*/
|
7044
|
-
abstract update<K extends SelectableColumn<Record>>(id:
|
8460
|
+
abstract update<K extends SelectableColumn<Record>>(id: Identifier, object: Partial<EditableData<Record>>, columns: K[], options?: {
|
7045
8461
|
ifVersion?: number;
|
7046
8462
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
|
7047
8463
|
/**
|
@@ -7050,7 +8466,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
7050
8466
|
* @param object The column names and their values that have to be updated.
|
7051
8467
|
* @returns The full persisted record, null if the record could not be found.
|
7052
8468
|
*/
|
7053
|
-
abstract update(id:
|
8469
|
+
abstract update(id: Identifier, object: Partial<EditableData<Record>>, options?: {
|
7054
8470
|
ifVersion?: number;
|
7055
8471
|
}): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
|
7056
8472
|
/**
|
@@ -7093,7 +8509,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
7093
8509
|
* @returns The full persisted record.
|
7094
8510
|
* @throws If the record could not be found.
|
7095
8511
|
*/
|
7096
|
-
abstract updateOrThrow<K extends SelectableColumn<Record>>(id:
|
8512
|
+
abstract updateOrThrow<K extends SelectableColumn<Record>>(id: Identifier, object: Partial<EditableData<Record>>, columns: K[], options?: {
|
7097
8513
|
ifVersion?: number;
|
7098
8514
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
7099
8515
|
/**
|
@@ -7103,7 +8519,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
7103
8519
|
* @returns The full persisted record.
|
7104
8520
|
* @throws If the record could not be found.
|
7105
8521
|
*/
|
7106
|
-
abstract updateOrThrow(id:
|
8522
|
+
abstract updateOrThrow(id: Identifier, object: Partial<EditableData<Record>>, options?: {
|
7107
8523
|
ifVersion?: number;
|
7108
8524
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
7109
8525
|
/**
|
@@ -7128,7 +8544,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
7128
8544
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
7129
8545
|
* @returns The full persisted record.
|
7130
8546
|
*/
|
7131
|
-
abstract createOrUpdate<K extends SelectableColumn<Record>>(object: EditableData<Record> & Identifiable
|
8547
|
+
abstract createOrUpdate<K extends SelectableColumn<Record>>(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, columns: K[], options?: {
|
7132
8548
|
ifVersion?: number;
|
7133
8549
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
7134
8550
|
/**
|
@@ -7137,7 +8553,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
7137
8553
|
* @param object Object containing the column names with their values to be persisted in the table.
|
7138
8554
|
* @returns The full persisted record.
|
7139
8555
|
*/
|
7140
|
-
abstract createOrUpdate(object: EditableData<Record> & Identifiable
|
8556
|
+
abstract createOrUpdate(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, options?: {
|
7141
8557
|
ifVersion?: number;
|
7142
8558
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
7143
8559
|
/**
|
@@ -7148,7 +8564,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
7148
8564
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
7149
8565
|
* @returns The full persisted record.
|
7150
8566
|
*/
|
7151
|
-
abstract createOrUpdate<K extends SelectableColumn<Record>>(id:
|
8567
|
+
abstract createOrUpdate<K extends SelectableColumn<Record>>(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
|
7152
8568
|
ifVersion?: number;
|
7153
8569
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
7154
8570
|
/**
|
@@ -7158,7 +8574,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
7158
8574
|
* @param object The column names and the values to be persisted.
|
7159
8575
|
* @returns The full persisted record.
|
7160
8576
|
*/
|
7161
|
-
abstract createOrUpdate(id:
|
8577
|
+
abstract createOrUpdate(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, options?: {
|
7162
8578
|
ifVersion?: number;
|
7163
8579
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
7164
8580
|
/**
|
@@ -7168,14 +8584,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
7168
8584
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
7169
8585
|
* @returns Array of the persisted records.
|
7170
8586
|
*/
|
7171
|
-
abstract createOrUpdate<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Identifiable
|
8587
|
+
abstract createOrUpdate<K extends SelectableColumn<Record>>(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
7172
8588
|
/**
|
7173
8589
|
* Creates or updates a single record. If a record exists with the given id,
|
7174
8590
|
* it will be partially updated, otherwise a new record will be created.
|
7175
8591
|
* @param objects Array of objects with the column names and the values to be stored in the table.
|
7176
8592
|
* @returns Array of the persisted records.
|
7177
8593
|
*/
|
7178
|
-
abstract createOrUpdate(objects: Array<EditableData<Record> & Identifiable
|
8594
|
+
abstract createOrUpdate(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
7179
8595
|
/**
|
7180
8596
|
* Creates or replaces a single record. If a record exists with the given id,
|
7181
8597
|
* it will be replaced, otherwise a new record will be created.
|
@@ -7183,7 +8599,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
7183
8599
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
7184
8600
|
* @returns The full persisted record.
|
7185
8601
|
*/
|
7186
|
-
abstract createOrReplace<K extends SelectableColumn<Record>>(object: EditableData<Record> & Identifiable
|
8602
|
+
abstract createOrReplace<K extends SelectableColumn<Record>>(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, columns: K[], options?: {
|
7187
8603
|
ifVersion?: number;
|
7188
8604
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
7189
8605
|
/**
|
@@ -7192,7 +8608,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
7192
8608
|
* @param object Object containing the column names with their values to be persisted in the table.
|
7193
8609
|
* @returns The full persisted record.
|
7194
8610
|
*/
|
7195
|
-
abstract createOrReplace(object: EditableData<Record> & Identifiable
|
8611
|
+
abstract createOrReplace(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, options?: {
|
7196
8612
|
ifVersion?: number;
|
7197
8613
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
7198
8614
|
/**
|
@@ -7203,7 +8619,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
7203
8619
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
7204
8620
|
* @returns The full persisted record.
|
7205
8621
|
*/
|
7206
|
-
abstract createOrReplace<K extends SelectableColumn<Record>>(id:
|
8622
|
+
abstract createOrReplace<K extends SelectableColumn<Record>>(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
|
7207
8623
|
ifVersion?: number;
|
7208
8624
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
7209
8625
|
/**
|
@@ -7213,7 +8629,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
7213
8629
|
* @param object The column names and the values to be persisted.
|
7214
8630
|
* @returns The full persisted record.
|
7215
8631
|
*/
|
7216
|
-
abstract createOrReplace(id:
|
8632
|
+
abstract createOrReplace(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, options?: {
|
7217
8633
|
ifVersion?: number;
|
7218
8634
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
7219
8635
|
/**
|
@@ -7223,14 +8639,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
7223
8639
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
7224
8640
|
* @returns Array of the persisted records.
|
7225
8641
|
*/
|
7226
|
-
abstract createOrReplace<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Identifiable
|
8642
|
+
abstract createOrReplace<K extends SelectableColumn<Record>>(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
7227
8643
|
/**
|
7228
8644
|
* Creates or replaces a single record. If a record exists with the given id,
|
7229
8645
|
* it will be replaced, otherwise a new record will be created.
|
7230
8646
|
* @param objects Array of objects with the column names and the values to be stored in the table.
|
7231
8647
|
* @returns Array of the persisted records.
|
7232
8648
|
*/
|
7233
|
-
abstract createOrReplace(objects: Array<EditableData<Record> & Identifiable
|
8649
|
+
abstract createOrReplace(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
7234
8650
|
/**
|
7235
8651
|
* Deletes a record given its unique id.
|
7236
8652
|
* @param object An object with a unique id.
|
@@ -7250,13 +8666,13 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
7250
8666
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
7251
8667
|
* @returns The deleted record, null if the record could not be found.
|
7252
8668
|
*/
|
7253
|
-
abstract delete<K extends SelectableColumn<Record>>(id:
|
8669
|
+
abstract delete<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
|
7254
8670
|
/**
|
7255
8671
|
* Deletes a record given a unique id.
|
7256
8672
|
* @param id The unique id.
|
7257
8673
|
* @returns The deleted record, null if the record could not be found.
|
7258
8674
|
*/
|
7259
|
-
abstract delete(id:
|
8675
|
+
abstract delete(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
|
7260
8676
|
/**
|
7261
8677
|
* Deletes multiple records given an array of objects with ids.
|
7262
8678
|
* @param objects An array of objects with unique ids.
|
@@ -7276,13 +8692,13 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
7276
8692
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
7277
8693
|
* @returns Array of the deleted records in order (if a record could not be found null is returned).
|
7278
8694
|
*/
|
7279
|
-
abstract delete<K extends SelectableColumn<Record>>(objects:
|
8695
|
+
abstract delete<K extends SelectableColumn<Record>>(objects: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
7280
8696
|
/**
|
7281
8697
|
* Deletes multiple records given an array of unique ids.
|
7282
8698
|
* @param objects An array of ids.
|
7283
8699
|
* @returns Array of the deleted records in order (if a record could not be found null is returned).
|
7284
8700
|
*/
|
7285
|
-
abstract delete(objects:
|
8701
|
+
abstract delete(objects: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
7286
8702
|
/**
|
7287
8703
|
* Deletes a record given its unique id.
|
7288
8704
|
* @param object An object with a unique id.
|
@@ -7305,14 +8721,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
7305
8721
|
* @returns The deleted record, null if the record could not be found.
|
7306
8722
|
* @throws If the record could not be found.
|
7307
8723
|
*/
|
7308
|
-
abstract deleteOrThrow<K extends SelectableColumn<Record>>(id:
|
8724
|
+
abstract deleteOrThrow<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
7309
8725
|
/**
|
7310
8726
|
* Deletes a record given a unique id.
|
7311
8727
|
* @param id The unique id.
|
7312
8728
|
* @returns The deleted record, null if the record could not be found.
|
7313
8729
|
* @throws If the record could not be found.
|
7314
8730
|
*/
|
7315
|
-
abstract deleteOrThrow(id:
|
8731
|
+
abstract deleteOrThrow(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
7316
8732
|
/**
|
7317
8733
|
* Deletes multiple records given an array of objects with ids.
|
7318
8734
|
* @param objects An array of objects with unique ids.
|
@@ -7335,14 +8751,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
7335
8751
|
* @returns Array of the deleted records in order (if a record could not be found null is returned).
|
7336
8752
|
* @throws If one or more records could not be found.
|
7337
8753
|
*/
|
7338
|
-
abstract deleteOrThrow<K extends SelectableColumn<Record>>(objects:
|
8754
|
+
abstract deleteOrThrow<K extends SelectableColumn<Record>>(objects: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
7339
8755
|
/**
|
7340
8756
|
* Deletes multiple records given an array of unique ids.
|
7341
8757
|
* @param objects An array of ids.
|
7342
8758
|
* @returns Array of the deleted records in order.
|
7343
8759
|
* @throws If one or more records could not be found.
|
7344
8760
|
*/
|
7345
|
-
abstract deleteOrThrow(objects:
|
8761
|
+
abstract deleteOrThrow(objects: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
7346
8762
|
/**
|
7347
8763
|
* Search for records in the table.
|
7348
8764
|
* @param query The query to search for.
|
@@ -7389,6 +8805,20 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
7389
8805
|
* @returns The requested aggregations.
|
7390
8806
|
*/
|
7391
8807
|
abstract aggregate<Expression extends Dictionary<AggregationExpression<Record>>>(expression?: Expression, filter?: Filter<Record>): Promise<AggregationResult<Record, Expression>>;
|
8808
|
+
/**
|
8809
|
+
* Experimental: Ask the database to perform a natural language question.
|
8810
|
+
*/
|
8811
|
+
abstract ask(question: string, options?: AskOptions<Record>): Promise<AskResult>;
|
8812
|
+
/**
|
8813
|
+
* Experimental: Ask the database to perform a natural language question.
|
8814
|
+
*/
|
8815
|
+
abstract ask(question: string, options: AskOptions<Record>): Promise<AskResult>;
|
8816
|
+
/**
|
8817
|
+
* Experimental: Ask the database to perform a natural language question.
|
8818
|
+
*/
|
8819
|
+
abstract ask(question: string, options: AskOptions<Record> & {
|
8820
|
+
onMessage: (message: AskResult) => void;
|
8821
|
+
}): void;
|
7392
8822
|
abstract query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
|
7393
8823
|
}
|
7394
8824
|
declare class RestRepository<Record extends XataRecord> extends Query<Record, SelectedPick<Record, ['*']>> implements Repository<Record> {
|
@@ -7405,26 +8835,26 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
|
|
7405
8835
|
create(object: EditableData<Record> & Partial<Identifiable>, options?: {
|
7406
8836
|
ifVersion?: number;
|
7407
8837
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
7408
|
-
create<K extends SelectableColumn<Record>>(id:
|
8838
|
+
create<K extends SelectableColumn<Record>>(id: Identifier, object: EditableData<Record>, columns: K[], options?: {
|
7409
8839
|
ifVersion?: number;
|
7410
8840
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
7411
|
-
create(id:
|
8841
|
+
create(id: Identifier, object: EditableData<Record>, options?: {
|
7412
8842
|
ifVersion?: number;
|
7413
8843
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
7414
8844
|
create<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
7415
8845
|
create(objects: Array<EditableData<Record> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
7416
|
-
read<K extends SelectableColumn<Record>>(id:
|
8846
|
+
read<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
|
7417
8847
|
read(id: string): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
|
7418
|
-
read<K extends SelectableColumn<Record>>(ids:
|
7419
|
-
read(ids:
|
8848
|
+
read<K extends SelectableColumn<Record>>(ids: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
8849
|
+
read(ids: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
7420
8850
|
read<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
|
7421
8851
|
read(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
|
7422
8852
|
read<K extends SelectableColumn<Record>>(objects: Identifiable[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
7423
8853
|
read(objects: Identifiable[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
7424
|
-
readOrThrow<K extends SelectableColumn<Record>>(id:
|
7425
|
-
readOrThrow(id:
|
7426
|
-
readOrThrow<K extends SelectableColumn<Record>>(ids:
|
7427
|
-
readOrThrow(ids:
|
8854
|
+
readOrThrow<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
8855
|
+
readOrThrow(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
8856
|
+
readOrThrow<K extends SelectableColumn<Record>>(ids: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
8857
|
+
readOrThrow(ids: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
7428
8858
|
readOrThrow<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
7429
8859
|
readOrThrow(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
7430
8860
|
readOrThrow<K extends SelectableColumn<Record>>(objects: Identifiable[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
@@ -7435,10 +8865,10 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
|
|
7435
8865
|
update(object: Partial<EditableData<Record>> & Identifiable, options?: {
|
7436
8866
|
ifVersion?: number;
|
7437
8867
|
}): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
|
7438
|
-
update<K extends SelectableColumn<Record>>(id:
|
8868
|
+
update<K extends SelectableColumn<Record>>(id: Identifier, object: Partial<EditableData<Record>>, columns: K[], options?: {
|
7439
8869
|
ifVersion?: number;
|
7440
8870
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
|
7441
|
-
update(id:
|
8871
|
+
update(id: Identifier, object: Partial<EditableData<Record>>, options?: {
|
7442
8872
|
ifVersion?: number;
|
7443
8873
|
}): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
|
7444
8874
|
update<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
@@ -7449,58 +8879,58 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
|
|
7449
8879
|
updateOrThrow(object: Partial<EditableData<Record>> & Identifiable, options?: {
|
7450
8880
|
ifVersion?: number;
|
7451
8881
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
7452
|
-
updateOrThrow<K extends SelectableColumn<Record>>(id:
|
8882
|
+
updateOrThrow<K extends SelectableColumn<Record>>(id: Identifier, object: Partial<EditableData<Record>>, columns: K[], options?: {
|
7453
8883
|
ifVersion?: number;
|
7454
8884
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
7455
|
-
updateOrThrow(id:
|
8885
|
+
updateOrThrow(id: Identifier, object: Partial<EditableData<Record>>, options?: {
|
7456
8886
|
ifVersion?: number;
|
7457
8887
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
7458
8888
|
updateOrThrow<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
7459
8889
|
updateOrThrow(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
7460
|
-
createOrUpdate<K extends SelectableColumn<Record>>(object: EditableData<Record> & Identifiable
|
8890
|
+
createOrUpdate<K extends SelectableColumn<Record>>(object: EditableData<Record> & Partial<Identifiable>, columns: K[], options?: {
|
7461
8891
|
ifVersion?: number;
|
7462
8892
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
7463
|
-
createOrUpdate(object: EditableData<Record> & Identifiable
|
8893
|
+
createOrUpdate(object: EditableData<Record> & Partial<Identifiable>, options?: {
|
7464
8894
|
ifVersion?: number;
|
7465
8895
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
7466
|
-
createOrUpdate<K extends SelectableColumn<Record>>(id:
|
8896
|
+
createOrUpdate<K extends SelectableColumn<Record>>(id: Identifier, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
|
7467
8897
|
ifVersion?: number;
|
7468
8898
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
7469
|
-
createOrUpdate(id:
|
8899
|
+
createOrUpdate(id: Identifier, object: Omit<EditableData<Record>, 'id'>, options?: {
|
7470
8900
|
ifVersion?: number;
|
7471
8901
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
7472
|
-
createOrUpdate<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Identifiable
|
7473
|
-
createOrUpdate(objects: Array<EditableData<Record> & Identifiable
|
7474
|
-
createOrReplace<K extends SelectableColumn<Record>>(object: EditableData<Record> & Identifiable
|
8902
|
+
createOrUpdate<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
8903
|
+
createOrUpdate(objects: Array<EditableData<Record> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
8904
|
+
createOrReplace<K extends SelectableColumn<Record>>(object: EditableData<Record> & Partial<Identifiable>, columns: K[], options?: {
|
7475
8905
|
ifVersion?: number;
|
7476
8906
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
7477
|
-
createOrReplace(object: EditableData<Record> & Identifiable
|
8907
|
+
createOrReplace(object: EditableData<Record> & Partial<Identifiable>, options?: {
|
7478
8908
|
ifVersion?: number;
|
7479
8909
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
7480
|
-
createOrReplace<K extends SelectableColumn<Record>>(id:
|
8910
|
+
createOrReplace<K extends SelectableColumn<Record>>(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
|
7481
8911
|
ifVersion?: number;
|
7482
8912
|
}): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
7483
|
-
createOrReplace(id:
|
8913
|
+
createOrReplace(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, options?: {
|
7484
8914
|
ifVersion?: number;
|
7485
8915
|
}): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
7486
|
-
createOrReplace<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Identifiable
|
7487
|
-
createOrReplace(objects: Array<EditableData<Record> & Identifiable
|
8916
|
+
createOrReplace<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
8917
|
+
createOrReplace(objects: Array<EditableData<Record> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
7488
8918
|
delete<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
|
7489
8919
|
delete(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
|
7490
|
-
delete<K extends SelectableColumn<Record>>(id:
|
7491
|
-
delete(id:
|
8920
|
+
delete<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
|
8921
|
+
delete(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
|
7492
8922
|
delete<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
7493
8923
|
delete(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
7494
|
-
delete<K extends SelectableColumn<Record>>(objects:
|
7495
|
-
delete(objects:
|
8924
|
+
delete<K extends SelectableColumn<Record>>(objects: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
8925
|
+
delete(objects: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
7496
8926
|
deleteOrThrow<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
7497
8927
|
deleteOrThrow(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
7498
|
-
deleteOrThrow<K extends SelectableColumn<Record>>(id:
|
7499
|
-
deleteOrThrow(id:
|
8928
|
+
deleteOrThrow<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
8929
|
+
deleteOrThrow(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
7500
8930
|
deleteOrThrow<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
7501
8931
|
deleteOrThrow(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
7502
|
-
deleteOrThrow<K extends SelectableColumn<Record>>(objects:
|
7503
|
-
deleteOrThrow(objects:
|
8932
|
+
deleteOrThrow<K extends SelectableColumn<Record>>(objects: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
8933
|
+
deleteOrThrow(objects: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
7504
8934
|
search(query: string, options?: {
|
7505
8935
|
fuzziness?: FuzzinessExpression;
|
7506
8936
|
prefix?: PrefixExpression;
|
@@ -7518,6 +8948,9 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
|
|
7518
8948
|
aggregate<Expression extends Dictionary<AggregationExpression<Record>>>(aggs?: Expression, filter?: Filter<Record>): Promise<any>;
|
7519
8949
|
query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
|
7520
8950
|
summarizeTable<Result extends XataRecord>(query: Query<Record, Result>, summaries?: Dictionary<SummarizeExpression<Record>>, summariesFilter?: FilterExpression): Promise<SummarizeResponse>;
|
8951
|
+
ask(question: string, options?: AskOptions<Record> & {
|
8952
|
+
onMessage?: (message: AskResult) => void;
|
8953
|
+
}): any;
|
7521
8954
|
}
|
7522
8955
|
|
7523
8956
|
type BaseSchema = {
|
@@ -7573,7 +9006,7 @@ type PropertyType<Tables, Properties, PropertyName extends PropertyKey> = Proper
|
|
7573
9006
|
} : {
|
7574
9007
|
[K in PropertyName]?: InnerType<Type, ObjectColumns, Tables, LinkedTable> | null;
|
7575
9008
|
} : never : never;
|
7576
|
-
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 {
|
9009
|
+
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 'object' ? ObjectColumns extends readonly unknown[] ? ObjectColumns[number] extends {
|
7577
9010
|
name: string;
|
7578
9011
|
type: string;
|
7579
9012
|
} ? UnionToIntersection<Values<{
|
@@ -7631,11 +9064,11 @@ declare const le: <T extends ComparableType>(value: T) => ComparableTypeFilter<T
|
|
7631
9064
|
/**
|
7632
9065
|
* Operator to restrict results to only values that are not null.
|
7633
9066
|
*/
|
7634
|
-
declare const exists: <T>(column?:
|
9067
|
+
declare const exists: <T>(column?: FilterColumns<T> | undefined) => ExistanceFilter<T>;
|
7635
9068
|
/**
|
7636
9069
|
* Operator to restrict results to only values that are null.
|
7637
9070
|
*/
|
7638
|
-
declare const notExists: <T>(column?:
|
9071
|
+
declare const notExists: <T>(column?: FilterColumns<T> | undefined) => ExistanceFilter<T>;
|
7639
9072
|
/**
|
7640
9073
|
* Operator to restrict results to only values that start with the given prefix.
|
7641
9074
|
*/
|
@@ -7693,6 +9126,54 @@ declare class SchemaPlugin<Schemas extends Record<string, XataRecord>> extends X
|
|
7693
9126
|
build(pluginOptions: XataPluginOptions): SchemaPluginResult<Schemas>;
|
7694
9127
|
}
|
7695
9128
|
|
9129
|
+
type BinaryFile = string | Blob | ArrayBuffer;
|
9130
|
+
type FilesPluginResult<Schemas extends Record<string, BaseData>> = {
|
9131
|
+
download: <Tables extends StringKeys<Schemas>>(location: DownloadDestination<Schemas, Tables>) => Promise<Blob>;
|
9132
|
+
upload: <Tables extends StringKeys<Schemas>>(location: UploadDestination<Schemas, Tables>, file: BinaryFile) => Promise<FileResponse>;
|
9133
|
+
delete: <Tables extends StringKeys<Schemas>>(location: DownloadDestination<Schemas, Tables>) => Promise<FileResponse>;
|
9134
|
+
};
|
9135
|
+
type UploadDestination<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = Values<{
|
9136
|
+
[Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
|
9137
|
+
table: Model;
|
9138
|
+
column: ColumnsByValue<Schemas[Model], XataFile>;
|
9139
|
+
record: string;
|
9140
|
+
} | {
|
9141
|
+
table: Model;
|
9142
|
+
column: ColumnsByValue<Schemas[Model], XataArrayFile[]>;
|
9143
|
+
record: string;
|
9144
|
+
fileId?: string;
|
9145
|
+
};
|
9146
|
+
}>;
|
9147
|
+
type DownloadDestination<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = Values<{
|
9148
|
+
[Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
|
9149
|
+
table: Model;
|
9150
|
+
column: ColumnsByValue<Schemas[Model], XataFile>;
|
9151
|
+
record: string;
|
9152
|
+
} | {
|
9153
|
+
table: Model;
|
9154
|
+
column: ColumnsByValue<Schemas[Model], XataArrayFile[]>;
|
9155
|
+
record: string;
|
9156
|
+
fileId: string;
|
9157
|
+
};
|
9158
|
+
}>;
|
9159
|
+
declare class FilesPlugin<Schemas extends Record<string, XataRecord>> extends XataPlugin {
|
9160
|
+
build(pluginOptions: XataPluginOptions): FilesPluginResult<Schemas>;
|
9161
|
+
}
|
9162
|
+
|
9163
|
+
type SQLQueryParams<T = any[]> = {
|
9164
|
+
statement: string;
|
9165
|
+
params?: T;
|
9166
|
+
consistency?: 'strong' | 'eventual';
|
9167
|
+
};
|
9168
|
+
type SQLQuery = TemplateStringsArray | SQLQueryParams | string;
|
9169
|
+
type SQLPluginResult = <T>(query: SQLQuery, ...parameters: any[]) => Promise<{
|
9170
|
+
records: T[];
|
9171
|
+
warning?: string;
|
9172
|
+
}>;
|
9173
|
+
declare class SQLPlugin extends XataPlugin {
|
9174
|
+
build(pluginOptions: XataPluginOptions): SQLPluginResult;
|
9175
|
+
}
|
9176
|
+
|
7696
9177
|
type TransactionOperation<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = {
|
7697
9178
|
insert: Values<{
|
7698
9179
|
[Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
|
@@ -7725,6 +9206,7 @@ type UpdateTransactionOperation<O extends XataRecord> = {
|
|
7725
9206
|
};
|
7726
9207
|
type DeleteTransactionOperation = {
|
7727
9208
|
id: string;
|
9209
|
+
failIfMissing?: boolean;
|
7728
9210
|
};
|
7729
9211
|
type TransactionOperationSingleResult<Schema extends Record<string, BaseData>, Table extends StringKeys<Schema>, Operation extends TransactionOperation<Schema, Table>> = Operation extends {
|
7730
9212
|
insert: {
|
@@ -7771,19 +9253,15 @@ type TransactionPluginResult<Schemas extends Record<string, XataRecord>> = {
|
|
7771
9253
|
run: <Tables extends StringKeys<Schemas>, Operations extends TransactionOperation<Schemas, Tables>[]>(operations: Narrow<Operations>) => Promise<TransactionResults<Schemas, Tables, Operations>>;
|
7772
9254
|
};
|
7773
9255
|
declare class TransactionPlugin<Schemas extends Record<string, XataRecord>> extends XataPlugin {
|
7774
|
-
build(
|
9256
|
+
build(pluginOptions: XataPluginOptions): TransactionPluginResult<Schemas>;
|
7775
9257
|
}
|
7776
9258
|
|
7777
|
-
type BranchStrategyValue = string | undefined | null;
|
7778
|
-
type BranchStrategyBuilder = () => BranchStrategyValue | Promise<BranchStrategyValue>;
|
7779
|
-
type BranchStrategy = BranchStrategyValue | BranchStrategyBuilder;
|
7780
|
-
type BranchStrategyOption = NonNullable<BranchStrategy | BranchStrategy[]>;
|
7781
|
-
|
7782
9259
|
type BaseClientOptions = {
|
7783
9260
|
fetch?: FetchImpl;
|
9261
|
+
host?: HostProvider;
|
7784
9262
|
apiKey?: string;
|
7785
9263
|
databaseURL?: string;
|
7786
|
-
branch?:
|
9264
|
+
branch?: string;
|
7787
9265
|
cache?: CacheImpl;
|
7788
9266
|
trace?: TraceFunction;
|
7789
9267
|
enableBrowser?: boolean;
|
@@ -7796,6 +9274,8 @@ interface ClientConstructor<Plugins extends Record<string, XataPlugin>> {
|
|
7796
9274
|
db: Awaited<ReturnType<SchemaPlugin<Schemas>['build']>>;
|
7797
9275
|
search: Awaited<ReturnType<SearchPlugin<Schemas>['build']>>;
|
7798
9276
|
transactions: Awaited<ReturnType<TransactionPlugin<Schemas>['build']>>;
|
9277
|
+
sql: Awaited<ReturnType<SQLPlugin['build']>>;
|
9278
|
+
files: Awaited<ReturnType<FilesPlugin<Schemas>['build']>>;
|
7799
9279
|
}, keyof Plugins> & {
|
7800
9280
|
[Key in StringKeys<NonNullable<Plugins>>]: Awaited<ReturnType<NonNullable<Plugins>[Key]['build']>>;
|
7801
9281
|
} & {
|
@@ -7825,35 +9305,31 @@ type SerializerResult<T> = T extends XataRecord ? Identifiable & Omit<{
|
|
7825
9305
|
[K in keyof T]: SerializerResult<T[K]>;
|
7826
9306
|
}, keyof XataRecord> : T extends any[] ? SerializerResult<T[number]>[] : T;
|
7827
9307
|
|
7828
|
-
type BranchResolutionOptions = {
|
7829
|
-
databaseURL?: string;
|
7830
|
-
apiKey?: string;
|
7831
|
-
fetchImpl?: FetchImpl;
|
7832
|
-
clientName?: string;
|
7833
|
-
xataAgentExtra?: Record<string, string>;
|
7834
|
-
};
|
7835
|
-
declare function getCurrentBranchName(options?: BranchResolutionOptions): Promise<string>;
|
7836
|
-
declare function getCurrentBranchDetails(options?: BranchResolutionOptions): Promise<DBBranch | null>;
|
7837
9308
|
declare function getDatabaseURL(): string | undefined;
|
7838
|
-
|
7839
9309
|
declare function getAPIKey(): string | undefined;
|
9310
|
+
declare function getBranch(): string | undefined;
|
9311
|
+
declare function buildPreviewBranchName({ org, branch }: {
|
9312
|
+
org: string;
|
9313
|
+
branch: string;
|
9314
|
+
}): string;
|
9315
|
+
declare function getPreviewBranch(): string | undefined;
|
7840
9316
|
|
7841
9317
|
interface Body {
|
7842
9318
|
arrayBuffer(): Promise<ArrayBuffer>;
|
7843
|
-
blob(): Promise<Blob>;
|
9319
|
+
blob(): Promise<Blob$1>;
|
7844
9320
|
formData(): Promise<FormData>;
|
7845
9321
|
json(): Promise<any>;
|
7846
9322
|
text(): Promise<string>;
|
7847
9323
|
}
|
7848
|
-
interface Blob {
|
9324
|
+
interface Blob$1 {
|
7849
9325
|
readonly size: number;
|
7850
9326
|
readonly type: string;
|
7851
9327
|
arrayBuffer(): Promise<ArrayBuffer>;
|
7852
|
-
slice(start?: number, end?: number, contentType?: string): Blob;
|
9328
|
+
slice(start?: number, end?: number, contentType?: string): Blob$1;
|
7853
9329
|
text(): Promise<string>;
|
7854
9330
|
}
|
7855
9331
|
/** Provides information about files and allows JavaScript in a web page to access their content. */
|
7856
|
-
interface File extends Blob {
|
9332
|
+
interface File extends Blob$1 {
|
7857
9333
|
readonly lastModified: number;
|
7858
9334
|
readonly name: string;
|
7859
9335
|
readonly webkitRelativePath: string;
|
@@ -7861,12 +9337,12 @@ interface File extends Blob {
|
|
7861
9337
|
type FormDataEntryValue = File | string;
|
7862
9338
|
/** 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". */
|
7863
9339
|
interface FormData {
|
7864
|
-
append(name: string, value: string | Blob, fileName?: string): void;
|
9340
|
+
append(name: string, value: string | Blob$1, fileName?: string): void;
|
7865
9341
|
delete(name: string): void;
|
7866
9342
|
get(name: string): FormDataEntryValue | null;
|
7867
9343
|
getAll(name: string): FormDataEntryValue[];
|
7868
9344
|
has(name: string): boolean;
|
7869
|
-
set(name: string, value: string | Blob, fileName?: string): void;
|
9345
|
+
set(name: string, value: string | Blob$1, fileName?: string): void;
|
7870
9346
|
forEach(callbackfn: (value: FormDataEntryValue, key: string, parent: FormData) => void, thisArg?: any): void;
|
7871
9347
|
}
|
7872
9348
|
/** 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. */
|
@@ -7923,4 +9399,4 @@ declare class XataError extends Error {
|
|
7923
9399
|
constructor(message: string, status: number);
|
7924
9400
|
}
|
7925
9401
|
|
7926
|
-
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, AggregateTableError, AggregateTablePathParams, AggregateTableRequestBody, AggregateTableVariables, ApiExtraProps, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BranchTransactionError, BranchTransactionPathParams, BranchTransactionRequestBody, BranchTransactionVariables, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, ColumnsByValue, CompareBranchSchemasError, CompareBranchSchemasPathParams, CompareBranchSchemasRequestBody, CompareBranchSchemasVariables, CompareBranchWithUserSchemaError, CompareBranchWithUserSchemaPathParams, CompareBranchWithUserSchemaRequestBody, CompareBranchWithUserSchemaVariables, CompareMigrationRequestError, CompareMigrationRequestPathParams, CompareMigrationRequestVariables, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchResponse, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateMigrationRequestError, CreateMigrationRequestPathParams, CreateMigrationRequestRequestBody, CreateMigrationRequestResponse, CreateMigrationRequestVariables, CreateTableError, CreateTablePathParams, CreateTableResponse, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchResponse, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabaseGithubSettingsError, DeleteDatabaseGithubSettingsPathParams, DeleteDatabaseGithubSettingsVariables, DeleteDatabasePathParams, DeleteDatabaseResponse, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableResponse, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, DeserializedType, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherError, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchSchemaHistoryError, GetBranchSchemaHistoryPathParams, GetBranchSchemaHistoryRequestBody, GetBranchSchemaHistoryResponse, GetBranchSchemaHistoryVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseGithubSettingsError, GetDatabaseGithubSettingsPathParams, GetDatabaseGithubSettingsVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetDatabaseMetadataError, GetDatabaseMetadataPathParams, GetDatabaseMetadataVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetMigrationRequestError, GetMigrationRequestIsMergedError, GetMigrationRequestIsMergedPathParams, GetMigrationRequestIsMergedResponse, GetMigrationRequestIsMergedVariables, GetMigrationRequestPathParams, GetMigrationRequestVariables, GetRecordError, GetRecordPathParams, GetRecordQueryParams, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, HostProvider, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, Link, ListMigrationRequestsCommitsError, ListMigrationRequestsCommitsPathParams, ListMigrationRequestsCommitsRequestBody, ListMigrationRequestsCommitsResponse, ListMigrationRequestsCommitsVariables, ListRegionsError, ListRegionsPathParams, ListRegionsVariables, MergeMigrationRequestError, MergeMigrationRequestPathParams, MergeMigrationRequestVariables, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, PreviewBranchSchemaEditError, PreviewBranchSchemaEditPathParams, PreviewBranchSchemaEditRequestBody, PreviewBranchSchemaEditResponse, PreviewBranchSchemaEditVariables, Query, QueryMigrationRequestsError, QueryMigrationRequestsPathParams, QueryMigrationRequestsRequestBody, QueryMigrationRequestsResponse, QueryMigrationRequestsVariables, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RecordArray, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaInference, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SearchTableError, SearchTablePathParams, SearchTableRequestBody, SearchTableVariables, SearchXataRecord, SelectableColumn, SelectedPick, SerializedString, Serializer, SerializerResult, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, 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, VectorSearchTableError, VectorSearchTablePathParams, VectorSearchTableRequestBody, VectorSearchTableVariables, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, branchTransaction, buildClient, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
|
9402
|
+
export { type AcceptWorkspaceMemberInviteError, type AcceptWorkspaceMemberInvitePathParams, type AcceptWorkspaceMemberInviteVariables, type AddGitBranchesEntryError, type AddGitBranchesEntryPathParams, type AddGitBranchesEntryRequestBody, type AddGitBranchesEntryResponse, type AddGitBranchesEntryVariables, type AddTableColumnError, type AddTableColumnPathParams, type AddTableColumnVariables, type AggregateTableError, type AggregateTablePathParams, type AggregateTableRequestBody, type AggregateTableVariables, type ApiExtraProps, type ApplyBranchSchemaEditError, type ApplyBranchSchemaEditPathParams, type ApplyBranchSchemaEditRequestBody, type ApplyBranchSchemaEditVariables, type AskOptions, type AskResult, type AskTableError, type AskTablePathParams, type AskTableRequestBody, type AskTableResponse, type AskTableSessionError, type AskTableSessionPathParams, type AskTableSessionRequestBody, type AskTableSessionResponse, type AskTableSessionVariables, type AskTableVariables, BaseClient, type BaseClientOptions, type BaseData, type BaseSchema, type BinaryFile, type BranchTransactionError, type BranchTransactionPathParams, type BranchTransactionRequestBody, type BranchTransactionVariables, type BulkInsertTableRecordsError, type BulkInsertTableRecordsPathParams, type BulkInsertTableRecordsQueryParams, type BulkInsertTableRecordsRequestBody, type BulkInsertTableRecordsVariables, type CacheImpl, type CancelWorkspaceMemberInviteError, type CancelWorkspaceMemberInvitePathParams, type CancelWorkspaceMemberInviteVariables, type ClientConstructor, type ColumnsByValue, type CompareBranchSchemasError, type CompareBranchSchemasPathParams, type CompareBranchSchemasRequestBody, type CompareBranchSchemasVariables, type CompareBranchWithUserSchemaError, type CompareBranchWithUserSchemaPathParams, type CompareBranchWithUserSchemaRequestBody, type CompareBranchWithUserSchemaVariables, type CompareMigrationRequestError, type CompareMigrationRequestPathParams, type CompareMigrationRequestVariables, type CopyBranchError, type CopyBranchPathParams, type CopyBranchRequestBody, type CopyBranchVariables, type CreateBranchError, type CreateBranchPathParams, type CreateBranchQueryParams, type CreateBranchRequestBody, type CreateBranchResponse, type CreateBranchVariables, type CreateDatabaseError, type CreateDatabasePathParams, type CreateDatabaseRequestBody, type CreateDatabaseResponse, type CreateDatabaseVariables, type CreateMigrationRequestError, type CreateMigrationRequestPathParams, type CreateMigrationRequestRequestBody, type CreateMigrationRequestResponse, type CreateMigrationRequestVariables, type CreateTableError, type CreateTablePathParams, type CreateTableResponse, type CreateTableVariables, type CreateUserAPIKeyError, type CreateUserAPIKeyPathParams, type CreateUserAPIKeyResponse, type CreateUserAPIKeyVariables, type CreateWorkspaceError, type CreateWorkspaceVariables, type CursorNavigationOptions, type DeleteBranchError, type DeleteBranchPathParams, type DeleteBranchResponse, type DeleteBranchVariables, type DeleteColumnError, type DeleteColumnPathParams, type DeleteColumnVariables, type DeleteDatabaseError, type DeleteDatabaseGithubSettingsError, type DeleteDatabaseGithubSettingsPathParams, type DeleteDatabaseGithubSettingsVariables, type DeleteDatabasePathParams, type DeleteDatabaseResponse, type DeleteDatabaseVariables, type DeleteFileError, type DeleteFileItemError, type DeleteFileItemPathParams, type DeleteFileItemVariables, type DeleteFilePathParams, type DeleteFileVariables, type DeleteOAuthAccessTokenError, type DeleteOAuthAccessTokenPathParams, type DeleteOAuthAccessTokenVariables, type DeleteRecordError, type DeleteRecordPathParams, type DeleteRecordQueryParams, type DeleteRecordVariables, type DeleteTableError, type DeleteTablePathParams, type DeleteTableResponse, type DeleteTableVariables, type DeleteUserAPIKeyError, type DeleteUserAPIKeyPathParams, type DeleteUserAPIKeyVariables, type DeleteUserError, type 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 GetColumnError, type GetColumnPathParams, type GetColumnVariables, type GetDatabaseGithubSettingsError, type GetDatabaseGithubSettingsPathParams, type GetDatabaseGithubSettingsVariables, type GetDatabaseListError, type GetDatabaseListPathParams, type GetDatabaseListVariables, type GetDatabaseMetadataError, type GetDatabaseMetadataPathParams, type GetDatabaseMetadataVariables, type GetFileError, type GetFileItemError, type GetFileItemPathParams, type GetFileItemVariables, type GetFilePathParams, type GetFileVariables, type GetGitBranchesMappingError, type GetGitBranchesMappingPathParams, type GetGitBranchesMappingVariables, type GetMigrationRequestError, type GetMigrationRequestIsMergedError, type GetMigrationRequestIsMergedPathParams, type GetMigrationRequestIsMergedResponse, type GetMigrationRequestIsMergedVariables, type GetMigrationRequestPathParams, type GetMigrationRequestVariables, type GetRecordError, type GetRecordPathParams, type GetRecordQueryParams, type GetRecordVariables, type GetTableColumnsError, type GetTableColumnsPathParams, type GetTableColumnsResponse, type GetTableColumnsVariables, type GetTableSchemaError, type GetTableSchemaPathParams, type GetTableSchemaResponse, type GetTableSchemaVariables, type GetUserAPIKeysError, type GetUserAPIKeysResponse, type GetUserAPIKeysVariables, type GetUserError, type GetUserOAuthAccessTokensError, type GetUserOAuthAccessTokensResponse, type GetUserOAuthAccessTokensVariables, type GetUserOAuthClientsError, type GetUserOAuthClientsResponse, type GetUserOAuthClientsVariables, type GetUserVariables, type GetWorkspaceError, type GetWorkspaceMembersListError, type GetWorkspaceMembersListPathParams, type GetWorkspaceMembersListVariables, type GetWorkspacePathParams, type GetWorkspaceVariables, type GetWorkspacesListError, type GetWorkspacesListResponse, type GetWorkspacesListVariables, type GrantAuthorizationCodeError, type GrantAuthorizationCodeVariables, type HostProvider, type Identifiable, type InsertRecordError, type InsertRecordPathParams, type InsertRecordQueryParams, type InsertRecordVariables, type InsertRecordWithIDError, type InsertRecordWithIDPathParams, type InsertRecordWithIDQueryParams, type InsertRecordWithIDVariables, type InviteWorkspaceMemberError, type InviteWorkspaceMemberPathParams, type InviteWorkspaceMemberRequestBody, type InviteWorkspaceMemberVariables, type JSONData, type KeywordAskOptions, type Link, type ListMigrationRequestsCommitsError, type ListMigrationRequestsCommitsPathParams, type ListMigrationRequestsCommitsRequestBody, type ListMigrationRequestsCommitsResponse, type ListMigrationRequestsCommitsVariables, type ListRegionsError, type ListRegionsPathParams, type ListRegionsVariables, type MergeMigrationRequestError, type MergeMigrationRequestPathParams, type MergeMigrationRequestVariables, type OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, type Paginable, type PaginationQueryMeta, type PreviewBranchSchemaEditError, type PreviewBranchSchemaEditPathParams, type PreviewBranchSchemaEditRequestBody, type PreviewBranchSchemaEditResponse, type PreviewBranchSchemaEditVariables, type PushBranchMigrationsError, type PushBranchMigrationsPathParams, type PushBranchMigrationsRequestBody, type PushBranchMigrationsVariables, type PutFileError, type PutFileItemError, type PutFileItemPathParams, type PutFileItemVariables, type PutFilePathParams, type PutFileVariables, Query, type QueryMigrationRequestsError, type QueryMigrationRequestsPathParams, type QueryMigrationRequestsRequestBody, type QueryMigrationRequestsResponse, type QueryMigrationRequestsVariables, type QueryTableError, type QueryTablePathParams, type QueryTableRequestBody, type QueryTableVariables, RecordArray, RecordColumnTypes, type RemoveGitBranchesEntryError, type RemoveGitBranchesEntryPathParams, type RemoveGitBranchesEntryQueryParams, type RemoveGitBranchesEntryVariables, type RemoveWorkspaceMemberError, type RemoveWorkspaceMemberPathParams, type RemoveWorkspaceMemberVariables, type RenameDatabaseError, type RenameDatabasePathParams, type RenameDatabaseRequestBody, type RenameDatabaseVariables, Repository, type ResendWorkspaceMemberInviteError, type ResendWorkspaceMemberInvitePathParams, type ResendWorkspaceMemberInviteVariables, type ResolveBranchError, type ResolveBranchPathParams, type ResolveBranchQueryParams, type ResolveBranchResponse, type ResolveBranchVariables, responses as Responses, RestRepository, SQLPlugin, type SQLPluginResult, type SQLQuery, type SQLQueryParams, type SchemaDefinition, type SchemaInference, SchemaPlugin, type SchemaPluginResult, schemas as Schemas, type SearchBranchError, type SearchBranchPathParams, type SearchBranchRequestBody, type SearchBranchVariables, type SearchOptions, SearchPlugin, type SearchPluginResult, type SearchTableError, type SearchTablePathParams, type SearchTableRequestBody, type SearchTableVariables, type SearchXataRecord, type SelectableColumn, type SelectedPick, type SerializedString, Serializer, type SerializerResult, type SetTableSchemaError, type SetTableSchemaPathParams, type SetTableSchemaRequestBody, type SetTableSchemaVariables, SimpleCache, type SimpleCacheOptions, type SqlQueryError, type SqlQueryPathParams, type SqlQueryRequestBody, type SqlQueryVariables, type SummarizeTableError, type SummarizeTablePathParams, type SummarizeTableRequestBody, type SummarizeTableVariables, type UpdateBranchMetadataError, type UpdateBranchMetadataPathParams, type UpdateBranchMetadataVariables, type UpdateBranchSchemaError, type UpdateBranchSchemaPathParams, type UpdateBranchSchemaVariables, type UpdateColumnError, type UpdateColumnPathParams, type UpdateColumnRequestBody, type UpdateColumnVariables, type UpdateDatabaseGithubSettingsError, type UpdateDatabaseGithubSettingsPathParams, type UpdateDatabaseGithubSettingsVariables, type UpdateDatabaseMetadataError, type UpdateDatabaseMetadataPathParams, type UpdateDatabaseMetadataRequestBody, type UpdateDatabaseMetadataVariables, type UpdateMigrationRequestError, type UpdateMigrationRequestPathParams, type UpdateMigrationRequestRequestBody, type UpdateMigrationRequestVariables, type UpdateOAuthAccessTokenError, type UpdateOAuthAccessTokenPathParams, type UpdateOAuthAccessTokenRequestBody, type UpdateOAuthAccessTokenVariables, type UpdateRecordWithIDError, type UpdateRecordWithIDPathParams, type UpdateRecordWithIDQueryParams, type UpdateRecordWithIDVariables, type UpdateTableError, type UpdateTablePathParams, type UpdateTableRequestBody, type UpdateTableVariables, type UpdateUserError, type UpdateUserVariables, type UpdateWorkspaceError, type UpdateWorkspaceMemberInviteError, type UpdateWorkspaceMemberInvitePathParams, type UpdateWorkspaceMemberInviteRequestBody, type UpdateWorkspaceMemberInviteVariables, type UpdateWorkspaceMemberRoleError, type UpdateWorkspaceMemberRolePathParams, type UpdateWorkspaceMemberRoleRequestBody, type UpdateWorkspaceMemberRoleVariables, type UpdateWorkspacePathParams, type UpdateWorkspaceVariables, type UploadDestination, type UpsertRecordWithIDError, type UpsertRecordWithIDPathParams, type UpsertRecordWithIDQueryParams, type UpsertRecordWithIDVariables, type ValueAtColumn, type VectorAskOptions, type VectorSearchTableError, type VectorSearchTablePathParams, type VectorSearchTableRequestBody, type VectorSearchTableVariables, XataApiClient, type XataApiClientOptions, XataApiPlugin, type XataArrayFile, XataError, XataFile, XataPlugin, type XataPluginOptions, type XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, askTable, askTableSession, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteFile, deleteFileItem, deleteOAuthAccessToken, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, fileAccess, ge, getAPIKey, getAuthorizationCode, 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, getUserOAuthAccessTokens, getUserOAuthClients, getWorkspace, getWorkspaceMembersList, getWorkspacesList, grantAuthorizationCode, 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, transformImage, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateOAuthAccessToken, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
|