@xata.io/client 0.19.1 → 0.20.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +22 -0
- package/README.md +2 -2
- package/Usage.md +5 -5
- package/dist/index.cjs +64 -29
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +282 -50
- package/dist/index.mjs +64 -30
- package/dist/index.mjs.map +1 -1
- package/mod.ts +2 -0
- package/package.json +1 -1
- package/{rollup.config.js → rollup.config.mjs} +0 -0
- package/tsconfig.json +1 -1
package/dist/index.d.ts
CHANGED
@@ -61,6 +61,7 @@ declare type FetcherExtraProps = {
|
|
61
61
|
signal?: AbortSignal;
|
62
62
|
clientID?: string;
|
63
63
|
sessionID?: string;
|
64
|
+
fetchOptions?: Record<string, unknown>;
|
64
65
|
};
|
65
66
|
|
66
67
|
declare type ControlPlaneFetcherExtraProps = {
|
@@ -982,9 +983,6 @@ declare type Schema = {
|
|
982
983
|
tables: Table[];
|
983
984
|
tablesOrder?: string[];
|
984
985
|
};
|
985
|
-
/**
|
986
|
-
* @x-internal true
|
987
|
-
*/
|
988
986
|
declare type SchemaEditScript = {
|
989
987
|
sourceMigrationID?: string;
|
990
988
|
targetMigrationID?: string;
|
@@ -1001,6 +999,7 @@ declare type Column = {
|
|
1001
999
|
type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object' | 'datetime';
|
1002
1000
|
link?: ColumnLink;
|
1003
1001
|
notNull?: boolean;
|
1002
|
+
defaultValue?: string;
|
1004
1003
|
unique?: boolean;
|
1005
1004
|
columns?: Column[];
|
1006
1005
|
};
|
@@ -1156,7 +1155,7 @@ declare type MigrationRequest = {
|
|
1156
1155
|
* Timestamp when the migration request was merged.
|
1157
1156
|
*/
|
1158
1157
|
mergedAt?: DateTime;
|
1159
|
-
status?: 'open' | 'closed' | 'merging' | 'merged';
|
1158
|
+
status?: 'open' | 'closed' | 'merging' | 'merged' | 'failed';
|
1160
1159
|
/**
|
1161
1160
|
* The migration request title.
|
1162
1161
|
*/
|
@@ -1240,6 +1239,10 @@ declare type FilterExpression = {
|
|
1240
1239
|
*
|
1241
1240
|
* @example {"all_users":{"count":"*"}}
|
1242
1241
|
* @example {"total_created":{"count":"created_at"}}
|
1242
|
+
* @example {"min_cost":{"min":"cost"}}
|
1243
|
+
* @example {"max_happiness":{"max":"happiness"}}
|
1244
|
+
* @example {"total_revenue":{"sum":"revenue"}}
|
1245
|
+
* @example {"average_speed":{"average":"speed"}}
|
1243
1246
|
* @x-go-type xbquery.SummaryList
|
1244
1247
|
*/
|
1245
1248
|
declare type SummaryExpressionList = {
|
@@ -1253,11 +1256,28 @@ declare type SummaryExpressionList = {
|
|
1253
1256
|
* an object, i.e. if `settings` is an object with `dark_mode` as a field, you may summarize
|
1254
1257
|
* `settings.dark_mode` but not `settings` nor `settings.*`.
|
1255
1258
|
*
|
1256
|
-
* We currently support
|
1257
|
-
*
|
1259
|
+
* We currently support several aggregation functions. Not all functions can be run on all column
|
1260
|
+
* types.
|
1261
|
+
*
|
1262
|
+
* - `count` is used to count the number of records in each group. Use `{"count": "*"}` to count
|
1263
|
+
* all columns present, otherwise `{"count": "<column_path>"}` to count the number of non-null
|
1264
|
+
* values are present at column path.
|
1265
|
+
*
|
1266
|
+
* Count can be used on any column type, and always returns an int.
|
1258
1267
|
*
|
1259
|
-
*
|
1260
|
-
*
|
1268
|
+
* - `min` calculates the minimum value in each group. `min` is compatible with most types;
|
1269
|
+
* string, multiple, text, email, int, float, and datetime. It returns a value of the same
|
1270
|
+
* type as operated on. This means that `{"lowest_latency": {"min": "latency"}}` where
|
1271
|
+
* `latency` is an int, will always return an int.
|
1272
|
+
*
|
1273
|
+
* - `max` calculates the maximum value in each group. `max` shares the same compatibility as
|
1274
|
+
* `min`.
|
1275
|
+
*
|
1276
|
+
* - `sum` adds up all values in a group. `sum` can be run on `int` and `float` types, and will
|
1277
|
+
* return a value of the same type as requested.
|
1278
|
+
*
|
1279
|
+
* - `average` averages all values in a group. `average` can be run on `int` and `float` types, and
|
1280
|
+
* always returns a float.
|
1261
1281
|
*
|
1262
1282
|
* @example {"count":"deleted_at"}
|
1263
1283
|
* @x-go-type xbquery.Summary
|
@@ -1566,11 +1586,11 @@ declare type PageConfig = {
|
|
1566
1586
|
/**
|
1567
1587
|
* Query the first page from the cursor.
|
1568
1588
|
*/
|
1569
|
-
|
1589
|
+
start?: string;
|
1570
1590
|
/**
|
1571
1591
|
* Query the last page from the cursor.
|
1572
1592
|
*/
|
1573
|
-
|
1593
|
+
end?: string;
|
1574
1594
|
/**
|
1575
1595
|
* Set page size. If the size is missing it is read from the cursor. If no cursor is given Xata will choose the default page size.
|
1576
1596
|
*
|
@@ -1662,6 +1682,128 @@ declare type AggResponse$1 = (number | null) | {
|
|
1662
1682
|
[key: string]: AggResponse$1;
|
1663
1683
|
})[];
|
1664
1684
|
};
|
1685
|
+
/**
|
1686
|
+
* A transaction operation
|
1687
|
+
*/
|
1688
|
+
declare type TransactionOperation = {
|
1689
|
+
insert: TransactionInsert;
|
1690
|
+
} | {
|
1691
|
+
update: TransactionUpdate;
|
1692
|
+
} | {
|
1693
|
+
['delete']: TransactionDelete;
|
1694
|
+
};
|
1695
|
+
/**
|
1696
|
+
* Insert operation
|
1697
|
+
*
|
1698
|
+
* @x-go-type TxOperation
|
1699
|
+
*/
|
1700
|
+
declare type TransactionInsert = {
|
1701
|
+
/**
|
1702
|
+
* The table name
|
1703
|
+
*/
|
1704
|
+
table: string;
|
1705
|
+
/**
|
1706
|
+
* The record to insert. The `id` field is optional; when specified, it will be used as the ID for the record.
|
1707
|
+
*/
|
1708
|
+
record: {
|
1709
|
+
[key: string]: any;
|
1710
|
+
};
|
1711
|
+
/**
|
1712
|
+
* The version of the record you expect to be overwriting. Only valid with an
|
1713
|
+
* explicit ID is also set in the `record` key.
|
1714
|
+
*/
|
1715
|
+
ifVersion?: number;
|
1716
|
+
/**
|
1717
|
+
* createOnly is used to change how Xata acts when an explicit ID is set in the `record` key.
|
1718
|
+
*
|
1719
|
+
* If `createOnly` is set to `true`, Xata will only attempt to insert the record. If there's a conflict, Xata
|
1720
|
+
* will cancel the transaction.
|
1721
|
+
*
|
1722
|
+
* If `createOnly` is set to `false`, Xata will attempt to insert the record. If there's no
|
1723
|
+
* conflict, the record is inserted. If there is a conflict, Xata will replace the record.
|
1724
|
+
*/
|
1725
|
+
createOnly?: boolean;
|
1726
|
+
};
|
1727
|
+
/**
|
1728
|
+
* Update operation
|
1729
|
+
*
|
1730
|
+
* @x-go-type TxOperation
|
1731
|
+
*/
|
1732
|
+
declare type TransactionUpdate = {
|
1733
|
+
/**
|
1734
|
+
* The table name
|
1735
|
+
*/
|
1736
|
+
table: string;
|
1737
|
+
id: RecordID;
|
1738
|
+
/**
|
1739
|
+
* The fields of the record you'd like to update
|
1740
|
+
*/
|
1741
|
+
fields: {
|
1742
|
+
[key: string]: any;
|
1743
|
+
};
|
1744
|
+
/**
|
1745
|
+
* The version of the record you expect to be updating
|
1746
|
+
*/
|
1747
|
+
ifVersion?: number;
|
1748
|
+
/**
|
1749
|
+
* Xata will insert this record if it cannot be found.
|
1750
|
+
*/
|
1751
|
+
upsert?: boolean;
|
1752
|
+
};
|
1753
|
+
/**
|
1754
|
+
* A delete operation. The transaction will continue if no record matches the ID.
|
1755
|
+
*
|
1756
|
+
* @x-go-type TxOperation
|
1757
|
+
*/
|
1758
|
+
declare type TransactionDelete = {
|
1759
|
+
/**
|
1760
|
+
* The table name
|
1761
|
+
*/
|
1762
|
+
table: string;
|
1763
|
+
id: RecordID;
|
1764
|
+
};
|
1765
|
+
/**
|
1766
|
+
* A result from an insert operation.
|
1767
|
+
*/
|
1768
|
+
declare type TransactionResultInsert = {
|
1769
|
+
/**
|
1770
|
+
* The number of affected rows
|
1771
|
+
*/
|
1772
|
+
rows: number;
|
1773
|
+
id: RecordID;
|
1774
|
+
};
|
1775
|
+
/**
|
1776
|
+
* A result from an update operation.
|
1777
|
+
*/
|
1778
|
+
declare type TransactionResultUpdate = {
|
1779
|
+
/**
|
1780
|
+
* The number of affected rows
|
1781
|
+
*/
|
1782
|
+
rows: number;
|
1783
|
+
id: RecordID;
|
1784
|
+
};
|
1785
|
+
/**
|
1786
|
+
* A result from a delete operation.
|
1787
|
+
*/
|
1788
|
+
declare type TransactionResultDelete = {
|
1789
|
+
/**
|
1790
|
+
* The number of affected rows
|
1791
|
+
*/
|
1792
|
+
rows: number;
|
1793
|
+
};
|
1794
|
+
/**
|
1795
|
+
* An error message from a failing transaction operation
|
1796
|
+
*/
|
1797
|
+
declare type TransactionError = {
|
1798
|
+
/**
|
1799
|
+
* The index of the failing operation
|
1800
|
+
*/
|
1801
|
+
index?: number;
|
1802
|
+
/**
|
1803
|
+
* The error message
|
1804
|
+
*/
|
1805
|
+
message: string;
|
1806
|
+
};
|
1665
1807
|
/**
|
1666
1808
|
* @format date-time
|
1667
1809
|
* @x-go-type string
|
@@ -1738,6 +1880,24 @@ declare type SearchResponse = {
|
|
1738
1880
|
records: XataRecord$1[];
|
1739
1881
|
warning?: string;
|
1740
1882
|
};
|
1883
|
+
/**
|
1884
|
+
* @x-go-type TxResponse
|
1885
|
+
*/
|
1886
|
+
declare type TransactionSucceeded = {
|
1887
|
+
/**
|
1888
|
+
* An ordered array of results from the submitted operations that were executed
|
1889
|
+
*/
|
1890
|
+
results: (TransactionResultInsert | TransactionResultUpdate | TransactionResultDelete)[];
|
1891
|
+
};
|
1892
|
+
/**
|
1893
|
+
* @x-go-type TxResponse
|
1894
|
+
*/
|
1895
|
+
declare type TransactionFailed = {
|
1896
|
+
/**
|
1897
|
+
* An array of errors from the submitted operations.
|
1898
|
+
*/
|
1899
|
+
errors: TransactionError[];
|
1900
|
+
};
|
1741
1901
|
declare type BadRequestError = {
|
1742
1902
|
id?: string;
|
1743
1903
|
message: string;
|
@@ -2399,6 +2559,32 @@ declare type ExecuteBranchMigrationPlanVariables = {
|
|
2399
2559
|
* Apply a migration plan to the branch
|
2400
2560
|
*/
|
2401
2561
|
declare const executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
|
2562
|
+
declare type BranchTransactionPathParams = {
|
2563
|
+
/**
|
2564
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
2565
|
+
*/
|
2566
|
+
dbBranchName: DBBranchName;
|
2567
|
+
workspace: string;
|
2568
|
+
region: string;
|
2569
|
+
};
|
2570
|
+
declare type BranchTransactionError = ErrorWrapper<{
|
2571
|
+
status: 400;
|
2572
|
+
payload: TransactionFailed;
|
2573
|
+
} | {
|
2574
|
+
status: 401;
|
2575
|
+
payload: AuthError;
|
2576
|
+
} | {
|
2577
|
+
status: 404;
|
2578
|
+
payload: SimpleError;
|
2579
|
+
}>;
|
2580
|
+
declare type BranchTransactionRequestBody = {
|
2581
|
+
operations: TransactionOperation[];
|
2582
|
+
};
|
2583
|
+
declare type BranchTransactionVariables = {
|
2584
|
+
body: BranchTransactionRequestBody;
|
2585
|
+
pathParams: BranchTransactionPathParams;
|
2586
|
+
} & DataPlaneFetcherExtraProps;
|
2587
|
+
declare const branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal) => Promise<TransactionSucceeded>;
|
2402
2588
|
declare type QueryMigrationRequestsPathParams = {
|
2403
2589
|
/**
|
2404
2590
|
* The Database Name
|
@@ -3530,6 +3716,12 @@ declare type QueryTableRequestBody = {
|
|
3530
3716
|
sort?: SortExpression;
|
3531
3717
|
page?: PageConfig;
|
3532
3718
|
columns?: ColumnsProjection;
|
3719
|
+
/**
|
3720
|
+
* The consistency level for this request.
|
3721
|
+
*
|
3722
|
+
* @default strong
|
3723
|
+
*/
|
3724
|
+
consistency?: 'strong' | 'eventual';
|
3533
3725
|
};
|
3534
3726
|
declare type QueryTableVariables = {
|
3535
3727
|
body?: QueryTableRequestBody;
|
@@ -3560,6 +3752,8 @@ declare type QueryTableVariables = {
|
|
3560
3752
|
* }
|
3561
3753
|
* ```
|
3562
3754
|
*
|
3755
|
+
* For usage, see also the [API Guide](https://xata.io/docs/api-guide/get).
|
3756
|
+
*
|
3563
3757
|
* ### Column selection
|
3564
3758
|
*
|
3565
3759
|
* If the `columns` array is not specified, all columns are included. For link
|
@@ -3578,7 +3772,6 @@ declare type QueryTableVariables = {
|
|
3578
3772
|
*
|
3579
3773
|
* ```json {"truncate": true}
|
3580
3774
|
* {
|
3581
|
-
* "formatVersion": "1.0",
|
3582
3775
|
* "tables": [
|
3583
3776
|
* {
|
3584
3777
|
* "name": "teams",
|
@@ -3932,9 +4125,8 @@ declare type QueryTableVariables = {
|
|
3932
4125
|
*
|
3933
4126
|
* #### Partial match
|
3934
4127
|
*
|
3935
|
-
* `$contains` is the simplest operator for partial matching.
|
3936
|
-
*
|
3937
|
-
* indices.
|
4128
|
+
* `$contains` is the simplest operator for partial matching. Note that `$contains` operator can
|
4129
|
+
* cause performance issues at scale, because indices cannot be used.
|
3938
4130
|
*
|
3939
4131
|
* ```json
|
3940
4132
|
* {
|
@@ -3964,7 +4156,7 @@ declare type QueryTableVariables = {
|
|
3964
4156
|
*
|
3965
4157
|
* If you want to match a string that contains a wildcard character, you can escape them using a backslash (`\`). You can escape a backslash by usign another backslash.
|
3966
4158
|
*
|
3967
|
-
*
|
4159
|
+
* You can also use the `$endsWith` and `$startsWith` operators:
|
3968
4160
|
*
|
3969
4161
|
* ```json
|
3970
4162
|
* {
|
@@ -4216,12 +4408,14 @@ declare type QueryTableVariables = {
|
|
4216
4408
|
*
|
4217
4409
|
* - `after`: Return the next page 'after' the current cursor
|
4218
4410
|
* - `before`: Return the previous page 'before' the current cursor.
|
4219
|
-
* - `
|
4220
|
-
*
|
4411
|
+
* - `start`: Resets the given cursor position to the beginning of the query result set.
|
4412
|
+
* Will return the first N records from the query result, where N is the `page.size` parameter.
|
4413
|
+
* - `end`: Resets the give cursor position to the end for the query result set.
|
4414
|
+
* Returns the last N records from the query result, where N is the `page.size` parameter.
|
4221
4415
|
*
|
4222
4416
|
* The request will fail if an invalid cursor value is given to `page.before`,
|
4223
|
-
* `page.after`, `page.
|
4224
|
-
* used if `page.
|
4417
|
+
* `page.after`, `page.start` , or `page.end`. No other cursor setting can be
|
4418
|
+
* used if `page.start` or `page.end` is set in a query.
|
4225
4419
|
*
|
4226
4420
|
* If both `page.before` and `page.after` parameters are present we treat the
|
4227
4421
|
* request as a range query. The range query will return all entries after
|
@@ -4243,14 +4437,14 @@ declare type QueryTableVariables = {
|
|
4243
4437
|
* returned is empty, but `page.meta.cursor` will include a cursor that can be
|
4244
4438
|
* used to "tail" the table from the end waiting for new data to be inserted.
|
4245
4439
|
* - `page.before=end`: This cursor returns the last page.
|
4246
|
-
* - `page.
|
4247
|
-
* first page without a cursor but `filter` and `sort` . Yet the `page.
|
4440
|
+
* - `page.start=<cursor>`: Start at the beginning of the result set of the <cursor> query. This is equivalent to querying the
|
4441
|
+
* first page without a cursor but applying `filter` and `sort` . Yet the `page.start`
|
4248
4442
|
* cursor can be convenient at times as user code does not need to remember the
|
4249
4443
|
* filter, sort, columns or page size configuration. All these information are
|
4250
4444
|
* read from the cursor.
|
4251
|
-
* - `page.
|
4445
|
+
* - `page.end=<cursor>`: Move to the end of the result set of the <cursor> query. This is equivalent to querying the
|
4252
4446
|
* last page with `page.before=end`, `filter`, and `sort` . Yet the
|
4253
|
-
* `page.
|
4447
|
+
* `page.end` cursor can be more convenient at times as user code does not
|
4254
4448
|
* need to remember the filter, sort, columns or page size configuration. All
|
4255
4449
|
* these information are read from the cursor.
|
4256
4450
|
*
|
@@ -4395,6 +4589,12 @@ declare type SummarizeTableRequestBody = {
|
|
4395
4589
|
summaries?: SummaryExpressionList;
|
4396
4590
|
sort?: SortExpression;
|
4397
4591
|
summariesFilter?: FilterExpression;
|
4592
|
+
/**
|
4593
|
+
* The consistency level for this request.
|
4594
|
+
*
|
4595
|
+
* @default strong
|
4596
|
+
*/
|
4597
|
+
consistency?: 'strong' | 'eventual';
|
4398
4598
|
page?: {
|
4399
4599
|
/**
|
4400
4600
|
* The number of records returned by summarize. If the amount of data you have exceeds this, or you have
|
@@ -4452,7 +4652,8 @@ declare type SummarizeTableVariables = {
|
|
4452
4652
|
* `columns`: tells Xata how to create each group. If you add `product_id`
|
4453
4653
|
* we will create a new group for every unique `product_id`.
|
4454
4654
|
*
|
4455
|
-
* `summaries`: tells Xata which calculations to run on each group.
|
4655
|
+
* `summaries`: tells Xata which calculations to run on each group. Xata
|
4656
|
+
* currently supports count, min, max, sum, average.
|
4456
4657
|
*
|
4457
4658
|
* `sort`: tells Xata in which order you'd like to see results. You may
|
4458
4659
|
* sort by fields specified in `columns` as well as the summary names
|
@@ -4460,8 +4661,8 @@ declare type SummarizeTableVariables = {
|
|
4460
4661
|
*
|
4461
4662
|
* note: Sorting on summarized values can be slower on very large tables;
|
4462
4663
|
* this will impact your rate limit significantly more than other queries.
|
4463
|
-
* Try use `filter`
|
4464
|
-
*
|
4664
|
+
* Try use `filter` to reduce the amount of data being processed in order
|
4665
|
+
* to reduce impact on your limits.
|
4465
4666
|
*
|
4466
4667
|
* `summariesFilter`: tells Xata how to filter the results of a summary.
|
4467
4668
|
* It has the same syntax as `filter`, however, by using `summariesFilter`
|
@@ -4512,6 +4713,8 @@ declare type AggregateTableVariables = {
|
|
4512
4713
|
* only eventually consistent. On the other hand, the aggregate endpoint uses a
|
4513
4714
|
* store that is more appropiate for analytics, makes use of approximative algorithms
|
4514
4715
|
* (e.g for cardinality), and is generally faster and can do more complex aggregations.
|
4716
|
+
*
|
4717
|
+
* For usage, see the [API Guide](https://xata.io/docs/api-guide/aggregate).
|
4515
4718
|
*/
|
4516
4719
|
declare const aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal) => Promise<AggResponse>;
|
4517
4720
|
|
@@ -4530,6 +4733,7 @@ declare const operationsByTag: {
|
|
4530
4733
|
resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal | undefined) => Promise<ResolveBranchResponse>;
|
4531
4734
|
};
|
4532
4735
|
records: {
|
4736
|
+
branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal | undefined) => Promise<TransactionSucceeded>;
|
4533
4737
|
insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
4534
4738
|
getRecord: (variables: GetRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
|
4535
4739
|
insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
|
@@ -4651,6 +4855,8 @@ type responses_SchemaUpdateResponse = SchemaUpdateResponse;
|
|
4651
4855
|
type responses_SummarizeResponse = SummarizeResponse;
|
4652
4856
|
type responses_AggResponse = AggResponse;
|
4653
4857
|
type responses_SearchResponse = SearchResponse;
|
4858
|
+
type responses_TransactionSucceeded = TransactionSucceeded;
|
4859
|
+
type responses_TransactionFailed = TransactionFailed;
|
4654
4860
|
declare namespace responses {
|
4655
4861
|
export {
|
4656
4862
|
responses_AuthError as AuthError,
|
@@ -4667,6 +4873,8 @@ declare namespace responses {
|
|
4667
4873
|
responses_SummarizeResponse as SummarizeResponse,
|
4668
4874
|
responses_AggResponse as AggResponse,
|
4669
4875
|
responses_SearchResponse as SearchResponse,
|
4876
|
+
responses_TransactionSucceeded as TransactionSucceeded,
|
4877
|
+
responses_TransactionFailed as TransactionFailed,
|
4670
4878
|
};
|
4671
4879
|
}
|
4672
4880
|
|
@@ -4744,6 +4952,14 @@ type schemas_RecordMeta = RecordMeta;
|
|
4744
4952
|
type schemas_RecordID = RecordID;
|
4745
4953
|
type schemas_TableRename = TableRename;
|
4746
4954
|
type schemas_RecordsMetadata = RecordsMetadata;
|
4955
|
+
type schemas_TransactionOperation = TransactionOperation;
|
4956
|
+
type schemas_TransactionInsert = TransactionInsert;
|
4957
|
+
type schemas_TransactionUpdate = TransactionUpdate;
|
4958
|
+
type schemas_TransactionDelete = TransactionDelete;
|
4959
|
+
type schemas_TransactionResultInsert = TransactionResultInsert;
|
4960
|
+
type schemas_TransactionResultUpdate = TransactionResultUpdate;
|
4961
|
+
type schemas_TransactionResultDelete = TransactionResultDelete;
|
4962
|
+
type schemas_TransactionError = TransactionError;
|
4747
4963
|
type schemas_User = User;
|
4748
4964
|
type schemas_UserID = UserID;
|
4749
4965
|
type schemas_UserWithID = UserWithID;
|
@@ -4841,6 +5057,14 @@ declare namespace schemas {
|
|
4841
5057
|
schemas_TableRename as TableRename,
|
4842
5058
|
schemas_RecordsMetadata as RecordsMetadata,
|
4843
5059
|
AggResponse$1 as AggResponse,
|
5060
|
+
schemas_TransactionOperation as TransactionOperation,
|
5061
|
+
schemas_TransactionInsert as TransactionInsert,
|
5062
|
+
schemas_TransactionUpdate as TransactionUpdate,
|
5063
|
+
schemas_TransactionDelete as TransactionDelete,
|
5064
|
+
schemas_TransactionResultInsert as TransactionResultInsert,
|
5065
|
+
schemas_TransactionResultUpdate as TransactionResultUpdate,
|
5066
|
+
schemas_TransactionResultDelete as TransactionResultDelete,
|
5067
|
+
schemas_TransactionError as TransactionError,
|
4844
5068
|
XataRecord$1 as XataRecord,
|
4845
5069
|
schemas_User as User,
|
4846
5070
|
schemas_UserID as UserID,
|
@@ -5191,7 +5415,7 @@ declare class RecordsApi {
|
|
5191
5415
|
declare class SearchAndFilterApi {
|
5192
5416
|
private extraProps;
|
5193
5417
|
constructor(extraProps: ApiExtraProps);
|
5194
|
-
queryTable({ workspace, region, database, branch, table, filter, sort, page, columns }: {
|
5418
|
+
queryTable({ workspace, region, database, branch, table, filter, sort, page, columns, consistency }: {
|
5195
5419
|
workspace: WorkspaceID;
|
5196
5420
|
region: string;
|
5197
5421
|
database: DBName;
|
@@ -5201,6 +5425,7 @@ declare class SearchAndFilterApi {
|
|
5201
5425
|
sort?: SortExpression;
|
5202
5426
|
page?: PageConfig;
|
5203
5427
|
columns?: ColumnsProjection;
|
5428
|
+
consistency?: 'strong' | 'eventual';
|
5204
5429
|
}): Promise<QueryResponse>;
|
5205
5430
|
searchTable({ workspace, region, database, branch, table, query, fuzziness, target, prefix, filter, highlight, boosters }: {
|
5206
5431
|
workspace: WorkspaceID;
|
@@ -5232,7 +5457,7 @@ declare class SearchAndFilterApi {
|
|
5232
5457
|
prefix?: PrefixExpression;
|
5233
5458
|
highlight?: HighlightExpression;
|
5234
5459
|
}): Promise<SearchResponse>;
|
5235
|
-
summarizeTable({ workspace, region, database, branch, table, filter, columns, summaries, sort, summariesFilter, page }: {
|
5460
|
+
summarizeTable({ workspace, region, database, branch, table, filter, columns, summaries, sort, summariesFilter, page, consistency }: {
|
5236
5461
|
workspace: WorkspaceID;
|
5237
5462
|
region: string;
|
5238
5463
|
database: DBName;
|
@@ -5246,6 +5471,7 @@ declare class SearchAndFilterApi {
|
|
5246
5471
|
page?: {
|
5247
5472
|
size?: number;
|
5248
5473
|
};
|
5474
|
+
consistency?: 'strong' | 'eventual';
|
5249
5475
|
}): Promise<SummarizeResponse>;
|
5250
5476
|
aggregateTable({ workspace, region, database, branch, table, filter, aggs }: {
|
5251
5477
|
workspace: WorkspaceID;
|
@@ -5573,13 +5799,13 @@ declare type XataRecordMetadata = {
|
|
5573
5799
|
};
|
5574
5800
|
declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
|
5575
5801
|
declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;
|
5576
|
-
declare type EditableData<O extends XataRecord> = Identifiable & Omit<{
|
5802
|
+
declare type EditableData<O extends XataRecord> = Identifiable & Partial<Omit<{
|
5577
5803
|
[K in keyof O]: O[K] extends XataRecord ? {
|
5578
5804
|
id: string;
|
5579
5805
|
} | string : NonNullable<O[K]> extends XataRecord ? {
|
5580
5806
|
id: string;
|
5581
5807
|
} | string | null | undefined : O[K];
|
5582
|
-
}, keyof XataRecord
|
5808
|
+
}, keyof XataRecord>>;
|
5583
5809
|
|
5584
5810
|
/**
|
5585
5811
|
* PropertyMatchFilter
|
@@ -5954,6 +6180,10 @@ declare type SortFilterBase<T extends XataRecord, Columns extends string = Colum
|
|
5954
6180
|
|
5955
6181
|
declare type SummarizeExpression<O extends XataRecord> = ExactlyOne<{
|
5956
6182
|
count: ColumnsByValue<O, any> | '*';
|
6183
|
+
min: ColumnsByValue<O, string | number | Date | any[]>;
|
6184
|
+
max: ColumnsByValue<O, string | number | Date | any[]>;
|
6185
|
+
sum: ColumnsByValue<O, number>;
|
6186
|
+
average: ColumnsByValue<O, number>;
|
5957
6187
|
}>;
|
5958
6188
|
declare type SummarizeParams<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>, Columns extends SelectableColumn<Record>[]> = {
|
5959
6189
|
summaries?: Expression;
|
@@ -5973,18 +6203,19 @@ declare type SummarizeExpressionResultTypes<Value> = {
|
|
5973
6203
|
min: Value;
|
5974
6204
|
max: Value;
|
5975
6205
|
sum: number;
|
5976
|
-
|
6206
|
+
average: number;
|
5977
6207
|
};
|
5978
6208
|
declare type SummarizeSort<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>> = SingleOrArray<SortFilter<Record, ColumnsByValue<Record, any> | StringKeys<Expression>>>;
|
5979
6209
|
declare type SummarizeValuePick<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>> = {
|
5980
6210
|
[K in StringKeys<Expression>]: StringKeys<Expression[K]> extends infer SummarizeOperation ? SummarizeOperation extends keyof Expression[K] ? Expression[K][SummarizeOperation] extends infer Column ? Column extends SelectableColumn<Record> ? SummarizeOperation extends keyof SummarizeExpressionResultTypes<any> ? SummarizeExpressionResultTypes<ValueAtColumn<Record, Column>>[SummarizeOperation] : never : never : never : never : never;
|
5981
6211
|
};
|
5982
|
-
declare type SummarizeFilter<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>> = Filter<Record
|
6212
|
+
declare type SummarizeFilter<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>> = Filter<Record & SummarizeValuePick<Record, Expression>>;
|
5983
6213
|
declare type SummarizeResultItem<Record extends XataRecord, Expression extends Dictionary<SummarizeExpression<Record>>, Columns extends SelectableColumn<Record>[]> = SummarizeValuePick<Record, Expression> & SelectedPick<Record, Columns>;
|
5984
6214
|
|
5985
6215
|
declare type BaseOptions<T extends XataRecord> = {
|
5986
6216
|
columns?: SelectableColumn<T>[];
|
5987
6217
|
cache?: number;
|
6218
|
+
fetchOptions?: Record<string, unknown>;
|
5988
6219
|
};
|
5989
6220
|
declare type CursorQueryOptions = {
|
5990
6221
|
pagination?: CursorNavigationOptions & OffsetNavigationOptions;
|
@@ -6226,17 +6457,17 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
6226
6457
|
*/
|
6227
6458
|
previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
6228
6459
|
/**
|
6229
|
-
* Retrieve
|
6460
|
+
* Retrieve start page of records
|
6230
6461
|
*
|
6231
6462
|
* @returns A new page object
|
6232
6463
|
*/
|
6233
|
-
|
6464
|
+
startPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
6234
6465
|
/**
|
6235
6466
|
* Retrieve last page of records
|
6236
6467
|
*
|
6237
6468
|
* @returns A new page object
|
6238
6469
|
*/
|
6239
|
-
|
6470
|
+
endPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
6240
6471
|
/**
|
6241
6472
|
* @returns Boolean indicating if there is a next page
|
6242
6473
|
*/
|
@@ -6254,8 +6485,8 @@ interface Paginable<Record extends XataRecord, Result extends XataRecord = Recor
|
|
6254
6485
|
records: RecordArray<Result>;
|
6255
6486
|
nextPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
6256
6487
|
previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
6257
|
-
|
6258
|
-
|
6488
|
+
startPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
6489
|
+
endPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
6259
6490
|
hasNextPage(): boolean;
|
6260
6491
|
}
|
6261
6492
|
/**
|
@@ -6288,19 +6519,19 @@ declare class Page<Record extends XataRecord, Result extends XataRecord = Record
|
|
6288
6519
|
*/
|
6289
6520
|
previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
6290
6521
|
/**
|
6291
|
-
* Retrieves the
|
6522
|
+
* Retrieves the start page of results.
|
6292
6523
|
* @param size Maximum number of results to be retrieved.
|
6293
6524
|
* @param offset Number of results to skip when retrieving the results.
|
6294
|
-
* @returns The
|
6525
|
+
* @returns The start page or results.
|
6295
6526
|
*/
|
6296
|
-
|
6527
|
+
startPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
6297
6528
|
/**
|
6298
|
-
* Retrieves the
|
6529
|
+
* Retrieves the end page of results.
|
6299
6530
|
* @param size Maximum number of results to be retrieved.
|
6300
6531
|
* @param offset Number of results to skip when retrieving the results.
|
6301
|
-
* @returns The
|
6532
|
+
* @returns The end page or results.
|
6302
6533
|
*/
|
6303
|
-
|
6534
|
+
endPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
6304
6535
|
/**
|
6305
6536
|
* Shortcut method to check if there will be additional results if the next page of results is retrieved.
|
6306
6537
|
* @returns Whether or not there will be additional results in the next page of results.
|
@@ -6308,9 +6539,9 @@ declare class Page<Record extends XataRecord, Result extends XataRecord = Record
|
|
6308
6539
|
hasNextPage(): boolean;
|
6309
6540
|
}
|
6310
6541
|
declare type CursorNavigationOptions = {
|
6311
|
-
|
6542
|
+
start?: string;
|
6312
6543
|
} | {
|
6313
|
-
|
6544
|
+
end?: string;
|
6314
6545
|
} | {
|
6315
6546
|
after?: string;
|
6316
6547
|
before?: string;
|
@@ -6343,17 +6574,17 @@ declare class RecordArray<Result extends XataRecord> extends Array<Result> {
|
|
6343
6574
|
*/
|
6344
6575
|
previousPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
|
6345
6576
|
/**
|
6346
|
-
* Retrieve
|
6577
|
+
* Retrieve start page of records
|
6347
6578
|
*
|
6348
6579
|
* @returns A new array of objects
|
6349
6580
|
*/
|
6350
|
-
|
6581
|
+
startPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
|
6351
6582
|
/**
|
6352
|
-
* Retrieve
|
6583
|
+
* Retrieve end page of records
|
6353
6584
|
*
|
6354
6585
|
* @returns A new array of objects
|
6355
6586
|
*/
|
6356
|
-
|
6587
|
+
endPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
|
6357
6588
|
/**
|
6358
6589
|
* @returns Boolean indicating if there is a next page
|
6359
6590
|
*/
|
@@ -7169,6 +7400,7 @@ declare type BaseClientOptions = {
|
|
7169
7400
|
branch?: BranchStrategyOption;
|
7170
7401
|
cache?: CacheImpl;
|
7171
7402
|
trace?: TraceFunction;
|
7403
|
+
enableBrowser?: boolean;
|
7172
7404
|
};
|
7173
7405
|
declare const buildClient: <Plugins extends Record<string, XataPlugin> = {}>(plugins?: Plugins | undefined) => ClientConstructor<Plugins>;
|
7174
7406
|
interface ClientConstructor<Plugins extends Record<string, XataPlugin>> {
|
@@ -7293,4 +7525,4 @@ declare class XataError extends Error {
|
|
7293
7525
|
constructor(message: string, status: number);
|
7294
7526
|
}
|
7295
7527
|
|
7296
|
-
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, AggregateTableError, AggregateTablePathParams, AggregateTableRequestBody, AggregateTableVariables, ApiExtraProps, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, ColumnsByValue, CompareBranchSchemasError, CompareBranchSchemasPathParams, 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, DEPRECATEDcreateDatabaseError, DEPRECATEDcreateDatabasePathParams, DEPRECATEDcreateDatabaseRequestBody, DEPRECATEDcreateDatabaseResponse, DEPRECATEDcreateDatabaseVariables, DEPRECATEDdeleteDatabaseError, DEPRECATEDdeleteDatabasePathParams, DEPRECATEDdeleteDatabaseResponse, DEPRECATEDdeleteDatabaseVariables, DEPRECATEDgetDatabaseListError, DEPRECATEDgetDatabaseListPathParams, DEPRECATEDgetDatabaseListVariables, DEPRECATEDgetDatabaseMetadataError, DEPRECATEDgetDatabaseMetadataPathParams, DEPRECATEDgetDatabaseMetadataVariables, DEPRECATEDupdateDatabaseMetadataError, DEPRECATEDupdateDatabaseMetadataPathParams, DEPRECATEDupdateDatabaseMetadataRequestBody, DEPRECATEDupdateDatabaseMetadataVariables, DeleteBranchError, DeleteBranchPathParams, DeleteBranchResponse, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseResponse, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableResponse, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchSchemaHistoryError, GetBranchSchemaHistoryPathParams, GetBranchSchemaHistoryRequestBody, GetBranchSchemaHistoryResponse, GetBranchSchemaHistoryVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, 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, Serializer, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, SummarizeTableError, SummarizeTablePathParams, SummarizeTableRequestBody, SummarizeTableVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, UpdateBranchSchemaVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, 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, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, buildClient, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, dEPRECATEDcreateDatabase, dEPRECATEDdeleteDatabase, dEPRECATEDgetDatabaseList, dEPRECATEDgetDatabaseMetadata, dEPRECATEDupdateDatabaseMetadata, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, 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, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID };
|
7528
|
+
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, AggregateTableError, AggregateTablePathParams, AggregateTableRequestBody, AggregateTableVariables, ApiExtraProps, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BranchTransactionError, BranchTransactionPathParams, BranchTransactionRequestBody, BranchTransactionVariables, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, ColumnsByValue, CompareBranchSchemasError, CompareBranchSchemasPathParams, 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, DEPRECATEDcreateDatabaseError, DEPRECATEDcreateDatabasePathParams, DEPRECATEDcreateDatabaseRequestBody, DEPRECATEDcreateDatabaseResponse, DEPRECATEDcreateDatabaseVariables, DEPRECATEDdeleteDatabaseError, DEPRECATEDdeleteDatabasePathParams, DEPRECATEDdeleteDatabaseResponse, DEPRECATEDdeleteDatabaseVariables, DEPRECATEDgetDatabaseListError, DEPRECATEDgetDatabaseListPathParams, DEPRECATEDgetDatabaseListVariables, DEPRECATEDgetDatabaseMetadataError, DEPRECATEDgetDatabaseMetadataPathParams, DEPRECATEDgetDatabaseMetadataVariables, DEPRECATEDupdateDatabaseMetadataError, DEPRECATEDupdateDatabaseMetadataPathParams, DEPRECATEDupdateDatabaseMetadataRequestBody, DEPRECATEDupdateDatabaseMetadataVariables, DeleteBranchError, DeleteBranchPathParams, DeleteBranchResponse, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseResponse, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableResponse, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchSchemaHistoryError, GetBranchSchemaHistoryPathParams, GetBranchSchemaHistoryRequestBody, GetBranchSchemaHistoryResponse, GetBranchSchemaHistoryVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, 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, Serializer, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, SummarizeTableError, SummarizeTablePathParams, SummarizeTableRequestBody, SummarizeTableVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, UpdateBranchSchemaVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, 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, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, branchTransaction, buildClient, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, dEPRECATEDcreateDatabase, dEPRECATEDdeleteDatabase, dEPRECATEDgetDatabaseList, dEPRECATEDgetDatabaseMetadata, dEPRECATEDupdateDatabaseMetadata, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, 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, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID };
|