@xata.io/client 0.0.0-alpha.vf7fccd9 → 0.0.0-alpha.vf882519

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 CHANGED
@@ -1,5 +1,149 @@
1
1
  # @xata.io/client
2
2
 
3
+ ## 0.21.3
4
+
5
+ ### Patch Changes
6
+
7
+ - [#792](https://github.com/xataio/client-ts/pull/792) [`6c96da45`](https://github.com/xataio/client-ts/commit/6c96da4533500ec236547f47310e99461d5457e8) Thanks [@SferaDev](https://github.com/SferaDev)! - Update workers return type helper
8
+
9
+ ## 0.21.2
10
+
11
+ ### Patch Changes
12
+
13
+ - [#787](https://github.com/xataio/client-ts/pull/787) [`93f5beed`](https://github.com/xataio/client-ts/commit/93f5beed77785b03409c614f5e2c3eca4c69c574) Thanks [@SferaDev](https://github.com/SferaDev)! - Expose consistency options
14
+
15
+ - [#784](https://github.com/xataio/client-ts/pull/784) [`cbe0609e`](https://github.com/xataio/client-ts/commit/cbe0609ec9d6650030efbda712a1eb243287525d) Thanks [@SferaDev](https://github.com/SferaDev)! - Update resolveBranch behaviour
16
+
17
+ ## 0.21.1
18
+
19
+ ### Patch Changes
20
+
21
+ - [#781](https://github.com/xataio/client-ts/pull/781) [`fdfa47de`](https://github.com/xataio/client-ts/commit/fdfa47de93ec772170ff00a4341fc14434347df5) Thanks [@SferaDev](https://github.com/SferaDev)! - Send header to disable encoding
22
+
23
+ ## 0.21.0
24
+
25
+ ### Minor Changes
26
+
27
+ - [#757](https://github.com/xataio/client-ts/pull/757) [`7da604d2`](https://github.com/xataio/client-ts/commit/7da604d27990e20ecadba6122434fca563e6a8c9) Thanks [@SferaDev](https://github.com/SferaDev)! - Add promise pool for retries
28
+
29
+ ### Patch Changes
30
+
31
+ - [#764](https://github.com/xataio/client-ts/pull/764) [`b131040a`](https://github.com/xataio/client-ts/commit/b131040a2d142c4e71a2e586fbf05cd9295af9a1) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix bun
32
+
33
+ - [#759](https://github.com/xataio/client-ts/pull/759) [`7ea810dc`](https://github.com/xataio/client-ts/commit/7ea810dc083ec284447e3bd27bd0465f887481e6) Thanks [@SferaDev](https://github.com/SferaDev)! - Expose new transaction API
34
+
35
+ - [#767](https://github.com/xataio/client-ts/pull/767) [`d124cbfb`](https://github.com/xataio/client-ts/commit/d124cbfb93d3d591e79bbe9e94c4b6304d825e71) Thanks [@SferaDev](https://github.com/SferaDev)! - Remove formatVersion from schema
36
+
37
+ - [#767](https://github.com/xataio/client-ts/pull/767) [`d124cbfb`](https://github.com/xataio/client-ts/commit/d124cbfb93d3d591e79bbe9e94c4b6304d825e71) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix null value returning on date columns
38
+
39
+ - [#775](https://github.com/xataio/client-ts/pull/775) [`fb5ccdf9`](https://github.com/xataio/client-ts/commit/fb5ccdf9fa95c37d54fbc5d9c0bb45872c831609) Thanks [@SferaDev](https://github.com/SferaDev)! - Add missing target field to search
40
+
41
+ - [#760](https://github.com/xataio/client-ts/pull/760) [`4ae00036`](https://github.com/xataio/client-ts/commit/4ae00036b53c6c89e02a1fcfdd992f1a3c22892c) Thanks [@SferaDev](https://github.com/SferaDev)! - Add support for filters in boosters
42
+
43
+ - [#766](https://github.com/xataio/client-ts/pull/766) [`bdae6668`](https://github.com/xataio/client-ts/commit/bdae6668fb571d29f1b1068a54f6866a80d9b174) Thanks [@SferaDev](https://github.com/SferaDev)! - Remove beta for Workers
44
+
45
+ - [#771](https://github.com/xataio/client-ts/pull/771) [`9486bdcc`](https://github.com/xataio/client-ts/commit/9486bdccc0af567bc5f2e8f91592b0143c539c45) Thanks [@SferaDev](https://github.com/SferaDev)! - Add modifier for numeric booster
46
+
47
+ - [#771](https://github.com/xataio/client-ts/pull/771) [`9486bdcc`](https://github.com/xataio/client-ts/commit/9486bdccc0af567bc5f2e8f91592b0143c539c45) Thanks [@SferaDev](https://github.com/SferaDev)! - Add pagination to search
48
+
49
+ ## 0.20.2
50
+
51
+ ### Patch Changes
52
+
53
+ - [#756](https://github.com/xataio/client-ts/pull/756) [`27b73745`](https://github.com/xataio/client-ts/commit/27b737451227cf12774115ccb70649f6bbf76180) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix update method with id in payload
54
+
55
+ - [#726](https://github.com/xataio/client-ts/pull/726) [`47a1f878`](https://github.com/xataio/client-ts/commit/47a1f87850a7178dad656a16d2584eee6ce68f29) Thanks [@SferaDev](https://github.com/SferaDev)! - Use transactions API internally for bulk operations
56
+
57
+ - [#726](https://github.com/xataio/client-ts/pull/726) [`adde9b10`](https://github.com/xataio/client-ts/commit/adde9b10708182295dee07c203c7bf737806e49e) Thanks [@SferaDev](https://github.com/SferaDev)! - Allow sending bulk operations of more than the limit
58
+
59
+ ## 0.20.1
60
+
61
+ ### Patch Changes
62
+
63
+ - [#744](https://github.com/xataio/client-ts/pull/744) [`98298ca`](https://github.com/xataio/client-ts/commit/98298ca1312a2256ee3e9d2700a9f3d3e316abe5) Thanks [@xata-bot](https://github.com/xata-bot)! - Add deno entry point
64
+
65
+ ## 0.20.0
66
+
67
+ ### Minor Changes
68
+
69
+ - [#737](https://github.com/xataio/client-ts/pull/737) [`6cbeaa0`](https://github.com/xataio/client-ts/commit/6cbeaa00050b5aa99ab7c98052a906487263e026) Thanks [@SferaDev](https://github.com/SferaDev)! - Rename first to start and last to end in pagination
70
+
71
+ ### Patch Changes
72
+
73
+ - [#732](https://github.com/xataio/client-ts/pull/732) [`a5a9aa5`](https://github.com/xataio/client-ts/commit/a5a9aa59987faa1d3d701d7431b8a96031e01ac7) Thanks [@SferaDev](https://github.com/SferaDev)! - [Experimental] Allow passing fetch options in some queries
74
+
75
+ - [#735](https://github.com/xataio/client-ts/pull/735) [`c64b2eb`](https://github.com/xataio/client-ts/commit/c64b2eb9add70e75d419d418ab9608caac0dbfa1) Thanks [@SferaDev](https://github.com/SferaDev)! - Add support for default values
76
+
77
+ - [#730](https://github.com/xataio/client-ts/pull/730) [`485b217`](https://github.com/xataio/client-ts/commit/485b217079c4b2091d697e68622c48eddd130ceb) Thanks [@SferaDev](https://github.com/SferaDev)! - Add more summarize functions
78
+
79
+ - [#730](https://github.com/xataio/client-ts/pull/730) [`4d7499c`](https://github.com/xataio/client-ts/commit/4d7499ccbb135691350334fd8022f7a5da41c5f2) Thanks [@SferaDev](https://github.com/SferaDev)! - Add a check for browser execution
80
+
81
+ ## 0.19.1
82
+
83
+ ### Patch Changes
84
+
85
+ - [#723](https://github.com/xataio/client-ts/pull/723) [`ad5feeb`](https://github.com/xataio/client-ts/commit/ad5feebad5983f724ea4067b884bfae428447470) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix replace operation not hidden
86
+
87
+ ## 0.19.0
88
+
89
+ ### Minor Changes
90
+
91
+ - [#692](https://github.com/xataio/client-ts/pull/692) [`c14f431`](https://github.com/xataio/client-ts/commit/c14f431db020036ab2b059bcc52a5d56b321c8e7) Thanks [@SferaDev](https://github.com/SferaDev)! - Add multi region endpoint support
92
+
93
+ - [#692](https://github.com/xataio/client-ts/pull/692) [`c8def01`](https://github.com/xataio/client-ts/commit/c8def013e9e2d5b634cdb2850f757a0b3e9e0a6d) Thanks [@SferaDev](https://github.com/SferaDev)! - Update OpenAPI spec methods
94
+
95
+ ### Patch Changes
96
+
97
+ - [#667](https://github.com/xataio/client-ts/pull/667) [`f80f051`](https://github.com/xataio/client-ts/commit/f80f05118dd0588861b8229114a469f016ef77ac) Thanks [@SferaDev](https://github.com/SferaDev)! - Allow sending page size to summarize endpoint
98
+
99
+ - [#676](https://github.com/xataio/client-ts/pull/676) [`2e341e5`](https://github.com/xataio/client-ts/commit/2e341e5c6140f9c4ddd74e479049992c26c43ea2) Thanks [@SferaDev](https://github.com/SferaDev)! - Support TS 4.7+
100
+
101
+ - [#709](https://github.com/xataio/client-ts/pull/709) [`f2f749f`](https://github.com/xataio/client-ts/commit/f2f749f4c64246a303da8d4a617773fc55c1d021) Thanks [@SferaDev](https://github.com/SferaDev)! - Add ifVersion flag to insert/update/upsert operations
102
+
103
+ - [#709](https://github.com/xataio/client-ts/pull/709) [`f2f749f`](https://github.com/xataio/client-ts/commit/f2f749f4c64246a303da8d4a617773fc55c1d021) Thanks [@SferaDev](https://github.com/SferaDev)! - Add createOrReplace operation to repository
104
+
105
+ ## 0.18.6
106
+
107
+ ### Patch Changes
108
+
109
+ - [#662](https://github.com/xataio/client-ts/pull/662) [`4a41680`](https://github.com/xataio/client-ts/commit/4a416803761a1c944ef9a76b794020ead6c8f477) Thanks [@SferaDev](https://github.com/SferaDev)! - Remove wildcard columns from sorting and filtering
110
+
111
+ - [#303](https://github.com/xataio/client-ts/pull/303) [`ad0cccb`](https://github.com/xataio/client-ts/commit/ad0cccb11cd4f9bb4bd7e44672d3375821e700fe) Thanks [@gimenete](https://github.com/gimenete)! - Add profiles for host parsing
112
+
113
+ - [#662](https://github.com/xataio/client-ts/pull/662) [`e1d6add`](https://github.com/xataio/client-ts/commit/e1d6addf84c55648bc0d908887b6bd020b429801) Thanks [@SferaDev](https://github.com/SferaDev)! - Add aggregations support to the SDK
114
+
115
+ - [#662](https://github.com/xataio/client-ts/pull/662) [`4a41680`](https://github.com/xataio/client-ts/commit/4a416803761a1c944ef9a76b794020ead6c8f477) Thanks [@SferaDev](https://github.com/SferaDev)! - Add summarize endpoints to SDK
116
+
117
+ ## 0.18.5
118
+
119
+ ### Patch Changes
120
+
121
+ - [#656](https://github.com/xataio/client-ts/pull/656) [`2dc2f5a`](https://github.com/xataio/client-ts/commit/2dc2f5a45529b2ace9127d963fb30214298da2e0) Thanks [@SferaDev](https://github.com/SferaDev)! - Broaden type for AbortSignal
122
+
123
+ ## 0.18.4
124
+
125
+ ### Patch Changes
126
+
127
+ - [#650](https://github.com/xataio/client-ts/pull/650) [`b8d441f`](https://github.com/xataio/client-ts/commit/b8d441f80867322f41989d52c94bba230632782b) Thanks [@xata-bot](https://github.com/xata-bot)! - API: Rename listMigrationRequests to queryMigrationRequests
128
+
129
+ ## 0.18.3
130
+
131
+ ### Patch Changes
132
+
133
+ - [#639](https://github.com/xataio/client-ts/pull/639) [`50fb3c0`](https://github.com/xataio/client-ts/commit/50fb3c0a1cffd03a16cc8b1b21454ea816f2edbb) Thanks [@SferaDev](https://github.com/SferaDev)! - Do not return null for columns not selected
134
+
135
+ ## 0.18.2
136
+
137
+ ### Patch Changes
138
+
139
+ - [#635](https://github.com/xataio/client-ts/pull/635) [`713f9b2`](https://github.com/xataio/client-ts/commit/713f9b2773be99c17d3fcb663e24fe096fa3da48) Thanks [@SferaDev](https://github.com/SferaDev)! - [Search] Add target columns
140
+
141
+ ## 0.18.1
142
+
143
+ ### Patch Changes
144
+
145
+ - [#627](https://github.com/xataio/client-ts/pull/627) [`ad0a5b4`](https://github.com/xataio/client-ts/commit/ad0a5b4bc87b82fdc10008a8ea324a8ca783e678) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix some cases where filters on link and multiple column types are not working
146
+
3
147
  ## 0.18.0
4
148
 
5
149
  ### Minor Changes
package/README.md CHANGED
@@ -112,18 +112,18 @@ const user = await xata.db.users.create({
112
112
  });
113
113
  ```
114
114
 
115
- If you want to create a record with a specific ID, you can invoke `insert()`.
115
+ If you want to create a record with a specific ID, you can provide the id as parameter to the `create()` method.
116
116
 
117
117
  ```ts
118
- const user = await xata.db.users.insert('user_admin', {
118
+ const user = await xata.db.users.create('user_admin', {
119
119
  fullName: 'John Smith'
120
120
  });
121
121
  ```
122
122
 
123
- And if you want to create or insert a record with a specific ID, you can invoke `updateOrInsert()`.
123
+ And if you want to create or update a record with a specific ID, you can invoke `createOrUpdate()` with an id parameter.
124
124
 
125
125
  ```ts
126
- const user = await xata.db.users.updateOrInsert('user_admin', {
126
+ const user = await xata.db.users.createOrUpdate('user_admin', {
127
127
  fullName: 'John Smith'
128
128
  });
129
129
  ```
@@ -187,8 +187,8 @@ page.hasNextPage(); // Boolean
187
187
 
188
188
  const nextPage = await page.nextPage(); // Page object
189
189
  const previousPage = await page.previousPage(); // Page object
190
- const firstPage = await page.firstPage(); // Page object
191
- const lastPage = await page.lastPage(); // Page object
190
+ const startPage = await page.startPage(); // Page object
191
+ const endPage = await page.endPage(); // Page object
192
192
  ```
193
193
 
194
194
  If you want to use an iterator, both the Repository and the Query classes implement an `AsyncIterable`. Alternatively you can use `getIterator()` and customize the batch size of the iterator:
@@ -247,7 +247,7 @@ Once you have initialized the API client, the operations are organized following
247
247
 
248
248
  ```ts
249
249
  const { id: workspace } = await api.workspaces.createWorkspace({ name: 'example' });
250
- const { databaseName } = await api.databases.createDatabase(workspace, 'database');
250
+ const { databaseName } = await api.database.createDatabase(workspace, 'database', { region: 'eu-west-1' });
251
251
 
252
252
  await api.branches.createBranch(workspace, databaseName, 'branch');
253
253
  await api.tables.createTable(workspace, databaseName, 'branch', 'table');
package/Usage.md CHANGED
@@ -329,8 +329,8 @@ It contains:
329
329
  - `hasNextPage`: Function that returns a boolean indicating if there is a next page.
330
330
  - `nextPage`: Async function that can be used to get the next page.
331
331
  - `previousPage`: Async function that can be used to get the previous page.
332
- - `firstPage`: Async function that can be used to get the first page.
333
- - `lastPage`: Async function that can be used to get the last page.
332
+ - `startPage`: Async function that can be used to get the start page.
333
+ - `endPage`: Async function that can be used to get the end page.
334
334
  - `meta`: Information about the current page and its cursor.
335
335
 
336
336
  ```ts
@@ -344,14 +344,14 @@ page2.records; // Array of `XataRecord` objects.
344
344
  const page1 = await page2.previousPage();
345
345
  page1.records; // Array of `XataRecord` objects.
346
346
 
347
- const firstPage = await page1.firstPage();
348
- firstPage.records; // Array of `XataRecord` objects.
347
+ const startPage = await page1.startPage();
348
+ startPage.records; // Array of `XataRecord` objects.
349
349
  ```
350
350
 
351
351
  The `Repository` class implements the `Query` interface, so you can use it to paginate the records in the table too.
352
352
 
353
353
  ```ts
354
- const page = await xata.db.users.firstPage();
354
+ const page = await xata.db.users.startPage();
355
355
  page.records; // Array of `XataRecord` objects.
356
356
  ```
357
357