@xata.io/client 0.0.0-alpha.vf9f8d99 → 0.0.0-alpha.vfa37ea7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-add-version.log +1 -1
- package/.turbo/turbo-build.log +4 -4
- package/CHANGELOG.md +69 -1
- package/dist/index.cjs +735 -48
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +961 -94
- package/dist/index.mjs +722 -49
- package/dist/index.mjs.map +1 -1
- package/package.json +6 -3
- package/.eslintrc.cjs +0 -13
- package/rollup.config.mjs +0 -44
- package/tsconfig.json +0 -23
package/dist/index.d.ts
CHANGED
@@ -27,6 +27,7 @@ declare abstract class XataPlugin {
|
|
27
27
|
}
|
28
28
|
type XataPluginOptions = ApiExtraProps & {
|
29
29
|
cache: CacheImpl;
|
30
|
+
host: HostProvider;
|
30
31
|
};
|
31
32
|
|
32
33
|
type AttributeDictionary = Record<string, string | number | boolean | undefined>;
|
@@ -952,6 +953,43 @@ type UpdateDatabaseMetadataVariables = {
|
|
952
953
|
* Update the color of the selected database
|
953
954
|
*/
|
954
955
|
declare const updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
956
|
+
type RenameDatabasePathParams = {
|
957
|
+
/**
|
958
|
+
* Workspace ID
|
959
|
+
*/
|
960
|
+
workspaceId: WorkspaceID;
|
961
|
+
/**
|
962
|
+
* The Database Name
|
963
|
+
*/
|
964
|
+
dbName: DBName$1;
|
965
|
+
};
|
966
|
+
type RenameDatabaseError = ErrorWrapper$1<{
|
967
|
+
status: 400;
|
968
|
+
payload: BadRequestError$1;
|
969
|
+
} | {
|
970
|
+
status: 401;
|
971
|
+
payload: AuthError$1;
|
972
|
+
} | {
|
973
|
+
status: 422;
|
974
|
+
payload: SimpleError$1;
|
975
|
+
} | {
|
976
|
+
status: 423;
|
977
|
+
payload: SimpleError$1;
|
978
|
+
}>;
|
979
|
+
type RenameDatabaseRequestBody = {
|
980
|
+
/**
|
981
|
+
* @minLength 1
|
982
|
+
*/
|
983
|
+
newName: string;
|
984
|
+
};
|
985
|
+
type RenameDatabaseVariables = {
|
986
|
+
body: RenameDatabaseRequestBody;
|
987
|
+
pathParams: RenameDatabasePathParams;
|
988
|
+
} & ControlPlaneFetcherExtraProps;
|
989
|
+
/**
|
990
|
+
* Change the name of an existing database
|
991
|
+
*/
|
992
|
+
declare const renameDatabase: (variables: RenameDatabaseVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
|
955
993
|
type GetDatabaseGithubSettingsPathParams = {
|
956
994
|
/**
|
957
995
|
* Workspace ID
|
@@ -1135,7 +1173,7 @@ type ColumnVector = {
|
|
1135
1173
|
};
|
1136
1174
|
type Column = {
|
1137
1175
|
name: string;
|
1138
|
-
type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object' | 'datetime' | 'vector' | '
|
1176
|
+
type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object' | 'datetime' | 'vector' | 'file[]' | 'file';
|
1139
1177
|
link?: ColumnLink;
|
1140
1178
|
vector?: ColumnVector;
|
1141
1179
|
notNull?: boolean;
|
@@ -1172,6 +1210,11 @@ type DBBranch = {
|
|
1172
1210
|
schema: Schema;
|
1173
1211
|
};
|
1174
1212
|
type MigrationStatus = 'completed' | 'pending' | 'failed';
|
1213
|
+
type BranchWithCopyID = {
|
1214
|
+
branchName: BranchName;
|
1215
|
+
dbBranchID: string;
|
1216
|
+
copyID: string;
|
1217
|
+
};
|
1175
1218
|
type MetricsDatapoint = {
|
1176
1219
|
timestamp: string;
|
1177
1220
|
value: number;
|
@@ -1287,7 +1330,7 @@ type FilterColumnIncludes = {
|
|
1287
1330
|
$includesNone?: FilterPredicate;
|
1288
1331
|
};
|
1289
1332
|
type FilterColumn = FilterColumnIncludes | FilterPredicate | FilterList;
|
1290
|
-
type SortOrder = 'asc' | 'desc';
|
1333
|
+
type SortOrder = 'asc' | 'desc' | 'random';
|
1291
1334
|
type SortExpression = string[] | {
|
1292
1335
|
[key: string]: SortOrder;
|
1293
1336
|
} | {
|
@@ -1385,9 +1428,13 @@ type RecordsMetadata = {
|
|
1385
1428
|
*/
|
1386
1429
|
cursor: string;
|
1387
1430
|
/**
|
1388
|
-
* true if more records can be
|
1431
|
+
* true if more records can be fetched
|
1389
1432
|
*/
|
1390
1433
|
more: boolean;
|
1434
|
+
/**
|
1435
|
+
* the number of records returned per page
|
1436
|
+
*/
|
1437
|
+
size: number;
|
1391
1438
|
};
|
1392
1439
|
};
|
1393
1440
|
type TableOpAdd = {
|
@@ -1436,10 +1483,9 @@ type Commit = {
|
|
1436
1483
|
message?: string;
|
1437
1484
|
id: string;
|
1438
1485
|
parentID?: string;
|
1486
|
+
checksum: string;
|
1439
1487
|
mergeParentID?: string;
|
1440
|
-
status: MigrationStatus;
|
1441
1488
|
createdAt: DateTime;
|
1442
|
-
modifiedAt?: DateTime;
|
1443
1489
|
operations: MigrationOp[];
|
1444
1490
|
};
|
1445
1491
|
type SchemaEditScript = {
|
@@ -1447,6 +1493,16 @@ type SchemaEditScript = {
|
|
1447
1493
|
targetMigrationID?: string;
|
1448
1494
|
operations: MigrationOp[];
|
1449
1495
|
};
|
1496
|
+
type BranchOp = {
|
1497
|
+
id: string;
|
1498
|
+
parentID?: string;
|
1499
|
+
title?: string;
|
1500
|
+
message?: string;
|
1501
|
+
status: MigrationStatus;
|
1502
|
+
createdAt: DateTime;
|
1503
|
+
modifiedAt?: DateTime;
|
1504
|
+
migration?: Commit;
|
1505
|
+
};
|
1450
1506
|
/**
|
1451
1507
|
* Branch schema migration.
|
1452
1508
|
*/
|
@@ -1454,6 +1510,14 @@ type Migration = {
|
|
1454
1510
|
parentID?: string;
|
1455
1511
|
operations: MigrationOp[];
|
1456
1512
|
};
|
1513
|
+
type MigrationObject = {
|
1514
|
+
title?: string;
|
1515
|
+
message?: string;
|
1516
|
+
id: string;
|
1517
|
+
parentID?: string;
|
1518
|
+
checksum: string;
|
1519
|
+
operations: MigrationOp[];
|
1520
|
+
};
|
1457
1521
|
/**
|
1458
1522
|
* @pattern [a-zA-Z0-9_\-~\.]+
|
1459
1523
|
*/
|
@@ -1527,9 +1591,27 @@ type TransactionUpdateOp = {
|
|
1527
1591
|
columns?: string[];
|
1528
1592
|
};
|
1529
1593
|
/**
|
1530
|
-
* A delete operation. The transaction will continue if no record matches the ID.
|
1594
|
+
* A delete operation. The transaction will continue if no record matches the ID by default. To override this behaviour, set failIfMissing to true.
|
1531
1595
|
*/
|
1532
1596
|
type TransactionDeleteOp = {
|
1597
|
+
/**
|
1598
|
+
* The table name
|
1599
|
+
*/
|
1600
|
+
table: string;
|
1601
|
+
id: RecordID;
|
1602
|
+
/**
|
1603
|
+
* If true, the transaction will fail when the record doesn't exist.
|
1604
|
+
*/
|
1605
|
+
failIfMissing?: boolean;
|
1606
|
+
/**
|
1607
|
+
* If set, the call will return the requested fields as part of the response.
|
1608
|
+
*/
|
1609
|
+
columns?: string[];
|
1610
|
+
};
|
1611
|
+
/**
|
1612
|
+
* Get by id operation.
|
1613
|
+
*/
|
1614
|
+
type TransactionGetOp = {
|
1533
1615
|
/**
|
1534
1616
|
* The table name
|
1535
1617
|
*/
|
@@ -1549,6 +1631,8 @@ type TransactionOperation$1 = {
|
|
1549
1631
|
update: TransactionUpdateOp;
|
1550
1632
|
} | {
|
1551
1633
|
['delete']: TransactionDeleteOp;
|
1634
|
+
} | {
|
1635
|
+
get: TransactionGetOp;
|
1552
1636
|
};
|
1553
1637
|
/**
|
1554
1638
|
* Fields to return in the transaction result.
|
@@ -1600,11 +1684,21 @@ type TransactionResultDelete = {
|
|
1600
1684
|
rows: number;
|
1601
1685
|
columns?: TransactionResultColumns;
|
1602
1686
|
};
|
1687
|
+
/**
|
1688
|
+
* A result from a get operation.
|
1689
|
+
*/
|
1690
|
+
type TransactionResultGet = {
|
1691
|
+
/**
|
1692
|
+
* The type of operation who's result is being returned.
|
1693
|
+
*/
|
1694
|
+
operation: 'get';
|
1695
|
+
columns?: TransactionResultColumns;
|
1696
|
+
};
|
1603
1697
|
/**
|
1604
1698
|
* An ordered array of results from the submitted operations.
|
1605
1699
|
*/
|
1606
1700
|
type TransactionSuccess = {
|
1607
|
-
results: (TransactionResultInsert | TransactionResultUpdate | TransactionResultDelete)[];
|
1701
|
+
results: (TransactionResultInsert | TransactionResultUpdate | TransactionResultDelete | TransactionResultGet)[];
|
1608
1702
|
};
|
1609
1703
|
/**
|
1610
1704
|
* An error message from a failing transaction operation
|
@@ -1639,27 +1733,36 @@ type ObjectValue = {
|
|
1639
1733
|
[key: string]: string | boolean | number | string[] | number[] | DateTime | ObjectValue;
|
1640
1734
|
};
|
1641
1735
|
/**
|
1642
|
-
*
|
1736
|
+
* Unique file identifier
|
1643
1737
|
*
|
1644
|
-
* @
|
1738
|
+
* @maxLength 255
|
1739
|
+
* @minLength 1
|
1740
|
+
* @pattern [a-zA-Z0-9_-~:]+
|
1741
|
+
*/
|
1742
|
+
type FileItemID = string;
|
1743
|
+
/**
|
1744
|
+
* File name
|
1745
|
+
*
|
1746
|
+
* @maxLength 1024
|
1747
|
+
* @minLength 0
|
1748
|
+
* @pattern [0-9a-zA-Z!\-_\.\*'\(\)]*
|
1749
|
+
*/
|
1750
|
+
type FileName = string;
|
1751
|
+
/**
|
1752
|
+
* Media type
|
1753
|
+
*
|
1754
|
+
* @maxLength 255
|
1755
|
+
* @minLength 3
|
1756
|
+
* @pattern ^\w+/[-+.\w]+$
|
1757
|
+
*/
|
1758
|
+
type MediaType = string;
|
1759
|
+
/**
|
1760
|
+
* Object representing a file in an array
|
1645
1761
|
*/
|
1646
1762
|
type InputFileEntry = {
|
1647
|
-
|
1648
|
-
|
1649
|
-
|
1650
|
-
* @maxLength 1024
|
1651
|
-
* @minLength 1
|
1652
|
-
* @pattern [0-9a-zA-Z!\-_\.\*'\(\)]+
|
1653
|
-
*/
|
1654
|
-
name: string;
|
1655
|
-
/**
|
1656
|
-
* Media type
|
1657
|
-
*
|
1658
|
-
* @maxLength 255
|
1659
|
-
* @minLength 3
|
1660
|
-
* @pattern ^\w+/[-+.\w]+$
|
1661
|
-
*/
|
1662
|
-
mediaType?: string;
|
1763
|
+
id?: FileItemID;
|
1764
|
+
name?: FileName;
|
1765
|
+
mediaType?: MediaType;
|
1663
1766
|
/**
|
1664
1767
|
* Base64 encoded content
|
1665
1768
|
*
|
@@ -1681,11 +1784,34 @@ type InputFileEntry = {
|
|
1681
1784
|
* @maxItems 50
|
1682
1785
|
*/
|
1683
1786
|
type InputFileArray = InputFileEntry[];
|
1787
|
+
/**
|
1788
|
+
* Object representing a file
|
1789
|
+
*
|
1790
|
+
* @x-go-type file.InputFile
|
1791
|
+
*/
|
1792
|
+
type InputFile = {
|
1793
|
+
name: FileName;
|
1794
|
+
mediaType?: MediaType;
|
1795
|
+
/**
|
1796
|
+
* Base64 encoded content
|
1797
|
+
*
|
1798
|
+
* @maxLength 20971520
|
1799
|
+
*/
|
1800
|
+
base64Content?: string;
|
1801
|
+
/**
|
1802
|
+
* Enable public access to the file
|
1803
|
+
*/
|
1804
|
+
enablePublicUrl?: boolean;
|
1805
|
+
/**
|
1806
|
+
* Time to live for signed URLs
|
1807
|
+
*/
|
1808
|
+
signedUrlTimeout?: number;
|
1809
|
+
};
|
1684
1810
|
/**
|
1685
1811
|
* Xata input record
|
1686
1812
|
*/
|
1687
1813
|
type DataInputRecord = {
|
1688
|
-
[key: string]: RecordID | string | boolean | number | string[] | number[] | DateTime | ObjectValue | InputFileArray |
|
1814
|
+
[key: string]: RecordID | string | boolean | number | string[] | number[] | DateTime | ObjectValue | InputFileArray | InputFile | null;
|
1689
1815
|
};
|
1690
1816
|
/**
|
1691
1817
|
* Xata Table Record Metadata
|
@@ -1719,6 +1845,23 @@ type RecordMeta = {
|
|
1719
1845
|
warnings?: string[];
|
1720
1846
|
};
|
1721
1847
|
};
|
1848
|
+
/**
|
1849
|
+
* File metadata
|
1850
|
+
*/
|
1851
|
+
type FileResponse = {
|
1852
|
+
id?: FileItemID;
|
1853
|
+
name: FileName;
|
1854
|
+
mediaType: MediaType;
|
1855
|
+
/**
|
1856
|
+
* @format int64
|
1857
|
+
*/
|
1858
|
+
size: number;
|
1859
|
+
/**
|
1860
|
+
* @format int64
|
1861
|
+
*/
|
1862
|
+
version: number;
|
1863
|
+
attributes?: Record<string, any>;
|
1864
|
+
};
|
1722
1865
|
/**
|
1723
1866
|
* The target expression is used to filter the search results by the target columns.
|
1724
1867
|
*/
|
@@ -1749,7 +1892,7 @@ type ValueBooster$1 = {
|
|
1749
1892
|
*/
|
1750
1893
|
value: string | number | boolean;
|
1751
1894
|
/**
|
1752
|
-
* The factor with which to multiply the
|
1895
|
+
* The factor with which to multiply the added boost.
|
1753
1896
|
*/
|
1754
1897
|
factor: number;
|
1755
1898
|
/**
|
@@ -1791,7 +1934,8 @@ type NumericBooster$1 = {
|
|
1791
1934
|
/**
|
1792
1935
|
* Boost records based on the value of a datetime column. It is configured via "origin", "scale", and "decay". The further away from the "origin",
|
1793
1936
|
* 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
|
1794
|
-
* should be interpreted as: a record with a date 10 days before/after origin will
|
1937
|
+
* should be interpreted as: a record with a date 10 days before/after origin will be boosted 2 times less than a record with the date at origin.
|
1938
|
+
* The result of the exponential function is a boost between 0 and 1. The "factor" allows you to control how impactful this boost is, by multiplying it with a given value.
|
1795
1939
|
*/
|
1796
1940
|
type DateBooster$1 = {
|
1797
1941
|
/**
|
@@ -1813,6 +1957,12 @@ type DateBooster$1 = {
|
|
1813
1957
|
* The decay factor to expect at "scale" distance from the "origin".
|
1814
1958
|
*/
|
1815
1959
|
decay: number;
|
1960
|
+
/**
|
1961
|
+
* The factor with which to multiply the added boost.
|
1962
|
+
*
|
1963
|
+
* @minimum 0
|
1964
|
+
*/
|
1965
|
+
factor?: number;
|
1816
1966
|
/**
|
1817
1967
|
* Only apply this booster to the records for which the provided filter matches.
|
1818
1968
|
*/
|
@@ -1874,6 +2024,12 @@ type SearchPageConfig = {
|
|
1874
2024
|
*/
|
1875
2025
|
offset?: number;
|
1876
2026
|
};
|
2027
|
+
/**
|
2028
|
+
* Xata Table SQL Record
|
2029
|
+
*/
|
2030
|
+
type SQLRecord = {
|
2031
|
+
[key: string]: any;
|
2032
|
+
};
|
1877
2033
|
/**
|
1878
2034
|
* A summary expression is the description of a single summary operation. It consists of a single
|
1879
2035
|
* key representing the operation, and a value representing the column to be operated on.
|
@@ -2101,6 +2257,18 @@ type AggResponse$1 = (number | null) | {
|
|
2101
2257
|
[key: string]: AggResponse$1;
|
2102
2258
|
})[];
|
2103
2259
|
};
|
2260
|
+
/**
|
2261
|
+
* File identifier in access URLs
|
2262
|
+
*
|
2263
|
+
* @maxLength 296
|
2264
|
+
* @minLength 88
|
2265
|
+
* @pattern [a-v0-9=]+
|
2266
|
+
*/
|
2267
|
+
type FileAccessID = string;
|
2268
|
+
/**
|
2269
|
+
* File signature
|
2270
|
+
*/
|
2271
|
+
type FileSignature = string;
|
2104
2272
|
/**
|
2105
2273
|
* Xata Table Record Metadata
|
2106
2274
|
*/
|
@@ -2152,6 +2320,7 @@ type RecordUpdateResponse = XataRecord$1 | {
|
|
2152
2320
|
version: number;
|
2153
2321
|
};
|
2154
2322
|
};
|
2323
|
+
type PutFileResponse = FileResponse;
|
2155
2324
|
type RecordResponse = XataRecord$1;
|
2156
2325
|
type BulkInsertResponse = {
|
2157
2326
|
recordIDs: string[];
|
@@ -2172,6 +2341,10 @@ type SearchResponse = {
|
|
2172
2341
|
records: XataRecord$1[];
|
2173
2342
|
warning?: string;
|
2174
2343
|
};
|
2344
|
+
type SQLResponse = {
|
2345
|
+
records: SQLRecord[];
|
2346
|
+
warning?: string;
|
2347
|
+
};
|
2175
2348
|
type RateLimitError = {
|
2176
2349
|
id?: string;
|
2177
2350
|
message: string;
|
@@ -2337,6 +2510,36 @@ type DeleteBranchVariables = {
|
|
2337
2510
|
* Delete the branch in the database and all its resources
|
2338
2511
|
*/
|
2339
2512
|
declare const deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal) => Promise<DeleteBranchResponse>;
|
2513
|
+
type CopyBranchPathParams = {
|
2514
|
+
/**
|
2515
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2516
|
+
*/
|
2517
|
+
dbBranchName: DBBranchName;
|
2518
|
+
workspace: string;
|
2519
|
+
region: string;
|
2520
|
+
};
|
2521
|
+
type CopyBranchError = ErrorWrapper<{
|
2522
|
+
status: 400;
|
2523
|
+
payload: BadRequestError;
|
2524
|
+
} | {
|
2525
|
+
status: 401;
|
2526
|
+
payload: AuthError;
|
2527
|
+
} | {
|
2528
|
+
status: 404;
|
2529
|
+
payload: SimpleError;
|
2530
|
+
}>;
|
2531
|
+
type CopyBranchRequestBody = {
|
2532
|
+
destinationBranch: string;
|
2533
|
+
limit?: number;
|
2534
|
+
};
|
2535
|
+
type CopyBranchVariables = {
|
2536
|
+
body: CopyBranchRequestBody;
|
2537
|
+
pathParams: CopyBranchPathParams;
|
2538
|
+
} & DataPlaneFetcherExtraProps;
|
2539
|
+
/**
|
2540
|
+
* Create a copy of the branch
|
2541
|
+
*/
|
2542
|
+
declare const copyBranch: (variables: CopyBranchVariables, signal?: AbortSignal) => Promise<BranchWithCopyID>;
|
2340
2543
|
type UpdateBranchMetadataPathParams = {
|
2341
2544
|
/**
|
2342
2545
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -2981,7 +3184,7 @@ type MergeMigrationRequestError = ErrorWrapper<{
|
|
2981
3184
|
type MergeMigrationRequestVariables = {
|
2982
3185
|
pathParams: MergeMigrationRequestPathParams;
|
2983
3186
|
} & DataPlaneFetcherExtraProps;
|
2984
|
-
declare const mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal) => Promise<
|
3187
|
+
declare const mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal) => Promise<BranchOp>;
|
2985
3188
|
type GetBranchSchemaHistoryPathParams = {
|
2986
3189
|
/**
|
2987
3190
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3178,6 +3381,44 @@ type ApplyBranchSchemaEditVariables = {
|
|
3178
3381
|
pathParams: ApplyBranchSchemaEditPathParams;
|
3179
3382
|
} & DataPlaneFetcherExtraProps;
|
3180
3383
|
declare const applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
3384
|
+
type PushBranchMigrationsPathParams = {
|
3385
|
+
/**
|
3386
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3387
|
+
*/
|
3388
|
+
dbBranchName: DBBranchName;
|
3389
|
+
workspace: string;
|
3390
|
+
region: string;
|
3391
|
+
};
|
3392
|
+
type PushBranchMigrationsError = ErrorWrapper<{
|
3393
|
+
status: 400;
|
3394
|
+
payload: BadRequestError;
|
3395
|
+
} | {
|
3396
|
+
status: 401;
|
3397
|
+
payload: AuthError;
|
3398
|
+
} | {
|
3399
|
+
status: 404;
|
3400
|
+
payload: SimpleError;
|
3401
|
+
}>;
|
3402
|
+
type PushBranchMigrationsRequestBody = {
|
3403
|
+
migrations: MigrationObject[];
|
3404
|
+
};
|
3405
|
+
type PushBranchMigrationsVariables = {
|
3406
|
+
body: PushBranchMigrationsRequestBody;
|
3407
|
+
pathParams: PushBranchMigrationsPathParams;
|
3408
|
+
} & DataPlaneFetcherExtraProps;
|
3409
|
+
/**
|
3410
|
+
* The `schema/push` API accepts a list of migrations to be applied to the
|
3411
|
+
* current branch. A list of applicable migrations can be fetched using
|
3412
|
+
* the `schema/history` API from another branch or database.
|
3413
|
+
*
|
3414
|
+
* The most recent migration must be part of the list or referenced (via
|
3415
|
+
* `parentID`) by the first migration in the list of migrations to be pushed.
|
3416
|
+
*
|
3417
|
+
* Each migration in the list has an `id`, `parentID`, and `checksum`. The
|
3418
|
+
* checksum for migrations are generated and verified by xata. The
|
3419
|
+
* operation fails if any migration in the list has an invalid checksum.
|
3420
|
+
*/
|
3421
|
+
declare const pushBranchMigrations: (variables: PushBranchMigrationsVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
3181
3422
|
type CreateTablePathParams = {
|
3182
3423
|
/**
|
3183
3424
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -3592,6 +3833,248 @@ type InsertRecordVariables = {
|
|
3592
3833
|
* Insert a new Record into the Table
|
3593
3834
|
*/
|
3594
3835
|
declare const insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
|
3836
|
+
type GetFileItemPathParams = {
|
3837
|
+
/**
|
3838
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3839
|
+
*/
|
3840
|
+
dbBranchName: DBBranchName;
|
3841
|
+
/**
|
3842
|
+
* The Table name
|
3843
|
+
*/
|
3844
|
+
tableName: TableName;
|
3845
|
+
/**
|
3846
|
+
* The Record name
|
3847
|
+
*/
|
3848
|
+
recordId: RecordID;
|
3849
|
+
/**
|
3850
|
+
* The Column name
|
3851
|
+
*/
|
3852
|
+
columnName: ColumnName;
|
3853
|
+
/**
|
3854
|
+
* The File Identifier
|
3855
|
+
*/
|
3856
|
+
fileId: FileItemID;
|
3857
|
+
workspace: string;
|
3858
|
+
region: string;
|
3859
|
+
};
|
3860
|
+
type GetFileItemError = ErrorWrapper<{
|
3861
|
+
status: 400;
|
3862
|
+
payload: BadRequestError;
|
3863
|
+
} | {
|
3864
|
+
status: 401;
|
3865
|
+
payload: AuthError;
|
3866
|
+
} | {
|
3867
|
+
status: 404;
|
3868
|
+
payload: SimpleError;
|
3869
|
+
}>;
|
3870
|
+
type GetFileItemVariables = {
|
3871
|
+
pathParams: GetFileItemPathParams;
|
3872
|
+
} & DataPlaneFetcherExtraProps;
|
3873
|
+
/**
|
3874
|
+
* Retrieves file content from an array by file ID
|
3875
|
+
*/
|
3876
|
+
declare const getFileItem: (variables: GetFileItemVariables, signal?: AbortSignal) => Promise<Blob>;
|
3877
|
+
type PutFileItemPathParams = {
|
3878
|
+
/**
|
3879
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3880
|
+
*/
|
3881
|
+
dbBranchName: DBBranchName;
|
3882
|
+
/**
|
3883
|
+
* The Table name
|
3884
|
+
*/
|
3885
|
+
tableName: TableName;
|
3886
|
+
/**
|
3887
|
+
* The Record name
|
3888
|
+
*/
|
3889
|
+
recordId: RecordID;
|
3890
|
+
/**
|
3891
|
+
* The Column name
|
3892
|
+
*/
|
3893
|
+
columnName: ColumnName;
|
3894
|
+
/**
|
3895
|
+
* The File Identifier
|
3896
|
+
*/
|
3897
|
+
fileId: FileItemID;
|
3898
|
+
workspace: string;
|
3899
|
+
region: string;
|
3900
|
+
};
|
3901
|
+
type PutFileItemError = ErrorWrapper<{
|
3902
|
+
status: 400;
|
3903
|
+
payload: BadRequestError;
|
3904
|
+
} | {
|
3905
|
+
status: 401;
|
3906
|
+
payload: AuthError;
|
3907
|
+
} | {
|
3908
|
+
status: 404;
|
3909
|
+
payload: SimpleError;
|
3910
|
+
} | {
|
3911
|
+
status: 422;
|
3912
|
+
payload: SimpleError;
|
3913
|
+
}>;
|
3914
|
+
type PutFileItemVariables = {
|
3915
|
+
body?: Blob;
|
3916
|
+
pathParams: PutFileItemPathParams;
|
3917
|
+
} & DataPlaneFetcherExtraProps;
|
3918
|
+
/**
|
3919
|
+
* Uploads the file content to an array given the file ID
|
3920
|
+
*/
|
3921
|
+
declare const putFileItem: (variables: PutFileItemVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
3922
|
+
type DeleteFileItemPathParams = {
|
3923
|
+
/**
|
3924
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3925
|
+
*/
|
3926
|
+
dbBranchName: DBBranchName;
|
3927
|
+
/**
|
3928
|
+
* The Table name
|
3929
|
+
*/
|
3930
|
+
tableName: TableName;
|
3931
|
+
/**
|
3932
|
+
* The Record name
|
3933
|
+
*/
|
3934
|
+
recordId: RecordID;
|
3935
|
+
/**
|
3936
|
+
* The Column name
|
3937
|
+
*/
|
3938
|
+
columnName: ColumnName;
|
3939
|
+
/**
|
3940
|
+
* The File Identifier
|
3941
|
+
*/
|
3942
|
+
fileId: FileItemID;
|
3943
|
+
workspace: string;
|
3944
|
+
region: string;
|
3945
|
+
};
|
3946
|
+
type DeleteFileItemError = ErrorWrapper<{
|
3947
|
+
status: 400;
|
3948
|
+
payload: BadRequestError;
|
3949
|
+
} | {
|
3950
|
+
status: 401;
|
3951
|
+
payload: AuthError;
|
3952
|
+
} | {
|
3953
|
+
status: 404;
|
3954
|
+
payload: SimpleError;
|
3955
|
+
}>;
|
3956
|
+
type DeleteFileItemVariables = {
|
3957
|
+
pathParams: DeleteFileItemPathParams;
|
3958
|
+
} & DataPlaneFetcherExtraProps;
|
3959
|
+
/**
|
3960
|
+
* Deletes an item from an file array column given the file ID
|
3961
|
+
*/
|
3962
|
+
declare const deleteFileItem: (variables: DeleteFileItemVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
3963
|
+
type GetFilePathParams = {
|
3964
|
+
/**
|
3965
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3966
|
+
*/
|
3967
|
+
dbBranchName: DBBranchName;
|
3968
|
+
/**
|
3969
|
+
* The Table name
|
3970
|
+
*/
|
3971
|
+
tableName: TableName;
|
3972
|
+
/**
|
3973
|
+
* The Record name
|
3974
|
+
*/
|
3975
|
+
recordId: RecordID;
|
3976
|
+
/**
|
3977
|
+
* The Column name
|
3978
|
+
*/
|
3979
|
+
columnName: ColumnName;
|
3980
|
+
workspace: string;
|
3981
|
+
region: string;
|
3982
|
+
};
|
3983
|
+
type GetFileError = ErrorWrapper<{
|
3984
|
+
status: 400;
|
3985
|
+
payload: BadRequestError;
|
3986
|
+
} | {
|
3987
|
+
status: 401;
|
3988
|
+
payload: AuthError;
|
3989
|
+
} | {
|
3990
|
+
status: 404;
|
3991
|
+
payload: SimpleError;
|
3992
|
+
}>;
|
3993
|
+
type GetFileVariables = {
|
3994
|
+
pathParams: GetFilePathParams;
|
3995
|
+
} & DataPlaneFetcherExtraProps;
|
3996
|
+
/**
|
3997
|
+
* Retrieves the file content from a file column
|
3998
|
+
*/
|
3999
|
+
declare const getFile: (variables: GetFileVariables, signal?: AbortSignal) => Promise<Blob>;
|
4000
|
+
type PutFilePathParams = {
|
4001
|
+
/**
|
4002
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4003
|
+
*/
|
4004
|
+
dbBranchName: DBBranchName;
|
4005
|
+
/**
|
4006
|
+
* The Table name
|
4007
|
+
*/
|
4008
|
+
tableName: TableName;
|
4009
|
+
/**
|
4010
|
+
* The Record name
|
4011
|
+
*/
|
4012
|
+
recordId: RecordID;
|
4013
|
+
/**
|
4014
|
+
* The Column name
|
4015
|
+
*/
|
4016
|
+
columnName: ColumnName;
|
4017
|
+
workspace: string;
|
4018
|
+
region: string;
|
4019
|
+
};
|
4020
|
+
type PutFileError = ErrorWrapper<{
|
4021
|
+
status: 400;
|
4022
|
+
payload: BadRequestError;
|
4023
|
+
} | {
|
4024
|
+
status: 401;
|
4025
|
+
payload: AuthError;
|
4026
|
+
} | {
|
4027
|
+
status: 404;
|
4028
|
+
payload: SimpleError;
|
4029
|
+
} | {
|
4030
|
+
status: 422;
|
4031
|
+
payload: SimpleError;
|
4032
|
+
}>;
|
4033
|
+
type PutFileVariables = {
|
4034
|
+
body?: Blob;
|
4035
|
+
pathParams: PutFilePathParams;
|
4036
|
+
} & DataPlaneFetcherExtraProps;
|
4037
|
+
/**
|
4038
|
+
* Uploads the file content to the given file column
|
4039
|
+
*/
|
4040
|
+
declare const putFile: (variables: PutFileVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
4041
|
+
type DeleteFilePathParams = {
|
4042
|
+
/**
|
4043
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
4044
|
+
*/
|
4045
|
+
dbBranchName: DBBranchName;
|
4046
|
+
/**
|
4047
|
+
* The Table name
|
4048
|
+
*/
|
4049
|
+
tableName: TableName;
|
4050
|
+
/**
|
4051
|
+
* The Record name
|
4052
|
+
*/
|
4053
|
+
recordId: RecordID;
|
4054
|
+
/**
|
4055
|
+
* The Column name
|
4056
|
+
*/
|
4057
|
+
columnName: ColumnName;
|
4058
|
+
workspace: string;
|
4059
|
+
region: string;
|
4060
|
+
};
|
4061
|
+
type DeleteFileError = ErrorWrapper<{
|
4062
|
+
status: 400;
|
4063
|
+
payload: BadRequestError;
|
4064
|
+
} | {
|
4065
|
+
status: 401;
|
4066
|
+
payload: AuthError;
|
4067
|
+
} | {
|
4068
|
+
status: 404;
|
4069
|
+
payload: SimpleError;
|
4070
|
+
}>;
|
4071
|
+
type DeleteFileVariables = {
|
4072
|
+
pathParams: DeleteFilePathParams;
|
4073
|
+
} & DataPlaneFetcherExtraProps;
|
4074
|
+
/**
|
4075
|
+
* Deletes a file referred in a file column
|
4076
|
+
*/
|
4077
|
+
declare const deleteFile: (variables: DeleteFileVariables, signal?: AbortSignal) => Promise<FileResponse>;
|
3595
4078
|
type GetRecordPathParams = {
|
3596
4079
|
/**
|
3597
4080
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -4532,25 +5015,40 @@ type QueryTableVariables = {
|
|
4532
5015
|
* }
|
4533
5016
|
* ```
|
4534
5017
|
*
|
4535
|
-
*
|
5018
|
+
* It is also possible to sort results randomly:
|
5019
|
+
*
|
5020
|
+
* ```json
|
5021
|
+
* POST /db/demo:main/tables/table/query
|
5022
|
+
* {
|
5023
|
+
* "sort": {
|
5024
|
+
* "*": "random"
|
5025
|
+
* }
|
5026
|
+
* }
|
5027
|
+
* ```
|
4536
5028
|
*
|
4537
|
-
*
|
4538
|
-
* cursor pagination is needed in order to retrieve all of their results. The offset pagination method is limited to 1000 records.
|
5029
|
+
* Note that a random sort does not apply to a specific column, hence the special column name `"*"`.
|
4539
5030
|
*
|
4540
|
-
*
|
5031
|
+
* A random sort can be combined with an ascending or descending sort on a specific column:
|
4541
5032
|
*
|
4542
5033
|
* ```json
|
4543
5034
|
* POST /db/demo:main/tables/table/query
|
4544
5035
|
* {
|
4545
|
-
* "
|
4546
|
-
*
|
4547
|
-
*
|
4548
|
-
*
|
5036
|
+
* "sort": [
|
5037
|
+
* {
|
5038
|
+
* "name": "desc"
|
5039
|
+
* },
|
5040
|
+
* {
|
5041
|
+
* "*": "random"
|
5042
|
+
* }
|
5043
|
+
* ]
|
4549
5044
|
* }
|
4550
5045
|
* ```
|
4551
5046
|
*
|
4552
|
-
*
|
4553
|
-
*
|
5047
|
+
* This will sort on the `name` column, breaking ties randomly.
|
5048
|
+
*
|
5049
|
+
* ### Pagination
|
5050
|
+
*
|
5051
|
+
* We offer cursor pagination and offset pagination. The cursor pagination method can be used for sequential scrolling with unrestricted depth. The offset pagination can be used to skip pages and is limited to 1000 records.
|
4554
5052
|
*
|
4555
5053
|
* Example of cursor pagination:
|
4556
5054
|
*
|
@@ -4604,6 +5102,34 @@ type QueryTableVariables = {
|
|
4604
5102
|
* `filter` or `sort` is set. The columns returned and page size can be changed
|
4605
5103
|
* anytime by passing the `columns` or `page.size` settings to the next query.
|
4606
5104
|
*
|
5105
|
+
* In the following example of size + offset pagination we retrieve the third page of up to 100 results:
|
5106
|
+
*
|
5107
|
+
* ```json
|
5108
|
+
* POST /db/demo:main/tables/table/query
|
5109
|
+
* {
|
5110
|
+
* "page": {
|
5111
|
+
* "size": 100,
|
5112
|
+
* "offset": 200
|
5113
|
+
* }
|
5114
|
+
* }
|
5115
|
+
* ```
|
5116
|
+
*
|
5117
|
+
* The `page.size` parameter represents the maximum number of records returned by this query. It has a default value of 20 and a maximum value of 200.
|
5118
|
+
* The `page.offset` parameter represents the number of matching records to skip. It has a default value of 0 and a maximum value of 800.
|
5119
|
+
*
|
5120
|
+
* Cursor pagination also works in combination with offset pagination. For example, starting from a specific cursor position, using a page size of 200 and an offset of 800, you can skip up to 5 pages of 200 records forwards or backwards from the cursor's position:
|
5121
|
+
*
|
5122
|
+
* ```json
|
5123
|
+
* POST /db/demo:main/tables/table/query
|
5124
|
+
* {
|
5125
|
+
* "page": {
|
5126
|
+
* "size": 200,
|
5127
|
+
* "offset": 800,
|
5128
|
+
* "after": "fMoxCsIwFIDh3WP8c4amDai5hO5SJCRNfaVSeC9b6d1FD"
|
5129
|
+
* }
|
5130
|
+
* }
|
5131
|
+
* ```
|
5132
|
+
*
|
4607
5133
|
* **Special cursors:**
|
4608
5134
|
*
|
4609
5135
|
* - `page.after=end`: Result points past the last entry. The list of records
|
@@ -4736,6 +5262,46 @@ type SearchTableVariables = {
|
|
4736
5262
|
* * filtering on columns of type `multiple` is currently unsupported
|
4737
5263
|
*/
|
4738
5264
|
declare const searchTable: (variables: SearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
|
5265
|
+
type SqlQueryPathParams = {
|
5266
|
+
/**
|
5267
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
5268
|
+
*/
|
5269
|
+
dbBranchName: DBBranchName;
|
5270
|
+
workspace: string;
|
5271
|
+
region: string;
|
5272
|
+
};
|
5273
|
+
type SqlQueryError = ErrorWrapper<{
|
5274
|
+
status: 400;
|
5275
|
+
payload: BadRequestError;
|
5276
|
+
} | {
|
5277
|
+
status: 401;
|
5278
|
+
payload: AuthError;
|
5279
|
+
} | {
|
5280
|
+
status: 404;
|
5281
|
+
payload: SimpleError;
|
5282
|
+
}>;
|
5283
|
+
type SqlQueryRequestBody = {
|
5284
|
+
/**
|
5285
|
+
* The query string.
|
5286
|
+
*
|
5287
|
+
* @minLength 1
|
5288
|
+
*/
|
5289
|
+
query: string;
|
5290
|
+
/**
|
5291
|
+
* The consistency level for this request.
|
5292
|
+
*
|
5293
|
+
* @default strong
|
5294
|
+
*/
|
5295
|
+
consistency?: 'strong' | 'eventual';
|
5296
|
+
};
|
5297
|
+
type SqlQueryVariables = {
|
5298
|
+
body: SqlQueryRequestBody;
|
5299
|
+
pathParams: SqlQueryPathParams;
|
5300
|
+
} & DataPlaneFetcherExtraProps;
|
5301
|
+
/**
|
5302
|
+
* Run an SQL query across the database branch.
|
5303
|
+
*/
|
5304
|
+
declare const sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<SQLResponse>;
|
4739
5305
|
type VectorSearchTablePathParams = {
|
4740
5306
|
/**
|
4741
5307
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -4834,11 +5400,42 @@ type AskTableRequestBody = {
|
|
4834
5400
|
* @minLength 3
|
4835
5401
|
*/
|
4836
5402
|
question: string;
|
4837
|
-
|
4838
|
-
|
4839
|
-
|
4840
|
-
|
4841
|
-
|
5403
|
+
/**
|
5404
|
+
* The type of search to use. If set to `keyword` (the default), the search can be configured by passing
|
5405
|
+
* a `search` object with the following fields. For more details about each, see the Search endpoint documentation.
|
5406
|
+
* All fields are optional.
|
5407
|
+
* * fuzziness - typo tolerance
|
5408
|
+
* * target - columns to search into, and weights.
|
5409
|
+
* * prefix - prefix search type.
|
5410
|
+
* * filter - pre-filter before searching.
|
5411
|
+
* * boosters - control relevancy.
|
5412
|
+
* If set to `vector`, a `vectorSearch` object must be passed, with the following parameters. For more details, see the Vector
|
5413
|
+
* Search endpoint documentation. The `column` and `contentColumn` parameters are required.
|
5414
|
+
* * column - the vector column containing the embeddings.
|
5415
|
+
* * contentColumn - the column that contains the text from which the embeddings where computed.
|
5416
|
+
* * filter - pre-filter before searching.
|
5417
|
+
*
|
5418
|
+
* @default keyword
|
5419
|
+
*/
|
5420
|
+
searchType?: 'keyword' | 'vector';
|
5421
|
+
search?: {
|
5422
|
+
fuzziness?: FuzzinessExpression;
|
5423
|
+
target?: TargetExpression;
|
5424
|
+
prefix?: PrefixExpression;
|
5425
|
+
filter?: FilterExpression;
|
5426
|
+
boosters?: BoosterExpression[];
|
5427
|
+
};
|
5428
|
+
vectorSearch?: {
|
5429
|
+
/**
|
5430
|
+
* The column to use for vector search. It must be of type `vector`.
|
5431
|
+
*/
|
5432
|
+
column: string;
|
5433
|
+
/**
|
5434
|
+
* The column containing the text for vector search. Must be of type `text`.
|
5435
|
+
*/
|
5436
|
+
contentColumn: string;
|
5437
|
+
filter?: FilterExpression;
|
5438
|
+
};
|
4842
5439
|
rules?: string[];
|
4843
5440
|
};
|
4844
5441
|
type AskTableVariables = {
|
@@ -4995,7 +5592,7 @@ type AggregateTableVariables = {
|
|
4995
5592
|
pathParams: AggregateTablePathParams;
|
4996
5593
|
} & DataPlaneFetcherExtraProps;
|
4997
5594
|
/**
|
4998
|
-
* This endpoint allows you to run
|
5595
|
+
* This endpoint allows you to run aggregations (analytics) on the data from one table.
|
4999
5596
|
* While the summary endpoint is served from a transactional store and the results are strongly
|
5000
5597
|
* consistent, the aggregate endpoint is served from our columnar store and the results are
|
5001
5598
|
* only eventually consistent. On the other hand, the aggregate endpoint uses a
|
@@ -5005,6 +5602,38 @@ type AggregateTableVariables = {
|
|
5005
5602
|
* For usage, see the [API Guide](https://xata.io/docs/api-guide/aggregate).
|
5006
5603
|
*/
|
5007
5604
|
declare const aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal) => Promise<AggResponse>;
|
5605
|
+
type FileAccessPathParams = {
|
5606
|
+
/**
|
5607
|
+
* The File Access Identifier
|
5608
|
+
*/
|
5609
|
+
fileId: FileAccessID;
|
5610
|
+
workspace: string;
|
5611
|
+
region: string;
|
5612
|
+
};
|
5613
|
+
type FileAccessQueryParams = {
|
5614
|
+
/**
|
5615
|
+
* File access signature
|
5616
|
+
*/
|
5617
|
+
verify?: FileSignature;
|
5618
|
+
};
|
5619
|
+
type FileAccessError = ErrorWrapper<{
|
5620
|
+
status: 400;
|
5621
|
+
payload: BadRequestError;
|
5622
|
+
} | {
|
5623
|
+
status: 401;
|
5624
|
+
payload: AuthError;
|
5625
|
+
} | {
|
5626
|
+
status: 404;
|
5627
|
+
payload: SimpleError;
|
5628
|
+
}>;
|
5629
|
+
type FileAccessVariables = {
|
5630
|
+
pathParams: FileAccessPathParams;
|
5631
|
+
queryParams?: FileAccessQueryParams;
|
5632
|
+
} & DataPlaneFetcherExtraProps;
|
5633
|
+
/**
|
5634
|
+
* Retrieve file content by access id
|
5635
|
+
*/
|
5636
|
+
declare const fileAccess: (variables: FileAccessVariables, signal?: AbortSignal) => Promise<undefined>;
|
5008
5637
|
|
5009
5638
|
declare const operationsByTag: {
|
5010
5639
|
branch: {
|
@@ -5012,6 +5641,7 @@ declare const operationsByTag: {
|
|
5012
5641
|
getBranchDetails: (variables: GetBranchDetailsVariables, signal?: AbortSignal | undefined) => Promise<DBBranch>;
|
5013
5642
|
createBranch: (variables: CreateBranchVariables, signal?: AbortSignal | undefined) => Promise<CreateBranchResponse>;
|
5014
5643
|
deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal | undefined) => Promise<DeleteBranchResponse>;
|
5644
|
+
copyBranch: (variables: CopyBranchVariables, signal?: AbortSignal | undefined) => Promise<BranchWithCopyID>;
|
5015
5645
|
updateBranchMetadata: (variables: UpdateBranchMetadataVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
5016
5646
|
getBranchMetadata: (variables: GetBranchMetadataVariables, signal?: AbortSignal | undefined) => Promise<BranchMetadata>;
|
5017
5647
|
getBranchStats: (variables: GetBranchStatsVariables, signal?: AbortSignal | undefined) => Promise<GetBranchStatsResponse>;
|
@@ -5020,16 +5650,6 @@ declare const operationsByTag: {
|
|
5020
5650
|
removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
5021
5651
|
resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal | undefined) => Promise<ResolveBranchResponse>;
|
5022
5652
|
};
|
5023
|
-
records: {
|
5024
|
-
branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal | undefined) => Promise<TransactionSuccess>;
|
5025
|
-
insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
5026
|
-
getRecord: (variables: GetRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
|
5027
|
-
insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
5028
|
-
updateRecordWithID: (variables: UpdateRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
5029
|
-
upsertRecordWithID: (variables: UpsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
5030
|
-
deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
|
5031
|
-
bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal | undefined) => Promise<BulkInsertResponse>;
|
5032
|
-
};
|
5033
5653
|
migrations: {
|
5034
5654
|
getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal | undefined) => Promise<GetBranchMigrationHistoryResponse>;
|
5035
5655
|
getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables, signal?: AbortSignal | undefined) => Promise<BranchMigrationPlan>;
|
@@ -5040,6 +5660,17 @@ declare const operationsByTag: {
|
|
5040
5660
|
updateBranchSchema: (variables: UpdateBranchSchemaVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
5041
5661
|
previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables, signal?: AbortSignal | undefined) => Promise<PreviewBranchSchemaEditResponse>;
|
5042
5662
|
applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
5663
|
+
pushBranchMigrations: (variables: PushBranchMigrationsVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
5664
|
+
};
|
5665
|
+
records: {
|
5666
|
+
branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal | undefined) => Promise<TransactionSuccess>;
|
5667
|
+
insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
5668
|
+
getRecord: (variables: GetRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
|
5669
|
+
insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
5670
|
+
updateRecordWithID: (variables: UpdateRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
5671
|
+
upsertRecordWithID: (variables: UpsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
5672
|
+
deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
|
5673
|
+
bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal | undefined) => Promise<BulkInsertResponse>;
|
5043
5674
|
};
|
5044
5675
|
migrationRequests: {
|
5045
5676
|
queryMigrationRequests: (variables: QueryMigrationRequestsVariables, signal?: AbortSignal | undefined) => Promise<QueryMigrationRequestsResponse>;
|
@@ -5049,7 +5680,7 @@ declare const operationsByTag: {
|
|
5049
5680
|
listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables, signal?: AbortSignal | undefined) => Promise<ListMigrationRequestsCommitsResponse>;
|
5050
5681
|
compareMigrationRequest: (variables: CompareMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<SchemaCompareResponse>;
|
5051
5682
|
getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables, signal?: AbortSignal | undefined) => Promise<GetMigrationRequestIsMergedResponse>;
|
5052
|
-
mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<
|
5683
|
+
mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<BranchOp>;
|
5053
5684
|
};
|
5054
5685
|
table: {
|
5055
5686
|
createTable: (variables: CreateTableVariables, signal?: AbortSignal | undefined) => Promise<CreateTableResponse>;
|
@@ -5063,10 +5694,20 @@ declare const operationsByTag: {
|
|
5063
5694
|
updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
5064
5695
|
deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
5065
5696
|
};
|
5697
|
+
files: {
|
5698
|
+
getFileItem: (variables: GetFileItemVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
|
5699
|
+
putFileItem: (variables: PutFileItemVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
|
5700
|
+
deleteFileItem: (variables: DeleteFileItemVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
|
5701
|
+
getFile: (variables: GetFileVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
|
5702
|
+
putFile: (variables: PutFileVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
|
5703
|
+
deleteFile: (variables: DeleteFileVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
|
5704
|
+
fileAccess: (variables: FileAccessVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
5705
|
+
};
|
5066
5706
|
searchAndFilter: {
|
5067
5707
|
queryTable: (variables: QueryTableVariables, signal?: AbortSignal | undefined) => Promise<QueryResponse>;
|
5068
5708
|
searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
|
5069
5709
|
searchTable: (variables: SearchTableVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
|
5710
|
+
sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal | undefined) => Promise<SQLResponse>;
|
5070
5711
|
vectorSearchTable: (variables: VectorSearchTableVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
|
5071
5712
|
askTable: (variables: AskTableVariables, signal?: AbortSignal | undefined) => Promise<AskTableResponse>;
|
5072
5713
|
summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal | undefined) => Promise<SummarizeResponse>;
|
@@ -5105,6 +5746,7 @@ declare const operationsByTag: {
|
|
5105
5746
|
deleteDatabase: (variables: DeleteDatabaseVariables, signal?: AbortSignal | undefined) => Promise<DeleteDatabaseResponse>;
|
5106
5747
|
getDatabaseMetadata: (variables: GetDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
|
5107
5748
|
updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
|
5749
|
+
renameDatabase: (variables: RenameDatabaseVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
|
5108
5750
|
getDatabaseGithubSettings: (variables: GetDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<DatabaseGithubSettings>;
|
5109
5751
|
updateDatabaseGithubSettings: (variables: UpdateDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<DatabaseGithubSettings>;
|
5110
5752
|
deleteDatabaseGithubSettings: (variables: DeleteDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
@@ -5112,7 +5754,7 @@ declare const operationsByTag: {
|
|
5112
5754
|
};
|
5113
5755
|
};
|
5114
5756
|
|
5115
|
-
type HostAliases = 'production' | 'staging';
|
5757
|
+
type HostAliases = 'production' | 'staging' | 'dev';
|
5116
5758
|
type ProviderBuilder = {
|
5117
5759
|
main: string;
|
5118
5760
|
workspaces: string;
|
@@ -5122,6 +5764,7 @@ declare function getHostUrl(provider: HostProvider, type: keyof ProviderBuilder)
|
|
5122
5764
|
declare function isHostProviderAlias(alias: HostProvider | string): alias is HostAliases;
|
5123
5765
|
declare function isHostProviderBuilder(builder: HostProvider): builder is ProviderBuilder;
|
5124
5766
|
declare function parseProviderString(provider?: string): HostProvider | null;
|
5767
|
+
declare function buildProviderString(provider: HostProvider): string;
|
5125
5768
|
declare function parseWorkspacesUrlParts(url: string): {
|
5126
5769
|
workspace: string;
|
5127
5770
|
region: string;
|
@@ -5133,10 +5776,12 @@ type responses_BadRequestError = BadRequestError;
|
|
5133
5776
|
type responses_BranchMigrationPlan = BranchMigrationPlan;
|
5134
5777
|
type responses_BulkError = BulkError;
|
5135
5778
|
type responses_BulkInsertResponse = BulkInsertResponse;
|
5779
|
+
type responses_PutFileResponse = PutFileResponse;
|
5136
5780
|
type responses_QueryResponse = QueryResponse;
|
5137
5781
|
type responses_RateLimitError = RateLimitError;
|
5138
5782
|
type responses_RecordResponse = RecordResponse;
|
5139
5783
|
type responses_RecordUpdateResponse = RecordUpdateResponse;
|
5784
|
+
type responses_SQLResponse = SQLResponse;
|
5140
5785
|
type responses_SchemaCompareResponse = SchemaCompareResponse;
|
5141
5786
|
type responses_SchemaUpdateResponse = SchemaUpdateResponse;
|
5142
5787
|
type responses_SearchResponse = SearchResponse;
|
@@ -5150,10 +5795,12 @@ declare namespace responses {
|
|
5150
5795
|
responses_BranchMigrationPlan as BranchMigrationPlan,
|
5151
5796
|
responses_BulkError as BulkError,
|
5152
5797
|
responses_BulkInsertResponse as BulkInsertResponse,
|
5798
|
+
responses_PutFileResponse as PutFileResponse,
|
5153
5799
|
responses_QueryResponse as QueryResponse,
|
5154
5800
|
responses_RateLimitError as RateLimitError,
|
5155
5801
|
responses_RecordResponse as RecordResponse,
|
5156
5802
|
responses_RecordUpdateResponse as RecordUpdateResponse,
|
5803
|
+
responses_SQLResponse as SQLResponse,
|
5157
5804
|
responses_SchemaCompareResponse as SchemaCompareResponse,
|
5158
5805
|
responses_SchemaUpdateResponse as SchemaUpdateResponse,
|
5159
5806
|
responses_SearchResponse as SearchResponse,
|
@@ -5171,6 +5818,8 @@ type schemas_Branch = Branch;
|
|
5171
5818
|
type schemas_BranchMetadata = BranchMetadata;
|
5172
5819
|
type schemas_BranchMigration = BranchMigration;
|
5173
5820
|
type schemas_BranchName = BranchName;
|
5821
|
+
type schemas_BranchOp = BranchOp;
|
5822
|
+
type schemas_BranchWithCopyID = BranchWithCopyID;
|
5174
5823
|
type schemas_Column = Column;
|
5175
5824
|
type schemas_ColumnLink = ColumnLink;
|
5176
5825
|
type schemas_ColumnMigration = ColumnMigration;
|
@@ -5190,6 +5839,11 @@ type schemas_DatabaseGithubSettings = DatabaseGithubSettings;
|
|
5190
5839
|
type schemas_DatabaseMetadata = DatabaseMetadata;
|
5191
5840
|
type schemas_DateHistogramAgg = DateHistogramAgg;
|
5192
5841
|
type schemas_DateTime = DateTime;
|
5842
|
+
type schemas_FileAccessID = FileAccessID;
|
5843
|
+
type schemas_FileItemID = FileItemID;
|
5844
|
+
type schemas_FileName = FileName;
|
5845
|
+
type schemas_FileResponse = FileResponse;
|
5846
|
+
type schemas_FileSignature = FileSignature;
|
5193
5847
|
type schemas_FilterColumn = FilterColumn;
|
5194
5848
|
type schemas_FilterColumnIncludes = FilterColumnIncludes;
|
5195
5849
|
type schemas_FilterExpression = FilterExpression;
|
@@ -5201,6 +5855,7 @@ type schemas_FilterRangeValue = FilterRangeValue;
|
|
5201
5855
|
type schemas_FilterValue = FilterValue;
|
5202
5856
|
type schemas_FuzzinessExpression = FuzzinessExpression;
|
5203
5857
|
type schemas_HighlightExpression = HighlightExpression;
|
5858
|
+
type schemas_InputFile = InputFile;
|
5204
5859
|
type schemas_InputFileArray = InputFileArray;
|
5205
5860
|
type schemas_InputFileEntry = InputFileEntry;
|
5206
5861
|
type schemas_InviteID = InviteID;
|
@@ -5210,10 +5865,12 @@ type schemas_ListDatabasesResponse = ListDatabasesResponse;
|
|
5210
5865
|
type schemas_ListGitBranchesResponse = ListGitBranchesResponse;
|
5211
5866
|
type schemas_ListRegionsResponse = ListRegionsResponse;
|
5212
5867
|
type schemas_MaxAgg = MaxAgg;
|
5868
|
+
type schemas_MediaType = MediaType;
|
5213
5869
|
type schemas_MetricsDatapoint = MetricsDatapoint;
|
5214
5870
|
type schemas_MetricsLatency = MetricsLatency;
|
5215
5871
|
type schemas_Migration = Migration;
|
5216
5872
|
type schemas_MigrationColumnOp = MigrationColumnOp;
|
5873
|
+
type schemas_MigrationObject = MigrationObject;
|
5217
5874
|
type schemas_MigrationOp = MigrationOp;
|
5218
5875
|
type schemas_MigrationRequest = MigrationRequest;
|
5219
5876
|
type schemas_MigrationRequestNumber = MigrationRequestNumber;
|
@@ -5230,6 +5887,7 @@ type schemas_RecordsMetadata = RecordsMetadata;
|
|
5230
5887
|
type schemas_Region = Region;
|
5231
5888
|
type schemas_RevLink = RevLink;
|
5232
5889
|
type schemas_Role = Role;
|
5890
|
+
type schemas_SQLRecord = SQLRecord;
|
5233
5891
|
type schemas_Schema = Schema;
|
5234
5892
|
type schemas_SchemaEditScript = SchemaEditScript;
|
5235
5893
|
type schemas_SearchPageConfig = SearchPageConfig;
|
@@ -5251,9 +5909,11 @@ type schemas_TopValuesAgg = TopValuesAgg;
|
|
5251
5909
|
type schemas_TransactionDeleteOp = TransactionDeleteOp;
|
5252
5910
|
type schemas_TransactionError = TransactionError;
|
5253
5911
|
type schemas_TransactionFailure = TransactionFailure;
|
5912
|
+
type schemas_TransactionGetOp = TransactionGetOp;
|
5254
5913
|
type schemas_TransactionInsertOp = TransactionInsertOp;
|
5255
5914
|
type schemas_TransactionResultColumns = TransactionResultColumns;
|
5256
5915
|
type schemas_TransactionResultDelete = TransactionResultDelete;
|
5916
|
+
type schemas_TransactionResultGet = TransactionResultGet;
|
5257
5917
|
type schemas_TransactionResultInsert = TransactionResultInsert;
|
5258
5918
|
type schemas_TransactionResultUpdate = TransactionResultUpdate;
|
5259
5919
|
type schemas_TransactionSuccess = TransactionSuccess;
|
@@ -5280,6 +5940,8 @@ declare namespace schemas {
|
|
5280
5940
|
schemas_BranchMetadata as BranchMetadata,
|
5281
5941
|
schemas_BranchMigration as BranchMigration,
|
5282
5942
|
schemas_BranchName as BranchName,
|
5943
|
+
schemas_BranchOp as BranchOp,
|
5944
|
+
schemas_BranchWithCopyID as BranchWithCopyID,
|
5283
5945
|
schemas_Column as Column,
|
5284
5946
|
schemas_ColumnLink as ColumnLink,
|
5285
5947
|
schemas_ColumnMigration as ColumnMigration,
|
@@ -5300,6 +5962,11 @@ declare namespace schemas {
|
|
5300
5962
|
DateBooster$1 as DateBooster,
|
5301
5963
|
schemas_DateHistogramAgg as DateHistogramAgg,
|
5302
5964
|
schemas_DateTime as DateTime,
|
5965
|
+
schemas_FileAccessID as FileAccessID,
|
5966
|
+
schemas_FileItemID as FileItemID,
|
5967
|
+
schemas_FileName as FileName,
|
5968
|
+
schemas_FileResponse as FileResponse,
|
5969
|
+
schemas_FileSignature as FileSignature,
|
5303
5970
|
schemas_FilterColumn as FilterColumn,
|
5304
5971
|
schemas_FilterColumnIncludes as FilterColumnIncludes,
|
5305
5972
|
schemas_FilterExpression as FilterExpression,
|
@@ -5311,6 +5978,7 @@ declare namespace schemas {
|
|
5311
5978
|
schemas_FilterValue as FilterValue,
|
5312
5979
|
schemas_FuzzinessExpression as FuzzinessExpression,
|
5313
5980
|
schemas_HighlightExpression as HighlightExpression,
|
5981
|
+
schemas_InputFile as InputFile,
|
5314
5982
|
schemas_InputFileArray as InputFileArray,
|
5315
5983
|
schemas_InputFileEntry as InputFileEntry,
|
5316
5984
|
schemas_InviteID as InviteID,
|
@@ -5320,10 +5988,12 @@ declare namespace schemas {
|
|
5320
5988
|
schemas_ListGitBranchesResponse as ListGitBranchesResponse,
|
5321
5989
|
schemas_ListRegionsResponse as ListRegionsResponse,
|
5322
5990
|
schemas_MaxAgg as MaxAgg,
|
5991
|
+
schemas_MediaType as MediaType,
|
5323
5992
|
schemas_MetricsDatapoint as MetricsDatapoint,
|
5324
5993
|
schemas_MetricsLatency as MetricsLatency,
|
5325
5994
|
schemas_Migration as Migration,
|
5326
5995
|
schemas_MigrationColumnOp as MigrationColumnOp,
|
5996
|
+
schemas_MigrationObject as MigrationObject,
|
5327
5997
|
schemas_MigrationOp as MigrationOp,
|
5328
5998
|
schemas_MigrationRequest as MigrationRequest,
|
5329
5999
|
schemas_MigrationRequestNumber as MigrationRequestNumber,
|
@@ -5341,6 +6011,7 @@ declare namespace schemas {
|
|
5341
6011
|
schemas_Region as Region,
|
5342
6012
|
schemas_RevLink as RevLink,
|
5343
6013
|
schemas_Role as Role,
|
6014
|
+
schemas_SQLRecord as SQLRecord,
|
5344
6015
|
schemas_Schema as Schema,
|
5345
6016
|
schemas_SchemaEditScript as SchemaEditScript,
|
5346
6017
|
schemas_SearchPageConfig as SearchPageConfig,
|
@@ -5362,10 +6033,12 @@ declare namespace schemas {
|
|
5362
6033
|
schemas_TransactionDeleteOp as TransactionDeleteOp,
|
5363
6034
|
schemas_TransactionError as TransactionError,
|
5364
6035
|
schemas_TransactionFailure as TransactionFailure,
|
6036
|
+
schemas_TransactionGetOp as TransactionGetOp,
|
5365
6037
|
schemas_TransactionInsertOp as TransactionInsertOp,
|
5366
6038
|
TransactionOperation$1 as TransactionOperation,
|
5367
6039
|
schemas_TransactionResultColumns as TransactionResultColumns,
|
5368
6040
|
schemas_TransactionResultDelete as TransactionResultDelete,
|
6041
|
+
schemas_TransactionResultGet as TransactionResultGet,
|
5369
6042
|
schemas_TransactionResultInsert as TransactionResultInsert,
|
5370
6043
|
schemas_TransactionResultUpdate as TransactionResultUpdate,
|
5371
6044
|
schemas_TransactionSuccess as TransactionSuccess,
|
@@ -5407,6 +6080,7 @@ declare class XataApiClient {
|
|
5407
6080
|
get migrationRequests(): MigrationRequestsApi;
|
5408
6081
|
get tables(): TableApi;
|
5409
6082
|
get records(): RecordsApi;
|
6083
|
+
get files(): FilesApi;
|
5410
6084
|
get searchAndFilter(): SearchAndFilterApi;
|
5411
6085
|
}
|
5412
6086
|
declare class UserApi {
|
@@ -5513,6 +6187,14 @@ declare class BranchApi {
|
|
5513
6187
|
database: DBName;
|
5514
6188
|
branch: BranchName;
|
5515
6189
|
}): Promise<DeleteBranchResponse>;
|
6190
|
+
copyBranch({ workspace, region, database, branch, destinationBranch, limit }: {
|
6191
|
+
workspace: WorkspaceID;
|
6192
|
+
region: string;
|
6193
|
+
database: DBName;
|
6194
|
+
branch: BranchName;
|
6195
|
+
destinationBranch: BranchName;
|
6196
|
+
limit?: number;
|
6197
|
+
}): Promise<BranchWithCopyID>;
|
5516
6198
|
updateBranchMetadata({ workspace, region, database, branch, metadata }: {
|
5517
6199
|
workspace: WorkspaceID;
|
5518
6200
|
region: string;
|
@@ -5720,6 +6402,75 @@ declare class RecordsApi {
|
|
5720
6402
|
operations: TransactionOperation$1[];
|
5721
6403
|
}): Promise<TransactionSuccess>;
|
5722
6404
|
}
|
6405
|
+
declare class FilesApi {
|
6406
|
+
private extraProps;
|
6407
|
+
constructor(extraProps: ApiExtraProps);
|
6408
|
+
getFileItem({ workspace, region, database, branch, table, record, column, fileId }: {
|
6409
|
+
workspace: WorkspaceID;
|
6410
|
+
region: string;
|
6411
|
+
database: DBName;
|
6412
|
+
branch: BranchName;
|
6413
|
+
table: TableName;
|
6414
|
+
record: RecordID;
|
6415
|
+
column: ColumnName;
|
6416
|
+
fileId: string;
|
6417
|
+
}): Promise<any>;
|
6418
|
+
putFileItem({ workspace, region, database, branch, table, record, column, fileId, file }: {
|
6419
|
+
workspace: WorkspaceID;
|
6420
|
+
region: string;
|
6421
|
+
database: DBName;
|
6422
|
+
branch: BranchName;
|
6423
|
+
table: TableName;
|
6424
|
+
record: RecordID;
|
6425
|
+
column: ColumnName;
|
6426
|
+
fileId: string;
|
6427
|
+
file: any;
|
6428
|
+
}): Promise<PutFileResponse>;
|
6429
|
+
deleteFileItem({ workspace, region, database, branch, table, record, column, fileId }: {
|
6430
|
+
workspace: WorkspaceID;
|
6431
|
+
region: string;
|
6432
|
+
database: DBName;
|
6433
|
+
branch: BranchName;
|
6434
|
+
table: TableName;
|
6435
|
+
record: RecordID;
|
6436
|
+
column: ColumnName;
|
6437
|
+
fileId: string;
|
6438
|
+
}): Promise<PutFileResponse>;
|
6439
|
+
getFile({ workspace, region, database, branch, table, record, column }: {
|
6440
|
+
workspace: WorkspaceID;
|
6441
|
+
region: string;
|
6442
|
+
database: DBName;
|
6443
|
+
branch: BranchName;
|
6444
|
+
table: TableName;
|
6445
|
+
record: RecordID;
|
6446
|
+
column: ColumnName;
|
6447
|
+
}): Promise<any>;
|
6448
|
+
putFile({ workspace, region, database, branch, table, record, column, file }: {
|
6449
|
+
workspace: WorkspaceID;
|
6450
|
+
region: string;
|
6451
|
+
database: DBName;
|
6452
|
+
branch: BranchName;
|
6453
|
+
table: TableName;
|
6454
|
+
record: RecordID;
|
6455
|
+
column: ColumnName;
|
6456
|
+
file: Blob;
|
6457
|
+
}): Promise<PutFileResponse>;
|
6458
|
+
deleteFile({ workspace, region, database, branch, table, record, column }: {
|
6459
|
+
workspace: WorkspaceID;
|
6460
|
+
region: string;
|
6461
|
+
database: DBName;
|
6462
|
+
branch: BranchName;
|
6463
|
+
table: TableName;
|
6464
|
+
record: RecordID;
|
6465
|
+
column: ColumnName;
|
6466
|
+
}): Promise<PutFileResponse>;
|
6467
|
+
fileAccess({ workspace, region, fileId, verify }: {
|
6468
|
+
workspace: WorkspaceID;
|
6469
|
+
region: string;
|
6470
|
+
fileId: string;
|
6471
|
+
verify?: FileSignature;
|
6472
|
+
}): Promise<any>;
|
6473
|
+
}
|
5723
6474
|
declare class SearchAndFilterApi {
|
5724
6475
|
private extraProps;
|
5725
6476
|
constructor(extraProps: ApiExtraProps);
|
@@ -5777,19 +6528,13 @@ declare class SearchAndFilterApi {
|
|
5777
6528
|
size?: number;
|
5778
6529
|
filter?: FilterExpression;
|
5779
6530
|
}): Promise<SearchResponse>;
|
5780
|
-
askTable({ workspace, region, database, branch, table,
|
6531
|
+
askTable({ workspace, region, database, branch, table, options }: {
|
5781
6532
|
workspace: WorkspaceID;
|
5782
6533
|
region: string;
|
5783
6534
|
database: DBName;
|
5784
6535
|
branch: BranchName;
|
5785
6536
|
table: TableName;
|
5786
|
-
|
5787
|
-
fuzziness?: FuzzinessExpression;
|
5788
|
-
target?: TargetExpression;
|
5789
|
-
prefix?: PrefixExpression;
|
5790
|
-
filter?: FilterExpression;
|
5791
|
-
boosters?: BoosterExpression[];
|
5792
|
-
rules?: string[];
|
6537
|
+
options: AskTableRequestBody;
|
5793
6538
|
}): Promise<AskTableResponse>;
|
5794
6539
|
summarizeTable({ workspace, region, database, branch, table, filter, columns, summaries, sort, summariesFilter, page, consistency }: {
|
5795
6540
|
workspace: WorkspaceID;
|
@@ -5876,7 +6621,7 @@ declare class MigrationRequestsApi {
|
|
5876
6621
|
region: string;
|
5877
6622
|
database: DBName;
|
5878
6623
|
migrationRequest: MigrationRequestNumber;
|
5879
|
-
}): Promise<
|
6624
|
+
}): Promise<BranchOp>;
|
5880
6625
|
}
|
5881
6626
|
declare class MigrationsApi {
|
5882
6627
|
private extraProps;
|
@@ -5955,6 +6700,13 @@ declare class MigrationsApi {
|
|
5955
6700
|
branch: BranchName;
|
5956
6701
|
edits: SchemaEditScript;
|
5957
6702
|
}): Promise<SchemaUpdateResponse>;
|
6703
|
+
pushBranchMigrations({ workspace, region, database, branch, migrations }: {
|
6704
|
+
workspace: WorkspaceID;
|
6705
|
+
region: string;
|
6706
|
+
database: DBName;
|
6707
|
+
branch: BranchName;
|
6708
|
+
migrations: MigrationObject[];
|
6709
|
+
}): Promise<SchemaUpdateResponse>;
|
5958
6710
|
}
|
5959
6711
|
declare class DatabaseApi {
|
5960
6712
|
private extraProps;
|
@@ -5980,6 +6732,11 @@ declare class DatabaseApi {
|
|
5980
6732
|
database: DBName;
|
5981
6733
|
metadata: DatabaseMetadata;
|
5982
6734
|
}): Promise<DatabaseMetadata>;
|
6735
|
+
renameDatabase({ workspace, database, newName }: {
|
6736
|
+
workspace: WorkspaceID;
|
6737
|
+
database: DBName;
|
6738
|
+
newName: DBName;
|
6739
|
+
}): Promise<DatabaseMetadata>;
|
5983
6740
|
getDatabaseGithubSettings({ workspace, database }: {
|
5984
6741
|
workspace: WorkspaceID;
|
5985
6742
|
database: DBName;
|
@@ -6045,9 +6802,9 @@ type ColumnsByValue<O, Value> = Values<{
|
|
6045
6802
|
type SelectedPick<O extends XataRecord, Key extends SelectableColumn<O>[]> = XataRecord<O> & UnionToIntersection<Values<{
|
6046
6803
|
[K in Key[number]]: NestedValueAtColumn<O, K> & XataRecord<O>;
|
6047
6804
|
}>>;
|
6048
|
-
type ValueAtColumn<
|
6805
|
+
type ValueAtColumn<Object, Key> = Key extends '*' ? Values<Object> : Key extends 'id' ? string : Key extends 'xata.version' ? number : Key extends 'xata.createdAt' ? Date : Key extends 'xata.updatedAt' ? Date : Key extends keyof Object ? Object[Key] : Key extends `${infer K}.${infer V}` ? K extends keyof Object ? Values<NonNullable<Object[K]> extends infer Item ? Item extends Record<string, any> ? V extends SelectableColumn<Item> ? {
|
6049
6806
|
V: ValueAtColumn<Item, V>;
|
6050
|
-
} : never :
|
6807
|
+
} : never : Object[K] : never> : never : never;
|
6051
6808
|
type MAX_RECURSION = 2;
|
6052
6809
|
type NestedColumns<O, RecursivePath extends any[]> = RecursivePath['length'] extends MAX_RECURSION ? never : If<IsObject<O>, Values<{
|
6053
6810
|
[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
|
@@ -6080,8 +6837,13 @@ interface BaseData {
|
|
6080
6837
|
* Represents a persisted record from the database.
|
6081
6838
|
*/
|
6082
6839
|
interface XataRecord<OriginalRecord extends XataRecord<any> = XataRecord<any>> extends Identifiable {
|
6840
|
+
/**
|
6841
|
+
* Metadata of this record.
|
6842
|
+
*/
|
6843
|
+
xata: XataRecordMetadata;
|
6083
6844
|
/**
|
6084
6845
|
* Get metadata of this record.
|
6846
|
+
* @deprecated Use `xata` property instead.
|
6085
6847
|
*/
|
6086
6848
|
getMetadata(): XataRecordMetadata;
|
6087
6849
|
/**
|
@@ -6160,23 +6922,59 @@ type XataRecordMetadata = {
|
|
6160
6922
|
* Number that is increased every time the record is updated.
|
6161
6923
|
*/
|
6162
6924
|
version: number;
|
6163
|
-
|
6925
|
+
/**
|
6926
|
+
* Timestamp when the record was created.
|
6927
|
+
*/
|
6928
|
+
createdAt: Date;
|
6929
|
+
/**
|
6930
|
+
* Timestamp when the record was last updated.
|
6931
|
+
*/
|
6932
|
+
updatedAt: Date;
|
6164
6933
|
};
|
6165
6934
|
declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
|
6166
6935
|
declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;
|
6936
|
+
type NumericOperator = ExclusiveOr<{
|
6937
|
+
$increment?: number;
|
6938
|
+
}, ExclusiveOr<{
|
6939
|
+
$decrement?: number;
|
6940
|
+
}, ExclusiveOr<{
|
6941
|
+
$multiply?: number;
|
6942
|
+
}, {
|
6943
|
+
$divide?: number;
|
6944
|
+
}>>>;
|
6167
6945
|
type EditableDataFields<T> = T extends XataRecord ? {
|
6168
6946
|
id: string;
|
6169
6947
|
} | string : NonNullable<T> extends XataRecord ? {
|
6170
6948
|
id: string;
|
6171
|
-
} | string | null | undefined : T extends Date ? string | Date : NonNullable<T> extends Date ? string | Date | null | undefined : T;
|
6949
|
+
} | string | null | undefined : T extends Date ? string | Date : NonNullable<T> extends Date ? string | Date | null | undefined : T extends number ? number | NumericOperator : T;
|
6172
6950
|
type EditableData<O extends XataRecord> = Identifiable & Partial<Omit<{
|
6173
6951
|
[K in keyof O]: EditableDataFields<O[K]>;
|
6174
6952
|
}, keyof XataRecord>>;
|
6175
6953
|
type JSONDataFields<T> = T extends XataRecord ? string : NonNullable<T> extends XataRecord ? string | null | undefined : T extends Date ? string : NonNullable<T> extends Date ? string | null | undefined : T;
|
6176
|
-
type
|
6954
|
+
type JSONDataBase = Identifiable & {
|
6955
|
+
/**
|
6956
|
+
* Metadata about the record.
|
6957
|
+
*/
|
6958
|
+
xata: {
|
6959
|
+
/**
|
6960
|
+
* Timestamp when the record was created.
|
6961
|
+
*/
|
6962
|
+
createdAt: string;
|
6963
|
+
/**
|
6964
|
+
* Timestamp when the record was last updated.
|
6965
|
+
*/
|
6966
|
+
updatedAt: string;
|
6967
|
+
/**
|
6968
|
+
* Number that is increased every time the record is updated.
|
6969
|
+
*/
|
6970
|
+
version: number;
|
6971
|
+
};
|
6972
|
+
};
|
6973
|
+
type JSONData<O> = JSONDataBase & Partial<Omit<{
|
6177
6974
|
[K in keyof O]: JSONDataFields<O[K]>;
|
6178
6975
|
}, keyof XataRecord>>;
|
6179
6976
|
|
6977
|
+
type FilterColumns<T> = ColumnsByValue<T, any> | `xata.${keyof XataRecordMetadata}`;
|
6180
6978
|
/**
|
6181
6979
|
* PropertyMatchFilter
|
6182
6980
|
* Example:
|
@@ -6196,7 +6994,7 @@ type JSONData<O> = Identifiable & Partial<Omit<{
|
|
6196
6994
|
}
|
6197
6995
|
*/
|
6198
6996
|
type PropertyAccessFilter<Record> = {
|
6199
|
-
[key in
|
6997
|
+
[key in FilterColumns<Record>]?: NestedApiFilter<ValueAtColumn<Record, key>> | PropertyFilter<ValueAtColumn<Record, key>>;
|
6200
6998
|
};
|
6201
6999
|
type PropertyFilter<T> = T | {
|
6202
7000
|
$is: T;
|
@@ -6258,7 +7056,7 @@ type AggregatorFilter<T> = {
|
|
6258
7056
|
* Example: { filter: { $exists: "settings" } }
|
6259
7057
|
*/
|
6260
7058
|
type ExistanceFilter<Record> = {
|
6261
|
-
[key in '$exists' | '$notExists']?:
|
7059
|
+
[key in '$exists' | '$notExists']?: FilterColumns<Record>;
|
6262
7060
|
};
|
6263
7061
|
type BaseApiFilter<Record> = PropertyAccessFilter<Record> | AggregatorFilter<Record> | ExistanceFilter<Record>;
|
6264
7062
|
/**
|
@@ -6275,6 +7073,12 @@ type DateBooster = {
|
|
6275
7073
|
origin?: string;
|
6276
7074
|
scale: string;
|
6277
7075
|
decay: number;
|
7076
|
+
/**
|
7077
|
+
* The factor with which to multiply the added boost.
|
7078
|
+
*
|
7079
|
+
* @minimum 0
|
7080
|
+
*/
|
7081
|
+
factor?: number;
|
6278
7082
|
};
|
6279
7083
|
type NumericBooster = {
|
6280
7084
|
factor: number;
|
@@ -6581,13 +7385,55 @@ type ComplexAggregationResult = {
|
|
6581
7385
|
}>;
|
6582
7386
|
};
|
6583
7387
|
|
7388
|
+
type KeywordAskOptions<Record extends XataRecord> = {
|
7389
|
+
searchType: 'keyword';
|
7390
|
+
search?: {
|
7391
|
+
fuzziness?: FuzzinessExpression;
|
7392
|
+
target?: TargetColumn<Record>[];
|
7393
|
+
prefix?: PrefixExpression;
|
7394
|
+
filter?: Filter<Record>;
|
7395
|
+
boosters?: Boosters<Record>[];
|
7396
|
+
};
|
7397
|
+
};
|
7398
|
+
type VectorAskOptions<Record extends XataRecord> = {
|
7399
|
+
searchType: 'vector';
|
7400
|
+
vectorSearch?: {
|
7401
|
+
/**
|
7402
|
+
* The column to use for vector search. It must be of type `vector`.
|
7403
|
+
*/
|
7404
|
+
column: string;
|
7405
|
+
/**
|
7406
|
+
* The column containing the text for vector search. Must be of type `text`.
|
7407
|
+
*/
|
7408
|
+
contentColumn: string;
|
7409
|
+
filter?: Filter<Record>;
|
7410
|
+
};
|
7411
|
+
};
|
7412
|
+
type TypeAskOptions<Record extends XataRecord> = KeywordAskOptions<Record> | VectorAskOptions<Record>;
|
7413
|
+
type BaseAskOptions = {
|
7414
|
+
rules?: string[];
|
7415
|
+
};
|
7416
|
+
type AskOptions<Record extends XataRecord> = TypeAskOptions<Record> & BaseAskOptions;
|
7417
|
+
type AskResult = {
|
7418
|
+
answer?: string;
|
7419
|
+
records?: string[];
|
7420
|
+
};
|
7421
|
+
|
6584
7422
|
type SortDirection = 'asc' | 'desc';
|
6585
|
-
type
|
7423
|
+
type RandomFilter = {
|
7424
|
+
'*': 'random';
|
7425
|
+
};
|
7426
|
+
type RandomFilterExtended = {
|
7427
|
+
column: '*';
|
7428
|
+
direction: 'random';
|
7429
|
+
};
|
7430
|
+
type SortColumns<T extends XataRecord> = ColumnsByValue<T, any> | `xata.${keyof XataRecordMetadata}`;
|
7431
|
+
type SortFilterExtended<T extends XataRecord, Columns extends string = SortColumns<T>> = RandomFilterExtended | {
|
6586
7432
|
column: Columns;
|
6587
7433
|
direction?: SortDirection;
|
6588
7434
|
};
|
6589
|
-
type SortFilter<T extends XataRecord, Columns extends string =
|
6590
|
-
type SortFilterBase<T extends XataRecord, Columns extends string =
|
7435
|
+
type SortFilter<T extends XataRecord, Columns extends string = SortColumns<T>> = Columns | SortFilterExtended<T, Columns> | SortFilterBase<T, Columns> | RandomFilter;
|
7436
|
+
type SortFilterBase<T extends XataRecord, Columns extends string = SortColumns<T>> = Values<{
|
6591
7437
|
[Key in Columns]: {
|
6592
7438
|
[K in Key]: SortDirection;
|
6593
7439
|
};
|
@@ -6718,7 +7564,9 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
6718
7564
|
* @param direction The direction. Either ascending or descending.
|
6719
7565
|
* @returns A new Query object.
|
6720
7566
|
*/
|
6721
|
-
sort<F extends ColumnsByValue<Record, any>>(column: F, direction
|
7567
|
+
sort<F extends ColumnsByValue<Record, any>>(column: F, direction: SortDirection): Query<Record, Result>;
|
7568
|
+
sort(column: '*', direction: 'random'): Query<Record, Result>;
|
7569
|
+
sort<F extends ColumnsByValue<Record, any>>(column: F): Query<Record, Result>;
|
6722
7570
|
/**
|
6723
7571
|
* Builds a new query specifying the set of columns to be returned in the query response.
|
6724
7572
|
* @param columns Array of column names to be returned by the query.
|
@@ -6744,7 +7592,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
6744
7592
|
* @param options Pagination options
|
6745
7593
|
* @returns A page of results
|
6746
7594
|
*/
|
6747
|
-
getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, typeof options['columns']>>>;
|
7595
|
+
getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, (typeof options)['columns']>>>;
|
6748
7596
|
/**
|
6749
7597
|
* Get results in an iterator
|
6750
7598
|
*
|
@@ -6775,7 +7623,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
6775
7623
|
*/
|
6776
7624
|
getIterator<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
|
6777
7625
|
batchSize?: number;
|
6778
|
-
}>(options: Options): AsyncGenerator<SelectedPick<Record, typeof options['columns']>[]>;
|
7626
|
+
}>(options: Options): AsyncGenerator<SelectedPick<Record, (typeof options)['columns']>[]>;
|
6779
7627
|
/**
|
6780
7628
|
* Performs the query in the database and returns a set of results.
|
6781
7629
|
* @returns An array of records from the database.
|
@@ -6786,7 +7634,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
6786
7634
|
* @param options Additional options to be used when performing the query.
|
6787
7635
|
* @returns An array of records from the database.
|
6788
7636
|
*/
|
6789
|
-
getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<RecordArray<SelectedPick<Record, typeof options['columns']>>>;
|
7637
|
+
getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<RecordArray<SelectedPick<Record, (typeof options)['columns']>>>;
|
6790
7638
|
/**
|
6791
7639
|
* Performs the query in the database and returns a set of results.
|
6792
7640
|
* @param options Additional options to be used when performing the query.
|
@@ -6807,7 +7655,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
6807
7655
|
*/
|
6808
7656
|
getAll<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
|
6809
7657
|
batchSize?: number;
|
6810
|
-
}>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
|
7658
|
+
}>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']>[]>;
|
6811
7659
|
/**
|
6812
7660
|
* Performs the query in the database and returns all the results.
|
6813
7661
|
* Warning: If there are a large number of results, this method can have performance implications.
|
@@ -6827,7 +7675,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
6827
7675
|
* @param options Additional options to be used when performing the query.
|
6828
7676
|
* @returns The first record that matches the query, or null if no record matched the query.
|
6829
7677
|
*/
|
6830
|
-
getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']> | null>;
|
7678
|
+
getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']> | null>;
|
6831
7679
|
/**
|
6832
7680
|
* Performs the query in the database and returns the first result.
|
6833
7681
|
* @param options Additional options to be used when performing the query.
|
@@ -6846,7 +7694,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
6846
7694
|
* @returns The first record that matches the query, or null if no record matched the query.
|
6847
7695
|
* @throws if there are no results.
|
6848
7696
|
*/
|
6849
|
-
getFirstOrThrow<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>>;
|
7697
|
+
getFirstOrThrow<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']>>;
|
6850
7698
|
/**
|
6851
7699
|
* Performs the query in the database and returns the first result.
|
6852
7700
|
* @param options Additional options to be used when performing the query.
|
@@ -6895,6 +7743,7 @@ type PaginationQueryMeta = {
|
|
6895
7743
|
page: {
|
6896
7744
|
cursor: string;
|
6897
7745
|
more: boolean;
|
7746
|
+
size: number;
|
6898
7747
|
};
|
6899
7748
|
};
|
6900
7749
|
interface Paginable<Record extends XataRecord, Result extends XataRecord = Record> {
|
@@ -7536,6 +8385,16 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
7536
8385
|
* @returns The requested aggregations.
|
7537
8386
|
*/
|
7538
8387
|
abstract aggregate<Expression extends Dictionary<AggregationExpression<Record>>>(expression?: Expression, filter?: Filter<Record>): Promise<AggregationResult<Record, Expression>>;
|
8388
|
+
/**
|
8389
|
+
* Experimental: Ask the database to perform a natural language question.
|
8390
|
+
*/
|
8391
|
+
abstract ask(question: string, options?: AskOptions<Record>): Promise<AskResult>;
|
8392
|
+
/**
|
8393
|
+
* Experimental: Ask the database to perform a natural language question.
|
8394
|
+
*/
|
8395
|
+
abstract ask(question: string, options: AskOptions<Record> & {
|
8396
|
+
onMessage: (message: AskResult) => void;
|
8397
|
+
}): void;
|
7539
8398
|
abstract query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
|
7540
8399
|
}
|
7541
8400
|
declare class RestRepository<Record extends XataRecord> extends Query<Record, SelectedPick<Record, ['*']>> implements Repository<Record> {
|
@@ -7665,6 +8524,9 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
|
|
7665
8524
|
aggregate<Expression extends Dictionary<AggregationExpression<Record>>>(aggs?: Expression, filter?: Filter<Record>): Promise<any>;
|
7666
8525
|
query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
|
7667
8526
|
summarizeTable<Result extends XataRecord>(query: Query<Record, Result>, summaries?: Dictionary<SummarizeExpression<Record>>, summariesFilter?: FilterExpression): Promise<SummarizeResponse>;
|
8527
|
+
ask(question: string, options?: AskOptions<Record> & {
|
8528
|
+
onMessage?: (message: AskResult) => void;
|
8529
|
+
}): any;
|
7668
8530
|
}
|
7669
8531
|
|
7670
8532
|
type BaseSchema = {
|
@@ -7778,11 +8640,11 @@ declare const le: <T extends ComparableType>(value: T) => ComparableTypeFilter<T
|
|
7778
8640
|
/**
|
7779
8641
|
* Operator to restrict results to only values that are not null.
|
7780
8642
|
*/
|
7781
|
-
declare const exists: <T>(column?:
|
8643
|
+
declare const exists: <T>(column?: FilterColumns<T> | undefined) => ExistanceFilter<T>;
|
7782
8644
|
/**
|
7783
8645
|
* Operator to restrict results to only values that are null.
|
7784
8646
|
*/
|
7785
|
-
declare const notExists: <T>(column?:
|
8647
|
+
declare const notExists: <T>(column?: FilterColumns<T> | undefined) => ExistanceFilter<T>;
|
7786
8648
|
/**
|
7787
8649
|
* Operator to restrict results to only values that start with the given prefix.
|
7788
8650
|
*/
|
@@ -7872,6 +8734,7 @@ type UpdateTransactionOperation<O extends XataRecord> = {
|
|
7872
8734
|
};
|
7873
8735
|
type DeleteTransactionOperation = {
|
7874
8736
|
id: string;
|
8737
|
+
failIfMissing?: boolean;
|
7875
8738
|
};
|
7876
8739
|
type TransactionOperationSingleResult<Schema extends Record<string, BaseData>, Table extends StringKeys<Schema>, Operation extends TransactionOperation<Schema, Table>> = Operation extends {
|
7877
8740
|
insert: {
|
@@ -7968,27 +8831,31 @@ type SerializerResult<T> = T extends XataRecord ? Identifiable & Omit<{
|
|
7968
8831
|
[K in keyof T]: SerializerResult<T[K]>;
|
7969
8832
|
}, keyof XataRecord> : T extends any[] ? SerializerResult<T[number]>[] : T;
|
7970
8833
|
|
7971
|
-
declare function getAPIKey(): string | undefined;
|
7972
|
-
|
7973
8834
|
declare function getDatabaseURL(): string | undefined;
|
8835
|
+
declare function getAPIKey(): string | undefined;
|
7974
8836
|
declare function getBranch(): string | undefined;
|
8837
|
+
declare function buildPreviewBranchName({ org, branch }: {
|
8838
|
+
org: string;
|
8839
|
+
branch: string;
|
8840
|
+
}): string;
|
8841
|
+
declare function getPreviewBranch(): string | undefined;
|
7975
8842
|
|
7976
8843
|
interface Body {
|
7977
8844
|
arrayBuffer(): Promise<ArrayBuffer>;
|
7978
|
-
blob(): Promise<Blob>;
|
8845
|
+
blob(): Promise<Blob$1>;
|
7979
8846
|
formData(): Promise<FormData>;
|
7980
8847
|
json(): Promise<any>;
|
7981
8848
|
text(): Promise<string>;
|
7982
8849
|
}
|
7983
|
-
interface Blob {
|
8850
|
+
interface Blob$1 {
|
7984
8851
|
readonly size: number;
|
7985
8852
|
readonly type: string;
|
7986
8853
|
arrayBuffer(): Promise<ArrayBuffer>;
|
7987
|
-
slice(start?: number, end?: number, contentType?: string): Blob;
|
8854
|
+
slice(start?: number, end?: number, contentType?: string): Blob$1;
|
7988
8855
|
text(): Promise<string>;
|
7989
8856
|
}
|
7990
8857
|
/** Provides information about files and allows JavaScript in a web page to access their content. */
|
7991
|
-
interface File extends Blob {
|
8858
|
+
interface File extends Blob$1 {
|
7992
8859
|
readonly lastModified: number;
|
7993
8860
|
readonly name: string;
|
7994
8861
|
readonly webkitRelativePath: string;
|
@@ -7996,12 +8863,12 @@ interface File extends Blob {
|
|
7996
8863
|
type FormDataEntryValue = File | string;
|
7997
8864
|
/** 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". */
|
7998
8865
|
interface FormData {
|
7999
|
-
append(name: string, value: string | Blob, fileName?: string): void;
|
8866
|
+
append(name: string, value: string | Blob$1, fileName?: string): void;
|
8000
8867
|
delete(name: string): void;
|
8001
8868
|
get(name: string): FormDataEntryValue | null;
|
8002
8869
|
getAll(name: string): FormDataEntryValue[];
|
8003
8870
|
has(name: string): boolean;
|
8004
|
-
set(name: string, value: string | Blob, fileName?: string): void;
|
8871
|
+
set(name: string, value: string | Blob$1, fileName?: string): void;
|
8005
8872
|
forEach(callbackfn: (value: FormDataEntryValue, key: string, parent: FormData) => void, thisArg?: any): void;
|
8006
8873
|
}
|
8007
8874
|
/** 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. */
|
@@ -8058,4 +8925,4 @@ declare class XataError extends Error {
|
|
8058
8925
|
constructor(message: string, status: number);
|
8059
8926
|
}
|
8060
8927
|
|
8061
|
-
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, AggregateTableError, AggregateTablePathParams, AggregateTableRequestBody, AggregateTableVariables, ApiExtraProps, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditVariables, AskTableError, AskTablePathParams, AskTableRequestBody, AskTableResponse, AskTableVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BranchTransactionError, BranchTransactionPathParams, BranchTransactionRequestBody, BranchTransactionVariables, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, ColumnsByValue, CompareBranchSchemasError, CompareBranchSchemasPathParams, CompareBranchSchemasRequestBody, CompareBranchSchemasVariables, CompareBranchWithUserSchemaError, CompareBranchWithUserSchemaPathParams, CompareBranchWithUserSchemaRequestBody, CompareBranchWithUserSchemaVariables, CompareMigrationRequestError, CompareMigrationRequestPathParams, CompareMigrationRequestVariables, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchResponse, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateMigrationRequestError, CreateMigrationRequestPathParams, CreateMigrationRequestRequestBody, CreateMigrationRequestResponse, CreateMigrationRequestVariables, CreateTableError, CreateTablePathParams, CreateTableResponse, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchResponse, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabaseGithubSettingsError, DeleteDatabaseGithubSettingsPathParams, DeleteDatabaseGithubSettingsVariables, DeleteDatabasePathParams, DeleteDatabaseResponse, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableResponse, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, DeserializedType, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherError, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchSchemaHistoryError, GetBranchSchemaHistoryPathParams, GetBranchSchemaHistoryRequestBody, GetBranchSchemaHistoryResponse, GetBranchSchemaHistoryVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseGithubSettingsError, GetDatabaseGithubSettingsPathParams, GetDatabaseGithubSettingsVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetDatabaseMetadataError, GetDatabaseMetadataPathParams, GetDatabaseMetadataVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetMigrationRequestError, GetMigrationRequestIsMergedError, GetMigrationRequestIsMergedPathParams, GetMigrationRequestIsMergedResponse, GetMigrationRequestIsMergedVariables, GetMigrationRequestPathParams, GetMigrationRequestVariables, GetRecordError, GetRecordPathParams, GetRecordQueryParams, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, HostProvider, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, Link, ListMigrationRequestsCommitsError, ListMigrationRequestsCommitsPathParams, ListMigrationRequestsCommitsRequestBody, ListMigrationRequestsCommitsResponse, ListMigrationRequestsCommitsVariables, ListRegionsError, ListRegionsPathParams, ListRegionsVariables, MergeMigrationRequestError, MergeMigrationRequestPathParams, MergeMigrationRequestVariables, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, PreviewBranchSchemaEditError, PreviewBranchSchemaEditPathParams, PreviewBranchSchemaEditRequestBody, PreviewBranchSchemaEditResponse, PreviewBranchSchemaEditVariables, Query, QueryMigrationRequestsError, QueryMigrationRequestsPathParams, QueryMigrationRequestsRequestBody, QueryMigrationRequestsResponse, QueryMigrationRequestsVariables, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RecordArray, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaInference, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SearchTableError, SearchTablePathParams, SearchTableRequestBody, SearchTableVariables, SearchXataRecord, SelectableColumn, SelectedPick, SerializedString, Serializer, SerializerResult, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, SummarizeTableError, SummarizeTablePathParams, SummarizeTableRequestBody, SummarizeTableVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, UpdateBranchSchemaVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateDatabaseGithubSettingsError, UpdateDatabaseGithubSettingsPathParams, UpdateDatabaseGithubSettingsVariables, UpdateDatabaseMetadataError, UpdateDatabaseMetadataPathParams, UpdateDatabaseMetadataRequestBody, UpdateDatabaseMetadataVariables, UpdateMigrationRequestError, UpdateMigrationRequestPathParams, UpdateMigrationRequestRequestBody, UpdateMigrationRequestVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberInviteError, UpdateWorkspaceMemberInvitePathParams, UpdateWorkspaceMemberInviteRequestBody, UpdateWorkspaceMemberInviteVariables, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, VectorSearchTableError, VectorSearchTablePathParams, VectorSearchTableRequestBody, VectorSearchTableVariables, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, askTable, branchTransaction, buildClient, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
|
8928
|
+
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, AggregateTableError, AggregateTablePathParams, AggregateTableRequestBody, AggregateTableVariables, ApiExtraProps, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditVariables, AskOptions, AskResult, AskTableError, AskTablePathParams, AskTableRequestBody, AskTableResponse, AskTableVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BranchTransactionError, BranchTransactionPathParams, BranchTransactionRequestBody, BranchTransactionVariables, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, ColumnsByValue, CompareBranchSchemasError, CompareBranchSchemasPathParams, CompareBranchSchemasRequestBody, CompareBranchSchemasVariables, CompareBranchWithUserSchemaError, CompareBranchWithUserSchemaPathParams, CompareBranchWithUserSchemaRequestBody, CompareBranchWithUserSchemaVariables, CompareMigrationRequestError, CompareMigrationRequestPathParams, CompareMigrationRequestVariables, CopyBranchError, CopyBranchPathParams, CopyBranchRequestBody, CopyBranchVariables, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchResponse, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateMigrationRequestError, CreateMigrationRequestPathParams, CreateMigrationRequestRequestBody, CreateMigrationRequestResponse, CreateMigrationRequestVariables, CreateTableError, CreateTablePathParams, CreateTableResponse, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchResponse, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabaseGithubSettingsError, DeleteDatabaseGithubSettingsPathParams, DeleteDatabaseGithubSettingsVariables, DeleteDatabasePathParams, DeleteDatabaseResponse, DeleteDatabaseVariables, DeleteFileError, DeleteFileItemError, DeleteFileItemPathParams, DeleteFileItemVariables, DeleteFilePathParams, DeleteFileVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableResponse, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, DeserializedType, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherError, FetcherExtraProps, FileAccessError, FileAccessPathParams, FileAccessQueryParams, FileAccessVariables, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchSchemaHistoryError, GetBranchSchemaHistoryPathParams, GetBranchSchemaHistoryRequestBody, GetBranchSchemaHistoryResponse, GetBranchSchemaHistoryVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseGithubSettingsError, GetDatabaseGithubSettingsPathParams, GetDatabaseGithubSettingsVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetDatabaseMetadataError, GetDatabaseMetadataPathParams, GetDatabaseMetadataVariables, GetFileError, GetFileItemError, GetFileItemPathParams, GetFileItemVariables, GetFilePathParams, GetFileVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetMigrationRequestError, GetMigrationRequestIsMergedError, GetMigrationRequestIsMergedPathParams, GetMigrationRequestIsMergedResponse, GetMigrationRequestIsMergedVariables, GetMigrationRequestPathParams, GetMigrationRequestVariables, GetRecordError, GetRecordPathParams, GetRecordQueryParams, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, HostProvider, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, JSONData, KeywordAskOptions, Link, ListMigrationRequestsCommitsError, ListMigrationRequestsCommitsPathParams, ListMigrationRequestsCommitsRequestBody, ListMigrationRequestsCommitsResponse, ListMigrationRequestsCommitsVariables, ListRegionsError, ListRegionsPathParams, ListRegionsVariables, MergeMigrationRequestError, MergeMigrationRequestPathParams, MergeMigrationRequestVariables, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, PreviewBranchSchemaEditError, PreviewBranchSchemaEditPathParams, PreviewBranchSchemaEditRequestBody, PreviewBranchSchemaEditResponse, PreviewBranchSchemaEditVariables, PushBranchMigrationsError, PushBranchMigrationsPathParams, PushBranchMigrationsRequestBody, PushBranchMigrationsVariables, PutFileError, PutFileItemError, PutFileItemPathParams, PutFileItemVariables, PutFilePathParams, PutFileVariables, Query, QueryMigrationRequestsError, QueryMigrationRequestsPathParams, QueryMigrationRequestsRequestBody, QueryMigrationRequestsResponse, QueryMigrationRequestsVariables, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RecordArray, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, RenameDatabaseError, RenameDatabasePathParams, RenameDatabaseRequestBody, RenameDatabaseVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaInference, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SearchTableError, SearchTablePathParams, SearchTableRequestBody, SearchTableVariables, SearchXataRecord, SelectableColumn, SelectedPick, SerializedString, Serializer, SerializerResult, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, SqlQueryError, SqlQueryPathParams, SqlQueryRequestBody, SqlQueryVariables, SummarizeTableError, SummarizeTablePathParams, SummarizeTableRequestBody, SummarizeTableVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, UpdateBranchSchemaVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateDatabaseGithubSettingsError, UpdateDatabaseGithubSettingsPathParams, UpdateDatabaseGithubSettingsVariables, UpdateDatabaseMetadataError, UpdateDatabaseMetadataPathParams, UpdateDatabaseMetadataRequestBody, UpdateDatabaseMetadataVariables, UpdateMigrationRequestError, UpdateMigrationRequestPathParams, UpdateMigrationRequestRequestBody, UpdateMigrationRequestVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberInviteError, UpdateWorkspaceMemberInvitePathParams, UpdateWorkspaceMemberInviteRequestBody, UpdateWorkspaceMemberInviteVariables, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, VectorAskOptions, VectorSearchTableError, VectorSearchTablePathParams, VectorSearchTableRequestBody, VectorSearchTableVariables, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, askTable, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteFile, deleteFileItem, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, fileAccess, ge, getAPIKey, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getFile, getFileItem, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, pushBranchMigrations, putFile, putFileItem, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, renameDatabase, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, sqlQuery, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
|