@xata.io/client 0.0.0-alpha.vf9f8d99 → 0.0.0-alpha.vfa36696

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/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>;
@@ -36,7 +37,7 @@ type TraceFunction = <T>(name: string, fn: (options: {
36
37
  }) => T, options?: AttributeDictionary) => Promise<T>;
37
38
 
38
39
  type RequestInit = {
39
- body?: string;
40
+ body?: any;
40
41
  headers?: Record<string, string>;
41
42
  method?: string;
42
43
  signal?: any;
@@ -46,6 +47,8 @@ type Response = {
46
47
  status: number;
47
48
  url: string;
48
49
  json(): Promise<any>;
50
+ text(): Promise<string>;
51
+ blob(): Promise<Blob>;
49
52
  headers?: {
50
53
  get(name: string): string | null;
51
54
  };
@@ -80,6 +83,8 @@ type FetcherExtraProps = {
80
83
  clientName?: string;
81
84
  xataAgentExtra?: Record<string, string>;
82
85
  fetchOptions?: Record<string, unknown>;
86
+ rawResponse?: boolean;
87
+ headers?: Record<string, unknown>;
83
88
  };
84
89
 
85
90
  type ControlPlaneFetcherExtraProps = {
@@ -104,6 +109,34 @@ type ErrorWrapper$1<TError> = TError | {
104
109
  *
105
110
  * @version 1.0
106
111
  */
112
+ type AuthorizationCode = {
113
+ state?: string;
114
+ redirectUri?: string;
115
+ scopes?: string[];
116
+ /**
117
+ * @format date-time
118
+ */
119
+ expires?: string;
120
+ };
121
+ type AccessTokenInput = {
122
+ grantType: string;
123
+ clientId: string;
124
+ clientSecret: string;
125
+ refreshToken: string;
126
+ } | {
127
+ grantType: string;
128
+ clientId: string;
129
+ clientSecret: string;
130
+ code: string;
131
+ redirectUri: string;
132
+ codeVerifier?: string;
133
+ };
134
+ type AccessTokenOutput = {
135
+ accessToken: string;
136
+ refreshToken: string;
137
+ tokenType: string;
138
+ expires?: number;
139
+ };
107
140
  type User = {
108
141
  /**
109
142
  * @format email
@@ -179,6 +212,7 @@ type WorkspaceMembers = {
179
212
  * @pattern ^ik_[a-zA-Z0-9]+
180
213
  */
181
214
  type InviteKey = string;
215
+ type AccessToken = string;
182
216
  /**
183
217
  * Metadata of databases
184
218
  */
@@ -259,6 +293,7 @@ type DatabaseGithubSettings = {
259
293
  };
260
294
  type Region = {
261
295
  id: string;
296
+ name: string;
262
297
  };
263
298
  type ListRegionsResponse = {
264
299
  /**
@@ -294,6 +329,55 @@ type SimpleError$1 = {
294
329
  * @version 1.0
295
330
  */
296
331
 
332
+ type GrantAuthorizationCodeError = ErrorWrapper$1<{
333
+ status: 400;
334
+ payload: BadRequestError$1;
335
+ } | {
336
+ status: 401;
337
+ payload: AuthError$1;
338
+ } | {
339
+ status: 404;
340
+ payload: SimpleError$1;
341
+ } | {
342
+ status: 409;
343
+ payload: SimpleError$1;
344
+ }>;
345
+ type GrantAuthorizationCodeResponse = AuthorizationCode & {
346
+ code: string;
347
+ };
348
+ type GrantAuthorizationCodeRequestBody = AuthorizationCode & {
349
+ responseType: string;
350
+ clientId: string;
351
+ codeChallenge?: string;
352
+ codeChallengeMethod?: string;
353
+ };
354
+ type GrantAuthorizationCodeVariables = {
355
+ body?: GrantAuthorizationCodeRequestBody;
356
+ } & ControlPlaneFetcherExtraProps;
357
+ /**
358
+ * Creates, stores and returns an authorization code to be used by a third party app
359
+ */
360
+ declare const grantAuthorizationCode: (variables: GrantAuthorizationCodeVariables, signal?: AbortSignal) => Promise<GrantAuthorizationCodeResponse>;
361
+ type GenerateAccessTokenError = ErrorWrapper$1<{
362
+ status: 400;
363
+ payload: BadRequestError$1;
364
+ } | {
365
+ status: 401;
366
+ payload: AuthError$1;
367
+ } | {
368
+ status: 404;
369
+ payload: SimpleError$1;
370
+ } | {
371
+ status: 409;
372
+ payload: SimpleError$1;
373
+ }>;
374
+ type GenerateAccessTokenVariables = {
375
+ body?: AccessTokenInput;
376
+ } & ControlPlaneFetcherExtraProps;
377
+ /**
378
+ * Creates/refreshes, stores and returns an access token to be used by a third party app
379
+ */
380
+ declare const generateAccessToken: (variables: GenerateAccessTokenVariables, signal?: AbortSignal) => Promise<AccessTokenOutput>;
297
381
  type GetUserError = ErrorWrapper$1<{
298
382
  status: 400;
299
383
  payload: BadRequestError$1;
@@ -952,6 +1036,43 @@ type UpdateDatabaseMetadataVariables = {
952
1036
  * Update the color of the selected database
953
1037
  */
954
1038
  declare const updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
1039
+ type RenameDatabasePathParams = {
1040
+ /**
1041
+ * Workspace ID
1042
+ */
1043
+ workspaceId: WorkspaceID;
1044
+ /**
1045
+ * The Database Name
1046
+ */
1047
+ dbName: DBName$1;
1048
+ };
1049
+ type RenameDatabaseError = ErrorWrapper$1<{
1050
+ status: 400;
1051
+ payload: BadRequestError$1;
1052
+ } | {
1053
+ status: 401;
1054
+ payload: AuthError$1;
1055
+ } | {
1056
+ status: 422;
1057
+ payload: SimpleError$1;
1058
+ } | {
1059
+ status: 423;
1060
+ payload: SimpleError$1;
1061
+ }>;
1062
+ type RenameDatabaseRequestBody = {
1063
+ /**
1064
+ * @minLength 1
1065
+ */
1066
+ newName: string;
1067
+ };
1068
+ type RenameDatabaseVariables = {
1069
+ body: RenameDatabaseRequestBody;
1070
+ pathParams: RenameDatabasePathParams;
1071
+ } & ControlPlaneFetcherExtraProps;
1072
+ /**
1073
+ * Change the name of an existing database
1074
+ */
1075
+ declare const renameDatabase: (variables: RenameDatabaseVariables, signal?: AbortSignal) => Promise<DatabaseMetadata>;
955
1076
  type GetDatabaseGithubSettingsPathParams = {
956
1077
  /**
957
1078
  * Workspace ID
@@ -1133,19 +1254,24 @@ type ColumnVector = {
1133
1254
  */
1134
1255
  dimension: number;
1135
1256
  };
1257
+ type ColumnFile = {
1258
+ defaultPublicAccess?: boolean;
1259
+ };
1136
1260
  type Column = {
1137
1261
  name: string;
1138
- type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object' | 'datetime' | 'vector' | 'fileArray';
1262
+ type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object' | 'datetime' | 'vector' | 'file[]' | 'file';
1139
1263
  link?: ColumnLink;
1140
1264
  vector?: ColumnVector;
1265
+ file?: ColumnFile;
1266
+ ['file[]']?: ColumnFile;
1141
1267
  notNull?: boolean;
1142
1268
  defaultValue?: string;
1143
1269
  unique?: boolean;
1144
1270
  columns?: Column[];
1145
1271
  };
1146
1272
  type RevLink = {
1147
- linkID: string;
1148
1273
  table: string;
1274
+ column: string;
1149
1275
  };
1150
1276
  type Table = {
1151
1277
  id?: string;
@@ -1172,6 +1298,11 @@ type DBBranch = {
1172
1298
  schema: Schema;
1173
1299
  };
1174
1300
  type MigrationStatus = 'completed' | 'pending' | 'failed';
1301
+ type BranchWithCopyID = {
1302
+ branchName: BranchName;
1303
+ dbBranchID: string;
1304
+ copyID: string;
1305
+ };
1175
1306
  type MetricsDatapoint = {
1176
1307
  timestamp: string;
1177
1308
  value: number;
@@ -1287,7 +1418,7 @@ type FilterColumnIncludes = {
1287
1418
  $includesNone?: FilterPredicate;
1288
1419
  };
1289
1420
  type FilterColumn = FilterColumnIncludes | FilterPredicate | FilterList;
1290
- type SortOrder = 'asc' | 'desc';
1421
+ type SortOrder = 'asc' | 'desc' | 'random';
1291
1422
  type SortExpression = string[] | {
1292
1423
  [key: string]: SortOrder;
1293
1424
  } | {
@@ -1385,9 +1516,13 @@ type RecordsMetadata = {
1385
1516
  */
1386
1517
  cursor: string;
1387
1518
  /**
1388
- * true if more records can be fetch
1519
+ * true if more records can be fetched
1389
1520
  */
1390
1521
  more: boolean;
1522
+ /**
1523
+ * the number of records returned per page
1524
+ */
1525
+ size: number;
1391
1526
  };
1392
1527
  };
1393
1528
  type TableOpAdd = {
@@ -1436,10 +1571,9 @@ type Commit = {
1436
1571
  message?: string;
1437
1572
  id: string;
1438
1573
  parentID?: string;
1574
+ checksum: string;
1439
1575
  mergeParentID?: string;
1440
- status: MigrationStatus;
1441
1576
  createdAt: DateTime;
1442
- modifiedAt?: DateTime;
1443
1577
  operations: MigrationOp[];
1444
1578
  };
1445
1579
  type SchemaEditScript = {
@@ -1447,6 +1581,16 @@ type SchemaEditScript = {
1447
1581
  targetMigrationID?: string;
1448
1582
  operations: MigrationOp[];
1449
1583
  };
1584
+ type BranchOp = {
1585
+ id: string;
1586
+ parentID?: string;
1587
+ title?: string;
1588
+ message?: string;
1589
+ status: MigrationStatus;
1590
+ createdAt: DateTime;
1591
+ modifiedAt?: DateTime;
1592
+ migration?: Commit;
1593
+ };
1450
1594
  /**
1451
1595
  * Branch schema migration.
1452
1596
  */
@@ -1454,6 +1598,14 @@ type Migration = {
1454
1598
  parentID?: string;
1455
1599
  operations: MigrationOp[];
1456
1600
  };
1601
+ type MigrationObject = {
1602
+ title?: string;
1603
+ message?: string;
1604
+ id: string;
1605
+ parentID?: string;
1606
+ checksum: string;
1607
+ operations: MigrationOp[];
1608
+ };
1457
1609
  /**
1458
1610
  * @pattern [a-zA-Z0-9_\-~\.]+
1459
1611
  */
@@ -1527,9 +1679,27 @@ type TransactionUpdateOp = {
1527
1679
  columns?: string[];
1528
1680
  };
1529
1681
  /**
1530
- * A delete operation. The transaction will continue if no record matches the ID.
1682
+ * A delete operation. The transaction will continue if no record matches the ID by default. To override this behaviour, set failIfMissing to true.
1531
1683
  */
1532
1684
  type TransactionDeleteOp = {
1685
+ /**
1686
+ * The table name
1687
+ */
1688
+ table: string;
1689
+ id: RecordID;
1690
+ /**
1691
+ * If true, the transaction will fail when the record doesn't exist.
1692
+ */
1693
+ failIfMissing?: boolean;
1694
+ /**
1695
+ * If set, the call will return the requested fields as part of the response.
1696
+ */
1697
+ columns?: string[];
1698
+ };
1699
+ /**
1700
+ * Get by id operation.
1701
+ */
1702
+ type TransactionGetOp = {
1533
1703
  /**
1534
1704
  * The table name
1535
1705
  */
@@ -1549,6 +1719,8 @@ type TransactionOperation$1 = {
1549
1719
  update: TransactionUpdateOp;
1550
1720
  } | {
1551
1721
  ['delete']: TransactionDeleteOp;
1722
+ } | {
1723
+ get: TransactionGetOp;
1552
1724
  };
1553
1725
  /**
1554
1726
  * Fields to return in the transaction result.
@@ -1600,11 +1772,21 @@ type TransactionResultDelete = {
1600
1772
  rows: number;
1601
1773
  columns?: TransactionResultColumns;
1602
1774
  };
1775
+ /**
1776
+ * A result from a get operation.
1777
+ */
1778
+ type TransactionResultGet = {
1779
+ /**
1780
+ * The type of operation who's result is being returned.
1781
+ */
1782
+ operation: 'get';
1783
+ columns?: TransactionResultColumns;
1784
+ };
1603
1785
  /**
1604
1786
  * An ordered array of results from the submitted operations.
1605
1787
  */
1606
1788
  type TransactionSuccess = {
1607
- results: (TransactionResultInsert | TransactionResultUpdate | TransactionResultDelete)[];
1789
+ results: (TransactionResultInsert | TransactionResultUpdate | TransactionResultDelete | TransactionResultGet)[];
1608
1790
  };
1609
1791
  /**
1610
1792
  * An error message from a failing transaction operation
@@ -1620,7 +1802,7 @@ type TransactionError = {
1620
1802
  message: string;
1621
1803
  };
1622
1804
  /**
1623
- * An array of errors, with indicides, from the transaction.
1805
+ * An array of errors, with indices, from the transaction.
1624
1806
  */
1625
1807
  type TransactionFailure = {
1626
1808
  /**
@@ -1639,27 +1821,36 @@ type ObjectValue = {
1639
1821
  [key: string]: string | boolean | number | string[] | number[] | DateTime | ObjectValue;
1640
1822
  };
1641
1823
  /**
1642
- * Object representing a file
1824
+ * Unique file identifier
1643
1825
  *
1644
- * @x-go-type file.InputFile
1826
+ * @maxLength 255
1827
+ * @minLength 1
1828
+ * @pattern [a-zA-Z0-9_-~:]+
1829
+ */
1830
+ type FileItemID = string;
1831
+ /**
1832
+ * File name
1833
+ *
1834
+ * @maxLength 1024
1835
+ * @minLength 0
1836
+ * @pattern [0-9a-zA-Z!\-_\.\*'\(\)]*
1837
+ */
1838
+ type FileName = string;
1839
+ /**
1840
+ * Media type
1841
+ *
1842
+ * @maxLength 255
1843
+ * @minLength 3
1844
+ * @pattern ^\w+/[-+.\w]+$
1845
+ */
1846
+ type MediaType = string;
1847
+ /**
1848
+ * Object representing a file in an array
1645
1849
  */
1646
1850
  type InputFileEntry = {
1647
- /**
1648
- * File name
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;
1851
+ id?: FileItemID;
1852
+ name?: FileName;
1853
+ mediaType?: MediaType;
1663
1854
  /**
1664
1855
  * Base64 encoded content
1665
1856
  *
@@ -1681,11 +1872,34 @@ type InputFileEntry = {
1681
1872
  * @maxItems 50
1682
1873
  */
1683
1874
  type InputFileArray = InputFileEntry[];
1875
+ /**
1876
+ * Object representing a file
1877
+ *
1878
+ * @x-go-type file.InputFile
1879
+ */
1880
+ type InputFile = {
1881
+ name: FileName;
1882
+ mediaType?: MediaType;
1883
+ /**
1884
+ * Base64 encoded content
1885
+ *
1886
+ * @maxLength 20971520
1887
+ */
1888
+ base64Content?: string;
1889
+ /**
1890
+ * Enable public access to the file
1891
+ */
1892
+ enablePublicUrl?: boolean;
1893
+ /**
1894
+ * Time to live for signed URLs
1895
+ */
1896
+ signedUrlTimeout?: number;
1897
+ };
1684
1898
  /**
1685
1899
  * Xata input record
1686
1900
  */
1687
1901
  type DataInputRecord = {
1688
- [key: string]: RecordID | string | boolean | number | string[] | number[] | DateTime | ObjectValue | InputFileArray | InputFileEntry;
1902
+ [key: string]: RecordID | string | boolean | number | string[] | number[] | DateTime | ObjectValue | InputFileArray | InputFile | null;
1689
1903
  };
1690
1904
  /**
1691
1905
  * Xata Table Record Metadata
@@ -1697,6 +1911,14 @@ type RecordMeta = {
1697
1911
  * The record's version. Can be used for optimistic concurrency control.
1698
1912
  */
1699
1913
  version: number;
1914
+ /**
1915
+ * The time when the record was created.
1916
+ */
1917
+ createdAt?: string;
1918
+ /**
1919
+ * The time when the record was last updated.
1920
+ */
1921
+ updatedAt?: string;
1700
1922
  /**
1701
1923
  * The record's table name. APIs that return records from multiple tables will set this field accordingly.
1702
1924
  */
@@ -1719,6 +1941,47 @@ type RecordMeta = {
1719
1941
  warnings?: string[];
1720
1942
  };
1721
1943
  };
1944
+ /**
1945
+ * File metadata
1946
+ */
1947
+ type FileResponse = {
1948
+ id?: FileItemID;
1949
+ name: FileName;
1950
+ mediaType: MediaType;
1951
+ /**
1952
+ * @format int64
1953
+ */
1954
+ size: number;
1955
+ /**
1956
+ * @format int64
1957
+ */
1958
+ version: number;
1959
+ attributes?: Record<string, any>;
1960
+ };
1961
+ type QueryColumnsProjection = (string | ProjectionConfig)[];
1962
+ /**
1963
+ * A structured projection that allows for some configuration.
1964
+ */
1965
+ type ProjectionConfig = {
1966
+ /**
1967
+ * The name of the column to project or a reverse link specification, see [API Guide](https://xata.io/docs/concepts/data-model#links-and-relations).
1968
+ */
1969
+ name?: string;
1970
+ columns?: QueryColumnsProjection;
1971
+ /**
1972
+ * An alias for the projected field, this is how it will be returned in the response.
1973
+ */
1974
+ as?: string;
1975
+ sort?: SortExpression;
1976
+ /**
1977
+ * @default 20
1978
+ */
1979
+ limit?: number;
1980
+ /**
1981
+ * @default 0
1982
+ */
1983
+ offset?: number;
1984
+ };
1722
1985
  /**
1723
1986
  * The target expression is used to filter the search results by the target columns.
1724
1987
  */
@@ -1749,7 +2012,7 @@ type ValueBooster$1 = {
1749
2012
  */
1750
2013
  value: string | number | boolean;
1751
2014
  /**
1752
- * The factor with which to multiply the score of the record.
2015
+ * The factor with which to multiply the added boost.
1753
2016
  */
1754
2017
  factor: number;
1755
2018
  /**
@@ -1791,7 +2054,8 @@ type NumericBooster$1 = {
1791
2054
  /**
1792
2055
  * 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
2056
  * 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 score 2 times less than a record with the date at origin.
2057
+ * 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.
2058
+ * 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
2059
  */
1796
2060
  type DateBooster$1 = {
1797
2061
  /**
@@ -1804,7 +2068,7 @@ type DateBooster$1 = {
1804
2068
  */
1805
2069
  origin?: string;
1806
2070
  /**
1807
- * The duration at which distance from origin the score is decayed with factor, using an exponential function. It is fromatted as number + units, for example: `5d`, `20m`, `10s`.
2071
+ * The duration at which distance from origin the score is decayed with factor, using an exponential function. It is formatted as number + units, for example: `5d`, `20m`, `10s`.
1808
2072
  *
1809
2073
  * @pattern ^(\d+)(d|h|m|s|ms)$
1810
2074
  */
@@ -1813,6 +2077,12 @@ type DateBooster$1 = {
1813
2077
  * The decay factor to expect at "scale" distance from the "origin".
1814
2078
  */
1815
2079
  decay: number;
2080
+ /**
2081
+ * The factor with which to multiply the added boost.
2082
+ *
2083
+ * @minimum 0
2084
+ */
2085
+ factor?: number;
1816
2086
  /**
1817
2087
  * Only apply this booster to the records for which the provided filter matches.
1818
2088
  */
@@ -1833,7 +2103,7 @@ type BoosterExpression = {
1833
2103
  /**
1834
2104
  * Maximum [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) for the search terms. The Levenshtein
1835
2105
  * distance is the number of one character changes needed to make two strings equal. The default is 1, meaning that single
1836
- * character typos per word are tollerated by search. You can set it to 0 to remove the typo tollerance or set it to 2
2106
+ * character typos per word are tolerated by search. You can set it to 0 to remove the typo tolerance or set it to 2
1837
2107
  * to allow two typos in a word.
1838
2108
  *
1839
2109
  * @default 1
@@ -1874,6 +2144,12 @@ type SearchPageConfig = {
1874
2144
  */
1875
2145
  offset?: number;
1876
2146
  };
2147
+ /**
2148
+ * Xata Table SQL Record
2149
+ */
2150
+ type SQLRecord = {
2151
+ [key: string]: any;
2152
+ };
1877
2153
  /**
1878
2154
  * A summary expression is the description of a single summary operation. It consists of a single
1879
2155
  * key representing the operation, and a value representing the column to be operated on.
@@ -1980,7 +2256,7 @@ type UniqueCountAgg = {
1980
2256
  column: string;
1981
2257
  /**
1982
2258
  * The threshold under which the unique count is exact. If the number of unique
1983
- * values in the column is higher than this threshold, the results are approximative.
2259
+ * values in the column is higher than this threshold, the results are approximate.
1984
2260
  * Maximum value is 40,000, default value is 3000.
1985
2261
  */
1986
2262
  precisionThreshold?: number;
@@ -2003,7 +2279,7 @@ type DateHistogramAgg = {
2003
2279
  column: string;
2004
2280
  /**
2005
2281
  * The fixed interval to use when bucketing.
2006
- * It is fromatted as number + units, for example: `5d`, `20m`, `10s`.
2282
+ * It is formatted as number + units, for example: `5d`, `20m`, `10s`.
2007
2283
  *
2008
2284
  * @pattern ^(\d+)(d|h|m|s|ms)$
2009
2285
  */
@@ -2058,7 +2334,7 @@ type NumericHistogramAgg = {
2058
2334
  interval: number;
2059
2335
  /**
2060
2336
  * By default the bucket keys start with 0 and then continue in `interval` steps. The bucket
2061
- * boundaries can be shiftend by using the offset option. For example, if the `interval` is 100,
2337
+ * boundaries can be shifted by using the offset option. For example, if the `interval` is 100,
2062
2338
  * but you prefer the bucket boundaries to be `[50, 150), [150, 250), etc.`, you can set `offset`
2063
2339
  * to 50.
2064
2340
  *
@@ -2101,6 +2377,18 @@ type AggResponse$1 = (number | null) | {
2101
2377
  [key: string]: AggResponse$1;
2102
2378
  })[];
2103
2379
  };
2380
+ /**
2381
+ * File identifier in access URLs
2382
+ *
2383
+ * @maxLength 296
2384
+ * @minLength 88
2385
+ * @pattern [a-v0-9=]+
2386
+ */
2387
+ type FileAccessID = string;
2388
+ /**
2389
+ * File signature
2390
+ */
2391
+ type FileSignature = string;
2104
2392
  /**
2105
2393
  * Xata Table Record Metadata
2106
2394
  */
@@ -2146,12 +2434,19 @@ type SchemaCompareResponse = {
2146
2434
  target: Schema;
2147
2435
  edits: SchemaEditScript;
2148
2436
  };
2437
+ type RateLimitError = {
2438
+ id?: string;
2439
+ message: string;
2440
+ };
2149
2441
  type RecordUpdateResponse = XataRecord$1 | {
2150
2442
  id: string;
2151
2443
  xata: {
2152
2444
  version: number;
2445
+ createdAt: string;
2446
+ updatedAt: string;
2153
2447
  };
2154
2448
  };
2449
+ type PutFileResponse = FileResponse;
2155
2450
  type RecordResponse = XataRecord$1;
2156
2451
  type BulkInsertResponse = {
2157
2452
  recordIDs: string[];
@@ -2168,13 +2463,21 @@ type QueryResponse = {
2168
2463
  records: XataRecord$1[];
2169
2464
  meta: RecordsMetadata;
2170
2465
  };
2466
+ type ServiceUnavailableError = {
2467
+ id?: string;
2468
+ message: string;
2469
+ };
2171
2470
  type SearchResponse = {
2172
2471
  records: XataRecord$1[];
2173
2472
  warning?: string;
2473
+ /**
2474
+ * The total count of records matched. It will be accurately returned up to 10000 records.
2475
+ */
2476
+ totalCount: number;
2174
2477
  };
2175
- type RateLimitError = {
2176
- id?: string;
2177
- message: string;
2478
+ type SQLResponse = {
2479
+ records: SQLRecord[];
2480
+ warning?: string;
2178
2481
  };
2179
2482
  type SummarizeResponse = {
2180
2483
  summaries: Record<string, any>[];
@@ -2199,6 +2502,8 @@ type DataPlaneFetcherExtraProps = {
2199
2502
  sessionID?: string;
2200
2503
  clientName?: string;
2201
2504
  xataAgentExtra?: Record<string, string>;
2505
+ rawResponse?: boolean;
2506
+ headers?: Record<string, unknown>;
2202
2507
  };
2203
2508
  type ErrorWrapper<TError> = TError | {
2204
2509
  status: 'unknown';
@@ -2337,6 +2642,36 @@ type DeleteBranchVariables = {
2337
2642
  * Delete the branch in the database and all its resources
2338
2643
  */
2339
2644
  declare const deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal) => Promise<DeleteBranchResponse>;
2645
+ type CopyBranchPathParams = {
2646
+ /**
2647
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2648
+ */
2649
+ dbBranchName: DBBranchName;
2650
+ workspace: string;
2651
+ region: string;
2652
+ };
2653
+ type CopyBranchError = ErrorWrapper<{
2654
+ status: 400;
2655
+ payload: BadRequestError;
2656
+ } | {
2657
+ status: 401;
2658
+ payload: AuthError;
2659
+ } | {
2660
+ status: 404;
2661
+ payload: SimpleError;
2662
+ }>;
2663
+ type CopyBranchRequestBody = {
2664
+ destinationBranch: string;
2665
+ limit?: number;
2666
+ };
2667
+ type CopyBranchVariables = {
2668
+ body: CopyBranchRequestBody;
2669
+ pathParams: CopyBranchPathParams;
2670
+ } & DataPlaneFetcherExtraProps;
2671
+ /**
2672
+ * Create a copy of the branch
2673
+ */
2674
+ declare const copyBranch: (variables: CopyBranchVariables, signal?: AbortSignal) => Promise<BranchWithCopyID>;
2340
2675
  type UpdateBranchMetadataPathParams = {
2341
2676
  /**
2342
2677
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -2981,7 +3316,7 @@ type MergeMigrationRequestError = ErrorWrapper<{
2981
3316
  type MergeMigrationRequestVariables = {
2982
3317
  pathParams: MergeMigrationRequestPathParams;
2983
3318
  } & DataPlaneFetcherExtraProps;
2984
- declare const mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal) => Promise<Commit>;
3319
+ declare const mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal) => Promise<BranchOp>;
2985
3320
  type GetBranchSchemaHistoryPathParams = {
2986
3321
  /**
2987
3322
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -3178,19 +3513,15 @@ type ApplyBranchSchemaEditVariables = {
3178
3513
  pathParams: ApplyBranchSchemaEditPathParams;
3179
3514
  } & DataPlaneFetcherExtraProps;
3180
3515
  declare const applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
3181
- type CreateTablePathParams = {
3516
+ type PushBranchMigrationsPathParams = {
3182
3517
  /**
3183
3518
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3184
3519
  */
3185
3520
  dbBranchName: DBBranchName;
3186
- /**
3187
- * The Table name
3188
- */
3189
- tableName: TableName;
3190
3521
  workspace: string;
3191
3522
  region: string;
3192
3523
  };
3193
- type CreateTableError = ErrorWrapper<{
3524
+ type PushBranchMigrationsError = ErrorWrapper<{
3194
3525
  status: 400;
3195
3526
  payload: BadRequestError;
3196
3527
  } | {
@@ -3199,16 +3530,58 @@ type CreateTableError = ErrorWrapper<{
3199
3530
  } | {
3200
3531
  status: 404;
3201
3532
  payload: SimpleError;
3202
- } | {
3203
- status: 422;
3204
- payload: SimpleError;
3205
3533
  }>;
3206
- type CreateTableResponse = {
3207
- branchName: string;
3208
- /**
3209
- * @minLength 1
3210
- */
3211
- tableName: string;
3534
+ type PushBranchMigrationsRequestBody = {
3535
+ migrations: MigrationObject[];
3536
+ };
3537
+ type PushBranchMigrationsVariables = {
3538
+ body: PushBranchMigrationsRequestBody;
3539
+ pathParams: PushBranchMigrationsPathParams;
3540
+ } & DataPlaneFetcherExtraProps;
3541
+ /**
3542
+ * The `schema/push` API accepts a list of migrations to be applied to the
3543
+ * current branch. A list of applicable migrations can be fetched using
3544
+ * the `schema/history` API from another branch or database.
3545
+ *
3546
+ * The most recent migration must be part of the list or referenced (via
3547
+ * `parentID`) by the first migration in the list of migrations to be pushed.
3548
+ *
3549
+ * Each migration in the list has an `id`, `parentID`, and `checksum`. The
3550
+ * checksum for migrations are generated and verified by xata. The
3551
+ * operation fails if any migration in the list has an invalid checksum.
3552
+ */
3553
+ declare const pushBranchMigrations: (variables: PushBranchMigrationsVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
3554
+ type CreateTablePathParams = {
3555
+ /**
3556
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3557
+ */
3558
+ dbBranchName: DBBranchName;
3559
+ /**
3560
+ * The Table name
3561
+ */
3562
+ tableName: TableName;
3563
+ workspace: string;
3564
+ region: string;
3565
+ };
3566
+ type CreateTableError = ErrorWrapper<{
3567
+ status: 400;
3568
+ payload: BadRequestError;
3569
+ } | {
3570
+ status: 401;
3571
+ payload: AuthError;
3572
+ } | {
3573
+ status: 404;
3574
+ payload: SimpleError;
3575
+ } | {
3576
+ status: 422;
3577
+ payload: SimpleError;
3578
+ }>;
3579
+ type CreateTableResponse = {
3580
+ branchName: string;
3581
+ /**
3582
+ * @minLength 1
3583
+ */
3584
+ tableName: string;
3212
3585
  status: MigrationStatus;
3213
3586
  };
3214
3587
  type CreateTableVariables = {
@@ -3418,9 +3791,7 @@ type AddTableColumnVariables = {
3418
3791
  pathParams: AddTableColumnPathParams;
3419
3792
  } & DataPlaneFetcherExtraProps;
3420
3793
  /**
3421
- * Adds a new column to the table. The body of the request should contain the column definition. In the column definition, the 'name' field should
3422
- * contain the full path separated by dots. If the parent objects do not exists, they will be automatically created. For example,
3423
- * passing `"name": "address.city"` will auto-create the `address` object if it doesn't exist.
3794
+ * Adds a new column to the table. The body of the request should contain the column definition.
3424
3795
  */
3425
3796
  declare const addTableColumn: (variables: AddTableColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
3426
3797
  type GetColumnPathParams = {
@@ -3453,7 +3824,7 @@ type GetColumnVariables = {
3453
3824
  pathParams: GetColumnPathParams;
3454
3825
  } & DataPlaneFetcherExtraProps;
3455
3826
  /**
3456
- * Get the definition of a single column. To refer to sub-objects, the column name can contain dots. For example `address.country`.
3827
+ * Get the definition of a single column.
3457
3828
  */
3458
3829
  declare const getColumn: (variables: GetColumnVariables, signal?: AbortSignal) => Promise<Column>;
3459
3830
  type UpdateColumnPathParams = {
@@ -3493,7 +3864,7 @@ type UpdateColumnVariables = {
3493
3864
  pathParams: UpdateColumnPathParams;
3494
3865
  } & DataPlaneFetcherExtraProps;
3495
3866
  /**
3496
- * Update column with partial data. Can be used for renaming the column by providing a new "name" field. To refer to sub-objects, the column name can contain dots. For example `address.country`.
3867
+ * Update column with partial data. Can be used for renaming the column by providing a new "name" field.
3497
3868
  */
3498
3869
  declare const updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
3499
3870
  type DeleteColumnPathParams = {
@@ -3526,7 +3897,7 @@ type DeleteColumnVariables = {
3526
3897
  pathParams: DeleteColumnPathParams;
3527
3898
  } & DataPlaneFetcherExtraProps;
3528
3899
  /**
3529
- * Deletes the specified column. To refer to sub-objects, the column name can contain dots. For example `address.country`.
3900
+ * Deletes the specified column.
3530
3901
  */
3531
3902
  declare const deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
3532
3903
  type BranchTransactionPathParams = {
@@ -3546,6 +3917,9 @@ type BranchTransactionError = ErrorWrapper<{
3546
3917
  } | {
3547
3918
  status: 404;
3548
3919
  payload: SimpleError;
3920
+ } | {
3921
+ status: 429;
3922
+ payload: RateLimitError;
3549
3923
  }>;
3550
3924
  type BranchTransactionRequestBody = {
3551
3925
  operations: TransactionOperation$1[];
@@ -3592,6 +3966,248 @@ type InsertRecordVariables = {
3592
3966
  * Insert a new Record into the Table
3593
3967
  */
3594
3968
  declare const insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal) => Promise<RecordUpdateResponse>;
3969
+ type GetFileItemPathParams = {
3970
+ /**
3971
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3972
+ */
3973
+ dbBranchName: DBBranchName;
3974
+ /**
3975
+ * The Table name
3976
+ */
3977
+ tableName: TableName;
3978
+ /**
3979
+ * The Record name
3980
+ */
3981
+ recordId: RecordID;
3982
+ /**
3983
+ * The Column name
3984
+ */
3985
+ columnName: ColumnName;
3986
+ /**
3987
+ * The File Identifier
3988
+ */
3989
+ fileId: FileItemID;
3990
+ workspace: string;
3991
+ region: string;
3992
+ };
3993
+ type GetFileItemError = ErrorWrapper<{
3994
+ status: 400;
3995
+ payload: BadRequestError;
3996
+ } | {
3997
+ status: 401;
3998
+ payload: AuthError;
3999
+ } | {
4000
+ status: 404;
4001
+ payload: SimpleError;
4002
+ }>;
4003
+ type GetFileItemVariables = {
4004
+ pathParams: GetFileItemPathParams;
4005
+ } & DataPlaneFetcherExtraProps;
4006
+ /**
4007
+ * Retrieves file content from an array by file ID
4008
+ */
4009
+ declare const getFileItem: (variables: GetFileItemVariables, signal?: AbortSignal) => Promise<Blob>;
4010
+ type PutFileItemPathParams = {
4011
+ /**
4012
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4013
+ */
4014
+ dbBranchName: DBBranchName;
4015
+ /**
4016
+ * The Table name
4017
+ */
4018
+ tableName: TableName;
4019
+ /**
4020
+ * The Record name
4021
+ */
4022
+ recordId: RecordID;
4023
+ /**
4024
+ * The Column name
4025
+ */
4026
+ columnName: ColumnName;
4027
+ /**
4028
+ * The File Identifier
4029
+ */
4030
+ fileId: FileItemID;
4031
+ workspace: string;
4032
+ region: string;
4033
+ };
4034
+ type PutFileItemError = ErrorWrapper<{
4035
+ status: 400;
4036
+ payload: BadRequestError;
4037
+ } | {
4038
+ status: 401;
4039
+ payload: AuthError;
4040
+ } | {
4041
+ status: 404;
4042
+ payload: SimpleError;
4043
+ } | {
4044
+ status: 422;
4045
+ payload: SimpleError;
4046
+ }>;
4047
+ type PutFileItemVariables = {
4048
+ body?: Blob;
4049
+ pathParams: PutFileItemPathParams;
4050
+ } & DataPlaneFetcherExtraProps;
4051
+ /**
4052
+ * Uploads the file content to an array given the file ID
4053
+ */
4054
+ declare const putFileItem: (variables: PutFileItemVariables, signal?: AbortSignal) => Promise<FileResponse>;
4055
+ type DeleteFileItemPathParams = {
4056
+ /**
4057
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4058
+ */
4059
+ dbBranchName: DBBranchName;
4060
+ /**
4061
+ * The Table name
4062
+ */
4063
+ tableName: TableName;
4064
+ /**
4065
+ * The Record name
4066
+ */
4067
+ recordId: RecordID;
4068
+ /**
4069
+ * The Column name
4070
+ */
4071
+ columnName: ColumnName;
4072
+ /**
4073
+ * The File Identifier
4074
+ */
4075
+ fileId: FileItemID;
4076
+ workspace: string;
4077
+ region: string;
4078
+ };
4079
+ type DeleteFileItemError = ErrorWrapper<{
4080
+ status: 400;
4081
+ payload: BadRequestError;
4082
+ } | {
4083
+ status: 401;
4084
+ payload: AuthError;
4085
+ } | {
4086
+ status: 404;
4087
+ payload: SimpleError;
4088
+ }>;
4089
+ type DeleteFileItemVariables = {
4090
+ pathParams: DeleteFileItemPathParams;
4091
+ } & DataPlaneFetcherExtraProps;
4092
+ /**
4093
+ * Deletes an item from an file array column given the file ID
4094
+ */
4095
+ declare const deleteFileItem: (variables: DeleteFileItemVariables, signal?: AbortSignal) => Promise<FileResponse>;
4096
+ type GetFilePathParams = {
4097
+ /**
4098
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4099
+ */
4100
+ dbBranchName: DBBranchName;
4101
+ /**
4102
+ * The Table name
4103
+ */
4104
+ tableName: TableName;
4105
+ /**
4106
+ * The Record name
4107
+ */
4108
+ recordId: RecordID;
4109
+ /**
4110
+ * The Column name
4111
+ */
4112
+ columnName: ColumnName;
4113
+ workspace: string;
4114
+ region: string;
4115
+ };
4116
+ type GetFileError = ErrorWrapper<{
4117
+ status: 400;
4118
+ payload: BadRequestError;
4119
+ } | {
4120
+ status: 401;
4121
+ payload: AuthError;
4122
+ } | {
4123
+ status: 404;
4124
+ payload: SimpleError;
4125
+ }>;
4126
+ type GetFileVariables = {
4127
+ pathParams: GetFilePathParams;
4128
+ } & DataPlaneFetcherExtraProps;
4129
+ /**
4130
+ * Retrieves the file content from a file column
4131
+ */
4132
+ declare const getFile: (variables: GetFileVariables, signal?: AbortSignal) => Promise<Blob>;
4133
+ type PutFilePathParams = {
4134
+ /**
4135
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4136
+ */
4137
+ dbBranchName: DBBranchName;
4138
+ /**
4139
+ * The Table name
4140
+ */
4141
+ tableName: TableName;
4142
+ /**
4143
+ * The Record name
4144
+ */
4145
+ recordId: RecordID;
4146
+ /**
4147
+ * The Column name
4148
+ */
4149
+ columnName: ColumnName;
4150
+ workspace: string;
4151
+ region: string;
4152
+ };
4153
+ type PutFileError = ErrorWrapper<{
4154
+ status: 400;
4155
+ payload: BadRequestError;
4156
+ } | {
4157
+ status: 401;
4158
+ payload: AuthError;
4159
+ } | {
4160
+ status: 404;
4161
+ payload: SimpleError;
4162
+ } | {
4163
+ status: 422;
4164
+ payload: SimpleError;
4165
+ }>;
4166
+ type PutFileVariables = {
4167
+ body?: Blob;
4168
+ pathParams: PutFilePathParams;
4169
+ } & DataPlaneFetcherExtraProps;
4170
+ /**
4171
+ * Uploads the file content to the given file column
4172
+ */
4173
+ declare const putFile: (variables: PutFileVariables, signal?: AbortSignal) => Promise<FileResponse>;
4174
+ type DeleteFilePathParams = {
4175
+ /**
4176
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4177
+ */
4178
+ dbBranchName: DBBranchName;
4179
+ /**
4180
+ * The Table name
4181
+ */
4182
+ tableName: TableName;
4183
+ /**
4184
+ * The Record name
4185
+ */
4186
+ recordId: RecordID;
4187
+ /**
4188
+ * The Column name
4189
+ */
4190
+ columnName: ColumnName;
4191
+ workspace: string;
4192
+ region: string;
4193
+ };
4194
+ type DeleteFileError = ErrorWrapper<{
4195
+ status: 400;
4196
+ payload: BadRequestError;
4197
+ } | {
4198
+ status: 401;
4199
+ payload: AuthError;
4200
+ } | {
4201
+ status: 404;
4202
+ payload: SimpleError;
4203
+ }>;
4204
+ type DeleteFileVariables = {
4205
+ pathParams: DeleteFilePathParams;
4206
+ } & DataPlaneFetcherExtraProps;
4207
+ /**
4208
+ * Deletes a file referred in a file column
4209
+ */
4210
+ declare const deleteFile: (variables: DeleteFileVariables, signal?: AbortSignal) => Promise<FileResponse>;
3595
4211
  type GetRecordPathParams = {
3596
4212
  /**
3597
4213
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -3863,12 +4479,15 @@ type QueryTableError = ErrorWrapper<{
3863
4479
  } | {
3864
4480
  status: 404;
3865
4481
  payload: SimpleError;
4482
+ } | {
4483
+ status: 503;
4484
+ payload: ServiceUnavailableError;
3866
4485
  }>;
3867
4486
  type QueryTableRequestBody = {
3868
4487
  filter?: FilterExpression;
3869
4488
  sort?: SortExpression;
3870
4489
  page?: PageConfig;
3871
- columns?: ColumnsProjection;
4490
+ columns?: QueryColumnsProjection;
3872
4491
  /**
3873
4492
  * The consistency level for this request.
3874
4493
  *
@@ -4532,25 +5151,40 @@ type QueryTableVariables = {
4532
5151
  * }
4533
5152
  * ```
4534
5153
  *
4535
- * ### Pagination
5154
+ * It is also possible to sort results randomly:
4536
5155
  *
4537
- * We offer cursor pagination and offset pagination. For queries that are expected to return more than 1000 records,
4538
- * cursor pagination is needed in order to retrieve all of their results. The offset pagination method is limited to 1000 records.
5156
+ * ```json
5157
+ * POST /db/demo:main/tables/table/query
5158
+ * {
5159
+ * "sort": {
5160
+ * "*": "random"
5161
+ * }
5162
+ * }
5163
+ * ```
5164
+ *
5165
+ * Note that a random sort does not apply to a specific column, hence the special column name `"*"`.
4539
5166
  *
4540
- * Example of size + offset pagination:
5167
+ * A random sort can be combined with an ascending or descending sort on a specific column:
4541
5168
  *
4542
5169
  * ```json
4543
5170
  * POST /db/demo:main/tables/table/query
4544
5171
  * {
4545
- * "page": {
4546
- * "size": 100,
4547
- * "offset": 200
4548
- * }
5172
+ * "sort": [
5173
+ * {
5174
+ * "name": "desc"
5175
+ * },
5176
+ * {
5177
+ * "*": "random"
5178
+ * }
5179
+ * ]
4549
5180
  * }
4550
5181
  * ```
4551
5182
  *
4552
- * 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.
4553
- * 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.
5183
+ * This will sort on the `name` column, breaking ties randomly.
5184
+ *
5185
+ * ### Pagination
5186
+ *
5187
+ * 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
5188
  *
4555
5189
  * Example of cursor pagination:
4556
5190
  *
@@ -4604,6 +5238,34 @@ type QueryTableVariables = {
4604
5238
  * `filter` or `sort` is set. The columns returned and page size can be changed
4605
5239
  * anytime by passing the `columns` or `page.size` settings to the next query.
4606
5240
  *
5241
+ * In the following example of size + offset pagination we retrieve the third page of up to 100 results:
5242
+ *
5243
+ * ```json
5244
+ * POST /db/demo:main/tables/table/query
5245
+ * {
5246
+ * "page": {
5247
+ * "size": 100,
5248
+ * "offset": 200
5249
+ * }
5250
+ * }
5251
+ * ```
5252
+ *
5253
+ * 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.
5254
+ * 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.
5255
+ *
5256
+ * 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:
5257
+ *
5258
+ * ```json
5259
+ * POST /db/demo:main/tables/table/query
5260
+ * {
5261
+ * "page": {
5262
+ * "size": 200,
5263
+ * "offset": 800,
5264
+ * "after": "fMoxCsIwFIDh3WP8c4amDai5hO5SJCRNfaVSeC9b6d1FD"
5265
+ * }
5266
+ * }
5267
+ * ```
5268
+ *
4607
5269
  * **Special cursors:**
4608
5270
  *
4609
5271
  * - `page.after=end`: Result points past the last entry. The list of records
@@ -4654,6 +5316,9 @@ type SearchBranchError = ErrorWrapper<{
4654
5316
  } | {
4655
5317
  status: 404;
4656
5318
  payload: SimpleError;
5319
+ } | {
5320
+ status: 503;
5321
+ payload: ServiceUnavailableError;
4657
5322
  }>;
4658
5323
  type SearchBranchRequestBody = {
4659
5324
  /**
@@ -4736,6 +5401,53 @@ type SearchTableVariables = {
4736
5401
  * * filtering on columns of type `multiple` is currently unsupported
4737
5402
  */
4738
5403
  declare const searchTable: (variables: SearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
5404
+ type SqlQueryPathParams = {
5405
+ /**
5406
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
5407
+ */
5408
+ dbBranchName: DBBranchName;
5409
+ workspace: string;
5410
+ region: string;
5411
+ };
5412
+ type SqlQueryError = ErrorWrapper<{
5413
+ status: 400;
5414
+ payload: BadRequestError;
5415
+ } | {
5416
+ status: 401;
5417
+ payload: AuthError;
5418
+ } | {
5419
+ status: 404;
5420
+ payload: SimpleError;
5421
+ } | {
5422
+ status: 503;
5423
+ payload: ServiceUnavailableError;
5424
+ }>;
5425
+ type SqlQueryRequestBody = {
5426
+ /**
5427
+ * The query string.
5428
+ *
5429
+ * @minLength 1
5430
+ */
5431
+ query: string;
5432
+ /**
5433
+ * The query parameter list.
5434
+ */
5435
+ params?: any[] | null;
5436
+ /**
5437
+ * The consistency level for this request.
5438
+ *
5439
+ * @default strong
5440
+ */
5441
+ consistency?: 'strong' | 'eventual';
5442
+ };
5443
+ type SqlQueryVariables = {
5444
+ body: SqlQueryRequestBody;
5445
+ pathParams: SqlQueryPathParams;
5446
+ } & DataPlaneFetcherExtraProps;
5447
+ /**
5448
+ * Run an SQL query across the database branch.
5449
+ */
5450
+ declare const sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<SQLResponse>;
4739
5451
  type VectorSearchTablePathParams = {
4740
5452
  /**
4741
5453
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -4785,18 +5497,106 @@ type VectorSearchTableRequestBody = {
4785
5497
  size?: number;
4786
5498
  filter?: FilterExpression;
4787
5499
  };
4788
- type VectorSearchTableVariables = {
4789
- body: VectorSearchTableRequestBody;
4790
- pathParams: VectorSearchTablePathParams;
5500
+ type VectorSearchTableVariables = {
5501
+ body: VectorSearchTableRequestBody;
5502
+ pathParams: VectorSearchTablePathParams;
5503
+ } & DataPlaneFetcherExtraProps;
5504
+ /**
5505
+ * This endpoint can be used to perform vector-based similarity searches in a table.
5506
+ * It can be used for implementing semantic search and product recommendation. To use this
5507
+ * endpoint, you need a column of type vector. The input vector must have the same
5508
+ * dimension as the vector column.
5509
+ */
5510
+ declare const vectorSearchTable: (variables: VectorSearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
5511
+ type AskTablePathParams = {
5512
+ /**
5513
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
5514
+ */
5515
+ dbBranchName: DBBranchName;
5516
+ /**
5517
+ * The Table name
5518
+ */
5519
+ tableName: TableName;
5520
+ workspace: string;
5521
+ region: string;
5522
+ };
5523
+ type AskTableError = ErrorWrapper<{
5524
+ status: 400;
5525
+ payload: BadRequestError;
5526
+ } | {
5527
+ status: 401;
5528
+ payload: AuthError;
5529
+ } | {
5530
+ status: 404;
5531
+ payload: SimpleError;
5532
+ } | {
5533
+ status: 429;
5534
+ payload: RateLimitError;
5535
+ }>;
5536
+ type AskTableResponse = {
5537
+ /**
5538
+ * The answer to the input question
5539
+ */
5540
+ answer: string;
5541
+ /**
5542
+ * The session ID for the chat session.
5543
+ */
5544
+ sessionId: string;
5545
+ };
5546
+ type AskTableRequestBody = {
5547
+ /**
5548
+ * The question you'd like to ask.
5549
+ *
5550
+ * @minLength 3
5551
+ */
5552
+ question?: string;
5553
+ /**
5554
+ * The type of search to use. If set to `keyword` (the default), the search can be configured by passing
5555
+ * a `search` object with the following fields. For more details about each, see the Search endpoint documentation.
5556
+ * All fields are optional.
5557
+ * * fuzziness - typo tolerance
5558
+ * * target - columns to search into, and weights.
5559
+ * * prefix - prefix search type.
5560
+ * * filter - pre-filter before searching.
5561
+ * * boosters - control relevancy.
5562
+ * If set to `vector`, a `vectorSearch` object must be passed, with the following parameters. For more details, see the Vector
5563
+ * Search endpoint documentation. The `column` and `contentColumn` parameters are required.
5564
+ * * column - the vector column containing the embeddings.
5565
+ * * contentColumn - the column that contains the text from which the embeddings where computed.
5566
+ * * filter - pre-filter before searching.
5567
+ *
5568
+ * @default keyword
5569
+ */
5570
+ searchType?: 'keyword' | 'vector';
5571
+ search?: {
5572
+ fuzziness?: FuzzinessExpression;
5573
+ target?: TargetExpression;
5574
+ prefix?: PrefixExpression;
5575
+ filter?: FilterExpression;
5576
+ boosters?: BoosterExpression[];
5577
+ };
5578
+ vectorSearch?: {
5579
+ /**
5580
+ * The column to use for vector search. It must be of type `vector`.
5581
+ */
5582
+ column: string;
5583
+ /**
5584
+ * The column containing the text for vector search. Must be of type `text`.
5585
+ */
5586
+ contentColumn: string;
5587
+ filter?: FilterExpression;
5588
+ };
5589
+ rules?: string[];
5590
+ };
5591
+ type AskTableVariables = {
5592
+ body?: AskTableRequestBody;
5593
+ pathParams: AskTablePathParams;
4791
5594
  } & DataPlaneFetcherExtraProps;
4792
5595
  /**
4793
- * This endpoint can be used to perform vector-based similarity searches in a table.
4794
- * It can be used for implementing semantic search and product recommendation. To use this
4795
- * endpoint, you need a column of type vector. The input vector must have the same
4796
- * dimension as the vector column.
5596
+ * Ask your table a question. If the `Accept` header is set to `text/event-stream`, Xata will stream the results back as SSE's.
4797
5597
  */
4798
- declare const vectorSearchTable: (variables: VectorSearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
4799
- type AskTablePathParams = {
5598
+ declare const askTable: (variables: AskTableVariables, signal?: AbortSignal) => Promise<AskTableResponse>;
5599
+ type AskTableSessionPathParams = {
4800
5600
  /**
4801
5601
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4802
5602
  */
@@ -4805,10 +5605,15 @@ type AskTablePathParams = {
4805
5605
  * The Table name
4806
5606
  */
4807
5607
  tableName: TableName;
5608
+ /**
5609
+ * @maxLength 36
5610
+ * @minLength 36
5611
+ */
5612
+ sessionId: string;
4808
5613
  workspace: string;
4809
5614
  region: string;
4810
5615
  };
4811
- type AskTableError = ErrorWrapper<{
5616
+ type AskTableSessionError = ErrorWrapper<{
4812
5617
  status: 400;
4813
5618
  payload: BadRequestError;
4814
5619
  } | {
@@ -4820,35 +5625,32 @@ type AskTableError = ErrorWrapper<{
4820
5625
  } | {
4821
5626
  status: 429;
4822
5627
  payload: RateLimitError;
5628
+ } | {
5629
+ status: 503;
5630
+ payload: ServiceUnavailableError;
4823
5631
  }>;
4824
- type AskTableResponse = {
5632
+ type AskTableSessionResponse = {
4825
5633
  /**
4826
5634
  * The answer to the input question
4827
5635
  */
4828
5636
  answer?: string;
4829
5637
  };
4830
- type AskTableRequestBody = {
5638
+ type AskTableSessionRequestBody = {
4831
5639
  /**
4832
5640
  * The question you'd like to ask.
4833
5641
  *
4834
5642
  * @minLength 3
4835
5643
  */
4836
- question: string;
4837
- fuzziness?: FuzzinessExpression;
4838
- target?: TargetExpression;
4839
- prefix?: PrefixExpression;
4840
- filter?: FilterExpression;
4841
- boosters?: BoosterExpression[];
4842
- rules?: string[];
5644
+ message?: string;
4843
5645
  };
4844
- type AskTableVariables = {
4845
- body: AskTableRequestBody;
4846
- pathParams: AskTablePathParams;
5646
+ type AskTableSessionVariables = {
5647
+ body?: AskTableSessionRequestBody;
5648
+ pathParams: AskTableSessionPathParams;
4847
5649
  } & DataPlaneFetcherExtraProps;
4848
5650
  /**
4849
- * Ask your table a question. If the `Accept` header is set to `text/event-stream`, Xata will stream the results back as SSE's.
5651
+ * Ask a follow-up question. If the `Accept` header is set to `text/event-stream`, Xata will stream the results back as SSE's.
4850
5652
  */
4851
- declare const askTable: (variables: AskTableVariables, signal?: AbortSignal) => Promise<AskTableResponse>;
5653
+ declare const askTableSession: (variables: AskTableSessionVariables, signal?: AbortSignal) => Promise<AskTableSessionResponse>;
4852
5654
  type SummarizeTablePathParams = {
4853
5655
  /**
4854
5656
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -4995,7 +5797,7 @@ type AggregateTableVariables = {
4995
5797
  pathParams: AggregateTablePathParams;
4996
5798
  } & DataPlaneFetcherExtraProps;
4997
5799
  /**
4998
- * This endpoint allows you to run aggragations (analytics) on the data from one table.
5800
+ * This endpoint allows you to run aggregations (analytics) on the data from one table.
4999
5801
  * While the summary endpoint is served from a transactional store and the results are strongly
5000
5802
  * consistent, the aggregate endpoint is served from our columnar store and the results are
5001
5803
  * only eventually consistent. On the other hand, the aggregate endpoint uses a
@@ -5005,6 +5807,38 @@ type AggregateTableVariables = {
5005
5807
  * For usage, see the [API Guide](https://xata.io/docs/api-guide/aggregate).
5006
5808
  */
5007
5809
  declare const aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal) => Promise<AggResponse>;
5810
+ type FileAccessPathParams = {
5811
+ /**
5812
+ * The File Access Identifier
5813
+ */
5814
+ fileId: FileAccessID;
5815
+ workspace: string;
5816
+ region: string;
5817
+ };
5818
+ type FileAccessQueryParams = {
5819
+ /**
5820
+ * File access signature
5821
+ */
5822
+ verify?: FileSignature;
5823
+ };
5824
+ type FileAccessError = ErrorWrapper<{
5825
+ status: 400;
5826
+ payload: BadRequestError;
5827
+ } | {
5828
+ status: 401;
5829
+ payload: AuthError;
5830
+ } | {
5831
+ status: 404;
5832
+ payload: SimpleError;
5833
+ }>;
5834
+ type FileAccessVariables = {
5835
+ pathParams: FileAccessPathParams;
5836
+ queryParams?: FileAccessQueryParams;
5837
+ } & DataPlaneFetcherExtraProps;
5838
+ /**
5839
+ * Retrieve file content by access id
5840
+ */
5841
+ declare const fileAccess: (variables: FileAccessVariables, signal?: AbortSignal) => Promise<Blob>;
5008
5842
 
5009
5843
  declare const operationsByTag: {
5010
5844
  branch: {
@@ -5012,6 +5846,7 @@ declare const operationsByTag: {
5012
5846
  getBranchDetails: (variables: GetBranchDetailsVariables, signal?: AbortSignal | undefined) => Promise<DBBranch>;
5013
5847
  createBranch: (variables: CreateBranchVariables, signal?: AbortSignal | undefined) => Promise<CreateBranchResponse>;
5014
5848
  deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal | undefined) => Promise<DeleteBranchResponse>;
5849
+ copyBranch: (variables: CopyBranchVariables, signal?: AbortSignal | undefined) => Promise<BranchWithCopyID>;
5015
5850
  updateBranchMetadata: (variables: UpdateBranchMetadataVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
5016
5851
  getBranchMetadata: (variables: GetBranchMetadataVariables, signal?: AbortSignal | undefined) => Promise<BranchMetadata>;
5017
5852
  getBranchStats: (variables: GetBranchStatsVariables, signal?: AbortSignal | undefined) => Promise<GetBranchStatsResponse>;
@@ -5020,16 +5855,6 @@ declare const operationsByTag: {
5020
5855
  removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
5021
5856
  resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal | undefined) => Promise<ResolveBranchResponse>;
5022
5857
  };
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
5858
  migrations: {
5034
5859
  getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal | undefined) => Promise<GetBranchMigrationHistoryResponse>;
5035
5860
  getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables, signal?: AbortSignal | undefined) => Promise<BranchMigrationPlan>;
@@ -5040,6 +5865,17 @@ declare const operationsByTag: {
5040
5865
  updateBranchSchema: (variables: UpdateBranchSchemaVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
5041
5866
  previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables, signal?: AbortSignal | undefined) => Promise<PreviewBranchSchemaEditResponse>;
5042
5867
  applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
5868
+ pushBranchMigrations: (variables: PushBranchMigrationsVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
5869
+ };
5870
+ records: {
5871
+ branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal | undefined) => Promise<TransactionSuccess>;
5872
+ insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
5873
+ getRecord: (variables: GetRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
5874
+ insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
5875
+ updateRecordWithID: (variables: UpdateRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
5876
+ upsertRecordWithID: (variables: UpsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
5877
+ deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
5878
+ bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal | undefined) => Promise<BulkInsertResponse>;
5043
5879
  };
5044
5880
  migrationRequests: {
5045
5881
  queryMigrationRequests: (variables: QueryMigrationRequestsVariables, signal?: AbortSignal | undefined) => Promise<QueryMigrationRequestsResponse>;
@@ -5049,7 +5885,7 @@ declare const operationsByTag: {
5049
5885
  listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables, signal?: AbortSignal | undefined) => Promise<ListMigrationRequestsCommitsResponse>;
5050
5886
  compareMigrationRequest: (variables: CompareMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<SchemaCompareResponse>;
5051
5887
  getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables, signal?: AbortSignal | undefined) => Promise<GetMigrationRequestIsMergedResponse>;
5052
- mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<Commit>;
5888
+ mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<BranchOp>;
5053
5889
  };
5054
5890
  table: {
5055
5891
  createTable: (variables: CreateTableVariables, signal?: AbortSignal | undefined) => Promise<CreateTableResponse>;
@@ -5063,15 +5899,30 @@ declare const operationsByTag: {
5063
5899
  updateColumn: (variables: UpdateColumnVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
5064
5900
  deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
5065
5901
  };
5902
+ files: {
5903
+ getFileItem: (variables: GetFileItemVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
5904
+ putFileItem: (variables: PutFileItemVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
5905
+ deleteFileItem: (variables: DeleteFileItemVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
5906
+ getFile: (variables: GetFileVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
5907
+ putFile: (variables: PutFileVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
5908
+ deleteFile: (variables: DeleteFileVariables, signal?: AbortSignal | undefined) => Promise<FileResponse>;
5909
+ fileAccess: (variables: FileAccessVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
5910
+ };
5066
5911
  searchAndFilter: {
5067
5912
  queryTable: (variables: QueryTableVariables, signal?: AbortSignal | undefined) => Promise<QueryResponse>;
5068
5913
  searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
5069
5914
  searchTable: (variables: SearchTableVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
5915
+ sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal | undefined) => Promise<SQLResponse>;
5070
5916
  vectorSearchTable: (variables: VectorSearchTableVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
5071
5917
  askTable: (variables: AskTableVariables, signal?: AbortSignal | undefined) => Promise<AskTableResponse>;
5918
+ askTableSession: (variables: AskTableSessionVariables, signal?: AbortSignal | undefined) => Promise<AskTableSessionResponse>;
5072
5919
  summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal | undefined) => Promise<SummarizeResponse>;
5073
5920
  aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal | undefined) => Promise<AggResponse>;
5074
5921
  };
5922
+ authOther: {
5923
+ grantAuthorizationCode: (variables: GrantAuthorizationCodeVariables, signal?: AbortSignal | undefined) => Promise<GrantAuthorizationCodeResponse>;
5924
+ generateAccessToken: (variables: GenerateAccessTokenVariables, signal?: AbortSignal | undefined) => Promise<AccessTokenOutput>;
5925
+ };
5075
5926
  users: {
5076
5927
  getUser: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<UserWithID>;
5077
5928
  updateUser: (variables: UpdateUserVariables, signal?: AbortSignal | undefined) => Promise<UserWithID>;
@@ -5105,6 +5956,7 @@ declare const operationsByTag: {
5105
5956
  deleteDatabase: (variables: DeleteDatabaseVariables, signal?: AbortSignal | undefined) => Promise<DeleteDatabaseResponse>;
5106
5957
  getDatabaseMetadata: (variables: GetDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
5107
5958
  updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
5959
+ renameDatabase: (variables: RenameDatabaseVariables, signal?: AbortSignal | undefined) => Promise<DatabaseMetadata>;
5108
5960
  getDatabaseGithubSettings: (variables: GetDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<DatabaseGithubSettings>;
5109
5961
  updateDatabaseGithubSettings: (variables: UpdateDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<DatabaseGithubSettings>;
5110
5962
  deleteDatabaseGithubSettings: (variables: DeleteDatabaseGithubSettingsVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
@@ -5112,7 +5964,7 @@ declare const operationsByTag: {
5112
5964
  };
5113
5965
  };
5114
5966
 
5115
- type HostAliases = 'production' | 'staging';
5967
+ type HostAliases = 'production' | 'staging' | 'dev';
5116
5968
  type ProviderBuilder = {
5117
5969
  main: string;
5118
5970
  workspaces: string;
@@ -5122,6 +5974,7 @@ declare function getHostUrl(provider: HostProvider, type: keyof ProviderBuilder)
5122
5974
  declare function isHostProviderAlias(alias: HostProvider | string): alias is HostAliases;
5123
5975
  declare function isHostProviderBuilder(builder: HostProvider): builder is ProviderBuilder;
5124
5976
  declare function parseProviderString(provider?: string): HostProvider | null;
5977
+ declare function buildProviderString(provider: HostProvider): string;
5125
5978
  declare function parseWorkspacesUrlParts(url: string): {
5126
5979
  workspace: string;
5127
5980
  region: string;
@@ -5133,13 +5986,16 @@ type responses_BadRequestError = BadRequestError;
5133
5986
  type responses_BranchMigrationPlan = BranchMigrationPlan;
5134
5987
  type responses_BulkError = BulkError;
5135
5988
  type responses_BulkInsertResponse = BulkInsertResponse;
5989
+ type responses_PutFileResponse = PutFileResponse;
5136
5990
  type responses_QueryResponse = QueryResponse;
5137
5991
  type responses_RateLimitError = RateLimitError;
5138
5992
  type responses_RecordResponse = RecordResponse;
5139
5993
  type responses_RecordUpdateResponse = RecordUpdateResponse;
5994
+ type responses_SQLResponse = SQLResponse;
5140
5995
  type responses_SchemaCompareResponse = SchemaCompareResponse;
5141
5996
  type responses_SchemaUpdateResponse = SchemaUpdateResponse;
5142
5997
  type responses_SearchResponse = SearchResponse;
5998
+ type responses_ServiceUnavailableError = ServiceUnavailableError;
5143
5999
  type responses_SimpleError = SimpleError;
5144
6000
  type responses_SummarizeResponse = SummarizeResponse;
5145
6001
  declare namespace responses {
@@ -5150,28 +6006,38 @@ declare namespace responses {
5150
6006
  responses_BranchMigrationPlan as BranchMigrationPlan,
5151
6007
  responses_BulkError as BulkError,
5152
6008
  responses_BulkInsertResponse as BulkInsertResponse,
6009
+ responses_PutFileResponse as PutFileResponse,
5153
6010
  responses_QueryResponse as QueryResponse,
5154
6011
  responses_RateLimitError as RateLimitError,
5155
6012
  responses_RecordResponse as RecordResponse,
5156
6013
  responses_RecordUpdateResponse as RecordUpdateResponse,
6014
+ responses_SQLResponse as SQLResponse,
5157
6015
  responses_SchemaCompareResponse as SchemaCompareResponse,
5158
6016
  responses_SchemaUpdateResponse as SchemaUpdateResponse,
5159
6017
  responses_SearchResponse as SearchResponse,
6018
+ responses_ServiceUnavailableError as ServiceUnavailableError,
5160
6019
  responses_SimpleError as SimpleError,
5161
6020
  responses_SummarizeResponse as SummarizeResponse,
5162
6021
  };
5163
6022
  }
5164
6023
 
5165
6024
  type schemas_APIKeyName = APIKeyName;
6025
+ type schemas_AccessToken = AccessToken;
6026
+ type schemas_AccessTokenInput = AccessTokenInput;
6027
+ type schemas_AccessTokenOutput = AccessTokenOutput;
5166
6028
  type schemas_AggExpression = AggExpression;
5167
6029
  type schemas_AggExpressionMap = AggExpressionMap;
6030
+ type schemas_AuthorizationCode = AuthorizationCode;
5168
6031
  type schemas_AverageAgg = AverageAgg;
5169
6032
  type schemas_BoosterExpression = BoosterExpression;
5170
6033
  type schemas_Branch = Branch;
5171
6034
  type schemas_BranchMetadata = BranchMetadata;
5172
6035
  type schemas_BranchMigration = BranchMigration;
5173
6036
  type schemas_BranchName = BranchName;
6037
+ type schemas_BranchOp = BranchOp;
6038
+ type schemas_BranchWithCopyID = BranchWithCopyID;
5174
6039
  type schemas_Column = Column;
6040
+ type schemas_ColumnFile = ColumnFile;
5175
6041
  type schemas_ColumnLink = ColumnLink;
5176
6042
  type schemas_ColumnMigration = ColumnMigration;
5177
6043
  type schemas_ColumnName = ColumnName;
@@ -5190,6 +6056,11 @@ type schemas_DatabaseGithubSettings = DatabaseGithubSettings;
5190
6056
  type schemas_DatabaseMetadata = DatabaseMetadata;
5191
6057
  type schemas_DateHistogramAgg = DateHistogramAgg;
5192
6058
  type schemas_DateTime = DateTime;
6059
+ type schemas_FileAccessID = FileAccessID;
6060
+ type schemas_FileItemID = FileItemID;
6061
+ type schemas_FileName = FileName;
6062
+ type schemas_FileResponse = FileResponse;
6063
+ type schemas_FileSignature = FileSignature;
5193
6064
  type schemas_FilterColumn = FilterColumn;
5194
6065
  type schemas_FilterColumnIncludes = FilterColumnIncludes;
5195
6066
  type schemas_FilterExpression = FilterExpression;
@@ -5201,6 +6072,7 @@ type schemas_FilterRangeValue = FilterRangeValue;
5201
6072
  type schemas_FilterValue = FilterValue;
5202
6073
  type schemas_FuzzinessExpression = FuzzinessExpression;
5203
6074
  type schemas_HighlightExpression = HighlightExpression;
6075
+ type schemas_InputFile = InputFile;
5204
6076
  type schemas_InputFileArray = InputFileArray;
5205
6077
  type schemas_InputFileEntry = InputFileEntry;
5206
6078
  type schemas_InviteID = InviteID;
@@ -5210,10 +6082,12 @@ type schemas_ListDatabasesResponse = ListDatabasesResponse;
5210
6082
  type schemas_ListGitBranchesResponse = ListGitBranchesResponse;
5211
6083
  type schemas_ListRegionsResponse = ListRegionsResponse;
5212
6084
  type schemas_MaxAgg = MaxAgg;
6085
+ type schemas_MediaType = MediaType;
5213
6086
  type schemas_MetricsDatapoint = MetricsDatapoint;
5214
6087
  type schemas_MetricsLatency = MetricsLatency;
5215
6088
  type schemas_Migration = Migration;
5216
6089
  type schemas_MigrationColumnOp = MigrationColumnOp;
6090
+ type schemas_MigrationObject = MigrationObject;
5217
6091
  type schemas_MigrationOp = MigrationOp;
5218
6092
  type schemas_MigrationRequest = MigrationRequest;
5219
6093
  type schemas_MigrationRequestNumber = MigrationRequestNumber;
@@ -5224,12 +6098,15 @@ type schemas_NumericHistogramAgg = NumericHistogramAgg;
5224
6098
  type schemas_ObjectValue = ObjectValue;
5225
6099
  type schemas_PageConfig = PageConfig;
5226
6100
  type schemas_PrefixExpression = PrefixExpression;
6101
+ type schemas_ProjectionConfig = ProjectionConfig;
6102
+ type schemas_QueryColumnsProjection = QueryColumnsProjection;
5227
6103
  type schemas_RecordID = RecordID;
5228
6104
  type schemas_RecordMeta = RecordMeta;
5229
6105
  type schemas_RecordsMetadata = RecordsMetadata;
5230
6106
  type schemas_Region = Region;
5231
6107
  type schemas_RevLink = RevLink;
5232
6108
  type schemas_Role = Role;
6109
+ type schemas_SQLRecord = SQLRecord;
5233
6110
  type schemas_Schema = Schema;
5234
6111
  type schemas_SchemaEditScript = SchemaEditScript;
5235
6112
  type schemas_SearchPageConfig = SearchPageConfig;
@@ -5251,9 +6128,11 @@ type schemas_TopValuesAgg = TopValuesAgg;
5251
6128
  type schemas_TransactionDeleteOp = TransactionDeleteOp;
5252
6129
  type schemas_TransactionError = TransactionError;
5253
6130
  type schemas_TransactionFailure = TransactionFailure;
6131
+ type schemas_TransactionGetOp = TransactionGetOp;
5254
6132
  type schemas_TransactionInsertOp = TransactionInsertOp;
5255
6133
  type schemas_TransactionResultColumns = TransactionResultColumns;
5256
6134
  type schemas_TransactionResultDelete = TransactionResultDelete;
6135
+ type schemas_TransactionResultGet = TransactionResultGet;
5257
6136
  type schemas_TransactionResultInsert = TransactionResultInsert;
5258
6137
  type schemas_TransactionResultUpdate = TransactionResultUpdate;
5259
6138
  type schemas_TransactionSuccess = TransactionSuccess;
@@ -5271,16 +6150,23 @@ type schemas_WorkspaceMeta = WorkspaceMeta;
5271
6150
  declare namespace schemas {
5272
6151
  export {
5273
6152
  schemas_APIKeyName as APIKeyName,
6153
+ schemas_AccessToken as AccessToken,
6154
+ schemas_AccessTokenInput as AccessTokenInput,
6155
+ schemas_AccessTokenOutput as AccessTokenOutput,
5274
6156
  schemas_AggExpression as AggExpression,
5275
6157
  schemas_AggExpressionMap as AggExpressionMap,
5276
6158
  AggResponse$1 as AggResponse,
6159
+ schemas_AuthorizationCode as AuthorizationCode,
5277
6160
  schemas_AverageAgg as AverageAgg,
5278
6161
  schemas_BoosterExpression as BoosterExpression,
5279
6162
  schemas_Branch as Branch,
5280
6163
  schemas_BranchMetadata as BranchMetadata,
5281
6164
  schemas_BranchMigration as BranchMigration,
5282
6165
  schemas_BranchName as BranchName,
6166
+ schemas_BranchOp as BranchOp,
6167
+ schemas_BranchWithCopyID as BranchWithCopyID,
5283
6168
  schemas_Column as Column,
6169
+ schemas_ColumnFile as ColumnFile,
5284
6170
  schemas_ColumnLink as ColumnLink,
5285
6171
  schemas_ColumnMigration as ColumnMigration,
5286
6172
  schemas_ColumnName as ColumnName,
@@ -5300,6 +6186,11 @@ declare namespace schemas {
5300
6186
  DateBooster$1 as DateBooster,
5301
6187
  schemas_DateHistogramAgg as DateHistogramAgg,
5302
6188
  schemas_DateTime as DateTime,
6189
+ schemas_FileAccessID as FileAccessID,
6190
+ schemas_FileItemID as FileItemID,
6191
+ schemas_FileName as FileName,
6192
+ schemas_FileResponse as FileResponse,
6193
+ schemas_FileSignature as FileSignature,
5303
6194
  schemas_FilterColumn as FilterColumn,
5304
6195
  schemas_FilterColumnIncludes as FilterColumnIncludes,
5305
6196
  schemas_FilterExpression as FilterExpression,
@@ -5311,6 +6202,7 @@ declare namespace schemas {
5311
6202
  schemas_FilterValue as FilterValue,
5312
6203
  schemas_FuzzinessExpression as FuzzinessExpression,
5313
6204
  schemas_HighlightExpression as HighlightExpression,
6205
+ schemas_InputFile as InputFile,
5314
6206
  schemas_InputFileArray as InputFileArray,
5315
6207
  schemas_InputFileEntry as InputFileEntry,
5316
6208
  schemas_InviteID as InviteID,
@@ -5320,10 +6212,12 @@ declare namespace schemas {
5320
6212
  schemas_ListGitBranchesResponse as ListGitBranchesResponse,
5321
6213
  schemas_ListRegionsResponse as ListRegionsResponse,
5322
6214
  schemas_MaxAgg as MaxAgg,
6215
+ schemas_MediaType as MediaType,
5323
6216
  schemas_MetricsDatapoint as MetricsDatapoint,
5324
6217
  schemas_MetricsLatency as MetricsLatency,
5325
6218
  schemas_Migration as Migration,
5326
6219
  schemas_MigrationColumnOp as MigrationColumnOp,
6220
+ schemas_MigrationObject as MigrationObject,
5327
6221
  schemas_MigrationOp as MigrationOp,
5328
6222
  schemas_MigrationRequest as MigrationRequest,
5329
6223
  schemas_MigrationRequestNumber as MigrationRequestNumber,
@@ -5335,12 +6229,15 @@ declare namespace schemas {
5335
6229
  schemas_ObjectValue as ObjectValue,
5336
6230
  schemas_PageConfig as PageConfig,
5337
6231
  schemas_PrefixExpression as PrefixExpression,
6232
+ schemas_ProjectionConfig as ProjectionConfig,
6233
+ schemas_QueryColumnsProjection as QueryColumnsProjection,
5338
6234
  schemas_RecordID as RecordID,
5339
6235
  schemas_RecordMeta as RecordMeta,
5340
6236
  schemas_RecordsMetadata as RecordsMetadata,
5341
6237
  schemas_Region as Region,
5342
6238
  schemas_RevLink as RevLink,
5343
6239
  schemas_Role as Role,
6240
+ schemas_SQLRecord as SQLRecord,
5344
6241
  schemas_Schema as Schema,
5345
6242
  schemas_SchemaEditScript as SchemaEditScript,
5346
6243
  schemas_SearchPageConfig as SearchPageConfig,
@@ -5362,10 +6259,12 @@ declare namespace schemas {
5362
6259
  schemas_TransactionDeleteOp as TransactionDeleteOp,
5363
6260
  schemas_TransactionError as TransactionError,
5364
6261
  schemas_TransactionFailure as TransactionFailure,
6262
+ schemas_TransactionGetOp as TransactionGetOp,
5365
6263
  schemas_TransactionInsertOp as TransactionInsertOp,
5366
6264
  TransactionOperation$1 as TransactionOperation,
5367
6265
  schemas_TransactionResultColumns as TransactionResultColumns,
5368
6266
  schemas_TransactionResultDelete as TransactionResultDelete,
6267
+ schemas_TransactionResultGet as TransactionResultGet,
5369
6268
  schemas_TransactionResultInsert as TransactionResultInsert,
5370
6269
  schemas_TransactionResultUpdate as TransactionResultUpdate,
5371
6270
  schemas_TransactionSuccess as TransactionSuccess,
@@ -5407,6 +6306,7 @@ declare class XataApiClient {
5407
6306
  get migrationRequests(): MigrationRequestsApi;
5408
6307
  get tables(): TableApi;
5409
6308
  get records(): RecordsApi;
6309
+ get files(): FilesApi;
5410
6310
  get searchAndFilter(): SearchAndFilterApi;
5411
6311
  }
5412
6312
  declare class UserApi {
@@ -5513,6 +6413,14 @@ declare class BranchApi {
5513
6413
  database: DBName;
5514
6414
  branch: BranchName;
5515
6415
  }): Promise<DeleteBranchResponse>;
6416
+ copyBranch({ workspace, region, database, branch, destinationBranch, limit }: {
6417
+ workspace: WorkspaceID;
6418
+ region: string;
6419
+ database: DBName;
6420
+ branch: BranchName;
6421
+ destinationBranch: BranchName;
6422
+ limit?: number;
6423
+ }): Promise<BranchWithCopyID>;
5516
6424
  updateBranchMetadata({ workspace, region, database, branch, metadata }: {
5517
6425
  workspace: WorkspaceID;
5518
6426
  region: string;
@@ -5720,6 +6628,75 @@ declare class RecordsApi {
5720
6628
  operations: TransactionOperation$1[];
5721
6629
  }): Promise<TransactionSuccess>;
5722
6630
  }
6631
+ declare class FilesApi {
6632
+ private extraProps;
6633
+ constructor(extraProps: ApiExtraProps);
6634
+ getFileItem({ workspace, region, database, branch, table, record, column, fileId }: {
6635
+ workspace: WorkspaceID;
6636
+ region: string;
6637
+ database: DBName;
6638
+ branch: BranchName;
6639
+ table: TableName;
6640
+ record: RecordID;
6641
+ column: ColumnName;
6642
+ fileId: string;
6643
+ }): Promise<any>;
6644
+ putFileItem({ workspace, region, database, branch, table, record, column, fileId, file }: {
6645
+ workspace: WorkspaceID;
6646
+ region: string;
6647
+ database: DBName;
6648
+ branch: BranchName;
6649
+ table: TableName;
6650
+ record: RecordID;
6651
+ column: ColumnName;
6652
+ fileId: string;
6653
+ file: any;
6654
+ }): Promise<PutFileResponse>;
6655
+ deleteFileItem({ workspace, region, database, branch, table, record, column, fileId }: {
6656
+ workspace: WorkspaceID;
6657
+ region: string;
6658
+ database: DBName;
6659
+ branch: BranchName;
6660
+ table: TableName;
6661
+ record: RecordID;
6662
+ column: ColumnName;
6663
+ fileId: string;
6664
+ }): Promise<PutFileResponse>;
6665
+ getFile({ workspace, region, database, branch, table, record, column }: {
6666
+ workspace: WorkspaceID;
6667
+ region: string;
6668
+ database: DBName;
6669
+ branch: BranchName;
6670
+ table: TableName;
6671
+ record: RecordID;
6672
+ column: ColumnName;
6673
+ }): Promise<any>;
6674
+ putFile({ workspace, region, database, branch, table, record, column, file }: {
6675
+ workspace: WorkspaceID;
6676
+ region: string;
6677
+ database: DBName;
6678
+ branch: BranchName;
6679
+ table: TableName;
6680
+ record: RecordID;
6681
+ column: ColumnName;
6682
+ file: Blob;
6683
+ }): Promise<PutFileResponse>;
6684
+ deleteFile({ workspace, region, database, branch, table, record, column }: {
6685
+ workspace: WorkspaceID;
6686
+ region: string;
6687
+ database: DBName;
6688
+ branch: BranchName;
6689
+ table: TableName;
6690
+ record: RecordID;
6691
+ column: ColumnName;
6692
+ }): Promise<PutFileResponse>;
6693
+ fileAccess({ workspace, region, fileId, verify }: {
6694
+ workspace: WorkspaceID;
6695
+ region: string;
6696
+ fileId: string;
6697
+ verify?: FileSignature;
6698
+ }): Promise<any>;
6699
+ }
5723
6700
  declare class SearchAndFilterApi {
5724
6701
  private extraProps;
5725
6702
  constructor(extraProps: ApiExtraProps);
@@ -5777,20 +6754,23 @@ declare class SearchAndFilterApi {
5777
6754
  size?: number;
5778
6755
  filter?: FilterExpression;
5779
6756
  }): Promise<SearchResponse>;
5780
- askTable({ workspace, region, database, branch, table, question, fuzziness, target, prefix, filter, boosters, rules }: {
6757
+ askTable({ workspace, region, database, branch, table, options }: {
5781
6758
  workspace: WorkspaceID;
5782
6759
  region: string;
5783
6760
  database: DBName;
5784
6761
  branch: BranchName;
5785
6762
  table: TableName;
5786
- question: string;
5787
- fuzziness?: FuzzinessExpression;
5788
- target?: TargetExpression;
5789
- prefix?: PrefixExpression;
5790
- filter?: FilterExpression;
5791
- boosters?: BoosterExpression[];
5792
- rules?: string[];
6763
+ options: AskTableRequestBody;
5793
6764
  }): Promise<AskTableResponse>;
6765
+ askTableSession({ workspace, region, database, branch, table, sessionId, message }: {
6766
+ workspace: WorkspaceID;
6767
+ region: string;
6768
+ database: DBName;
6769
+ branch: BranchName;
6770
+ table: TableName;
6771
+ sessionId: string;
6772
+ message: string;
6773
+ }): Promise<AskTableSessionResponse>;
5794
6774
  summarizeTable({ workspace, region, database, branch, table, filter, columns, summaries, sort, summariesFilter, page, consistency }: {
5795
6775
  workspace: WorkspaceID;
5796
6776
  region: string;
@@ -5876,7 +6856,7 @@ declare class MigrationRequestsApi {
5876
6856
  region: string;
5877
6857
  database: DBName;
5878
6858
  migrationRequest: MigrationRequestNumber;
5879
- }): Promise<Commit>;
6859
+ }): Promise<BranchOp>;
5880
6860
  }
5881
6861
  declare class MigrationsApi {
5882
6862
  private extraProps;
@@ -5955,6 +6935,13 @@ declare class MigrationsApi {
5955
6935
  branch: BranchName;
5956
6936
  edits: SchemaEditScript;
5957
6937
  }): Promise<SchemaUpdateResponse>;
6938
+ pushBranchMigrations({ workspace, region, database, branch, migrations }: {
6939
+ workspace: WorkspaceID;
6940
+ region: string;
6941
+ database: DBName;
6942
+ branch: BranchName;
6943
+ migrations: MigrationObject[];
6944
+ }): Promise<SchemaUpdateResponse>;
5958
6945
  }
5959
6946
  declare class DatabaseApi {
5960
6947
  private extraProps;
@@ -5962,10 +6949,11 @@ declare class DatabaseApi {
5962
6949
  getDatabaseList({ workspace }: {
5963
6950
  workspace: WorkspaceID;
5964
6951
  }): Promise<ListDatabasesResponse>;
5965
- createDatabase({ workspace, database, data }: {
6952
+ createDatabase({ workspace, database, data, headers }: {
5966
6953
  workspace: WorkspaceID;
5967
6954
  database: DBName;
5968
6955
  data: CreateDatabaseRequestBody;
6956
+ headers?: Record<string, string>;
5969
6957
  }): Promise<CreateDatabaseResponse>;
5970
6958
  deleteDatabase({ workspace, database }: {
5971
6959
  workspace: WorkspaceID;
@@ -5980,6 +6968,11 @@ declare class DatabaseApi {
5980
6968
  database: DBName;
5981
6969
  metadata: DatabaseMetadata;
5982
6970
  }): Promise<DatabaseMetadata>;
6971
+ renameDatabase({ workspace, database, newName }: {
6972
+ workspace: WorkspaceID;
6973
+ database: DBName;
6974
+ newName: DBName;
6975
+ }): Promise<DatabaseMetadata>;
5983
6976
  getDatabaseGithubSettings({ workspace, database }: {
5984
6977
  workspace: WorkspaceID;
5985
6978
  database: DBName;
@@ -6035,7 +7028,227 @@ type Narrowable = string | number | bigint | boolean;
6035
7028
  type Try<A1, A2, Catch = never> = A1 extends A2 ? A1 : Catch;
6036
7029
  type Narrow<A> = Try<A, [], NarrowRaw<A>>;
6037
7030
 
6038
- type SelectableColumn<O, RecursivePath extends any[] = []> = '*' | 'id' | DataProps<O> | NestedColumns<O, RecursivePath>;
7031
+ interface ImageTransformations {
7032
+ /**
7033
+ * Whether to preserve animation frames from input files. Default is true.
7034
+ * Setting it to false reduces animations to still images. This setting is
7035
+ * recommended when enlarging images or processing arbitrary user content,
7036
+ * because large GIF animations can weigh tens or even hundreds of megabytes.
7037
+ * It is also useful to set anim:false when using format:"json" to get the
7038
+ * response quicker without the number of frames.
7039
+ */
7040
+ anim?: boolean;
7041
+ /**
7042
+ * Background color to add underneath the image. Applies only to images with
7043
+ * transparency (such as PNG). Accepts any CSS color (#RRGGBB, rgba(…),
7044
+ * hsl(…), etc.)
7045
+ */
7046
+ background?: string;
7047
+ /**
7048
+ * Radius of a blur filter (approximate gaussian). Maximum supported radius
7049
+ * is 250.
7050
+ */
7051
+ blur?: number;
7052
+ /**
7053
+ * Increase brightness by a factor. A value of 1.0 equals no change, a value
7054
+ * of 0.5 equals half brightness, and a value of 2.0 equals twice as bright.
7055
+ * 0 is ignored.
7056
+ */
7057
+ brightness?: number;
7058
+ /**
7059
+ * Slightly reduces latency on a cache miss by selecting a
7060
+ * quickest-to-compress file format, at a cost of increased file size and
7061
+ * lower image quality. It will usually override the format option and choose
7062
+ * JPEG over WebP or AVIF. We do not recommend using this option, except in
7063
+ * unusual circumstances like resizing uncacheable dynamically-generated
7064
+ * images.
7065
+ */
7066
+ compression?: 'fast';
7067
+ /**
7068
+ * Increase contrast by a factor. A value of 1.0 equals no change, a value of
7069
+ * 0.5 equals low contrast, and a value of 2.0 equals high contrast. 0 is
7070
+ * ignored.
7071
+ */
7072
+ contrast?: number;
7073
+ /**
7074
+ * Device Pixel Ratio. Default 1. Multiplier for width/height that makes it
7075
+ * easier to specify higher-DPI sizes in <img srcset>.
7076
+ */
7077
+ dpr?: number;
7078
+ /**
7079
+ * Resizing mode as a string. It affects interpretation of width and height
7080
+ * options:
7081
+ * - scale-down: Similar to contain, but the image is never enlarged. If
7082
+ * the image is larger than given width or height, it will be resized.
7083
+ * Otherwise its original size will be kept.
7084
+ * - contain: Resizes to maximum size that fits within the given width and
7085
+ * height. If only a single dimension is given (e.g. only width), the
7086
+ * image will be shrunk or enlarged to exactly match that dimension.
7087
+ * Aspect ratio is always preserved.
7088
+ * - cover: Resizes (shrinks or enlarges) to fill the entire area of width
7089
+ * and height. If the image has an aspect ratio different from the ratio
7090
+ * of width and height, it will be cropped to fit.
7091
+ * - crop: The image will be shrunk and cropped to fit within the area
7092
+ * specified by width and height. The image will not be enlarged. For images
7093
+ * smaller than the given dimensions it's the same as scale-down. For
7094
+ * images larger than the given dimensions, it's the same as cover.
7095
+ * See also trim.
7096
+ * - pad: Resizes to the maximum size that fits within the given width and
7097
+ * height, and then fills the remaining area with a background color
7098
+ * (white by default). Use of this mode is not recommended, as the same
7099
+ * effect can be more efficiently achieved with the contain mode and the
7100
+ * CSS object-fit: contain property.
7101
+ */
7102
+ fit?: 'scale-down' | 'contain' | 'cover' | 'crop' | 'pad';
7103
+ /**
7104
+ * Output format to generate. It can be:
7105
+ * - avif: generate images in AVIF format.
7106
+ * - webp: generate images in Google WebP format. Set quality to 100 to get
7107
+ * the WebP-lossless format.
7108
+ * - json: instead of generating an image, outputs information about the
7109
+ * image, in JSON format. The JSON object will contain image size
7110
+ * (before and after resizing), source image’s MIME type, file size, etc.
7111
+ * - jpeg: generate images in JPEG format.
7112
+ * - png: generate images in PNG format.
7113
+ */
7114
+ format?: 'auto' | 'avif' | 'webp' | 'json' | 'jpeg' | 'png';
7115
+ /**
7116
+ * Increase exposure by a factor. A value of 1.0 equals no change, a value of
7117
+ * 0.5 darkens the image, and a value of 2.0 lightens the image. 0 is ignored.
7118
+ */
7119
+ gamma?: number;
7120
+ /**
7121
+ * When cropping with fit: "cover", this defines the side or point that should
7122
+ * be left uncropped. The value is either a string
7123
+ * "left", "right", "top", "bottom", "auto", or "center" (the default),
7124
+ * or an object {x, y} containing focal point coordinates in the original
7125
+ * image expressed as fractions ranging from 0.0 (top or left) to 1.0
7126
+ * (bottom or right), 0.5 being the center. {fit: "cover", gravity: "top"} will
7127
+ * crop bottom or left and right sides as necessary, but won’t crop anything
7128
+ * from the top. {fit: "cover", gravity: {x:0.5, y:0.2}} will crop each side to
7129
+ * preserve as much as possible around a point at 20% of the height of the
7130
+ * source image.
7131
+ */
7132
+ gravity?: 'left' | 'right' | 'top' | 'bottom' | 'center' | 'auto' | {
7133
+ x: number;
7134
+ y: number;
7135
+ };
7136
+ /**
7137
+ * Maximum height in image pixels. The value must be an integer.
7138
+ */
7139
+ height?: number;
7140
+ /**
7141
+ * What EXIF data should be preserved in the output image. Note that EXIF
7142
+ * rotation and embedded color profiles are always applied ("baked in" into
7143
+ * the image), and aren't affected by this option. Note that if the Polish
7144
+ * feature is enabled, all metadata may have been removed already and this
7145
+ * option may have no effect.
7146
+ * - keep: Preserve most of EXIF metadata, including GPS location if there's
7147
+ * any.
7148
+ * - copyright: Only keep the copyright tag, and discard everything else.
7149
+ * This is the default behavior for JPEG files.
7150
+ * - none: Discard all invisible EXIF metadata. Currently WebP and PNG
7151
+ * output formats always discard metadata.
7152
+ */
7153
+ metadata?: 'keep' | 'copyright' | 'none';
7154
+ /**
7155
+ * Quality setting from 1-100 (useful values are in 60-90 range). Lower values
7156
+ * make images look worse, but load faster. The default is 85. It applies only
7157
+ * to JPEG and WebP images. It doesn’t have any effect on PNG.
7158
+ */
7159
+ quality?: number;
7160
+ /**
7161
+ * Number of degrees (90, 180, 270) to rotate the image by. width and height
7162
+ * options refer to axes after rotation.
7163
+ */
7164
+ rotate?: 0 | 90 | 180 | 270 | 360;
7165
+ /**
7166
+ * Strength of sharpening filter to apply to the image. Floating-point
7167
+ * number between 0 (no sharpening, default) and 10 (maximum). 1.0 is a
7168
+ * recommended value for downscaled images.
7169
+ */
7170
+ sharpen?: number;
7171
+ /**
7172
+ * An object with four properties {left, top, right, bottom} that specify
7173
+ * a number of pixels to cut off on each side. Allows removal of borders
7174
+ * or cutting out a specific fragment of an image. Trimming is performed
7175
+ * before resizing or rotation. Takes dpr into account.
7176
+ */
7177
+ trim?: {
7178
+ left?: number;
7179
+ top?: number;
7180
+ right?: number;
7181
+ bottom?: number;
7182
+ };
7183
+ /**
7184
+ * Maximum width in image pixels. The value must be an integer.
7185
+ */
7186
+ width?: number;
7187
+ }
7188
+
7189
+ type XataFileEditableFields = Partial<Pick<XataArrayFile, keyof InputFileEntry>>;
7190
+ declare class XataFile {
7191
+ /**
7192
+ * Name of this file.
7193
+ */
7194
+ name?: string;
7195
+ /**
7196
+ * Media type of this file.
7197
+ */
7198
+ mediaType: string;
7199
+ /**
7200
+ * Base64 encoded content of this file.
7201
+ */
7202
+ base64Content?: string;
7203
+ /**
7204
+ * Whether to enable public url for this file.
7205
+ */
7206
+ enablePublicUrl?: boolean;
7207
+ /**
7208
+ * Timeout for the signed url.
7209
+ */
7210
+ signedUrlTimeout?: number;
7211
+ /**
7212
+ * Size of this file.
7213
+ */
7214
+ size?: number;
7215
+ /**
7216
+ * Version of this file.
7217
+ */
7218
+ version?: number;
7219
+ /**
7220
+ * Url of this file.
7221
+ */
7222
+ url?: string;
7223
+ /**
7224
+ * Signed url of this file.
7225
+ */
7226
+ signedUrl?: string;
7227
+ /**
7228
+ * Attributes of this file.
7229
+ */
7230
+ attributes?: Record<string, unknown>;
7231
+ constructor(file: Partial<XataFile>);
7232
+ static fromBuffer(buffer: Buffer, options?: XataFileEditableFields): XataFile;
7233
+ toBuffer(): Buffer;
7234
+ static fromArrayBuffer(arrayBuffer: ArrayBuffer, options?: XataFileEditableFields): XataFile;
7235
+ toArrayBuffer(): ArrayBuffer;
7236
+ static fromUint8Array(uint8Array: Uint8Array, options?: XataFileEditableFields): XataFile;
7237
+ toUint8Array(): Uint8Array;
7238
+ static fromBlob(file: Blob, options?: XataFileEditableFields): Promise<XataFile>;
7239
+ toBlob(): Blob;
7240
+ static fromString(string: string, options?: XataFileEditableFields): XataFile;
7241
+ toString(): string;
7242
+ static fromBase64(base64Content: string, options?: XataFileEditableFields): XataFile;
7243
+ toBase64(): string;
7244
+ transform(...options: ImageTransformations[]): {
7245
+ url: string | undefined;
7246
+ signedUrl: string | undefined;
7247
+ };
7248
+ }
7249
+ type XataArrayFile = Identifiable & XataFile;
7250
+
7251
+ type SelectableColumn<O, RecursivePath extends any[] = []> = '*' | 'id' | `xata.${'version' | 'createdAt' | 'updatedAt'}` | DataProps<O> | NestedColumns<O, RecursivePath>;
6039
7252
  type WildcardColumns<O> = Values<{
6040
7253
  [K in SelectableColumn<O>]: K extends `${string}*` ? K : never;
6041
7254
  }>;
@@ -6045,18 +7258,17 @@ type ColumnsByValue<O, Value> = Values<{
6045
7258
  type SelectedPick<O extends XataRecord, Key extends SelectableColumn<O>[]> = XataRecord<O> & UnionToIntersection<Values<{
6046
7259
  [K in Key[number]]: NestedValueAtColumn<O, K> & XataRecord<O>;
6047
7260
  }>>;
6048
- type ValueAtColumn<O, P extends SelectableColumn<O>> = P extends '*' ? Values<O> : P extends 'id' ? string : P extends keyof O ? O[P] : P extends `${infer K}.${infer V}` ? K extends keyof O ? Values<NonNullable<O[K]> extends infer Item ? Item extends Record<string, any> ? V extends SelectableColumn<Item> ? {
7261
+ 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
7262
  V: ValueAtColumn<Item, V>;
6050
- } : never : O[K] : never> : never : never;
7263
+ } : never : Object[K] : never> : never : never;
6051
7264
  type MAX_RECURSION = 2;
6052
7265
  type NestedColumns<O, RecursivePath extends any[]> = RecursivePath['length'] extends MAX_RECURSION ? never : If<IsObject<O>, Values<{
6053
- [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
6054
- If<IsObject<Item>, Item extends XataRecord ? SelectableColumn<Item, [...RecursivePath, Item]> extends infer Column ? Column extends string ? K | `${K}.${Column}` : never : never : Item extends Date ? K : `${K}.${StringKeys<Item> | '*'}`, // This allows usage of objects that are not links
7266
+ [K in DataProps<O>]: NonNullable<O[K]> extends infer Item ? If<IsArray<Item>, Item extends (infer Type)[] ? Type extends XataArrayFile ? K | `${K}.${keyof XataFileEditableFields | '*'}` : K | `${K}.${StringKeys<Type> | '*'}` : never, If<IsObject<Item>, Item extends XataRecord ? SelectableColumn<Item, [...RecursivePath, Item]> extends infer Column ? Column extends string ? K | `${K}.${Column}` : never : never : Item extends Date ? K : Item extends XataFile ? K | `${K}.${keyof XataFileEditableFields | '*'}` : `${K}.${StringKeys<Item> | '*'}`, // This allows usage of objects that are not links
6055
7267
  K>> : never;
6056
7268
  }>, never>;
6057
7269
  type DataProps<O> = Exclude<StringKeys<O>, StringKeys<XataRecord>>;
6058
7270
  type NestedValueAtColumn<O, Key extends SelectableColumn<O>> = Key extends `${infer N}.${infer M}` ? N extends DataProps<O> ? {
6059
- [K in N]: M extends SelectableColumn<NonNullable<O[K]>> ? NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M> & XataRecord> : ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M>> : unknown;
7271
+ [K in N]: M extends SelectableColumn<NonNullable<O[K]>> ? NonNullable<O[K]> extends XataFile ? ForwardNullable<O[K], XataFile> : NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M> & XataRecord> : ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M>> : NonNullable<O[K]> extends (infer ArrayType)[] ? ArrayType extends XataArrayFile ? ForwardNullable<O[K], XataArrayFile[]> : M extends SelectableColumn<NonNullable<ArrayType>> ? ForwardNullable<O[K], NestedValueAtColumn<NonNullable<ArrayType>, M>[]> : unknown : unknown;
6060
7272
  } : unknown : Key extends DataProps<O> ? {
6061
7273
  [K in Key]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], SelectedPick<NonNullable<O[K]>, ['*']>> : O[K];
6062
7274
  } : Key extends '*' ? {
@@ -6064,6 +7276,8 @@ type NestedValueAtColumn<O, Key extends SelectableColumn<O>> = Key extends `${in
6064
7276
  } : unknown;
6065
7277
  type ForwardNullable<T, R> = T extends NonNullable<T> ? R : R | null;
6066
7278
 
7279
+ declare const RecordColumnTypes: readonly ["bool", "int", "float", "string", "text", "email", "multiple", "link", "object", "datetime", "vector", "file[]", "file"];
7280
+ type Identifier = string;
6067
7281
  /**
6068
7282
  * Represents an identifiable record from the database.
6069
7283
  */
@@ -6071,7 +7285,7 @@ interface Identifiable {
6071
7285
  /**
6072
7286
  * Unique id of this record.
6073
7287
  */
6074
- id: string;
7288
+ id: Identifier;
6075
7289
  }
6076
7290
  interface BaseData {
6077
7291
  [key: string]: any;
@@ -6080,8 +7294,13 @@ interface BaseData {
6080
7294
  * Represents a persisted record from the database.
6081
7295
  */
6082
7296
  interface XataRecord<OriginalRecord extends XataRecord<any> = XataRecord<any>> extends Identifiable {
7297
+ /**
7298
+ * Metadata of this record.
7299
+ */
7300
+ xata: XataRecordMetadata;
6083
7301
  /**
6084
7302
  * Get metadata of this record.
7303
+ * @deprecated Use `xata` property instead.
6085
7304
  */
6086
7305
  getMetadata(): XataRecordMetadata;
6087
7306
  /**
@@ -6160,23 +7379,60 @@ type XataRecordMetadata = {
6160
7379
  * Number that is increased every time the record is updated.
6161
7380
  */
6162
7381
  version: number;
6163
- warnings?: string[];
7382
+ /**
7383
+ * Timestamp when the record was created.
7384
+ */
7385
+ createdAt: Date;
7386
+ /**
7387
+ * Timestamp when the record was last updated.
7388
+ */
7389
+ updatedAt: Date;
6164
7390
  };
6165
7391
  declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
6166
7392
  declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;
7393
+ type NumericOperator = ExclusiveOr<{
7394
+ $increment?: number;
7395
+ }, ExclusiveOr<{
7396
+ $decrement?: number;
7397
+ }, ExclusiveOr<{
7398
+ $multiply?: number;
7399
+ }, {
7400
+ $divide?: number;
7401
+ }>>>;
7402
+ type InputXataFile = Partial<XataArrayFile> | Promise<Partial<XataArrayFile>>;
6167
7403
  type EditableDataFields<T> = T extends XataRecord ? {
6168
- id: string;
6169
- } | string : NonNullable<T> extends XataRecord ? {
6170
- id: string;
6171
- } | string | null | undefined : T extends Date ? string | Date : NonNullable<T> extends Date ? string | Date | null | undefined : T;
7404
+ id: Identifier;
7405
+ } | Identifier : NonNullable<T> extends XataRecord ? {
7406
+ id: Identifier;
7407
+ } | Identifier | null | undefined : T extends Date ? string | Date : NonNullable<T> extends Date ? string | Date | null | undefined : T extends XataFile ? InputXataFile : T extends XataFile[] ? InputXataFile[] : T extends number ? number | NumericOperator : T;
6172
7408
  type EditableData<O extends XataRecord> = Identifiable & Partial<Omit<{
6173
7409
  [K in keyof O]: EditableDataFields<O[K]>;
6174
7410
  }, keyof XataRecord>>;
6175
7411
  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 JSONData<O> = Identifiable & Partial<Omit<{
7412
+ type JSONDataBase = Identifiable & {
7413
+ /**
7414
+ * Metadata about the record.
7415
+ */
7416
+ xata: {
7417
+ /**
7418
+ * Timestamp when the record was created.
7419
+ */
7420
+ createdAt: string;
7421
+ /**
7422
+ * Timestamp when the record was last updated.
7423
+ */
7424
+ updatedAt: string;
7425
+ /**
7426
+ * Number that is increased every time the record is updated.
7427
+ */
7428
+ version: number;
7429
+ };
7430
+ };
7431
+ type JSONData<O> = JSONDataBase & Partial<Omit<{
6177
7432
  [K in keyof O]: JSONDataFields<O[K]>;
6178
7433
  }, keyof XataRecord>>;
6179
7434
 
7435
+ type FilterColumns<T> = ColumnsByValue<T, any> | `xata.${keyof XataRecordMetadata}`;
6180
7436
  /**
6181
7437
  * PropertyMatchFilter
6182
7438
  * Example:
@@ -6196,7 +7452,7 @@ type JSONData<O> = Identifiable & Partial<Omit<{
6196
7452
  }
6197
7453
  */
6198
7454
  type PropertyAccessFilter<Record> = {
6199
- [key in ColumnsByValue<Record, any>]?: NestedApiFilter<ValueAtColumn<Record, key>> | PropertyFilter<ValueAtColumn<Record, key>>;
7455
+ [key in FilterColumns<Record>]?: NestedApiFilter<ValueAtColumn<Record, key>> | PropertyFilter<ValueAtColumn<Record, key>>;
6200
7456
  };
6201
7457
  type PropertyFilter<T> = T | {
6202
7458
  $is: T;
@@ -6258,7 +7514,7 @@ type AggregatorFilter<T> = {
6258
7514
  * Example: { filter: { $exists: "settings" } }
6259
7515
  */
6260
7516
  type ExistanceFilter<Record> = {
6261
- [key in '$exists' | '$notExists']?: ColumnsByValue<Record, any>;
7517
+ [key in '$exists' | '$notExists']?: FilterColumns<Record>;
6262
7518
  };
6263
7519
  type BaseApiFilter<Record> = PropertyAccessFilter<Record> | AggregatorFilter<Record> | ExistanceFilter<Record>;
6264
7520
  /**
@@ -6275,6 +7531,12 @@ type DateBooster = {
6275
7531
  origin?: string;
6276
7532
  scale: string;
6277
7533
  decay: number;
7534
+ /**
7535
+ * The factor with which to multiply the added boost.
7536
+ *
7537
+ * @minimum 0
7538
+ */
7539
+ factor?: number;
6278
7540
  };
6279
7541
  type NumericBooster = {
6280
7542
  factor: number;
@@ -6581,13 +7843,55 @@ type ComplexAggregationResult = {
6581
7843
  }>;
6582
7844
  };
6583
7845
 
7846
+ type KeywordAskOptions<Record extends XataRecord> = {
7847
+ searchType: 'keyword';
7848
+ search?: {
7849
+ fuzziness?: FuzzinessExpression;
7850
+ target?: TargetColumn<Record>[];
7851
+ prefix?: PrefixExpression;
7852
+ filter?: Filter<Record>;
7853
+ boosters?: Boosters<Record>[];
7854
+ };
7855
+ };
7856
+ type VectorAskOptions<Record extends XataRecord> = {
7857
+ searchType: 'vector';
7858
+ vectorSearch?: {
7859
+ /**
7860
+ * The column to use for vector search. It must be of type `vector`.
7861
+ */
7862
+ column: string;
7863
+ /**
7864
+ * The column containing the text for vector search. Must be of type `text`.
7865
+ */
7866
+ contentColumn: string;
7867
+ filter?: Filter<Record>;
7868
+ };
7869
+ };
7870
+ type TypeAskOptions<Record extends XataRecord> = KeywordAskOptions<Record> | VectorAskOptions<Record>;
7871
+ type BaseAskOptions = {
7872
+ rules?: string[];
7873
+ };
7874
+ type AskOptions<Record extends XataRecord> = TypeAskOptions<Record> & BaseAskOptions;
7875
+ type AskResult = {
7876
+ answer?: string;
7877
+ records?: string[];
7878
+ };
7879
+
6584
7880
  type SortDirection = 'asc' | 'desc';
6585
- type SortFilterExtended<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = {
7881
+ type RandomFilter = {
7882
+ '*': 'random';
7883
+ };
7884
+ type RandomFilterExtended = {
7885
+ column: '*';
7886
+ direction: 'random';
7887
+ };
7888
+ type SortColumns<T extends XataRecord> = ColumnsByValue<T, any> | `xata.${keyof XataRecordMetadata}`;
7889
+ type SortFilterExtended<T extends XataRecord, Columns extends string = SortColumns<T>> = RandomFilterExtended | {
6586
7890
  column: Columns;
6587
7891
  direction?: SortDirection;
6588
7892
  };
6589
- type SortFilter<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = Columns | SortFilterExtended<T, Columns> | SortFilterBase<T, Columns>;
6590
- type SortFilterBase<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = Values<{
7893
+ type SortFilter<T extends XataRecord, Columns extends string = SortColumns<T>> = Columns | SortFilterExtended<T, Columns> | SortFilterBase<T, Columns> | RandomFilter;
7894
+ type SortFilterBase<T extends XataRecord, Columns extends string = SortColumns<T>> = Values<{
6591
7895
  [Key in Columns]: {
6592
7896
  [K in Key]: SortDirection;
6593
7897
  };
@@ -6718,7 +8022,9 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
6718
8022
  * @param direction The direction. Either ascending or descending.
6719
8023
  * @returns A new Query object.
6720
8024
  */
6721
- sort<F extends ColumnsByValue<Record, any>>(column: F, direction?: SortDirection): Query<Record, Result>;
8025
+ sort<F extends ColumnsByValue<Record, any>>(column: F, direction: SortDirection): Query<Record, Result>;
8026
+ sort(column: '*', direction: 'random'): Query<Record, Result>;
8027
+ sort<F extends ColumnsByValue<Record, any>>(column: F): Query<Record, Result>;
6722
8028
  /**
6723
8029
  * Builds a new query specifying the set of columns to be returned in the query response.
6724
8030
  * @param columns Array of column names to be returned by the query.
@@ -6744,7 +8050,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
6744
8050
  * @param options Pagination options
6745
8051
  * @returns A page of results
6746
8052
  */
6747
- getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, typeof options['columns']>>>;
8053
+ getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, (typeof options)['columns']>>>;
6748
8054
  /**
6749
8055
  * Get results in an iterator
6750
8056
  *
@@ -6775,7 +8081,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
6775
8081
  */
6776
8082
  getIterator<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
6777
8083
  batchSize?: number;
6778
- }>(options: Options): AsyncGenerator<SelectedPick<Record, typeof options['columns']>[]>;
8084
+ }>(options: Options): AsyncGenerator<SelectedPick<Record, (typeof options)['columns']>[]>;
6779
8085
  /**
6780
8086
  * Performs the query in the database and returns a set of results.
6781
8087
  * @returns An array of records from the database.
@@ -6786,7 +8092,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
6786
8092
  * @param options Additional options to be used when performing the query.
6787
8093
  * @returns An array of records from the database.
6788
8094
  */
6789
- getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<RecordArray<SelectedPick<Record, typeof options['columns']>>>;
8095
+ getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<RecordArray<SelectedPick<Record, (typeof options)['columns']>>>;
6790
8096
  /**
6791
8097
  * Performs the query in the database and returns a set of results.
6792
8098
  * @param options Additional options to be used when performing the query.
@@ -6807,7 +8113,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
6807
8113
  */
6808
8114
  getAll<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
6809
8115
  batchSize?: number;
6810
- }>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
8116
+ }>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']>[]>;
6811
8117
  /**
6812
8118
  * Performs the query in the database and returns all the results.
6813
8119
  * Warning: If there are a large number of results, this method can have performance implications.
@@ -6827,7 +8133,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
6827
8133
  * @param options Additional options to be used when performing the query.
6828
8134
  * @returns The first record that matches the query, or null if no record matched the query.
6829
8135
  */
6830
- getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']> | null>;
8136
+ getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']> | null>;
6831
8137
  /**
6832
8138
  * Performs the query in the database and returns the first result.
6833
8139
  * @param options Additional options to be used when performing the query.
@@ -6846,7 +8152,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
6846
8152
  * @returns The first record that matches the query, or null if no record matched the query.
6847
8153
  * @throws if there are no results.
6848
8154
  */
6849
- getFirstOrThrow<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>>;
8155
+ getFirstOrThrow<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']>>;
6850
8156
  /**
6851
8157
  * Performs the query in the database and returns the first result.
6852
8158
  * @param options Additional options to be used when performing the query.
@@ -6895,6 +8201,7 @@ type PaginationQueryMeta = {
6895
8201
  page: {
6896
8202
  cursor: string;
6897
8203
  more: boolean;
8204
+ size: number;
6898
8205
  };
6899
8206
  };
6900
8207
  interface Paginable<Record extends XataRecord, Result extends XataRecord = Record> {
@@ -7027,7 +8334,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7027
8334
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7028
8335
  * @returns The full persisted record.
7029
8336
  */
7030
- abstract create<K extends SelectableColumn<Record>>(id: string, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
8337
+ abstract create<K extends SelectableColumn<Record>>(id: Identifier, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
7031
8338
  ifVersion?: number;
7032
8339
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7033
8340
  /**
@@ -7036,7 +8343,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7036
8343
  * @param object Object containing the column names with their values to be stored in the table.
7037
8344
  * @returns The full persisted record.
7038
8345
  */
7039
- abstract create(id: string, object: Omit<EditableData<Record>, 'id'>, options?: {
8346
+ abstract create(id: Identifier, object: Omit<EditableData<Record>, 'id'>, options?: {
7040
8347
  ifVersion?: number;
7041
8348
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7042
8349
  /**
@@ -7058,26 +8365,26 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7058
8365
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7059
8366
  * @returns The persisted record for the given id or null if the record could not be found.
7060
8367
  */
7061
- abstract read<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
8368
+ abstract read<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
7062
8369
  /**
7063
8370
  * Queries a single record from the table given its unique id.
7064
8371
  * @param id The unique id.
7065
8372
  * @returns The persisted record for the given id or null if the record could not be found.
7066
8373
  */
7067
- abstract read(id: string): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
8374
+ abstract read(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
7068
8375
  /**
7069
8376
  * Queries multiple records from the table given their unique id.
7070
8377
  * @param ids The unique ids array.
7071
8378
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7072
8379
  * @returns The persisted records for the given ids in order (if a record could not be found null is returned).
7073
8380
  */
7074
- abstract read<K extends SelectableColumn<Record>>(ids: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
8381
+ abstract read<K extends SelectableColumn<Record>>(ids: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
7075
8382
  /**
7076
8383
  * Queries multiple records from the table given their unique id.
7077
8384
  * @param ids The unique ids array.
7078
8385
  * @returns The persisted records for the given ids in order (if a record could not be found null is returned).
7079
8386
  */
7080
- abstract read(ids: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
8387
+ abstract read(ids: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
7081
8388
  /**
7082
8389
  * Queries a single record from the table by the id in the object.
7083
8390
  * @param object Object containing the id of the record.
@@ -7111,14 +8418,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7111
8418
  * @returns The persisted record for the given id.
7112
8419
  * @throws If the record could not be found.
7113
8420
  */
7114
- abstract readOrThrow<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
8421
+ abstract readOrThrow<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7115
8422
  /**
7116
8423
  * Queries a single record from the table given its unique id.
7117
8424
  * @param id The unique id.
7118
8425
  * @returns The persisted record for the given id.
7119
8426
  * @throws If the record could not be found.
7120
8427
  */
7121
- abstract readOrThrow(id: string): Promise<Readonly<SelectedPick<Record, ['*']>>>;
8428
+ abstract readOrThrow(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7122
8429
  /**
7123
8430
  * Queries multiple records from the table given their unique id.
7124
8431
  * @param ids The unique ids array.
@@ -7126,14 +8433,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7126
8433
  * @returns The persisted records for the given ids in order.
7127
8434
  * @throws If one or more records could not be found.
7128
8435
  */
7129
- abstract readOrThrow<K extends SelectableColumn<Record>>(ids: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
8436
+ abstract readOrThrow<K extends SelectableColumn<Record>>(ids: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
7130
8437
  /**
7131
8438
  * Queries multiple records from the table given their unique id.
7132
8439
  * @param ids The unique ids array.
7133
8440
  * @returns The persisted records for the given ids in order.
7134
8441
  * @throws If one or more records could not be found.
7135
8442
  */
7136
- abstract readOrThrow(ids: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
8443
+ abstract readOrThrow(ids: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
7137
8444
  /**
7138
8445
  * Queries a single record from the table by the id in the object.
7139
8446
  * @param object Object containing the id of the record.
@@ -7188,7 +8495,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7188
8495
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7189
8496
  * @returns The full persisted record, null if the record could not be found.
7190
8497
  */
7191
- abstract update<K extends SelectableColumn<Record>>(id: string, object: Partial<EditableData<Record>>, columns: K[], options?: {
8498
+ abstract update<K extends SelectableColumn<Record>>(id: Identifier, object: Partial<EditableData<Record>>, columns: K[], options?: {
7192
8499
  ifVersion?: number;
7193
8500
  }): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
7194
8501
  /**
@@ -7197,7 +8504,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7197
8504
  * @param object The column names and their values that have to be updated.
7198
8505
  * @returns The full persisted record, null if the record could not be found.
7199
8506
  */
7200
- abstract update(id: string, object: Partial<EditableData<Record>>, options?: {
8507
+ abstract update(id: Identifier, object: Partial<EditableData<Record>>, options?: {
7201
8508
  ifVersion?: number;
7202
8509
  }): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
7203
8510
  /**
@@ -7240,7 +8547,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7240
8547
  * @returns The full persisted record.
7241
8548
  * @throws If the record could not be found.
7242
8549
  */
7243
- abstract updateOrThrow<K extends SelectableColumn<Record>>(id: string, object: Partial<EditableData<Record>>, columns: K[], options?: {
8550
+ abstract updateOrThrow<K extends SelectableColumn<Record>>(id: Identifier, object: Partial<EditableData<Record>>, columns: K[], options?: {
7244
8551
  ifVersion?: number;
7245
8552
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7246
8553
  /**
@@ -7250,7 +8557,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7250
8557
  * @returns The full persisted record.
7251
8558
  * @throws If the record could not be found.
7252
8559
  */
7253
- abstract updateOrThrow(id: string, object: Partial<EditableData<Record>>, options?: {
8560
+ abstract updateOrThrow(id: Identifier, object: Partial<EditableData<Record>>, options?: {
7254
8561
  ifVersion?: number;
7255
8562
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7256
8563
  /**
@@ -7275,7 +8582,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7275
8582
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7276
8583
  * @returns The full persisted record.
7277
8584
  */
7278
- abstract createOrUpdate<K extends SelectableColumn<Record>>(object: EditableData<Record> & Identifiable, columns: K[], options?: {
8585
+ abstract createOrUpdate<K extends SelectableColumn<Record>>(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, columns: K[], options?: {
7279
8586
  ifVersion?: number;
7280
8587
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7281
8588
  /**
@@ -7284,7 +8591,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7284
8591
  * @param object Object containing the column names with their values to be persisted in the table.
7285
8592
  * @returns The full persisted record.
7286
8593
  */
7287
- abstract createOrUpdate(object: EditableData<Record> & Identifiable, options?: {
8594
+ abstract createOrUpdate(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, options?: {
7288
8595
  ifVersion?: number;
7289
8596
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7290
8597
  /**
@@ -7295,7 +8602,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7295
8602
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7296
8603
  * @returns The full persisted record.
7297
8604
  */
7298
- abstract createOrUpdate<K extends SelectableColumn<Record>>(id: string, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
8605
+ abstract createOrUpdate<K extends SelectableColumn<Record>>(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
7299
8606
  ifVersion?: number;
7300
8607
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7301
8608
  /**
@@ -7305,7 +8612,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7305
8612
  * @param object The column names and the values to be persisted.
7306
8613
  * @returns The full persisted record.
7307
8614
  */
7308
- abstract createOrUpdate(id: string, object: Omit<EditableData<Record>, 'id'>, options?: {
8615
+ abstract createOrUpdate(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, options?: {
7309
8616
  ifVersion?: number;
7310
8617
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7311
8618
  /**
@@ -7315,14 +8622,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7315
8622
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7316
8623
  * @returns Array of the persisted records.
7317
8624
  */
7318
- abstract createOrUpdate<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
8625
+ abstract createOrUpdate<K extends SelectableColumn<Record>>(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
7319
8626
  /**
7320
8627
  * Creates or updates a single record. If a record exists with the given id,
7321
8628
  * it will be partially updated, otherwise a new record will be created.
7322
8629
  * @param objects Array of objects with the column names and the values to be stored in the table.
7323
8630
  * @returns Array of the persisted records.
7324
8631
  */
7325
- abstract createOrUpdate(objects: Array<EditableData<Record> & Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
8632
+ abstract createOrUpdate(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
7326
8633
  /**
7327
8634
  * Creates or replaces a single record. If a record exists with the given id,
7328
8635
  * it will be replaced, otherwise a new record will be created.
@@ -7330,7 +8637,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7330
8637
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7331
8638
  * @returns The full persisted record.
7332
8639
  */
7333
- abstract createOrReplace<K extends SelectableColumn<Record>>(object: EditableData<Record> & Identifiable, columns: K[], options?: {
8640
+ abstract createOrReplace<K extends SelectableColumn<Record>>(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, columns: K[], options?: {
7334
8641
  ifVersion?: number;
7335
8642
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7336
8643
  /**
@@ -7339,7 +8646,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7339
8646
  * @param object Object containing the column names with their values to be persisted in the table.
7340
8647
  * @returns The full persisted record.
7341
8648
  */
7342
- abstract createOrReplace(object: EditableData<Record> & Identifiable, options?: {
8649
+ abstract createOrReplace(object: Omit<EditableData<Record>, 'id'> & Partial<Identifiable>, options?: {
7343
8650
  ifVersion?: number;
7344
8651
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7345
8652
  /**
@@ -7350,7 +8657,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7350
8657
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7351
8658
  * @returns The full persisted record.
7352
8659
  */
7353
- abstract createOrReplace<K extends SelectableColumn<Record>>(id: string, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
8660
+ abstract createOrReplace<K extends SelectableColumn<Record>>(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
7354
8661
  ifVersion?: number;
7355
8662
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7356
8663
  /**
@@ -7360,7 +8667,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7360
8667
  * @param object The column names and the values to be persisted.
7361
8668
  * @returns The full persisted record.
7362
8669
  */
7363
- abstract createOrReplace(id: string, object: Omit<EditableData<Record>, 'id'>, options?: {
8670
+ abstract createOrReplace(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, options?: {
7364
8671
  ifVersion?: number;
7365
8672
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7366
8673
  /**
@@ -7370,14 +8677,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7370
8677
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7371
8678
  * @returns Array of the persisted records.
7372
8679
  */
7373
- abstract createOrReplace<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
8680
+ abstract createOrReplace<K extends SelectableColumn<Record>>(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
7374
8681
  /**
7375
8682
  * Creates or replaces a single record. If a record exists with the given id,
7376
8683
  * it will be replaced, otherwise a new record will be created.
7377
8684
  * @param objects Array of objects with the column names and the values to be stored in the table.
7378
8685
  * @returns Array of the persisted records.
7379
8686
  */
7380
- abstract createOrReplace(objects: Array<EditableData<Record> & Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
8687
+ abstract createOrReplace(objects: Array<Omit<EditableData<Record>, 'id'> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
7381
8688
  /**
7382
8689
  * Deletes a record given its unique id.
7383
8690
  * @param object An object with a unique id.
@@ -7397,13 +8704,13 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7397
8704
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7398
8705
  * @returns The deleted record, null if the record could not be found.
7399
8706
  */
7400
- abstract delete<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
8707
+ abstract delete<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
7401
8708
  /**
7402
8709
  * Deletes a record given a unique id.
7403
8710
  * @param id The unique id.
7404
8711
  * @returns The deleted record, null if the record could not be found.
7405
8712
  */
7406
- abstract delete(id: string): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
8713
+ abstract delete(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
7407
8714
  /**
7408
8715
  * Deletes multiple records given an array of objects with ids.
7409
8716
  * @param objects An array of objects with unique ids.
@@ -7423,13 +8730,13 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7423
8730
  * @param columns Array of columns to be returned. If not specified, first level columns will be returned.
7424
8731
  * @returns Array of the deleted records in order (if a record could not be found null is returned).
7425
8732
  */
7426
- abstract delete<K extends SelectableColumn<Record>>(objects: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
8733
+ abstract delete<K extends SelectableColumn<Record>>(objects: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
7427
8734
  /**
7428
8735
  * Deletes multiple records given an array of unique ids.
7429
8736
  * @param objects An array of ids.
7430
8737
  * @returns Array of the deleted records in order (if a record could not be found null is returned).
7431
8738
  */
7432
- abstract delete(objects: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
8739
+ abstract delete(objects: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
7433
8740
  /**
7434
8741
  * Deletes a record given its unique id.
7435
8742
  * @param object An object with a unique id.
@@ -7452,14 +8759,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7452
8759
  * @returns The deleted record, null if the record could not be found.
7453
8760
  * @throws If the record could not be found.
7454
8761
  */
7455
- abstract deleteOrThrow<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
8762
+ abstract deleteOrThrow<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7456
8763
  /**
7457
8764
  * Deletes a record given a unique id.
7458
8765
  * @param id The unique id.
7459
8766
  * @returns The deleted record, null if the record could not be found.
7460
8767
  * @throws If the record could not be found.
7461
8768
  */
7462
- abstract deleteOrThrow(id: string): Promise<Readonly<SelectedPick<Record, ['*']>>>;
8769
+ abstract deleteOrThrow(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7463
8770
  /**
7464
8771
  * Deletes multiple records given an array of objects with ids.
7465
8772
  * @param objects An array of objects with unique ids.
@@ -7482,14 +8789,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7482
8789
  * @returns Array of the deleted records in order (if a record could not be found null is returned).
7483
8790
  * @throws If one or more records could not be found.
7484
8791
  */
7485
- abstract deleteOrThrow<K extends SelectableColumn<Record>>(objects: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
8792
+ abstract deleteOrThrow<K extends SelectableColumn<Record>>(objects: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
7486
8793
  /**
7487
8794
  * Deletes multiple records given an array of unique ids.
7488
8795
  * @param objects An array of ids.
7489
8796
  * @returns Array of the deleted records in order.
7490
8797
  * @throws If one or more records could not be found.
7491
8798
  */
7492
- abstract deleteOrThrow(objects: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
8799
+ abstract deleteOrThrow(objects: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
7493
8800
  /**
7494
8801
  * Search for records in the table.
7495
8802
  * @param query The query to search for.
@@ -7536,6 +8843,16 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7536
8843
  * @returns The requested aggregations.
7537
8844
  */
7538
8845
  abstract aggregate<Expression extends Dictionary<AggregationExpression<Record>>>(expression?: Expression, filter?: Filter<Record>): Promise<AggregationResult<Record, Expression>>;
8846
+ /**
8847
+ * Experimental: Ask the database to perform a natural language question.
8848
+ */
8849
+ abstract ask(question: string, options?: AskOptions<Record>): Promise<AskResult>;
8850
+ /**
8851
+ * Experimental: Ask the database to perform a natural language question.
8852
+ */
8853
+ abstract ask(question: string, options: AskOptions<Record> & {
8854
+ onMessage: (message: AskResult) => void;
8855
+ }): void;
7539
8856
  abstract query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
7540
8857
  }
7541
8858
  declare class RestRepository<Record extends XataRecord> extends Query<Record, SelectedPick<Record, ['*']>> implements Repository<Record> {
@@ -7552,26 +8869,26 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
7552
8869
  create(object: EditableData<Record> & Partial<Identifiable>, options?: {
7553
8870
  ifVersion?: number;
7554
8871
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7555
- create<K extends SelectableColumn<Record>>(id: string, object: EditableData<Record>, columns: K[], options?: {
8872
+ create<K extends SelectableColumn<Record>>(id: Identifier, object: EditableData<Record>, columns: K[], options?: {
7556
8873
  ifVersion?: number;
7557
8874
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7558
- create(id: string, object: EditableData<Record>, options?: {
8875
+ create(id: Identifier, object: EditableData<Record>, options?: {
7559
8876
  ifVersion?: number;
7560
8877
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7561
8878
  create<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
7562
8879
  create(objects: Array<EditableData<Record> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
7563
- read<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
8880
+ read<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
7564
8881
  read(id: string): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
7565
- read<K extends SelectableColumn<Record>>(ids: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
7566
- read(ids: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
8882
+ read<K extends SelectableColumn<Record>>(ids: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
8883
+ read(ids: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
7567
8884
  read<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
7568
8885
  read(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
7569
8886
  read<K extends SelectableColumn<Record>>(objects: Identifiable[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
7570
8887
  read(objects: Identifiable[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
7571
- readOrThrow<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7572
- readOrThrow(id: string): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7573
- readOrThrow<K extends SelectableColumn<Record>>(ids: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
7574
- readOrThrow(ids: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
8888
+ readOrThrow<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
8889
+ readOrThrow(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>>>;
8890
+ readOrThrow<K extends SelectableColumn<Record>>(ids: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
8891
+ readOrThrow(ids: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
7575
8892
  readOrThrow<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7576
8893
  readOrThrow(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7577
8894
  readOrThrow<K extends SelectableColumn<Record>>(objects: Identifiable[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
@@ -7582,10 +8899,10 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
7582
8899
  update(object: Partial<EditableData<Record>> & Identifiable, options?: {
7583
8900
  ifVersion?: number;
7584
8901
  }): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
7585
- update<K extends SelectableColumn<Record>>(id: string, object: Partial<EditableData<Record>>, columns: K[], options?: {
8902
+ update<K extends SelectableColumn<Record>>(id: Identifier, object: Partial<EditableData<Record>>, columns: K[], options?: {
7586
8903
  ifVersion?: number;
7587
8904
  }): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
7588
- update(id: string, object: Partial<EditableData<Record>>, options?: {
8905
+ update(id: Identifier, object: Partial<EditableData<Record>>, options?: {
7589
8906
  ifVersion?: number;
7590
8907
  }): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
7591
8908
  update<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
@@ -7596,58 +8913,58 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
7596
8913
  updateOrThrow(object: Partial<EditableData<Record>> & Identifiable, options?: {
7597
8914
  ifVersion?: number;
7598
8915
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7599
- updateOrThrow<K extends SelectableColumn<Record>>(id: string, object: Partial<EditableData<Record>>, columns: K[], options?: {
8916
+ updateOrThrow<K extends SelectableColumn<Record>>(id: Identifier, object: Partial<EditableData<Record>>, columns: K[], options?: {
7600
8917
  ifVersion?: number;
7601
8918
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7602
- updateOrThrow(id: string, object: Partial<EditableData<Record>>, options?: {
8919
+ updateOrThrow(id: Identifier, object: Partial<EditableData<Record>>, options?: {
7603
8920
  ifVersion?: number;
7604
8921
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7605
8922
  updateOrThrow<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
7606
8923
  updateOrThrow(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
7607
- createOrUpdate<K extends SelectableColumn<Record>>(object: EditableData<Record> & Identifiable, columns: K[], options?: {
8924
+ createOrUpdate<K extends SelectableColumn<Record>>(object: EditableData<Record> & Partial<Identifiable>, columns: K[], options?: {
7608
8925
  ifVersion?: number;
7609
8926
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7610
- createOrUpdate(object: EditableData<Record> & Identifiable, options?: {
8927
+ createOrUpdate(object: EditableData<Record> & Partial<Identifiable>, options?: {
7611
8928
  ifVersion?: number;
7612
8929
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7613
- createOrUpdate<K extends SelectableColumn<Record>>(id: string, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
8930
+ createOrUpdate<K extends SelectableColumn<Record>>(id: Identifier, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
7614
8931
  ifVersion?: number;
7615
8932
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7616
- createOrUpdate(id: string, object: Omit<EditableData<Record>, 'id'>, options?: {
8933
+ createOrUpdate(id: Identifier, object: Omit<EditableData<Record>, 'id'>, options?: {
7617
8934
  ifVersion?: number;
7618
8935
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7619
- createOrUpdate<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
7620
- createOrUpdate(objects: Array<EditableData<Record> & Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
7621
- createOrReplace<K extends SelectableColumn<Record>>(object: EditableData<Record> & Identifiable, columns: K[], options?: {
8936
+ createOrUpdate<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
8937
+ createOrUpdate(objects: Array<EditableData<Record> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
8938
+ createOrReplace<K extends SelectableColumn<Record>>(object: EditableData<Record> & Partial<Identifiable>, columns: K[], options?: {
7622
8939
  ifVersion?: number;
7623
8940
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7624
- createOrReplace(object: EditableData<Record> & Identifiable, options?: {
8941
+ createOrReplace(object: EditableData<Record> & Partial<Identifiable>, options?: {
7625
8942
  ifVersion?: number;
7626
8943
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7627
- createOrReplace<K extends SelectableColumn<Record>>(id: string, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
8944
+ createOrReplace<K extends SelectableColumn<Record>>(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, columns: K[], options?: {
7628
8945
  ifVersion?: number;
7629
8946
  }): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7630
- createOrReplace(id: string, object: Omit<EditableData<Record>, 'id'>, options?: {
8947
+ createOrReplace(id: Identifier | undefined, object: Omit<EditableData<Record>, 'id'>, options?: {
7631
8948
  ifVersion?: number;
7632
8949
  }): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7633
- createOrReplace<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
7634
- createOrReplace(objects: Array<EditableData<Record> & Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
8950
+ createOrReplace<K extends SelectableColumn<Record>>(objects: Array<EditableData<Record> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
8951
+ createOrReplace(objects: Array<EditableData<Record> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
7635
8952
  delete<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
7636
8953
  delete(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
7637
- delete<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
7638
- delete(id: string): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
8954
+ delete<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
8955
+ delete(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
7639
8956
  delete<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
7640
8957
  delete(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
7641
- delete<K extends SelectableColumn<Record>>(objects: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
7642
- delete(objects: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
8958
+ delete<K extends SelectableColumn<Record>>(objects: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
8959
+ delete(objects: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
7643
8960
  deleteOrThrow<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7644
8961
  deleteOrThrow(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7645
- deleteOrThrow<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
7646
- deleteOrThrow(id: string): Promise<Readonly<SelectedPick<Record, ['*']>>>;
8962
+ deleteOrThrow<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
8963
+ deleteOrThrow(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>>>;
7647
8964
  deleteOrThrow<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
7648
8965
  deleteOrThrow(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
7649
- deleteOrThrow<K extends SelectableColumn<Record>>(objects: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
7650
- deleteOrThrow(objects: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
8966
+ deleteOrThrow<K extends SelectableColumn<Record>>(objects: Identifier[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
8967
+ deleteOrThrow(objects: Identifier[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
7651
8968
  search(query: string, options?: {
7652
8969
  fuzziness?: FuzzinessExpression;
7653
8970
  prefix?: PrefixExpression;
@@ -7665,6 +8982,9 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
7665
8982
  aggregate<Expression extends Dictionary<AggregationExpression<Record>>>(aggs?: Expression, filter?: Filter<Record>): Promise<any>;
7666
8983
  query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
7667
8984
  summarizeTable<Result extends XataRecord>(query: Query<Record, Result>, summaries?: Dictionary<SummarizeExpression<Record>>, summariesFilter?: FilterExpression): Promise<SummarizeResponse>;
8985
+ ask(question: string, options?: AskOptions<Record> & {
8986
+ onMessage?: (message: AskResult) => void;
8987
+ }): any;
7668
8988
  }
7669
8989
 
7670
8990
  type BaseSchema = {
@@ -7720,7 +9040,7 @@ type PropertyType<Tables, Properties, PropertyName extends PropertyKey> = Proper
7720
9040
  } : {
7721
9041
  [K in PropertyName]?: InnerType<Type, ObjectColumns, Tables, LinkedTable> | null;
7722
9042
  } : never : never;
7723
- type InnerType<Type, ObjectColumns, Tables, LinkedTable> = Type extends 'string' | 'text' | 'email' ? string : Type extends 'int' | 'float' ? number : Type extends 'bool' ? boolean : Type extends 'datetime' ? Date : Type extends 'multiple' ? string[] : Type extends 'vector' ? number[] : Type extends 'object' ? ObjectColumns extends readonly unknown[] ? ObjectColumns[number] extends {
9043
+ type InnerType<Type, ObjectColumns, Tables, LinkedTable> = Type extends 'string' | 'text' | 'email' ? string : Type extends 'int' | 'float' ? number : Type extends 'bool' ? boolean : Type extends 'datetime' ? Date : Type extends 'multiple' ? string[] : Type extends 'vector' ? number[] : Type extends 'file' ? XataFile : Type extends 'file[]' ? XataArrayFile[] : Type extends 'object' ? ObjectColumns extends readonly unknown[] ? ObjectColumns[number] extends {
7724
9044
  name: string;
7725
9045
  type: string;
7726
9046
  } ? UnionToIntersection<Values<{
@@ -7778,11 +9098,11 @@ declare const le: <T extends ComparableType>(value: T) => ComparableTypeFilter<T
7778
9098
  /**
7779
9099
  * Operator to restrict results to only values that are not null.
7780
9100
  */
7781
- declare const exists: <T>(column?: ColumnsByValue<T, any> | undefined) => ExistanceFilter<T>;
9101
+ declare const exists: <T>(column?: FilterColumns<T> | undefined) => ExistanceFilter<T>;
7782
9102
  /**
7783
9103
  * Operator to restrict results to only values that are null.
7784
9104
  */
7785
- declare const notExists: <T>(column?: ColumnsByValue<T, any> | undefined) => ExistanceFilter<T>;
9105
+ declare const notExists: <T>(column?: FilterColumns<T> | undefined) => ExistanceFilter<T>;
7786
9106
  /**
7787
9107
  * Operator to restrict results to only values that start with the given prefix.
7788
9108
  */
@@ -7840,6 +9160,40 @@ declare class SchemaPlugin<Schemas extends Record<string, XataRecord>> extends X
7840
9160
  build(pluginOptions: XataPluginOptions): SchemaPluginResult<Schemas>;
7841
9161
  }
7842
9162
 
9163
+ type BinaryFile = string | Blob | ArrayBuffer;
9164
+ type FilesPluginResult<Schemas extends Record<string, BaseData>> = {
9165
+ download: <Tables extends StringKeys<Schemas>>(location: DownloadDestination<Schemas, Tables>) => Promise<Blob>;
9166
+ upload: <Tables extends StringKeys<Schemas>>(location: UploadDestination<Schemas, Tables>, file: BinaryFile) => Promise<FileResponse>;
9167
+ delete: <Tables extends StringKeys<Schemas>>(location: DownloadDestination<Schemas, Tables>) => Promise<FileResponse>;
9168
+ };
9169
+ type UploadDestination<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = Values<{
9170
+ [Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
9171
+ table: Model;
9172
+ column: ColumnsByValue<Schemas[Model], XataFile>;
9173
+ record: string;
9174
+ } | {
9175
+ table: Model;
9176
+ column: ColumnsByValue<Schemas[Model], XataArrayFile[]>;
9177
+ record: string;
9178
+ fileId?: string;
9179
+ };
9180
+ }>;
9181
+ type DownloadDestination<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = Values<{
9182
+ [Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
9183
+ table: Model;
9184
+ column: ColumnsByValue<Schemas[Model], XataFile>;
9185
+ record: string;
9186
+ } | {
9187
+ table: Model;
9188
+ column: ColumnsByValue<Schemas[Model], XataArrayFile[]>;
9189
+ record: string;
9190
+ fileId: string;
9191
+ };
9192
+ }>;
9193
+ declare class FilesPlugin<Schemas extends Record<string, XataRecord>> extends XataPlugin {
9194
+ build(pluginOptions: XataPluginOptions): FilesPluginResult<Schemas>;
9195
+ }
9196
+
7843
9197
  type TransactionOperation<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = {
7844
9198
  insert: Values<{
7845
9199
  [Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
@@ -7872,6 +9226,7 @@ type UpdateTransactionOperation<O extends XataRecord> = {
7872
9226
  };
7873
9227
  type DeleteTransactionOperation = {
7874
9228
  id: string;
9229
+ failIfMissing?: boolean;
7875
9230
  };
7876
9231
  type TransactionOperationSingleResult<Schema extends Record<string, BaseData>, Table extends StringKeys<Schema>, Operation extends TransactionOperation<Schema, Table>> = Operation extends {
7877
9232
  insert: {
@@ -7939,6 +9294,7 @@ interface ClientConstructor<Plugins extends Record<string, XataPlugin>> {
7939
9294
  db: Awaited<ReturnType<SchemaPlugin<Schemas>['build']>>;
7940
9295
  search: Awaited<ReturnType<SearchPlugin<Schemas>['build']>>;
7941
9296
  transactions: Awaited<ReturnType<TransactionPlugin<Schemas>['build']>>;
9297
+ files: Awaited<ReturnType<FilesPlugin<Schemas>['build']>>;
7942
9298
  }, keyof Plugins> & {
7943
9299
  [Key in StringKeys<NonNullable<Plugins>>]: Awaited<ReturnType<NonNullable<Plugins>[Key]['build']>>;
7944
9300
  } & {
@@ -7968,27 +9324,31 @@ type SerializerResult<T> = T extends XataRecord ? Identifiable & Omit<{
7968
9324
  [K in keyof T]: SerializerResult<T[K]>;
7969
9325
  }, keyof XataRecord> : T extends any[] ? SerializerResult<T[number]>[] : T;
7970
9326
 
7971
- declare function getAPIKey(): string | undefined;
7972
-
7973
9327
  declare function getDatabaseURL(): string | undefined;
9328
+ declare function getAPIKey(): string | undefined;
7974
9329
  declare function getBranch(): string | undefined;
9330
+ declare function buildPreviewBranchName({ org, branch }: {
9331
+ org: string;
9332
+ branch: string;
9333
+ }): string;
9334
+ declare function getPreviewBranch(): string | undefined;
7975
9335
 
7976
9336
  interface Body {
7977
9337
  arrayBuffer(): Promise<ArrayBuffer>;
7978
- blob(): Promise<Blob>;
9338
+ blob(): Promise<Blob$1>;
7979
9339
  formData(): Promise<FormData>;
7980
9340
  json(): Promise<any>;
7981
9341
  text(): Promise<string>;
7982
9342
  }
7983
- interface Blob {
9343
+ interface Blob$1 {
7984
9344
  readonly size: number;
7985
9345
  readonly type: string;
7986
9346
  arrayBuffer(): Promise<ArrayBuffer>;
7987
- slice(start?: number, end?: number, contentType?: string): Blob;
9347
+ slice(start?: number, end?: number, contentType?: string): Blob$1;
7988
9348
  text(): Promise<string>;
7989
9349
  }
7990
9350
  /** Provides information about files and allows JavaScript in a web page to access their content. */
7991
- interface File extends Blob {
9351
+ interface File extends Blob$1 {
7992
9352
  readonly lastModified: number;
7993
9353
  readonly name: string;
7994
9354
  readonly webkitRelativePath: string;
@@ -7996,12 +9356,12 @@ interface File extends Blob {
7996
9356
  type FormDataEntryValue = File | string;
7997
9357
  /** 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
9358
  interface FormData {
7999
- append(name: string, value: string | Blob, fileName?: string): void;
9359
+ append(name: string, value: string | Blob$1, fileName?: string): void;
8000
9360
  delete(name: string): void;
8001
9361
  get(name: string): FormDataEntryValue | null;
8002
9362
  getAll(name: string): FormDataEntryValue[];
8003
9363
  has(name: string): boolean;
8004
- set(name: string, value: string | Blob, fileName?: string): void;
9364
+ set(name: string, value: string | Blob$1, fileName?: string): void;
8005
9365
  forEach(callbackfn: (value: FormDataEntryValue, key: string, parent: FormData) => void, thisArg?: any): void;
8006
9366
  }
8007
9367
  /** 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 +9418,4 @@ declare class XataError extends Error {
8058
9418
  constructor(message: string, status: number);
8059
9419
  }
8060
9420
 
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 };
9421
+ 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, AskTableSessionError, AskTableSessionPathParams, AskTableSessionRequestBody, AskTableSessionResponse, AskTableSessionVariables, 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, GenerateAccessTokenError, GenerateAccessTokenVariables, 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, GrantAuthorizationCodeError, GrantAuthorizationCodeRequestBody, GrantAuthorizationCodeResponse, GrantAuthorizationCodeVariables, HostProvider, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, JSONData, KeywordAskOptions, Link, ListMigrationRequestsCommitsError, ListMigrationRequestsCommitsPathParams, ListMigrationRequestsCommitsRequestBody, ListMigrationRequestsCommitsResponse, ListMigrationRequestsCommitsVariables, ListRegionsError, ListRegionsPathParams, ListRegionsVariables, MergeMigrationRequestError, MergeMigrationRequestPathParams, MergeMigrationRequestVariables, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, PreviewBranchSchemaEditError, PreviewBranchSchemaEditPathParams, PreviewBranchSchemaEditRequestBody, PreviewBranchSchemaEditResponse, PreviewBranchSchemaEditVariables, PushBranchMigrationsError, PushBranchMigrationsPathParams, PushBranchMigrationsRequestBody, PushBranchMigrationsVariables, PutFileError, PutFileItemError, PutFileItemPathParams, PutFileItemVariables, PutFilePathParams, PutFileVariables, Query, QueryMigrationRequestsError, QueryMigrationRequestsPathParams, QueryMigrationRequestsRequestBody, QueryMigrationRequestsResponse, QueryMigrationRequestsVariables, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RecordArray, RecordColumnTypes, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, RenameDatabaseError, RenameDatabasePathParams, RenameDatabaseRequestBody, RenameDatabaseVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaInference, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SearchTableError, SearchTablePathParams, SearchTableRequestBody, SearchTableVariables, SearchXataRecord, SelectableColumn, SelectedPick, SerializedString, Serializer, SerializerResult, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, SqlQueryError, SqlQueryPathParams, SqlQueryRequestBody, SqlQueryVariables, SummarizeTableError, SummarizeTablePathParams, SummarizeTableRequestBody, SummarizeTableVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, UpdateBranchSchemaVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateDatabaseGithubSettingsError, UpdateDatabaseGithubSettingsPathParams, UpdateDatabaseGithubSettingsVariables, UpdateDatabaseMetadataError, UpdateDatabaseMetadataPathParams, UpdateDatabaseMetadataRequestBody, UpdateDatabaseMetadataVariables, UpdateMigrationRequestError, UpdateMigrationRequestPathParams, UpdateMigrationRequestRequestBody, UpdateMigrationRequestVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberInviteError, UpdateWorkspaceMemberInvitePathParams, UpdateWorkspaceMemberInviteRequestBody, UpdateWorkspaceMemberInviteVariables, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, VectorAskOptions, VectorSearchTableError, VectorSearchTablePathParams, VectorSearchTableRequestBody, VectorSearchTableVariables, XataApiClient, XataApiClientOptions, XataApiPlugin, XataArrayFile, XataError, XataFile, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, askTable, askTableSession, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteFile, deleteFileItem, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, fileAccess, ge, generateAccessToken, 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, grantAuthorizationCode, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, pushBranchMigrations, putFile, putFileItem, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, renameDatabase, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, sqlQuery, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };