@xata.io/client 0.0.0-alpha.vf9d4e41 → 0.0.0-alpha.vf9f8ac6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +144 -0
- package/README.md +271 -1
- package/Usage.md +428 -0
- package/dist/index.cjs +576 -299
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +870 -161
- package/dist/index.mjs +550 -300
- package/dist/index.mjs.map +1 -1
- package/package.json +8 -4
package/dist/index.d.ts
CHANGED
@@ -6,6 +6,9 @@ declare type FetchImpl = (url: string, init?: {
|
|
6
6
|
ok: boolean;
|
7
7
|
status: number;
|
8
8
|
json(): Promise<any>;
|
9
|
+
headers?: {
|
10
|
+
get(name: string): string | null;
|
11
|
+
};
|
9
12
|
}>;
|
10
13
|
declare type WorkspaceApiUrlBuilder = (path: string, pathParams: Record<string, string>) => string;
|
11
14
|
declare type FetcherExtraProps = {
|
@@ -20,7 +23,6 @@ declare type ErrorWrapper<TError> = TError | {
|
|
20
23
|
};
|
21
24
|
|
22
25
|
interface CacheImpl {
|
23
|
-
cacheRecords: boolean;
|
24
26
|
defaultQueryTTL: number;
|
25
27
|
getAll(): Promise<Record<string, unknown>>;
|
26
28
|
get: <T>(key: string) => Promise<T | null>;
|
@@ -30,13 +32,11 @@ interface CacheImpl {
|
|
30
32
|
}
|
31
33
|
interface SimpleCacheOptions {
|
32
34
|
max?: number;
|
33
|
-
cacheRecords?: boolean;
|
34
35
|
defaultQueryTTL?: number;
|
35
36
|
}
|
36
37
|
declare class SimpleCache implements CacheImpl {
|
37
38
|
#private;
|
38
39
|
capacity: number;
|
39
|
-
cacheRecords: boolean;
|
40
40
|
defaultQueryTTL: number;
|
41
41
|
constructor(options?: SimpleCacheOptions);
|
42
42
|
getAll(): Promise<Record<string, unknown>>;
|
@@ -122,16 +122,20 @@ declare type WorkspaceMembers = {
|
|
122
122
|
* @pattern ^ik_[a-zA-Z0-9]+
|
123
123
|
*/
|
124
124
|
declare type InviteKey = string;
|
125
|
+
/**
|
126
|
+
* Metadata of databases
|
127
|
+
*/
|
128
|
+
declare type DatabaseMetadata = {
|
129
|
+
name: string;
|
130
|
+
displayName: string;
|
131
|
+
createdAt: DateTime;
|
132
|
+
numberOfBranches: number;
|
133
|
+
ui?: {
|
134
|
+
color?: string;
|
135
|
+
};
|
136
|
+
};
|
125
137
|
declare type ListDatabasesResponse = {
|
126
|
-
databases?:
|
127
|
-
name: string;
|
128
|
-
displayName: string;
|
129
|
-
createdAt: DateTime;
|
130
|
-
numberOfBranches: number;
|
131
|
-
ui?: {
|
132
|
-
color?: string;
|
133
|
-
};
|
134
|
-
}[];
|
138
|
+
databases?: DatabaseMetadata[];
|
135
139
|
};
|
136
140
|
declare type ListBranchesResponse = {
|
137
141
|
databaseName: string;
|
@@ -268,6 +272,21 @@ declare type SortExpression = string[] | {
|
|
268
272
|
[key: string]: SortOrder;
|
269
273
|
}[];
|
270
274
|
declare type SortOrder = 'asc' | 'desc';
|
275
|
+
/**
|
276
|
+
* Maximum [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) for the search terms. The Levenshtein
|
277
|
+
* distance is the number of one charcter changes needed to make two strings equal. The default is 1, meaning that single
|
278
|
+
* character typos per word are tollerated by search. You can set it to 0 to remove the typo tollerance or set it to 2
|
279
|
+
* to allow two typos in a word.
|
280
|
+
*
|
281
|
+
* @default 1
|
282
|
+
* @maximum 2
|
283
|
+
* @minimum 0
|
284
|
+
*/
|
285
|
+
declare type FuzzinessExpression = number;
|
286
|
+
/**
|
287
|
+
* If the prefix type is set to "disabled" (the default), the search only matches full words. If the prefix type is set to "phrase", the search will return results that match prefixes of the search phrase.
|
288
|
+
*/
|
289
|
+
declare type PrefixExpression = 'phrase' | 'disabled';
|
271
290
|
/**
|
272
291
|
* @minProperties 1
|
273
292
|
*/
|
@@ -281,6 +300,48 @@ declare type FilterExpression = {
|
|
281
300
|
} & {
|
282
301
|
[key: string]: FilterColumn;
|
283
302
|
};
|
303
|
+
declare type HighlightExpression = {
|
304
|
+
enabled?: boolean;
|
305
|
+
encodeHTML?: boolean;
|
306
|
+
};
|
307
|
+
/**
|
308
|
+
* Booster Expression
|
309
|
+
*
|
310
|
+
* @x-go-type xata.BoosterExpression
|
311
|
+
*/
|
312
|
+
declare type BoosterExpression = {
|
313
|
+
valueBooster?: ValueBooster$1;
|
314
|
+
} | {
|
315
|
+
numericBooster?: NumericBooster$1;
|
316
|
+
} | {
|
317
|
+
dateBooster?: DateBooster$1;
|
318
|
+
};
|
319
|
+
/**
|
320
|
+
* Boost records with a particular value for a column.
|
321
|
+
*/
|
322
|
+
declare type ValueBooster$1 = {
|
323
|
+
column: string;
|
324
|
+
value: string | number | boolean;
|
325
|
+
factor: number;
|
326
|
+
};
|
327
|
+
/**
|
328
|
+
* Boost records based on the value of a numeric column.
|
329
|
+
*/
|
330
|
+
declare type NumericBooster$1 = {
|
331
|
+
column: string;
|
332
|
+
factor: number;
|
333
|
+
};
|
334
|
+
/**
|
335
|
+
* Boost records based on the value of a datetime column. It is configured via "origin", "scale", and "decay". The further away from the "origin",
|
336
|
+
* 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
|
337
|
+
* should be interpreted as: a record with a date 10 days before/after origin will score 2 times less than a record with the date at origin.
|
338
|
+
*/
|
339
|
+
declare type DateBooster$1 = {
|
340
|
+
column: string;
|
341
|
+
origin?: string;
|
342
|
+
scale: string;
|
343
|
+
decay: number;
|
344
|
+
};
|
284
345
|
declare type FilterList = FilterExpression | FilterExpression[];
|
285
346
|
declare type FilterColumn = FilterColumnIncludes | FilterPredicate | FilterList;
|
286
347
|
/**
|
@@ -337,7 +398,24 @@ declare type PageConfig = {
|
|
337
398
|
size?: number;
|
338
399
|
offset?: number;
|
339
400
|
};
|
340
|
-
declare type
|
401
|
+
declare type ColumnsProjection = string[];
|
402
|
+
/**
|
403
|
+
* Xata Table Record Metadata
|
404
|
+
*/
|
405
|
+
declare type RecordMeta = {
|
406
|
+
id: RecordID;
|
407
|
+
xata: {
|
408
|
+
version: number;
|
409
|
+
table?: string;
|
410
|
+
highlight?: {
|
411
|
+
[key: string]: string[] | {
|
412
|
+
[key: string]: any;
|
413
|
+
};
|
414
|
+
};
|
415
|
+
score?: number;
|
416
|
+
warnings?: string[];
|
417
|
+
};
|
418
|
+
};
|
341
419
|
/**
|
342
420
|
* @pattern [a-zA-Z0-9_-~:]+
|
343
421
|
*/
|
@@ -359,16 +437,9 @@ declare type RecordsMetadata = {
|
|
359
437
|
};
|
360
438
|
};
|
361
439
|
/**
|
362
|
-
* Xata Table Record
|
440
|
+
* Xata Table Record Metadata
|
363
441
|
*/
|
364
|
-
declare type XataRecord$1 = {
|
365
|
-
id: RecordID;
|
366
|
-
xata: {
|
367
|
-
version: number;
|
368
|
-
table?: string;
|
369
|
-
warnings?: string[];
|
370
|
-
};
|
371
|
-
} & {
|
442
|
+
declare type XataRecord$1 = RecordMeta & {
|
372
443
|
[key: string]: any;
|
373
444
|
};
|
374
445
|
|
@@ -386,6 +457,7 @@ type schemas_InviteID = InviteID;
|
|
386
457
|
type schemas_WorkspaceInvite = WorkspaceInvite;
|
387
458
|
type schemas_WorkspaceMembers = WorkspaceMembers;
|
388
459
|
type schemas_InviteKey = InviteKey;
|
460
|
+
type schemas_DatabaseMetadata = DatabaseMetadata;
|
389
461
|
type schemas_ListDatabasesResponse = ListDatabasesResponse;
|
390
462
|
type schemas_ListBranchesResponse = ListBranchesResponse;
|
391
463
|
type schemas_ListGitBranchesResponse = ListGitBranchesResponse;
|
@@ -409,7 +481,11 @@ type schemas_TableMigration = TableMigration;
|
|
409
481
|
type schemas_ColumnMigration = ColumnMigration;
|
410
482
|
type schemas_SortExpression = SortExpression;
|
411
483
|
type schemas_SortOrder = SortOrder;
|
484
|
+
type schemas_FuzzinessExpression = FuzzinessExpression;
|
485
|
+
type schemas_PrefixExpression = PrefixExpression;
|
412
486
|
type schemas_FilterExpression = FilterExpression;
|
487
|
+
type schemas_HighlightExpression = HighlightExpression;
|
488
|
+
type schemas_BoosterExpression = BoosterExpression;
|
413
489
|
type schemas_FilterList = FilterList;
|
414
490
|
type schemas_FilterColumn = FilterColumn;
|
415
491
|
type schemas_FilterColumnIncludes = FilterColumnIncludes;
|
@@ -419,7 +495,8 @@ type schemas_FilterPredicateRangeOp = FilterPredicateRangeOp;
|
|
419
495
|
type schemas_FilterRangeValue = FilterRangeValue;
|
420
496
|
type schemas_FilterValue = FilterValue;
|
421
497
|
type schemas_PageConfig = PageConfig;
|
422
|
-
type
|
498
|
+
type schemas_ColumnsProjection = ColumnsProjection;
|
499
|
+
type schemas_RecordMeta = RecordMeta;
|
423
500
|
type schemas_RecordID = RecordID;
|
424
501
|
type schemas_TableRename = TableRename;
|
425
502
|
type schemas_RecordsMetadata = RecordsMetadata;
|
@@ -439,6 +516,7 @@ declare namespace schemas {
|
|
439
516
|
schemas_WorkspaceInvite as WorkspaceInvite,
|
440
517
|
schemas_WorkspaceMembers as WorkspaceMembers,
|
441
518
|
schemas_InviteKey as InviteKey,
|
519
|
+
schemas_DatabaseMetadata as DatabaseMetadata,
|
442
520
|
schemas_ListDatabasesResponse as ListDatabasesResponse,
|
443
521
|
schemas_ListBranchesResponse as ListBranchesResponse,
|
444
522
|
schemas_ListGitBranchesResponse as ListGitBranchesResponse,
|
@@ -462,7 +540,14 @@ declare namespace schemas {
|
|
462
540
|
schemas_ColumnMigration as ColumnMigration,
|
463
541
|
schemas_SortExpression as SortExpression,
|
464
542
|
schemas_SortOrder as SortOrder,
|
543
|
+
schemas_FuzzinessExpression as FuzzinessExpression,
|
544
|
+
schemas_PrefixExpression as PrefixExpression,
|
465
545
|
schemas_FilterExpression as FilterExpression,
|
546
|
+
schemas_HighlightExpression as HighlightExpression,
|
547
|
+
schemas_BoosterExpression as BoosterExpression,
|
548
|
+
ValueBooster$1 as ValueBooster,
|
549
|
+
NumericBooster$1 as NumericBooster,
|
550
|
+
DateBooster$1 as DateBooster,
|
466
551
|
schemas_FilterList as FilterList,
|
467
552
|
schemas_FilterColumn as FilterColumn,
|
468
553
|
schemas_FilterColumnIncludes as FilterColumnIncludes,
|
@@ -472,7 +557,8 @@ declare namespace schemas {
|
|
472
557
|
schemas_FilterRangeValue as FilterRangeValue,
|
473
558
|
schemas_FilterValue as FilterValue,
|
474
559
|
schemas_PageConfig as PageConfig,
|
475
|
-
|
560
|
+
schemas_ColumnsProjection as ColumnsProjection,
|
561
|
+
schemas_RecordMeta as RecordMeta,
|
476
562
|
schemas_RecordID as RecordID,
|
477
563
|
schemas_TableRename as TableRename,
|
478
564
|
schemas_RecordsMetadata as RecordsMetadata,
|
@@ -507,11 +593,17 @@ declare type BulkError = {
|
|
507
593
|
status?: number;
|
508
594
|
}[];
|
509
595
|
};
|
596
|
+
declare type BulkInsertResponse = {
|
597
|
+
recordIDs: string[];
|
598
|
+
} | {
|
599
|
+
records: XataRecord$1[];
|
600
|
+
};
|
510
601
|
declare type BranchMigrationPlan = {
|
511
602
|
version: number;
|
512
603
|
migration: BranchMigration;
|
513
604
|
};
|
514
|
-
declare type
|
605
|
+
declare type RecordResponse = XataRecord$1;
|
606
|
+
declare type RecordUpdateResponse = XataRecord$1 | {
|
515
607
|
id: string;
|
516
608
|
xata: {
|
517
609
|
version: number;
|
@@ -535,7 +627,9 @@ type responses_SimpleError = SimpleError;
|
|
535
627
|
type responses_BadRequestError = BadRequestError;
|
536
628
|
type responses_AuthError = AuthError;
|
537
629
|
type responses_BulkError = BulkError;
|
630
|
+
type responses_BulkInsertResponse = BulkInsertResponse;
|
538
631
|
type responses_BranchMigrationPlan = BranchMigrationPlan;
|
632
|
+
type responses_RecordResponse = RecordResponse;
|
539
633
|
type responses_RecordUpdateResponse = RecordUpdateResponse;
|
540
634
|
type responses_QueryResponse = QueryResponse;
|
541
635
|
type responses_SearchResponse = SearchResponse;
|
@@ -546,7 +640,9 @@ declare namespace responses {
|
|
546
640
|
responses_BadRequestError as BadRequestError,
|
547
641
|
responses_AuthError as AuthError,
|
548
642
|
responses_BulkError as BulkError,
|
643
|
+
responses_BulkInsertResponse as BulkInsertResponse,
|
549
644
|
responses_BranchMigrationPlan as BranchMigrationPlan,
|
645
|
+
responses_RecordResponse as RecordResponse,
|
550
646
|
responses_RecordUpdateResponse as RecordUpdateResponse,
|
551
647
|
responses_QueryResponse as QueryResponse,
|
552
648
|
responses_SearchResponse as SearchResponse,
|
@@ -852,6 +948,9 @@ declare type InviteWorkspaceMemberError = ErrorWrapper<{
|
|
852
948
|
} | {
|
853
949
|
status: 404;
|
854
950
|
payload: SimpleError;
|
951
|
+
} | {
|
952
|
+
status: 409;
|
953
|
+
payload: SimpleError;
|
855
954
|
}>;
|
856
955
|
declare type InviteWorkspaceMemberRequestBody = {
|
857
956
|
email: string;
|
@@ -865,6 +964,34 @@ declare type InviteWorkspaceMemberVariables = {
|
|
865
964
|
* Invite some user to join the workspace with the given role
|
866
965
|
*/
|
867
966
|
declare const inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables) => Promise<WorkspaceInvite>;
|
967
|
+
declare type UpdateWorkspaceMemberInvitePathParams = {
|
968
|
+
workspaceId: WorkspaceID;
|
969
|
+
inviteId: InviteID;
|
970
|
+
};
|
971
|
+
declare type UpdateWorkspaceMemberInviteError = ErrorWrapper<{
|
972
|
+
status: 400;
|
973
|
+
payload: BadRequestError;
|
974
|
+
} | {
|
975
|
+
status: 401;
|
976
|
+
payload: AuthError;
|
977
|
+
} | {
|
978
|
+
status: 404;
|
979
|
+
payload: SimpleError;
|
980
|
+
} | {
|
981
|
+
status: 422;
|
982
|
+
payload: SimpleError;
|
983
|
+
}>;
|
984
|
+
declare type UpdateWorkspaceMemberInviteRequestBody = {
|
985
|
+
role: Role;
|
986
|
+
};
|
987
|
+
declare type UpdateWorkspaceMemberInviteVariables = {
|
988
|
+
body: UpdateWorkspaceMemberInviteRequestBody;
|
989
|
+
pathParams: UpdateWorkspaceMemberInvitePathParams;
|
990
|
+
} & FetcherExtraProps;
|
991
|
+
/**
|
992
|
+
* This operation provides a way to update an existing invite. Updates are performed in-place; they do not change the invite link, the expiry time, nor do they re-notify the recipient of the invite.
|
993
|
+
*/
|
994
|
+
declare const updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables) => Promise<WorkspaceInvite>;
|
868
995
|
declare type CancelWorkspaceMemberInvitePathParams = {
|
869
996
|
workspaceId: WorkspaceID;
|
870
997
|
inviteId: InviteID;
|
@@ -1018,6 +1145,27 @@ declare type DeleteDatabaseVariables = {
|
|
1018
1145
|
* Delete a database and all of its branches and tables permanently.
|
1019
1146
|
*/
|
1020
1147
|
declare const deleteDatabase: (variables: DeleteDatabaseVariables) => Promise<undefined>;
|
1148
|
+
declare type GetDatabaseMetadataPathParams = {
|
1149
|
+
dbName: DBName;
|
1150
|
+
workspace: string;
|
1151
|
+
};
|
1152
|
+
declare type GetDatabaseMetadataError = ErrorWrapper<{
|
1153
|
+
status: 400;
|
1154
|
+
payload: BadRequestError;
|
1155
|
+
} | {
|
1156
|
+
status: 401;
|
1157
|
+
payload: AuthError;
|
1158
|
+
} | {
|
1159
|
+
status: 404;
|
1160
|
+
payload: SimpleError;
|
1161
|
+
}>;
|
1162
|
+
declare type GetDatabaseMetadataVariables = {
|
1163
|
+
pathParams: GetDatabaseMetadataPathParams;
|
1164
|
+
} & FetcherExtraProps;
|
1165
|
+
/**
|
1166
|
+
* Retrieve metadata of the given database
|
1167
|
+
*/
|
1168
|
+
declare const getDatabaseMetadata: (variables: GetDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
|
1021
1169
|
declare type GetGitBranchesMappingPathParams = {
|
1022
1170
|
dbName: DBName;
|
1023
1171
|
workspace: string;
|
@@ -1210,6 +1358,10 @@ declare type CreateBranchError = ErrorWrapper<{
|
|
1210
1358
|
status: 404;
|
1211
1359
|
payload: SimpleError;
|
1212
1360
|
}>;
|
1361
|
+
declare type CreateBranchResponse = {
|
1362
|
+
databaseName: string;
|
1363
|
+
branchName: string;
|
1364
|
+
};
|
1213
1365
|
declare type CreateBranchRequestBody = {
|
1214
1366
|
from?: string;
|
1215
1367
|
metadata?: BranchMetadata;
|
@@ -1219,7 +1371,7 @@ declare type CreateBranchVariables = {
|
|
1219
1371
|
pathParams: CreateBranchPathParams;
|
1220
1372
|
queryParams?: CreateBranchQueryParams;
|
1221
1373
|
} & FetcherExtraProps;
|
1222
|
-
declare const createBranch: (variables: CreateBranchVariables) => Promise<
|
1374
|
+
declare const createBranch: (variables: CreateBranchVariables) => Promise<CreateBranchResponse>;
|
1223
1375
|
declare type DeleteBranchPathParams = {
|
1224
1376
|
dbBranchName: DBBranchName;
|
1225
1377
|
workspace: string;
|
@@ -1406,13 +1558,17 @@ declare type CreateTableError = ErrorWrapper<{
|
|
1406
1558
|
status: 422;
|
1407
1559
|
payload: SimpleError;
|
1408
1560
|
}>;
|
1561
|
+
declare type CreateTableResponse = {
|
1562
|
+
branchName: string;
|
1563
|
+
tableName: string;
|
1564
|
+
};
|
1409
1565
|
declare type CreateTableVariables = {
|
1410
1566
|
pathParams: CreateTablePathParams;
|
1411
1567
|
} & FetcherExtraProps;
|
1412
1568
|
/**
|
1413
1569
|
* Creates a new table with the given name. Returns 422 if a table with the same name already exists.
|
1414
1570
|
*/
|
1415
|
-
declare const createTable: (variables: CreateTableVariables) => Promise<
|
1571
|
+
declare const createTable: (variables: CreateTableVariables) => Promise<CreateTableResponse>;
|
1416
1572
|
declare type DeleteTablePathParams = {
|
1417
1573
|
dbBranchName: DBBranchName;
|
1418
1574
|
tableName: TableName;
|
@@ -1645,6 +1801,9 @@ declare type InsertRecordPathParams = {
|
|
1645
1801
|
tableName: TableName;
|
1646
1802
|
workspace: string;
|
1647
1803
|
};
|
1804
|
+
declare type InsertRecordQueryParams = {
|
1805
|
+
columns?: ColumnsProjection;
|
1806
|
+
};
|
1648
1807
|
declare type InsertRecordError = ErrorWrapper<{
|
1649
1808
|
status: 400;
|
1650
1809
|
payload: BadRequestError;
|
@@ -1655,20 +1814,15 @@ declare type InsertRecordError = ErrorWrapper<{
|
|
1655
1814
|
status: 404;
|
1656
1815
|
payload: SimpleError;
|
1657
1816
|
}>;
|
1658
|
-
declare type InsertRecordResponse = {
|
1659
|
-
id: string;
|
1660
|
-
xata: {
|
1661
|
-
version: number;
|
1662
|
-
};
|
1663
|
-
};
|
1664
1817
|
declare type InsertRecordVariables = {
|
1665
1818
|
body?: Record<string, any>;
|
1666
1819
|
pathParams: InsertRecordPathParams;
|
1820
|
+
queryParams?: InsertRecordQueryParams;
|
1667
1821
|
} & FetcherExtraProps;
|
1668
1822
|
/**
|
1669
1823
|
* Insert a new Record into the Table
|
1670
1824
|
*/
|
1671
|
-
declare const insertRecord: (variables: InsertRecordVariables) => Promise<
|
1825
|
+
declare const insertRecord: (variables: InsertRecordVariables) => Promise<RecordUpdateResponse>;
|
1672
1826
|
declare type InsertRecordWithIDPathParams = {
|
1673
1827
|
dbBranchName: DBBranchName;
|
1674
1828
|
tableName: TableName;
|
@@ -1676,6 +1830,7 @@ declare type InsertRecordWithIDPathParams = {
|
|
1676
1830
|
workspace: string;
|
1677
1831
|
};
|
1678
1832
|
declare type InsertRecordWithIDQueryParams = {
|
1833
|
+
columns?: ColumnsProjection;
|
1679
1834
|
createOnly?: boolean;
|
1680
1835
|
ifVersion?: number;
|
1681
1836
|
};
|
@@ -1708,6 +1863,7 @@ declare type UpdateRecordWithIDPathParams = {
|
|
1708
1863
|
workspace: string;
|
1709
1864
|
};
|
1710
1865
|
declare type UpdateRecordWithIDQueryParams = {
|
1866
|
+
columns?: ColumnsProjection;
|
1711
1867
|
ifVersion?: number;
|
1712
1868
|
};
|
1713
1869
|
declare type UpdateRecordWithIDError = ErrorWrapper<{
|
@@ -1736,6 +1892,7 @@ declare type UpsertRecordWithIDPathParams = {
|
|
1736
1892
|
workspace: string;
|
1737
1893
|
};
|
1738
1894
|
declare type UpsertRecordWithIDQueryParams = {
|
1895
|
+
columns?: ColumnsProjection;
|
1739
1896
|
ifVersion?: number;
|
1740
1897
|
};
|
1741
1898
|
declare type UpsertRecordWithIDError = ErrorWrapper<{
|
@@ -1763,6 +1920,9 @@ declare type DeleteRecordPathParams = {
|
|
1763
1920
|
recordId: RecordID;
|
1764
1921
|
workspace: string;
|
1765
1922
|
};
|
1923
|
+
declare type DeleteRecordQueryParams = {
|
1924
|
+
columns?: ColumnsProjection;
|
1925
|
+
};
|
1766
1926
|
declare type DeleteRecordError = ErrorWrapper<{
|
1767
1927
|
status: 400;
|
1768
1928
|
payload: BadRequestError;
|
@@ -1775,14 +1935,18 @@ declare type DeleteRecordError = ErrorWrapper<{
|
|
1775
1935
|
}>;
|
1776
1936
|
declare type DeleteRecordVariables = {
|
1777
1937
|
pathParams: DeleteRecordPathParams;
|
1938
|
+
queryParams?: DeleteRecordQueryParams;
|
1778
1939
|
} & FetcherExtraProps;
|
1779
|
-
declare const deleteRecord: (variables: DeleteRecordVariables) => Promise<
|
1940
|
+
declare const deleteRecord: (variables: DeleteRecordVariables) => Promise<XataRecord$1>;
|
1780
1941
|
declare type GetRecordPathParams = {
|
1781
1942
|
dbBranchName: DBBranchName;
|
1782
1943
|
tableName: TableName;
|
1783
1944
|
recordId: RecordID;
|
1784
1945
|
workspace: string;
|
1785
1946
|
};
|
1947
|
+
declare type GetRecordQueryParams = {
|
1948
|
+
columns?: ColumnsProjection;
|
1949
|
+
};
|
1786
1950
|
declare type GetRecordError = ErrorWrapper<{
|
1787
1951
|
status: 400;
|
1788
1952
|
payload: BadRequestError;
|
@@ -1793,12 +1957,9 @@ declare type GetRecordError = ErrorWrapper<{
|
|
1793
1957
|
status: 404;
|
1794
1958
|
payload: SimpleError;
|
1795
1959
|
}>;
|
1796
|
-
declare type GetRecordRequestBody = {
|
1797
|
-
columns?: ColumnsFilter;
|
1798
|
-
};
|
1799
1960
|
declare type GetRecordVariables = {
|
1800
|
-
body?: GetRecordRequestBody;
|
1801
1961
|
pathParams: GetRecordPathParams;
|
1962
|
+
queryParams?: GetRecordQueryParams;
|
1802
1963
|
} & FetcherExtraProps;
|
1803
1964
|
/**
|
1804
1965
|
* Retrieve record by ID
|
@@ -1809,6 +1970,9 @@ declare type BulkInsertTableRecordsPathParams = {
|
|
1809
1970
|
tableName: TableName;
|
1810
1971
|
workspace: string;
|
1811
1972
|
};
|
1973
|
+
declare type BulkInsertTableRecordsQueryParams = {
|
1974
|
+
columns?: ColumnsProjection;
|
1975
|
+
};
|
1812
1976
|
declare type BulkInsertTableRecordsError = ErrorWrapper<{
|
1813
1977
|
status: 400;
|
1814
1978
|
payload: BulkError;
|
@@ -1818,21 +1982,22 @@ declare type BulkInsertTableRecordsError = ErrorWrapper<{
|
|
1818
1982
|
} | {
|
1819
1983
|
status: 404;
|
1820
1984
|
payload: SimpleError;
|
1985
|
+
} | {
|
1986
|
+
status: 422;
|
1987
|
+
payload: SimpleError;
|
1821
1988
|
}>;
|
1822
|
-
declare type BulkInsertTableRecordsResponse = {
|
1823
|
-
recordIDs: string[];
|
1824
|
-
};
|
1825
1989
|
declare type BulkInsertTableRecordsRequestBody = {
|
1826
1990
|
records: Record<string, any>[];
|
1827
1991
|
};
|
1828
1992
|
declare type BulkInsertTableRecordsVariables = {
|
1829
1993
|
body: BulkInsertTableRecordsRequestBody;
|
1830
1994
|
pathParams: BulkInsertTableRecordsPathParams;
|
1995
|
+
queryParams?: BulkInsertTableRecordsQueryParams;
|
1831
1996
|
} & FetcherExtraProps;
|
1832
1997
|
/**
|
1833
1998
|
* Bulk insert records
|
1834
1999
|
*/
|
1835
|
-
declare const bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables) => Promise<
|
2000
|
+
declare const bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables) => Promise<BulkInsertResponse>;
|
1836
2001
|
declare type QueryTablePathParams = {
|
1837
2002
|
dbBranchName: DBBranchName;
|
1838
2003
|
tableName: TableName;
|
@@ -1852,7 +2017,7 @@ declare type QueryTableRequestBody = {
|
|
1852
2017
|
filter?: FilterExpression;
|
1853
2018
|
sort?: SortExpression;
|
1854
2019
|
page?: PageConfig;
|
1855
|
-
columns?:
|
2020
|
+
columns?: ColumnsProjection;
|
1856
2021
|
};
|
1857
2022
|
declare type QueryTableVariables = {
|
1858
2023
|
body?: QueryTableRequestBody;
|
@@ -2262,12 +2427,18 @@ declare type QueryTableVariables = {
|
|
2262
2427
|
* {
|
2263
2428
|
* "filter": {
|
2264
2429
|
* "<column_name>": {
|
2265
|
-
* "$pattern": "v*
|
2430
|
+
* "$pattern": "v*alu?"
|
2266
2431
|
* }
|
2267
2432
|
* }
|
2268
2433
|
* }
|
2269
2434
|
* ```
|
2270
2435
|
*
|
2436
|
+
* The `$pattern` operator accepts two wildcard characters:
|
2437
|
+
* * `*` matches zero or more characters
|
2438
|
+
* * `?` matches exactly one character
|
2439
|
+
*
|
2440
|
+
* If you want to match a string that contains a wildcard character, you can escape them using a backslash (`\`). You can escape a backslash by usign another backslash.
|
2441
|
+
*
|
2271
2442
|
* We could also have `$endsWith` and `$startsWith` operators:
|
2272
2443
|
*
|
2273
2444
|
* ```json
|
@@ -2574,6 +2745,41 @@ declare type QueryTableVariables = {
|
|
2574
2745
|
* ```
|
2575
2746
|
*/
|
2576
2747
|
declare const queryTable: (variables: QueryTableVariables) => Promise<QueryResponse>;
|
2748
|
+
declare type SearchTablePathParams = {
|
2749
|
+
dbBranchName: DBBranchName;
|
2750
|
+
tableName: TableName;
|
2751
|
+
workspace: string;
|
2752
|
+
};
|
2753
|
+
declare type SearchTableError = ErrorWrapper<{
|
2754
|
+
status: 400;
|
2755
|
+
payload: BadRequestError;
|
2756
|
+
} | {
|
2757
|
+
status: 401;
|
2758
|
+
payload: AuthError;
|
2759
|
+
} | {
|
2760
|
+
status: 404;
|
2761
|
+
payload: SimpleError;
|
2762
|
+
}>;
|
2763
|
+
declare type SearchTableRequestBody = {
|
2764
|
+
query: string;
|
2765
|
+
fuzziness?: FuzzinessExpression;
|
2766
|
+
prefix?: PrefixExpression;
|
2767
|
+
filter?: FilterExpression;
|
2768
|
+
highlight?: HighlightExpression;
|
2769
|
+
boosters?: BoosterExpression[];
|
2770
|
+
};
|
2771
|
+
declare type SearchTableVariables = {
|
2772
|
+
body: SearchTableRequestBody;
|
2773
|
+
pathParams: SearchTablePathParams;
|
2774
|
+
} & FetcherExtraProps;
|
2775
|
+
/**
|
2776
|
+
* Run a free text search operation in a particular table.
|
2777
|
+
*
|
2778
|
+
* The endpoint accepts a `query` parameter that is used for the free text search and a set of structured filters (via the `filter` parameter) that are applied before the search. The `filter` parameter uses the same syntax as the [query endpoint](/api-reference/db/db_branch_name/tables/table_name/) with the following exceptions:
|
2779
|
+
* * filters `$contains`, `$startsWith`, `$endsWith` don't work on columns of type `text`
|
2780
|
+
* * filtering on columns of type `multiple` is currently unsupported
|
2781
|
+
*/
|
2782
|
+
declare const searchTable: (variables: SearchTableVariables) => Promise<SearchResponse>;
|
2577
2783
|
declare type SearchBranchPathParams = {
|
2578
2784
|
dbBranchName: DBBranchName;
|
2579
2785
|
workspace: string;
|
@@ -2589,9 +2795,14 @@ declare type SearchBranchError = ErrorWrapper<{
|
|
2589
2795
|
payload: SimpleError;
|
2590
2796
|
}>;
|
2591
2797
|
declare type SearchBranchRequestBody = {
|
2592
|
-
tables?: string
|
2798
|
+
tables?: (string | {
|
2799
|
+
table: string;
|
2800
|
+
filter?: FilterExpression;
|
2801
|
+
boosters?: BoosterExpression[];
|
2802
|
+
})[];
|
2593
2803
|
query: string;
|
2594
|
-
fuzziness?:
|
2804
|
+
fuzziness?: FuzzinessExpression;
|
2805
|
+
highlight?: HighlightExpression;
|
2595
2806
|
};
|
2596
2807
|
declare type SearchBranchVariables = {
|
2597
2808
|
body: SearchBranchRequestBody;
|
@@ -2620,6 +2831,7 @@ declare const operationsByTag: {
|
|
2620
2831
|
updateWorkspaceMemberRole: (variables: UpdateWorkspaceMemberRoleVariables) => Promise<undefined>;
|
2621
2832
|
removeWorkspaceMember: (variables: RemoveWorkspaceMemberVariables) => Promise<undefined>;
|
2622
2833
|
inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables) => Promise<WorkspaceInvite>;
|
2834
|
+
updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables) => Promise<WorkspaceInvite>;
|
2623
2835
|
cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables) => Promise<undefined>;
|
2624
2836
|
resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables) => Promise<undefined>;
|
2625
2837
|
acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables) => Promise<undefined>;
|
@@ -2628,6 +2840,7 @@ declare const operationsByTag: {
|
|
2628
2840
|
getDatabaseList: (variables: GetDatabaseListVariables) => Promise<ListDatabasesResponse>;
|
2629
2841
|
createDatabase: (variables: CreateDatabaseVariables) => Promise<CreateDatabaseResponse>;
|
2630
2842
|
deleteDatabase: (variables: DeleteDatabaseVariables) => Promise<undefined>;
|
2843
|
+
getDatabaseMetadata: (variables: GetDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
|
2631
2844
|
getGitBranchesMapping: (variables: GetGitBranchesMappingVariables) => Promise<ListGitBranchesResponse>;
|
2632
2845
|
addGitBranchesEntry: (variables: AddGitBranchesEntryVariables) => Promise<AddGitBranchesEntryResponse>;
|
2633
2846
|
removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables) => Promise<undefined>;
|
@@ -2636,7 +2849,7 @@ declare const operationsByTag: {
|
|
2636
2849
|
branch: {
|
2637
2850
|
getBranchList: (variables: GetBranchListVariables) => Promise<ListBranchesResponse>;
|
2638
2851
|
getBranchDetails: (variables: GetBranchDetailsVariables) => Promise<DBBranch>;
|
2639
|
-
createBranch: (variables: CreateBranchVariables) => Promise<
|
2852
|
+
createBranch: (variables: CreateBranchVariables) => Promise<CreateBranchResponse>;
|
2640
2853
|
deleteBranch: (variables: DeleteBranchVariables) => Promise<undefined>;
|
2641
2854
|
updateBranchMetadata: (variables: UpdateBranchMetadataVariables) => Promise<undefined>;
|
2642
2855
|
getBranchMetadata: (variables: GetBranchMetadataVariables) => Promise<BranchMetadata>;
|
@@ -2646,7 +2859,7 @@ declare const operationsByTag: {
|
|
2646
2859
|
getBranchStats: (variables: GetBranchStatsVariables) => Promise<GetBranchStatsResponse>;
|
2647
2860
|
};
|
2648
2861
|
table: {
|
2649
|
-
createTable: (variables: CreateTableVariables) => Promise<
|
2862
|
+
createTable: (variables: CreateTableVariables) => Promise<CreateTableResponse>;
|
2650
2863
|
deleteTable: (variables: DeleteTableVariables) => Promise<undefined>;
|
2651
2864
|
updateTable: (variables: UpdateTableVariables) => Promise<undefined>;
|
2652
2865
|
getTableSchema: (variables: GetTableSchemaVariables) => Promise<GetTableSchemaResponse>;
|
@@ -2658,14 +2871,15 @@ declare const operationsByTag: {
|
|
2658
2871
|
updateColumn: (variables: UpdateColumnVariables) => Promise<MigrationIdResponse>;
|
2659
2872
|
};
|
2660
2873
|
records: {
|
2661
|
-
insertRecord: (variables: InsertRecordVariables) => Promise<
|
2874
|
+
insertRecord: (variables: InsertRecordVariables) => Promise<RecordUpdateResponse>;
|
2662
2875
|
insertRecordWithID: (variables: InsertRecordWithIDVariables) => Promise<RecordUpdateResponse>;
|
2663
2876
|
updateRecordWithID: (variables: UpdateRecordWithIDVariables) => Promise<RecordUpdateResponse>;
|
2664
2877
|
upsertRecordWithID: (variables: UpsertRecordWithIDVariables) => Promise<RecordUpdateResponse>;
|
2665
|
-
deleteRecord: (variables: DeleteRecordVariables) => Promise<
|
2878
|
+
deleteRecord: (variables: DeleteRecordVariables) => Promise<XataRecord$1>;
|
2666
2879
|
getRecord: (variables: GetRecordVariables) => Promise<XataRecord$1>;
|
2667
|
-
bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables) => Promise<
|
2880
|
+
bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables) => Promise<BulkInsertResponse>;
|
2668
2881
|
queryTable: (variables: QueryTableVariables) => Promise<QueryResponse>;
|
2882
|
+
searchTable: (variables: SearchTableVariables) => Promise<SearchResponse>;
|
2669
2883
|
searchBranch: (variables: SearchBranchVariables) => Promise<SearchResponse>;
|
2670
2884
|
};
|
2671
2885
|
};
|
@@ -2717,6 +2931,7 @@ declare class WorkspaceApi {
|
|
2717
2931
|
updateWorkspaceMemberRole(workspaceId: WorkspaceID, userId: UserID, role: Role): Promise<void>;
|
2718
2932
|
removeWorkspaceMember(workspaceId: WorkspaceID, userId: UserID): Promise<void>;
|
2719
2933
|
inviteWorkspaceMember(workspaceId: WorkspaceID, email: string, role: Role): Promise<WorkspaceInvite>;
|
2934
|
+
updateWorkspaceMemberInvite(workspaceId: WorkspaceID, inviteId: InviteID, role: Role): Promise<WorkspaceInvite>;
|
2720
2935
|
cancelWorkspaceMemberInvite(workspaceId: WorkspaceID, inviteId: InviteID): Promise<void>;
|
2721
2936
|
resendWorkspaceMemberInvite(workspaceId: WorkspaceID, inviteId: InviteID): Promise<void>;
|
2722
2937
|
acceptWorkspaceMemberInvite(workspaceId: WorkspaceID, inviteKey: InviteKey): Promise<void>;
|
@@ -2727,17 +2942,18 @@ declare class DatabaseApi {
|
|
2727
2942
|
getDatabaseList(workspace: WorkspaceID): Promise<ListDatabasesResponse>;
|
2728
2943
|
createDatabase(workspace: WorkspaceID, dbName: DBName, options?: CreateDatabaseRequestBody): Promise<CreateDatabaseResponse>;
|
2729
2944
|
deleteDatabase(workspace: WorkspaceID, dbName: DBName): Promise<void>;
|
2945
|
+
getDatabaseMetadata(workspace: WorkspaceID, dbName: DBName): Promise<DatabaseMetadata>;
|
2730
2946
|
getGitBranchesMapping(workspace: WorkspaceID, dbName: DBName): Promise<ListGitBranchesResponse>;
|
2731
2947
|
addGitBranchesEntry(workspace: WorkspaceID, dbName: DBName, body: AddGitBranchesEntryRequestBody): Promise<AddGitBranchesEntryResponse>;
|
2732
2948
|
removeGitBranchesEntry(workspace: WorkspaceID, dbName: DBName, gitBranch: string): Promise<void>;
|
2733
|
-
resolveBranch(workspace: WorkspaceID, dbName: DBName, gitBranch
|
2949
|
+
resolveBranch(workspace: WorkspaceID, dbName: DBName, gitBranch?: string, fallbackBranch?: string): Promise<ResolveBranchResponse>;
|
2734
2950
|
}
|
2735
2951
|
declare class BranchApi {
|
2736
2952
|
private extraProps;
|
2737
2953
|
constructor(extraProps: FetcherExtraProps);
|
2738
2954
|
getBranchList(workspace: WorkspaceID, dbName: DBName): Promise<ListBranchesResponse>;
|
2739
2955
|
getBranchDetails(workspace: WorkspaceID, database: DBName, branch: BranchName): Promise<DBBranch>;
|
2740
|
-
createBranch(workspace: WorkspaceID, database: DBName, branch: BranchName, from?: string, options?: CreateBranchRequestBody): Promise<
|
2956
|
+
createBranch(workspace: WorkspaceID, database: DBName, branch: BranchName, from?: string, options?: CreateBranchRequestBody): Promise<CreateBranchResponse>;
|
2741
2957
|
deleteBranch(workspace: WorkspaceID, database: DBName, branch: BranchName): Promise<void>;
|
2742
2958
|
updateBranchMetadata(workspace: WorkspaceID, database: DBName, branch: BranchName, metadata?: BranchMetadata): Promise<void>;
|
2743
2959
|
getBranchMetadata(workspace: WorkspaceID, database: DBName, branch: BranchName): Promise<BranchMetadata>;
|
@@ -2749,7 +2965,7 @@ declare class BranchApi {
|
|
2749
2965
|
declare class TableApi {
|
2750
2966
|
private extraProps;
|
2751
2967
|
constructor(extraProps: FetcherExtraProps);
|
2752
|
-
createTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName): Promise<
|
2968
|
+
createTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName): Promise<CreateTableResponse>;
|
2753
2969
|
deleteTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName): Promise<void>;
|
2754
2970
|
updateTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, options: UpdateTableRequestBody): Promise<void>;
|
2755
2971
|
getTableSchema(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName): Promise<GetTableSchemaResponse>;
|
@@ -2763,14 +2979,15 @@ declare class TableApi {
|
|
2763
2979
|
declare class RecordsApi {
|
2764
2980
|
private extraProps;
|
2765
2981
|
constructor(extraProps: FetcherExtraProps);
|
2766
|
-
insertRecord(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, record: Record<string, any
|
2982
|
+
insertRecord(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, record: Record<string, any>, options?: InsertRecordQueryParams): Promise<RecordUpdateResponse>;
|
2767
2983
|
insertRecordWithID(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID, record: Record<string, any>, options?: InsertRecordWithIDQueryParams): Promise<RecordUpdateResponse>;
|
2768
2984
|
updateRecordWithID(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID, record: Record<string, any>, options?: UpdateRecordWithIDQueryParams): Promise<RecordUpdateResponse>;
|
2769
2985
|
upsertRecordWithID(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID, record: Record<string, any>, options?: UpsertRecordWithIDQueryParams): Promise<RecordUpdateResponse>;
|
2770
|
-
deleteRecord(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID): Promise<
|
2771
|
-
getRecord(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID, options?:
|
2772
|
-
bulkInsertTableRecords(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, records: Record<string, any>[]): Promise<
|
2986
|
+
deleteRecord(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID, options?: DeleteRecordQueryParams): Promise<RecordUpdateResponse>;
|
2987
|
+
getRecord(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID, options?: GetRecordQueryParams): Promise<XataRecord$1>;
|
2988
|
+
bulkInsertTableRecords(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, records: Record<string, any>[], options?: BulkInsertTableRecordsQueryParams): Promise<BulkInsertResponse>;
|
2773
2989
|
queryTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: QueryTableRequestBody): Promise<QueryResponse>;
|
2990
|
+
searchTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: SearchTableRequestBody): Promise<SearchResponse>;
|
2774
2991
|
searchBranch(workspace: WorkspaceID, database: DBName, branch: BranchName, query: SearchBranchRequestBody): Promise<SearchResponse>;
|
2775
2992
|
}
|
2776
2993
|
|
@@ -2784,28 +3001,29 @@ declare type UnionToIntersection<T> = (T extends any ? (x: T) => any : never) ex
|
|
2784
3001
|
declare type If<Condition, Then, Else> = Condition extends true ? Then : Else;
|
2785
3002
|
declare type IsObject<T> = T extends Record<string, any> ? true : false;
|
2786
3003
|
declare type IsArray<T> = T extends Array<any> ? true : false;
|
2787
|
-
declare type NonEmptyArray<T> = T[] & {
|
2788
|
-
0: T;
|
2789
|
-
};
|
2790
3004
|
declare type RequiredBy<T, K extends keyof T> = T & {
|
2791
3005
|
[P in K]-?: NonNullable<T[P]>;
|
2792
3006
|
};
|
2793
3007
|
declare type GetArrayInnerType<T extends readonly any[]> = T[number];
|
2794
3008
|
declare type SingleOrArray<T> = T | T[];
|
2795
3009
|
declare type OmitBy<T, K extends keyof T> = T extends any ? Omit<T, K> : never;
|
3010
|
+
declare type Without<T, U> = {
|
3011
|
+
[P in Exclude<keyof T, keyof U>]?: never;
|
3012
|
+
};
|
3013
|
+
declare type ExclusiveOr<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
|
2796
3014
|
|
2797
3015
|
declare type SelectableColumn<O, RecursivePath extends any[] = []> = '*' | 'id' | DataProps<O> | NestedColumns<O, RecursivePath>;
|
2798
|
-
declare type SelectedPick<O extends XataRecord, Key extends SelectableColumn<O>[]> = XataRecord & UnionToIntersection<Values<{
|
2799
|
-
[K in Key[number]]: NestedValueAtColumn<O, K> & XataRecord
|
3016
|
+
declare type SelectedPick<O extends XataRecord, Key extends SelectableColumn<O>[]> = XataRecord<O> & UnionToIntersection<Values<{
|
3017
|
+
[K in Key[number]]: NestedValueAtColumn<O, K> & XataRecord<O>;
|
2800
3018
|
}>>;
|
2801
|
-
declare type ValueAtColumn<O, P extends SelectableColumn<O>> = P extends '*' ? Values<O> : P extends 'id' ? string : P extends keyof O ? O[P] : P extends `${infer K}.${infer V}` ? K extends keyof O ? Values<O[K] extends
|
2802
|
-
V: ValueAtColumn<
|
2803
|
-
} : never
|
3019
|
+
declare type ValueAtColumn<O, P extends SelectableColumn<O>> = P extends '*' ? Values<O> : P extends 'id' ? string : P extends keyof O ? O[P] : P extends `${infer K}.${infer V}` ? K extends keyof O ? Values<NonNullable<O[K]> extends infer Item ? Item extends Record<string, any> ? V extends SelectableColumn<Item> ? {
|
3020
|
+
V: ValueAtColumn<Item, V>;
|
3021
|
+
} : never : O[K] : never> : never : never;
|
2804
3022
|
declare type MAX_RECURSION = 5;
|
2805
3023
|
declare type NestedColumns<O, RecursivePath extends any[]> = RecursivePath['length'] extends MAX_RECURSION ? never : If<IsObject<O>, Values<{
|
2806
|
-
[K in DataProps<O>]:
|
2807
|
-
If<IsObject<
|
2808
|
-
K
|
3024
|
+
[K in DataProps<O>]: NonNullable<O[K]> extends infer Item ? If<IsArray<Item>, K, // If the property is an array, we stop recursion. We don't support object arrays yet
|
3025
|
+
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
|
3026
|
+
K>> : never;
|
2809
3027
|
}>, never>;
|
2810
3028
|
declare type DataProps<O> = Exclude<StringKeys<O>, StringKeys<XataRecord>>;
|
2811
3029
|
declare type NestedValueAtColumn<O, Key extends SelectableColumn<O>> = Key extends `${infer N}.${infer M}` ? N extends DataProps<O> ? {
|
@@ -2832,27 +3050,37 @@ interface BaseData {
|
|
2832
3050
|
/**
|
2833
3051
|
* Represents a persisted record from the database.
|
2834
3052
|
*/
|
2835
|
-
interface XataRecord extends Identifiable {
|
3053
|
+
interface XataRecord<OriginalRecord extends XataRecord<any> = XataRecord<any>> extends Identifiable {
|
2836
3054
|
/**
|
2837
|
-
*
|
3055
|
+
* Get metadata of this record.
|
2838
3056
|
*/
|
2839
|
-
|
2840
|
-
/**
|
2841
|
-
* Number that is increased every time the record is updated.
|
2842
|
-
*/
|
2843
|
-
version: number;
|
2844
|
-
};
|
3057
|
+
getMetadata(): XataRecordMetadata;
|
2845
3058
|
/**
|
2846
3059
|
* Retrieves a refreshed copy of the current record from the database.
|
3060
|
+
* @param columns The columns to retrieve. If not specified, all first level properties are retrieved.
|
3061
|
+
* @returns The persisted record with the selected columns.
|
2847
3062
|
*/
|
2848
|
-
read(): Promise<Readonly<SelectedPick<
|
3063
|
+
read<K extends SelectableColumn<OriginalRecord>>(columns: K[]): Promise<Readonly<SelectedPick<OriginalRecord, typeof columns>> | null>;
|
3064
|
+
/**
|
3065
|
+
* Retrieves a refreshed copy of the current record from the database.
|
3066
|
+
* @returns The persisted record with all first level properties.
|
3067
|
+
*/
|
3068
|
+
read(): Promise<Readonly<SelectedPick<OriginalRecord, ['*']>> | null>;
|
2849
3069
|
/**
|
2850
3070
|
* Performs a partial update of the current record. On success a new object is
|
2851
3071
|
* returned and the current object is not mutated.
|
2852
|
-
* @param
|
2853
|
-
* @
|
3072
|
+
* @param partialUpdate The columns and their values that have to be updated.
|
3073
|
+
* @param columns The columns to retrieve. If not specified, all first level properties are retrieved.
|
3074
|
+
* @returns The persisted record with the selected columns.
|
3075
|
+
*/
|
3076
|
+
update<K extends SelectableColumn<OriginalRecord>>(partialUpdate: Partial<EditableData<Omit<OriginalRecord, keyof XataRecord>>>, columns: K[]): Promise<Readonly<SelectedPick<OriginalRecord, typeof columns>>>;
|
3077
|
+
/**
|
3078
|
+
* Performs a partial update of the current record. On success a new object is
|
3079
|
+
* returned and the current object is not mutated.
|
3080
|
+
* @param partialUpdate The columns and their values that have to be updated.
|
3081
|
+
* @returns The persisted record with all first level properties.
|
2854
3082
|
*/
|
2855
|
-
update(partialUpdate: Partial<EditableData<Omit<
|
3083
|
+
update(partialUpdate: Partial<EditableData<Omit<OriginalRecord, keyof XataRecord>>>): Promise<Readonly<SelectedPick<OriginalRecord, ['*']>>>;
|
2856
3084
|
/**
|
2857
3085
|
* Performs a deletion of the current record in the database.
|
2858
3086
|
*
|
@@ -2864,23 +3092,36 @@ declare type Link<Record extends XataRecord> = Omit<XataRecord, 'read' | 'update
|
|
2864
3092
|
/**
|
2865
3093
|
* Retrieves a refreshed copy of the current record from the database.
|
2866
3094
|
*/
|
2867
|
-
read(): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
|
3095
|
+
read<K extends SelectableColumn<Record>>(columns?: K[]): Promise<Readonly<SelectedPick<Record, typeof columns extends SelectableColumn<Record>[] ? typeof columns : ['*']>> | null>;
|
2868
3096
|
/**
|
2869
3097
|
* Performs a partial update of the current record. On success a new object is
|
2870
3098
|
* returned and the current object is not mutated.
|
2871
|
-
* @param
|
3099
|
+
* @param partialUpdate The columns and their values that have to be updated.
|
2872
3100
|
* @returns A new record containing the latest values for all the columns of the current record.
|
2873
3101
|
*/
|
2874
|
-
update(partialUpdate: Partial<EditableData<Omit<Record, keyof XataRecord
|
3102
|
+
update<K extends SelectableColumn<Record>>(partialUpdate: Partial<EditableData<Omit<Record, keyof XataRecord>>>, columns?: K[]): Promise<Readonly<SelectedPick<Record, typeof columns extends SelectableColumn<Record>[] ? typeof columns : ['*']>>>;
|
3103
|
+
/**
|
3104
|
+
* Performs a deletion of the current record in the database.
|
3105
|
+
*
|
3106
|
+
* @throws If the record was already deleted or if an error happened while performing the deletion.
|
3107
|
+
*/
|
3108
|
+
delete(): Promise<void>;
|
3109
|
+
};
|
3110
|
+
declare type XataRecordMetadata = {
|
3111
|
+
/**
|
3112
|
+
* Number that is increased every time the record is updated.
|
3113
|
+
*/
|
3114
|
+
version: number;
|
3115
|
+
warnings?: string[];
|
2875
3116
|
};
|
2876
3117
|
declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
|
2877
3118
|
declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;
|
2878
3119
|
declare type EditableData<O extends BaseData> = {
|
2879
3120
|
[K in keyof O]: O[K] extends XataRecord ? {
|
2880
3121
|
id: string;
|
2881
|
-
} : NonNullable<O[K]> extends XataRecord ? {
|
3122
|
+
} | string : NonNullable<O[K]> extends XataRecord ? {
|
2882
3123
|
id: string;
|
2883
|
-
} | null | undefined : O[K];
|
3124
|
+
} | string | null | undefined : O[K];
|
2884
3125
|
};
|
2885
3126
|
|
2886
3127
|
/**
|
@@ -2956,8 +3197,8 @@ declare type ValueTypeFilters<T> = T | T extends string ? StringTypeFilter : T e
|
|
2956
3197
|
],
|
2957
3198
|
}
|
2958
3199
|
*/
|
2959
|
-
declare type AggregatorFilter<
|
2960
|
-
[key in '$all' | '$any' | '$not' | '$none']?: SingleOrArray<Filter<
|
3200
|
+
declare type AggregatorFilter<T> = {
|
3201
|
+
[key in '$all' | '$any' | '$not' | '$none']?: SingleOrArray<Filter<T>>;
|
2961
3202
|
};
|
2962
3203
|
/**
|
2963
3204
|
* Existance filter
|
@@ -2972,10 +3213,88 @@ declare type BaseApiFilter<Record> = PropertyAccessFilter<Record> | AggregatorFi
|
|
2972
3213
|
* Injects the Api filters on nested properties
|
2973
3214
|
* Example: { filter: { settings: { plan: { $any: ['free', 'trial'] } } } }
|
2974
3215
|
*/
|
2975
|
-
declare type NestedApiFilter<T> =
|
3216
|
+
declare type NestedApiFilter<T> = {
|
2976
3217
|
[key in keyof T]?: T[key] extends Record<string, any> ? SingleOrArray<Filter<T[key]>> : PropertyFilter<T[key]>;
|
2977
|
-
}
|
2978
|
-
declare type Filter<
|
3218
|
+
};
|
3219
|
+
declare type Filter<T> = T extends Record<string, any> ? BaseApiFilter<T> | NestedApiFilter<T> : PropertyFilter<T>;
|
3220
|
+
|
3221
|
+
declare type DateBooster = {
|
3222
|
+
origin?: string;
|
3223
|
+
scale: string;
|
3224
|
+
decay: number;
|
3225
|
+
};
|
3226
|
+
declare type NumericBooster = {
|
3227
|
+
factor: number;
|
3228
|
+
};
|
3229
|
+
declare type ValueBooster<T extends string | number | boolean> = {
|
3230
|
+
value: T;
|
3231
|
+
factor: number;
|
3232
|
+
};
|
3233
|
+
declare type Boosters<O extends XataRecord> = Values<{
|
3234
|
+
[K in SelectableColumn<O>]: NonNullable<ValueAtColumn<O, K>> extends Date ? {
|
3235
|
+
dateBooster: {
|
3236
|
+
column: K;
|
3237
|
+
} & DateBooster;
|
3238
|
+
} : NonNullable<ValueAtColumn<O, K>> extends number ? ExclusiveOr<{
|
3239
|
+
numericBooster?: {
|
3240
|
+
column: K;
|
3241
|
+
} & NumericBooster;
|
3242
|
+
}, {
|
3243
|
+
valueBooster?: {
|
3244
|
+
column: K;
|
3245
|
+
} & ValueBooster<number>;
|
3246
|
+
}> : NonNullable<ValueAtColumn<O, K>> extends string | boolean ? {
|
3247
|
+
valueBooster: {
|
3248
|
+
column: K;
|
3249
|
+
} & ValueBooster<NonNullable<ValueAtColumn<O, K>>>;
|
3250
|
+
} : never;
|
3251
|
+
}>;
|
3252
|
+
|
3253
|
+
declare type SearchOptions<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = {
|
3254
|
+
fuzziness?: FuzzinessExpression;
|
3255
|
+
prefix?: PrefixExpression;
|
3256
|
+
highlight?: HighlightExpression;
|
3257
|
+
tables?: Array<Tables | Values<{
|
3258
|
+
[Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
|
3259
|
+
table: Model;
|
3260
|
+
filter?: Filter<SelectedPick<Schemas[Model] & XataRecord, ['*']>>;
|
3261
|
+
boosters?: Boosters<Schemas[Model] & XataRecord>[];
|
3262
|
+
};
|
3263
|
+
}>>;
|
3264
|
+
};
|
3265
|
+
declare type SearchPluginResult<Schemas extends Record<string, BaseData>> = {
|
3266
|
+
all: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<Values<{
|
3267
|
+
[Model in ExtractTables<Schemas, Tables, GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>>]: {
|
3268
|
+
table: Model;
|
3269
|
+
record: Awaited<SearchXataRecord<SelectedPick<Schemas[Model] & XataRecord, ['*']>>>;
|
3270
|
+
};
|
3271
|
+
}>[]>;
|
3272
|
+
byTable: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<{
|
3273
|
+
[Model in ExtractTables<Schemas, Tables, GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>>]?: Awaited<SearchXataRecord<SelectedPick<Schemas[Model] & XataRecord, ['*']>>[]>;
|
3274
|
+
}>;
|
3275
|
+
};
|
3276
|
+
declare class SearchPlugin<Schemas extends Record<string, BaseData>> extends XataPlugin {
|
3277
|
+
#private;
|
3278
|
+
private db;
|
3279
|
+
constructor(db: SchemaPluginResult<Schemas>, schemaTables?: Schemas.Table[]);
|
3280
|
+
build({ getFetchProps }: XataPluginOptions): SearchPluginResult<Schemas>;
|
3281
|
+
}
|
3282
|
+
declare type SearchXataRecord<Record extends XataRecord> = Omit<Record, 'getMetadata'> & {
|
3283
|
+
getMetadata: () => XataRecordMetadata & SearchExtraProperties;
|
3284
|
+
};
|
3285
|
+
declare type SearchExtraProperties = {
|
3286
|
+
table: string;
|
3287
|
+
highlight?: {
|
3288
|
+
[key: string]: string[] | {
|
3289
|
+
[key: string]: any;
|
3290
|
+
};
|
3291
|
+
};
|
3292
|
+
score?: number;
|
3293
|
+
};
|
3294
|
+
declare type ReturnTable<Table, Tables> = Table extends Tables ? Table : never;
|
3295
|
+
declare type ExtractTables<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>, TableOptions extends GetArrayInnerType<NonNullable<NonNullable<SearchOptions<Schemas, Tables>>['tables']>>> = TableOptions extends `${infer Table}` ? ReturnTable<Table, Tables> : TableOptions extends {
|
3296
|
+
table: infer Table;
|
3297
|
+
} ? ReturnTable<Table, Tables> : never;
|
2979
3298
|
|
2980
3299
|
declare type SortDirection = 'asc' | 'desc';
|
2981
3300
|
declare type SortFilterExtended<T extends XataRecord> = {
|
@@ -2988,7 +3307,7 @@ declare type SortFilterBase<T extends XataRecord> = {
|
|
2988
3307
|
};
|
2989
3308
|
|
2990
3309
|
declare type BaseOptions<T extends XataRecord> = {
|
2991
|
-
columns?:
|
3310
|
+
columns?: SelectableColumn<T>[];
|
2992
3311
|
cache?: number;
|
2993
3312
|
};
|
2994
3313
|
declare type CursorQueryOptions = {
|
@@ -3011,8 +3330,8 @@ declare type QueryOptions<T extends XataRecord> = BaseOptions<T> & (CursorQueryO
|
|
3011
3330
|
declare class Query<Record extends XataRecord, Result extends XataRecord = Record> implements Paginable<Record, Result> {
|
3012
3331
|
#private;
|
3013
3332
|
readonly meta: PaginationQueryMeta;
|
3014
|
-
readonly records: Result
|
3015
|
-
constructor(repository: Repository<Record> | null, table: string, data: Partial<QueryOptions<Record>>,
|
3333
|
+
readonly records: RecordArray<Result>;
|
3334
|
+
constructor(repository: Repository<Record> | null, table: string, data: Partial<QueryOptions<Record>>, rawParent?: Partial<QueryOptions<Record>>);
|
3016
3335
|
getQueryOptions(): QueryOptions<Record>;
|
3017
3336
|
key(): string;
|
3018
3337
|
/**
|
@@ -3044,18 +3363,28 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
3044
3363
|
*
|
3045
3364
|
* ```
|
3046
3365
|
* query.filter("columnName", columnValue)
|
3047
|
-
* query.filter(
|
3048
|
-
*
|
3049
|
-
*
|
3366
|
+
* query.filter("columnName", operator(columnValue)) // Use gt, gte, lt, lte, startsWith,...
|
3367
|
+
* ```
|
3368
|
+
*
|
3369
|
+
* @param column The name of the column to filter.
|
3370
|
+
* @param value The value to filter.
|
3371
|
+
* @returns A new Query object.
|
3372
|
+
*/
|
3373
|
+
filter<F extends SelectableColumn<Record>>(column: F, value: Filter<ValueAtColumn<Record, F>>): Query<Record, Result>;
|
3374
|
+
/**
|
3375
|
+
* Builds a new query object adding one or more constraints. Examples:
|
3376
|
+
*
|
3377
|
+
* ```
|
3378
|
+
* query.filter({ "columnName": columnValue })
|
3050
3379
|
* query.filter({
|
3051
3380
|
* "columnName": operator(columnValue) // Use gt, gte, lt, lte, startsWith,...
|
3052
3381
|
* })
|
3053
3382
|
* ```
|
3054
3383
|
*
|
3384
|
+
* @param filters A filter object
|
3055
3385
|
* @returns A new Query object.
|
3056
3386
|
*/
|
3057
3387
|
filter(filters: Filter<Record>): Query<Record, Result>;
|
3058
|
-
filter<F extends SelectableColumn<Record>>(column: F, value: Filter<ValueAtColumn<Record, F>>): Query<Record, Result>;
|
3059
3388
|
/**
|
3060
3389
|
* Builds a new query with a new sort option.
|
3061
3390
|
* @param column The column name.
|
@@ -3068,57 +3397,149 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
3068
3397
|
* @param columns Array of column names to be returned by the query.
|
3069
3398
|
* @returns A new Query object.
|
3070
3399
|
*/
|
3071
|
-
select<K extends SelectableColumn<Record>>(columns:
|
3400
|
+
select<K extends SelectableColumn<Record>>(columns: K[]): Query<Record, SelectedPick<Record, K[]>>;
|
3401
|
+
/**
|
3402
|
+
* Get paginated results
|
3403
|
+
*
|
3404
|
+
* @returns A page of results
|
3405
|
+
*/
|
3072
3406
|
getPaginated(): Promise<Page<Record, Result>>;
|
3407
|
+
/**
|
3408
|
+
* Get paginated results
|
3409
|
+
*
|
3410
|
+
* @param options Pagination options
|
3411
|
+
* @returns A page of results
|
3412
|
+
*/
|
3073
3413
|
getPaginated(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<Page<Record, Result>>;
|
3414
|
+
/**
|
3415
|
+
* Get paginated results
|
3416
|
+
*
|
3417
|
+
* @param options Pagination options
|
3418
|
+
* @returns A page of results
|
3419
|
+
*/
|
3074
3420
|
getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, typeof options['columns']>>>;
|
3421
|
+
/**
|
3422
|
+
* Get results in an iterator
|
3423
|
+
*
|
3424
|
+
* @async
|
3425
|
+
* @returns Async interable of results
|
3426
|
+
*/
|
3075
3427
|
[Symbol.asyncIterator](): AsyncIterableIterator<Result>;
|
3428
|
+
/**
|
3429
|
+
* Build an iterator of results
|
3430
|
+
*
|
3431
|
+
* @returns Async generator of results array
|
3432
|
+
*/
|
3076
3433
|
getIterator(): AsyncGenerator<Result[]>;
|
3434
|
+
/**
|
3435
|
+
* Build an iterator of results
|
3436
|
+
*
|
3437
|
+
* @param options Pagination options with batchSize
|
3438
|
+
* @returns Async generator of results array
|
3439
|
+
*/
|
3077
3440
|
getIterator(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'> & {
|
3078
3441
|
batchSize?: number;
|
3079
3442
|
}): AsyncGenerator<Result[]>;
|
3443
|
+
/**
|
3444
|
+
* Build an iterator of results
|
3445
|
+
*
|
3446
|
+
* @param options Pagination options with batchSize
|
3447
|
+
* @returns Async generator of results array
|
3448
|
+
*/
|
3080
3449
|
getIterator<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
|
3081
3450
|
batchSize?: number;
|
3082
3451
|
}>(options: Options): AsyncGenerator<SelectedPick<Record, typeof options['columns']>[]>;
|
3452
|
+
/**
|
3453
|
+
* Performs the query in the database and returns a set of results.
|
3454
|
+
* @returns An array of records from the database.
|
3455
|
+
*/
|
3456
|
+
getMany(): Promise<RecordArray<Result>>;
|
3083
3457
|
/**
|
3084
3458
|
* Performs the query in the database and returns a set of results.
|
3085
3459
|
* @param options Additional options to be used when performing the query.
|
3086
3460
|
* @returns An array of records from the database.
|
3087
3461
|
*/
|
3088
|
-
getMany(): Promise<
|
3089
|
-
|
3090
|
-
|
3462
|
+
getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<RecordArray<SelectedPick<Record, typeof options['columns']>>>;
|
3463
|
+
/**
|
3464
|
+
* Performs the query in the database and returns a set of results.
|
3465
|
+
* @param options Additional options to be used when performing the query.
|
3466
|
+
* @returns An array of records from the database.
|
3467
|
+
*/
|
3468
|
+
getMany(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<RecordArray<Result>>;
|
3091
3469
|
/**
|
3092
3470
|
* Performs the query in the database and returns all the results.
|
3093
3471
|
* Warning: If there are a large number of results, this method can have performance implications.
|
3094
|
-
* @param options Additional options to be used when performing the query.
|
3095
3472
|
* @returns An array of records from the database.
|
3096
3473
|
*/
|
3097
3474
|
getAll(): Promise<Result[]>;
|
3098
|
-
|
3099
|
-
|
3100
|
-
|
3475
|
+
/**
|
3476
|
+
* Performs the query in the database and returns all the results.
|
3477
|
+
* Warning: If there are a large number of results, this method can have performance implications.
|
3478
|
+
* @param options Additional options to be used when performing the query.
|
3479
|
+
* @returns An array of records from the database.
|
3480
|
+
*/
|
3101
3481
|
getAll<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
|
3102
3482
|
batchSize?: number;
|
3103
3483
|
}>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
|
3104
3484
|
/**
|
3105
|
-
* Performs the query in the database and returns the
|
3485
|
+
* Performs the query in the database and returns all the results.
|
3486
|
+
* Warning: If there are a large number of results, this method can have performance implications.
|
3106
3487
|
* @param options Additional options to be used when performing the query.
|
3488
|
+
* @returns An array of records from the database.
|
3489
|
+
*/
|
3490
|
+
getAll(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'> & {
|
3491
|
+
batchSize?: number;
|
3492
|
+
}): Promise<Result[]>;
|
3493
|
+
/**
|
3494
|
+
* Performs the query in the database and returns the first result.
|
3107
3495
|
* @returns The first record that matches the query, or null if no record matched the query.
|
3108
3496
|
*/
|
3109
3497
|
getFirst(): Promise<Result | null>;
|
3110
|
-
|
3498
|
+
/**
|
3499
|
+
* Performs the query in the database and returns the first result.
|
3500
|
+
* @param options Additional options to be used when performing the query.
|
3501
|
+
* @returns The first record that matches the query, or null if no record matched the query.
|
3502
|
+
*/
|
3111
3503
|
getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']> | null>;
|
3504
|
+
/**
|
3505
|
+
* Performs the query in the database and returns the first result.
|
3506
|
+
* @param options Additional options to be used when performing the query.
|
3507
|
+
* @returns The first record that matches the query, or null if no record matched the query.
|
3508
|
+
*/
|
3509
|
+
getFirst(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'>): Promise<Result | null>;
|
3112
3510
|
/**
|
3113
3511
|
* Builds a new query object adding a cache TTL in milliseconds.
|
3114
3512
|
* @param ttl The cache TTL in milliseconds.
|
3115
3513
|
* @returns A new Query object.
|
3116
3514
|
*/
|
3117
3515
|
cache(ttl: number): Query<Record, Result>;
|
3516
|
+
/**
|
3517
|
+
* Retrieve next page of records
|
3518
|
+
*
|
3519
|
+
* @returns A new page object.
|
3520
|
+
*/
|
3118
3521
|
nextPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
3522
|
+
/**
|
3523
|
+
* Retrieve previous page of records
|
3524
|
+
*
|
3525
|
+
* @returns A new page object
|
3526
|
+
*/
|
3119
3527
|
previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
3528
|
+
/**
|
3529
|
+
* Retrieve first page of records
|
3530
|
+
*
|
3531
|
+
* @returns A new page object
|
3532
|
+
*/
|
3120
3533
|
firstPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
3534
|
+
/**
|
3535
|
+
* Retrieve last page of records
|
3536
|
+
*
|
3537
|
+
* @returns A new page object
|
3538
|
+
*/
|
3121
3539
|
lastPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
3540
|
+
/**
|
3541
|
+
* @returns Boolean indicating if there is a next page
|
3542
|
+
*/
|
3122
3543
|
hasNextPage(): boolean;
|
3123
3544
|
}
|
3124
3545
|
|
@@ -3130,7 +3551,7 @@ declare type PaginationQueryMeta = {
|
|
3130
3551
|
};
|
3131
3552
|
interface Paginable<Record extends XataRecord, Result extends XataRecord = Record> {
|
3132
3553
|
meta: PaginationQueryMeta;
|
3133
|
-
records: Result
|
3554
|
+
records: RecordArray<Result>;
|
3134
3555
|
nextPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
3135
3556
|
previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
3136
3557
|
firstPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
@@ -3150,7 +3571,7 @@ declare class Page<Record extends XataRecord, Result extends XataRecord = Record
|
|
3150
3571
|
/**
|
3151
3572
|
* The set of results for this page.
|
3152
3573
|
*/
|
3153
|
-
readonly records: Result
|
3574
|
+
readonly records: RecordArray<Result>;
|
3154
3575
|
constructor(query: Query<Record, Result>, meta: PaginationQueryMeta, records?: Result[]);
|
3155
3576
|
/**
|
3156
3577
|
* Retrieves the next page of results.
|
@@ -3199,40 +3620,153 @@ declare type OffsetNavigationOptions = {
|
|
3199
3620
|
offset?: number;
|
3200
3621
|
};
|
3201
3622
|
declare const PAGINATION_MAX_SIZE = 200;
|
3202
|
-
declare const PAGINATION_DEFAULT_SIZE =
|
3623
|
+
declare const PAGINATION_DEFAULT_SIZE = 20;
|
3203
3624
|
declare const PAGINATION_MAX_OFFSET = 800;
|
3204
3625
|
declare const PAGINATION_DEFAULT_OFFSET = 0;
|
3626
|
+
declare function isCursorPaginationOptions(options: Record<string, unknown> | undefined | null): options is CursorNavigationOptions;
|
3627
|
+
declare class RecordArray<Result extends XataRecord> extends Array<Result> {
|
3628
|
+
#private;
|
3629
|
+
constructor(page: Paginable<any, Result>, overrideRecords?: Result[]);
|
3630
|
+
static parseConstructorParams(...args: any[]): any[];
|
3631
|
+
toArray(): Result[];
|
3632
|
+
map<U>(callbackfn: (value: Result, index: number, array: Result[]) => U, thisArg?: any): U[];
|
3633
|
+
/**
|
3634
|
+
* Retrieve next page of records
|
3635
|
+
*
|
3636
|
+
* @returns A new array of objects
|
3637
|
+
*/
|
3638
|
+
nextPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
|
3639
|
+
/**
|
3640
|
+
* Retrieve previous page of records
|
3641
|
+
*
|
3642
|
+
* @returns A new array of objects
|
3643
|
+
*/
|
3644
|
+
previousPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
|
3645
|
+
/**
|
3646
|
+
* Retrieve first page of records
|
3647
|
+
*
|
3648
|
+
* @returns A new array of objects
|
3649
|
+
*/
|
3650
|
+
firstPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
|
3651
|
+
/**
|
3652
|
+
* Retrieve last page of records
|
3653
|
+
*
|
3654
|
+
* @returns A new array of objects
|
3655
|
+
*/
|
3656
|
+
lastPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
|
3657
|
+
/**
|
3658
|
+
* @returns Boolean indicating if there is a next page
|
3659
|
+
*/
|
3660
|
+
hasNextPage(): boolean;
|
3661
|
+
}
|
3205
3662
|
|
3206
3663
|
/**
|
3207
3664
|
* Common interface for performing operations on a table.
|
3208
3665
|
*/
|
3209
3666
|
declare abstract class Repository<Data extends BaseData, Record extends XataRecord = Data & XataRecord> extends Query<Record, Readonly<SelectedPick<Record, ['*']>>> {
|
3210
|
-
abstract create(object: EditableData<Data> & Partial<Identifiable
|
3667
|
+
abstract create<K extends SelectableColumn<Record>>(object: Omit<EditableData<Data>, 'id'> & Partial<Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
3668
|
+
abstract create(object: Omit<EditableData<Data>, 'id'> & Partial<Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
3211
3669
|
/**
|
3212
3670
|
* Creates a single record in the table with a unique id.
|
3213
3671
|
* @param id The unique id.
|
3214
3672
|
* @param object Object containing the column names with their values to be stored in the table.
|
3673
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3215
3674
|
* @returns The full persisted record.
|
3216
3675
|
*/
|
3217
|
-
abstract create(id: string, object: EditableData<Data
|
3676
|
+
abstract create<K extends SelectableColumn<Record>>(id: string, object: Omit<EditableData<Data>, 'id'>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
3677
|
+
/**
|
3678
|
+
* Creates a single record in the table with a unique id.
|
3679
|
+
* @param id The unique id.
|
3680
|
+
* @param object Object containing the column names with their values to be stored in the table.
|
3681
|
+
* @returns The full persisted record.
|
3682
|
+
*/
|
3683
|
+
abstract create(id: string, object: Omit<EditableData<Data>, 'id'>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
3218
3684
|
/**
|
3219
3685
|
* Creates multiple records in the table.
|
3220
3686
|
* @param objects Array of objects with the column names and the values to be stored in the table.
|
3221
|
-
* @
|
3687
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3688
|
+
* @returns Array of the persisted records in order.
|
3689
|
+
*/
|
3690
|
+
abstract create<K extends SelectableColumn<Record>>(objects: Array<Omit<EditableData<Data>, 'id'> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
3691
|
+
/**
|
3692
|
+
* Creates multiple records in the table.
|
3693
|
+
* @param objects Array of objects with the column names and the values to be stored in the table.
|
3694
|
+
* @returns Array of the persisted records in order.
|
3695
|
+
*/
|
3696
|
+
abstract create(objects: Array<Omit<EditableData<Data>, 'id'> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
3697
|
+
/**
|
3698
|
+
* Queries a single record from the table given its unique id.
|
3699
|
+
* @param id The unique id.
|
3700
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3701
|
+
* @returns The persisted record for the given id or null if the record could not be found.
|
3222
3702
|
*/
|
3223
|
-
abstract
|
3703
|
+
abstract read<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
|
3224
3704
|
/**
|
3225
3705
|
* Queries a single record from the table given its unique id.
|
3226
3706
|
* @param id The unique id.
|
3227
3707
|
* @returns The persisted record for the given id or null if the record could not be found.
|
3228
3708
|
*/
|
3229
3709
|
abstract read(id: string): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
|
3710
|
+
/**
|
3711
|
+
* Queries multiple records from the table given their unique id.
|
3712
|
+
* @param ids The unique ids array.
|
3713
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3714
|
+
* @returns The persisted records for the given ids in order (if a record could not be found null is returned).
|
3715
|
+
*/
|
3716
|
+
abstract read<K extends SelectableColumn<Record>>(ids: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
3717
|
+
/**
|
3718
|
+
* Queries multiple records from the table given their unique id.
|
3719
|
+
* @param ids The unique ids array.
|
3720
|
+
* @returns The persisted records for the given ids in order (if a record could not be found null is returned).
|
3721
|
+
*/
|
3722
|
+
abstract read(ids: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
3723
|
+
/**
|
3724
|
+
* Queries a single record from the table by the id in the object.
|
3725
|
+
* @param object Object containing the id of the record.
|
3726
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3727
|
+
* @returns The persisted record for the given id or null if the record could not be found.
|
3728
|
+
*/
|
3729
|
+
abstract read<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
|
3730
|
+
/**
|
3731
|
+
* Queries a single record from the table by the id in the object.
|
3732
|
+
* @param object Object containing the id of the record.
|
3733
|
+
* @returns The persisted record for the given id or null if the record could not be found.
|
3734
|
+
*/
|
3735
|
+
abstract read(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
|
3736
|
+
/**
|
3737
|
+
* Queries multiple records from the table by the ids in the objects.
|
3738
|
+
* @param objects Array of objects containing the ids of the records.
|
3739
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3740
|
+
* @returns The persisted records for the given ids in order (if a record could not be found null is returned).
|
3741
|
+
*/
|
3742
|
+
abstract read<K extends SelectableColumn<Record>>(objects: Identifiable[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
3743
|
+
/**
|
3744
|
+
* Queries multiple records from the table by the ids in the objects.
|
3745
|
+
* @param objects Array of objects containing the ids of the records.
|
3746
|
+
* @returns The persisted records for the given ids in order (if a record could not be found null is returned).
|
3747
|
+
*/
|
3748
|
+
abstract read(objects: Identifiable[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
3749
|
+
/**
|
3750
|
+
* Partially update a single record.
|
3751
|
+
* @param object An object with its id and the columns to be updated.
|
3752
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3753
|
+
* @returns The full persisted record.
|
3754
|
+
*/
|
3755
|
+
abstract update<K extends SelectableColumn<Record>>(object: Partial<EditableData<Data>> & Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
3230
3756
|
/**
|
3231
3757
|
* Partially update a single record.
|
3232
3758
|
* @param object An object with its id and the columns to be updated.
|
3233
3759
|
* @returns The full persisted record.
|
3234
3760
|
*/
|
3235
3761
|
abstract update(object: Partial<EditableData<Data>> & Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
3762
|
+
/**
|
3763
|
+
* Partially update a single record given its unique id.
|
3764
|
+
* @param id The unique id.
|
3765
|
+
* @param object The column names and their values that have to be updated.
|
3766
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3767
|
+
* @returns The full persisted record.
|
3768
|
+
*/
|
3769
|
+
abstract update<K extends SelectableColumn<Record>>(id: string, object: Partial<EditableData<Data>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
3236
3770
|
/**
|
3237
3771
|
* Partially update a single record given its unique id.
|
3238
3772
|
* @param id The unique id.
|
@@ -3243,9 +3777,24 @@ declare abstract class Repository<Data extends BaseData, Record extends XataReco
|
|
3243
3777
|
/**
|
3244
3778
|
* Partially updates multiple records.
|
3245
3779
|
* @param objects An array of objects with their ids and columns to be updated.
|
3246
|
-
* @
|
3780
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3781
|
+
* @returns Array of the persisted records in order.
|
3782
|
+
*/
|
3783
|
+
abstract update<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Data>> & Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
3784
|
+
/**
|
3785
|
+
* Partially updates multiple records.
|
3786
|
+
* @param objects An array of objects with their ids and columns to be updated.
|
3787
|
+
* @returns Array of the persisted records in order.
|
3247
3788
|
*/
|
3248
3789
|
abstract update(objects: Array<Partial<EditableData<Data>> & Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
3790
|
+
/**
|
3791
|
+
* Creates or updates a single record. If a record exists with the given id,
|
3792
|
+
* it will be update, otherwise a new record will be created.
|
3793
|
+
* @param object Object containing the column names with their values to be persisted in the table.
|
3794
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3795
|
+
* @returns The full persisted record.
|
3796
|
+
*/
|
3797
|
+
abstract createOrUpdate<K extends SelectableColumn<Record>>(object: EditableData<Data> & Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
3249
3798
|
/**
|
3250
3799
|
* Creates or updates a single record. If a record exists with the given id,
|
3251
3800
|
* it will be update, otherwise a new record will be created.
|
@@ -3253,6 +3802,15 @@ declare abstract class Repository<Data extends BaseData, Record extends XataReco
|
|
3253
3802
|
* @returns The full persisted record.
|
3254
3803
|
*/
|
3255
3804
|
abstract createOrUpdate(object: EditableData<Data> & Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
3805
|
+
/**
|
3806
|
+
* Creates or updates a single record. If a record exists with the given id,
|
3807
|
+
* it will be update, otherwise a new record will be created.
|
3808
|
+
* @param id A unique id.
|
3809
|
+
* @param object The column names and the values to be persisted.
|
3810
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3811
|
+
* @returns The full persisted record.
|
3812
|
+
*/
|
3813
|
+
abstract createOrUpdate<K extends SelectableColumn<Record>>(id: string, object: Omit<EditableData<Data>, 'id'>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
3256
3814
|
/**
|
3257
3815
|
* Creates or updates a single record. If a record exists with the given id,
|
3258
3816
|
* it will be update, otherwise a new record will be created.
|
@@ -3260,7 +3818,15 @@ declare abstract class Repository<Data extends BaseData, Record extends XataReco
|
|
3260
3818
|
* @param object The column names and the values to be persisted.
|
3261
3819
|
* @returns The full persisted record.
|
3262
3820
|
*/
|
3263
|
-
abstract createOrUpdate(id: string, object: EditableData<Data>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
3821
|
+
abstract createOrUpdate(id: string, object: Omit<EditableData<Data>, 'id'>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
3822
|
+
/**
|
3823
|
+
* Creates or updates a single record. If a record exists with the given id,
|
3824
|
+
* it will be update, otherwise a new record will be created.
|
3825
|
+
* @param objects Array of objects with the column names and the values to be stored in the table.
|
3826
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3827
|
+
* @returns Array of the persisted records.
|
3828
|
+
*/
|
3829
|
+
abstract createOrUpdate<K extends SelectableColumn<Record>>(objects: Array<EditableData<Data> & Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
3264
3830
|
/**
|
3265
3831
|
* Creates or updates a single record. If a record exists with the given id,
|
3266
3832
|
* it will be update, otherwise a new record will be created.
|
@@ -3299,35 +3865,112 @@ declare abstract class Repository<Data extends BaseData, Record extends XataReco
|
|
3299
3865
|
* @returns The found records.
|
3300
3866
|
*/
|
3301
3867
|
abstract search(query: string, options?: {
|
3302
|
-
fuzziness?:
|
3303
|
-
|
3868
|
+
fuzziness?: FuzzinessExpression;
|
3869
|
+
prefix?: PrefixExpression;
|
3870
|
+
highlight?: HighlightExpression;
|
3871
|
+
filter?: Filter<Record>;
|
3872
|
+
boosters?: Boosters<Record>[];
|
3873
|
+
}): Promise<SearchXataRecord<SelectedPick<Record, ['*']>>[]>;
|
3304
3874
|
abstract query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
|
3305
3875
|
}
|
3306
3876
|
declare class RestRepository<Data extends BaseData, Record extends XataRecord = Data & XataRecord> extends Query<Record, SelectedPick<Record, ['*']>> implements Repository<Data, Record> {
|
3307
3877
|
#private;
|
3308
|
-
db: SchemaPluginResult<any>;
|
3309
3878
|
constructor(options: {
|
3310
3879
|
table: string;
|
3311
3880
|
db: SchemaPluginResult<any>;
|
3312
3881
|
pluginOptions: XataPluginOptions;
|
3882
|
+
schemaTables?: Table[];
|
3313
3883
|
});
|
3314
|
-
create(object: EditableData<Data>): Promise<SelectedPick<Record, ['*']
|
3315
|
-
create(recordId: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']
|
3316
|
-
create(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']
|
3317
|
-
|
3884
|
+
create(object: EditableData<Data>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
3885
|
+
create(recordId: string, object: EditableData<Data>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
3886
|
+
create(objects: EditableData<Data>[]): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
3887
|
+
create<K extends SelectableColumn<Record>>(object: EditableData<Data>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
3888
|
+
create<K extends SelectableColumn<Record>>(recordId: string, object: EditableData<Data>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
3889
|
+
create<K extends SelectableColumn<Record>>(objects: EditableData<Data>[], columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
3890
|
+
read(recordId: string): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
|
3891
|
+
read(recordIds: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
3892
|
+
read(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
|
3893
|
+
read(objects: Identifiable[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
3894
|
+
read<K extends SelectableColumn<Record>>(recordId: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
|
3895
|
+
read<K extends SelectableColumn<Record>>(recordIds: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
3896
|
+
read<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
|
3897
|
+
read<K extends SelectableColumn<Record>>(objects: Identifiable[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
3318
3898
|
update(object: Partial<EditableData<Data>> & Identifiable): Promise<SelectedPick<Record, ['*']>>;
|
3319
3899
|
update(recordId: string, object: Partial<EditableData<Data>>): Promise<SelectedPick<Record, ['*']>>;
|
3320
3900
|
update(objects: Array<Partial<EditableData<Data>> & Identifiable>): Promise<SelectedPick<Record, ['*']>[]>;
|
3901
|
+
update<K extends SelectableColumn<Record>>(object: Partial<EditableData<Data>> & Identifiable, columns: K[]): Promise<SelectedPick<Record, typeof columns>>;
|
3902
|
+
update<K extends SelectableColumn<Record>>(recordId: string, object: Partial<EditableData<Data>>, columns: K[]): Promise<SelectedPick<Record, typeof columns>>;
|
3903
|
+
update<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Data>> & Identifiable>, columns: K[]): Promise<SelectedPick<Record, typeof columns>[]>;
|
3321
3904
|
createOrUpdate(object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
|
3322
3905
|
createOrUpdate(recordId: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
|
3323
3906
|
createOrUpdate(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']>[]>;
|
3907
|
+
createOrUpdate<K extends SelectableColumn<Record>>(object: EditableData<Data>, columns: K[]): Promise<SelectedPick<Record, typeof columns>>;
|
3908
|
+
createOrUpdate<K extends SelectableColumn<Record>>(recordId: string, object: EditableData<Data>, columns: K[]): Promise<SelectedPick<Record, typeof columns>>;
|
3909
|
+
createOrUpdate<K extends SelectableColumn<Record>>(objects: EditableData<Data>[], columns: K[]): Promise<SelectedPick<Record, typeof columns>[]>;
|
3324
3910
|
delete(a: string | Identifiable | Array<string | Identifiable>): Promise<void>;
|
3325
3911
|
search(query: string, options?: {
|
3326
|
-
fuzziness?:
|
3327
|
-
|
3912
|
+
fuzziness?: FuzzinessExpression;
|
3913
|
+
prefix?: PrefixExpression;
|
3914
|
+
highlight?: HighlightExpression;
|
3915
|
+
filter?: Filter<Record>;
|
3916
|
+
boosters?: Boosters<Record>[];
|
3917
|
+
}): Promise<any>;
|
3328
3918
|
query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
|
3329
3919
|
}
|
3330
3920
|
|
3921
|
+
declare type BaseSchema = {
|
3922
|
+
name: string;
|
3923
|
+
columns: readonly ({
|
3924
|
+
name: string;
|
3925
|
+
type: Column['type'];
|
3926
|
+
} | {
|
3927
|
+
name: string;
|
3928
|
+
type: 'link';
|
3929
|
+
link: {
|
3930
|
+
table: string;
|
3931
|
+
};
|
3932
|
+
} | {
|
3933
|
+
name: string;
|
3934
|
+
type: 'object';
|
3935
|
+
columns: {
|
3936
|
+
name: string;
|
3937
|
+
type: string;
|
3938
|
+
}[];
|
3939
|
+
})[];
|
3940
|
+
};
|
3941
|
+
declare type SchemaInference<T extends readonly BaseSchema[]> = T extends never[] ? Record<string, Record<string, any>> : T extends readonly unknown[] ? T[number] extends {
|
3942
|
+
name: string;
|
3943
|
+
columns: readonly unknown[];
|
3944
|
+
} ? {
|
3945
|
+
[K in T[number]['name']]: TableType<T[number], K>;
|
3946
|
+
} : never : never;
|
3947
|
+
declare type TableType<Tables, TableName> = Tables & {
|
3948
|
+
name: TableName;
|
3949
|
+
} extends infer Table ? Table extends {
|
3950
|
+
name: string;
|
3951
|
+
columns: infer Columns;
|
3952
|
+
} ? Columns extends readonly unknown[] ? Columns[number] extends {
|
3953
|
+
name: string;
|
3954
|
+
type: string;
|
3955
|
+
} ? Identifiable & {
|
3956
|
+
[K in Columns[number]['name']]?: PropertyType<Tables, Columns[number], K>;
|
3957
|
+
} : never : never : never : never;
|
3958
|
+
declare type PropertyType<Tables, Properties, PropertyName> = Properties & {
|
3959
|
+
name: PropertyName;
|
3960
|
+
} extends infer Property ? Property extends {
|
3961
|
+
name: string;
|
3962
|
+
type: infer Type;
|
3963
|
+
link?: {
|
3964
|
+
table: infer LinkedTable;
|
3965
|
+
};
|
3966
|
+
columns?: infer ObjectColumns;
|
3967
|
+
} ? (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 'object' ? ObjectColumns extends readonly unknown[] ? ObjectColumns[number] extends {
|
3968
|
+
name: string;
|
3969
|
+
type: string;
|
3970
|
+
} ? {
|
3971
|
+
[K in ObjectColumns[number]['name']]?: PropertyType<Tables, ObjectColumns[number], K>;
|
3972
|
+
} : never : never : Type extends 'link' ? TableType<Tables, LinkedTable> & XataRecord : never) | null : never : never;
|
3973
|
+
|
3331
3974
|
/**
|
3332
3975
|
* Operator to restrict results to only values that are greater than the given value.
|
3333
3976
|
*/
|
@@ -3411,38 +4054,10 @@ declare type SchemaPluginResult<Schemas extends Record<string, BaseData>> = {
|
|
3411
4054
|
};
|
3412
4055
|
declare class SchemaPlugin<Schemas extends Record<string, BaseData>> extends XataPlugin {
|
3413
4056
|
#private;
|
3414
|
-
|
3415
|
-
constructor(tableNames?: string[] | undefined);
|
4057
|
+
constructor(schemaTables?: Schemas.Table[]);
|
3416
4058
|
build(pluginOptions: XataPluginOptions): SchemaPluginResult<Schemas>;
|
3417
4059
|
}
|
3418
4060
|
|
3419
|
-
declare type SearchOptions<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = {
|
3420
|
-
fuzziness?: number;
|
3421
|
-
tables?: Tables[];
|
3422
|
-
};
|
3423
|
-
declare type SearchPluginResult<Schemas extends Record<string, BaseData>> = {
|
3424
|
-
all: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<Values<{
|
3425
|
-
[Model in GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>]: {
|
3426
|
-
table: Model;
|
3427
|
-
record: Awaited<SelectedPick<Schemas[Model] & SearchXataRecord, ['*']>>;
|
3428
|
-
};
|
3429
|
-
}>[]>;
|
3430
|
-
byTable: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<{
|
3431
|
-
[Model in GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>]?: Awaited<SelectedPick<Schemas[Model] & SearchXataRecord, ['*']>[]>;
|
3432
|
-
}>;
|
3433
|
-
};
|
3434
|
-
declare class SearchPlugin<Schemas extends Record<string, BaseData>> extends XataPlugin {
|
3435
|
-
#private;
|
3436
|
-
private db;
|
3437
|
-
constructor(db: SchemaPluginResult<Schemas>);
|
3438
|
-
build({ getFetchProps }: XataPluginOptions): SearchPluginResult<Schemas>;
|
3439
|
-
}
|
3440
|
-
declare type SearchXataRecord = XataRecord & {
|
3441
|
-
xata: {
|
3442
|
-
table: string;
|
3443
|
-
};
|
3444
|
-
};
|
3445
|
-
|
3446
4061
|
declare type BranchStrategyValue = string | undefined | null;
|
3447
4062
|
declare type BranchStrategyBuilder = () => BranchStrategyValue | Promise<BranchStrategyValue>;
|
3448
4063
|
declare type BranchStrategy = BranchStrategyValue | BranchStrategyBuilder;
|
@@ -3457,16 +4072,30 @@ declare type BaseClientOptions = {
|
|
3457
4072
|
};
|
3458
4073
|
declare const buildClient: <Plugins extends Record<string, XataPlugin> = {}>(plugins?: Plugins | undefined) => ClientConstructor<Plugins>;
|
3459
4074
|
interface ClientConstructor<Plugins extends Record<string, XataPlugin>> {
|
3460
|
-
new <
|
3461
|
-
db: Awaited<ReturnType<SchemaPlugin<
|
3462
|
-
search: Awaited<ReturnType<SearchPlugin<
|
4075
|
+
new <T extends readonly BaseSchema[]>(options?: Partial<BaseClientOptions>, schemaTables?: T): Omit<{
|
4076
|
+
db: Awaited<ReturnType<SchemaPlugin<SchemaInference<NonNullable<typeof schemaTables>>>['build']>>;
|
4077
|
+
search: Awaited<ReturnType<SearchPlugin<SchemaInference<NonNullable<typeof schemaTables>>>['build']>>;
|
3463
4078
|
}, keyof Plugins> & {
|
3464
4079
|
[Key in StringKeys<NonNullable<Plugins>>]: Awaited<ReturnType<NonNullable<Plugins>[Key]['build']>>;
|
4080
|
+
} & {
|
4081
|
+
getConfig(): Promise<{
|
4082
|
+
databaseURL: string;
|
4083
|
+
branch: string;
|
4084
|
+
}>;
|
3465
4085
|
};
|
3466
4086
|
}
|
3467
4087
|
declare const BaseClient_base: ClientConstructor<{}>;
|
3468
|
-
declare class BaseClient extends BaseClient_base<
|
4088
|
+
declare class BaseClient extends BaseClient_base<[]> {
|
4089
|
+
}
|
4090
|
+
|
4091
|
+
declare class Serializer {
|
4092
|
+
classes: Record<string, any>;
|
4093
|
+
add(clazz: any): void;
|
4094
|
+
toJSON<T>(data: T): string;
|
4095
|
+
fromJSON<T>(json: string): T;
|
3469
4096
|
}
|
4097
|
+
declare const serialize: <T>(data: T) => string;
|
4098
|
+
declare const deserialize: <T>(json: string) => T;
|
3470
4099
|
|
3471
4100
|
declare type BranchResolutionOptions = {
|
3472
4101
|
databaseURL?: string;
|
@@ -3479,9 +4108,89 @@ declare function getDatabaseURL(): string | undefined;
|
|
3479
4108
|
|
3480
4109
|
declare function getAPIKey(): string | undefined;
|
3481
4110
|
|
4111
|
+
interface Body {
|
4112
|
+
arrayBuffer(): Promise<ArrayBuffer>;
|
4113
|
+
blob(): Promise<Blob>;
|
4114
|
+
formData(): Promise<FormData>;
|
4115
|
+
json(): Promise<any>;
|
4116
|
+
text(): Promise<string>;
|
4117
|
+
}
|
4118
|
+
interface Blob {
|
4119
|
+
readonly size: number;
|
4120
|
+
readonly type: string;
|
4121
|
+
arrayBuffer(): Promise<ArrayBuffer>;
|
4122
|
+
slice(start?: number, end?: number, contentType?: string): Blob;
|
4123
|
+
text(): Promise<string>;
|
4124
|
+
}
|
4125
|
+
/** Provides information about files and allows JavaScript in a web page to access their content. */
|
4126
|
+
interface File extends Blob {
|
4127
|
+
readonly lastModified: number;
|
4128
|
+
readonly name: string;
|
4129
|
+
readonly webkitRelativePath: string;
|
4130
|
+
}
|
4131
|
+
declare type FormDataEntryValue = File | string;
|
4132
|
+
/** 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". */
|
4133
|
+
interface FormData {
|
4134
|
+
append(name: string, value: string | Blob, fileName?: string): void;
|
4135
|
+
delete(name: string): void;
|
4136
|
+
get(name: string): FormDataEntryValue | null;
|
4137
|
+
getAll(name: string): FormDataEntryValue[];
|
4138
|
+
has(name: string): boolean;
|
4139
|
+
set(name: string, value: string | Blob, fileName?: string): void;
|
4140
|
+
forEach(callbackfn: (value: FormDataEntryValue, key: string, parent: FormData) => void, thisArg?: any): void;
|
4141
|
+
}
|
4142
|
+
/** 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. */
|
4143
|
+
interface Headers {
|
4144
|
+
append(name: string, value: string): void;
|
4145
|
+
delete(name: string): void;
|
4146
|
+
get(name: string): string | null;
|
4147
|
+
has(name: string): boolean;
|
4148
|
+
set(name: string, value: string): void;
|
4149
|
+
forEach(callbackfn: (value: string, key: string, parent: Headers) => void, thisArg?: any): void;
|
4150
|
+
}
|
4151
|
+
interface Request extends Body {
|
4152
|
+
/** Returns the cache mode associated with request, which is a string indicating how the request will interact with the browser's cache when fetching. */
|
4153
|
+
readonly cache: 'default' | 'force-cache' | 'no-cache' | 'no-store' | 'only-if-cached' | 'reload';
|
4154
|
+
/** Returns the credentials mode associated with request, which is a string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. */
|
4155
|
+
readonly credentials: 'include' | 'omit' | 'same-origin';
|
4156
|
+
/** Returns the kind of resource requested by request, e.g., "document" or "script". */
|
4157
|
+
readonly destination: '' | 'audio' | 'audioworklet' | 'document' | 'embed' | 'font' | 'frame' | 'iframe' | 'image' | 'manifest' | 'object' | 'paintworklet' | 'report' | 'script' | 'sharedworker' | 'style' | 'track' | 'video' | 'worker' | 'xslt';
|
4158
|
+
/** Returns a Headers object consisting of the headers associated with request. Note that headers added in the network layer by the user agent will not be accounted for in this object, e.g., the "Host" header. */
|
4159
|
+
readonly headers: Headers;
|
4160
|
+
/** Returns request's subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. [SRI] */
|
4161
|
+
readonly integrity: string;
|
4162
|
+
/** Returns a boolean indicating whether or not request can outlive the global in which it was created. */
|
4163
|
+
readonly keepalive: boolean;
|
4164
|
+
/** Returns request's HTTP method, which is "GET" by default. */
|
4165
|
+
readonly method: string;
|
4166
|
+
/** Returns the mode associated with request, which is a string indicating whether the request will use CORS, or will be restricted to same-origin URLs. */
|
4167
|
+
readonly mode: 'cors' | 'navigate' | 'no-cors' | 'same-origin';
|
4168
|
+
/** Returns the redirect mode associated with request, which is a string indicating how redirects for the request will be handled during fetching. A request will follow redirects by default. */
|
4169
|
+
readonly redirect: 'error' | 'follow' | 'manual';
|
4170
|
+
/** Returns the referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to indicate no referrer, and "about:client" when defaulting to the global's default. This is used during fetching to determine the value of the `Referer` header of the request being made. */
|
4171
|
+
readonly referrer: string;
|
4172
|
+
/** Returns the referrer policy associated with request. This is used during fetching to compute the value of the request's referrer. */
|
4173
|
+
readonly referrerPolicy: '' | 'no-referrer' | 'no-referrer-when-downgrade' | 'origin' | 'origin-when-cross-origin' | 'same-origin' | 'strict-origin' | 'strict-origin-when-cross-origin' | 'unsafe-url';
|
4174
|
+
/** Returns the URL of request as a string. */
|
4175
|
+
readonly url: string;
|
4176
|
+
clone(): Request;
|
4177
|
+
}
|
4178
|
+
|
4179
|
+
declare type XataWorkerContext<XataClient> = {
|
4180
|
+
xata: XataClient;
|
4181
|
+
request: Request;
|
4182
|
+
env: Record<string, string | undefined>;
|
4183
|
+
};
|
4184
|
+
declare type RemoveFirst<T> = T extends [any, ...infer U] ? U : never;
|
4185
|
+
declare type WorkerRunnerConfig = {
|
4186
|
+
workspace: string;
|
4187
|
+
worker: string;
|
4188
|
+
};
|
4189
|
+
declare function buildWorkerRunner<XataClient>(config: WorkerRunnerConfig): <WorkerFunction extends (ctx: XataWorkerContext<XataClient>, ...args: any[]) => any>(name: string, _worker: WorkerFunction) => (...args: RemoveFirst<Parameters<WorkerFunction>>) => Promise<Awaited<ReturnType<WorkerFunction>>>;
|
4190
|
+
|
3482
4191
|
declare class XataError extends Error {
|
3483
4192
|
readonly status: number;
|
3484
4193
|
constructor(message: string, status: number);
|
3485
4194
|
}
|
3486
4195
|
|
3487
|
-
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, BaseClient, BaseClientOptions, BaseData, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams,
|
4196
|
+
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchResponse, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateTableError, CreateTablePathParams, CreateTableResponse, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetDatabaseMetadataError, GetDatabaseMetadataPathParams, GetDatabaseMetadataVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetRecordError, GetRecordPathParams, GetRecordQueryParams, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, Link, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, Query, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RecordArray, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaInference, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SearchTableError, SearchTablePathParams, SearchTableRequestBody, SearchTableVariables, SearchXataRecord, SelectableColumn, SelectedPick, Serializer, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberInviteError, UpdateWorkspaceMemberInvitePathParams, UpdateWorkspaceMemberInviteRequestBody, UpdateWorkspaceMemberInviteVariables, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, buildClient, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, contains, createBranch, createDatabase, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isIdentifiable, isNot, isXataRecord, le, lt, lte, notExists, operationsByTag, pattern, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, updateBranchMetadata, updateColumn, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID };
|