Skip to content

Commit

Permalink
add request timeout info to wix data api
Browse files Browse the repository at this point in the history
  • Loading branch information
idanlib-wix committed Jul 28, 2024
1 parent d22e659 commit 12f0f21
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions wix-data-v2/wix-data-v2/Items/guides/data-items-1-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,23 @@ The Data Items API allows you to access and manage items in a Wix site's data co

With the Data Items API, you can:

+ Create and manage data items in a site's collections.
+ Retrieve data items from a collection individually or with filtering and sorting queries.
+ Create and manage reference fields.
+ Perform aggregations and calculations on data in collections.
+ Truncate a data collection, removing all its contents.
- Create and manage data items in a site's collections.
- Retrieve data items from a collection individually or with filtering and sorting queries.
- Create and manage reference fields.
- Perform aggregations and calculations on data in collections.
- Truncate a data collection, removing all its contents.

The Data Items API only works with existing collections. To create and manage data collections, use the [Data Collections API](https://www.wix.com/velo/reference/wix-data-v2/collections).

## Before you begin

It's important to note the following points before starting to code:

+ The maximum size of an item you can save to a collection is 500 kb.
+ We don't recommend updating a data item more than once per second.
+ When using data retrieval functions such as [`queryDataItems()`](https://www.wix.com/velo/reference/wix-data-v2/items/querydataitems) or [`getDataItem()`](https://www.wix.com/velo/reference/wix-data-v2/items/getdataitem) following an update to a collection's data, the data retrieved may not yet contain the most recent changes. See [Wix Data and Eventual Consistency](https://www.wix.com/velo/reference/wix-data-v2/eventual-consistency) for more information and instructions for overriding this.
+ When querying Wix App Collections, check which fields can be filtered in the relevant collection field article.
+ Updating a data item replaces the existing item entirely. If the existing item had fields with values and those fields aren't included in the updated item, the values in those properties are lost.
+ Aggregations can't be performed on Wix App collections.
+ After connecting external database collections to a Wix site using the [External Database Connections API](https://www.wix.com/velo/reference/wix-data-v2/externaldatabaseconnections), you can use the Data Items API to manage and retrieve data from those collections as if they were Wix Data collections.
- The maximum size of an item you can save to a collection is 500 kb.
- We don't recommend updating a data item more than once per second.
- When using data retrieval functions such as [`queryDataItems()`](https://www.wix.com/velo/reference/wix-data-v2/items/querydataitems) or [`getDataItem()`](https://www.wix.com/velo/reference/wix-data-v2/items/getdataitem) following an update to a collection's data, the data retrieved may not yet contain the most recent changes. See [Wix Data and Eventual Consistency](https://www.wix.com/velo/reference/wix-data-v2/eventual-consistency) for more information and instructions for overriding this.
- When your site makes a data request, it may take some time to receive a response. Wix Data places limits on how long a response can take before the [request times out](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/data-api/working-with-wix-data#request-timeouts). If the response time exceeds this limit, Wix Data returns an error instead of the intended result.
- When querying Wix App Collections, check which fields can be filtered in the relevant collection field article.
- Updating a data item replaces the existing item entirely. If the existing item had fields with values and those fields aren't included in the updated item, the values in those properties are lost.
- Aggregations can't be performed on Wix App collections.
- After connecting external database collections to a Wix site using the [External Database Connections API](https://www.wix.com/velo/reference/wix-data-v2/externaldatabaseconnections), you can use the Data Items API to manage and retrieve data from those collections as if they were Wix Data collections.

0 comments on commit 12f0f21

Please sign in to comment.