@xata.io/client 0.23.4 → 0.24.0
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 +28 -0
- package/dist/index.cjs +352 -9
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +662 -64
- package/dist/index.mjs +345 -10
- 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
@@ -953,6 +953,43 @@ type UpdateDatabaseMetadataVariables = {
|
|
953
953
|
* Update the color of the selected database
|
954
954
|
*/
|
955
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>;
|
956
993
|
type GetDatabaseGithubSettingsPathParams = {
|
957
994
|
/**
|
958
995
|
* Workspace ID
|
@@ -1136,7 +1173,7 @@ type ColumnVector = {
|
|
1136
1173
|
};
|
1137
1174
|
type Column = {
|
1138
1175
|
name: string;
|
1139
|
-
type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object' | 'datetime' | 'vector' | 'file[]' | 'file'
|
1176
|
+
type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object' | 'datetime' | 'vector' | 'file[]' | 'file';
|
1140
1177
|
link?: ColumnLink;
|
1141
1178
|
vector?: ColumnVector;
|
1142
1179
|
notNull?: boolean;
|
@@ -1391,9 +1428,13 @@ type RecordsMetadata = {
|
|
1391
1428
|
*/
|
1392
1429
|
cursor: string;
|
1393
1430
|
/**
|
1394
|
-
* true if more records can be
|
1431
|
+
* true if more records can be fetched
|
1395
1432
|
*/
|
1396
1433
|
more: boolean;
|
1434
|
+
/**
|
1435
|
+
* the number of records returned per page
|
1436
|
+
*/
|
1437
|
+
size: number;
|
1397
1438
|
};
|
1398
1439
|
};
|
1399
1440
|
type TableOpAdd = {
|
@@ -1442,7 +1483,7 @@ type Commit = {
|
|
1442
1483
|
message?: string;
|
1443
1484
|
id: string;
|
1444
1485
|
parentID?: string;
|
1445
|
-
checksum
|
1486
|
+
checksum: string;
|
1446
1487
|
mergeParentID?: string;
|
1447
1488
|
createdAt: DateTime;
|
1448
1489
|
operations: MigrationOp[];
|
@@ -1474,7 +1515,7 @@ type MigrationObject = {
|
|
1474
1515
|
message?: string;
|
1475
1516
|
id: string;
|
1476
1517
|
parentID?: string;
|
1477
|
-
checksum
|
1518
|
+
checksum: string;
|
1478
1519
|
operations: MigrationOp[];
|
1479
1520
|
};
|
1480
1521
|
/**
|
@@ -1550,9 +1591,27 @@ type TransactionUpdateOp = {
|
|
1550
1591
|
columns?: string[];
|
1551
1592
|
};
|
1552
1593
|
/**
|
1553
|
-
* 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.
|
1554
1595
|
*/
|
1555
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 = {
|
1556
1615
|
/**
|
1557
1616
|
* The table name
|
1558
1617
|
*/
|
@@ -1572,6 +1631,8 @@ type TransactionOperation$1 = {
|
|
1572
1631
|
update: TransactionUpdateOp;
|
1573
1632
|
} | {
|
1574
1633
|
['delete']: TransactionDeleteOp;
|
1634
|
+
} | {
|
1635
|
+
get: TransactionGetOp;
|
1575
1636
|
};
|
1576
1637
|
/**
|
1577
1638
|
* Fields to return in the transaction result.
|
@@ -1623,11 +1684,21 @@ type TransactionResultDelete = {
|
|
1623
1684
|
rows: number;
|
1624
1685
|
columns?: TransactionResultColumns;
|
1625
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
|
+
};
|
1626
1697
|
/**
|
1627
1698
|
* An ordered array of results from the submitted operations.
|
1628
1699
|
*/
|
1629
1700
|
type TransactionSuccess = {
|
1630
|
-
results: (TransactionResultInsert | TransactionResultUpdate | TransactionResultDelete)[];
|
1701
|
+
results: (TransactionResultInsert | TransactionResultUpdate | TransactionResultDelete | TransactionResultGet)[];
|
1631
1702
|
};
|
1632
1703
|
/**
|
1633
1704
|
* An error message from a failing transaction operation
|
@@ -1662,27 +1733,36 @@ type ObjectValue = {
|
|
1662
1733
|
[key: string]: string | boolean | number | string[] | number[] | DateTime | ObjectValue;
|
1663
1734
|
};
|
1664
1735
|
/**
|
1665
|
-
*
|
1736
|
+
* Unique file identifier
|
1666
1737
|
*
|
1667
|
-
* @
|
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
|
1668
1761
|
*/
|
1669
1762
|
type InputFileEntry = {
|
1670
|
-
|
1671
|
-
|
1672
|
-
|
1673
|
-
* @maxLength 1024
|
1674
|
-
* @minLength 1
|
1675
|
-
* @pattern [0-9a-zA-Z!\-_\.\*'\(\)]+
|
1676
|
-
*/
|
1677
|
-
name: string;
|
1678
|
-
/**
|
1679
|
-
* Media type
|
1680
|
-
*
|
1681
|
-
* @maxLength 255
|
1682
|
-
* @minLength 3
|
1683
|
-
* @pattern ^\w+/[-+.\w]+$
|
1684
|
-
*/
|
1685
|
-
mediaType?: string;
|
1763
|
+
id?: FileItemID;
|
1764
|
+
name?: FileName;
|
1765
|
+
mediaType?: MediaType;
|
1686
1766
|
/**
|
1687
1767
|
* Base64 encoded content
|
1688
1768
|
*
|
@@ -1704,11 +1784,34 @@ type InputFileEntry = {
|
|
1704
1784
|
* @maxItems 50
|
1705
1785
|
*/
|
1706
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
|
+
};
|
1707
1810
|
/**
|
1708
1811
|
* Xata input record
|
1709
1812
|
*/
|
1710
1813
|
type DataInputRecord = {
|
1711
|
-
[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;
|
1712
1815
|
};
|
1713
1816
|
/**
|
1714
1817
|
* Xata Table Record Metadata
|
@@ -1742,6 +1845,23 @@ type RecordMeta = {
|
|
1742
1845
|
warnings?: string[];
|
1743
1846
|
};
|
1744
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
|
+
};
|
1745
1865
|
/**
|
1746
1866
|
* The target expression is used to filter the search results by the target columns.
|
1747
1867
|
*/
|
@@ -1772,7 +1892,7 @@ type ValueBooster$1 = {
|
|
1772
1892
|
*/
|
1773
1893
|
value: string | number | boolean;
|
1774
1894
|
/**
|
1775
|
-
* The factor with which to multiply the
|
1895
|
+
* The factor with which to multiply the added boost.
|
1776
1896
|
*/
|
1777
1897
|
factor: number;
|
1778
1898
|
/**
|
@@ -1814,7 +1934,8 @@ type NumericBooster$1 = {
|
|
1814
1934
|
/**
|
1815
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",
|
1816
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
|
1817
|
-
* 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.
|
1818
1939
|
*/
|
1819
1940
|
type DateBooster$1 = {
|
1820
1941
|
/**
|
@@ -1836,6 +1957,12 @@ type DateBooster$1 = {
|
|
1836
1957
|
* The decay factor to expect at "scale" distance from the "origin".
|
1837
1958
|
*/
|
1838
1959
|
decay: number;
|
1960
|
+
/**
|
1961
|
+
* The factor with which to multiply the added boost.
|
1962
|
+
*
|
1963
|
+
* @minimum 0
|
1964
|
+
*/
|
1965
|
+
factor?: number;
|
1839
1966
|
/**
|
1840
1967
|
* Only apply this booster to the records for which the provided filter matches.
|
1841
1968
|
*/
|
@@ -1897,6 +2024,12 @@ type SearchPageConfig = {
|
|
1897
2024
|
*/
|
1898
2025
|
offset?: number;
|
1899
2026
|
};
|
2027
|
+
/**
|
2028
|
+
* Xata Table SQL Record
|
2029
|
+
*/
|
2030
|
+
type SQLRecord = {
|
2031
|
+
[key: string]: any;
|
2032
|
+
};
|
1900
2033
|
/**
|
1901
2034
|
* A summary expression is the description of a single summary operation. It consists of a single
|
1902
2035
|
* key representing the operation, and a value representing the column to be operated on.
|
@@ -2124,6 +2257,18 @@ type AggResponse$1 = (number | null) | {
|
|
2124
2257
|
[key: string]: AggResponse$1;
|
2125
2258
|
})[];
|
2126
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;
|
2127
2272
|
/**
|
2128
2273
|
* Xata Table Record Metadata
|
2129
2274
|
*/
|
@@ -2175,6 +2320,7 @@ type RecordUpdateResponse = XataRecord$1 | {
|
|
2175
2320
|
version: number;
|
2176
2321
|
};
|
2177
2322
|
};
|
2323
|
+
type PutFileResponse = FileResponse;
|
2178
2324
|
type RecordResponse = XataRecord$1;
|
2179
2325
|
type BulkInsertResponse = {
|
2180
2326
|
recordIDs: string[];
|
@@ -2195,6 +2341,10 @@ type SearchResponse = {
|
|
2195
2341
|
records: XataRecord$1[];
|
2196
2342
|
warning?: string;
|
2197
2343
|
};
|
2344
|
+
type SQLResponse = {
|
2345
|
+
records: SQLRecord[];
|
2346
|
+
warning?: string;
|
2347
|
+
};
|
2198
2348
|
type RateLimitError = {
|
2199
2349
|
id?: string;
|
2200
2350
|
message: string;
|
@@ -3256,6 +3406,18 @@ type PushBranchMigrationsVariables = {
|
|
3256
3406
|
body: PushBranchMigrationsRequestBody;
|
3257
3407
|
pathParams: PushBranchMigrationsPathParams;
|
3258
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
|
+
*/
|
3259
3421
|
declare const pushBranchMigrations: (variables: PushBranchMigrationsVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
3260
3422
|
type CreateTablePathParams = {
|
3261
3423
|
/**
|
@@ -3671,6 +3833,248 @@ type InsertRecordVariables = {
|
|
3671
3833
|
* Insert a new Record into the Table
|
3672
3834
|
*/
|
3673
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>;
|
3674
4078
|
type GetRecordPathParams = {
|
3675
4079
|
/**
|
3676
4080
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -4644,23 +5048,7 @@ type QueryTableVariables = {
|
|
4644
5048
|
*
|
4645
5049
|
* ### Pagination
|
4646
5050
|
*
|
4647
|
-
* We offer cursor pagination and offset pagination.
|
4648
|
-
* cursor pagination is needed in order to retrieve all of their results. The offset pagination method is limited to 1000 records.
|
4649
|
-
*
|
4650
|
-
* Example of size + offset pagination:
|
4651
|
-
*
|
4652
|
-
* ```json
|
4653
|
-
* POST /db/demo:main/tables/table/query
|
4654
|
-
* {
|
4655
|
-
* "page": {
|
4656
|
-
* "size": 100,
|
4657
|
-
* "offset": 200
|
4658
|
-
* }
|
4659
|
-
* }
|
4660
|
-
* ```
|
4661
|
-
*
|
4662
|
-
* 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.
|
4663
|
-
* 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.
|
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.
|
4664
5052
|
*
|
4665
5053
|
* Example of cursor pagination:
|
4666
5054
|
*
|
@@ -4714,6 +5102,34 @@ type QueryTableVariables = {
|
|
4714
5102
|
* `filter` or `sort` is set. The columns returned and page size can be changed
|
4715
5103
|
* anytime by passing the `columns` or `page.size` settings to the next query.
|
4716
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
|
+
*
|
4717
5133
|
* **Special cursors:**
|
4718
5134
|
*
|
4719
5135
|
* - `page.after=end`: Result points past the last entry. The list of records
|
@@ -4885,7 +5301,7 @@ type SqlQueryVariables = {
|
|
4885
5301
|
/**
|
4886
5302
|
* Run an SQL query across the database branch.
|
4887
5303
|
*/
|
4888
|
-
declare const sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<
|
5304
|
+
declare const sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<SQLResponse>;
|
4889
5305
|
type VectorSearchTablePathParams = {
|
4890
5306
|
/**
|
4891
5307
|
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
@@ -5186,6 +5602,38 @@ type AggregateTableVariables = {
|
|
5186
5602
|
* For usage, see the [API Guide](https://xata.io/docs/api-guide/aggregate).
|
5187
5603
|
*/
|
5188
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>;
|
5189
5637
|
|
5190
5638
|
declare const operationsByTag: {
|
5191
5639
|
branch: {
|
@@ -5246,11 +5694,20 @@ declare const operationsByTag: {
|
|
5246
5694
|
updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
5247
5695
|
deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
|
5248
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
|
+
};
|
5249
5706
|
searchAndFilter: {
|
5250
5707
|
queryTable: (variables: QueryTableVariables, signal?: AbortSignal | undefined) => Promise<QueryResponse>;
|
5251
5708
|
searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
|
5252
5709
|
searchTable: (variables: SearchTableVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
|
5253
|
-
sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal | undefined) => Promise<
|
5710
|
+
sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal | undefined) => Promise<SQLResponse>;
|
5254
5711
|
vectorSearchTable: (variables: VectorSearchTableVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
|
5255
5712
|
askTable: (variables: AskTableVariables, signal?: AbortSignal | undefined) => Promise<AskTableResponse>;
|
5256
5713
|
summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal | undefined) => Promise<SummarizeResponse>;
|
@@ -5289,6 +5746,7 @@ declare const operationsByTag: {
|
|
5289
5746
|
deleteDatabase: (variables: DeleteDatabaseVariables, signal?: AbortSignal | undefined) => Promise<DeleteDatabaseResponse>;
|
5290
5747
|
getDatabaseMetadata: (variables: GetDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
|
5291
5748
|
updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
|
5749
|
+
renameDatabase: (variables: RenameDatabaseVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
|
5292
5750
|
getDatabaseGithubSettings: (variables: GetDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<DatabaseGithubSettings>;
|
5293
5751
|
updateDatabaseGithubSettings: (variables: UpdateDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<DatabaseGithubSettings>;
|
5294
5752
|
deleteDatabaseGithubSettings: (variables: DeleteDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
|
@@ -5318,10 +5776,12 @@ type responses_BadRequestError = BadRequestError;
|
|
5318
5776
|
type responses_BranchMigrationPlan = BranchMigrationPlan;
|
5319
5777
|
type responses_BulkError = BulkError;
|
5320
5778
|
type responses_BulkInsertResponse = BulkInsertResponse;
|
5779
|
+
type responses_PutFileResponse = PutFileResponse;
|
5321
5780
|
type responses_QueryResponse = QueryResponse;
|
5322
5781
|
type responses_RateLimitError = RateLimitError;
|
5323
5782
|
type responses_RecordResponse = RecordResponse;
|
5324
5783
|
type responses_RecordUpdateResponse = RecordUpdateResponse;
|
5784
|
+
type responses_SQLResponse = SQLResponse;
|
5325
5785
|
type responses_SchemaCompareResponse = SchemaCompareResponse;
|
5326
5786
|
type responses_SchemaUpdateResponse = SchemaUpdateResponse;
|
5327
5787
|
type responses_SearchResponse = SearchResponse;
|
@@ -5335,10 +5795,12 @@ declare namespace responses {
|
|
5335
5795
|
responses_BranchMigrationPlan as BranchMigrationPlan,
|
5336
5796
|
responses_BulkError as BulkError,
|
5337
5797
|
responses_BulkInsertResponse as BulkInsertResponse,
|
5798
|
+
responses_PutFileResponse as PutFileResponse,
|
5338
5799
|
responses_QueryResponse as QueryResponse,
|
5339
5800
|
responses_RateLimitError as RateLimitError,
|
5340
5801
|
responses_RecordResponse as RecordResponse,
|
5341
5802
|
responses_RecordUpdateResponse as RecordUpdateResponse,
|
5803
|
+
responses_SQLResponse as SQLResponse,
|
5342
5804
|
responses_SchemaCompareResponse as SchemaCompareResponse,
|
5343
5805
|
responses_SchemaUpdateResponse as SchemaUpdateResponse,
|
5344
5806
|
responses_SearchResponse as SearchResponse,
|
@@ -5377,6 +5839,11 @@ type schemas_DatabaseGithubSettings = DatabaseGithubSettings;
|
|
5377
5839
|
type schemas_DatabaseMetadata = DatabaseMetadata;
|
5378
5840
|
type schemas_DateHistogramAgg = DateHistogramAgg;
|
5379
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;
|
5380
5847
|
type schemas_FilterColumn = FilterColumn;
|
5381
5848
|
type schemas_FilterColumnIncludes = FilterColumnIncludes;
|
5382
5849
|
type schemas_FilterExpression = FilterExpression;
|
@@ -5388,6 +5855,7 @@ type schemas_FilterRangeValue = FilterRangeValue;
|
|
5388
5855
|
type schemas_FilterValue = FilterValue;
|
5389
5856
|
type schemas_FuzzinessExpression = FuzzinessExpression;
|
5390
5857
|
type schemas_HighlightExpression = HighlightExpression;
|
5858
|
+
type schemas_InputFile = InputFile;
|
5391
5859
|
type schemas_InputFileArray = InputFileArray;
|
5392
5860
|
type schemas_InputFileEntry = InputFileEntry;
|
5393
5861
|
type schemas_InviteID = InviteID;
|
@@ -5397,6 +5865,7 @@ type schemas_ListDatabasesResponse = ListDatabasesResponse;
|
|
5397
5865
|
type schemas_ListGitBranchesResponse = ListGitBranchesResponse;
|
5398
5866
|
type schemas_ListRegionsResponse = ListRegionsResponse;
|
5399
5867
|
type schemas_MaxAgg = MaxAgg;
|
5868
|
+
type schemas_MediaType = MediaType;
|
5400
5869
|
type schemas_MetricsDatapoint = MetricsDatapoint;
|
5401
5870
|
type schemas_MetricsLatency = MetricsLatency;
|
5402
5871
|
type schemas_Migration = Migration;
|
@@ -5418,6 +5887,7 @@ type schemas_RecordsMetadata = RecordsMetadata;
|
|
5418
5887
|
type schemas_Region = Region;
|
5419
5888
|
type schemas_RevLink = RevLink;
|
5420
5889
|
type schemas_Role = Role;
|
5890
|
+
type schemas_SQLRecord = SQLRecord;
|
5421
5891
|
type schemas_Schema = Schema;
|
5422
5892
|
type schemas_SchemaEditScript = SchemaEditScript;
|
5423
5893
|
type schemas_SearchPageConfig = SearchPageConfig;
|
@@ -5439,9 +5909,11 @@ type schemas_TopValuesAgg = TopValuesAgg;
|
|
5439
5909
|
type schemas_TransactionDeleteOp = TransactionDeleteOp;
|
5440
5910
|
type schemas_TransactionError = TransactionError;
|
5441
5911
|
type schemas_TransactionFailure = TransactionFailure;
|
5912
|
+
type schemas_TransactionGetOp = TransactionGetOp;
|
5442
5913
|
type schemas_TransactionInsertOp = TransactionInsertOp;
|
5443
5914
|
type schemas_TransactionResultColumns = TransactionResultColumns;
|
5444
5915
|
type schemas_TransactionResultDelete = TransactionResultDelete;
|
5916
|
+
type schemas_TransactionResultGet = TransactionResultGet;
|
5445
5917
|
type schemas_TransactionResultInsert = TransactionResultInsert;
|
5446
5918
|
type schemas_TransactionResultUpdate = TransactionResultUpdate;
|
5447
5919
|
type schemas_TransactionSuccess = TransactionSuccess;
|
@@ -5490,6 +5962,11 @@ declare namespace schemas {
|
|
5490
5962
|
DateBooster$1 as DateBooster,
|
5491
5963
|
schemas_DateHistogramAgg as DateHistogramAgg,
|
5492
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,
|
5493
5970
|
schemas_FilterColumn as FilterColumn,
|
5494
5971
|
schemas_FilterColumnIncludes as FilterColumnIncludes,
|
5495
5972
|
schemas_FilterExpression as FilterExpression,
|
@@ -5501,6 +5978,7 @@ declare namespace schemas {
|
|
5501
5978
|
schemas_FilterValue as FilterValue,
|
5502
5979
|
schemas_FuzzinessExpression as FuzzinessExpression,
|
5503
5980
|
schemas_HighlightExpression as HighlightExpression,
|
5981
|
+
schemas_InputFile as InputFile,
|
5504
5982
|
schemas_InputFileArray as InputFileArray,
|
5505
5983
|
schemas_InputFileEntry as InputFileEntry,
|
5506
5984
|
schemas_InviteID as InviteID,
|
@@ -5510,6 +5988,7 @@ declare namespace schemas {
|
|
5510
5988
|
schemas_ListGitBranchesResponse as ListGitBranchesResponse,
|
5511
5989
|
schemas_ListRegionsResponse as ListRegionsResponse,
|
5512
5990
|
schemas_MaxAgg as MaxAgg,
|
5991
|
+
schemas_MediaType as MediaType,
|
5513
5992
|
schemas_MetricsDatapoint as MetricsDatapoint,
|
5514
5993
|
schemas_MetricsLatency as MetricsLatency,
|
5515
5994
|
schemas_Migration as Migration,
|
@@ -5532,6 +6011,7 @@ declare namespace schemas {
|
|
5532
6011
|
schemas_Region as Region,
|
5533
6012
|
schemas_RevLink as RevLink,
|
5534
6013
|
schemas_Role as Role,
|
6014
|
+
schemas_SQLRecord as SQLRecord,
|
5535
6015
|
schemas_Schema as Schema,
|
5536
6016
|
schemas_SchemaEditScript as SchemaEditScript,
|
5537
6017
|
schemas_SearchPageConfig as SearchPageConfig,
|
@@ -5553,10 +6033,12 @@ declare namespace schemas {
|
|
5553
6033
|
schemas_TransactionDeleteOp as TransactionDeleteOp,
|
5554
6034
|
schemas_TransactionError as TransactionError,
|
5555
6035
|
schemas_TransactionFailure as TransactionFailure,
|
6036
|
+
schemas_TransactionGetOp as TransactionGetOp,
|
5556
6037
|
schemas_TransactionInsertOp as TransactionInsertOp,
|
5557
6038
|
TransactionOperation$1 as TransactionOperation,
|
5558
6039
|
schemas_TransactionResultColumns as TransactionResultColumns,
|
5559
6040
|
schemas_TransactionResultDelete as TransactionResultDelete,
|
6041
|
+
schemas_TransactionResultGet as TransactionResultGet,
|
5560
6042
|
schemas_TransactionResultInsert as TransactionResultInsert,
|
5561
6043
|
schemas_TransactionResultUpdate as TransactionResultUpdate,
|
5562
6044
|
schemas_TransactionSuccess as TransactionSuccess,
|
@@ -5598,6 +6080,7 @@ declare class XataApiClient {
|
|
5598
6080
|
get migrationRequests(): MigrationRequestsApi;
|
5599
6081
|
get tables(): TableApi;
|
5600
6082
|
get records(): RecordsApi;
|
6083
|
+
get files(): FilesApi;
|
5601
6084
|
get searchAndFilter(): SearchAndFilterApi;
|
5602
6085
|
}
|
5603
6086
|
declare class UserApi {
|
@@ -5919,6 +6402,75 @@ declare class RecordsApi {
|
|
5919
6402
|
operations: TransactionOperation$1[];
|
5920
6403
|
}): Promise<TransactionSuccess>;
|
5921
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
|
+
}
|
5922
6474
|
declare class SearchAndFilterApi {
|
5923
6475
|
private extraProps;
|
5924
6476
|
constructor(extraProps: ApiExtraProps);
|
@@ -6180,6 +6732,11 @@ declare class DatabaseApi {
|
|
6180
6732
|
database: DBName;
|
6181
6733
|
metadata: DatabaseMetadata;
|
6182
6734
|
}): Promise<DatabaseMetadata>;
|
6735
|
+
renameDatabase({ workspace, database, newName }: {
|
6736
|
+
workspace: WorkspaceID;
|
6737
|
+
database: DBName;
|
6738
|
+
newName: DBName;
|
6739
|
+
}): Promise<DatabaseMetadata>;
|
6183
6740
|
getDatabaseGithubSettings({ workspace, database }: {
|
6184
6741
|
workspace: WorkspaceID;
|
6185
6742
|
database: DBName;
|
@@ -6245,9 +6802,9 @@ type ColumnsByValue<O, Value> = Values<{
|
|
6245
6802
|
type SelectedPick<O extends XataRecord, Key extends SelectableColumn<O>[]> = XataRecord<O> & UnionToIntersection<Values<{
|
6246
6803
|
[K in Key[number]]: NestedValueAtColumn<O, K> & XataRecord<O>;
|
6247
6804
|
}>>;
|
6248
|
-
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> ? {
|
6249
6806
|
V: ValueAtColumn<Item, V>;
|
6250
|
-
} : never :
|
6807
|
+
} : never : Object[K] : never> : never : never;
|
6251
6808
|
type MAX_RECURSION = 2;
|
6252
6809
|
type NestedColumns<O, RecursivePath extends any[]> = RecursivePath['length'] extends MAX_RECURSION ? never : If<IsObject<O>, Values<{
|
6253
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
|
@@ -6280,8 +6837,13 @@ interface BaseData {
|
|
6280
6837
|
* Represents a persisted record from the database.
|
6281
6838
|
*/
|
6282
6839
|
interface XataRecord<OriginalRecord extends XataRecord<any> = XataRecord<any>> extends Identifiable {
|
6840
|
+
/**
|
6841
|
+
* Metadata of this record.
|
6842
|
+
*/
|
6843
|
+
xata: XataRecordMetadata;
|
6283
6844
|
/**
|
6284
6845
|
* Get metadata of this record.
|
6846
|
+
* @deprecated Use `xata` property instead.
|
6285
6847
|
*/
|
6286
6848
|
getMetadata(): XataRecordMetadata;
|
6287
6849
|
/**
|
@@ -6360,7 +6922,14 @@ type XataRecordMetadata = {
|
|
6360
6922
|
* Number that is increased every time the record is updated.
|
6361
6923
|
*/
|
6362
6924
|
version: number;
|
6363
|
-
|
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;
|
6364
6933
|
};
|
6365
6934
|
declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
|
6366
6935
|
declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;
|
@@ -6382,10 +6951,30 @@ type EditableData<O extends XataRecord> = Identifiable & Partial<Omit<{
|
|
6382
6951
|
[K in keyof O]: EditableDataFields<O[K]>;
|
6383
6952
|
}, keyof XataRecord>>;
|
6384
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;
|
6385
|
-
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<{
|
6386
6974
|
[K in keyof O]: JSONDataFields<O[K]>;
|
6387
6975
|
}, keyof XataRecord>>;
|
6388
6976
|
|
6977
|
+
type FilterColumns<T> = ColumnsByValue<T, any> | `xata.${keyof XataRecordMetadata}`;
|
6389
6978
|
/**
|
6390
6979
|
* PropertyMatchFilter
|
6391
6980
|
* Example:
|
@@ -6405,7 +6994,7 @@ type JSONData<O> = Identifiable & Partial<Omit<{
|
|
6405
6994
|
}
|
6406
6995
|
*/
|
6407
6996
|
type PropertyAccessFilter<Record> = {
|
6408
|
-
[key in
|
6997
|
+
[key in FilterColumns<Record>]?: NestedApiFilter<ValueAtColumn<Record, key>> | PropertyFilter<ValueAtColumn<Record, key>>;
|
6409
6998
|
};
|
6410
6999
|
type PropertyFilter<T> = T | {
|
6411
7000
|
$is: T;
|
@@ -6467,7 +7056,7 @@ type AggregatorFilter<T> = {
|
|
6467
7056
|
* Example: { filter: { $exists: "settings" } }
|
6468
7057
|
*/
|
6469
7058
|
type ExistanceFilter<Record> = {
|
6470
|
-
[key in '$exists' | '$notExists']?:
|
7059
|
+
[key in '$exists' | '$notExists']?: FilterColumns<Record>;
|
6471
7060
|
};
|
6472
7061
|
type BaseApiFilter<Record> = PropertyAccessFilter<Record> | AggregatorFilter<Record> | ExistanceFilter<Record>;
|
6473
7062
|
/**
|
@@ -6484,6 +7073,12 @@ type DateBooster = {
|
|
6484
7073
|
origin?: string;
|
6485
7074
|
scale: string;
|
6486
7075
|
decay: number;
|
7076
|
+
/**
|
7077
|
+
* The factor with which to multiply the added boost.
|
7078
|
+
*
|
7079
|
+
* @minimum 0
|
7080
|
+
*/
|
7081
|
+
factor?: number;
|
6487
7082
|
};
|
6488
7083
|
type NumericBooster = {
|
6489
7084
|
factor: number;
|
@@ -6832,12 +7427,13 @@ type RandomFilterExtended = {
|
|
6832
7427
|
column: '*';
|
6833
7428
|
direction: 'random';
|
6834
7429
|
};
|
6835
|
-
type
|
7430
|
+
type SortColumns<T extends XataRecord> = ColumnsByValue<T, any> | `xata.${keyof XataRecordMetadata}`;
|
7431
|
+
type SortFilterExtended<T extends XataRecord, Columns extends string = SortColumns<T>> = RandomFilterExtended | {
|
6836
7432
|
column: Columns;
|
6837
7433
|
direction?: SortDirection;
|
6838
7434
|
};
|
6839
|
-
type SortFilter<T extends XataRecord, Columns extends string =
|
6840
|
-
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<{
|
6841
7437
|
[Key in Columns]: {
|
6842
7438
|
[K in Key]: SortDirection;
|
6843
7439
|
};
|
@@ -7147,6 +7743,7 @@ type PaginationQueryMeta = {
|
|
7147
7743
|
page: {
|
7148
7744
|
cursor: string;
|
7149
7745
|
more: boolean;
|
7746
|
+
size: number;
|
7150
7747
|
};
|
7151
7748
|
};
|
7152
7749
|
interface Paginable<Record extends XataRecord, Result extends XataRecord = Record> {
|
@@ -8043,11 +8640,11 @@ declare const le: <T extends ComparableType>(value: T) => ComparableTypeFilter<T
|
|
8043
8640
|
/**
|
8044
8641
|
* Operator to restrict results to only values that are not null.
|
8045
8642
|
*/
|
8046
|
-
declare const exists: <T>(column?:
|
8643
|
+
declare const exists: <T>(column?: FilterColumns<T> | undefined) => ExistanceFilter<T>;
|
8047
8644
|
/**
|
8048
8645
|
* Operator to restrict results to only values that are null.
|
8049
8646
|
*/
|
8050
|
-
declare const notExists: <T>(column?:
|
8647
|
+
declare const notExists: <T>(column?: FilterColumns<T> | undefined) => ExistanceFilter<T>;
|
8051
8648
|
/**
|
8052
8649
|
* Operator to restrict results to only values that start with the given prefix.
|
8053
8650
|
*/
|
@@ -8137,6 +8734,7 @@ type UpdateTransactionOperation<O extends XataRecord> = {
|
|
8137
8734
|
};
|
8138
8735
|
type DeleteTransactionOperation = {
|
8139
8736
|
id: string;
|
8737
|
+
failIfMissing?: boolean;
|
8140
8738
|
};
|
8141
8739
|
type TransactionOperationSingleResult<Schema extends Record<string, BaseData>, Table extends StringKeys<Schema>, Operation extends TransactionOperation<Schema, Table>> = Operation extends {
|
8142
8740
|
insert: {
|
@@ -8244,20 +8842,20 @@ declare function getPreviewBranch(): string | undefined;
|
|
8244
8842
|
|
8245
8843
|
interface Body {
|
8246
8844
|
arrayBuffer(): Promise<ArrayBuffer>;
|
8247
|
-
blob(): Promise<Blob>;
|
8845
|
+
blob(): Promise<Blob$1>;
|
8248
8846
|
formData(): Promise<FormData>;
|
8249
8847
|
json(): Promise<any>;
|
8250
8848
|
text(): Promise<string>;
|
8251
8849
|
}
|
8252
|
-
interface Blob {
|
8850
|
+
interface Blob$1 {
|
8253
8851
|
readonly size: number;
|
8254
8852
|
readonly type: string;
|
8255
8853
|
arrayBuffer(): Promise<ArrayBuffer>;
|
8256
|
-
slice(start?: number, end?: number, contentType?: string): Blob;
|
8854
|
+
slice(start?: number, end?: number, contentType?: string): Blob$1;
|
8257
8855
|
text(): Promise<string>;
|
8258
8856
|
}
|
8259
8857
|
/** Provides information about files and allows JavaScript in a web page to access their content. */
|
8260
|
-
interface File extends Blob {
|
8858
|
+
interface File extends Blob$1 {
|
8261
8859
|
readonly lastModified: number;
|
8262
8860
|
readonly name: string;
|
8263
8861
|
readonly webkitRelativePath: string;
|
@@ -8265,12 +8863,12 @@ interface File extends Blob {
|
|
8265
8863
|
type FormDataEntryValue = File | string;
|
8266
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". */
|
8267
8865
|
interface FormData {
|
8268
|
-
append(name: string, value: string | Blob, fileName?: string): void;
|
8866
|
+
append(name: string, value: string | Blob$1, fileName?: string): void;
|
8269
8867
|
delete(name: string): void;
|
8270
8868
|
get(name: string): FormDataEntryValue | null;
|
8271
8869
|
getAll(name: string): FormDataEntryValue[];
|
8272
8870
|
has(name: string): boolean;
|
8273
|
-
set(name: string, value: string | Blob, fileName?: string): void;
|
8871
|
+
set(name: string, value: string | Blob$1, fileName?: string): void;
|
8274
8872
|
forEach(callbackfn: (value: FormDataEntryValue, key: string, parent: FormData) => void, thisArg?: any): void;
|
8275
8873
|
}
|
8276
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. */
|
@@ -8327,4 +8925,4 @@ declare class XataError extends Error {
|
|
8327
8925
|
constructor(message: string, status: number);
|
8328
8926
|
}
|
8329
8927
|
|
8330
|
-
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, AggregateTableError, AggregateTablePathParams, AggregateTableRequestBody, AggregateTableVariables, ApiExtraProps, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditVariables, AskOptions, AskResult, AskTableError, AskTablePathParams, AskTableRequestBody, AskTableResponse, AskTableVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BranchTransactionError, BranchTransactionPathParams, BranchTransactionRequestBody, BranchTransactionVariables, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, ColumnsByValue, CompareBranchSchemasError, CompareBranchSchemasPathParams, CompareBranchSchemasRequestBody, CompareBranchSchemasVariables, CompareBranchWithUserSchemaError, CompareBranchWithUserSchemaPathParams, CompareBranchWithUserSchemaRequestBody, CompareBranchWithUserSchemaVariables, CompareMigrationRequestError, CompareMigrationRequestPathParams, CompareMigrationRequestVariables, CopyBranchError, CopyBranchPathParams, CopyBranchRequestBody, CopyBranchVariables, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchResponse, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateMigrationRequestError, CreateMigrationRequestPathParams, CreateMigrationRequestRequestBody, CreateMigrationRequestResponse, CreateMigrationRequestVariables, CreateTableError, CreateTablePathParams, CreateTableResponse, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchResponse, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabaseGithubSettingsError, DeleteDatabaseGithubSettingsPathParams, DeleteDatabaseGithubSettingsVariables, DeleteDatabasePathParams, DeleteDatabaseResponse, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableResponse, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, DeserializedType, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherError, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchSchemaHistoryError, GetBranchSchemaHistoryPathParams, GetBranchSchemaHistoryRequestBody, GetBranchSchemaHistoryResponse, GetBranchSchemaHistoryVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseGithubSettingsError, GetDatabaseGithubSettingsPathParams, GetDatabaseGithubSettingsVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetDatabaseMetadataError, GetDatabaseMetadataPathParams, GetDatabaseMetadataVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetMigrationRequestError, GetMigrationRequestIsMergedError, GetMigrationRequestIsMergedPathParams, GetMigrationRequestIsMergedResponse, GetMigrationRequestIsMergedVariables, GetMigrationRequestPathParams, GetMigrationRequestVariables, GetRecordError, GetRecordPathParams, GetRecordQueryParams, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, HostProvider, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, KeywordAskOptions, Link, ListMigrationRequestsCommitsError, ListMigrationRequestsCommitsPathParams, ListMigrationRequestsCommitsRequestBody, ListMigrationRequestsCommitsResponse, ListMigrationRequestsCommitsVariables, ListRegionsError, ListRegionsPathParams, ListRegionsVariables, MergeMigrationRequestError, MergeMigrationRequestPathParams, MergeMigrationRequestVariables, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, PreviewBranchSchemaEditError, PreviewBranchSchemaEditPathParams, PreviewBranchSchemaEditRequestBody, PreviewBranchSchemaEditResponse, PreviewBranchSchemaEditVariables, PushBranchMigrationsError, PushBranchMigrationsPathParams, PushBranchMigrationsRequestBody, PushBranchMigrationsVariables, Query, QueryMigrationRequestsError, QueryMigrationRequestsPathParams, QueryMigrationRequestsRequestBody, QueryMigrationRequestsResponse, QueryMigrationRequestsVariables, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RecordArray, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaInference, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SearchTableError, SearchTablePathParams, SearchTableRequestBody, SearchTableVariables, SearchXataRecord, SelectableColumn, SelectedPick, SerializedString, Serializer, SerializerResult, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, SqlQueryError, SqlQueryPathParams, SqlQueryRequestBody, SqlQueryVariables, SummarizeTableError, SummarizeTablePathParams, SummarizeTableRequestBody, SummarizeTableVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, UpdateBranchSchemaVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateDatabaseGithubSettingsError, UpdateDatabaseGithubSettingsPathParams, UpdateDatabaseGithubSettingsVariables, UpdateDatabaseMetadataError, UpdateDatabaseMetadataPathParams, UpdateDatabaseMetadataRequestBody, UpdateDatabaseMetadataVariables, UpdateMigrationRequestError, UpdateMigrationRequestPathParams, UpdateMigrationRequestRequestBody, UpdateMigrationRequestVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberInviteError, UpdateWorkspaceMemberInvitePathParams, UpdateWorkspaceMemberInviteRequestBody, UpdateWorkspaceMemberInviteVariables, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, VectorAskOptions, VectorSearchTableError, VectorSearchTablePathParams, VectorSearchTableRequestBody, VectorSearchTableVariables, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, askTable, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, pushBranchMigrations, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, sqlQuery, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
|
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 };
|