{"id":"77eed031-b32f-4a2a-ac09-25c51539492a","createdDate":"2024-10-10T09:04:48.744Z","updatedDate":"2024-10-10T09:04:48.744Z","resourceId":"963a94da-6231-4ab9-88c7-1149bd7c1b06","sdk":{"schema":{"name":"velo_wix-data","fqn":"","slug":"velo-wix-data","typesMap":{"WixDataAggregate.WixDataAggregate":{"name":"WixDataAggregate","fqn":"WixDataAggregate.WixDataAggregate","slug":"wix-data-aggregate","actions":[{"name":"ascending","fqn":"WixDataAggregate.WixDataAggregate.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort."}],"description":"Adds a sort to an aggregation, sorting by the items or groups by the specified properties in ascending order.\r\n\r\nThe `ascending()` function refines a `WixDataAggregate` to sort the resulting\r\n items or groups in ascending order. If you specify more than one property,\r\n `ascending()` sorts the results in ascending order by each property in the\r\n order they are listed.\r\n\r\n You can sort the following types:\r\n\r\n + Number: Sorts numerically.\r\n + Date: Sorts by date and time.\r\n + String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n + Reference: Compares by the ID of the referenced item as a String.\r\n\r\n\r\n If a property contains a number as a String, that value will be sorted\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified sort property are ranked lowest.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"avg","fqn":"WixDataAggregate.WixDataAggregate.avg","slug":"avg","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property in which to find the average value."},{"name":"projectedName","slug":"projected-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the property in the aggregation results containing the average value."}],"description":"Refines a `WixDataAggregate` to only contain the average value from each aggregation group.\r\n\r\nThe `avg()` function refines a `WixDataAggregate` to contain the average\r\n value from the specified property for each aggregated group or from the\r\n whole collection if no group is defined.\r\n\r\n When the aggregation is [run](#run), the returned `WixDataAggregateResult`\r\n object contains an item for each group with the following key:value pairs:\r\n\r\n + If a value was passed for the optional `projectedName`, the key is named\r\n using that value. Otherwise, the key is named using the following format:\r\n `\"propertyNameAvg\"`, where `propertyName` is the name of the specified property.\r\n + The value is the average of the values found in the specified property.\r\n\r\n\r\n Averages can only be calculated on properties of type Number.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"count","fqn":"WixDataAggregate.WixDataAggregate.count","slug":"count","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"description":"Refines a `WixDataAggregate` to contain the item count of each group in the aggregation.\r\n\r\nThe `count()` function refines a `WixDataAggregate` to contain the item\r\n count in each of the aggregate's groups.\r\n\r\n When the aggregation is [run](#run), the returned `WixDataAggregateResult`\r\n object contains items with the following additional key:value pair:\r\n\r\n + The key is named `\"count\"`.\r\n + The value is the count of items aggregated in the group.\r\n\r\n\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"descending","fqn":"WixDataAggregate.WixDataAggregate.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort."}],"description":"Adds a sort to an aggregation, sorting by the items or groups by the specified properties in descending order.\r\n\r\nThe `descending()` function refines a `WixDataAggregate` to sort the resulting\r\n items or groups in descending order. If you specify more than one property,\r\n `descending()` sorts the results in descending order by each property in the\r\n order they are listed.\r\n\r\n You can sort the following types:\r\n\r\n + Number: Sorts numerically.\r\n + Date: Sorts by date and time.\r\n + String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n + Reference: Compares by the ID of the referenced item as a String.\r\n\r\n\r\n If a property contains a number as a String, that value will be sorted\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified sort property are ranked lowest.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"filter","fqn":"WixDataAggregate.WixDataAggregate.filter","slug":"filter","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["filter"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"actionParams":[{"name":"filter","slug":"filter","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataFilter","referenceFqn":"WixDataFilter.WixDataFilter"},"description":"The filter to use to filter out items from being used in the aggregation."}],"description":"Filters out items from being used in an aggregation.\r\n\r\nThe `filter()` function refines a `WixDataAggregate` so that it only\r\n includes items from the aggregate's collection which match the specified\r\n filter criteria.\r\n\r\n To create a filter, use the wix-data [`filter()`](wix-data.html#filter) function.\r\n\r\n Filtering using `filter()` takes place before grouping is performed on the\r\n aggregation. To filter grouped results, use the [`having()`](#having) function.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"group","fqn":"WixDataAggregate.WixDataAggregate.group","slug":"group","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The property or properties to group on."}],"description":"Groups items together in an aggregation.\r\n\r\nThe `group()` function refines a `WixDataAggregate` so that its items are\r\n grouped by the specified property or properties.\r\n\r\n You can perform aggregations on the groups using the following functions:\r\n\r\n + [`avg()`](#avg)\r\n + [`count()`](#count)\r\n + [`max()`](#max)\r\n + [`min()`](#min)\r\n + [`sum()`](#sum)\r\n\r\n\r\n To filter grouped results, use the [`having()`](#having) function.\r\n > **Notes:** \r\n > + Aggregations can only be used on collections you have created. They cannot be used on [Wix App Collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code).\r\n > + You can only call the `group()` function once per aggregate query."},{"name":"having","fqn":"WixDataAggregate.WixDataAggregate.having","slug":"having","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["filter"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"actionParams":[{"name":"filter","slug":"filter","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataFilter","referenceFqn":"WixDataFilter.WixDataFilter"},"description":"The filter to use to filter out groups from being returned from the aggregation."}],"description":"Filters out groups from being returned from an aggregation.\r\n\r\nThe `having()` function refines a `WixDataAggregate` so that it only\r\n includes groups from the aggregate's grouping which match the specified\r\n filter criteria.\r\n\r\n To create a filter, use the wix-data [`filter()`](wix-data.html#filter) function.\r\n\r\n Filtering using `having()` takes place after grouping is performed on the\r\n aggregation. To filter items before grouping, use the [`filter()`](#filter) function.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"limit","fqn":"WixDataAggregate.WixDataAggregate.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["limit"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items or groups to return."}],"description":"Limits the number of items or groups the aggregation returns.\r\n\r\nThe `limit()` function defines the number of results an aggregation returns in each\r\n page. Only one page of results is retreived at a time. The [`next()`](wix-data.WixDataQueryResult.html)\r\n function is used to navigate the pages of a query result.\r\n\r\n By default, `limit` is set to `50`.\r\n\r\n The maximum value that `limit()` can accept is `1000`.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"max","fqn":"WixDataAggregate.WixDataAggregate.max","slug":"max","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property in which to find the maximum value."},{"name":"projectedName","slug":"projected-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the property in the aggregation results containing the maximum value."}],"description":"Refines a `WixDataAggregate` to only contain the maximum value from each aggregation group.\r\n\r\nThe `max()` function refines a `WixDataAggregate` to contain the maximum\r\n value from the specified property for each aggregated group or from the\r\n whole collection if no group is defined.\r\n\r\n When the aggregation is [run()](wix-data.WixDataAggregate.html#run), the returned `WixDataAggregateResult`\r\n object contains an item for each group with the following key:value pairs:\r\n\r\n + If a value was passed for the optional `projectedName`, the key is named\r\n using that value. Otherwise, the key is named using the following format:\r\n `\"propertyNameMax\"`, where `propertyName` is the name of the specified property.\r\n + The value is the maximum value found in the specified property.\r\n\r\n\r\n The following types of properties can be compared to determine a maximum value:\r\n\r\n + Number: Compares numerically.\r\n + Date and Time: Compares JavaScript Date objects.\r\n + Text: Compares lexicographically, so `\"text\"` is greater than `\"Text\"`.\r\n + Rich Text: Compares HTML source as text.\r\n + URL: Compares as text.\r\n + Image: Compares image source as text.\r\n + Video: Compares video source as text.\r\n + Document: Compares document source as text.\r\n + Reference: Compares by the ID of the referenced item as a String.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"min","fqn":"WixDataAggregate.WixDataAggregate.min","slug":"min","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property in which to find the minimum value."},{"name":"projectedName","slug":"projected-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the property in the aggregation results containing the minimum value."}],"description":"Refines a `WixDataAggregate` to only contain the minimum value from each aggregation group.\r\n\r\nThe `min()` function refines a `WixDataAggregate` to contain the minimum\r\n value from the specified property for each aggregated group or from the\r\n whole collection if no group is defined.\r\n\r\n When the aggregation is [run](#run), the returned `WixDataAggregateResult`\r\n object contains an item for each group with the following key:value pairs:\r\n\r\n + If a value was passed for the optional `projectedName`, the key is named\r\n using that value. Otherwise, the key is named using the following format:\r\n `\"propertyNameMin\"`, where `propertyName` is the name of the specified property.\r\n + The value is the minimum value found in the specified property.\r\n\r\n\r\n The following types of properties can be compared to determine a minimum value:\r\n\r\n + Number: Compares numerically.\r\n + Date and Time: Compares JavaScript Date objects.\r\n + Text: Compares lexicographically, so `\"text\"` is greater than `\"Text\"`.\r\n + Rich Text: Compares HTML source as text.\r\n + URL: Compares as text.\r\n + Image: Compares image source as text.\r\n + Video: Compares video source as text.\r\n + Document: Compares document source as text.\r\n + Reference: Compares by the ID of the referenced item as a String.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"run","fqn":"WixDataAggregate.WixDataAggregate.run","slug":"run","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataAggregateResult","referenceFqn":"WixDataAggregateResult.WixDataAggregateResult"},"description":"Fulfilled - A Promise that resolves to the results of the aggregation.\r\nRejected - Error that caused the aggregation to fail."},"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RunOptions","referenceFqn":"WixDataAggregate.RunOptions"},"description":"Options to use when running an aggregation."}],"description":"Runs the aggregation and returns the results.\r\n\r\nThe `run()` function returns a Promise that resolves to the results found\r\n by the aggregation and some information about the results.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"skip","fqn":"WixDataAggregate.WixDataAggregate.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["skip"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items or groups to skip in the aggregation results before returning the results."}],"description":"Sets the number of items or groups to skip before returning aggregation results.\r\n\r\nThe `skip()` function defines the number of results to skip in the aggregation\r\n results before returning new aggregation results.\r\n\r\n For example, if you perform an aggregation on a collection and 10 groups match\r\n your aggregation, but you set `skip` to 3, the results returned will skip\r\n the first 3 groups that match and return the 4th through 10th items.\r\n\r\n By default, `skip` is set to 0.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"sum","fqn":"WixDataAggregate.WixDataAggregate.sum","slug":"sum","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property in which to find the sum."},{"name":"projectedName","slug":"projected-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the property in the aggregation results containing the sum."}],"description":"Refines a `WixDataAggregate` to contain the sum from each aggregation group.\r\n\r\nThe `sum()` function refines a `WixDataAggregate` to contain the sum of the\r\n values from the specified property for each aggregated group or from the\r\n whole collection if no group is defined.\r\n\r\n When the aggregation is [run](#run), the returned `WixDataAggregateResult`\r\n object contains an item for each group with the following key:value pairs:\r\n\r\n + If a value was passed for the optional `projectedName`, the key is named\r\n using that value. Otherwise, the key is named using the following format:\r\n `\"propertyNameSum\"`, where `propertyName` is the name of the specified property.\r\n + The value is the sum of the values found in the specified property.\r\n\r\n\r\n Sums can only be calculated on properties of type Number.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."}],"properties":[]},"WixDataFilter.WixDataFilter":{"name":"WixDataFilter","fqn":"WixDataFilter.WixDataFilter","slug":"wix-data-filter","actions":[{"name":"and","fqn":"WixDataFilter.WixDataFilter.and","slug":"and","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery"},"description":"A query to add to the initial query as an `and` condition."}],"description":"Adds an `and` condition to the query or filter.\r\n\r\nThe `and()` function adds an `and` condition to a `WixDataQuery` or `WixDataFilter`.\r\n A query or filter with an `and` returns all the items that match the query\r\n or filter as defined up to the `and` function and also match the query or\r\n filter passed to the `and` function.\r\n\r\n Note that when chaining multiple `WixDataFilter` functions to a query an `and` condition is assumed.\r\n In such cases, you do not need to add a call to the `and()` function.\r\n For example, this query returns results where status is active **and** age is\r\n greater than 25.\r\n\r\n ```javascript\r\n wixData.query(\"myCollection\")\r\n .eq(\"status\", \"active\")\r\n .gt(\"age\", 25);\r\n ```\r\n\r\n The `and()` function is needed when performing compound queries. For\r\n example, the final query in this set of queries returns results where status\r\n is either pending or rejected **and** age is either less than 25 or greater than 65.\r\n\r\n ```javascript\r\n let statusQuery = wixData.query(\"myCollection\")\r\n .eq(\"status\", \"pending\")\r\n .or(\r\n wixData.query(\"myCollection\")\r\n .eq(\"status\", \"rejected\")\r\n );\r\n\r\n let ageQuery = wixData.query(\"myCollection\")\r\n .lt(\"age\", 25)\r\n .or(\r\n wixData.query(\"myCollection\")\r\n .gt(\"age\", 65)\r\n );\r\n\r\n let statusAndAgeQuery = statusQuery.and(ageQuery);\r\n ```\r\n\r\n The collections referenced by both the initial query and the query passed\r\n to the `and` function must be the same.\r\n\r\n The 'and()' function is designed to work with 2 or more queries or filters.\r\n If you use it on its own, it will return all the items in a collection."},{"name":"between","fqn":"WixDataFilter.WixDataFilter.between","slug":"between","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","rangeStart","rangeEnd"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `rangeStart` and `rangeEnd`."},{"name":"rangeStart","slug":"range-start","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The beginning value of the range to match against."},{"name":"rangeEnd","slug":"range-end","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The ending value of the range to match against."}],"description":"Refines a query or filter to match items whose specified property value is within a specified range.\r\n\r\nThe `between()` function refines a `WixDataQuery` or `WixDataFilter` to only\r\n match items where the value of the specified property is greater than or equal\r\n to `rangeStart` and less than `rangeEnd`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically, so\r\n + `\"A\"` and `\"M\"` are between `\"A\"` and `\"Z\"`, but `\"a\"`, `\"m\"`, `\"z\"` and `\"Z\"` are not.\r\n + `\"A\"`, `\"M\"`, `\"Z\"`, and `\"a\"` are between `\"A\"` and `\"z\"`, but `\"z\"` is not."},{"name":"contains","fqn":"WixDataFilter.WixDataFilter.contains","slug":"contains","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","string"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with the string."},{"name":"string","slug":"string","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The string to look for inside the specified property value."}],"description":"Refines a query or filter to match items whose specified property value contains a specified string.\r\n\r\nThe `contains()` function refines a `WixDataQuery` or `WixDataFilter` to\r\n only match items where the value of the specified property contains the\r\n specified `string`. Matching with `contains()` is not case sensitive, so\r\n `\"text\"` does contain `\"Tex\"`.\r\n\r\n You can use `contains()` with a property whose value is a String or a Reference.\r\n For properties of type reference it is recommended that you use the [`eq()`](#eq)\r\n function instead of `contains()`. With properties that are References, `contains()`\r\n matches by the ID of the referenced item as a String."},{"name":"endsWith","fqn":"WixDataFilter.WixDataFilter.endsWith","slug":"ends-with","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","string"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with the string."},{"name":"string","slug":"string","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The string to look for at the end of the specified property value."}],"description":"Refines a query or filter to match items whose specified property value ends with a specified string.\r\n\r\nThe `endsWith()` function refines a `WixDataQuery` or `WixDataFilter` to only\r\n match items where the value of the specified property ends with the specified\r\n`string`. Matching with `endsWith()` is not case sensitive, so `\"TEXT\"` ends\r\n with `\"ext\"`.\r\n\r\n You can only use `endsWith()` with a property whose value is a String or Reference.\r\n When using a Reference, `endsWith()` matches by the ID of the referenced item as Strings."},{"name":"eq","fqn":"WixDataFilter.WixDataFilter.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value equals the specified value.\r\n\r\nThe `eq()` function refines a `WixDataQuery` or `WixDataFilter` to only\r\n match items where the value of the specified property equals the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n Matching strings with `eq()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\n If `propertyName` points to a collection field of type Array, `eq()` includes the item\r\n as long as at least one Array element matches the specified `value`."},{"name":"ge","fqn":"WixDataFilter.WixDataFilter.ge","slug":"ge","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value is greater than or equal to the specified value.\r\n\r\nThe `ge()` function refines a `WixDataQuery` or `WixDataFilter` to only\r\n match items where the value of the specified property is greater than or\r\n equal to the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically,\r\n so `\"abc\"` is greater than or equal to `\"ABC\"` (because of the greater than),\r\n but `\"ABC\"` is not greater than or equal to `\"abc\"`.\r\n + Reference: Compares by the ID of the referenced item as a String."},{"name":"gt","fqn":"WixDataFilter.WixDataFilter.gt","slug":"gt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object with the query definition, based on the supplied parameters."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value is greater than the specified value.\r\n\r\nThe `gt()` function refines a `WixDataQuery` or `WixDataFilter` to only match\r\n items where the value of the specified property is greater than the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically, so `\"text\"` is greater than `\"Text\"`.\r\n + Reference: Compares by the ID of the referenced item as a String."},{"name":"hasAll","fqn":"WixDataFilter.WixDataFilter.hasAll","slug":"has-all","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"any"}},{"kind":"DATE"}]},"description":"The values to match against."}],"description":"Refines a query or filter to match items whose specified property values equals all of the specified `value` parameters.\r\n\r\nThe `hasAll()` function refines a `WixDataQuery` or `WixDataFilter` to\r\n only match items where the value of the specified property equals all of\r\n the specified values.\r\n\r\n Matching strings with `hasAll()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\n If the value of the specified property is an array, `hasAll()` will match\r\n if there is a match in the elements of that array for all of the specified\r\n values.\r\n\r\n You can specify a list of values to match by providing an array of\r\n String, Number, or Date types as the `value` parameters."},{"name":"hasSome","fqn":"WixDataFilter.WixDataFilter.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"any"}},{"kind":"DATE"}]},"description":"The values to match against."}],"description":"Refines a query or filter to match items whose specified property value equals any of the specified `value` parameters.\r\n\r\nThe `hasSome()` function refines a `WixDataQuery` or `WixDataFilter` to\r\n only match items where the value of the specified property equals any of\r\n the specified values.\r\n\r\n Matching strings with `hasSome()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\n If the value of the specified property is an array, `hasSome()` will match\r\n if any of the elements of that array match any of the specified values.\r\n\r\n If the specified property contains multiple references, pass item IDs in the\r\n `value` property. In such a case, `hasSome()` will match if any of the\r\n multiple references match any of the specified ID values.\r\n\r\n You can specify a list of values to match by providing an array of\r\n String, Number, or Date types as the `value` parameters."},{"name":"isEmpty","fqn":"WixDataFilter.WixDataFilter.isEmpty","slug":"is-empty","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The the property in which to check for a value."}],"description":"Refines a query or filter to match items whose specified property does not exist or does not have any value.\r\n\r\nThe `isEmpty()` function refines a `WixDataQuery` or `WixDataFilter` to only match items where the\r\n value of the specified property is `null` or `undefined` or the property does\r\n not exist.\r\n\r\n If the property contains any value at all for a given item, including the\r\n empty string or an invalid value, that item will match the query."},{"name":"isNotEmpty","fqn":"WixDataFilter.WixDataFilter.isNotEmpty","slug":"is-not-empty","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property in which to check for a value."}],"description":"Refines a query or filter to match items whose specified property has any value.\r\n\r\nThe `isNotEmpty()` function refines a `WixDataQuery` or `WixDataFilter` to only match items where the\r\n value of the specified property is not `null` or `undefined`.\r\n\r\n If the property contains any value at all for a given item, including the\r\n empty string or an invalid value, that item will match the query."},{"name":"le","fqn":"WixDataFilter.WixDataFilter.le","slug":"le","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value is less than or equal to the specified value.\r\n\r\nThe `le()` function refines a `WixDataQuery` or `WixDataFilter` to only match\r\n items where the value of the specified property is less than or equal to the\r\n specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically,\r\n so `\"ABC\"` is less than or equal to `\"abc\"` (because of the less than),\r\n but `\"abc\"` is not less than or equal to `\"ABC\"`.\r\n + Reference: Compares by the ID of the referenced item as a String."},{"name":"lt","fqn":"WixDataFilter.WixDataFilter.lt","slug":"lt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object with the query definition, based on the supplied parameters."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value is less than the specified value.\r\n\r\nThe `lt()` function refines a `WixDataQuery` or `WixDataFilter` to only match\r\n items where the value of the specified property is less than the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically, so `\"Text\"` is less than `\"text\"`.\r\n + Reference: Compares by the ID of the referenced item as a String."},{"name":"ne","fqn":"WixDataFilter.WixDataFilter.ne","slug":"ne","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value does not equal the specified value.\r\n\r\nThe `ne()` function refines a `WixDataQuery` or `WixDataFilter` to only\r\n match items where the value of the specified property does not equal the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type is considered not equal to the same number stored as a Number type.\r\n\r\n Matching strings with `ne()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\n If the value of the `propertyName` property is an Array, `ne()` includes items\r\n in which none of the elements of the Array match the specified `value`."},{"name":"not","fqn":"WixDataFilter.WixDataFilter.not","slug":"not","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery"},"description":"A query to add to the initial query as a `not` condition."}],"description":"Adds a `not` condition to the query or filter.\r\n\r\nThe `not()` function adds a `not` condition to a `WixDataQuery` or `WixDataFilter`. A query or filter with a `not`\r\n returns all the items that match the query or filter as defined up to the `not`\r\n function, but don't match the query or filter passed to the `not` function.\r\n\r\n If the query or filter only contains a `not()` function, it returns all the items\r\n that don't match the query defined by the `not` method.\r\n\r\n The collections referenced by both the initial query and the query passed\r\n to the `not` function must be the same."},{"name":"or","fqn":"WixDataFilter.WixDataFilter.or","slug":"or","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery"},"description":"A query to add to the initial query as an `or` condition."}],"description":"Adds an `or` condition to the query or filter.\r\n\r\nThe `or()` function adds an inclusive `or` condition to a `WixDataQuery` or `WixDataFilter`. A query or filter\r\n with an `or` returns all the items that match the query or filter as defined up to\r\n the `or` function, the items that match the query or filter passed to the `or`\r\n function, and the items that match both.\r\n\r\n The collections used by both the initial query and the query passed\r\n to the `or` function must be the same.\r\n\r\n The 'or()' function is designed to work with 2 or more queries or filters.\r\n If you use it on its own, it will return all the items in a collection."},{"name":"startsWith","fqn":"WixDataFilter.WixDataFilter.startsWith","slug":"starts-with","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","string"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with the string."},{"name":"string","slug":"string","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The string to look for at the beginning of the specified property value."}],"description":"Refines a query or filter to match items whose specified property value starts with a specified string.\r\n\r\nThe `startsWith()` function refines a `WixDataQuery` or `WixDataFilter` to\r\n only match items where the value of the specified property starts with the\r\n defined `string`. Matching with `startsWith()` is not case sensitive, so `\"TEXT\"` starts\r\n with `\"tex\"`.\r\n\r\n You can only use `startsWith()` with a property whose value is a String or Reference.\r\n When using a Reference, `startsWith()` matches by the ID of the referenced item as Strings."}],"properties":[]},"WixDataQuery.WixDataQuery":{"name":"WixDataQuery","fqn":"WixDataQuery.WixDataQuery","slug":"wix-data-query","actions":[{"name":"and","fqn":"WixDataFilter.and","slug":"and","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an and to a query","content":"let newQuery = query1.and(query2);"},{"title":"Create two or queries, add an and, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nlet statusQuery = wixData.query(\"myCollection\")\n .eq(\"status\", \"pending\")\n .or(\n wixData.query(\"myCollection\")\n .eq(\"status\", \"rejected\")\n );\n\nlet ageQuery = wixData.query(\"myCollection\")\n .lt(\"age\", 25)\n .or(\n wixData.query(\"myCollection\")\n .gt(\"age\", 65)\n );\n\nstatusQuery.and(ageQuery)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n /*\n * For example, results contain items where age is:\n * 18\n * 21\n * 67\n * 90\n *\n * But not items where age is:\n * 25\n * 30\n * 40\n * 65\n */"}],"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery"},"description":"A query to add to the initial query as an `and` condition."}],"description":"Adds an `and` condition to the query or filter.\r\n\r\nThe `and()` function adds an `and` condition to a `WixDataQuery` or `WixDataFilter`.\r\n A query or filter with an `and` returns all the items that match the query\r\n or filter as defined up to the `and` function and also match the query or\r\n filter passed to the `and` function.\r\n\r\n Note that when chaining multiple `WixDataFilter` functions to a query an `and` condition is assumed.\r\n In such cases, you do not need to add a call to the `and()` function.\r\n For example, this query returns results where status is active **and** age is\r\n greater than 25.\r\n\r\n ```javascript\r\n wixData.query(\"myCollection\")\r\n .eq(\"status\", \"active\")\r\n .gt(\"age\", 25);\r\n ```\r\n\r\n The `and()` function is needed when performing compound queries. For\r\n example, the final query in this set of queries returns results where status\r\n is either pending or rejected **and** age is either less than 25 or greater than 65.\r\n\r\n ```javascript\r\n let statusQuery = wixData.query(\"myCollection\")\r\n .eq(\"status\", \"pending\")\r\n .or(\r\n wixData.query(\"myCollection\")\r\n .eq(\"status\", \"rejected\")\r\n );\r\n\r\n let ageQuery = wixData.query(\"myCollection\")\r\n .lt(\"age\", 25)\r\n .or(\r\n wixData.query(\"myCollection\")\r\n .gt(\"age\", 65)\r\n );\r\n\r\n let statusAndAgeQuery = statusQuery.and(ageQuery);\r\n ```\r\n\r\n The collections referenced by both the initial query and the query passed\r\n to the `and` function must be the same.\r\n\r\n The 'and()' function is designed to work with 2 or more queries or filters.\r\n If you use it on its own, it will return all the items in a collection."},{"name":"ascending","fqn":"WixDataQuery.WixDataQuery.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort."}],"description":"Adds a sort to a query or sort, sorting by the specified properties in ascending order.\r\n\r\nThe `ascending()` function refines a `WixDataQuery` or `WixDataSort` to sort in ascending order of\r\n the specified properties. If you specify more than one property,\r\n `ascending()` sorts the results in ascending order by each property in the\r\n order they are listed.\r\n\r\n You can sort the following types:\r\n\r\n + Number: Sorts numerically.\r\n + Date: Sorts by date and time.\r\n + String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n + Reference: Compares by the ID of the referenced item as a String.\r\n\r\n\r\n If a property contains a number as a String, that value will be sorted\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified sort property are ranked lowest."},{"name":"between","fqn":"WixDataFilter.between","slug":"between","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","rangeStart","rangeEnd"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a between filter to a query","content":"let newQuery = query.between(\"age\", 25, 65);"},{"title":"Create a query, add a between filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .between(\"age\", 25, 65)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a between filter and other filters, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .between(\"age\", 25, 65)\n .eq(\"status\", \"active\")\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `rangeStart` and `rangeEnd`."},{"name":"rangeStart","slug":"range-start","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The beginning value of the range to match against."},{"name":"rangeEnd","slug":"range-end","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The ending value of the range to match against."}],"description":"Refines a query or filter to match items whose specified property value is within a specified range.\r\n\r\nThe `between()` function refines a `WixDataQuery` or `WixDataFilter` to only\r\n match items where the value of the specified property is greater than or equal\r\n to `rangeStart` and less than `rangeEnd`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically, so\r\n + `\"A\"` and `\"M\"` are between `\"A\"` and `\"Z\"`, but `\"a\"`, `\"m\"`, `\"z\"` and `\"Z\"` are not.\r\n + `\"A\"`, `\"M\"`, `\"Z\"`, and `\"a\"` are between `\"A\"` and `\"z\"`, but `\"z\"` is not."},{"name":"contains","fqn":"WixDataFilter.contains","slug":"contains","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","string"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a contains filter to a query","content":"let newQuery = query.contains(\"description\", \"some words\");"},{"title":"Create a query, add a contains filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .contains(\"description\", \"some words\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a contains filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .contains(\"description\", \"some words\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with the string."},{"name":"string","slug":"string","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The string to look for inside the specified property value."}],"description":"Refines a query or filter to match items whose specified property value contains a specified string.\r\n\r\nThe `contains()` function refines a `WixDataQuery` or `WixDataFilter` to\r\n only match items where the value of the specified property contains the\r\n specified `string`. Matching with `contains()` is not case sensitive, so\r\n `\"text\"` does contain `\"Tex\"`.\r\n\r\n You can use `contains()` with a property whose value is a String or a Reference.\r\n For properties of type reference it is recommended that you use the [`eq()`](#eq)\r\n function instead of `contains()`. With properties that are References, `contains()`\r\n matches by the ID of the referenced item as a String."},{"name":"count","fqn":"WixDataQuery.WixDataQuery.count","slug":"count","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"number"},"description":"Fulfilled - The number of items that match the query.\r\nRejected - The errors that caused the rejection."},"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataOptions","referenceFqn":"WixDataOptions"},"description":"An object containing options to use when processing this operation."}],"description":"Returns the number of items that match the query.\r\n\r\nThe `count()` function returns a Promise that resolves to the number of\r\n items that match the query. The Promise is rejected if `count()` is called\r\n with incorrect permissions or if any of the functions used to refine the\r\n query is invalid.\r\n\r\n Calling the `count()` function triggers the [`beforeCount()`](wix-data.Hooks.html#beforeCount)\r\n and [`afterCount()`](wix-data.Hooks.html#afterCount) hooks if they have been defined.\r\n\r\n Use the `options` parameter to run `count()` without checking for permissions\r\n or without its registered hooks.\r\n\r\n Any function that does not filter query results (e.g., [`ascending()`](#ascending))\r\n does not affect the result of `count()`.\r\n\r\n If you build a query and don't refine it with any `WixDataQuery` functions,\r\n `count()` returns the total number of items in the collection.\r\n\r\n If you have already run a query with [`find()`](#find), you can retrieve\r\n the number of query results without calling `count()`. The [`find()`](#find)\r\n function returns a Promise that resolves to a [`WixDataQueryResult`](https://dev.wix.com/docs/velo/api-reference/wix-data/wix-data-query-result/introduction)\r\n object, which has a `totalCount` property whose value is the number of results."},{"name":"descending","fqn":"WixDataQuery.WixDataQuery.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort."}],"description":"Adds a sort to a query or sort, sorting by the specified properties in descending order.\r\n\r\nThe `descending()` function refines a `WixDataQuery` or `WixDataSort` to sort in descending order of\r\n the specified properties. If you specify more than one property,\r\n `descending()` sorts the results in descending order by each property in the\r\n order they are listed.\r\n\r\n You can sort the following types:\r\n\r\n + Number: Sorts numerically.\r\n + Date: Sorts by date and time.\r\n + String: Sorts lexicographically, so `\"abc\"` comes before `\"XYZ\"`.\r\n + Reference: Compares by the ID of the referenced item as a String.\r\n\r\n\r\n If a property contains a number as a String, that value will be sorted\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified sort property are ranked lowest."},{"name":"distinct","fqn":"WixDataQuery.WixDataQuery.distinct","slug":"distinct","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataQueryResult","referenceFqn":"WixDataQueryResult.WixDataQueryResult"},"description":"Fulfilled - A Promise that resolves to the results of the query.\r\nRejected - Error that caused the query to fail."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared for distinct values."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataQueryOptions","referenceFqn":"WixDataQueryOptions"},"description":"An object containing options to use when processing this operation."}],"description":"Returns the distinct values that match the query, without duplicates.\r\n\r\nThe `distinct()` function returns a Promise that resolves to:\r\n\r\n + The distinct values found in the specified field when running the query.\r\n + Additional information about the results, such as the number of values that match the query.\r\n\r\n\r\n Unlike `find()`, which returns all item objects that match the query, `distinct()` returns matching field values, and eliminates\r\n duplicate field values from the query result. You cannot use `find()` and `distinct()` together.\r\n\r\n For an item to be resolved as distinct, only the specified field must be distinct. Other fields for that item in the\r\n collection are not evaluated when resolving the promise.\r\n\r\n The Promise is rejected if `distinct()` is called with incorrect permissions or if any of the\r\n functions used to refine the query is invalid.\r\n\r\n >**Note:** Only site visitors with [Data Read](https://support.wix.com/en/article/collection-permissions-an-overview#permissions) permissions can retrieve and view data. You can override the permissions by setting the `suppressAuth` option to `true`."},{"name":"endsWith","fqn":"WixDataFilter.endsWith","slug":"ends-with","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","string"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an ends with filter to a query","content":"let newQuery = query.endsWith(\"last_name\", \"z\");"},{"title":"Create a query, add an ends with filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .endsWith(\"last_name\", \"z\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add an ends with filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .endsWith(\"last_name\", \"z\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with the string."},{"name":"string","slug":"string","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The string to look for at the end of the specified property value."}],"description":"Refines a query or filter to match items whose specified property value ends with a specified string.\r\n\r\nThe `endsWith()` function refines a `WixDataQuery` or `WixDataFilter` to only\r\n match items where the value of the specified property ends with the specified\r\n`string`. Matching with `endsWith()` is not case sensitive, so `\"TEXT\"` ends\r\n with `\"ext\"`.\r\n\r\n You can only use `endsWith()` with a property whose value is a String or Reference.\r\n When using a Reference, `endsWith()` matches by the ID of the referenced item as Strings."},{"name":"eq","fqn":"WixDataFilter.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an equals filter to a query","content":"let newQuery = query.eq(\"status\", \"active\");"},{"title":"Create a query, add an equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .eq(\"status\", \"active\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add an equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .eq(\"status\", \"active\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value equals the specified value.\r\n\r\nThe `eq()` function refines a `WixDataQuery` or `WixDataFilter` to only\r\n match items where the value of the specified property equals the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n Matching strings with `eq()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\n If `propertyName` points to a collection field of type Array, `eq()` includes the item\r\n as long as at least one Array element matches the specified `value`."},{"name":"fields","fqn":"WixDataQuery.WixDataQuery.fields","slug":"fields","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Properties to return. To return multiple properties,\r\npass properties as additional arguments."}],"description":"Lists the fields to return in a query's results.\r\n\r\nThe `fields()` function returns only the specified fields in the query's results.\r\n\r\n You can use [`include()`](#include) in conjunction with `fields()` to get referenced items.\r\n\r\n When `fields()` receives an empty or invalid property, the query behaves as follows:\r\n\r\n + When no fields are specified, the query returns all fields.\r\n + When multiple fields are specified but some are invalid, invalid fields are ignored and valid fields are returned.\r\n + When only invalid fields are specified, only the default `_id` field is returned."},{"name":"find","fqn":"WixDataQuery.WixDataQuery.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataQueryResult","referenceFqn":"WixDataQueryResult.WixDataQueryResult"},"description":"Fulfilled - A Promise that resolves to the results of the query.\r\nRejected - Error that caused the query to fail."},"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataQueryOptions","referenceFqn":"WixDataQueryOptions"},"description":"An object containing options to use when processing this operation."}],"description":"Returns the items that match the query.\r\n\r\nThe `find()` function returns a Promise that resolves to the results found\r\n by the query and some information about the results. The Promise is\r\n rejected if `find()` is called with incorrect permissions or if any of the\r\n functions used to refine the query is invalid.\r\n\r\n Calling the `find()` function triggers the [`beforeQuery()`](wix-data.Hooks.html#beforeQuery)\r\n and [`afterQuery()`](wix-data.Hooks.html#afterQuery) hooks if they have been defined.\r\n\r\n> **Note:**\r\n Calling `find()` triggers hooks for the specified collection only. It doesn’t trigger hooks for referenced collections.\r\n\r\n Use the `options` parameter to override default preferences:\r\n + Override permission checks with `suppressAuth`.\r\n + Ensure the most up-to-date data is retrieved with `consistentRead`.\r\n + Prevent hooks from running with `suppressHooks`.\r\n + Speed up execution with `omitTotalCount`, if you don't need a count of items matching the query.\r\n\r\n If you build a query and don't refine it with any `wixDataQuery` functions,\r\n `find()` returns the entire collection."},{"name":"ge","fqn":"WixDataFilter.ge","slug":"ge","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a greater than or equals filter to a query","content":"let newQuery = query.ge(\"age\", 25);"},{"title":"Create a query, add a greater than or equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .ge(\"age\", 25)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a greater than or equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .ge(\"age\", 25)\n .eq(\"status\", \"active\")\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value is greater than or equal to the specified value.\r\n\r\nThe `ge()` function refines a `WixDataQuery` or `WixDataFilter` to only\r\n match items where the value of the specified property is greater than or\r\n equal to the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically,\r\n so `\"abc\"` is greater than or equal to `\"ABC\"` (because of the greater than),\r\n but `\"ABC\"` is not greater than or equal to `\"abc\"`.\r\n + Reference: Compares by the ID of the referenced item as a String."},{"name":"gt","fqn":"WixDataFilter.gt","slug":"gt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object with the query definition, based on the supplied parameters."},"examples":[{"title":"Add a greater than filter to a query","content":"let newQuery = query.gt(\"age\", 25);"},{"title":"Create a query, add a greater than filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .gt(\"age\", 25)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a greater than filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .gt(\"age\", 25)\n .eq(\"status\", \"active\")\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value is greater than the specified value.\r\n\r\nThe `gt()` function refines a `WixDataQuery` or `WixDataFilter` to only match\r\n items where the value of the specified property is greater than the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically, so `\"text\"` is greater than `\"Text\"`.\r\n + Reference: Compares by the ID of the referenced item as a String."},{"name":"hasAll","fqn":"WixDataFilter.hasAll","slug":"has-all","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a has all filter to a query","content":"let newQuery = query.hasAll(\"sizes\", [30, 38, 42]);"},{"title":"Create a query, add a has all filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .hasAll(\"colors\", [\"red\", \"yellow\", \"blue\"])\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a has all filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .hasAll(\"colors\", [\"red\", \"yellow\", \"blue\"])\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"any"}},{"kind":"DATE"}]},"description":"The values to match against."}],"description":"Refines a query or filter to match items whose specified property values equals all of the specified `value` parameters.\r\n\r\nThe `hasAll()` function refines a `WixDataQuery` or `WixDataFilter` to\r\n only match items where the value of the specified property equals all of\r\n the specified values.\r\n\r\n Matching strings with `hasAll()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\n If the value of the specified property is an array, `hasAll()` will match\r\n if there is a match in the elements of that array for all of the specified\r\n values.\r\n\r\n You can specify a list of values to match by providing an array of\r\n String, Number, or Date types as the `value` parameters."},{"name":"hasSome","fqn":"WixDataFilter.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a has some filter to a query","content":"let newQuery = query.hasSome(\"sizes\", [30, 38, 42]);"},{"title":"Create a query, add a has some filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .hasSome(\"colors\", [\"red\", \"yellow\", \"blue\"])\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a has some filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .hasSome(\"colors\", [\"red\", \"yellow\", \"blue\"])\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Add a has some filter on a multiple reference field to a query","description":"This example gets the items from the **movies** collection that have a\n reference in the **authors** field to an item with an ID that is either\n **1357** or **2468**.","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"movies\")\n .hasSome(\"actors\", [\"1357\", \"2468\"])\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"any"}},{"kind":"DATE"}]},"description":"The values to match against."}],"description":"Refines a query or filter to match items whose specified property value equals any of the specified `value` parameters.\r\n\r\nThe `hasSome()` function refines a `WixDataQuery` or `WixDataFilter` to\r\n only match items where the value of the specified property equals any of\r\n the specified values.\r\n\r\n Matching strings with `hasSome()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\n If the value of the specified property is an array, `hasSome()` will match\r\n if any of the elements of that array match any of the specified values.\r\n\r\n If the specified property contains multiple references, pass item IDs in the\r\n `value` property. In such a case, `hasSome()` will match if any of the\r\n multiple references match any of the specified ID values.\r\n\r\n You can specify a list of values to match by providing an array of\r\n String, Number, or Date types as the `value` parameters."},{"name":"include","fqn":"WixDataQuery.WixDataQuery.include","slug":"include","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties for which to include referenced items."}],"description":"Includes referenced items for the specified properties in a query's results.\r\n\r\nThe `include()` function refines a query so that the items returned in the\r\n query's results include the full referenced items for the specified properties.\r\n\r\n For example, suppose you have a **books** collection with an **author**\r\n field that references an **authors** collection. Querying the **books**\r\n collection with an `include(\"author\")` returns the relevant book items\r\n and each item will include the full referenced author item in the book's\r\n `author` property.\r\n\r\n When querying a collection that contains a reference field without using the\r\n `include()` function:\r\n\r\n + Single reference field: returned items contain only the ID of the\r\n referenced item, and not the full referenced items.\r\n + Multiple reference field: returned items do not contain the multiple\r\n reference field at all.\r\n\r\n\r\n When including a property with multiple references, the following limitations\r\n apply:\r\n\r\n + Only one property with multiple references can be included.\r\n + The query will return an error if more than 50 items are returned, regardless\r\n of any query limit set using the [`limit()`](#limit) function.\r\n + Each returned item can include up to 50 referenced items. If there are more\r\n than 50 referenced items, only 50 are returned when the query is run\r\n and the [`partialIncludes`](wix-data.WixDataQueryResult.html#partialIncludes)\r\n property of the returned [`WixDataQueryResult`](wix-data.WixDataQueryResult.html)\r\n is `true`. To retrieve more than 50 referenced items, use the\r\n [`queryReferenced()`](wix-data.html#queryReferenced) function.\r\n\r\n\r\n For a discussion of when to use the similar [`queryReferenced()`](wix-data.html#queryReferenced)\r\n function and when to use `include()`, see [Querying Items that Reference Other Items](https://support.wix.com/en/article/including-referenced-data-when-filtering).\r\n\r\n > **Notes:**\r\n > - Calling the `include()` function does not trigger any hooks.\r\n > - The `include()` function is not supported for Single Item Collections."},{"name":"isEmpty","fqn":"WixDataFilter.isEmpty","slug":"is-empty","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an isEmpty filter to a query","content":"let newQuery = query.isEmpty(\"bio\");"},{"title":"Create a query, add an isEmpty filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .isEmpty(\"bio\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add an isEmpty filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .isEmpty(\"bio\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The the property in which to check for a value."}],"description":"Refines a query or filter to match items whose specified property does not exist or does not have any value.\r\n\r\nThe `isEmpty()` function refines a `WixDataQuery` or `WixDataFilter` to only match items where the\r\n value of the specified property is `null` or `undefined` or the property does\r\n not exist.\r\n\r\n If the property contains any value at all for a given item, including the\r\n empty string or an invalid value, that item will match the query."},{"name":"isNotEmpty","fqn":"WixDataFilter.isNotEmpty","slug":"is-not-empty","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an isNotEmpty filter to a query","content":"let newQuery = query.isNotEmpty(\"bio\");"},{"title":"Create a query, add an isNotEmpty filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .isNotEmpty(\"bio\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add an isNotEmpty filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .isNotEmpty(\"bio\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property in which to check for a value."}],"description":"Refines a query or filter to match items whose specified property has any value.\r\n\r\nThe `isNotEmpty()` function refines a `WixDataQuery` or `WixDataFilter` to only match items where the\r\n value of the specified property is not `null` or `undefined`.\r\n\r\n If the property contains any value at all for a given item, including the\r\n empty string or an invalid value, that item will match the query."},{"name":"le","fqn":"WixDataFilter.le","slug":"le","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a less than or equals filter to a query","content":"let newQuery = query.le(\"age\", 25);"},{"title":"Create a query, add a less than or equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .le(\"age\", 25)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a less than or equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .le(\"age\", 25)\n .eq(\"status\", \"active\")\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value is less than or equal to the specified value.\r\n\r\nThe `le()` function refines a `WixDataQuery` or `WixDataFilter` to only match\r\n items where the value of the specified property is less than or equal to the\r\n specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically,\r\n so `\"ABC\"` is less than or equal to `\"abc\"` (because of the less than),\r\n but `\"abc\"` is not less than or equal to `\"ABC\"`.\r\n + Reference: Compares by the ID of the referenced item as a String."},{"name":"limit","fqn":"WixDataQuery.WixDataQuery.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["limit"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items to return, which is also the [`pageSize`](wix-data.WixDataQueryResult.html#pageSize) of the results object."}],"description":"Limits the number of items the query returns.\r\n\r\nThe `limit()` function defines the number of results a query returns in each\r\n page. Only one page of results is retrieved at a time. The [`next()`](wix-data.WixDataQueryResult.html#next)\r\n and [`prev()`](wix-data.WixDataQueryResult.html#prev) functions are used to\r\n navigate the pages of a query result.\r\n\r\n By default, `limit` is set to `50`.\r\n\r\n The maximum value that `limit()` can accept is `1000`.\r\n\r\n Note that for some Wix app collections, the maximum value `limit()` can accept is\r\n less than `1000`. For example, the maximum limit for the Wix `Stores/Product` collection is 100."},{"name":"lt","fqn":"WixDataFilter.lt","slug":"lt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object with the query definition, based on the supplied parameters."},"examples":[{"title":"Add a less than filter to a query","content":"let newQuery = query.lt(\"age\", 25);"},{"title":"Create a query, add a less than filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .lt(\"age\", 25)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a less than filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .lt(\"age\", 25)\n .eq(\"status\", \"active\")\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value is less than the specified value.\r\n\r\nThe `lt()` function refines a `WixDataQuery` or `WixDataFilter` to only match\r\n items where the value of the specified property is less than the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically, so `\"Text\"` is less than `\"text\"`.\r\n + Reference: Compares by the ID of the referenced item as a String."},{"name":"ne","fqn":"WixDataFilter.ne","slug":"ne","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a not equals filter to a query","content":"let newQuery = query.ne(\"status\", \"active\");"},{"title":"Create a query, add a not equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .ne(\"status\", \"active\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a not equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .ne(\"status\", \"active\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value does not equal the specified value.\r\n\r\nThe `ne()` function refines a `WixDataQuery` or `WixDataFilter` to only\r\n match items where the value of the specified property does not equal the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type is considered not equal to the same number stored as a Number type.\r\n\r\n Matching strings with `ne()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\n If the value of the `propertyName` property is an Array, `ne()` includes items\r\n in which none of the elements of the Array match the specified `value`."},{"name":"not","fqn":"WixDataFilter.not","slug":"not","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a not to a query","content":"let newQuery = query1.not(query2);"},{"title":"Create a query, add a not, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .gt(\"age\", 25)\n .not(\n wixData.query(\"myCollection\")\n .eq(\"access_type\", \"restricted\")\n )\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery"},"description":"A query to add to the initial query as a `not` condition."}],"description":"Adds a `not` condition to the query or filter.\r\n\r\nThe `not()` function adds a `not` condition to a `WixDataQuery` or `WixDataFilter`. A query or filter with a `not`\r\n returns all the items that match the query or filter as defined up to the `not`\r\n function, but don't match the query or filter passed to the `not` function.\r\n\r\n If the query or filter only contains a `not()` function, it returns all the items\r\n that don't match the query defined by the `not` method.\r\n\r\n The collections referenced by both the initial query and the query passed\r\n to the `not` function must be the same."},{"name":"or","fqn":"WixDataFilter.or","slug":"or","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an or to a query","content":"let newQuery = query1.or(query2);"},{"title":"Create a query, add an or, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .lt(\"age\", 25)\n .or(\n wixData.query(\"myCollection\")\n .gt(\"age\", 65)\n )\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n /*\n * For example, results contain items where age is:\n * 18\n * 21\n * 67\n * 90\n *\n * But not items where age is:\n * 25\n * 30\n * 40\n * 65\n */"}],"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery"},"description":"A query to add to the initial query as an `or` condition."}],"description":"Adds an `or` condition to the query or filter.\r\n\r\nThe `or()` function adds an inclusive `or` condition to a `WixDataQuery` or `WixDataFilter`. A query or filter\r\n with an `or` returns all the items that match the query or filter as defined up to\r\n the `or` function, the items that match the query or filter passed to the `or`\r\n function, and the items that match both.\r\n\r\n The collections used by both the initial query and the query passed\r\n to the `or` function must be the same.\r\n\r\n The 'or()' function is designed to work with 2 or more queries or filters.\r\n If you use it on its own, it will return all the items in a collection."},{"name":"skip","fqn":"WixDataQuery.WixDataQuery.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["skip"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items to skip in the query results before returning the results."}],"description":"Sets the number of items to skip before returning query results.\r\n\r\nThe `skip()` function defines the number of results to skip in the query\r\n results before returning new query results.\r\n\r\n For example, if you query a collection and 50 items match your query, but\r\n you set `skip` to 10, the results returned will skip the first 10 items\r\n that match and return the 11th through 50th items.\r\n\r\n By default, `skip` is set to 0."},{"name":"startsWith","fqn":"WixDataFilter.startsWith","slug":"starts-with","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","string"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a starts with filter to a query","content":"let newQuery = query.startsWith(\"last_name\", \"M\");"},{"title":"Create a query, add a starts with filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .startsWith(\"last_name\", \"M\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a starts with filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .startsWith(\"last_name\", \"M\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with the string."},{"name":"string","slug":"string","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The string to look for at the beginning of the specified property value."}],"description":"Refines a query or filter to match items whose specified property value starts with a specified string.\r\n\r\nThe `startsWith()` function refines a `WixDataQuery` or `WixDataFilter` to\r\n only match items where the value of the specified property starts with the\r\n defined `string`. Matching with `startsWith()` is not case sensitive, so `\"TEXT\"` starts\r\n with `\"tex\"`.\r\n\r\n You can only use `startsWith()` with a property whose value is a String or Reference.\r\n When using a Reference, `startsWith()` matches by the ID of the referenced item as Strings."}],"properties":[]},"WixDataOptions":{"name":"WixDataOptions","fqn":"WixDataOptions","slug":"wix-data-options","actions":[],"properties":[{"name":"appOptions","slug":"app-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixStoresProductQuery","referenceFqn":"WixStoresProductQuery"},"description":"Optional filters specific to querying [Wix Stores Products Collection Fields](https://support.wix.com/en/article/velo-wix-stores-products-collection-fields)."},{"name":"consistentRead","slug":"consistent-read","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"When `true`, reads data from the primary database instance.\r\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\r\nSee [Wix Data and Eventual Consistency](https://www.wix.com/velo/reference/wix-data/introduction#wix-data_introduction_wix-data-and-eventual-consistency) for more information.\r\n\r\nDefault: `false`"},{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Fields to return for the item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.\r\n> **Note:** The `_id` system field is always returned."},{"name":"suppressAuth","slug":"suppress-auth","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Prevents [permission](https://support.wix.com/en/article/about-collection-permissions) checks from running for the operation. Defaults to `false`. Can only be used in backend code."},{"name":"suppressHooks","slug":"suppress-hooks","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Prevents [hooks](https://support.wix.com/en/article/wix-code-how-to-use-data-hooks) from running for the operation. Can only be used in backend code."}]},"WixStoresProductQuery":{"name":"WixStoresProductQuery","fqn":"WixStoresProductQuery","slug":"wix-stores-product-query","actions":[],"properties":[{"name":"includeHiddenProducts","slug":"include-hidden-products","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to include [hidden products](https://support.wix.com/en/article/wix-stores-changing-the-visibility-of-a-product) in the query. Default is `false`."},{"name":"includeVariants","slug":"include-variants","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to include product variants in the query. Default is `false`."}]},"WixDataQueryOptions":{"name":"WixDataQueryOptions","fqn":"WixDataQueryOptions","slug":"wix-data-query-options","actions":[],"properties":[{"name":"appOptions","slug":"app-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixStoresProductQuery","referenceFqn":"WixStoresProductQuery"},"description":"Optional filters specific to querying [Wix Stores Products Collection Fields](https://support.wix.com/en/article/velo-wix-stores-products-collection-fields)."},{"name":"consistentRead","slug":"consistent-read","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"When `true`, reads data from the primary database instance.\r\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\r\nSee [Wix Data and Eventual Consistency](https://www.wix.com/velo/reference/wix-data/introduction#wix-data_introduction_wix-data-and-eventual-consistency) for more information.\r\n\r\nDefault: `false`"},{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Fields to return for the item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.\r\n> **Note:** The `_id` system field is always returned."},{"name":"language","slug":"language","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\r\nIf provided, the result text is returned in the specified language. **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\r\nIf not provided, result text is not translated."},{"name":"omitTotalCount","slug":"omit-total-count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"When `true`, the query result does not include a `totalCount` property containing the total number of items matching the query.\r\nThis speeds up the query.\r\n\r\nDefault: `false`"},{"name":"suppressAuth","slug":"suppress-auth","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Prevents [permission](https://support.wix.com/en/article/about-collection-permissions) checks from running for the operation. Defaults to `false`. Can only be used in backend code."},{"name":"suppressHooks","slug":"suppress-hooks","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Prevents [hooks](https://support.wix.com/en/article/wix-code-how-to-use-data-hooks) from running for the operation. Can only be used in backend code."}]},"WixDataQueryResult.WixDataQueryResult":{"name":"WixDataQueryResult","fqn":"WixDataQueryResult.WixDataQueryResult","slug":"wix-data-query-result","actions":[{"name":"hasNext","fqn":"WixDataQueryResult.WixDataQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"description":"Indicates if the query has more results."},{"name":"hasPrev","fqn":"WixDataQueryResult.WixDataQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are previous results."},"description":"Indicates the query has previous results."},{"name":"next","fqn":"WixDataQueryResult.WixDataQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataQueryResult","referenceFqn":"WixDataQueryResult.WixDataQueryResult"},"description":"Fulfilled - A query result object with the next page of query results.\r\nRejected - The errors that caused the rejection."},"description":"Retrieves the next page of query results.\r\n\r\nThe `next()` function retrieves the next page of query results.\r\n\r\n The page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n If items are added or removed between calls to `next()` the values returned\r\n by `WixDataQueryResult` may change.\r\n >**Note:** The `next()` function is not supported for Single Item Collections."},{"name":"prev","fqn":"WixDataQueryResult.WixDataQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataQueryResult","referenceFqn":"WixDataQueryResult.WixDataQueryResult"},"description":"Fulfilled - A query result object with the previous page of query results.\r\nRejected - The errors that caused the rejection."},"description":"Retrieves the previous page of query results.\r\n\r\nThe `prev()` function retrieves the previous page of query results.\r\n\r\n The page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n If items are added or removed between calls to `prev()` the values returned\r\n may change.\r\n >**Note:** The `prev()` function is not supported for Single Item Collections."}],"properties":[{"name":"currentPage","slug":"current-page","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the index of the current results page number.\r\n\r\nThe `currentPage` is a zero-based index of the current page of results.\r\n\r\n The page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n The `currentPage` property returns `undefined` if the query returned no results."},{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"object"}},"description":"Returns the items that match the query.\r\n\r\nThe current page of items retrieved by the query.\r\n\r\n The page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n When no items match the query, the `items` array is empty."},{"name":"length","slug":"length","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current results page.\r\n\r\nThe page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions."},{"name":"pageSize","slug":"page-size","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the query page size.\r\n\r\nThe page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions."},{"name":"partialIncludes","slug":"partial-includes","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates if referenced items have been trimmed from the results.\r\n\r\nWhen [including](wix-data.WixDataQuery.html#include) a property with multiple references, each returned item can\r\n include up to 50 referenced items. If there are more than 50 referenced items,\r\n only 50 will be returned and `partialIncludes` will be true.\r\n\r\n To retrieve more than 50 referenced items, use the\r\n [`queryReferenced()`](wix-data.html#queryReferenced) function."},{"name":"query","slug":"query","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery"},"description":"Returns the query used to get the current results.\r\n\r\nUse the `query` property to create and run a new query by chaining additional WixDataQueryBuilder functions to it."},{"name":"totalCount","slug":"total-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of items that match the query.\r\n\r\nThe `totalCount` returns the total number of items that match the query,\r\n not just the number of items in the current page."},{"name":"totalPages","slug":"total-pages","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of pages the query produced.\r\n\r\nThe page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions."}]},"WixDataAggregate.RunOptions":{"name":"RunOptions","fqn":"WixDataAggregate.RunOptions","slug":"run-options","actions":[],"properties":[{"name":"consistentRead","slug":"consistent-read","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"When `true`, reads data from the primary database instance. \r\nThis decreases performance but ensures data retrieved is up to date even immediately after an update. \r\nSee [Wix Data and Eventual Consistency](https://www.wix.com/velo/reference/wix-data/introduction#wix-data_introduction_wix-data-and-eventual-consistency) for more information.\r\n\r\nDefault: `false`"},{"name":"language","slug":"language","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\r\nIf provided, the result text is returned in the specified language. **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\r\nIf not provided, result text is not translated."},{"name":"suppressAuth","slug":"suppress-auth","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"When `true`, prevents permission checks from running for the `run()` operation. Defaults to `false`."}]},"WixDataAggregateResult.WixDataAggregateResult":{"name":"WixDataAggregateResult","fqn":"WixDataAggregateResult.WixDataAggregateResult","slug":"wix-data-aggregate-result","actions":[{"name":"hasNext","fqn":"WixDataAggregateResult.WixDataAggregateResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"description":"Indicates if the aggregation has more results."},{"name":"next","fqn":"WixDataAggregateResult.WixDataAggregateResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataAggregateResult","referenceFqn":"WixDataAggregateResult.WixDataAggregateResult"},"description":"Fulfilled - An aggregate object with the next page of aggregate results.\r\nRejected - The errors that caused the rejection."},"description":"Retrieves the next page of aggregate results.\r\n\r\nThe `next()` function retrieves the next page of aggregate results.\r\n\r\n The page size is defined by the [`limit()`](wix-data.WixDataAggregate.html#limit) function.\r\n\r\n If items are added or removed between calls to `next()` the values returned\r\n by `WixDataAggregateResult` may change."}],"properties":[{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"object"}},"description":"Gets the aggregated values.\r\n\r\nThe current page of items retrieved by the aggregation.\r\n\r\n The page size is defined by the [`limit()`](wix-data.WixDataAggregate.html#limit) function and\r\n navigating through pages is done with the [`next()`](#next) function.\r\n\r\n When no items match the aggregation, the `items` array is empty."},{"name":"length","slug":"length","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of values in the aggregate results."}]},"WixDataBulkResult":{"name":"WixDataBulkResult","fqn":"WixDataBulkResult","slug":"wix-data-bulk-result","actions":[],"properties":[{"name":"errors","slug":"errors","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Error","referenceFqn":""}},"description":"List of errors."},{"name":"inserted","slug":"inserted","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of inserted items."},{"name":"insertedItemIds","slug":"inserted-item-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of IDs of inserted items."},{"name":"skipped","slug":"skipped","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of skipped items."},{"name":"updated","slug":"updated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of updated items."},{"name":"updatedItemIds","slug":"updated-item-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of IDs of updated items."}]},"WixDataBulkRemoveResult":{"name":"WixDataBulkRemoveResult","fqn":"WixDataBulkRemoveResult","slug":"wix-data-bulk-remove-result","actions":[],"properties":[{"name":"errors","slug":"errors","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Error","referenceFqn":""}},"description":"List of errors."},{"name":"removed","slug":"removed","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of removed items."},{"name":"removedItemIds","slug":"removed-item-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of IDs of removed items."},{"name":"skipped","slug":"skipped","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of skipped items."}]},"WixDataQueryReferencedOptions":{"name":"WixDataQueryReferencedOptions","fqn":"WixDataQueryReferencedOptions","slug":"wix-data-query-referenced-options","actions":[],"properties":[{"name":"consistentRead","slug":"consistent-read","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"When `true`, reads data from the primary database instance.\r\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\r\nSee [Wix Data and Eventual Consistency](https://www.wix.com/velo/reference/wix-data/introduction#wix-data_introduction_wix-data-and-eventual-consistency) for more information.\r\n\r\nDefault: `false`"},{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Fields to return for the item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.\r\n> **Note:** The `_id` system field is always returned."},{"name":"omitTotalCount","slug":"omit-total-count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"When `true`, the query result does not include a `totalCount` property containing the total number of items matching the query.\r\nThis speeds up the query.\r\n\r\n\r\nDefault: `false`"},{"name":"order","slug":"order","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Order of the returned referenced items. Sorted by the date each item was referenced.\r\n\r\nSupported values:\r\n- `'asc'`: Ascending\r\n- `'desc'`: Descending"},{"name":"suppressAuth","slug":"suppress-auth","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Prevents [permission](https://support.wix.com/en/article/about-collection-permissions) checks from running for the operation. Defaults to `false`. Can only be used in backend code."}]},"WixDataQueryReferencedResult.WixDataQueryReferencedResult":{"name":"WixDataQueryReferencedResult","fqn":"WixDataQueryReferencedResult.WixDataQueryReferencedResult","slug":"wix-data-query-referenced-result","actions":[{"name":"hasNext","fqn":"WixDataQueryReferencedResult.WixDataQueryReferencedResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"description":"Indicates if the reference query has more results."},{"name":"hasPrev","fqn":"WixDataQueryReferencedResult.WixDataQueryReferencedResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are previous results."},"description":"Indicates if the reference query has previous results."},{"name":"next","fqn":"WixDataQueryReferencedResult.WixDataQueryReferencedResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataQueryReferencedResult","referenceFqn":"WixDataQueryReferencedResult.WixDataQueryReferencedResult"},"description":"Fulfilled - A reference query result object with the next page of query results.\r\nRejected - The errors that caused the rejection."},"description":"Retrieves the next page of reference query results.\r\n\r\nThe `next()` function retrieves the next page of reference query results.\r\n\r\n The page size is 50 items. Navigate through pages of items with the\r\n [`prev()`](#prev) and [`next()`](#next) functions.\r\n\r\n If items are added or removed between calls to `next()` the values returned\r\n may change."},{"name":"prev","fqn":"WixDataQueryReferencedResult.WixDataQueryReferencedResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataQueryReferencedResult","referenceFqn":"WixDataQueryReferencedResult.WixDataQueryReferencedResult"},"description":"Fulfilled - A query result object with the previous page of query results.\r\nRejected - The errors that caused the rejection."},"description":"Retrieves the previous page of reference query results.\r\n\r\nThe `prev()` function retrieves the previous page of reference query results.\r\n\r\n The page size is 50 items. Navigate through pages of items with the\r\n [`prev()`](#prev) and [`next()`](#next) functions.\r\n\r\n If items are added or removed between calls to `prev()` the values returned\r\n may change."}],"properties":[{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"object"}},"description":"Returns the items that match the reference query.\r\n\r\nThe current page of items retrieved by the reference query.\r\n\r\n The page size is 50 items. Navigate through pages of items with the\r\n [`prev()`](#prev) and [`next()`](#next) functions.\r\n\r\n When no items match the reference query, the `items` array is empty."},{"name":"totalCount","slug":"total-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of items that match the reference query.\r\n\r\nThe `totalCount` returns the total number of items that match the reference query,\r\n not just the number of items in the current page."}]},"WixDataSort.WixDataSort":{"name":"WixDataSort","fqn":"WixDataSort.WixDataSort","slug":"wix-data-sort","actions":[{"name":"ascending","fqn":"WixDataSort.WixDataSort.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort."}],"description":"Adds a sort to a query or sort, sorting by the specified properties in ascending order.\r\n\r\nThe `ascending()` function refines a `WixDataQuery` or `WixDataSort` to sort in ascending order of\r\n the specified properties. If you specify more than one property,\r\n `ascending()` sorts the results in ascending order by each property in the\r\n order they are listed.\r\n\r\n You can sort the following types:\r\n\r\n + Number: Sorts numerically.\r\n + Date: Sorts by date and time.\r\n + String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n + Reference: Compares by the ID of the referenced item as a String.\r\n\r\n\r\n If a property contains a number as a String, that value will be sorted\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified sort property are ranked lowest."},{"name":"descending","fqn":"WixDataSort.WixDataSort.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort."}],"description":"Adds a sort to a query or sort, sorting by the specified properties in descending order.\r\n\r\nThe `descending()` function refines a `WixDataQuery` or `WixDataSort` to sort in descending order of\r\n the specified properties. If you specify more than one property,\r\n `descending()` sorts the results in descending order by each property in the\r\n order they are listed.\r\n\r\n You can sort the following types:\r\n\r\n + Number: Sorts numerically.\r\n + Date: Sorts by date and time.\r\n + String: Sorts lexicographically, so `\"abc\"` comes before `\"XYZ\"`.\r\n + Reference: Compares by the ID of the referenced item as a String.\r\n\r\n\r\n If a property contains a number as a String, that value will be sorted\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified sort property are ranked lowest."}],"properties":[]},"Hooks.HookContext":{"name":"HookContext","fqn":"Hooks.HookContext","slug":"hook-context","actions":[],"properties":[{"name":"collectionName","slug":"collection-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the collection the hook affects."},{"name":"userId","slug":"user-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The current site user ID. If no user is logged in to the site it may be null."},{"name":"userRole","slug":"user-role","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The permissions role of the current user. Possibilities are: `anonymous`, `siteMember`, and `siteOwner`."}]},"Hooks.UpdateHookContext":{"name":"UpdateHookContext","fqn":"Hooks.UpdateHookContext","slug":"update-hook-context","actions":[],"properties":[{"name":"collectionName","slug":"collection-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the collection the hook affects."},{"name":"currentItem","slug":"current-item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"object"},"description":"The item stored in the database collection before an update or delete operation."},{"name":"userId","slug":"user-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The current site user ID. If no user is logged in to the site it may be null."},{"name":"userRole","slug":"user-role","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The permissions role of the current user. Possibilities are: `anonymous`, `siteMember`, and `siteOwner`."}]}},"standaloneTypes":[],"metadata":{},"actions":[{"name":"aggregate","fqn":"aggregate","slug":"aggregate","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["collectionId"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"An aggregate object."},"examples":[{"title":"Perform an aggregation","content":"aggregate.run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let numItems = results.length;\n let hasNext = results.hasNext(); \n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create an aggregation and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nconst filter = wixData.filter().eq(\"year\", 2010);\nconst having = wixData.filter().gt(\"maxPopulation\", 1000000);\n\nwixData.aggregate(\"PopulationData\")\n .filter(filter)\n .group(\"state\")\n .max(\"population\", \"maxPopulation\")\n .having(having)\n .descending(\"maxPopulation\")\n .skip(5)\n .limit(3)\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let numItems = results.length;\n let hasNext = results.hasNext();\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"collectionId","slug":"collection-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the collection to run the aggregation on.\r\n\r\nTo find your `collectionId`, select the **Databases** tab in the [Velo Sidebar](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar).\r\nHover over your collection, click the three dots, and select **Edit Settings**."}],"description":"Creates an aggregation.\r\n\r\nThe `aggregate()` function builds an aggregation on the specified collection\r\n and returns a [`WixDataAggregate`](wix-data.WixDataAggregate.html) object.\r\n\r\n The returned object contains the aggregate definition which is typically used\r\n to run the aggregation using the [`run()`](wix-data.WixDataAggregate.html#run)\r\n function.\r\n\r\n You can refine the aggregation by chaining [`WixDataAggregate`](wix-data.WixDataAggregate.html)\r\n functions on to the aggregate.\r\n\r\n The `aggregate()` function runs with the following [`WixDataAggregate`](wix-data.WixDataAggregate.html)\r\n defaults that you can override:\r\n\r\n + [**skip**](wix-data.WixDataAggregate.html#skip) - `0`\r\n + [**limit**](wix-data.WixDataAggregate.html#limit) - `50`"},{"name":"bulkInsert","fqn":"bulkInsert","slug":"bulk-insert","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["collectionId","items"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataBulkResult","referenceFqn":"WixDataBulkResult"},"description":"Fulfilled - The results of the bulk insert.\r\nRejected - The error that caused the rejection."},"examples":[{"title":"Insert multiple items into a collection","content":"import wixData from 'wix-data';\n\n// ...\n\nlet toInsert1 = {\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n};\n\nlet toInsert2 = {\n \"title\": \"Ms.\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\"\n};\n\nwixData.bulkInsert(\"myCollection\", [toInsert1, toInsert2])\n .then((results) => {\n let inserted = results.inserted; // 2\n let insertedIds = results.insertedItemIds; // see below\n let updated = results.updated; // 0\n let skipped = results.skipped; // 0\n let errors = results.errors; // []\n })\n .catch((err) => {\n let errorMsg = err;\n });\n\n/* insertedIds is:\n *\n * [\n * \"d9ea65a6-726a-4c3e-b97d-1128c0a06b5f\",\n * \"472c1da9-e5e4-4620-8ee3-962e9d1a7df5\"\n * ]\n */"},{"title":"Insert multiple items with specified IDs into a collection","content":"import wixData from 'wix-data';\n\n// ...\n\nlet toInsert1 = {\n \"_id\": \"00001\",\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n};\n\nlet toInsert2 = {\n \"_id\": \"00002\",\n \"title\": \"Ms.\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\"\n};\n\nwixData.bulkInsert(\"myCollection\", [toInsert1, toInsert2])\n .then((results) => {\n let inserted = results.inserted; // 2\n let insertedIds = results.insertedItemIds; // [\"00001\", \"00002\"]\n let updated = results.updated; // 0\n let skipped = results.skipped; // 0\n let errors = results.errors; // []\n })\n .catch((err) => {\n let errorMsg = err;\n });"},{"title":"Insert multiple items into a collection using data options","content":"import wixData from 'wix-data';\n\n// ...\n\nlet toInsert1 = {\n \"_id\": \"00001\",\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n};\n\nlet toInsert2 = {\n \"_id\": \"00002\",\n \"title\": \"Ms.\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\"\n};\n\nlet options = {\n \"suppressAuth\": true,\n \"suppressHooks\": true\n};\n\nwixData.bulkInsert(\"myCollection\", [toInsert1, toInsert2], options)\n .then((results) => {\n let inserted = results.inserted; // 2\n let insertedIds = results.insertedItemIds; // [\"00001\", \"00002\"]\n let updated = results.updated; // 0\n let skipped = results.skipped; // 0\n let errors = results.errors; // []\n })\n .catch((err) => {\n let errorMsg = err;\n });"},{"title":"Insert multiple items including a reference to another item using the referenced item's ID","content":"import wixData from 'wix-data';\n\n// ...\n\nlet countryId = \"id-of-usa-item\";\n\nlet toInsert1 = {\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"country\": countryId\n};\n\nlet toInsert2 = {\n \"title\": \"Ms.\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"country\": countryId\n};\n\nwixData.bulkInsert(\"myCollection\", [toInsert1, toInsert2])\n .then((results) => {\n let inserted = results.inserted; // 2\n let insertedIds = results.insertedItemIds; // see below\n let updated = results.updated; // 0\n let skipped = results.skipped; // 0\n let errors = results.errors; // []\n })\n .catch((err) => {\n let errorMsg = err;\n });\n\n/* insertedIds is:\n *\n * [\n * \"d9ea65a6-726a-4c3e-b97d-1128c0a06b5f\",\n * \"472c1da9-e5e4-4620-8ee3-962e9d1a7df5\"\n * ]\n */"},{"title":"Insert multiple items including a reference to another item using the reference item","content":"import wixData from 'wix-data';\n\n// ...\n\nlet countryItem = // get country item from somewhere\n\nlet toInsert1 = {\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"country\": countryItem\n};\n\nlet toInsert2 = {\n \"title\": \"Ms.\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"country\": countryItem\n};\n\nwixData.bulkInsert(\"myCollection\", [toInsert1, toInsert2])\n .then((results) => {\n let inserted = results.inserted; // 2\n let insertedIds = results.insertedItemIds; // see below\n let updated = results.updated; // 0\n let skipped = results.skipped; // 0\n let errors = results.errors; // []\n })\n .catch((err) => {\n let errorMsg = err;\n });\n\n/* insertedIds is:\n *\n * [\n * \"d9ea65a6-726a-4c3e-b97d-1128c0a06b5f\",\n * \"472c1da9-e5e4-4620-8ee3-962e9d1a7df5\"\n * ]\n */"}],"actionParams":[{"name":"collectionId","slug":"collection-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the collection to add the item to. \r\n\r\nThe array must contain at least one item. Passing an empty array returns an error.\r\n\r\nTo find your `collectionId`, select the **Databases** tab in the [Velo Sidebar](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar). \r\nHover over your collection, click the three dots, and select **Edit Settings**."},{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"object"}},"description":"The items to add."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataOptions","referenceFqn":"WixDataOptions"},"description":"An object containing options to use when processing this operation."}],"description":"Adds a number of items to a collection.\r\n\r\nThe `bulkInsert()` function returns a Promise that resolves after the items\r\n have been added to the specified collection.\r\n The Promise is rejected if the current user does not have \"create\" permissions\r\n for the collection. Items are skipped if they include an `_id` property whose\r\n value matches an existing ID in the collection. Meaning, `bulkInsert()` cannot\r\n overwrite an existing item in the collection.\r\n\r\n Calling the `bulkInsert()` function triggers the [`beforeInsert()`](wix-data.Hooks.html#beforeInsert)\r\n and [`afterInsert()`](wix-data.Hooks.html#afterInsert) hooks for each item\r\n that is inserted if the hooks have been defined.\r\n\r\n Use the `options` parameter to run `bulkInsert()` from backend code without\r\n checking for permissions or without its registered hooks.\r\n\r\n When inserting items into a collection that has a reference field, set\r\n the values of the reference fields to the referenced item's `_id` value or\r\n the entire referenced item object.\r\n\r\n The `bulkInsert()` function adds the following properties and values to the item\r\n when it adds it to the collection:\r\n\r\n + `_id`: A unique identifier for an item in a collection, if the item doesn't have one or has one that is `undefined`. You can optionally provide your own ID. Once an ID is assigned to an item it cannot be changed.\r\n + `_createdDate`: The date the item was added to the collection.\r\n + `_updatedDate`: The date the item was modified. When the item is first added, the `createdDate` and `updatedDate` are the same.\r\n\r\n\r\n Any valid JavaScript object can be added as a property value. The `bulkInsert()`\r\n function maintains the structure of the specified object. For example,\r\n objects that contain nested objects, Arrays, or Arrays with nested objects\r\n are all added to the collection as defined.\r\n\r\nThe maximum size of an item that you can add to a collection is 500kb.\r\n> **Notes:** \r\n> - If an item's `_id` property value is set to `null` or an empty string, an error is thrown.\r\n> - Bulk operations are limited to 1000 items per function call.\r\n> - The `bulkInsert()` function is not supported for Single Item Collections.\r\n> - The `bulkInsert()` function does not support multi-reference fields. For multi-reference fields, use [`insertReference()`](https://www.wix.com/velo/reference/wix-data/insertreference). \r\n> - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `bulkInsert()` will fail and issue an error."},{"name":"bulkRemove","fqn":"bulkRemove","slug":"bulk-remove","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["collectionId","itemIds"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataBulkRemoveResult","referenceFqn":"WixDataBulkRemoveResult"},"description":"Fulfilled - The results of the bulk remove.\r\nRejected - The error that caused the rejection."},"examples":[{"title":"Remove multiple items from a collection","content":"import wixData from 'wix-data';\n\n// ...\n\nlet toRemove = [\"00001\", \"00003\", \"00004\"];\n\nwixData.bulkRemove(\"myCollection\", toRemove)\n .then((results) => {\n let removed = results.removed; // 2\n let removedIds = results.removedItemIds; // see below\n let skipped = results.skipped; // 0\n })\n .catch((err) => {\n let errorMsg = err;\n });\n\n/* removedIds is:\n *\n * [\n * \"00001\",\n * \"00002\",\n * \"00003\"\n * ]\n */"},{"title":"Remove multiple items from a collection using data options","content":"import wixData from 'wix-data';\n\n// ...\n\nlet toRemove = [\"00001\", \"00003\", \"00004\"];\n\nlet options = {\n \"suppressAuth\": true,\n \"suppressHooks\": true\n};\n\nwixData.bulkRemove(\"myCollection\", toRemove, options)\n .then((results) => {\n let removed = results.removed; // 2\n let removedIds = results.removedItemIds; // see below\n let skipped = results.skipped; // 0\n })\n .catch((err) => {\n let errorMsg = err;\n });\n\n/* removedIds is:\n *\n * [\n * \"00001\",\n * \"00002\",\n * \"00003\"\n * ]\n */"}],"actionParams":[{"name":"collectionId","slug":"collection-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the collection to remove the items from.\r\n\r\nTo find your `collectionId`, select the **Databases** tab in the [Velo Sidebar](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar).\r\nHover over your collection, click the three dots, and select **Edit Settings**."},{"name":"itemIds","slug":"item-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of the items to remove.\r\n\r\nThe array must contain at least one item. Passing an empty array returns an error."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataOptions","referenceFqn":"WixDataOptions"},"description":"An object containing options to use when processing this operation."}],"description":"Removes a number of items from a collection.\r\n\r\nThe `bulkRemove()` function returns a Promise that resolves after the items\r\n have been removed from the specified collection.\r\n The Promise is rejected if the current user does not have \"delete\" permissions\r\n for the collection. If the delete permissions for the collection are set to\r\n **Site member author**, the only items that will be deleted are those for\r\n which the current user is the owner. All other items will be skipped.\r\n\r\n Calling the `bulkRemove()` function triggers the [`beforeRemove()`](wix-data.Hooks.html#beforeRemove)\r\n and [`afterRemove()`](wix-data.Hooks.html#afterRemove) hooks for each item\r\n that is deleted if the hooks have been defined.\r\n\r\n Use the `options` parameter to run `bulkRemove()` from backend code without\r\n checking for permissions or without its registered hooks.\r\n\r\n > **Notes:** \r\n > - The `bulkRemove()` function also clears multiple-item reference fields for items in collections referenced by the specified items. For example, suppose you have a **Movies** collection with an **Actors** field that contains multiple references to items in a **People** collection. Removing items in the **Movies** collection also clears the data in the corresponding multiple-item reference fields in the **People** collection.\r\n >\r\n > - Bulk operations are limited to 1000 items per function call."},{"name":"bulkSave","fqn":"bulkSave","slug":"bulk-save","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["collectionId","items"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataBulkResult","referenceFqn":"WixDataBulkResult"},"description":"Fulfilled - The results of the bulk save.\r\nRejected - The error that caused the rejection."},"examples":[{"title":"Save multiple items in a collection","content":"import wixData from 'wix-data';\n\n// ...\n\nlet toSave1 = {\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n};\n\nlet toSave2 = {\n \"title\": \"Ms.\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\"\n};\n\nwixData.bulkSave(\"myCollection\", [toSave1, toSave2])\n .then((results) => {\n let inserted = results.inserted; // 2\n let insertedIds = results.insertedItemIds; // see below\n let updated = results.updated; // 0\n let skipped = results.skipped; // 0\n let errors = results.errors; // []\n })\n .catch((err) => {\n let errorMsg = err;\n });\n\n/* insertedIds is:\n *\n * [\n * \"d9ea65a6-726a-4c3e-b97d-1128c0a06b5f\",\n * \"472c1da9-e5e4-4620-8ee3-962e9d1a7df5\"\n * ]\n */"},{"title":"Save multiple items with specified IDs in a collection","content":"import wixData from 'wix-data';\n\n// ...\n\nlet toSave1 = {\n \"_id\": \"00001\",\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Schmoe\"\n};\n\nlet toSave2 = {\n \"_id\": \"00003\",\n \"title\": \"Prof.\",\n \"first_name\": \"Jan\",\n \"last_name\": \"Doey\"\n};\n\nwixData.bulkSave(\"myCollection\", [toSave1, toSave2])\n .then((results) => {\n let inserted = results.inserted; // 1\n let insertedIds = results.insertedItemIds; // [\"00003\"]\n let updated = results.updated; // 1\n let skipped = results.skipped; // 0\n let errors = results.errors; // []\n })\n .catch((err) => {\n let errorMsg = err;\n });"},{"title":"Save multiple items in a collection using data options","content":"import wixData from 'wix-data';\n\n// ...\n\nlet toSave1 = {\n \"_id\": \"00001\",\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Schmoe\"\n};\n\nlet toSave2 = {\n \"_id\": \"00003\",\n \"title\": \"Prof.\",\n \"first_name\": \"Jan\",\n \"last_name\": \"Doey\"\n};\n\nlet options = {\n \"suppressAuth\": true,\n \"suppressHooks\": true\n};\n\nwixData.bulkSave(\"myCollection\", [toSave1, toSave2], options)\n .then((results) => {\n let inserted = results.inserted; // 1\n let insertedIds = results.insertedItemIds; // [\"00003\"]\n let updated = results.updated; // 1\n let skipped = results.skipped; // 0\n let errors = results.errors; // []\n })\n .catch((err) => {\n let errorMsg = err;\n });"},{"title":"Save multiple items including a reference to another item using the referenced item's ID","content":"import wixData from 'wix-data';\n\n// ...\n\nlet countryId = \"id-of-usa-item\";\n\nlet toSave1 = {\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"country\": countryId\n};\n\nlet toSave2 = {\n \"title\": \"Ms.\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"country\": countryId\n};\n\nwixData.bulkSave(\"myCollection\", [toSave1, toSave2])\n .then((results) => {\n let inserted = results.inserted; // 2\n let insertedIds = results.insertedItemIds; // see below\n let updated = results.updated; // 0\n let skipped = results.skipped; // 0\n let errors = results.errors; // []\n })\n .catch((err) => {\n let errorMsg = err;\n });\n\n/* insertedIds is:\n *\n * [\n * \"d9ea65a6-726a-4c3e-b97d-1128c0a06b5f\",\n * \"472c1da9-e5e4-4620-8ee3-962e9d1a7df5\"\n * ]\n */"},{"title":"Save multiple items including a reference to another item using the reference item","content":"import wixData from 'wix-data';\n\n// ...\n\nlet countryItem = // get country item from somewhere\n\nlet toSave1 = {\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"country\": countryItem\n};\n\nlet toSave2 = {\n \"title\": \"Ms.\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"country\": countryItem\n};\n\nwixData.bulkSave(\"myCollection\", [toSave1, toSave2])\n .then((results) => {\n let inserted = results.inserted; // 2\n let insertedIds = results.insertedItemIds; // see below\n let updated = results.updated; // 0\n let skipped = results.skipped; // 0\n let errors = results.errors; // []\n })\n .catch((err) => {\n let errorMsg = err;\n });\n\n/* insertedIds is:\n *\n * [\n * \"d9ea65a6-726a-4c3e-b97d-1128c0a06b5f\",\n * \"472c1da9-e5e4-4620-8ee3-962e9d1a7df5\"\n * ]\n */"}],"actionParams":[{"name":"collectionId","slug":"collection-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the collection to save the item to.\r\n\r\nTo find your `collectionId`, select the **Databases** tab in the [Velo Sidebar](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar).\r\nHover over your collection, click the three dots, and select **Edit Settings**."},{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"object"}},"description":"The items to insert or update.\r\n\r\nThe array must contain at least one item. Passing an empty array returns an error."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataOptions","referenceFqn":"WixDataOptions"},"description":"An object containing options to use when processing this operation."}],"description":"Inserts or updates a number of items in a collection.\r\n\r\nThe `bulkSave()` function returns a Promise that resolves after the items\r\n have been added or updated in the specified collection. The Promise is rejected if the\r\n current user does not have the necessary permissions for the collection.\r\n\r\n The `bulkSave()` function inserts or updates the specified items, depending on\r\n whether they already exist in the collection. It compares the `_id` property\r\n value of the specified items with the `_id` property values of the items in\r\n the specified collection.\r\n\r\n + If an item in the collection has the specified `_id` value,\r\n `bulkSave()` uses [`update()`](#update) to update the item in the\r\n collection, triggering the [`beforeUpdate()`](wix-data.Hooks.html#beforeUpdate)\r\n and [`afterUpdate()`](wix-data.Hooks.html#afterUpdate) hooks for that item if they have\r\n been defined.\r\n + If none of the items in the collection contain that `_id` value, the\r\n specified item does not have an `_id` property, or if the specified item's `_id` property is `undefined`,\r\n `bulkSave()` uses [`insert()`](#insert) to add the specified item into the\r\n collection. This triggers the [`beforeInsert()`](wix-data.Hooks.html#beforeInsert)\r\n and [`afterInsert()`](wix-data.Hooks.html#afterInsert) hooks for that item if they have\r\n been defined.\r\n\r\n\r\n Use the `options` parameter to run `bulkSave()` from backend code without\r\n checking for permissions or without its registered hooks.\r\n\r\n When saving items to a collection that has a reference field, set\r\n the values of the reference fields to the referenced item's `_id` value or\r\n the entire referenced item object.\r\n\r\n The maximum size of an item that you can save to a collection is 500kb.\r\n\r\n> **Notes:**\r\n> - If an item's `_id` property value is set to `null` or an empty string, an error is thrown.\r\n> - Bulk operations are limited to 1000 items per function call.\r\n> - The `bulkSave()` function is not supported for Single Item Collections.\r\n> - The `bulkSave()` function does not support multi-reference fields. For multi-reference fields, use [`replaceReferences()`](https://www.wix.com/velo/reference/wix-data/replacereferences) or [`insertReference()`](https://www.wix.com/velo/reference/wix-data/insertreference).\r\n> - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `bulkSave()` will fail and issue an error."},{"name":"bulkUpdate","fqn":"bulkUpdate","slug":"bulk-update","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["collectionId","items"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataBulkResult","referenceFqn":"WixDataBulkResult"},"description":"Fulfilled - The results of the bulk save.\r\nRejected - The error that caused the rejection."},"examples":[{"title":"Update multiple items with specified IDs in a collection","content":"import wixData from 'wix-data';\n\n// ...\n\nlet toUpdate1 = {\n \"_id\": \"00001\",\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n};\n\nlet toUpdate2 = {\n \"_id\": \"00002\",\n \"title\": \"Ms.\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\"\n};\n\nwixData.bulkUpdate(\"myCollection\", [toUpdate1, toUpdate2])\n .then((results) => {\n let inserted = results.inserted; // 0\n let insertedIds = results.insertedItemIds; // []\n let updated = results.updated; // 2\n let skipped = results.skipped; // 0\n let errors = results.errors; // []\n })\n .catch((err) => {\n let errorMsg = err;\n });"},{"title":"Update multiple items in a collection using data options","content":"import wixData from 'wix-data';\n\n// ...\n\nlet toUpdate1 = {\n \"_id\": \"00001\",\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n};\n\nlet toUpdate2 = {\n \"_id\": \"00002\",\n \"title\": \"Ms.\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\"\n};\n\nlet options = {\n \"suppressAuth\": true,\n \"suppressHooks\": true\n};\n\nwixData.bulkUpdate(\"myCollection\", [toUpdate1, toUpdate2], options)\n .then((results) => {\n let inserted = results.inserted; // 0\n let insertedIds = results.insertedItemIds; // []\n let updated = results.updated; // 2\n let skipped = results.skipped; // 0\n let errors = results.errors; // []\n })\n .catch((err) => {\n let errorMsg = err;\n });"},{"title":"Update multiple items including a reference to another item using the referenced item's ID","content":"import wixData from 'wix-data';\n\n// ...\n\nlet countryId = \"id-of-usa-item\";\n\nlet toUpdate1 = {\n \"_id\": \"00001\",\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"country\": countryId\n};\n\nlet toUpdate2 = {\n \"_id\": \"00002\",\n \"title\": \"Ms.\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"country\": countryId\n};\n\nwixData.bulkUpdate(\"myCollection\", [toUpdate1, toUpdate2])\n .then((results) => {\n let inserted = results.inserted; // 0\n let insertedIds = results.insertedItemIds; // []\n let updated = results.updated; // 2\n let skipped = results.skipped; // 0\n let errors = results.errors; // []\n })\n .catch((err) => {\n let errorMsg = err;\n });"},{"title":"Update multiple items including a reference to another item using the referenced item","content":"import wixData from 'wix-data';\n\n// ...\n\nlet countryItem = // get country item from somewhere\n\nlet toUpdate1 = {\n \"_id\": \"00001\",\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"country\": countryItem\n};\n\nlet toUpdate2 = {\n \"_id\": \"00002\",\n \"title\": \"Ms.\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"country\": countryItem\n};\n\nwixData.bulkUpdate(\"myCollection\", [toUpdate1, toUpdate2])\n .then((results) => {\n let inserted = results.inserted; // 0\n let insertedIds = results.insertedItemIds; // []\n let updated = results.updated; // 2\n let skipped = results.skipped; // 0\n let errors = results.errors; // []\n })\n .catch((err) => {\n let errorMsg = err;\n });"}],"actionParams":[{"name":"collectionId","slug":"collection-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the collection that contains the item to update.\r\n\r\nTo find your `collectionId`, select the **Databases** tab in the [Velo Sidebar](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar).\r\nHover over your collection, click the three dots, and select **Edit Settings**."},{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"object"}},"description":"The items to update.\r\n\r\nThe array must contain at least one item. Passing an empty array returns an error."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataOptions","referenceFqn":"WixDataOptions"},"description":"An object containing options to use when processing this operation."}],"description":"Updates a number of items in a collection.\r\n\r\nThe `bulkUpdate()` function returns a Promise that resolves after the items\r\n have been updated in the specified collection. The Promise is rejected if the\r\n current user does not have update permissions for the collection. Items are\r\n skipped if they include an `_id` property whose value does not match an\r\n existing ID in the collection. Meaning, `bulkUpdate()` cannot add new items\r\n into the collection.\r\n\r\n Calling the `bulkUpdate()` function triggers the [`beforeUpdate()`](wix-data.Hooks.html#beforeUpdate)\r\n and [`afterUpdate()`](wix-data.Hooks.html#afterUpdate) hooks for each item\r\n that is updated if the hooks have been defined.\r\n\r\n The `bulkUpdate()` function compares the `_id` property of the specified\r\n items with the `_id` property values of the items in the specified\r\n collection.\r\n\r\n > **Warning:** If an existing item in the specified collection matches the `_id` of the specified item, `bulkUpdate`\r\n replaces the existing item's property values with the ones in the specified item.\r\n **If the existing item had properties with values and those properties were not\r\n included in the specified item, the values in those properties are lost.**\r\n The item's `_updatedDate` property is also updated to the current date.\r\n\r\n Any valid JavaScript object can be used as a property value. The `bulkUpdate()`\r\n function maintains the structure of the specified object. For example,\r\n objects that contain nested objects, Arrays, or Arrays with nested objects\r\n are all added to the collection as defined.\r\n\r\n Use the `options` parameter to run `bulkUpdate()` from backend code without\r\n checking for permissions or without its registered hooks.\r\n\r\n When updating items in a collection that has a reference field, set\r\n the values of the reference field to the referenced item's `_id` value or\r\n the entire referenced item object.\r\n\r\nThe maximum size of an item that you can update in a collection is 500kb.\r\n> **Notes:**\r\n> - Bulk operations are limited to 1000 items per function call.\r\n> - The `bulkUpdate()` function is not supported for Single Item Collections.\r\n> - The `bulkUpdate()` function does not support multi-reference fields. For multi-reference fields, use [`replaceReferences()`](https://www.wix.com/velo/reference/wix-data/replacereferences) or [`insertReference()`](https://www.wix.com/velo/reference/wix-data/insertreference).\r\n> - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `bulkUpdate()` will fail and issue an error."},{"name":"filter","fqn":"filter","slug":"filter","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataFilter","referenceFqn":"WixDataFilter.WixDataFilter","description":"A filter object."},"examples":[{"title":"Filter a dataset","content":"import wixData from 'wix-data';\n\n// ...\n\n$w(\"#myDataset\").setFilter( wixData.filter()\n .startsWith(\"lastName\", \"D\")\n .ge(\"age\", \"21\")\n);"}],"description":"Creates a filter to be used with datasets and aggregations.\r\n\r\nThe `filter()` function builds a filter to be applied to a dataset or an aggregation, and returns a [`WixDataFilter`](wix-data.WixDataFilter.html) object.\r\nThe returned object contains the filter definition and is used with the [`setFilter()`](wix-dataset.Dataset.html#setFilter) function.\r\n\r\nWhen working with [Wix app collections](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code), check [which fields](https://support.wix.com/en/search?term=velo%20collection%20fields) can be used in a filter."},{"name":"get","fqn":"get","slug":"get","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["collectionId","itemId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"object"},"description":"Fulfilled - The retrieved item or null if not found.\r\nRejected - The error that caused the rejection."},"examples":[{"title":"Get an item from a collection","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.get(\"myCollection\", \"00001\")\n .then((item) => {\n console.log(item); //see item below\n })\n .catch((err) => {\n console.log(err);\n });\n\n/* item is:\n *\n * {\n * \"_id\": \"00001\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\"\n * }\n */"},{"title":"Get an item from a collection using data options","content":"import wixData from 'wix-data';\n\n// ...\n\nlet options = {\n \"suppressAuth\": true,\n \"suppressHooks\": true\n};\n\nwixData.get(\"myCollection\", \"00001\", options)\n .then((item) => {\n console.log(item); //see item below\n })\n .catch((err) => {\n console.log(err);\n });\n\n/* item is:\n *\n * {\n * \"_id\": \"00001\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\"\n * }\n */"}],"actionParams":[{"name":"collectionId","slug":"collection-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the collection to retrieve the item from.\r\n\r\nTo find your `collectionId`, select the **Databases** tab in the [Velo Sidebar](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar).\r\nHover over your collection, click the three dots, and select **Edit Settings**."},{"name":"itemId","slug":"item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the item to retrieve."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataOptions","referenceFqn":"WixDataOptions"},"description":"An object containing options to use when processing this operation."}],"description":"Retrieves an item from a collection.\r\n\r\nThe `get()` function returns a Promise that resolves to the item with ID\r\n `itemId` from the specified collection, or null if the `itemId` is not found. The Promise is rejected if the\r\n current user does not have read permissions for the collection.\r\n\r\n If the specified collection contains reference fields, the ID of the referenced item is returned. To return the values of the referenced items use [`query()`](wix-data/query) and [`include()`](wix-data/wixdataquery/include).\r\n\r\n If the `get()` function is passed the ID of a hidden item, it returns `null`.\r\n\r\n Calling the `get()` function triggers the [`beforeGet()`](wix-data.Hooks.html#beforeGet)\r\n and [`afterGet()`](wix-data.Hooks.html#afterGet) hooks if they have been defined.\r\n\r\n Use the `options` parameter to run `get()` from backend code without\r\n checking for permissions or without its registered hooks.\r\n\r\n > **Notes:**\r\n > - When using the `query()` or `get()` functions or another data retrieval method following a change to your database collection, the data retrieved may not contain your most recent changes. See [Wix-data and Eventual Consistency](wix-data.html#wix-data-and-eventual-consistency) for more information. To solve this problem, you can use the [`setTimeout()`](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Asynchronous/Timeouts_and_intervals#setTimeout) function to delay retrieving data following any changes to your database collection.\r\n > - An `itemId` is required to retrieve an item even from a single-item collection."},{"name":"insert","fqn":"insert","slug":"insert","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["collectionId","item"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"object"},"description":"Fulfilled - The item that was added.\r\nRejected - The error that caused the rejection."},"examples":[{"title":"Insert an item into a collection","content":"import wixData from 'wix-data';\n\n// ...\n\nlet toInsert = {\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n};\n\nwixData.insert(\"myCollection\", toInsert)\n .then((item) => {\nconsole.log(item); //see item below\n })\n .catch((err) => {\n console.log(err);\n });\n\n/* item is:\n *\n * {\n * \"_id\": \"rifk4nrk-dj4o-djhe-oidk-fnoqw4oiglk4i\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\"\n * }\n */"},{"title":"Insert an item with a specified ID into a collection","content":"import wixData from 'wix-data';\n\n// ...\n\nlet toInsert = {\n \"_id\": \"00001\",\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n};\n\nwixData.insert(\"myCollection\", toInsert)\n .then((results) => {\n let item = results; //see item below\n })\n .catch((err) => {\n let errorMsg = err;\n });\n\n/* item is:\n *\n * {\n * \"_id\": \"00001\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\"\n * }\n */"},{"title":"Insert an item into a collection using data options","content":"import wixData from 'wix-data';\n\n// ...\n\nlet toInsert = {\n \"_id\": \"00001\",\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n};\n\nlet options = {\n \"suppressAuth\": true,\n \"suppressHooks\": true\n};\n\nwixData.insert(\"myCollection\", toInsert, options)\n .then((item) => {\n console.log(item); //see item below\n })\n .catch((err) => {\n console.log(err);\n });\n\n/* item is:\n *\n * {\n * \"_id\": \"00001\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\"\n * }\n */"},{"title":"Insert an item including a reference to another item using the referenced item's ID","content":"import wixData from 'wix-data';\n\n// ...\n\nlet countryId = \"id-of-usa-item\";\n\nlet toInsert = {\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"country\": countryId\n};\n\nwixData.insert(\"myCollection\", toInsert)\n .then((results) => {\n console.log(item); //see item below\n })\n .catch((err) => {\n console.log(err);\n });\n\n/* item is:\n *\n * {\n * \"_id\": \"rifk4nrk-dj4o-djhe-oidk-fnoqw4oiglk4i\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\",\n * \"country\": \"id-of-usa-item\"\n * }\n */"},{"title":"Insert an item including a reference to another item using the reference item","content":"import wixData from 'wix-data';\n\n// ...\n\nlet countryItem = // get country item from somewhere\n\nlet toInsert = {\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"country\": countryItem\n};\n\nwixData.insert(\"myCollection\", toInsert)\n .then((results) => {\n console.log(item); //see item below\n})\n .catch((err) => {\n console.log(err);\n});\n\n/* item is:\n *\n * {\n * \"_id\": \"rifk4nrk-dj4o-djhe-oidk-fnoqw4oiglk4i\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\",\n * \"country\": \"id-of-usa-item\"\n * }\n */"},{"title":"Insert an item into a collection using a custom function","description":"In this example, we demonstrate how you can you can build a CRUD \"create\" function using `insert()`. You can test out the code in our [example template](https://manage.wix.com/edit-template/from?originTemplateId=d802a21e-b944-4bfb-92c3-eb4efd6fdee4&templateId=839cba18-7956-4dbc-bf2b-5b416b4097b6&autoDevMode=true).","content":"import wixData from 'wix-data';\n\n// Code for a create operation using insert() //\n\nfunction createGreeting(language, greeting) {\n const toInsert = {\n language,\n greeting\n };\n\n return wixData.insert('Greetings', toInsert);\n}\n"}],"actionParams":[{"name":"collectionId","slug":"collection-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the collection to add the item to.\r\n\r\nTo find your `collectionId`, select the **Databases** tab in the [Velo Sidebar](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar).\r\nHover over your collection, click the three dots, and select **Edit Settings**."},{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"object"},"description":"The item to add."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataOptions","referenceFqn":"WixDataOptions"},"description":"An object containing options to use when processing this operation."}],"description":"Adds an item to a collection.\r\n\r\nThe `insert()` function returns a Promise that resolves to the inserted item\r\n after it has been added to the specified collection.\r\n The Promise is rejected if the current user does not have \"create\" permissions\r\n for the collection or the specified item includes an `_id` property whose\r\n value matches an existing ID in the collection. Meaning, `insert()` cannot\r\n overwrite an existing item in the collection.\r\n\r\n Calling the `insert()` function triggers the [`beforeInsert()`](wix-data.Hooks.html#beforeInsert)\r\n and [`afterInsert()`](wix-data.Hooks.html#afterInsert) hooks if they have been defined.\r\n\r\n Use the `options` parameter to run `insert()` from backend code without\r\n checking for permissions or without its registered hooks.\r\n\r\n When inserting an item into a collection that has a reference field, set\r\n the value of the reference field to the referenced item's `_id` value or\r\n the entire referenced item object.\r\n\r\n The `insert()` function adds the following properties and values to the item\r\n when it adds it to the collection:\r\n\r\n + `_id`: A unique identifier for an item in a collection, if the item doesn't have one or has one that is `undefined`. You can optionally provide your own ID. Once an ID is assigned to an item it cannot be changed.\r\n + `_createdDate`: The date the item was added to the collection.\r\n + `_updatedDate`: The date the item was modified. When the item is first added, the `_createdDate` and `_updatedDate` are the same.\r\n\r\n\r\n Any valid JavaScript object can be added as a property value. The `insert()`\r\n function maintains the structure of the specified object. For example,\r\n objects that contain nested objects, Arrays, or Arrays with nested objects\r\n are all added to the collection as defined.\r\n\r\nThe maximum size of an item that you can add to a collection is 500kb.\r\n\r\n> **Notes:**\r\n> - If an item's `_id` property value is set to `null` or an empty string, an error is thrown.\r\n> - When creating a Single Item Collection, an item with the system field `_id` is pre-inserted into the collection. Single Item Collections may contain only one item.\r\n> - If there is a pre-existing item in a Single Item Collection, the `insert()` function will not run. To update or change an item in a Single Item Collection see the [`update()`](#update) and [`save()`](#save) functions.\r\n> - The `insert()` function does not support multi-reference fields. For multi-reference fields, use [`insertReference()`](https://www.wix.com/velo/reference/wix-data/insertreference).\r\n> - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `insert()` will fail and issue an error."},{"name":"insertReference","fqn":"insertReference","slug":"insert-reference","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["collectionId","propertyName","referringItem","referencedItem"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the references have been inserted.\r\nRejected - The error that caused the rejection."},"examples":[{"title":"Insert a reference","description":"This example inserts a reference to the item with ID **12345** in the\n **Actors** field of the item in the **Movies** collection with the ID **00001**.","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.insertReference(\"movies\", \"actors\", \"00001\", \"12345\")\n .then(() => {\n console.log(\"Reference inserted\");\n })\n .catch((error) => {\n console.log(error);\n });\n"},{"title":"Insert references using an array","description":"This example inserts a reference to the items with IDs **12345** and **67890** in the\n **Actors** field of the item in the **Movies** collection with the ID **00001**.","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.insertReference(\"movies\", \"actors\", \"00001\", [\"12345\", \"67890\"])\n .then(() => {\n console.log(\"Reference inserted\");\n })\n .catch((error) => {\n console.log(error);\n });\n"}],"actionParams":[{"name":"collectionId","slug":"collection-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the collection that contains the referring item.\r\n\r\nTo find your `collectionId`, select the **Databases** tab in the [Velo Sidebar](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar).\r\nHover over your collection, click the three dots, and select **Edit Settings**."},{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property to insert the reference into."},{"name":"referringItem","slug":"referring-item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"object"}]},"description":"The referring item or referring item's ID."},{"name":"referencedItem","slug":"referenced-item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"object"},{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"object"}}]},"description":"The referenced item, referenced item's ID, an array of referenced items, or an array of referenced item IDs."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataOptions","referenceFqn":"WixDataOptions"},"description":"An object containing options to use when processing this operation."}],"description":"Inserts a reference in the specified property.\r\n\r\nThe `insertReference()` function returns a Promise that resolves when a\r\n reference to the referenced item(s) is added to the referring item in the\r\n specified property. The Promise is rejected if the current user does not\r\n have update permissions for the collection.\r\n\r\n Calling the `insertReference()` function does not trigger any hooks.\r\n\r\n> **Notes:**\r\n> - The `insertReference()` function only applies to multi-reference fields.\r\n> - The `insertReference()` function is not supported for Single Item Collections."},{"name":"isReferenced","fqn":"isReferenced","slug":"is-referenced","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["collectionId","propertyName","referringItem","referencedItem"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"boolean"},"description":"Fulfilled - Whether the referring item contains a reference to the referenced item or not.\r\nRejected - The error that caused the rejection."},"examples":[{"title":"Get referenced items","description":"This example checks if the item in the **Movies** collection with the ID **00001**\n has a reference in its **Actors** field that refers to an item with the ID\n **12345**.","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.isReferenced(\"movies\", \"actors\", \"00001\", \"12345\")\n .then((result) => {\n let isReferenced = result; // true\n })\n .catch((err) => {\n let errorMsg = err;\n });\n"}],"actionParams":[{"name":"collectionId","slug":"collection-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the collection that contains the referring item.\r\n\r\nTo find your `collectionId`, select the **Databases** tab in the [Velo Sidebar](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar).\r\nHover over your collection, click the three dots, and select **Edit Settings**."},{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property that possibly contains the references to the referenced item."},{"name":"referringItem","slug":"referring-item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"object"}]},"description":"The referring item or referring item's ID."},{"name":"referencedItem","slug":"referenced-item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"object"}]},"description":"The referenced item or referenced item's ID."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataOptions","referenceFqn":"WixDataOptions"},"description":"An object containing options to use when processing this operation."}],"description":"Checks if a reference to the referenced item exists in the specified\r\n property of the referring item.\r\n\r\nThe `isReferenced()` function returns a Promise that resolves to `true` if\r\n the referring item contains a reference to the referenced item in the\r\n specified property. The Promise is rejected if the current\r\n user does not have read permissions for the collection.\r\n\r\n Calling the `isReferenced()` function does not trigger any hooks.\r\n\r\n>**Note:** The `isReferenced()` function is not supported for Single Item Collections."},{"name":"query","fqn":"query","slug":"query","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["collectionId"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A query object."},"examples":[{"title":"Build a query","content":"import wixData from 'wix-data';\n\n// ...\n\nlet query = wixData.query(\"myCollection\");"},{"title":"Build and perform a query","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n console.log(results.items[0]); //see item below\n } else {\n // handle case where no matching items found\n }\n })\n .catch((err) => {\n console.log(err);\n });\n\n/* firstItem is:\n *\n * {\n * \"_id\": \"00001\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\"\n * }\n */"},{"title":"Build and perform a query using data options","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .eq(\"title\", \"Dr.\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n console.log(results.items[0]); //see firstItem below\n } else {\n // handle case where no matching items found\n }\n })\n .catch((err) => {\n console.log(err);\n });\n\n/* firstItem is:\n *\n * {\n * \"_id\": \"00002\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"title\": \"Dr.\",\n * \"first_name\": \"Jane\",\n * \"last_name\": \"Doe\"\n * }\n */"},{"title":"Create, filter, sort, limit, and run a query","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .eq(\"status\", \"active\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Build a query incrementally","description":"This example builds a query based on certain conditions. It then performs the\n query and uses the results to populate a table.","content":"import wixData from 'wix-data';\n\n// ...\n\nfunction runQuery(low, high) {\n let myQuery = wixData.query(\"myCollection\");\n\n if(low) {\n myQuery = myQuery.ge(\"price\", low);\n }\n\n if(high) {\n myQuery = myQuery.le(\"price\", high);\n }\n\n myQuery.find()\n .then((results) => {\n if(results.items.length > 0) {\n $w(\"#myTable\").rows = results.items;\n } else {\n $w(\"#myTable\").collapse();\n }\n });\n}\n"},{"title":"Build a query using `include()` to include the referenced collection cities, based on the field \"city\" from myCollection","content":"import wixData from 'wix-data';\n\nwixData.query(\"myCollection\")\n .include(\"city\")\n .find()\n .then((results) => {\n let firstItem = results.items[0]\n console.log(firstItem);\n });\n\n\n /* firstItem is:\n *\n * {\n * \"_id\": \"1d8a1d97-93d3-4d6c-9a0f-c279058b4aa5\",\n * \"_owner\": \"81c9168e-95b8-47fd-8e6a-ad9fdf71b38e\",\n * \"_createdDate\": \"2020-08-03T10:26:26.825Z\",\n * \"_updatedDate\": \"2020-08-03T10:27:01.558Z\",\n * \"first_name\": \"Betty\",\n * \"last_name\": \"Boop\",\n * \"city\": \n * {\n * \"_id\": \"a99daca6-0400-4ef1-8d74-de3f9095bf0b\",\n * \"_owner\": \"81c9168e-95b8-47fd-8e6a-ad9fdf71b38e\",\n * \"_createdDate\": \"2020-08-03T10:22:39.114Z\",\n * \"_updatedDate\": \"2020-08-03T10:23:25.042Z\" ,\n * \"city_name\": \"Los Angeles\",\n * \"state\": \"California\"\n * }\n */"},{"title":"Query a collection using a custom function","description":"In this example, we demonstrate how you can you can build a CRUD \"read\" function using `query()`. You can test out the code in our [example template](https://manage.wix.com/edit-template/from?originTemplateId=d802a21e-b944-4bfb-92c3-eb4efd6fdee4&templateId=839cba18-7956-4dbc-bf2b-5b416b4097b6&autoDevMode=true).","content":"import wixData from 'wix-data';\n\n// Code for a read operation using query() //\n\nasync function readGreetings() {\n const results = await wixData.query('Greetings').ascending('language').find();\n\n return results.items;\n}\n"}],"actionParams":[{"name":"collectionId","slug":"collection-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the collection to run the query on.\r\n\r\nTo find your `collectionId`, select the **Databases** tab in the [Velo Sidebar](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar).\r\nHover over your collection, click the three dots, and select **Edit Settings**."}],"description":"Creates a query for retrieving items from a database collection.\r\n\r\nThe `query()` function builds a query on the specified collection and returns\r\n a [`WixDataQuery`](wix-data.WixDataQuery.html) object.\r\n\r\n The returned object contains the query definition which is typically used\r\n to run the query using the [`find()`](wix-data.WixDataQuery.html#find)\r\n function.\r\n\r\n You can refine the query by chaining [`WixDataQuery`](wix-data.WixDataQuery.html)\r\n functions onto the query. `WixDataQuery` functions enable you to sort,\r\n filter, and control the results a query returns.\r\n\r\n The `query()` runs with the following [`WixDataQuery`](wix-data.WixDataQuery.html)\r\n defaults that you can override:\r\n\r\n + [`skip`](wix-data.WixDataQuery.html#skip): `0`\r\n + [`limit`](wix-data.WixDataQuery.html#limit): `50`\r\n + [`descending`](wix-data.WixDataQuery.html#descending): by `_createdDate`\r\n + [`include`](wix-data.WixDataQuery.html#include): none\r\n\r\n\r\n\r\n The functions that are chained to `query()` are applied in the order they\r\n are called. For example, if you sort on an `age` property in ascending\r\n order and then on a `name` property in descending order, the results are\r\n sorted first by the age of the items and then, if there are multiple\r\n results with the same age, the items are sorted by name in descending\r\n order, per age value.\r\n\r\n\r\nIf the collection that you are querying has references to other collections, by default, the data from referenced collections will not be retrieved. To get the data from the referenced items, you must either use the [`include()`](wix-data.WixDataQuery.html#include) chained function before `find()` or use the [`queryReferenced()`](wix-data.html#queryReferenced) function instead of `query()`.\r\n\r\nItems marked as hidden in the collection are not returned.\r\n\r\nWhen working with [Wix app collections](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code), fields in the collections have the following permissions:\r\n + Can connect to data\r\n + Can use in dynamic page URL\r\n + Can be sorted\r\n + Can be filtered\r\n + Read-only\r\nCheck [which fields](https://support.wix.com/en/search?term=velo%20collection%20fields) can be used in a query.\r\n\r\n > **Note:**\r\n When using the `query()` or `get()` functions or another data retrieval method following a change to your database collection,\r\nthe data retrieved may not contain your most recent changes. See [Wix-data and Eventual Consistency](wix-data.html#wix-data-and-eventual-consistency) for more information. To solve this problem,\r\nyou can use the [`setTimeout()`](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Asynchronous/Timeouts_and_intervals#setTimeout) function to delay retrieving data following any changes to your database collection."},{"name":"queryReferenced","fqn":"queryReferenced","slug":"query-referenced","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["collectionId","item","propertyName"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataQueryReferencedResult","referenceFqn":"WixDataQueryReferencedResult.WixDataQueryReferencedResult"},"description":"Fulfilled - The referenced items.\r\nRejected - The error that caused the rejection."},"examples":[{"title":"Get referenced items","description":"This example finds the item in the **Movies** collection with the ID **00001**.\n It gets all of the items referenced in the **Actors** field of that item\n and then stores the first actor in a variable.","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.queryReferenced(\"movies\", \"00001\", \"actors\")\n .then((results) => {\n if(results.items.length > 0) {\n console.log(results.items[0]); //see item below\n } else {\n // handle case where no matching items found\n }\n })\n .catch((err) => {\n console.log(err);\n });\n\n/* firstItem is:\n *\n * {\n * \"_id\": \"12345\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\"\n * }\n */\n"},{"title":"Get referenced items using options","content":"import wixData from 'wix-data';\n\n// ...\n\nlet options = {\n \"order\": \"asc\"\n};\n\nwixData.queryReferenced(\"movies\", \"00001\", \"actors\", options)\n .then((results) => {\n if(results.items.length > 0) {\n console.log(results.items[0]); //see item below\n } else {\n // handle case where no matching items found\n }\n })\n .catch((err) => {\n console.log(err);\n });\n\n/* firstItem is:\n *\n * {\n * \"_id\": \"12345\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\"\n * }\n */"}],"actionParams":[{"name":"collectionId","slug":"collection-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the collection that contains the referring item.\r\n\r\nTo find your `collectionId`, select the **Databases** tab in the [Velo Sidebar](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar).\r\nHover over your collection, click the three dots, and select **Edit Settings**."},{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"object"}]},"description":"The referring item or referring item's ID."},{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property that contains the references to the referenced items."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataQueryReferencedOptions","referenceFqn":"WixDataQueryReferencedOptions"},"description":"An object for controlling the order of the returned referenced items."}],"description":"Gets the full items referenced in the specified property.\r\n\r\nThe `queryReferenced()` function returns a Promise that resolves to the full\r\n items that are referenced in the specified property of the\r\n item from the specified collection. The Promise is rejected if the current\r\n user does not have read permissions for the specified collection or the\r\n collection containing the referenced items.\r\n\r\n For example, suppose you have a **Movies** collection with an **Actors**\r\n field that contains references\r\n to items in a **People** collection. Querying the **Movies** collection\r\n using `queryReferenced()` returns the relevant **People** items\r\n referenced in the **Actors** field of the specified **Movies** item. Meaning,\r\n it returns the full actor information for all actors in the specified movie.\r\n\r\n The `queryReferenced()` function can be used instead of a standard [`query()`](#query)\r\n with an [`include()`](wix-data.WixDataQuery.html#include) to overcome the\r\n limitations of the [`include()`](wix-data.WixDataQuery.html#include) function.\r\n\r\n You can optionally control the order of the returned referenced items by\r\n passing a `WixDataQueryReferencedOptions` object.\r\n\r\n > **Notes:**\r\n > - Calling the `queryReferenced()` function does not trigger any hooks.\r\n > - You can only use the `queryReferenced()` function with [multiple-item reference fields](https://support.wix.com/en/article/about-referencing-multiple-items-in-one-field), and not with single-item (regular) reference fields.\r\n > - The `queryReferenced()` function is not supported for Single Item Collections.\r\n\r\n For a discussion of when to use the similar [`include()`](wix-data.WixDataQuery.html#include)\r\n function and when to use `queryReferenced()`, see [Querying Items that Reference Other Items](https://support.wix.com/en/article/including-referenced-data-when-filtering)."},{"name":"remove","fqn":"remove","slug":"remove","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["collectionId","itemId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"object"},"description":"Fulfilled - The removed item, or `null` if the item was not found.\r\nRejected - The error that caused the rejection."},"examples":[{"title":"Remove an item from a collection","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.remove(\"myCollection\", \"00001\")\n .then((result) => {\n console.log(result); // see removed item below\n })\n .catch((err) => {\n console.log(err);\n });\n\n/* removed item is:\n *\n * {\n * \"_id\": \"00001\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\"\n * }\n */"},{"title":"Remove an item from a collection using data options","content":"import wixData from 'wix-data';\n\n// ...\n\nlet options = {\n \"suppressAuth\": true,\n \"suppressHooks\": true\n};\n\nwixData.remove(\"myCollection\", \"00001\", options)\n .then((result) => {\n console.log(result); // see removed item below\n })\n .catch((err) => {\n console.log(err);\n });\n\n/* removed item is:\n *\n * {\n * \"_id\": \"00001\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\"\n * }\n */"},{"title":"Remove a collection using a custom function","description":"In this example, we demonstrate how you can you can build a CRUD \"delete\" function using `remove()`. You can test out the code in our [example template](https://manage.wix.com/edit-template/from?originTemplateId=d802a21e-b944-4bfb-92c3-eb4efd6fdee4&templateId=839cba18-7956-4dbc-bf2b-5b416b4097b6&autoDevMode=true).","content":"import wixData from 'wix-data';\n\n// Code for a delete operation using remove() //\n\nfunction deleteGreeting(itemId) {\n return wixData.remove('Greetings', itemId);\n}\n"}],"actionParams":[{"name":"collectionId","slug":"collection-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the collection to remove the item from.\r\n\r\nTo find your `collectionId`, select the **Databases** tab in the [Velo Sidebar](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar).\r\nHover over your collection, click the three dots, and select **Edit Settings**."},{"name":"itemId","slug":"item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the item to remove."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataOptions","referenceFqn":"WixDataOptions"},"description":"An object containing options to use when processing this operation."}],"description":"Removes an item from a collection.\r\n\r\nThe `remove()` function returns a Promise that resolves to the removed item\r\n after it has been removed from the specified collection.\r\n The Promise is rejected if the current user does not have \"delete\" permissions\r\n for the collection.\r\n\r\n Calling the `remove()` function triggers the [`beforeRemove()`](wix-data.Hooks.html#beforeRemove)\r\n and [`afterRemove()`](wix-data.Hooks.html#afterRemove) hooks if they have been defined.\r\n\r\n Use the `options` parameter to run `remove()` from backend code without\r\n checking for permissions or without its registered hooks.\r\n\r\n> **Notes:**\r\n> - The `remove()` function also clears multiple-item reference fields for items in collections referenced by the specified item.\r\nFor example, suppose you have a **Movies** collection with an **Actors** field that contains multiple references\r\nto items in a **People** collection. Removing an item in the **Movies** collection also clears the data in the corresponding\r\nmultiple-item reference fields in the **People** collection."},{"name":"removeReference","fqn":"removeReference","slug":"remove-reference","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["collectionId","propertyName","referringItem","referencedItem"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the references have been removed.\r\nRejected - The error that caused the rejection."},"examples":[{"title":"Remove a reference","description":"This example removes a reference to the item with ID **12345** from the\n **Actors** field of the item in the **Movies** collection with the ID **00001**.","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.removeReference(\"movies\", \"actors\", \"00001\", \"12345\")\n .then(() => {\n console.log(\"Reference removed\");\n })\n .catch((error) => {\n console.log(error);\n });\n"},{"title":"Remove references using an array","description":"This example removes a reference to the items with IDs **12345** and **67890** from the\n **Actors** field of the item in the **Movies** collection with the ID **00001**.","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.removeReference(\"movies\", \"actors\", \"00001\", [\"12345\", \"67890\"])\n .then(() => {\n console.log(\"Reference removed\");\n })\n .catch((error) => {\n console.log(error);\n });\n"}],"actionParams":[{"name":"collectionId","slug":"collection-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the collection that contains the referring item.\r\n\r\nTo find your `collectionId`, select the **Databases** tab in the [Velo Sidebar](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar).\r\nHover over your collection, click the three dots, and select **Edit Settings**."},{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property to remove the reference from."},{"name":"referringItem","slug":"referring-item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"object"}]},"description":"The referring item or referring item's ID."},{"name":"referencedItem","slug":"referenced-item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"object"},{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"object"}}]},"description":"The referenced item, referenced item's ID, an array of referenced items, or an array of referenced item IDs."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataOptions","referenceFqn":"WixDataOptions"},"description":"An object containing options to use when processing this operation."}],"description":"Removes a reference from the specified property.\r\n\r\nThe `removeReference()` function returns a Promise that resolves when a\r\n reference to the referenced item(s) is removed from the specified property in\r\n the referring item. The Promise is rejected if the current user does not\r\n have update permissions for the collection.\r\n\r\n Calling the `removeReference()` function does not trigger any hooks.\r\n\r\n>**Note:** The `removeReference()` function is not supported for Single Item Collections."},{"name":"replaceReferences","fqn":"replaceReferences","slug":"replace-references","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["collectionId","propertyName","referringItem","referencedItem"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the references have been inserted.\r\nRejected - The error that caused the rejection."},"examples":[{"title":"Replace a reference","description":"This example replaces the references in the **Actors** field of the item in\n the **Movies** collection with the ID **00001** with a reference to the item with ID **12345**.","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.replaceReferences(\"movies\", \"actors\", \"00001\", \"12345\")\n .then(() => {\n console.log(\"References replaced\");\n })\n .catch((error) => {\n console.log(error);\n });\n"},{"title":"Replace references using an array","description":"This example replaces the references in the **Actors** field of the item in\n the **Movies** collection with the ID **00001** with references to the items\n with IDs **12345** and **67890**.","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.replaceReferences(\"movies\", \"actors\", \"00001\", [\"12345\", \"67890\"])\n .then(() => {\n console.log(\"References replaced\");\n })\n .catch((error) => {\n console.log(error);\n });\n"}],"actionParams":[{"name":"collectionId","slug":"collection-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the collection that contains the referring item.\r\n\r\nTo find your `collectionId`, select the **Databases** tab in the [Velo Sidebar](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar).\r\nHover over your collection, click the three dots, and select **Edit Settings**."},{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property to replaces the references in."},{"name":"referringItem","slug":"referring-item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"object"}]},"description":"The referring item or referring item's ID."},{"name":"referencedItem","slug":"referenced-item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"object"},{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"object"}}]},"description":"The referenced item, referenced item's ID, an array of referenced items, or an array of referenced item IDs."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataOptions","referenceFqn":"WixDataOptions"},"description":"An object containing options to use when processing this operation."}],"description":"Replaces current references with references in the specified property.\r\n\r\nThe `replaceReferences()` function returns a Promise that resolves when\r\n the item's current references in the specified property are removed and\r\n references to the referenced items are added in their place. The Promise is\r\n rejected if the current user does not have update permissions for the collection.\r\n\r\n Calling the `replaceReferences()` function does not trigger any hooks.\r\n\r\n>**Note:** The `replaceReferences()` function is not supported for Single Item Collections."},{"name":"save","fqn":"save","slug":"save","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["collectionId","item"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"object"},"description":"Fulfilled - The item that was either inserted or updated, depending on whether it previously existed in the collection.\r\nRejected - The error that caused the rejection."},"examples":[{"title":"Save an item in a collection","content":"import wixData from 'wix-data';\n\n// ...\n\nlet toSave = {\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n};\n\nwixData.save(\"myCollection\", toSave)\n .then((results) => {\n console.log(results); //see item below\n })\n .catch((err) => {\n console.log(err);\n });\n\n/* item is:\n *\n * {\n * \"_id\": \"rifk4nrk-dj4o-djhe-oidk-fnoqw4oiglk4i\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\"\n * }\n */"},{"title":"Save an item with a specified ID in a collection","content":"import wixData from 'wix-data';\n\n// ...\n\nlet toSave = {\n \"_id\": \"00001\",\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n};\n\nwixData.save(\"myCollection\", toSave)\n .then((results) => {\n console.log(results); //see item below\n })\n .catch((err) => {\n console.log(err);\n });\n\n/* item is:\n *\n * {\n * \"_id\": \"00001\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\"\n * }\n */"},{"title":"Save an item in a collection using data options","content":"import wixData from 'wix-data';\n\n// ...\n\nlet toSave = {\n \"_id\": \"00001\",\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n};\n\nlet options = {\n \"suppressAuth\": true,\n \"suppressHooks\": true\n};\n\nwixData.save(\"myCollection\", toSave, options)\n .then((results) => {\n console.log(results); //see item below\n })\n .catch((err) => {\n console.log(err);\n });\n\n/* item is:\n *\n * {\n * \"_id\": \"00001\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\"\n * }\n */"},{"title":"Save an item including a reference to another item using the referenced item's ID","content":"import wixData from 'wix-data';\n\n// ...\n\nlet countryId = \"id-of-usa-item\";\n\nlet toSave = {\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"country\": countryId\n};\n\nwixData.save(\"myCollection\", toSave)\n .then((results) => {\n console.log(results); //see item below\n })\n .catch((err) => {\n console.log(err);\n });\n\n/* item is:\n *\n * {\n * \"_id\": \"rifk4nrk-dj4o-djhe-oidk-fnoqw4oiglk4i\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\",\n * \"country\": \"id-of-usa-item\"\n * }\n */"},{"title":"Save an item including a reference to another item using the reference item","content":"import wixData from 'wix-data';\n\n// ...\n\nlet countryItem = // get country item from somewhere\n\nlet toSave = {\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"country\": countryItem\n};\n\nwixData.save(\"myCollection\", toSave)\n .then((results) => {\n console.log(results); //see item below\n })\n .catch((err) => {\n console.log(err);\n });\n\n/* item is:\n *\n * {\n * \"_id\": \"rifk4nrk-dj4o-djhe-oidk-fnoqw4oiglk4i\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\",\n * \"country\": \"id-of-usa-item\"\n * }\n */"}],"actionParams":[{"name":"collectionId","slug":"collection-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the collection to save the item to.\r\n\r\nTo find your `collectionId`, select the **Databases** tab in the [Velo Sidebar](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar).\r\nHover over your collection, click the three dots, and select **Edit Settings**."},{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"object"},"description":"The item to insert or update."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataOptions","referenceFqn":"WixDataOptions"},"description":"An object containing options to use when processing this operation."}],"description":"Inserts or updates an item in a collection.\r\n\r\nThe `save()` function returns a Promise that resolves to the inserted or\r\n updated item after it has been added or updated in\r\n the specified collection. The Promise is rejected if the\r\n current user does not have the necessary permissions for the collection.\r\n\r\n The `save()` function inserts or updates the specified item, depending on\r\n whether it already exists in the collection. It compares the `_id` property\r\n value of the specified item with the `_id` property values of the items in\r\n the specified collection. If an item in the collection has that `_id` value,\r\n `save()` uses [`update()`](#update) to update the item in the\r\n collection, triggering the [`beforeUpdate()`](wix-data.Hooks.html#beforeUpdate)\r\n and [`afterUpdate()`](wix-data.Hooks.html#afterUpdate) hooks if they have\r\n been defined. If none of the items in the collection contain that `_id` value, the\r\n specified item does not have an `_id` property, or if the specified item's `id` property\r\n is `undefined`, `save()` uses [`insert()`](#insert) to add the specified item to the\r\n collection. This triggers the [`beforeInsert()`](wix-data.Hooks.html#beforeInsert)\r\n and [`afterInsert()`](wix-data.Hooks.html#afterInsert) hooks if they have\r\n been defined.\r\n\r\n Use the `options` parameter to run `save()` from backend code without\r\n checking for permissions or without its registered hooks.\r\n\r\n When saving an item to a collection that has a reference field, set\r\n the value of the reference field to the referenced item's `_id` value or\r\n the entire referenced item object.\r\n\r\n The maximum size of an item that you can save to a collection is 500kb.\r\n\r\n > **Notes:**\r\n > - If an item's `_id` property value is set to `null` or an empty string, an error is thrown.\r\n > - The `save()` function does not support multi-reference fields. For multi-reference fields, use [`insertReference()`](https://www.wix.com/velo/reference/wix-data/insertreference) or [`replaceReferences()`](https://www.wix.com/velo/reference/wix-data/replacereferences)\r\n > - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `save()` will fail and issue an error."},{"name":"sort","fqn":"sort","slug":"sort","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataSort","referenceFqn":"WixDataSort.WixDataSort","description":"A sort object."},"examples":[{"title":"Sort a dataset","content":"import wixData from 'wix-data';\n\n// ...\n\n$w(\"#myDataset\").setSort( wixData.sort()\n .ascending(\"lastName\")\n .descending(\"age\")\n);"}],"description":"Creates a sort to be used with the dataset `setSort()` function.\r\n\r\nThis function is not used on its own. It is only used to create a sort\r\n for a dataset using the [`setSort()`](https://dev.wix.com/docs/velo/api-reference/wix-dataset/dataset/set-sort) function.\r\n\r\nWhen working with [Wix app collections](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code), check [which fields](https://support.wix.com/en/search?term=velo%20collection%20fields) can be used in a sort."},{"name":"truncate","fqn":"truncate","slug":"truncate","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["collectionId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"object"},"description":"Fulfilled - When the items have been removed.\r\nRejected - The error that caused the rejection."},"examples":[{"title":"Site owner removes all items from a collection","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.truncate(\"myCollection\")\n .then(() => {\n console.log(\"All items removed\");\n })\n .catch((err) => {\n console.log(err);\n });"},{"title":"User who is not the site owner removes all items from a collection in the backend using data options","content":"import wixData from 'wix-data';\n\n// ...\n\nlet options = {\n \"suppressAuth\": true\n};\n\nwixData.truncate(\"myCollection\", options)\n .then(() => {\n console.log(\"All items removed\");\n })\n .catch((err) => {\n console.log(err);\n });"}],"actionParams":[{"name":"collectionId","slug":"collection-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the collection to remove items from.\r\n\r\nTo find your `collectionId`, select the **Databases** tab in the [Velo Sidebar](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar).\r\nHover over your collection, click the three dots, and select **Edit Settings**."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataOptions","referenceFqn":"WixDataOptions"},"description":"An object containing options you can use when calling this function."}],"description":"Removes all items from a collection.\r\n\r\nThe `truncate()` function returns a Promise that resolves\r\n after all items have been removed from the specified collection.\r\n\r\n `truncate()` runs when at least one of the following is true:\r\n\r\n + The current user is the site owner.\r\n + The request is performed in backend code with a `suppressAuth` options value of `true`.\r\n\r\n\r\n Calling the `truncate()` function does not trigger any hooks.\r\n\r\n > **Note:** `truncate()` also clears multiple-item reference fields in collections referenced by the specified collection.\r\n For example, suppose you have a **Movies** collection with an **Actors** field that contains multiple references\r\n to items in a **People** collection. Truncating the **Movies** collection also clears the data in the corresponding\r\n multiple-item reference field in the **People** collection."},{"name":"update","fqn":"update","slug":"update","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["collectionId","item"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"object"},"description":"Fulfilled - The object that was updated.\r\nRejected - The error that caused the rejection."},"examples":[{"title":"Update an item with a specified ID in a collection","content":"import wixData from 'wix-data';\n\n// ...\n\nlet toUpdate = {\n \"_id\": \"00001\",\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n};\n\nwixData.update(\"myCollection\", toUpdate)\n .then((results) => {\n console.log(results); //see item below\n })\n .catch((err) => {\n console.log(err);\n });\n\n/* item is:\n *\n * {\n * \"_id\": \"00001\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\"\n * }\n */"},{"title":"Update an item in a collection using data options","content":"import wixData from 'wix-data';\n\n// ...\n\nlet toUpdate = {\n \"_id\": \"00001\",\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n};\n\nlet options = {\n \"suppressAuth\": true,\n \"suppressHooks\": true\n};\n\nwixData.update(\"myCollection\", toUpdate, options)\n .then((results) => {\n console.log(results); //see item below\n })\n .catch((err) => {\n console.log(err);\n });\n\n/* item is:\n *\n * {\n * \"_id\": \"00001\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\"\n * }\n */"},{"title":"Get an item in a collection and update it","description":"This example demonstrates the `get()` function followed by the `update()` function. When updating an item in a collection, all\n existing item properties must be passed to the `update()` function. If only the changed property is passed, the values of the\n other item properties will be lost. To ensure all item properties are included in the update, perform a `get()` on the item,\n change a property, and then `update()` the item.","content":"import wixData from 'wix-data';\n\n/* existing item:\n *\n * {\n * \"_id\": \"00001\",\n *\t \"title\": \"Mr.\",\n *\t \"first_name\": \"John\",\n * \"last_name\": \"Doe\"\n * }\n *\n */\n\nwixData.get(\"myCollection\", \"00001\")\n .then((item) => {\n item.last_name = \"Smith\"; // updated last name\n wixData.update(\"myCollection\", item);\n console.log(item); //see item below\n })\n .catch((err) => {\n console.log(err);\n }); \n\n\n/* updated item:\n *\n * {\n * \"_id\": \"00001\",\n *\t \"title\": \"Mr.\",\n *\t \"first_name\": \"John\",\n * \"last_name\": \"Smith\"\n * }\n *\n */\n"},{"title":"Query an item in a collection and update it","description":"This example demonstrates the `query()` function followed by the `update()` function. When updating an item in a collection, all\n existing item properties must be passed to the `update()` function. If only the changed property is passed, the values of the\n other item properties will be lost. To ensure all item properties are included in the update, perform a `query()` on the item,\n change a property, and then `update()` the item.","content":"import wixData from 'wix-data';\n\n/* existing item:\n *\n * {\n * \"_id\": \"00001\",\n *\t \"title\": \"Mr.\",\n *\t \"first_name\": \"John\",\n * \"last_name\": \"Doe\"\n * }\n *\n */\n\n wixData.query(\"myCollection\")\n .eq(\"first_name\", \"John\")\n .eq(\"last_name\", \"Doe\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let item = results.items[0];\n item.last_name = \"Smith\"; // updated last name\n wixData.update(\"myCollection\", item);\n console.log(item); //see item below\n } else {\n // handle case where no matching items found\n }\n })\n .catch((err) => {\n console.log(err);\n });\n\n/* updated item:\n *\n * {\n * \"_id\": \"00001\",\n *\t \"title\": \"Mr.\",\n *\t \"first_name\": \"John\",\n * \"last_name\": \"Smith\"\n * }\n *\n */\n"},{"title":"Update an item including a reference to another item using the referenced item's ID","content":"import wixData from 'wix-data';\n\n// ...\n\net countryId = \"id-of-usa-item\";\n\nlet toUpdate = {\n \"_id\": \"00001\",\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"country\": countryId\n};\n\nwixData.update(\"myCollection\", toUpdate)\n .then((results) => {\n console.log(results); //see item below\n })\n .catch((err) => {\n console.log(err);\n });\n\n/* item is:\n *\n * {\n * \"_id\": \"rifk4nrk-dj4o-djhe-oidk-fnoqw4oiglk4i\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\",\n * \"country\": \"id-of-usa-item\"\n * }\n */"},{"title":"Update an item including a reference to another item using the referenced item","content":"import wixData from 'wix-data';\n\n// ...\n\nlet countryItem = // get country item from somewhere\n\nlet toUpdate = {\n \"_id\": \"00001\",\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"country\": countryItem\n};\n\nwixData.update(\"myCollection\", toUpdate)\n .then((results) => {\n console.log(results); //see item below\n })\n .catch((err) => {\n console.log(err);\n });\n\n/* item is:\n *\n * {\n * \"_id\": \"rifk4nrk-dj4o-djhe-oidk-fnoqw4oiglk4i\",\n * \"_owner\": \"ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb\",\n * \"_createdDate\": \"2017-05-24T12:33:18.938Z\",\n * \"_updatedDate\": \"2017-05-24T12:33:18.938Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\",\n * \"country\": \"id-of-usa-item\"\n * }\n */"},{"title":"Update a collection using a custom function","description":"In this example, we demonstrate how you can you can build a CRUD \"update\" function using `update()`. You can test out the code in our [example template](https://manage.wix.com/edit-template/from?originTemplateId=d802a21e-b944-4bfb-92c3-eb4efd6fdee4&templateId=839cba18-7956-4dbc-bf2b-5b416b4097b6&autoDevMode=true).","content":"import wixData from 'wix-data';\n\n// Code for an update operation using update() //\n\nfunction updateGreeting(itemId, language, greeting) {\n const toUpdate = {\n _id: itemId,\n language,\n greeting\n };\n\n return wixData.update('Greetings', toUpdate);\n}\n"}],"actionParams":[{"name":"collectionId","slug":"collection-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the collection that contains the item to update.\r\n\r\nTo find your `collectionId`, select the **Databases** tab in the [Velo Sidebar](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar).\r\nHover over your collection, click the three dots, and select **Edit Settings**."},{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"object"},"description":"The item to update."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataOptions","referenceFqn":"WixDataOptions"},"description":"An object containing options to use when processing this operation."}],"description":"Updates an item in a collection.\r\n\r\nThe `update()` function returns a Promise that resolves to the updated\r\n item from the specified collection. The Promise is rejected if the\r\n current user does not have update permissions for the collection.\r\n\r\n Calling the `update()` function triggers the [`beforeUpdate()`](wix-data.Hooks.html#beforeUpdate)\r\n and [`afterUpdate()`](wix-data.Hooks.html#afterUpdate) hooks if they have been defined.\r\n\r\n\r\n The `update()` function compares the `_id` property of the specified\r\n item with the `_id` property values of the items in the specified\r\n collection. If an item in the collection has that `_id` value, `update()`\r\n replaces the item's property values with the ones in the specified item.\r\n If the existing item had properties with values and those properties were not\r\n included in the specified item, the values in those properties are lost. The\r\n item's `_updatedDate` property is also updated to the current date.\r\n\r\n Any valid JavaScript object can be used as a property value. The `update()`\r\n function maintains the structure of the specified object. For example,\r\n objects that contain nested objects, Arrays, or Arrays with nested objects\r\n are all added to the collection as defined.\r\n\r\n Use the `options` parameter to run `update()` from backend code without\r\n checking for permissions or without its registered hooks.\r\n\r\n When updating an item in a collection that has a reference field, set\r\n the value of the reference field to the referenced item's `_id` value or\r\n the entire referenced item object.\r\n\r\nThe maximum size of an item that you can update in a collection is 500kb.\r\n\r\n >**Notes:**\r\n > - The specified item must include an `_id` property that already exists in the collection.\r\n > - The `update()` function does not support multi-reference fields. For multi-reference fields, use [`replaceReferences()`](https://www.wix.com/velo/reference/wix-data/replacereferences) or [`insertReference()`](https://www.wix.com/velo/reference/wix-data/insertreference).\r\n > - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `update()` will fail and issue an error."}],"webhooks":[],"articles":[{"content":"# Introduction\nThe Data API allows you to interact programmatically with your site's [database collections](https://support.wix.com/en/article/content-manager-creating-a-collection). \n \n With the Data API, you can:\n\n + Manage the data in your site's collections.\n + [Filter](https://www.wix.com/velo/reference/wix-data/wixdatafilter), [sort](https://www.wix.com/velo/reference/wix-data/wixdatasort), and [query](https://www.wix.com/velo/reference/wix-data/query) your data.\n + Intercept interactions with your collections using [data hooks](https://www.wix.com/velo/reference/wix-data/hooks).\n + Work programmatically with [reference fields](https://support.wix.com/en/article/cms-using-reference-fields-to-display-content-from-multiple-collections).\n + [Aggregate](https://www.wix.com/velo/reference/wix-data/aggregate) data from your collections.\n\n For more information, see [Working with the Data API](https://support.wix.com/en/article/velo-working-with-the-data-api) and [Overview of the Wix Data and Wix Dataset APIs](https://support.wix.com/en/article/velo-overview-of-the-wix-data-and-wix-dataset-apis).\n\n Get hands-on experience with the Data API on our [Hello Data](https://www.wix.com/velo/example/hello-data) example page.\n\n To use the data module, import `wixData` from the `wix-data` module:\n\n ``` javascript\n import wixData from 'wix-data';\n ```\n\n ## Before you begin\n \n It's important to note the following points before starting to code:\n\n + The Data API can be used in your site’s frontend or backend code.\n + The maximum size of an item that you can save to a collection is 500 kb.\n + When using data retrieval methods such as `query()` or `get()` following a change to your database collection, the data retrieved may not yet contain \n your most recent changes. See [Wix-data and Eventual Consistency](https://www.wix.com/velo/reference/wix-data/introduction#wix-data_introduction_wix-data-and-eventual-consistency) for more information.\n + When querying [Wix App Collections](https://support.wix.com/en/article/content-manager-working-with-wix-app-collections), check which fields can be filtered in the relevant [collection field article](https://support.wix.com/en/search?term=velo%20collection%20fields).\n + 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. \n + [Updating](https://dev.wix.com/docs/velo/api-reference/wix-data/update) a collection item replaces the existing database item. If the existing item had properties with values and those properties are not included in the updated item, \n the values in those properties are lost.\n + Aggregations can only be used on collections you created. They cannot be used on [Wix App Collections](https://support.wix.com/en/article/content-manager-working-with-wix-app-collections).\n + Some functions don't apply to [Single Item Collections](https://support.wix.com/en/article/content-manager-about-collections-with-a-single-item).\n + Depending on the [permissions](https://support.wix.com/en/article/collection-permissions-an-overview) defined for your database collection, \n your site visitors may not have the permissions required to run a specific function. A function called with insufficient permissions will fail. When necessary, you can override permission \n checks in backend code by using the `SuppressAuth` option.\n + You can connect [external database collections](https://support.wix.com/en/article/velo-integrating-external-databases-with-your-wix-site) to your Wix site and use any of the Wix Data APIs to manage and retrieve data from those collections. \n\n \n ## Terminology\n \n + **Aggregate**: Perform calculations on collection data to retrieve meaningful summaries. \n + **Distinct**: Function that returns the distinct values that match a query, without duplicates.\n + **Hooks**: Hooks run code before or after certain interactions with your site's collections, sometimes allowing you to interact with \n the data handled in the interaction. For example, you can use the [`beforeInsert()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-insert) hook to capitalize text before it's inserted into a collection.\n + **Query**: Retrieve information from a database.\n + **Reference field**: Fields in a database collection that let you link one collection with other collections. \n Specifically, a reference field associates an item in one collection with an item in a different collection.\n + **Truncate**: Removes all items from a collection.\n\n \n ### Data Types\n\n The Wix Data API works with a schemaless database behind the scenes. In theory,\n you can store any type of data in any database collection field. In practice, each collection has a\n non-enforced schema that you should conform to. This schema is used to determine\n which page elements can connect to which fields and to provide a better experience\n in the [Content Management System (CMS)](https://support.wix.com/en/article/managing-your-database-collections-5018117).\n For example, if you set a field's type to **Date and Time**, you can then connect\n that field to elements that work with dates, such as DatePicker and Text elements.\n Also, in the CMS, values will appear as dates and you can add new values\n using a date picker.\n\n The following is a list of the field types from database collections and their\n corresponding JavaScript data types. When you retrieve data from a collection,\n that data will be represented in the JavaScript data types that correspond\n to your collection's field types. When you add or update data in a collection,\n you should provide the data using the JavaScript data types that correspond to your\n collection's field types.\n\n\n|Field Type|Data Type|Notes|\n|----------|---------|-----|\n|Address| JavaScript object| An Address object as described [here]($w.AddressInput.html#value).|\n|Array|JavaScript array||\n|Audio| JavaScript string| A Media Manager audio URL as described [here]($w.AudioPlayer.html#src).|\n|Boolean| JavaScript boolean|| \n|Date and Time| JavaScript Date object| Note that Javascript Date Objects are displayed as strings. Learn more about [Date Fields](https://support.wix.com/en/article/velo-working-with-the-data-api#date-fields).|\n|Date| JavaScript string | A date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date format (YYYY-MM-DD). Learn more about [Date Fields](https://support.wix.com/en/article/velo-working-with-the-data-api#date-fields).| \n|Document| JavaScript string| A Media Manager document URL in the following format: `wix:document://`.|\n|Image| JavaScript string| An image URL as described [here](https://www.wix.com/velo/reference/$w/image/src).|\n|Media Gallery| JavaScript array| Each element in the array is either an `ImageItem` or `VideoItem` as described [here]($w.Gallery.html#items).|\n|Number| JavaScript number|| \n|Object| JavaScript object|| \n|Rich Text| JavaScript string| A string which can contain a [subset of HTML tags]($w.Text.html#formatting-text).|\n|Reference/Multiple Items Reference| JavaScript string/JavaScript array of strings| An item ID or multiple items IDs from the referenced collection.|\n|Tags| JavaScript string array|| \n|Text| JavaScript string|| \n|Time| JavaScript string| Time in the HH.mm.ss.SSS format.|\n|URL|JavaScript string| A valid URL.|\n|Video| JavaScript string| A video URL as described [here]($w.Gallery.html#items).|\n\n\n### Wix Data and Eventual Consistency\n\nWix Data stores your data in a primary database instance, as well as several geographically dispersed mirror instances. The wix-data API is eventually consistent,\nmeaning that it always updates your data in the primary database instance first, then propagates your changes to the mirror instances. When you update your database collection,\nthere may be a short delay (typically a few seconds) until all mirror instances are up to date with your recent changes.\n\nWhen you call a data retrieval function, your request goes to the closest mirror database instance. This saves time, as the request and response don't have to travel as far. However,\nif you attempt to retrieve data shortly after updating it, your latest changes may not yet be reflected in the data you get back. For example, initially `wixData.get('Collection', 'x');` may resolve to\n`null` following `wixData.insert('Collection', { _id: 'x' });`. \n \nIf you need a data retrieval function to get fully up-to-date data immediately after an update, you can set the `consistentRead` property in the `options` parameter to `true`. \nThis slows down the operation but ensures the data is retrieved from the up-to-date primary database instance.\n\n### Data Quotas\n\nWix places quotas on requests made by your site using the wix-data API. These quotas affect the number of requests your site can make per minute and\nthe amount of time your requests can run for. Learn more about [data quotas](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/premium-plans/data-platform-features) and how to work with them.","displayName":"Introduction","slugifyName":"introduction"},{"content":"# Wix Data Error Codes\n\nWhen you use the Wix Data API, you may encounter errors. This list includes the error codes and messages returned by the API and more information to help you resolve issues. If an error persists, [contact support](https://www.wix.com/contact) for help.\n\n|

Code

Message

| Description |\n|---------------------------------------|---------|-----------------|\n|WDE0001| Collection name must be a string.| Check that the collection name you provided is a valid string. |\n|WDE0002| Item ID must be a string.| Check that the item `_id` you provided is a valid string. |\n|WDE0003| Field name must be a string.| Check that the field name you provided is a valid string. |\n|WDE0004| Failed to save {item name} into {collection name}. Items must be JavaScript objects.| Check that the item you're saving is a valid JavaScript object. |\n|WDE0005| Failed to bulk save items into {collection name}. Items must be an array of JavaScript objects and item IDs must be strings if present.| One or more of the items you tried to save was invalid. Check that the items are an array of valid JavaScript objects and that any `_id` properties in the items are strings. A valid ID key-value pair looks like this:
`'_id': 'ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb'`. |\n|WDE0006| Failed to bulk save items into {collection name}. Cannot insert more than 1000 items in one request.| You tried to save too many items at once. Avoid this error by splitting up your request into batches of fewer than 1000 items. |\n|WDE0007|Invalid update. Updated object must have an _id property that is a string.| Check that the object you passed for the `item` parameter has a property called `_id` whose value is a valid string.|\n|WDE0008|wixData.{the function you called} expects between {minimum} and {maximum} arguments, but was called with {the number of arguments you provided}.| The wrong number of arguments were passed to the function. Check your code to make sure that you are passing a valid number of arguments, and that you separate the argument values with commas.|\n|WDE0009| Document is too large.| The maximum size for a single collection item is 512 KB. Check that the items you're adding are smaller than this.|\n|WDE0011| Invalid filter usage. .filter requires WixDataFilter.| Check that the argument passed to the WixDataAggregate [`filter()`](https://dev.wix.com/docs/velo/api-reference/wix-data/wix-data-aggregate/filter) function is a valid [WixDataFilter](https://dev.wix.com/docs/velo/api-reference/wix-data/wix-data-filter/introduction) object. |\n|WDE0012| Invalid {function you called} usage. Filter is already set.| You are trying to use this function to set a filter, but you've already set one. You can only set one filter at a time. Check your code to see where the previous filter was set. |\n|WDE0013| Invalid group usage. Group is already set.| You are trying to use the [`group()`](https://dev.wix.com/docs/velo/api-reference/wix-data/wix-data-aggregate/group) function to set a group for your aggregation, but you've already set one. You can only set one group at a time. Check your code to see where the previous group was set. |\n|WDE0014| Requests per minute quota exceeded.| Your site has exceeded the quota of the maximum number of data requests per minute. Learn more about [this quota](https://support.wix.com/en/article/velo-about-data-quotas#requests-per-minute) and how to prevent this error. |\n|WDE0016| Filter must be an object.| Check that your filter is a valid WixDataFilter object. See the [API Reference](https://dev.wix.com/docs/velo/api-reference/wix-data/wix-data-filter/introduction) to learn how to build one. |\n|WDE0018| Options must be an object with one or all of the following boolean properties: {expected properties for your function}|Check that the `options` object you provided for a function is valid.

For example, the [`save()`](https://dev.wix.com/docs/velo/api-reference/wix-data/save) function accepts 2 optional properties in its `options` parameter, `supressAuth`, and `supressHooks`. Defining an `options` parameter that has one of those properties whose value isn't a boolean results in an error.

To find the appropriate `options` properties for the function you're using, consult the API Reference. |\n|WDE0019| Reference operation takes a string ID or an object with an ID to be connected.|Check that the argument passed to a function dealing with reference fields is either an item ID string or an object with an `_id` field. This error applies to the `referringItem` and `referencedItem` parameters of the [`isReferenced()`](https://dev.wix.com/docs/velo/api-reference/wix-data/is-referenced), [`replaceReferences()`](https://dev.wix.com/docs/velo/api-reference/wix-data/replace-references), and [`removeReference()`](https://dev.wix.com/docs/velo/api-reference/wix-data/remove-reference) functions and the `item` parameter of [`queryReferenced()`](https://dev.wix.com/docs/velo/api-reference/wix-data/query-referenced) function. |\n|WDE0020| Provided relationship attribute {your field name} is not a multi-reference field.| Check that the collection field you're adding a multi-reference value to is a multi-reference type. |\n|WDE0021| Invalid reference| Check that the referring and referenced items you provided are valid. A valid referring item is either an `_id` string or an object with an `_id` property. A valid referenced item is either an `_id` string, an object with an `_id` property, or an array of `_id` strings. |\n|WDE0022| Unable to execute a query. Only single multi-reference field can be included.| Your query includes more than the maximum of one multi-reference field. Learn more about [`include()`](https://dev.wix.com/docs/velo/api-reference/wix-data/wix-data-query/include). |\n|WDE0023| Cannot fetch more than 50 elements when include is being used on multi-reference field| Your query reached the limit of more than 50 referenced items. To retrieve more than 50 referenced items, use the [`queryReferenced()`](https://dev.wix.com/docs/velo/api-reference/wix-data/query-referenced) function. Learn more about [querying items that reference other items](https://support.wix.com/en/article/including-referenced-data-when-filtering). |\n|WDE0024| Field is deleted| The field you're trying to access was deleted. [Restore the collection](https://support.wix.com/en/article/cms-formerly-content-manager-backing-up-your-collections) in the Content Management System (CMS) before using the field in your code. |\n|WDE0025| The {your collection name} collection does not exist. You cannot work with a collection using the Data API before it is created in the Editor.| Check that the collection you're trying to access exists on your site. |\n|WDE0026| The {your collection name} collection was removed, so you cannot work with it. To restore its data, create a new collection with the same name.| You're trying to access a deleted collection in your code. [Restore the collection](https://support.wix.com/en/article/content-manager-restoring-a-deleted-collection) by creating a new collection with the same name.|\n|WDE0027| The current user does not have permissions to {some action} on the {your collection name} collection.| A data request was made with insufficient permissions. [Set up your collections permissions](https://support.wix.com/en/article/velo-security-best-practices#collection-permissions) based on your site's needs. |\n|WDE0028| Operation time limit exceeded.| Your data request ran for more than 5 seconds and timed out. The request was terminated. If this error persists, it may be because your request is working with large amounts of data. Learn more about [this quota](https://support.wix.com/en/article/velo-about-data-quotas#individual-request-timeout) and how to prevent this error. |\n|WDE0032| Invalid {operator} parameter {operand}. {operator} parameter must be a {specifier} number. | The argument passed to this function must be a valid number. |\n|WDE0033| Invalid {operator} parameter {operand}. {operator} parameter must be a positive number. | When calling `limit()`, the argument passed to this function must be a positive number. |\n|WDE0034| Invalid {operator} parameter {operand}. {operator} parameter must be a non-negative number.\t| When calling `skip()`, the argument passed to this function must be a non-negative number. |\n|WDE0035| Invalid {operator} parameter {operand}. {operator} parameter must be an integer. | The argument passed to this function must be an integer. |\n|WDE0036| Invalid {operator} parameter {operand}. {operator} parameter cannot exceed {value}. | The argument passed to this function cannot be larger than the specified value. |\n|WDE0037| Invalid query on {collection name}. Invalid prev positioned query skip on a negative number.| Internal Wix Data error occurred. |\n|WDE0038| Invalid {operator} usage. {operator} does not take parameters. | This function expects no arguments. |\n|WDE0039| Invalid {operator} usage. {operator} requires one parameter. | This function expects exactly one argument. |\n|WDE0040| Invalid {operator} usage. {operator} requires two parameters. | This function expects exactly two arguments. |\n|WDE0041| Invalid {operator} usage. {operator} requires three parameters. | This function expects exactly three arguments. |\n|WDE0042| Invalid {operator} usage. {operator} requires at least two parameters. | This function expects at least two arguments, but fewer were provided. |\n|WDE0043| Invalid {operator} usage. {operator} requires at least one parameter. | This function expects at least one argument, but none were provided. |\n|WDE0044| Invalid {function name} parameter value. {function name} parameter must be a string. | The argument passed to this function must be a string. |\n|WDE0045| Invalid {operator} parameter value {value}. Valid {operator} parameter types are string, Number or Date. | The argument passed to this function must be a string, number, or date object. |\n|WDE0046| Invalid {operator} parameter values {first} and {second}. Both parameters must be of the same type. | The arguments to this function must be of the same type. |\n|WDE0047| Invalid {operator} usage. {operator} supports only number, string or date items. | The arguments to this function must be strings, numbers, or date objects. |\n|WDE0048| Invalid {operator} field value {field}. {operator} field must be a string. | This field value must be a string. |\n|WDE0049| Invalid {operator} parameter {obj}. {operator} expects {constructor name} only. | The argument passed to this function must be a valid [Wix Data Query](https://dev.wix.com/docs/velo/api-reference/wix-data/wix-data-query/introduction) object. | \n|WDE0050| Invalid {operator} parameter query for {collection name}. {operator} accepts {constructor name} for the same collection only. | You can only chain functions that query the same collection. |\n|WDE0051| Invalid {operator} parameters {effective arguments}. Valid {operator} values are string, array of strings, or varargs string. | This function expects a string, an array of strings, or multiple strings (varargs) separated by commas. For example: `(\"key1\", \"key2\")`. |\n|WDE0052| The current site is in template mode. Please save it to modify data.| To modify collection data on a site created from a template, make sure to [save the site](https://support.wix.com/en/article/wix-editor-save-preview-and-publish-your-site#saving-your-site) first. |\n|WDE0053| Internal wixData error: {error message} | An unexpected error occurred. If the error persists, [contact support](https://www.wix.com/contact). |\n|WDE0054| WD_UNKNOWN_ERROR | An internal server error. Try running your code again. |\n|WDE0055| Failed to parse server response. | Wix Data could not parse the server response. Try querying again. |\n|WDE0056| {operator} should be an Object. Got {value} instead. | The argument passed to this function must be a valid object. Learn more about [data types in Wix Data](https://dev.wix.com/docs/velo/api-reference/wix-data/introduction#api-reference_wix-data_data-types). |\n|WDE0057| {operator} should be an Array. Got {value} instead. | The argument passed to this function must be a valid array. Learn more about [data types in Wix Data](https://dev.wix.com/docs/velo/api-reference/wix-data/introduction#api-reference_wix-data_data-types). |\n|WDE0058| {operator} should be a Date, number, or string. Got {value} instead. | The argument passed to this function must be a valid date object, a number, or a string. Learn more about [data types in Wix Data](https://dev.wix.com/docs/velo/api-reference/wix-data/introduction#api-reference_wix-data_data-types). |\n|WDE0059| {operator} should be a string. Got {value} instead | The argument passed to this function must be a valid string. Learn more about [data types in Wix Data](https://dev.wix.com/docs/velo/api-reference/wix-data/introduction#api-reference_wix-data_data-types). |\n|WDE0060| {operator} array should only contain values of types date, number, and string. Got {value} instead. | The array can only contain dates, objects, numbers, and strings. Learn more about [data types in Wix Data](https://dev.wix.com/docs/velo/api-reference/wix-data/introduction#api-reference_wix-data_data-types). |\n|WDE0061| `{$in}` Array should have length 2, and match { String, Number }. Got {value} instead. | Invalid parameter types. Learn more about [data types in Wix Data](https://dev.wix.com/docs/velo/api-reference/wix-data/introduction#api-reference_wix-data_data-types). |\n|WDE0062| `$matches` value {value} does not have property {property name} | The value specified in the `$matches` operator must contain the specified property. |\n|WDE0063| `$matches.ignoreCase` should equal true. Got {value} instead | Wix Data error encountered. Try modifying your query. If this error persists, [contact support](https://www.wix.com/contact).|\n|WDE0064| `$matches.spec` array values should be either {{\"type\":\"anyOf\",\"value\":\" -\"}} or {{\"type\":\"literal\",\"value\":String}}. Got {value} instead | Wix Data error encountered. Try modifying your query. If this error persists, [contact support](https://www.wix.com/contact). |\n|WDE0065| Sort Model should be an Array. Got {value} instead. | Wix Data error encountered. Try modifying your query. If this error persists, [contact support](https://www.wix.com/contact). |\n|WDE0066| Sort Model Array should contain values of type Object only. Got {value} instead | Wix Data error encountered. Try modifying your query. If this error persists, [contact support](https://www.wix.com/contact). |\n|WDE0067| Sort Model Array items should have a single property with value \"asc\" or \"desc\". Got {value} instead | Wix Data error encountered. Try modifying your query. If this error persists, [contact support](https://www.wix.com/contact). |\n|WDE0068| Item IDs must be an array of strings. | Check that the [`bulkRemove()`](https://dev.wix.com/docs/velo/api-reference/wix-data/bulk-remove) function received an array of strings representing the IDs of the items you want to remove as its second argument.

For example, `['ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb', 'afthj8s4-dt7u-g4fr-at23-6joedh34awshy']`. |\n|WDE0069| Failed to remove items from {collection name}. Cannot remove more than 1000 items in one request. | You tried to remove too many items from a collection at once. Split your request into batches of 1000 items or fewer. To remove all the items in a collection, use [`truncate()`](https://dev.wix.com/docs/velo/api-reference/wix-data/truncate). |\n|WDE0070| {regex} keyword is not allowed. | Wix Data error encountered. Try modifying your query. If this error persists, [contact support](https://www.wix.com/contact). |\n|WDE0073| Item {item ID} does not exist in collection {collection name}.| Check that an item with the ID you're requesting exists in the collection you're querying. |\n|WDE0074| WD_ITEM_ALREADY_EXISTS | An item with the requested ID value already exists. This error occurs when you try to insert an item into a collection with an `_id` value that already exists in that collection. If you are trying to either insert a new item or update it if it already exists, use [`save()`](https://dev.wix.com/docs/velo/api-reference/wix-data/save). |\n|WDE0075| WD_BAD_REQUEST| This error occurs when you make an invalid request using the [`aggregate()`](https://dev.wix.com/docs/velo/api-reference/wix-data/aggregate) function. See the [API reference](https://dev.wix.com/docs/velo/api-reference/wix-data/aggregate) for details on building the WixDataAggregate objects used with this function.|\n|WDE0076| Validation error. {error message from Wix app collection or external database}|A request to a [Wix app collection](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code) or an [external database](https://support.wix.com/en/article/velo-integrating-external-databases-with-your-wix-site) that you're working with returned with an error. Check that the data requests in your code are valid. |\n|WDE0077| 'limit' cannot exceed {maximum query limit} | The query [limit](https://dev.wix.com/docs/velo/api-reference/wix-data/wix-data-query/limit) you provided is greater than the maximum supported by the collection. Provide a lower value. |\n|WDE0078| Hook error.| The code for one of your [data hook](https://support.wix.com/en/article/velo-about-data-hooks) functions threw an error.

For example, consider an `afterInsert` data hook function in a `backend/data.js` file that includes this line of code: `throw new Error(\"sample error message\")`

Once you define this hook, calling the [`insert()`](https://dev.wix.com/docs/velo/api-reference/wix-data/insert) function results in the `WDE0078` error. |\n|WDE0079| {your collection name} is a single item collection and item must have id {expected ID}, but got {received ID} instead.| The item in a single item collection has a fixed `_id` value. Check that you aren't trying to change this value in your code. You can find the item's `_id` value using the [CMS](https://support.wix.com/en/article/about-the-content-manager-7160473#collections) or by using [`find()`](https://dev.wix.com/docs/velo/api-reference/wix-data/wix-data-query/find) without any filters. |\n|WDE0080| { Multiple possible values.} | This error occurs when you make an API call with invalid arguments. For example, if you use the [`query()`](https://dev.wix.com/docs/velo/api-reference/wix-data/query) function without providing a collection name as an argument. To resolve this error, check the API reference to make sure you're providing the right arguments in your code. |\n|WDE0091| Database quota exceeded. Delete some data and try again.| Your site has exceeded the collection storage quota. Learn more about [this quota](https://support.wix.com/en/article/velo-about-data-quotas#collection-storage) and what you can do to resolve this issue. |\n|WDE0092| Dataset is too large to sort.| The data you tried to sort didn't fit into memory. This usually occurs when large items are being sorted or there are too many items being sorted to fit into memory at once. [Add an index](https://support.wix.com/en/article/content-manager-adding-an-index-for-your-collection) to your collection to avoid using up memory. |\n|WDE0093| Invalid filter for _publishStatus field, only `.eq` and `.ne` filters are allowed with 'DRAFT' and 'PUBLISHED' possible values.| When you enable the [Draft and Publish Items](https://support.wix.com/en/article/content-manager-using-the-draft-publish-items-feature) feature for a collection, a `_publishStatus` field is added to every item in that collection. If you want to filter a data request based on this field, you can only use the [`eq()`](https://dev.wix.com/docs/velo/api-reference/wix-data/wix-data-filter/eq) and [`ne()`](https://dev.wix.com/docs/velo/api-reference/wix-data/wix-data-filter/ne) functions. The only valid values for `_publishedStatus` are `'DRAFT'` and `'PUBLISHED'`. Check that your code isn't using other filter functions or values with `_publishedStatus`. |\n|WDE0094| Invalid {operator} parameter. {operator} parameter must be non-empty string. | The argument passed to this function must be a non-empty string. |\n|WDE0109| Payload is too large. | The request is too big. Consider restructuring your data. If you are attempting to store a media file, consider using the [Wix Media](https://dev.wix.com/docs/velo/api-reference/wix-media-v2/files/introduction) API. |\n|WDE0110| WD_BAD_REQUEST. | System error. Please try running your code again. |\n|WDE0111| GridAppId must be provided in SANDBOX segment | To resolve this error, reload your site in the browser. |\n|WDE0115| WD_UNKNOWN_ERROR| Your external database requested an unsupported data operation. |\n|WDE0116| WD_UNKNOWN_ERROR| Your external database responded to Wix with an error. |\n|WDE0117| MetaSiteId can not be resolved. | System error. Please try running your code again. |\n|WDE0118| GridAppId {app ID} not found in instance {instance ID}. | Request provided an invalid gridAppId. To resolve this error, reload your site in the browser. |\n|WDE0120| {your collection name} does not support {function name} operation. | Some specialized collections, like the ones that hold data for Wix apps, don't support the full data API. This error occurs when you try to call a function that isn't supported by a specific collection. Remove the unsupported function call from your code. |\n|WDE0121| Sorting by multiple array fields is not supported| If there are multiple fields in your collection that contain arrays, you can't sort by both of them at once.

For example, consider a collection item that includes a field called `A` whose value is `[1,2,3]` and a field called `B` whose value is `[3,2,1]`. In this case, attempting to sort by both `A` and `B` at once results in an error. If your collection contains multiple fields that are arrays, check that you aren't trying to sort using more than one at once. |\n|WDE0123| Duplicated values cannot be added to a field with a unique index.| When you add a [unique index](https://support.wix.com/en/article/velo-indexes-and-wix-data-collections#working-with-unique-indexes) to a collection, each value for the indexed field in that collection must be unique. This error occurs when you try to add a duplicate value for the field. To resolve the error, use a unique value. |\n|WDE0128 | WD_UNKNOWN_ERROR | Your [external database adaptor](https://support.wix.com/en/article/velo-integrating-external-databases-with-your-wix-site) tried to create a collection item with no `_id` field. Check that any item created by an external adaptor contains this field. |\n|WDE0133 | Document field is too large to index, exceeds 1024 bytes. | This error occurs when you try to add a value to an indexed field that, together with other indexed fields, becomes too large. The total size of all indexed field values per item must be 1024 bytes or less. Learn more about [working with indexes](https://support.wix.com/en/article/velo-indexes-and-wix-data-collections) in your collections. |\n| WDE0134 | Field names with dollar ($) prefix are not allowed. | This error occurs when you try to add a field to a collection with a `$` at the beginning of its name. To resolve this error, remove the `$` from the name. |\n| WDE0144 | Issue with processing data. | You don't have permission to perform this action. Ask the collection administrator for the required permissions. |\n| WDE0149 | Internal application error. | This error occurs when a Wix app collection fails with a system or unrecognized error. To resolve the error, retry the request. If the request fails, [contact support](https://www.wix.com/contact). |\n| WDE0150 | Data hook syntax error. | This error occurs when your **data.js** file, or any other file it imports from, contains a JavaScript syntax error. To resolve this error, fix syntax errors in the JavaScript codebase. |\n| WDE0151 | Incorrect cursor provided. | Pagination error occurred: the query's cursor paging property contains an invalid cursor. Query the collection again to create a new cursor. |\n| WDE0152 | Cursor is expired. | Pagination error occurred: the query's cursor paging property contains an expired cursor. Query the collection again to create a new cursor. |\n| WDE0153| Reference {property in referencing collection} from {referencing item id} to {referenced item id} does not exist. | You are attempting to remove a multi-reference that does not exist. Check that the reference is correct. |\n| WDE0154 | The data collection share policy with ID {id} was not found. | A data sharing error occurred. Learn more about [sharing collections across sites](https://support.wix.com/en/article/wix-enterprise-sharing-cms-collections-with-sites-and-templates).|\n| WDE0155 | Data collection is already shared. | The specified data collection is already shared with this site. Learn more about [sharing collections across sites](https://support.wix.com/en/article/wix-enterprise-sharing-cms-collections-with-sites-and-templates). |\n| WDE0156 | Data collection {collection name} is not shared. | The specified collection is not shared with this site. Learn more about [sharing collections across sites](https://support.wix.com/en/article/wix-enterprise-sharing-cms-collections-with-sites-and-templates). |\n| WDE0157 | Field {property name} cannot be translated as {field type} data type is not translatable. | This field cannot be translated because its type is not supported by Wix Multilingual. For example, field types such as **Video** and **Number** cannot be marked as translatable. Learn more about [how Wix Multilingual works with the CMS](https://support.wix.com/article/wix-multilingual-translating-cms-collection-content#how-wix-multilingual-works-with-the-cms).|\n| WDE0158 | Multilingual plugin must have at least one translatable field. | To enable Wix Multilingual, mark at least one field as translatable. Learn more about [translation eligibility requirements for collections](https://support.wix.com/article/wix-multilingual-translating-cms-collection-content#translation-eligibility-requirements-for-collections). |\n| WDE0159| Invalid query on {collection name}. There is no prev page. | You are viewing the first page of results and cannot call `prev()`. If necessary, try running a different query. |\n| WDE0160| Index already exists as a system index. | The field you are attempting to index is a [system field](https://support.wix.com/article/cms-formerly-content-manager-about-your-collection-fields#system-fields) for which Wix Data already has an index. |\n| WDE0161 | Data collection {collection name} is not multilingual. | You are querying translated content, but the collection is not translatable. Add this collection to Wix Multilingual, or select a translatable collection. Learn more about [translating CMS collection content](https://support.wix.com/article/wix-multilingual-translating-cms-collection-content).|\n| WDE0162 | Language {language} is not enabled for data collection {collection name}. | The requested language is not available for this collection. Enable this language in Wix Multilingual. Learn more about [managing languages in a multilingual site](https://support.wix.com/article/wix-multilingual-managing-languages-in-a-multilingual-site). |\n| WDE0163 | Invalid value for the page link {field name}: {cause for error}. | The value of this [Page Link field](https://support.wix.com/article/cms-formerly-content-manager-about-your-collection-fields#page-link-fields) does not conform to the dynamic URL slug structure. Learn more about [URL slug structures](https://support.wix.com/en/article/cms-creating-unique-dynamic-page-urls#about-url-slugs-and-url-slug-structures). |\n| WDE0164 | The index {index name} with the same fields already exists in collection {collection id}. | An index already exists in this collection for the same fields. To create another index, select [different fields](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/indexes-and-wix-data-collections#which-fields-make-good-indexes). |\n| WDE0165 | Invalid query on {collection name}. There is no next page. | You are viewing the last page of results and cannot call `next()`. If necessary, try running a different query. |\n| WDE0167 | Aggregation item field name cannot end with `.` | Cannot apply aggregation to a field that ends with a dot character `.`. Change the field name or select another field to aggregate. |\n| WDE0168 | Document nesting level is too deep | A data item can contain up to 50 levels of nesting. Restructure the item to contain 50 nested levels or less. |\n| WDE0169 | Filter nesting level is too deep | A filter can contain up to 50 levels of nesting. Restructure your filter to contain 50 nested levels or less. |\n| WDE0170 | Data collection change is not supported. | This [external collection](https://dev.wix.com/docs/develop-websites/articles/databases/external-databases/overview/integrating-external-databases-with-your-wix-site) does not support this change. Check the external database's documentation to learn what modifications it supports. |\n|WDE0171 | Application not installed to access the {collection id} collection | The collection you are attempting to query was [created by a Wix app](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code#what-are-wix-app-collections), but that app is no longer installed on your site. |\n| WDE0172 | Data hook execution throttled. | The [data hook](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/hooks/about-data-hooks) was blocked due to built-in request limitations. Learn more about [backend requests in Velo](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/limits-and-optimization/compute-features#backend-requests-per-minute).|\n| WDE0173 | Aggregation item field name cannot be empty. | Cannot apply aggregation to an unnamed field. Learn more about [working with aggregations](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/aggregations/working-with-aggregations-in-the-data-api). |\n| WDE0174 | Multilingual is not supported in a Sandbox environment. | [Sandbox collections](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections) do not support translated content. To view translated content, use Wix Multilingual on Live collections. |\n| WDE0175 | Updates to translatable collections are not supported in the non-primary language {language}. | When viewed in a non-primary language, [translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow inserting or updating items. Only updates to non-translatable collections are allowed when viewing in a non-primary language. |\n","displayName":"Error Codes","slugifyName":"error-codes"}],"namespaces":[{"name":"Hooks","slug":"hooks","fqn":"Hooks","standaloneTypes":[],"metadata":{},"actions":[{"name":"afterCount","fqn":"Hooks.afterCount","slug":"after-count","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["count","context"],"adminMethod":false,"returnType":{"kind":"UNION","types":[{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"number"}},{"kind":"PRIMITIVE","name":"number"}],"description":"The count to return to [`count()`](wix-data.WixDataQuery.html#count) instead of the original count.\r\n Returning a rejected promise will not block the operation, but will return a rejected promise to the caller as well as trigger the [`onFailure()`](#onFailure) hook."},"examples":[{"title":"An afterCount hook","content":"// In data.js\n\nexport function myCollection_afterCount(count, context) {\n let hookContext = context; // see below\n\n // some change to the received count\n\n return count;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"},{"title":"Change the number returned by `count()` using an afterCount hook","content":"// In data.js\n\nexport function myCollection_afterCount(count, context) {\n let hookContext = context; // see below\n\n // return a value higher than the actual item count\n count += 5;\n\n return count;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"}],"actionParams":[{"name":"count","slug":"count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items the count operation has found."},{"name":"context","slug":"context","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"HookContext","referenceFqn":"Hooks.HookContext"},"description":"Contextual information about the hook."}],"description":"A hook that is triggered after a `count()` operation.\r\n\r\nThe `afterCount()` hook runs when:\r\n\r\n + The [`count()`](wix-data.WixDataQuery.html#count) function is called.\r\n + The collection is viewed in the CMS.\r\n\r\n\r\n Return a number or a Promise that resolves to number from the `afterCount()`\r\n function. The returned number will be used as the result of the call to\r\n [`count()`](wix-data.WixDataQuery.html#count) instead of the actual count of\r\n items found in the collection. If returning a Promise, the number is used as\r\n the result, whether the Promise is fulfilled or rejected.\r\n\r\n If the returned value is of the wrong type, the value is ignored.\r\n\r\n A rejected Promise also calls the [`onFailure()`](#onFailure) hook if it has\r\n been registered."},{"name":"afterGet","fqn":"Hooks.afterGet","slug":"after-get","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["item","context"],"adminMethod":false,"returnType":{"kind":"UNION","types":[{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"object"}},{"kind":"PRIMITIVE","name":"object"}],"description":"The item to return to [`get()`](wix-data.html#get) instead of the retrieved item.\r\n Returning a rejected promise will not block the operation, but will return a rejected promise to the operation caller as well as trigger the [`onFailure()`](#onFailure) hook."},"examples":[{"title":"An afterGet hook","content":"// In data.js\n\nexport function myCollection_afterGet(item, context) {\n let hookContext = context; // see below\n\n // some changes to the received item\n\n return item;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"},{"title":"Change the item returned by `get()` using an afterGet hook","content":"// In data.js\n\nexport function myCollection_afterGet(item, context) {\n let hookContext = context; // see below\n\n // add a full_name property to the item being returned\n item.full_name = item.first_name + \" \" + item.last_name;\n\n return item;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"}],"actionParams":[{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"object"},"description":"The item that was retrieved from the collection."},{"name":"context","slug":"context","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"HookContext","referenceFqn":"Hooks.HookContext"},"description":"Contextual information about the hook."}],"description":"A hook that is triggered after a `get()` operation.\r\n\r\nThe `afterGet()` hook runs when the [`get()`](wix-data.html#get)\r\n function is called.\r\n\r\n The hook does not run when the [`find`](wix-data.WixDataQuery.html#find)\r\n function is called or when a dataset retrieves items from the collection it\r\n is connected to.\r\n\r\n Return an object or a Promise that resolves to an object from the `afterGet()`\r\n function. The returned object will be used as the result of the call to the\r\n [`get()`](wix-data.html#get) function instead of the actual item found in the\r\n collection. If returning a Promise, the object is used as the result, whether\r\n the Promise is fulfilled or rejected.\r\n\r\n If the returned value is of the wrong type, the value is ignored.\r\n\r\n A rejected Promise also calls the [`onFailure()`](#onFailure) hook if it has\r\n been registered."},{"name":"afterInsert","fqn":"Hooks.afterInsert","slug":"after-insert","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["item","context"],"adminMethod":false,"returnType":{"kind":"UNION","types":[{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"object"}},{"kind":"PRIMITIVE","name":"object"}],"description":"The item to return to [`insert()`](wix-data.html#insert) instead of the inserted item.\r\n Returning a rejected promise will not block the operation, but will return a rejected promise to the caller as well as trigger the [`onFailure()`](#onFailure) hook."},"examples":[{"title":"An afterInsert hook","content":"// In data.js\n\nexport function myCollection_afterInsert(item, context) {\n let hookContext = context; // see below\n\n // some changes to the received item\n\n return item;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"},{"title":"Change the item returned by `insert()` using an afterInsert hook","content":"// In data.js\n\nexport function myCollection_afterInsert(item, context) {\n let hookContext = context; // see below\n\n //add a new property to the item being returned that aggregates the content from several fields into one\n item.combinedSentence = `Customer: ${item.lastName}, ${item.firstName}: Purchases: ${item.purchases}, Item Returns: ${item.returns}`;\n\n return item;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"}],"actionParams":[{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"object"},"description":"The item that was inserted."},{"name":"context","slug":"context","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"HookContext","referenceFqn":"Hooks.HookContext"},"description":"Contextual information about the hook."}],"description":"A hook that is triggered after an `insert()` operation.\r\n\r\nThe `afterInsert()` hook runs when:\r\n\r\n + The [`insert()`](wix-data.html#insert) function is called.\r\n + An action is performed on a dataset that inserts a new item into the collection.\r\n + An item is inserted using the CMS.\r\n + An item is imported into the Sandbox or Live collection.\r\n\r\n\r\n Return an object or a Promise that resolves to an object from the `afterInsert()`\r\n function. The returned object will be used as the result of the call to the\r\n [`insert()`](wix-data.html#insert) function instead of the actual item inserted\r\n into the collection. If returning a Promise, the object is used as the result,\r\n whether the Promise is fulfilled or rejected.\r\n\r\n If the returned value is of the wrong type, the value is ignored.\r\n\r\n A rejected Promise also calls the [`onFailure()`](#onFailure) hook if it has\r\n been registered.\r\n\r\n Because the `afterInsert` hook is called after the [`insert()`](wix-data.html#insert)\r\n is executed, it cannot affect the item that is inserted into the collection.\r\n It can only affect the item returned by [`insert()`](wix-data.html#insert)."},{"name":"afterQuery","fqn":"Hooks.afterQuery","slug":"after-query","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["item","context"],"adminMethod":false,"returnType":{"kind":"UNION","types":[{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"object"}},{"kind":"PRIMITIVE","name":"object"}],"description":"The item to return to [`find`](wix-data.WixDataQuery.html#find) instead of the item retrieved from the database.\r\n Returning a rejected promise will not block the operation, but will return a rejected promise to the operation caller as well as trigger the [`onFailure()`](#onFailure) hook."},"examples":[{"title":"An afterQuery hook","content":"// In data.js\n\nexport function myCollection_afterQuery(item, context) {\n let hookContext = context; // see below\n\n // some changes to the received item\n\n return item;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"},{"title":"Change the item returned by `find()` using an afterQuery hook","content":"// In data.js\n\nexport function myCollection_afterQuery(item, context) {\n let hookContext = context; // see below\n\n // add a full_name property to the item being returned\n item.full_name = item.first_name + \" \" + item.last_name;\n\n return item;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"}],"actionParams":[{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"object"},"description":"One of the items of the query result. The hook is called for each item in the results."},{"name":"context","slug":"context","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"HookContext","referenceFqn":"Hooks.HookContext"},"description":"Contextual information about the hook."}],"description":"A hook that is triggered after a `find` operation, for each of the items in the query results.\r\n\r\nThe `afterQuery()` hook runs when:\r\n\r\n + The [`find`](wix-data.WixDataQuery.html#find) function is called.\r\n + An action is performed on a dataset that retrieves items from the collection.\r\n + The collection is viewed in the CMS.\r\n + An item is exported from the collection.\r\n\r\n\r\n The hook runs once for each item in the collection.\r\n\r\n Return an object or a Promise that resolves to an object from the `afterQuery()`\r\n function. The returned object will be used as the result of the call to the\r\n [`find`](wix-data.WixDataQuery.html#find) function instead of the actual item\r\n found in the collection. If returning a Promise, the object is used as the\r\n result, whether the Promise is fulfilled or rejected.\r\n\r\n If the returned value is of the wrong type, the value is ignored.\r\n\r\n A rejected Promise also calls the [`onFailure()`](#onFailure) hook if it has\r\n been registered.\r\n\r\n> **Note:**\r\n> We recommend implementing `afterQuery()` with in-memory operations only. Don't use network calls such as REST API requests\r\n> or other wix-data operations, as these can lead to timeouts and issues loading collection data."},{"name":"afterRemove","fqn":"Hooks.afterRemove","slug":"after-remove","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["item","context"],"adminMethod":false,"returnType":{"kind":"UNION","types":[{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"object"}},{"kind":"PRIMITIVE","name":"object"}],"description":"The item to return to [`remove()`](wix-data.html#remove) instead of the deleted item.\r\n Returning a rejected promise will not block the operation, but will return a rejected promise to the caller as well as trigger the [`onFailure()`](#onFailure) hook."},"examples":[{"title":"An afterRemove hook","content":"// In data.js\n\nexport function myCollection_afterRemove(item, context) {\n let hookContext = context; // see below\n\n // some changes to the removed item\n\n return item;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"},{"title":"Change the item returned by `remove()` using an afterRemove hook","content":"// In data.js\n\nexport function myCollection_afterUpdate(item, context) {\n let hookContext = context; // see below\n\n // add a full_name property to the item being returned\n item.full_name = item.first_name + \" \" + item.last_name;\n\n return item;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"}],"actionParams":[{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"object"},"description":"The item that was removed."},{"name":"context","slug":"context","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"HookContext","referenceFqn":"Hooks.HookContext"},"description":"Contextual information about the hook."}],"description":"A hook that is triggered after a `remove()` operation.\r\n\r\nThe `afterRemove()` hook runs when:\r\n\r\n + The [`remove()`](wix-data.html#remove) function is called.\r\n + An action is performed on a dataset that removes an item from the collection.\r\n + An item is deleted using the CMS.\r\n\r\n\r\n Return an object or a Promise that resolves to an object. The returned object\r\n will be used as the result of the call to the [`remove()`](wix-data.html#remove)\r\n function instead of the actual item removed from the collection. If returning a\r\n Promise, the object is used as the result, whether the Promise is fulfilled or rejected.\r\n\r\n If the returned value is of the wrong type, the value is ignored.\r\n\r\n A rejected Promise also calls the [`onFailure()`](#onFailure) hook if it has\r\n been registered.\r\n\r\n Because the `afterRemove()` hook is called after the [`remove()`](wix-data.html#remove)\r\n is executed, it cannot prevent the item from being removed from the collection.\r\n It can only affect the item returned by [`remove()`](wix-data.html#remove)."},{"name":"afterUpdate","fqn":"Hooks.afterUpdate","slug":"after-update","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["item","context"],"adminMethod":false,"returnType":{"kind":"UNION","types":[{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"object"}},{"kind":"PRIMITIVE","name":"object"}],"description":"The item to return to [`update()`](https://dev.wix.com/docs/velo/api-reference/wix-data/update) instead of the updated item.\r\n Returning a rejected promise will not block the operation, but will return a rejected promise to the caller as well as trigger the [`onFailure()`](#onFailure) hook."},"examples":[{"title":"An afterUpdate hook","content":"// In data.js\n\nexport function myCollection_afterUpdate(item, context) {\n let hookContext = context; // see below\n\n // some changes to the received item\n\n return item;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"},{"title":"Change the item returned by `update()` using an afterUpdate hook","content":"// In data.js\n\nexport function myCollection_afterUpdate(item, context) {\n let hookContext = context; // see below\n \n // add a full_name property to the item being returned\n item.full_name = item.first_name + \" \" + item.last_name;\n \n return item;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"}],"actionParams":[{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"object"},"description":"The updated item."},{"name":"context","slug":"context","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateHookContext","referenceFqn":"Hooks.UpdateHookContext"},"description":"Contextual information about the hook."}],"description":"A hook that is triggered after an `update()` operation.\r\n\r\nThe `afterUpdate()` hook runs when:\r\n\r\n + The [`update()`](https://dev.wix.com/docs/velo/api-reference/wix-data/update) function is called.\r\n + An action is performed on a dataset that updates an item from the collection.\r\n + An item is updated using the CMS.\r\n\r\n **Note**: When [scheduling an item's visibility change](https://support.wix.com/en/article/cms-controlling-live-site-item-visibility-from-your-collection#scheduling-changes-to-item-visibility), the hook is triggered when the change is scheduled, not when it takes effect.\r\n\r\n\r\n Return an object or a Promise that resolves to an object from the `afterUpdate()`\r\n function. The returned object will be used as the result of the call to the\r\n [`update()`](https://dev.wix.com/docs/velo/api-reference/wix-data/update) function instead of the actual item updated\r\n in the collection. If returning a Promise, the object is used as the result,\r\n whether the Promise is fulfilled or rejected.\r\n\r\n If the returned value is of the wrong type, the value is ignored.\r\n\r\n A rejected Promise also calls the [`onFailure()`](#onFailure) hook if it has\r\n been registered.\r\n\r\n Because the `afterUpdate` hook is called after the [`update()`](https://dev.wix.com/docs/velo/api-reference/wix-data/update)\r\n is executed, it cannot affect the item that is being updated in the collection.\r\n It can only affect the item returned by [`update()`](https://dev.wix.com/docs/velo/api-reference/wix-data/update)."},{"name":"beforeCount","fqn":"Hooks.beforeCount","slug":"before-count","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query","context"],"adminMethod":false,"returnType":{"kind":"UNION","types":[{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery"}},{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery"}],"description":"The `query` to be used for the [`count()`](wix-data.WixDataQuery.html#count) operation instead of the original query.\r\n Returning a rejected promise will block the operation and will return a rejected promise to the caller as well as trigger the [`onFailure()`](#onFailure) hook."},"examples":[{"title":"A beforeCount hook","content":"// In data.js\n\nexport function myCollection_beforeCount(query, context) {\n let hookContext = context; // see below\n\n // some change to the received query\n\n return query;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"},{"title":"Change the query used for the count, using a beforeCount hook","content":"// In data.js\n\nexport function myCollection_beforeCount(query, context) {\n let hookContext = context; // see below\n\n // some change to the received query\n let newQuery = query.eq(\"status\", \"active\");\n\n return newQuery;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"}],"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery"},"description":"The original query as defined by [`count()`](wix-data.WixDataQuery.html#count)."},{"name":"context","slug":"context","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"HookContext","referenceFqn":"Hooks.HookContext"},"description":"Contextual information about the hook."}],"description":"A hook that is triggered before a `count()` operation.\r\n\r\nThe `beforeCount()` hook runs when:\r\n\r\n + The [`count()`](wix-data.WixDataQuery.html#count) function is called.\r\n + The collection is viewed in the CMS.\r\n\r\n\r\n Return a query or a Promise that resolves to a query from the `beforeCount()`\r\n function. The returned query will be used as the query for the\r\n [`count()`](wix-data.WixDataQuery.html#count) operation.\r\n\r\n Often, you will modify the query that is received in the `query` parameter\r\n by calling one or more [`WixDataQuery`](wix-data.WixDataQuery.html) functions.\r\n\r\n If the returned value is of the wrong type, the value is ignored.\r\n\r\n A rejected Promise blocks the call to [`count()`](wix-data.WixDataQuery.html#count)\r\n and also calls the [`onFailure()`](#onFailure) hook if it has been registered.\r\n\r\n Because the `beforeCount()` hook is called before [`count()`](wix-data.WixDataQuery.html#count)\r\n is executed, it can affect how items are counted or block the [`count()`](wix-data.WixDataQuery.html#count)."},{"name":"beforeGet","fqn":"Hooks.beforeGet","slug":"before-get","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["itemId","context"],"adminMethod":false,"returnType":{"kind":"UNION","types":[{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"string"}},{"kind":"PRIMITIVE","name":"string"}],"description":"The ID to be used for the [`get()`](wix-data.html#get) operation instead of the original `itemId` specified by the caller.\r\n Returning a rejected promise will block the operation and will return a rejected promise to the caller as well as trigger the [`onFailure()`](#onFailure) hook."},"examples":[{"title":"A beforeGet hook","content":"// In data.js\n\nexport function myCollection_beforeGet(itemId, context) {\n let hookContext = context; // see below\n\n // change the item to get\n\n return itemId;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"},{"title":"Change which item is retrieved using a beforeGet hook","content":"// In data.js\n\nexport function myCollection_beforeGet(itemId, context) {\n let hookContext = context; // see below\n\n // change the item to get\n let newItemId = \"1234\";\n\n return newItemId;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"}],"actionParams":[{"name":"itemId","slug":"item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the original item to be retrieved."},{"name":"context","slug":"context","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"HookContext","referenceFqn":"Hooks.HookContext"},"description":"Contextual information about the hook."}],"description":"A hook that is triggered before a `get()` operation.\r\n\r\nThe `beforeGet()` hook runs when the [`get()`](wix-data.html#get)\r\n function is called.\r\n\r\n The hook does not run when the [`find`](wix-data.WixDataQuery.html#find)\r\n function is called or when a dataset retrieves items from the collection it\r\n is connected to.\r\n\r\n Return a string or a Promise that resolves to a string from the `beforeGet()`\r\n function. The returned string will be used as the `itemId` parameter for the\r\n [`get()`](wix-data.html#get) operation. The item with the new `itemId` will\r\n be retrieved instead of the item with the original `itemId`.\r\n\r\n If the returned value is of the wrong type, the value is ignored.\r\n\r\n A rejected Promise blocks the call to [`get()`](wix-data.html#get)\r\n and also calls the [`onFailure()`](#onFailure) hook if it has been registered.\r\n\r\n Because the `beforeGet()` hook is called before [`get()`](wix-data.html#get)\r\n is executed, it can affect which item is retrieved\r\n or block the [`get()`](wix-data.html#get)."},{"name":"beforeInsert","fqn":"Hooks.beforeInsert","slug":"before-insert","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["item","context"],"adminMethod":false,"returnType":{"kind":"UNION","types":[{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"object"}},{"kind":"PRIMITIVE","name":"object"}],"description":"The item to be inserted instead of the original item specified by the caller.\r\n Returning a rejected promise will block the operation and will return a rejected promise to the caller as well as trigger the [`onFailure()`](#onFailure) hook."},"examples":[{"title":"A beforeInsert hook","content":"// In data.js\n\nexport function myCollection_beforeInsert(item, context) {\n let hookContext = context; // see below\n\n // some change to the received item\n\n return item;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"},{"title":"Change the item to insert using a beforeInsert hook","content":"// In data.js\n\nexport function myCollection_beforeInsert(item, context) {\n let hookContext = context; // see below\n\n // some change to the received item\n item.title = toUpperFirst(item.title);\n item.first_name = toUpperFirst(item.first_name);\n item.last_name = toUpperFirst(item.last_name);\n\n return item;\n}\n\nfunction toUpperFirst(s) {\n return s.charAt(0).toUpperCase() + s.slice(1);\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"},{"title":"Validate an email address field using a beforeInsert hook","content":"// In data.js\n\nexport function myCollection_beforeInsert(item, context) {\n let hookContext = context; // see below\n\n //validate the email field and reject in case of failure\n const emailRegex = /^\\w+([\\.-]?\\w+)*@\\w+([\\.-]?\\w+)*(\\.\\w{2,3})+$/;\n\n if (emailRegex.test(item.email)) {\n return item;\n } else {\n return Promise.reject('Invalid email address.');\n }\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"}],"actionParams":[{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"object"},"description":"The original item to be inserted."},{"name":"context","slug":"context","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"HookContext","referenceFqn":"Hooks.HookContext"},"description":"Contextual information about the hook."}],"description":"A hook that is triggered before an `insert()` operation.\r\n\r\nThe `beforeInsert()` hook runs when:\r\n\r\n + The [`insert()`](wix-data.html#insert) function is called.\r\n + An action is performed on a dataset that inserts a new item into the collection.\r\n + An item is inserted using the CMS.\r\n + An item is imported into the Sandbox or Live collection.\r\n\r\n\r\n The hook also runs when an action is performed on a dataset that inserts a\r\n new item into the collection that the dataset is connected to.\r\n\r\n Return an object or a Promise that resolves to an object from the `beforeInsert()`\r\n function. The returned object will be inserted into the collection instead of\r\n the original item passed to the [`insert()`](wix-data.html#insert) function.\r\n\r\n If the returned value is of the wrong type, the value is ignored.\r\n\r\n A rejected Promise blocks the call to [`insert()`](wix-data.html#insert)\r\n and also calls the [`onFailure()`](#onFailure) hook if it has been registered.\r\n\r\n Because the `beforeInsert()` hook is called before [`insert()`](wix-data.html#insert)\r\n is executed, it can affect the item that is inserted into the collection\r\n or block the [`insert()`](wix-data.html#insert)."},{"name":"beforeQuery","fqn":"Hooks.beforeQuery","slug":"before-query","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query","context"],"adminMethod":false,"returnType":{"kind":"UNION","types":[{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery"}},{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery"}],"description":"The query to use instead of the original query specified by the caller.\r\n Returning a rejected promise will block the operation and will return a rejected promise to the operation caller as well as trigger the [`onFailure()`](#onFailure) hook."},"examples":[{"title":"A beforeQuery hook","content":"// In data.js\n\nexport function myCollection_beforeQuery(query, context) {\n let hookContext = context; // see below\n\n // some change to the received query\n\n return query;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"},{"title":"Change the query to be executed using the beforeQuery hook","content":"// In data.js\n\nexport function myCollection_beforeQuery(query, context) {\n let hookContext = context; // see below\n\n // some change to the received query\n let newQuery = query.eq(\"status\", \"active\");\n\n return newQuery;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"}],"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery"},"description":"The original query as specified by the caller."},{"name":"context","slug":"context","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"HookContext","referenceFqn":"Hooks.HookContext"},"description":"Contextual information about the hook."}],"description":"A hook that is triggered before a `find()` operation.\r\n\r\nThe `beforeQuery()` hook runs when:\r\n\r\n + The [`find`](wix-data.WixDataQuery.html#find) function is called.\r\n + An action is performed on a dataset that retrieves items from the collection.\r\n + The collection is viewed in the CMS.\r\n + An item is exported from the collection.\r\n\r\n\r\n The hook also runs when an action is performed on a dataset that retrieves\r\n items from the collection that the dataset is connected to.\r\n\r\n Return a query or a Promise that resolves to a query from the `beforeQuery()`\r\n function. The returned query will be used as the query for the\r\n [`find`](wix-data.WixDataQuery.html#find) operation.\r\n\r\n Often, you will modify the query that is received in the `query` parameter\r\n by calling one or more [`WixDataQuery`](wix-data.WixDataQuery.html) functions.\r\n\r\n If the returned value is of the wrong type, the value is ignored.\r\n\r\n A rejected Promise blocks the call to [`find()`](wix-data.WixDataQuery.html#find)\r\n and also calls the [`onFailure()`](#onFailure) hook if it has been registered.\r\n\r\n Because the `beforeQuery()` hook is called before [`find()`](wix-data.WixDataQuery.html#find)\r\n is executed, it can affect the query that is used to retrieve items\r\n or block the [`find()`](wix-data.WixDataQuery.html#find)."},{"name":"beforeRemove","fqn":"Hooks.beforeRemove","slug":"before-remove","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["itemId","context"],"adminMethod":false,"returnType":{"kind":"UNION","types":[{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"string"}},{"kind":"PRIMITIVE","name":"string"}],"description":"The ID to be used for the [`remove()`](wix-data.html#remove) instead of the original `itemId` specified by the caller.\r\n Returning a rejected promise will block the operation and will return a rejected promise to the caller as well as trigger the [`onFailure()`](#onFailure) hook."},"examples":[{"title":"A beforeRemove hook","content":"// In data.js\n\nexport function myCollection_beforeRemove(itemId, context) {\n let hookContext = context; // see below\n\n // change to the item to remove\n\n return itemId;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"},{"title":"Change the item to remove using a beforeRemove hook","content":"// In data.js\n\nexport function myCollection_beforeRemove(itemId, context) {\n let hookContext = context; // see below\n\n // change to the item to remove\n let newItemId = \"1234\";\n\n return newItemId;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"}],"actionParams":[{"name":"itemId","slug":"item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the original item to be removed."},{"name":"context","slug":"context","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateHookContext","referenceFqn":"Hooks.UpdateHookContext"},"description":"Contextual information about the hook."}],"description":"A hook that is called before a `remove()` operation.\r\n\r\nThe `beforeRemove()` hook runs when:\r\n\r\n + The [`remove()`](wix-data.html#remove) function is called.\r\n + An action is performed on a dataset that removes an item from the collection.\r\n + An item is deleted using the CMS.\r\n\r\n\r\n The hook also runs when an action is performed on a dataset that removes\r\n an item from the collection that the dataset is connected to.\r\n\r\n Return a string or a Promise that resolves to a string from the `beforeRemove()`\r\n function. The returned string will be used as the `itemId` parameter for the\r\n [`remove()`](wix-data.html#remove) operation. The item with the new `itemId`\r\n will be removed instead of the item with the original `itemId`.\r\n\r\n If the returned value is of the wrong type, the value is ignored.\r\n\r\n A rejected Promise blocks the call to [`remove()`](wix-data.html#remove)\r\n and also calls the [`onFailure()`](#onFailure) hook if it has been registered.\r\n\r\n Because the `beforeRemove()` hook is called before [`remove()`](wix-data.html#remove)\r\n is executed, it can affect the item that is removed from the collection\r\n or block the [`remove()`](wix-data.html#remove)."},{"name":"beforeUpdate","fqn":"Hooks.beforeUpdate","slug":"before-update","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["item","context"],"adminMethod":false,"returnType":{"kind":"UNION","types":[{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"object"}},{"kind":"PRIMITIVE","name":"object"}],"description":"The item to be updated instead of the original item specified by the caller.\r\n Returning a rejected promise will block the operation and will return a rejected promise to the caller as well as trigger the [`onFailure()`](#onFailure) hook."},"examples":[{"title":"A beforeUpdate hook","content":"// In data.js\n\nexport function myCollection_beforeUpdate(item, context) {\n let hookContext = context; // see below\n\n // some change to the received item\n\n return item;\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"},{"title":"Change the item to update using a beforeUpdate hook","content":"// In data.js\n\nexport function myCollection_beforeUpdate(item, context) {\n let hookContext = context; // see below\n\n // some change to the received item\n item.title = toUpperFirst(item.title);\n item.first_name = toUpperFirst(item.first_name);\n item.last_name = toUpperFirst(item.last_name);\n\n return item;\n}\n\nfunction toUpperFirst(s) {\n return s.charAt(0).toUpperCase() + s.slice(1);\n}\n\n/*\n * hookContext:\n *\n * {\n * \"collectionName\": \"myCollection\",\n * \"userId\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"userRole\": \"siteOwner\"\n * }\n */"}],"actionParams":[{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"object"},"description":"The original item to be updated."},{"name":"context","slug":"context","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateHookContext","referenceFqn":"Hooks.UpdateHookContext"},"description":"Contextual information about the hook."}],"description":"A hook that is triggered before an `update()` operation.\r\n\r\nThe `beforeUpdate()` hook runs when:\r\n\r\n + The [`update()`](https://dev.wix.com/docs/velo/api-reference/wix-data/update) function is called.\r\n + An action is performed on a dataset that updates an item from the collection.\r\n + An item is updated using the CMS.\r\n\r\n\r\n The hook also runs when an action is performed on a dataset that updates\r\n an item from the collection that the dataset is connected to.\r\n\r\n Return an object or a Promise that resolves to an object from the `beforeUpdate()`\r\n function. The returned object will be updated in the collection instead of\r\n the original item passed to the [`update()`](https://dev.wix.com/docs/velo/api-reference/wix-data/update) function.\r\n\r\n If the returned value is of the wrong type, the value is ignored.\r\n\r\n A rejected Promise blocks the call to [`update()`](https://dev.wix.com/docs/velo/api-reference/wix-data/update)\r\n and also calls the [`onFailure()`](#onFailure) hook if it has been registered.\r\n\r\n Because the `beforeUpdate()` hook is called before the [`update()`](https://dev.wix.com/docs/velo/api-reference/wix-data/update)\r\n is executed, it can affect the item that is updated in the collection\r\n or block the [`update()`](https://dev.wix.com/docs/velo/api-reference/wix-data/update)."},{"name":"onFailure","fqn":"Hooks.onFailure","slug":"on-failure","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["error","context"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"object"},"description":"Fulfilled - Returning a fulfilled promise will result in a fulfilled data operation with the provided result.\r\nRejected - Returning a rejected promise will result in returning a rejected promise to the caller of the data operation."},"examples":[{"title":"A hook triggered when a failure occurs","content":"// In data.js\n\nexport function myCollection_onFailure(error, context) {\n let hookError = error; // see below\n\n // handle error\n\n return ret;\n}\n\n/*\n * hookError:\n *\n * {\n * \"message\": \"An item with _id [1234] already exists.\",\n * \"code\": -409\n * }\n */"}],"actionParams":[{"name":"error","slug":"error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Error","referenceFqn":""},"description":"The error that caused the failure."},{"name":"context","slug":"context","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"HookContext","referenceFqn":"Hooks.HookContext"},"description":"Contextual information about the hook."}],"description":"A hook that is triggered on any error or rejected Promise from any of the wix-data operations.\r\n\r\nThe `onFailure()` hook is triggered whenever a wix-data operation or hook returns a\r\nrejected Promise or an error."}],"webhooks":[],"articles":[{"content":"# Introduction\nData hooks run code before or after certain interactions with your site's\n collections. A data hook allows you to intercept the interaction immediately\n before or immediately after it occurs. The hook's code can even be used to\n affect the interaction itself. For example, you may want to intercept an\n item before it is added to your collection to perform a final validation or\n tweak the data that actually makes it into the collection.\n\n In general, hooks are run whether the interaction with your collection is\n initiated by a page element, programmatically, or when using the Content Management System (CMS).\n However, a Data API call from the backend code of your site may pass the\n optional `WixDataOptions` object and use it\n to suppress hooks from being called on that particular operation.\n\n Code for the hooks is written in the **data.js** file, which resides in the **Backend** section of your site.\n Hook functions are defined using the following pattern:\n\n ``` javascript\n export function _() { }\n ```\n You can add these functions to the **data.js** file by writing them yourself, or by generating templates using the Velo sidebar.\n\n To add a hook to a collection from the sidebar:\n 1. Click the **Databases** button and hover over the relevant collection.\n 1. Click the **Show More** icon.\n 1. Select **Add/Remove Hooks**, and choose the hooks you want to add.\n ![Adding a Hook](https://wixmp-833713b177cebf373f611808.wixmp.com/images/velo-images/media_add_remove_hooks.png \"Add/Remove Hook\")","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]},{"name":"WixDataAggregate","slug":"wix-data-aggregate","fqn":"WixDataAggregate","standaloneTypes":[],"metadata":{},"actions":[{"name":"ascending","fqn":"WixDataAggregate.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"examples":[{"title":"Add an ascending sort to an aggregation","content":"let newAggregate = aggregate.ascending(\"state\", \"city\");"},{"title":"Create an aggregation, add an ascending sort, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.aggregate(\"PopulationData\")\n .group(\"state\", \"year\")\n .avg(\"population\")\n .ascending(\"populationAvg\")\n .run()\n .then((results) => {\n let items = results.items; // see below\n let numItems = results.length; // 6\n let hasNext = results.hasNext(); // false\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n/* Given the sample data above, items is:\n * [\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2010},\n * \"populationAvg\": 4226500,\n * \"state\": \"NY\",\n * \"year\": 2010\n * }, {\n * \"_id\": {\"state\": \"NY\", \"year\": 2000},\n * \"populationAvg\": 4153500,\n * \"state\": \"NY\",\n * \"year\": 2000\n * }, {\n * \"_id\": {\"state\": \"CA\", \"year\": 2010},\n * \"populationAvg\": 1969000,\n * \"state\": \"CA\",\n * \"year\": 2010\n * }, {\n * \"_id\": {\"state\": \"CA\", \"year\": 2000},\n * \"populationAvg\": 2240000,\n * \"state\": \"CA\",\n * \"year\": 2000\n * }, {\n * \"_id\": {\"state\": \"FL\", \"year\": 2010},\n * \"populationAvg\": 320500,\n * \"state\": \"FL\",\n * \"year\": 2010\n * }, {\n * \"_id\": {\"state\": \"FL\", \"year\": 2000},\n * \"populationAvg\": 278500,\n * \"state\": \"FL\",\n * \"year\": 2000\n * }\n * ]\n */"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort."}],"description":"Adds a sort to an aggregation, sorting by the items or groups by the specified properties in ascending order.\r\n\r\nThe `ascending()` function refines a `WixDataAggregate` to sort the resulting\r\n items or groups in ascending order. If you specify more than one property,\r\n `ascending()` sorts the results in ascending order by each property in the\r\n order they are listed.\r\n\r\n You can sort the following types:\r\n\r\n + Number: Sorts numerically.\r\n + Date: Sorts by date and time.\r\n + String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n + Reference: Compares by the ID of the referenced item as a String.\r\n\r\n\r\n If a property contains a number as a String, that value will be sorted\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified sort property are ranked lowest.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"avg","fqn":"WixDataAggregate.avg","slug":"avg","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"examples":[{"title":"Add an avg aggregation","content":"let newAggregate = aggregate.avg(\"population\");"},{"title":"Add an avg aggregation with a projected name for the results","content":"let newAggregate = aggregate.max(\"population\", \"avgPopulation\");"},{"title":"Create an aggregation, add an avg aggregation, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.aggregate(\"PopulationData\")\n .group(\"state\", \"year\")\n .avg(\"population\")\n .run()\n .then((results) => {\n let items = results.items; // see below\n let numItems = results.length; // 6\n let hasNext = results.hasNext(); // false\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n/* Given the sample data above, items is:\n * [\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2000},\n * \"populationAvg\": 4153500,\n * \"state\": \"NY\",\n * \"year\": 2000},\n * {\n * \"_id\": {\"state\": \"FL\", \"year\": 2000},\n * \"populationAvg\": 278500,\n * \"state\": \"FL\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"CA\", \"year\": 2000},\n * \"populationAvg\": 2240000,\n * \"state\": \"CA\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"FL\", \"year\": 2010},\n * \"populationAvg\": 320500,\n * \"state\": \"FL\",\n * \"year\": 2010\n * },\n * {\n * \"_id\": {\"state\": \"CA\", \"year\": 2010},\n * \"populationAvg\": 2300500,\n * \"state\": \"CA\",\n * \"year\": 2010\n * },\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2010},\n * \"populationAvg\": 4226500,\n * \"state\": \"NY\",\n * \"year\": 2010\n * }\n * ]\n */"},{"title":"Create an aggregation, add an avg aggregation with a projected name for the results, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.aggregate(\"PopulationData\")\n .group(\"state\", \"year\")\n .avg(\"population\", \"averagePopulation\")\n .run()\n .then((results) => {\n let items = results.items; // see below\n let numItems = results.length; // 6\n let hasNext = results.hasNext(); // false\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n/* Given the sample data above, items is:\n * [\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2000},\n * \"averagePopulation\": 4153500,\n * \"state\": \"NY\",\n * \"year\": 2000},\n * {\n * \"_id\": {\"state\": \"FL\", \"year\": 2000},\n * \"averagePopulation\": 278500,\n * \"state\": \"FL\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"CA\", \"year\": 2000},\n * \"averagePopulation\": 2240000,\n * \"state\": \"CA\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"FL\", \"year\": 2010},\n * \"averagePopulation\": 320500,\n * \"state\": \"FL\",\n * \"year\": 2010\n * },\n * {\n * \"_id\": {\"state\": \"CA\", \"year\": 2010},\n * \"averagePopulation\": 2300500,\n * \"state\": \"CA\",\n * \"year\": 2010\n * },\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2010},\n * \"averagePopulation\": 4226500,\n * \"state\": \"NY\",\n * \"year\": 2010\n * }\n * ]\n */"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property in which to find the average value."},{"name":"projectedName","slug":"projected-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the property in the aggregation results containing the average value."}],"description":"Refines a `WixDataAggregate` to only contain the average value from each aggregation group.\r\n\r\nThe `avg()` function refines a `WixDataAggregate` to contain the average\r\n value from the specified property for each aggregated group or from the\r\n whole collection if no group is defined.\r\n\r\n When the aggregation is [run](#run), the returned `WixDataAggregateResult`\r\n object contains an item for each group with the following key:value pairs:\r\n\r\n + If a value was passed for the optional `projectedName`, the key is named\r\n using that value. Otherwise, the key is named using the following format:\r\n `\"propertyNameAvg\"`, where `propertyName` is the name of the specified property.\r\n + The value is the average of the values found in the specified property.\r\n\r\n\r\n Averages can only be calculated on properties of type Number.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"count","fqn":"WixDataAggregate.count","slug":"count","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"examples":[{"title":"Add a sum aggregation","content":"let newAggregate = aggregate.count();"},{"title":"Create an aggregation, add a sum aggregation, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.aggregate(\"PopulationData\")\n .group(\"state\", \"year\")\n .count()\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items; // see below\n let numItems = results.length; // 6\n let hasNext = results.hasNext(); // false\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n/* Given the sample data above, items is:\n * [\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2000},\n * \"count\": 2,\n * \"state\": \"NY\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"FL\", \"year\": 2000},\n * \"count\": 2,\n * \"state\": \"FL\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"CA\", \"year\": 2000},\n * \"count\": 2,\n * \"state\": \"CA\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"FL\", \"year\": 2010},\n * \"count\": 2,\n * \"state\": \"FL\",\n * \"year\": 2010\n * },\n * {\n * \"_id\": {\"state\": \"CA\", \"year\": 2010},\n * \"count\": 2,\n * \"state\": \"CA\",\n * \"year\": 2010\n * },\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2010},\n * \"count\": 2,\n * \"state\": \"NY\",\n * \"year\": 2010\n * }\n * ]\n */"}],"description":"Refines a `WixDataAggregate` to contain the item count of each group in the aggregation.\r\n\r\nThe `count()` function refines a `WixDataAggregate` to contain the item\r\n count in each of the aggregate's groups.\r\n\r\n When the aggregation is [run](#run), the returned `WixDataAggregateResult`\r\n object contains items with the following additional key:value pair:\r\n\r\n + The key is named `\"count\"`.\r\n + The value is the count of items aggregated in the group.\r\n\r\n\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"descending","fqn":"WixDataAggregate.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"examples":[{"title":"Add a descending sort to an aggregation","content":"let newAggregate = aggregate.descending(\"state\", \"city\");"},{"title":"Create an aggregation, add a descending sort, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.aggregate(\"PopulationData\")\n .group(\"state\", \"year\")\n .avg(\"population\")\n .descending(\"populationAvg\")\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items; // see below\n let numItems = results.length; // 6\n let hasNext = results.hasNext(); // false\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n/* Given the sample data above, items is:\n * [\n * {\n * \"_id\": {\"state\": \"NY\",\"year\": 2010},\n * \"populationAvg\": 4226500,\n * \"state\": \"NY\",\n * \"year\": 2010\n * }, {\n * \"_id\": {\"state\": \"NY\",\"year\": 2000},\n * \"populationAvg\": 4153500,\n * \"state\": \"NY\",\n * \"year\": 2000\n * }, {\n * \"_id\": {\"state\": \"CA\",\"year\": 2010},\n * \"populationAvg\": 1969000,\n * \"state\": \"CA\",\n * \"year\": 2010\n * }, {\n * \"_id\": {\"state\": \"CA\", \"year\": 2000},\n * \"populationAvg\": 2240000,\n * \"state\": \"CA\",\n * \"year\": 2000\n * }, {\n * \"_id\": {\"state\": \"FL\", \"year\": 2010},\n * \"populationAvg\": 320500,\n * \"state\": \"FL\",\n * \"year\": 2010\n * }, {\n * \"_id\": {\"state\": \"FL\", \"year\": 2000},\n * \"populationAvg\": 278500,\n * \"state\": \"FL\",\n * \"year\": 2000\n * }\n * ]\n */"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort."}],"description":"Adds a sort to an aggregation, sorting by the items or groups by the specified properties in descending order.\r\n\r\nThe `descending()` function refines a `WixDataAggregate` to sort the resulting\r\n items or groups in descending order. If you specify more than one property,\r\n `descending()` sorts the results in descending order by each property in the\r\n order they are listed.\r\n\r\n You can sort the following types:\r\n\r\n + Number: Sorts numerically.\r\n + Date: Sorts by date and time.\r\n + String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n + Reference: Compares by the ID of the referenced item as a String.\r\n\r\n\r\n If a property contains a number as a String, that value will be sorted\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified sort property are ranked lowest.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"filter","fqn":"WixDataAggregate.filter","slug":"filter","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["filter"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"examples":[{"title":"Filter out items in an aggregation","content":"let filter = wixData.filter().eq(\"year\", 2010);\n\nlet newAggregate = aggregate.filter(filter);"},{"title":"Filter out items in an aggregation and run the aggregation","content":"import wixData from 'wix-data';\n\n// ...\n\nlet filter = wixData.filter().eq(\"year\", 2010);\n\nwixData.aggregate(\"PopulationData\")\n .filter(filter)\n .max(\"population\", \"maxPopulation\")\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items; // see below\n let numItems = results.length; // 1\n let hasNext = results.hasNext(); // false\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n// items is: [{\"_id\":\"0\",\"maxPopulation\":8192000}]"},{"title":"Create an aggregation with filtering and grouping and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nconst filter = wixData.filter().eq(\"year\", 2010);\nconst having = wixData.filter().gt(\"maxPopulation\", 1000000);\n\nwixData.aggregate(\"PopulationData\")\n .filter(filter)\n .group(\"state\")\n .max(\"population\", \"maxPopulation\")\n .having(having)\n .descending(\"maxPopulation\")\n .skip(5)\n .limit(3)\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let numItems = results.length;\n let hasNext = results.hasNext();\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"filter","slug":"filter","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataFilter","referenceFqn":"WixDataFilter.WixDataFilter"},"description":"The filter to use to filter out items from being used in the aggregation."}],"description":"Filters out items from being used in an aggregation.\r\n\r\nThe `filter()` function refines a `WixDataAggregate` so that it only\r\n includes items from the aggregate's collection which match the specified\r\n filter criteria.\r\n\r\n To create a filter, use the wix-data [`filter()`](wix-data.html#filter) function.\r\n\r\n Filtering using `filter()` takes place before grouping is performed on the\r\n aggregation. To filter grouped results, use the [`having()`](#having) function.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"group","fqn":"WixDataAggregate.group","slug":"group","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"examples":[{"title":"Group items in an aggregation","content":"let newAggregate = aggregate.group(\"state\");"},{"title":"Group items by multiple fields in an aggregation","content":"let newAggregate = aggregate.group(\"state\", \"year\");"},{"title":"Group items in an aggregation and run the aggregation","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.aggregate(\"PopulationData\")\n .group(\"state\")\n .max(\"population\")\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items; // see below\n let numItems = results.length; // 3\n let hasNext = results.hasNext(); // false\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n/* Given the sample data above, items is:\n * [\n * {\"_id\": \"FL\", \"populationMax\": 401000},\n * {\"_id\": \"CA\", \"populationMax\": 3796000},\n * {\"_id\": \"NY\", \"populationMax\": 8192000}\n * ]\n */"},{"title":"Group items in an aggregation and run the aggregation","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.aggregate(\"PopulationData\")\n .group(\"state\", \"year\")\n .max(\"population\")\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items; // see below\n let numItems = results.length; // 6\n let hasNext = results.hasNext(); // false\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n/* Given the sample data above, items is:\n * [\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2000},\n * \"populationMax\": 8015000,\n * \"state\": \"NY\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"FL\", \"year\": 2000},\n * \"populationMax\": 362000,\n * \"state\": \"FL\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2010},\n * \"populationMax\": 8192000,\n * \"state\": \"NY\",\n * \"year\": 2010\n * },\n * {\n * \"_id\": {\"state\": \"CA\", \"year\": 2010},\n * \"populationMax\": 3796000,\n * \"state\": \"CA\",\n * \"year\": 2010\n * },\n * {\n * \"_id\": {\"state\": \"CA\", \"year\": 2000},\n * \"populationMax\": 3703000,\n * \"state\": \"CA\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"FL\", \"year\": 2010},\n * \"populationMax\": 401000,\n * \"state\": \"FL\",\n * \"year\": 2010\n * }\n * ]\n */"},{"title":"Create an aggregation with filtering and grouping and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nconst filter = wixData.filter().eq(\"year\", 2010);\nconst having = wixData.filter().gt(\"maxPopulation\", 1000000);\n\nwixData.aggregate(\"PopulationData\")\n .filter(filter)\n .group(\"state\")\n .max(\"population\", \"maxPopulation\")\n .having(having)\n .descending(\"maxPopulation\")\n .skip(5)\n .limit(3)\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let numItems = results.length;\n let hasNext = results.hasNext();\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The property or properties to group on."}],"description":"Groups items together in an aggregation.\r\n\r\nThe `group()` function refines a `WixDataAggregate` so that its items are\r\n grouped by the specified property or properties.\r\n\r\n You can perform aggregations on the groups using the following functions:\r\n\r\n + [`avg()`](#avg)\r\n + [`count()`](#count)\r\n + [`max()`](#max)\r\n + [`min()`](#min)\r\n + [`sum()`](#sum)\r\n\r\n\r\n To filter grouped results, use the [`having()`](#having) function.\r\n > **Notes:** \r\n > + Aggregations can only be used on collections you have created. They cannot be used on [Wix App Collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code).\r\n > + You can only call the `group()` function once per aggregate query."},{"name":"having","fqn":"WixDataAggregate.having","slug":"having","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["filter"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"examples":[{"title":"Filter out groups in an aggregation","content":"let having = wixData.filter().gt(\"maxPopulation\", 1000000);\n\nlet newAggregate = aggregate.having(having);"},{"title":"Filter out groups in an aggregation and run the aggregation","content":"import wixData from 'wix-data';\n\n// ...\n\nlet having = wixData.filter().gt(\"maxPopulation\", 1000000);\n\nwixData.aggregate(\"PopulationData\")\n .group(\"city\", \"state\")\n .max(\"population\", \"maxPopulation\")\n .having(having)\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items; // see below\n let numItems = results.length; // 3\n let hasNext = results.hasNext(); // false\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n/* Given the sample data above, items is:\n * [\n * {\n * \"_id\": {\"city\": \"San Diego\", \"state\": \"CA\"},\n * \"maxPopulation\": 1306000,\n * \"city\": \"San Diego\",\n * \"state\": \"CA\"\n * }, {\n * \"_id\": {\"city\": \"New York\", \"state\": \"NY\"},\n * \"maxPopulation\": 8192000,\n * \"city\": \"New York\",\n * \"state\": \"NY\"\n * }, {\n * \"_id\": {\"city\": \"Los Angeles\", \"state\": \"CA\"},\n * \"maxPopulation\": 3796000,\n * \"city\": \"Los Angeles\",\n * \"state\": \"CA\"\n * }\n * ]\n */"},{"title":"Create an aggregation with filtering and grouping and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nconst filter = wixData.filter().eq(\"year\", 2010);\nconst having = wixData.filter().gt(\"maxPopulation\", 1000000);\n\nwixData.aggregate(\"PopulationData\")\n .filter(filter)\n .group(\"state\")\n .max(\"population\", \"maxPopulation\")\n .having(having)\n .descending(\"maxPopulation\")\n .skip(5)\n .limit(3)\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let numItems = results.length;\n let hasNext = results.hasNext();\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"filter","slug":"filter","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataFilter","referenceFqn":"WixDataFilter.WixDataFilter"},"description":"The filter to use to filter out groups from being returned from the aggregation."}],"description":"Filters out groups from being returned from an aggregation.\r\n\r\nThe `having()` function refines a `WixDataAggregate` so that it only\r\n includes groups from the aggregate's grouping which match the specified\r\n filter criteria.\r\n\r\n To create a filter, use the wix-data [`filter()`](wix-data.html#filter) function.\r\n\r\n Filtering using `having()` takes place after grouping is performed on the\r\n aggregation. To filter items before grouping, use the [`filter()`](#filter) function.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"limit","fqn":"WixDataAggregate.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["limit"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"examples":[{"title":"Add a limit to an aggregation","content":"let newAggregate = aggregate.limit(3);"},{"title":"Create an aggregate, add a limit, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.aggregate(\"PopulationData\")\n .group(\"state\", \"year\")\n .max(\"population\")\n .limit(3)\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items; // see below\n let numItems = results.length; // 3\n let hasNext = results.hasNext(); // true\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n/* Given the sample data above, items is:\n * [\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2000},\n * \"populationMax\":8015000,\n * \"state\": \"NY\",\n * \"year\": 2000\n * }, {\n * \"_id\": {\"state\": \"FL\", \"year\": 2000},\n * \"populationMax\":362000,\n * \"state\": \"FL\",\n * \"year\": 2000\n * }, {\n * \"_id\": {\"state\": \"NY\", \"year\": 2010},\n * \"populationMax\":3703000,\n * \"state\": \"NY\",\n * \"year\": 2010\n * }\n * ]\n */"},{"title":"Create an aggregation with filtering and grouping and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nconst filter = wixData.filter().eq(\"year\", 2010);\nconst having = wixData.filter().gt(\"maxPopulation\", 1000000);\n\nwixData.aggregate(\"PopulationData\")\n .filter(filter)\n .group(\"state\")\n .max(\"population\", \"maxPopulation\")\n .having(having)\n .descending(\"maxPopulation\")\n .skip(5)\n .limit(3)\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let numItems = results.length;\n let hasNext = results.hasNext();\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items or groups to return."}],"description":"Limits the number of items or groups the aggregation returns.\r\n\r\nThe `limit()` function defines the number of results an aggregation returns in each\r\n page. Only one page of results is retreived at a time. The [`next()`](wix-data.WixDataQueryResult.html)\r\n function is used to navigate the pages of a query result.\r\n\r\n By default, `limit` is set to `50`.\r\n\r\n The maximum value that `limit()` can accept is `1000`.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"max","fqn":"WixDataAggregate.max","slug":"max","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"examples":[{"title":"Add a max aggregation","content":"let newAggregate = aggregate.max(\"population\");"},{"title":"Add a max aggregation with a projected name for the results","content":"let newAggregate = aggregate.max(\"population\", \"maxPopulation\");"},{"title":"Create an aggregation, add a max aggregation, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.aggregate(\"PopulationData\")\n .group(\"state\", \"year\")\n .max(\"population\")\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items; // see below\n let numItems = results.length; // 6\n let hasNext = results.hasNext(); // false\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n/* Given the sample data above, items is:\n * [\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2000},\n * \"populationMax\": 8015000,\n * \"state\": \"NY\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"FL\", \"year\": 2000},\n * \"populationMax\": 362000,\n * \"state\": \"FL\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"CA\", \"year\": 2000},\n * \"populationMax\": 3703000,\n * \"state\": \"CA\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"FL\", \"year\": 2010},\n * \"populationMax\": 401000,\n * \"state\": \"FL\",\n * \"year\": 2010\n * },\n * {\n * \"_id\": {\"state\": \"CA\", \"year\": 2010},\n * \"populationMax\": 3796000,\n * \"state\": \"CA\",\n * \"year\": 2010\n * },\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2010},\n * \"populationMax\": 8192000,\n * \"state\": \"NY\",\n * \"year\": 2010\n * }\n * ]\n */"},{"title":"Create an aggregation, add a max aggregation with a projected name for the results, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.aggregate(\"PopulationData\")\n .group(\"state\", \"year\")\n .max(\"population\", \"maximumPopulation\")\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items; // see below\n let numItems = results.length; // 6\n let hasNext = results.hasNext(); // false\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n/* Given the sample data above, items is:\n * [\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2000},\n * \"maximumPopulation\": 8015000,\n * \"state\": \"NY\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"FL\", \"year\": 2000},\n * \"maximumPopulation\": 362000,\n * \"state\": \"FL\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"CA\", \"year\": 2000},\n * \"maximumPopulation\": 3703000,\n * \"state\": \"CA\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"FL\", \"year\": 2010},\n * \"maximumPopulation\": 401000,\n * \"state\": \"FL\",\n * \"year\": 2010\n * },\n * {\n * \"_id\": {\"state\": \"CA\", \"year\": 2010},\n * \"maximumPopulation\": 3796000,\n * \"state\": \"CA\",\n * \"year\": 2010\n * },\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2010},\n * \"maximumPopulation\": 8192000,\n * \"state\": \"NY\",\n * \"year\": 2010\n * }\n * ]\n */"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property in which to find the maximum value."},{"name":"projectedName","slug":"projected-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the property in the aggregation results containing the maximum value."}],"description":"Refines a `WixDataAggregate` to only contain the maximum value from each aggregation group.\r\n\r\nThe `max()` function refines a `WixDataAggregate` to contain the maximum\r\n value from the specified property for each aggregated group or from the\r\n whole collection if no group is defined.\r\n\r\n When the aggregation is [run()](wix-data.WixDataAggregate.html#run), the returned `WixDataAggregateResult`\r\n object contains an item for each group with the following key:value pairs:\r\n\r\n + If a value was passed for the optional `projectedName`, the key is named\r\n using that value. Otherwise, the key is named using the following format:\r\n `\"propertyNameMax\"`, where `propertyName` is the name of the specified property.\r\n + The value is the maximum value found in the specified property.\r\n\r\n\r\n The following types of properties can be compared to determine a maximum value:\r\n\r\n + Number: Compares numerically.\r\n + Date and Time: Compares JavaScript Date objects.\r\n + Text: Compares lexicographically, so `\"text\"` is greater than `\"Text\"`.\r\n + Rich Text: Compares HTML source as text.\r\n + URL: Compares as text.\r\n + Image: Compares image source as text.\r\n + Video: Compares video source as text.\r\n + Document: Compares document source as text.\r\n + Reference: Compares by the ID of the referenced item as a String.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"min","fqn":"WixDataAggregate.min","slug":"min","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"examples":[{"title":"Add a min aggregation","content":"let newAggregate = aggregate.min(\"population\");"},{"title":"Add a min aggregation with a projected name for the results","content":"let newAggregate = aggregate.min(\"population\", \"minPopulation\");"},{"title":"Create an aggregation, add a max aggregation, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.aggregate(\"PopulationData\")\n .group(\"state\", \"year\")\n .min(\"population\")\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items; // see below\n let numItems = results.length; // 6\n let hasNext = results.hasNext(); // false\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n/* Given the sample data above, items is:\n * [\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2000},\n * \"populationMin\": 292000,\n * \"state\": \"NY\",\n * \"year\":2000\n * },\n * {\n * \"_id\": {\"state\": \"FL\", \"year\": 2000},\n * \"populationMin\": 195000,\n * \"state\": \"FL\",\n * \"year\":2000\n * },\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2010},\n * \"populationMin\": 261000,\n * \"state\": \"NY\",\n * \"year\":2010\n * },\n * {\n * \"_id\": {\"state\": \"CA\", \"year\": 2010},\n * \"populationMin\": 805000,\n * \"state\": \"CA\",\n * \"year\":2010\n * },\n * {\n * \"_id\": {\"state\": \"CA\", \"year\": 2000},\n * \"populationMin\": 777000,\n * \"state\": \"CA\",\n * \"year\":2000\n * },\n * {\n * \"_id\": {\"state\": \"FL\", \"year\": 2010},\n * \"populationMin\": 240000,\n * \"state\": \"FL\",\n * \"year\":2010\n * }\n * ]\n */"},{"title":"Create an aggregation, add a min aggregation with a projected name for the results, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.aggregate(\"PopulationData\")\n .group(\"state\", \"year\")\n .min(\"population\", \"minimumPopulation\")\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items; // see below\n let numItems = results.length; // 6\n let hasNext = results.hasNext(); // false\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n/* Given the sample data above, items is:\n * [\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2000},\n * \"minimumPopulation\": 292000,\n * \"state\": \"NY\",\n * \"year\":2000\n * },\n * {\n * \"_id\": {\"state\": \"FL\", \"year\": 2000},\n * \"minimumPopulation\": 195000,\n * \"state\": \"FL\",\n * \"year\":2000\n * },\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2010},\n * \"minimumPopulation\": 261000,\n * \"state\": \"NY\",\n * \"year\":2010\n * },\n * {\n * \"_id\": {\"state\": \"CA\", \"year\": 2010},\n * \"minimumPopulation\": 805000,\n * \"state\": \"CA\",\n * \"year\":2010\n * },\n * {\n * \"_id\": {\"state\": \"CA\", \"year\": 2000},\n * \"minimumPopulation\": 777000,\n * \"state\": \"CA\",\n * \"year\":2000\n * },\n * {\n * \"_id\": {\"state\": \"FL\", \"year\": 2010},\n * \"minimumPopulation\": 240000,\n * \"state\": \"FL\",\n * \"year\":2010\n * }\n * ]\n */"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property in which to find the minimum value."},{"name":"projectedName","slug":"projected-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the property in the aggregation results containing the minimum value."}],"description":"Refines a `WixDataAggregate` to only contain the minimum value from each aggregation group.\r\n\r\nThe `min()` function refines a `WixDataAggregate` to contain the minimum\r\n value from the specified property for each aggregated group or from the\r\n whole collection if no group is defined.\r\n\r\n When the aggregation is [run](#run), the returned `WixDataAggregateResult`\r\n object contains an item for each group with the following key:value pairs:\r\n\r\n + If a value was passed for the optional `projectedName`, the key is named\r\n using that value. Otherwise, the key is named using the following format:\r\n `\"propertyNameMin\"`, where `propertyName` is the name of the specified property.\r\n + The value is the minimum value found in the specified property.\r\n\r\n\r\n The following types of properties can be compared to determine a minimum value:\r\n\r\n + Number: Compares numerically.\r\n + Date and Time: Compares JavaScript Date objects.\r\n + Text: Compares lexicographically, so `\"text\"` is greater than `\"Text\"`.\r\n + Rich Text: Compares HTML source as text.\r\n + URL: Compares as text.\r\n + Image: Compares image source as text.\r\n + Video: Compares video source as text.\r\n + Document: Compares document source as text.\r\n + Reference: Compares by the ID of the referenced item as a String.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"run","fqn":"WixDataAggregate.run","slug":"run","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataAggregateResult","referenceFqn":"WixDataAggregateResult.WixDataAggregateResult"},"description":"Fulfilled - A Promise that resolves to the results of the aggregation.\r\nRejected - Error that caused the aggregation to fail."},"examples":[{"title":"Perform an aggregation","content":"aggregate.run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let numItems = results.length;\n let hasNext = results.hasNext(); \n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create an aggregation with filtering and grouping and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nconst filter = wixData.filter().eq(\"year\", 2010);\nconst having = wixData.filter().gt(\"maxPopulation\", 1000000);\n\nwixData.aggregate(\"PopulationData\")\n .filter(filter)\n .group(\"state\")\n .max(\"population\", \"maxPopulation\")\n .having(having)\n .descending(\"maxPopulation\")\n .skip(5)\n .limit(3)\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let numItems = results.length;\n let hasNext = results.hasNext();\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RunOptions","referenceFqn":"WixDataAggregate.RunOptions"},"description":"Options to use when running an aggregation."}],"description":"Runs the aggregation and returns the results.\r\n\r\nThe `run()` function returns a Promise that resolves to the results found\r\n by the aggregation and some information about the results.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"skip","fqn":"WixDataAggregate.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["skip"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"examples":[{"title":"Add a skip to an aggregation","content":"let newAggregate = aggregate.skip(10);"},{"title":"Create an aggregate, add a skip, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.aggregate(\"PopulationData\")\n .group(\"state\", \"year\")\n .max(\"population\")\n .skip(3)\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items; // see below\n let numItems = results.length; // 3\n let hasNext = results.hasNext();\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n/* Given the sample data above, items is:\n * [\n * {\n * \"_id\": {\"state\": \"FL\", \"year\": 2010},\n * \"populationMax\":401000,\n * \"state\": \"FL\",\n * \"year\": 2010\n * }, {\n * \"_id\": {\"state\": \"CA\", \"year\": 2010},\n * \"populationMax\":3796000,\n * \"state\": \"CA\",\n * \"year\": 2010\n * }, {\n * \"_id\": {\"state\": \"NY\", \"year\": 2010},\n * \"populationMax\":8192000,\n * \"state\": \"NY\",\n * \"year\": 2010\n * }\n * ]\n */"},{"title":"Create an aggregation with filtering and grouping and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nconst filter = wixData.filter().eq(\"year\", 2010);\nconst having = wixData.filter().gt(\"maxPopulation\", 1000000);\n\nwixData.aggregate(\"PopulationData\")\n .filter(filter)\n .group(\"state\")\n .max(\"population\", \"maxPopulation\")\n .having(having)\n .descending(\"maxPopulation\")\n .skip(5)\n .limit(3)\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let numItems = results.length;\n let hasNext = results.hasNext();\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items or groups to skip in the aggregation results before returning the results."}],"description":"Sets the number of items or groups to skip before returning aggregation results.\r\n\r\nThe `skip()` function defines the number of results to skip in the aggregation\r\n results before returning new aggregation results.\r\n\r\n For example, if you perform an aggregation on a collection and 10 groups match\r\n your aggregation, but you set `skip` to 3, the results returned will skip\r\n the first 3 groups that match and return the 4th through 10th items.\r\n\r\n By default, `skip` is set to 0.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."},{"name":"sum","fqn":"WixDataAggregate.sum","slug":"sum","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataAggregate","referenceFqn":"WixDataAggregate.WixDataAggregate","description":"A `WixDataAggregate` object representing the refined aggregation."},"examples":[{"title":"Add a sum aggregation","content":"let newAggregate = aggregate.sum(\"population\");"},{"title":"Add a sum aggregation with a projected name for the results","content":"let newAggregate = aggregate.sum(\"population\", \"sumPopulation\");"},{"title":"Create an aggregation, add a sum aggregation, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.aggregate(\"PopulationData\")\n .group(\"state\", \"year\")\n .sum(\"population\")\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items; // see below\n let numItems = results.length; // 6\n let hasNext = results.hasNext(); // false\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n/* Given the sample data above, items is:\n * [\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2000},\n * \"populationSum\": 8307000,\n * \"state\": \"NY\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"FL\", \"year\": 2000},\n * \"populationSum\": 557000,\n * \"state\": \"FL\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2010},\n * \"populationSum\": 8453000,\n * \"state\": \"NY\",\n * \"year\": 2010\n * },\n * {\n * \"_id\": {\"state\": \"CA\", \"year\": 2010},\n * \"populationSum\": 4601000,\n * \"state\": \"CA\",\n * \"year\": 2010\n * },\n * {\n * \"_id\": {\"state\": \"CA\", \"year\": 2000},\n * \"populationSum\": 4480000,\n * \"state\": \"CA\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"FL\", \"year\": 2010},\n * \"populationSum\": 641000,\n * \"state\": \"FL\",\n * \"year\": 2010\n * }\n * ]\n */"},{"title":"Create an aggregation, add a sum aggregation with a projected name for the results, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.aggregate(\"PopulationData\")\n .group(\"state\", \"year\")\n .sum(\"population\", \"totalPopulation\")\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items; // see below\n let numItems = results.length; // 6\n let hasNext = results.hasNext(); // false\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n/* Given the sample data above, items is:\n * [\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2000},\n * \"totalPopulation\": 8307000,\n * \"state\": \"NY\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"FL\", \"year\": 2000},\n * \"totalPopulation\": 557000,\n * \"state\": \"FL\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"NY\", \"year\": 2010},\n * \"totalPopulation\": 8453000,\n * \"state\": \"NY\",\n * \"year\": 2010\n * },\n * {\n * \"_id\": {\"state\": \"CA\", \"year\": 2010},\n * \"totalPopulation\": 4601000,\n * \"state\": \"CA\",\n * \"year\": 2010\n * },\n * {\n * \"_id\": {\"state\": \"CA\", \"year\": 2000},\n * \"totalPopulation\": 4480000,\n * \"state\": \"CA\",\n * \"year\": 2000\n * },\n * {\n * \"_id\": {\"state\": \"FL\", \"year\": 2010},\n * \"totalPopulation\": 641000,\n * \"state\": \"FL\",\n * \"year\": 2010\n * }\n * ]\n */"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property in which to find the sum."},{"name":"projectedName","slug":"projected-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the property in the aggregation results containing the sum."}],"description":"Refines a `WixDataAggregate` to contain the sum from each aggregation group.\r\n\r\nThe `sum()` function refines a `WixDataAggregate` to contain the sum of the\r\n values from the specified property for each aggregated group or from the\r\n whole collection if no group is defined.\r\n\r\n When the aggregation is [run](#run), the returned `WixDataAggregateResult`\r\n object contains an item for each group with the following key:value pairs:\r\n\r\n + If a value was passed for the optional `projectedName`, the key is named\r\n using that value. Otherwise, the key is named using the following format:\r\n `\"propertyNameSum\"`, where `propertyName` is the name of the specified property.\r\n + The value is the sum of the values found in the specified property.\r\n\r\n\r\n Sums can only be calculated on properties of type Number.\r\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\r\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections)."}],"webhooks":[],"articles":[{"content":"# Introduction\nThe aggregation functionality of the Data API allows you to perform calculations\n on your collection data, as whole or on groups of items that you define, to\n retrieve meaningful summaries. You can also add filtering and sorting to your\n aggregations to retrieve exactly what you need.\n\n The examples below use a sample collection, named PopulationData, with the following data:\n\n ```\n City, Population, State, Year\n Buffalo, 292000, NY, 2000\n Buffalo, 261000, NY, 2010\n Los Angeles, 3703000, CA, 2000\n Los Angeles, 3796000, CA, 2010\n Miami, 362000, FL, 2000\n Miami, 401000, FL, 2010\n New York, 8015000, NY, 2000\n New York, 8192000, NY, 2010\n Orlando, 195000, FL, 2000\n Orlando, 240000, FL, 2010\n San Diego 1228000, CA, 2010\n San Diego 1306000, CA, 2012\n San Francisco, 777000, CA, 2000\n San Francisco, 805000, CA, 2010\n ```\n\n For more information, see [Working with Aggregations and Groupings in the Data API](https://support.wix.com/en/article/working-with-aggregations-and-groupings-in-the-data-api).\n > **Note:** Aggregations can only be used on collections you have created. They cannot be\n used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections).","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]},{"name":"WixDataAggregateResult","slug":"wix-data-aggregate-result","fqn":"WixDataAggregateResult","standaloneTypes":[],"metadata":{},"actions":[{"name":"hasNext","fqn":"WixDataAggregateResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"examples":[{"title":"Get whether the aggregate result object has more results","content":"let hasNext = results.hasNext(); // true"},{"title":"Run an aggregation and get whether the aggregate result object has more results","content":"import wixData from 'wix-data';\n\nwixData.aggregate(\"PopulationData\")\n .group(\"state\")\n .max(\"population\")\n .run()\n .then((results) => {\n let hasNext = results.hasNext(); // false\n });"},{"title":"Iterate through all pages of aggregate results","content":"let results = await wixData.aggregate(\"Cities\")\n .group(\"city\")\n .limit(3)\n .run();\n\nconsole.log(results.items);\n\nwhile(results.hasNext()) {\n console.log(\"---▼ Next Page ▼---\");\n results = await results.next();\n console.log(results.items);\n}\n\n/* Logs:\n * [{\"_id\":\"San Diego\"},{\"_id\":\"Orlando\"},{\"_id\":\"San Francisco\"}]\n * ---▼ Next Page ▼---\n * [{\"_id\":\"Buffalo\"},{\"_id\":\"Miami\"},{\"_id\":\"Los Angeles\"}]\n * ---▼ Next Page ▼---\n * [{\"_id\":\"Miami\"}]\n */"}],"description":"Indicates if the aggregation has more results."},{"name":"next","fqn":"WixDataAggregateResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataAggregateResult","referenceFqn":"WixDataAggregateResult.WixDataAggregateResult"},"description":"Fulfilled - An aggregate object with the next page of aggregate results.\r\nRejected - The errors that caused the rejection."},"examples":[{"title":"Get the next page of an aggregate result","content":"oldResults.next()\n .then((newResults) => {\n let items = newResults.items;\n let numItems = newResults.length;\n let hasNext = newResults.hasNext();\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Iterate through all pages of aggregate results","content":"let results = await wixData.aggregate(\"Cities\")\n .group(\"city\")\n .limit(3)\n .run();\n\nconsole.log(results.items);\n\nwhile(results.hasNext()) {\n console.log(\"---▼ Next Page ▼---\");\n results = await results.next();\n console.log(results.items);\n}\n\n/* Logs:\n * [{\"_id\":\"San Diego\"},{\"_id\":\"Orlando\"},{\"_id\":\"San Francisco\"}]\n * ---▼ Next Page ▼---\n * [{\"_id\":\"Buffalo\"},{\"_id\":\"Miami\"},{\"_id\":\"Los Angeles\"}]\n * ---▼ Next Page ▼---\n * [{\"_id\":\"Miami\"}]\n */"}],"description":"Retrieves the next page of aggregate results.\r\n\r\nThe `next()` function retrieves the next page of aggregate results.\r\n\r\n The page size is defined by the [`limit()`](wix-data.WixDataAggregate.html#limit) function.\r\n\r\n If items are added or removed between calls to `next()` the values returned\r\n by `WixDataAggregateResult` may change."}],"webhooks":[],"articles":[{"content":"# Introduction\nWhen you execute an aggregation with the [`run()`](https://www.wix.com/velo/reference/wix-data/wixdataaggregate/run) function, it returns\n a Promise that resolves to a `WixDataAggregateResult` object, which contains\n the aggregated values.","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the aggregate values","content":"let items = results.items;"},{"title":"Run an aggregation and get the aggregate values","content":"import wixData from 'wix-data';\n\nwixData.aggregate(\"PopulationData\")\n .group(\"state\")\n .max(\"population\")\n .run()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items; // see below\n } else {\n // handle case where no matching items found\n }\n });\n\n/* Given the sample data above, items is:\n * [\n * {\"_id\": \"NY\", \"populationMax\": 8192000},\n * {\"_id\": \"CA\", \"populationMax\": 3796000},\n * {\"_id\": \"FL\", \"populationMax\": 401000}\n * ]\n */"}],"type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"object"}},"description":"Gets the aggregated values.\r\n\r\nThe current page of items retrieved by the aggregation.\r\n\r\n The page size is defined by the [`limit()`](wix-data.WixDataAggregate.html#limit) function and\r\n navigating through pages is done with the [`next()`](#next) function.\r\n\r\n When no items match the aggregation, the `items` array is empty."},{"name":"length","slug":"length","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the number of values in the aggregate results","content":"let length = results.length; // 4"},{"title":"Run an aggregation and get the number of values in the aggregate results","content":"import wixData from 'wix-data';\n\nwixData.aggregate(\"PopulationData\")\n .group(\"state\")\n .max(\"population\")\n .run()\n .then((results) => {\n let length = results.length; // 3\n });"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of values in the aggregate results."}]},{"name":"WixDataFilter","slug":"wix-data-filter","fqn":"WixDataFilter","standaloneTypes":[],"metadata":{},"actions":[{"name":"and","fqn":"WixDataFilter.and","slug":"and","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an and to a query","content":"let newQuery = query1.and(query2);"},{"title":"Create two or queries, add an and, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nlet statusQuery = wixData.query(\"myCollection\")\n .eq(\"status\", \"pending\")\n .or(\n wixData.query(\"myCollection\")\n .eq(\"status\", \"rejected\")\n );\n\nlet ageQuery = wixData.query(\"myCollection\")\n .lt(\"age\", 25)\n .or(\n wixData.query(\"myCollection\")\n .gt(\"age\", 65)\n );\n\nstatusQuery.and(ageQuery)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n /*\n * For example, results contain items where age is:\n * 18\n * 21\n * 67\n * 90\n *\n * But not items where age is:\n * 25\n * 30\n * 40\n * 65\n */"}],"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery"},"description":"A query to add to the initial query as an `and` condition."}],"description":"Adds an `and` condition to the query or filter.\r\n\r\nThe `and()` function adds an `and` condition to a `WixDataQuery` or `WixDataFilter`.\r\n A query or filter with an `and` returns all the items that match the query\r\n or filter as defined up to the `and` function and also match the query or\r\n filter passed to the `and` function.\r\n\r\n Note that when chaining multiple `WixDataFilter` functions to a query an `and` condition is assumed.\r\n In such cases, you do not need to add a call to the `and()` function.\r\n For example, this query returns results where status is active **and** age is\r\n greater than 25.\r\n\r\n ```javascript\r\n wixData.query(\"myCollection\")\r\n .eq(\"status\", \"active\")\r\n .gt(\"age\", 25);\r\n ```\r\n\r\n The `and()` function is needed when performing compound queries. For\r\n example, the final query in this set of queries returns results where status\r\n is either pending or rejected **and** age is either less than 25 or greater than 65.\r\n\r\n ```javascript\r\n let statusQuery = wixData.query(\"myCollection\")\r\n .eq(\"status\", \"pending\")\r\n .or(\r\n wixData.query(\"myCollection\")\r\n .eq(\"status\", \"rejected\")\r\n );\r\n\r\n let ageQuery = wixData.query(\"myCollection\")\r\n .lt(\"age\", 25)\r\n .or(\r\n wixData.query(\"myCollection\")\r\n .gt(\"age\", 65)\r\n );\r\n\r\n let statusAndAgeQuery = statusQuery.and(ageQuery);\r\n ```\r\n\r\n The collections referenced by both the initial query and the query passed\r\n to the `and` function must be the same.\r\n\r\n The 'and()' function is designed to work with 2 or more queries or filters.\r\n If you use it on its own, it will return all the items in a collection."},{"name":"between","fqn":"WixDataFilter.between","slug":"between","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","rangeStart","rangeEnd"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a between filter to a query","content":"let newQuery = query.between(\"age\", 25, 65);"},{"title":"Create a query, add a between filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .between(\"age\", 25, 65)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a between filter and other filters, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .between(\"age\", 25, 65)\n .eq(\"status\", \"active\")\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `rangeStart` and `rangeEnd`."},{"name":"rangeStart","slug":"range-start","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The beginning value of the range to match against."},{"name":"rangeEnd","slug":"range-end","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The ending value of the range to match against."}],"description":"Refines a query or filter to match items whose specified property value is within a specified range.\r\n\r\nThe `between()` function refines a `WixDataQuery` or `WixDataFilter` to only\r\n match items where the value of the specified property is greater than or equal\r\n to `rangeStart` and less than `rangeEnd`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically, so\r\n + `\"A\"` and `\"M\"` are between `\"A\"` and `\"Z\"`, but `\"a\"`, `\"m\"`, `\"z\"` and `\"Z\"` are not.\r\n + `\"A\"`, `\"M\"`, `\"Z\"`, and `\"a\"` are between `\"A\"` and `\"z\"`, but `\"z\"` is not."},{"name":"contains","fqn":"WixDataFilter.contains","slug":"contains","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","string"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a contains filter to a query","content":"let newQuery = query.contains(\"description\", \"some words\");"},{"title":"Create a query, add a contains filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .contains(\"description\", \"some words\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a contains filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .contains(\"description\", \"some words\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with the string."},{"name":"string","slug":"string","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The string to look for inside the specified property value."}],"description":"Refines a query or filter to match items whose specified property value contains a specified string.\r\n\r\nThe `contains()` function refines a `WixDataQuery` or `WixDataFilter` to\r\n only match items where the value of the specified property contains the\r\n specified `string`. Matching with `contains()` is not case sensitive, so\r\n `\"text\"` does contain `\"Tex\"`.\r\n\r\n You can use `contains()` with a property whose value is a String or a Reference.\r\n For properties of type reference it is recommended that you use the [`eq()`](#eq)\r\n function instead of `contains()`. With properties that are References, `contains()`\r\n matches by the ID of the referenced item as a String."},{"name":"endsWith","fqn":"WixDataFilter.endsWith","slug":"ends-with","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","string"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an ends with filter to a query","content":"let newQuery = query.endsWith(\"last_name\", \"z\");"},{"title":"Create a query, add an ends with filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .endsWith(\"last_name\", \"z\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add an ends with filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .endsWith(\"last_name\", \"z\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with the string."},{"name":"string","slug":"string","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The string to look for at the end of the specified property value."}],"description":"Refines a query or filter to match items whose specified property value ends with a specified string.\r\n\r\nThe `endsWith()` function refines a `WixDataQuery` or `WixDataFilter` to only\r\n match items where the value of the specified property ends with the specified\r\n`string`. Matching with `endsWith()` is not case sensitive, so `\"TEXT\"` ends\r\n with `\"ext\"`.\r\n\r\n You can only use `endsWith()` with a property whose value is a String or Reference.\r\n When using a Reference, `endsWith()` matches by the ID of the referenced item as Strings."},{"name":"eq","fqn":"WixDataFilter.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an equals filter to a query","content":"let newQuery = query.eq(\"status\", \"active\");"},{"title":"Create a query, add an equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .eq(\"status\", \"active\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add an equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .eq(\"status\", \"active\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value equals the specified value.\r\n\r\nThe `eq()` function refines a `WixDataQuery` or `WixDataFilter` to only\r\n match items where the value of the specified property equals the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n Matching strings with `eq()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\n If `propertyName` points to a collection field of type Array, `eq()` includes the item\r\n as long as at least one Array element matches the specified `value`."},{"name":"ge","fqn":"WixDataFilter.ge","slug":"ge","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a greater than or equals filter to a query","content":"let newQuery = query.ge(\"age\", 25);"},{"title":"Create a query, add a greater than or equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .ge(\"age\", 25)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a greater than or equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .ge(\"age\", 25)\n .eq(\"status\", \"active\")\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value is greater than or equal to the specified value.\r\n\r\nThe `ge()` function refines a `WixDataQuery` or `WixDataFilter` to only\r\n match items where the value of the specified property is greater than or\r\n equal to the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically,\r\n so `\"abc\"` is greater than or equal to `\"ABC\"` (because of the greater than),\r\n but `\"ABC\"` is not greater than or equal to `\"abc\"`.\r\n + Reference: Compares by the ID of the referenced item as a String."},{"name":"gt","fqn":"WixDataFilter.gt","slug":"gt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object with the query definition, based on the supplied parameters."},"examples":[{"title":"Add a greater than filter to a query","content":"let newQuery = query.gt(\"age\", 25);"},{"title":"Create a query, add a greater than filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .gt(\"age\", 25)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a greater than filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .gt(\"age\", 25)\n .eq(\"status\", \"active\")\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value is greater than the specified value.\r\n\r\nThe `gt()` function refines a `WixDataQuery` or `WixDataFilter` to only match\r\n items where the value of the specified property is greater than the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically, so `\"text\"` is greater than `\"Text\"`.\r\n + Reference: Compares by the ID of the referenced item as a String."},{"name":"hasAll","fqn":"WixDataFilter.hasAll","slug":"has-all","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a has all filter to a query","content":"let newQuery = query.hasAll(\"sizes\", [30, 38, 42]);"},{"title":"Create a query, add a has all filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .hasAll(\"colors\", [\"red\", \"yellow\", \"blue\"])\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a has all filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .hasAll(\"colors\", [\"red\", \"yellow\", \"blue\"])\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"any"}},{"kind":"DATE"}]},"description":"The values to match against."}],"description":"Refines a query or filter to match items whose specified property values equals all of the specified `value` parameters.\r\n\r\nThe `hasAll()` function refines a `WixDataQuery` or `WixDataFilter` to\r\n only match items where the value of the specified property equals all of\r\n the specified values.\r\n\r\n Matching strings with `hasAll()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\n If the value of the specified property is an array, `hasAll()` will match\r\n if there is a match in the elements of that array for all of the specified\r\n values.\r\n\r\n You can specify a list of values to match by providing an array of\r\n String, Number, or Date types as the `value` parameters."},{"name":"hasSome","fqn":"WixDataFilter.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a has some filter to a query","content":"let newQuery = query.hasSome(\"sizes\", [30, 38, 42]);"},{"title":"Create a query, add a has some filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .hasSome(\"colors\", [\"red\", \"yellow\", \"blue\"])\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a has some filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .hasSome(\"colors\", [\"red\", \"yellow\", \"blue\"])\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Add a has some filter on a multiple reference field to a query","description":"This example gets the items from the **movies** collection that have a\n reference in the **authors** field to an item with an ID that is either\n **1357** or **2468**.","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"movies\")\n .hasSome(\"actors\", [\"1357\", \"2468\"])\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"any"}},{"kind":"DATE"}]},"description":"The values to match against."}],"description":"Refines a query or filter to match items whose specified property value equals any of the specified `value` parameters.\r\n\r\nThe `hasSome()` function refines a `WixDataQuery` or `WixDataFilter` to\r\n only match items where the value of the specified property equals any of\r\n the specified values.\r\n\r\n Matching strings with `hasSome()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\n If the value of the specified property is an array, `hasSome()` will match\r\n if any of the elements of that array match any of the specified values.\r\n\r\n If the specified property contains multiple references, pass item IDs in the\r\n `value` property. In such a case, `hasSome()` will match if any of the\r\n multiple references match any of the specified ID values.\r\n\r\n You can specify a list of values to match by providing an array of\r\n String, Number, or Date types as the `value` parameters."},{"name":"isEmpty","fqn":"WixDataFilter.isEmpty","slug":"is-empty","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an isEmpty filter to a query","content":"let newQuery = query.isEmpty(\"bio\");"},{"title":"Create a query, add an isEmpty filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .isEmpty(\"bio\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add an isEmpty filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .isEmpty(\"bio\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The the property in which to check for a value."}],"description":"Refines a query or filter to match items whose specified property does not exist or does not have any value.\r\n\r\nThe `isEmpty()` function refines a `WixDataQuery` or `WixDataFilter` to only match items where the\r\n value of the specified property is `null` or `undefined` or the property does\r\n not exist.\r\n\r\n If the property contains any value at all for a given item, including the\r\n empty string or an invalid value, that item will match the query."},{"name":"isNotEmpty","fqn":"WixDataFilter.isNotEmpty","slug":"is-not-empty","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an isNotEmpty filter to a query","content":"let newQuery = query.isNotEmpty(\"bio\");"},{"title":"Create a query, add an isNotEmpty filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .isNotEmpty(\"bio\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add an isNotEmpty filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .isNotEmpty(\"bio\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property in which to check for a value."}],"description":"Refines a query or filter to match items whose specified property has any value.\r\n\r\nThe `isNotEmpty()` function refines a `WixDataQuery` or `WixDataFilter` to only match items where the\r\n value of the specified property is not `null` or `undefined`.\r\n\r\n If the property contains any value at all for a given item, including the\r\n empty string or an invalid value, that item will match the query."},{"name":"le","fqn":"WixDataFilter.le","slug":"le","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a less than or equals filter to a query","content":"let newQuery = query.le(\"age\", 25);"},{"title":"Create a query, add a less than or equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .le(\"age\", 25)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a less than or equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .le(\"age\", 25)\n .eq(\"status\", \"active\")\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value is less than or equal to the specified value.\r\n\r\nThe `le()` function refines a `WixDataQuery` or `WixDataFilter` to only match\r\n items where the value of the specified property is less than or equal to the\r\n specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically,\r\n so `\"ABC\"` is less than or equal to `\"abc\"` (because of the less than),\r\n but `\"abc\"` is not less than or equal to `\"ABC\"`.\r\n + Reference: Compares by the ID of the referenced item as a String."},{"name":"lt","fqn":"WixDataFilter.lt","slug":"lt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object with the query definition, based on the supplied parameters."},"examples":[{"title":"Add a less than filter to a query","content":"let newQuery = query.lt(\"age\", 25);"},{"title":"Create a query, add a less than filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .lt(\"age\", 25)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a less than filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .lt(\"age\", 25)\n .eq(\"status\", \"active\")\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value is less than the specified value.\r\n\r\nThe `lt()` function refines a `WixDataQuery` or `WixDataFilter` to only match\r\n items where the value of the specified property is less than the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically, so `\"Text\"` is less than `\"text\"`.\r\n + Reference: Compares by the ID of the referenced item as a String."},{"name":"ne","fqn":"WixDataFilter.ne","slug":"ne","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a not equals filter to a query","content":"let newQuery = query.ne(\"status\", \"active\");"},{"title":"Create a query, add a not equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .ne(\"status\", \"active\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a not equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .ne(\"status\", \"active\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value does not equal the specified value.\r\n\r\nThe `ne()` function refines a `WixDataQuery` or `WixDataFilter` to only\r\n match items where the value of the specified property does not equal the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type is considered not equal to the same number stored as a Number type.\r\n\r\n Matching strings with `ne()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\n If the value of the `propertyName` property is an Array, `ne()` includes items\r\n in which none of the elements of the Array match the specified `value`."},{"name":"not","fqn":"WixDataFilter.not","slug":"not","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a not to a query","content":"let newQuery = query1.not(query2);"},{"title":"Create a query, add a not, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .gt(\"age\", 25)\n .not(\n wixData.query(\"myCollection\")\n .eq(\"access_type\", \"restricted\")\n )\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery"},"description":"A query to add to the initial query as a `not` condition."}],"description":"Adds a `not` condition to the query or filter.\r\n\r\nThe `not()` function adds a `not` condition to a `WixDataQuery` or `WixDataFilter`. A query or filter with a `not`\r\n returns all the items that match the query or filter as defined up to the `not`\r\n function, but don't match the query or filter passed to the `not` function.\r\n\r\n If the query or filter only contains a `not()` function, it returns all the items\r\n that don't match the query defined by the `not` method.\r\n\r\n The collections referenced by both the initial query and the query passed\r\n to the `not` function must be the same."},{"name":"or","fqn":"WixDataFilter.or","slug":"or","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an or to a query","content":"let newQuery = query1.or(query2);"},{"title":"Create a query, add an or, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .lt(\"age\", 25)\n .or(\n wixData.query(\"myCollection\")\n .gt(\"age\", 65)\n )\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n /*\n * For example, results contain items where age is:\n * 18\n * 21\n * 67\n * 90\n *\n * But not items where age is:\n * 25\n * 30\n * 40\n * 65\n */"}],"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery"},"description":"A query to add to the initial query as an `or` condition."}],"description":"Adds an `or` condition to the query or filter.\r\n\r\nThe `or()` function adds an inclusive `or` condition to a `WixDataQuery` or `WixDataFilter`. A query or filter\r\n with an `or` returns all the items that match the query or filter as defined up to\r\n the `or` function, the items that match the query or filter passed to the `or`\r\n function, and the items that match both.\r\n\r\n The collections used by both the initial query and the query passed\r\n to the `or` function must be the same.\r\n\r\n The 'or()' function is designed to work with 2 or more queries or filters.\r\n If you use it on its own, it will return all the items in a collection."},{"name":"startsWith","fqn":"WixDataFilter.startsWith","slug":"starts-with","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","string"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a starts with filter to a query","content":"let newQuery = query.startsWith(\"last_name\", \"M\");"},{"title":"Create a query, add a starts with filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .startsWith(\"last_name\", \"M\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a starts with filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .startsWith(\"last_name\", \"M\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with the string."},{"name":"string","slug":"string","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The string to look for at the beginning of the specified property value."}],"description":"Refines a query or filter to match items whose specified property value starts with a specified string.\r\n\r\nThe `startsWith()` function refines a `WixDataQuery` or `WixDataFilter` to\r\n only match items where the value of the specified property starts with the\r\n defined `string`. Matching with `startsWith()` is not case sensitive, so `\"TEXT\"` starts\r\n with `\"tex\"`.\r\n\r\n You can only use `startsWith()` with a property whose value is a String or Reference.\r\n When using a Reference, `startsWith()` matches by the ID of the referenced item as Strings."}],"webhooks":[],"articles":[{"content":"# Introduction\nThe `WixDataFilter` functions enable you to filter and control which results are returned by a dataset when the\n[`setFilter()`](https://dev.wix.com/docs/velo/api-reference/wix-dataset/dataset/set-filter) function is applied.\n\nA filter is used to control which data is contained in a dataset on your page.\n\nTypically, you build a filter using the [`filter()`](wix-data.html#filter) function, refine the filter with `WixDataFilter` functions, and then apply the filter to the dataset using the [`setFilter()`](https://dev.wix.com/docs/velo/api-reference/wix-dataset/dataset/set-filter) function.\n\nFor example, the following code shows a filter on a dataset that is connected to a collection containing customer data. The filter includes only customers over the age of 20:\n\n```javascript\n import wixData from 'wix-data';\n\n const customerFilter = wixData.filter()\n .gt(\"age\", 20);\n\n $w(\"#myDataset\").setFilter(customerFilter);\n\n\n ```\nWhen working with [Wix app collections](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code), check [which fields](https://support.wix.com/en/search?term=velo%20collection%20fields) can be used in a filter.","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]},{"name":"WixDataQuery","slug":"wix-data-query","fqn":"WixDataQuery","standaloneTypes":[],"metadata":{},"actions":[{"name":"ascending","fqn":"WixDataQuery.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an ascending sort to a query","content":"let newQuery = query.ascending(\"last_name\", \"first_name\");"},{"title":"Create a query, add an ascending sort, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .ascending(\"last_name\", \"first_name\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add an ascending sort, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .ascending(\"last_name\", \"first_name\")\n .eq(\"status\", \"active\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort."}],"description":"Adds a sort to a query or sort, sorting by the specified properties in ascending order.\r\n\r\nThe `ascending()` function refines a `WixDataQuery` or `WixDataSort` to sort in ascending order of\r\n the specified properties. If you specify more than one property,\r\n `ascending()` sorts the results in ascending order by each property in the\r\n order they are listed.\r\n\r\n You can sort the following types:\r\n\r\n + Number: Sorts numerically.\r\n + Date: Sorts by date and time.\r\n + String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n + Reference: Compares by the ID of the referenced item as a String.\r\n\r\n\r\n If a property contains a number as a String, that value will be sorted\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified sort property are ranked lowest."},{"name":"count","fqn":"WixDataQuery.count","slug":"count","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"number"},"description":"Fulfilled - The number of items that match the query.\r\nRejected - The errors that caused the rejection."},"examples":[{"title":"Perform a count on a query","content":"query.count()\n .then((num) => {\n let numberOfItems = num;\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query and perform a count on it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .count()\n .then((num) => {\n let numberOfItems = num;\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query and perform a count on it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .eq(\"status\", \"active\")\n .gt(\"age\", 25)\n .count()\n .then((num) => {\n let numberOfItems = num;\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataOptions","referenceFqn":"WixDataOptions"},"description":"An object containing options to use when processing this operation."}],"description":"Returns the number of items that match the query.\r\n\r\nThe `count()` function returns a Promise that resolves to the number of\r\n items that match the query. The Promise is rejected if `count()` is called\r\n with incorrect permissions or if any of the functions used to refine the\r\n query is invalid.\r\n\r\n Calling the `count()` function triggers the [`beforeCount()`](wix-data.Hooks.html#beforeCount)\r\n and [`afterCount()`](wix-data.Hooks.html#afterCount) hooks if they have been defined.\r\n\r\n Use the `options` parameter to run `count()` without checking for permissions\r\n or without its registered hooks.\r\n\r\n Any function that does not filter query results (e.g., [`ascending()`](#ascending))\r\n does not affect the result of `count()`.\r\n\r\n If you build a query and don't refine it with any `WixDataQuery` functions,\r\n `count()` returns the total number of items in the collection.\r\n\r\n If you have already run a query with [`find()`](#find), you can retrieve\r\n the number of query results without calling `count()`. The [`find()`](#find)\r\n function returns a Promise that resolves to a [`WixDataQueryResult`](https://dev.wix.com/docs/velo/api-reference/wix-data/wix-data-query-result/introduction)\r\n object, which has a `totalCount` property whose value is the number of results."},{"name":"descending","fqn":"WixDataQuery.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an descending sort to a query","content":"let newQuery = query.descending(\"last_name\", \"first_name\");"},{"title":"Create a query, add an descending sort, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .descending(\"last_name\", \"first_name\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add an descending sort, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .descending(\"last_name\", \"first_name\")\n .eq(\"status\", \"active\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort."}],"description":"Adds a sort to a query or sort, sorting by the specified properties in descending order.\r\n\r\nThe `descending()` function refines a `WixDataQuery` or `WixDataSort` to sort in descending order of\r\n the specified properties. If you specify more than one property,\r\n `descending()` sorts the results in descending order by each property in the\r\n order they are listed.\r\n\r\n You can sort the following types:\r\n\r\n + Number: Sorts numerically.\r\n + Date: Sorts by date and time.\r\n + String: Sorts lexicographically, so `\"abc\"` comes before `\"XYZ\"`.\r\n + Reference: Compares by the ID of the referenced item as a String.\r\n\r\n\r\n If a property contains a number as a String, that value will be sorted\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified sort property are ranked lowest."},{"name":"distinct","fqn":"WixDataQuery.distinct","slug":"distinct","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataQueryResult","referenceFqn":"WixDataQueryResult.WixDataQueryResult"},"description":"Fulfilled - A Promise that resolves to the results of the query.\r\nRejected - Error that caused the query to fail."},"examples":[{"title":"Get distinct values from a query","description":"This example demonstrates how to run a `distinct()` on a `query()` that was previously built and stored in a variable.","content":"query.distinct(\"state\")\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n"},{"title":"Create a distinct query and run it","description":"This example demonstrates how to build a `query()` and then run `distinct()` on it.","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .distinct(\"state\")\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n"},{"title":"Create a query, add functions to the query, and find distinct values","description":"This example demonstrates how to build a `query()`, chain additional functions such as `eq()` and `gt()` to the query, and then run the `distinct()`.","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .eq(\"status\", \"active\")\n .gt(\"age\", 25)\n .distinct(\"state\")\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n"},{"title":"Create a distinct query with options and run it","description":"This example demonstrates how to build a `query()` and then run `distinct()` bypassing permission checks.\n Note that the `options` parameter can only be used in backend code.","content":"import wixData from 'wix-data';\n\n// ...\n\nlet options = {\n \"suppressAuth\": true\n};\n\nwixData.query(\"myCollection\")\n .distinct(\"state\", options)\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared for distinct values."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataQueryOptions","referenceFqn":"WixDataQueryOptions"},"description":"An object containing options to use when processing this operation."}],"description":"Returns the distinct values that match the query, without duplicates.\r\n\r\nThe `distinct()` function returns a Promise that resolves to:\r\n\r\n + The distinct values found in the specified field when running the query.\r\n + Additional information about the results, such as the number of values that match the query.\r\n\r\n\r\n Unlike `find()`, which returns all item objects that match the query, `distinct()` returns matching field values, and eliminates\r\n duplicate field values from the query result. You cannot use `find()` and `distinct()` together.\r\n\r\n For an item to be resolved as distinct, only the specified field must be distinct. Other fields for that item in the\r\n collection are not evaluated when resolving the promise.\r\n\r\n The Promise is rejected if `distinct()` is called with incorrect permissions or if any of the\r\n functions used to refine the query is invalid.\r\n\r\n >**Note:** Only site visitors with [Data Read](https://support.wix.com/en/article/collection-permissions-an-overview#permissions) permissions can retrieve and view data. You can override the permissions by setting the `suppressAuth` option to `true`."},{"name":"fields","fqn":"WixDataQuery.fields","slug":"fields","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the query."},"examples":[{"title":"Add a fields function to a query","content":"let myQuery = query.fields(\"fieldName1\", \"fieldName2\");"},{"title":"Create a query, specify fields to return, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"books\")\n .fields(\"authorLastName\", \"title\")\n .find()\n .then((results) => {\n let books = results.items;\n } else {\n // handle case where no matching items found\n }\n )\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n }); \n/* Items returned contain the _id field in addition to the requested fields.\n * [\n * {\n * _id: '123', \n * authorLastName: 'Rowling', \n * title: 'Fantastic Beasts'\n * },\n * {\n * _id: '456', \n * authorLastName: 'Melville', \n * title: 'Moby Dick'\n * }\n * ] \n */"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Properties to return. To return multiple properties,\r\npass properties as additional arguments."}],"description":"Lists the fields to return in a query's results.\r\n\r\nThe `fields()` function returns only the specified fields in the query's results.\r\n\r\n You can use [`include()`](#include) in conjunction with `fields()` to get referenced items.\r\n\r\n When `fields()` receives an empty or invalid property, the query behaves as follows:\r\n\r\n + When no fields are specified, the query returns all fields.\r\n + When multiple fields are specified but some are invalid, invalid fields are ignored and valid fields are returned.\r\n + When only invalid fields are specified, only the default `_id` field is returned."},{"name":"find","fqn":"WixDataQuery.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataQueryResult","referenceFqn":"WixDataQueryResult.WixDataQueryResult"},"description":"Fulfilled - A Promise that resolves to the results of the query.\r\nRejected - Error that caused the query to fail."},"examples":[{"title":"Perform a find on a query","description":"This example demonstrates how to run a `find()` on a `query()` that was previously built and stored in a variable.","content":"query.find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n"},{"title":"Create a query and run it","description":"This example demonstrates how to build a `query()` and then run a `find()` on it.","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n"},{"title":"Create a query, add functions to the query, and run it","description":"This example demonstrates how to build a `query()`, chain additional functions such as `eq()` and `gt()` to the query, and then run the `query()`.","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .eq(\"status\", \"active\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n"},{"title":"Create a query with options and run it","description":"This example demonstrates how to build a `query()` and then run a `find()` that bypasses permission checks and registered hooks.\n Note that the `options` parameter can only be used in backend code.","content":"import wixData from 'wix-data';\n\n// ...\n\nlet options = {\n \"suppressAuth\": true,\n \"suppressHooks\": true\n};\n\nwixData.query(\"myCollection\")\n .find(options)\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n } else {\n // handle case where no matching items found\n } \n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataQueryOptions","referenceFqn":"WixDataQueryOptions"},"description":"An object containing options to use when processing this operation."}],"description":"Returns the items that match the query.\r\n\r\nThe `find()` function returns a Promise that resolves to the results found\r\n by the query and some information about the results. The Promise is\r\n rejected if `find()` is called with incorrect permissions or if any of the\r\n functions used to refine the query is invalid.\r\n\r\n Calling the `find()` function triggers the [`beforeQuery()`](wix-data.Hooks.html#beforeQuery)\r\n and [`afterQuery()`](wix-data.Hooks.html#afterQuery) hooks if they have been defined.\r\n\r\n> **Note:**\r\n Calling `find()` triggers hooks for the specified collection only. It doesn’t trigger hooks for referenced collections.\r\n\r\n Use the `options` parameter to override default preferences:\r\n + Override permission checks with `suppressAuth`.\r\n + Ensure the most up-to-date data is retrieved with `consistentRead`.\r\n + Prevent hooks from running with `suppressHooks`.\r\n + Speed up execution with `omitTotalCount`, if you don't need a count of items matching the query.\r\n\r\n If you build a query and don't refine it with any `wixDataQuery` functions,\r\n `find()` returns the entire collection."},{"name":"include","fqn":"WixDataQuery.include","slug":"include","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the query."},"examples":[{"title":"Add an include to a query","content":"let newQuery = query.include(\"referenceField\");"},{"title":"Create a query, include a reference field, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .include(\"referenceField\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let firstRefProp = firstItem.referenceField.propertyName;\n\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, include a reference field, and run it","description":"In this example there is a **books** collection which has two reference fields\n that reference an **authors** collection and a **publishers** collection.\n\n The query includes the **author** and **publisher** properties so that each\n returned book will also include the full items of its referenced author and\n publisher.","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"books\")\n .include(\"author\", \"publisher\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let books = results.items;\n let firstBook = books[0];\n let firstAuthor = firstBook.author;\n let firstAuthorBio = firstAuthor.bio;\n let firstPublisher = firstBook.publisher.name;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n"},{"title":"Create a query, include a reference field, and run it","description":"In this example there is a **books** collection which has two reference fields\n that reference an **authors** collection and a **publishers** collection.\n\n The query is refined to only include books from a specific publisher using\n the `eq()` function and the publisher's ID.\n\n The query also includes the **author** property so that each returned\n book will include the full item of its referenced author.","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"books\")\n .eq(\"publisher\", \"00001\")\n .include(\"author\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let books = results.items;\n let firstBook = books[0];\n let firstAuthor = firstBook.author;\n let firstAuthorBio = firstAuthor.bio;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n"},{"title":"Create a query, include a reference field, and populate a table with the results","description":"In this example there is a **books** collection which has one reference field,\n **author**, that references an **authors** collection.\n\n The columns of a table are set to show information from both the **books**\n collection and the referenced **authors** collection.\n\n The query includes the **author** property so that each returned\n book will include the full item of its referenced author.","content":"import wixData from 'wix-data';\n\n// ...\n\n$w(\"#myTable\").columns = [\n {\n \"id\": \"col1\",\n // 'dataPath' is 'title' field from 'Books' collection\n \"dataPath\": \"title\", \n \"label\": \"Book\",\n \"type\": \"string\"\n }, {\n \"id\": \"col2\",\n // 'datapath' is 'name' field from the collection referenced\n // in the 'author' field \n \"dataPath\": \"author.name\",\n \"label\": \"Author\",\n \"type\": \"string\"\n }\n];\n\nwixData.query(\"books\")\n .include(\"author\")\n .find()\n .then((myResults) => {\n if(myResults.items.length > 0) {\n $w(\"#myTable\").rows = myResults.items;\n }\n else {\n console.log(\"No results found.\");\n }\n });\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties for which to include referenced items."}],"description":"Includes referenced items for the specified properties in a query's results.\r\n\r\nThe `include()` function refines a query so that the items returned in the\r\n query's results include the full referenced items for the specified properties.\r\n\r\n For example, suppose you have a **books** collection with an **author**\r\n field that references an **authors** collection. Querying the **books**\r\n collection with an `include(\"author\")` returns the relevant book items\r\n and each item will include the full referenced author item in the book's\r\n `author` property.\r\n\r\n When querying a collection that contains a reference field without using the\r\n `include()` function:\r\n\r\n + Single reference field: returned items contain only the ID of the\r\n referenced item, and not the full referenced items.\r\n + Multiple reference field: returned items do not contain the multiple\r\n reference field at all.\r\n\r\n\r\n When including a property with multiple references, the following limitations\r\n apply:\r\n\r\n + Only one property with multiple references can be included.\r\n + The query will return an error if more than 50 items are returned, regardless\r\n of any query limit set using the [`limit()`](#limit) function.\r\n + Each returned item can include up to 50 referenced items. If there are more\r\n than 50 referenced items, only 50 are returned when the query is run\r\n and the [`partialIncludes`](wix-data.WixDataQueryResult.html#partialIncludes)\r\n property of the returned [`WixDataQueryResult`](wix-data.WixDataQueryResult.html)\r\n is `true`. To retrieve more than 50 referenced items, use the\r\n [`queryReferenced()`](wix-data.html#queryReferenced) function.\r\n\r\n\r\n For a discussion of when to use the similar [`queryReferenced()`](wix-data.html#queryReferenced)\r\n function and when to use `include()`, see [Querying Items that Reference Other Items](https://support.wix.com/en/article/including-referenced-data-when-filtering).\r\n\r\n > **Notes:**\r\n > - Calling the `include()` function does not trigger any hooks.\r\n > - The `include()` function is not supported for Single Item Collections."},{"name":"limit","fqn":"WixDataQuery.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["limit"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a limit to a query","content":"let newQuery = query.limit(10);"},{"title":"Create a query, add a limit, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a limit, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .eq(\"status\", \"active\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Iterate through all pages of query results","description":"This example demonstrates how to get all query results, bypassing the maximum limit of 1000.","content":"async function retrieveAllItems() {\n let results = await wixData.query(\"myCollection\")\n .limit(1000)\n .find();\n let allItems = results.items;\n while (results.hasNext()) {\n results = await results.next();\n allItems = allItems.concat(results.items);\n }\n return allItems;\n}"}],"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items to return, which is also the [`pageSize`](wix-data.WixDataQueryResult.html#pageSize) of the results object."}],"description":"Limits the number of items the query returns.\r\n\r\nThe `limit()` function defines the number of results a query returns in each\r\n page. Only one page of results is retrieved at a time. The [`next()`](wix-data.WixDataQueryResult.html#next)\r\n and [`prev()`](wix-data.WixDataQueryResult.html#prev) functions are used to\r\n navigate the pages of a query result.\r\n\r\n By default, `limit` is set to `50`.\r\n\r\n The maximum value that `limit()` can accept is `1000`.\r\n\r\n Note that for some Wix app collections, the maximum value `limit()` can accept is\r\n less than `1000`. For example, the maximum limit for the Wix `Stores/Product` collection is 100."},{"name":"skip","fqn":"WixDataQuery.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["skip"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a skip to a query","content":"let newQuery = query.skip(10);"},{"title":"Create a query, add a skip, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .skip(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a skip, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .eq(\"status\", \"active\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .skip(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of items to skip in the query results before returning the results."}],"description":"Sets the number of items to skip before returning query results.\r\n\r\nThe `skip()` function defines the number of results to skip in the query\r\n results before returning new query results.\r\n\r\n For example, if you query a collection and 50 items match your query, but\r\n you set `skip` to 10, the results returned will skip the first 10 items\r\n that match and return the 11th through 50th items.\r\n\r\n By default, `skip` is set to 0."},{"name":"and","fqn":"WixDataFilter.and","slug":"and","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an and to a query","content":"let newQuery = query1.and(query2);"},{"title":"Create two or queries, add an and, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nlet statusQuery = wixData.query(\"myCollection\")\n .eq(\"status\", \"pending\")\n .or(\n wixData.query(\"myCollection\")\n .eq(\"status\", \"rejected\")\n );\n\nlet ageQuery = wixData.query(\"myCollection\")\n .lt(\"age\", 25)\n .or(\n wixData.query(\"myCollection\")\n .gt(\"age\", 65)\n );\n\nstatusQuery.and(ageQuery)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n /*\n * For example, results contain items where age is:\n * 18\n * 21\n * 67\n * 90\n *\n * But not items where age is:\n * 25\n * 30\n * 40\n * 65\n */"}],"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery"},"description":"A query to add to the initial query as an `and` condition."}],"description":"Adds an `and` condition to the query or filter.\r\n\r\nThe `and()` function adds an `and` condition to a `WixDataQuery` or `WixDataFilter`.\r\n A query or filter with an `and` returns all the items that match the query\r\n or filter as defined up to the `and` function and also match the query or\r\n filter passed to the `and` function.\r\n\r\n Note that when chaining multiple `WixDataFilter` functions to a query an `and` condition is assumed.\r\n In such cases, you do not need to add a call to the `and()` function.\r\n For example, this query returns results where status is active **and** age is\r\n greater than 25.\r\n\r\n ```javascript\r\n wixData.query(\"myCollection\")\r\n .eq(\"status\", \"active\")\r\n .gt(\"age\", 25);\r\n ```\r\n\r\n The `and()` function is needed when performing compound queries. For\r\n example, the final query in this set of queries returns results where status\r\n is either pending or rejected **and** age is either less than 25 or greater than 65.\r\n\r\n ```javascript\r\n let statusQuery = wixData.query(\"myCollection\")\r\n .eq(\"status\", \"pending\")\r\n .or(\r\n wixData.query(\"myCollection\")\r\n .eq(\"status\", \"rejected\")\r\n );\r\n\r\n let ageQuery = wixData.query(\"myCollection\")\r\n .lt(\"age\", 25)\r\n .or(\r\n wixData.query(\"myCollection\")\r\n .gt(\"age\", 65)\r\n );\r\n\r\n let statusAndAgeQuery = statusQuery.and(ageQuery);\r\n ```\r\n\r\n The collections referenced by both the initial query and the query passed\r\n to the `and` function must be the same.\r\n\r\n The 'and()' function is designed to work with 2 or more queries or filters.\r\n If you use it on its own, it will return all the items in a collection."},{"name":"between","fqn":"WixDataFilter.between","slug":"between","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","rangeStart","rangeEnd"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a between filter to a query","content":"let newQuery = query.between(\"age\", 25, 65);"},{"title":"Create a query, add a between filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .between(\"age\", 25, 65)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a between filter and other filters, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .between(\"age\", 25, 65)\n .eq(\"status\", \"active\")\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `rangeStart` and `rangeEnd`."},{"name":"rangeStart","slug":"range-start","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The beginning value of the range to match against."},{"name":"rangeEnd","slug":"range-end","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The ending value of the range to match against."}],"description":"Refines a query or filter to match items whose specified property value is within a specified range.\r\n\r\nThe `between()` function refines a `WixDataQuery` or `WixDataFilter` to only\r\n match items where the value of the specified property is greater than or equal\r\n to `rangeStart` and less than `rangeEnd`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically, so\r\n + `\"A\"` and `\"M\"` are between `\"A\"` and `\"Z\"`, but `\"a\"`, `\"m\"`, `\"z\"` and `\"Z\"` are not.\r\n + `\"A\"`, `\"M\"`, `\"Z\"`, and `\"a\"` are between `\"A\"` and `\"z\"`, but `\"z\"` is not."},{"name":"contains","fqn":"WixDataFilter.contains","slug":"contains","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","string"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a contains filter to a query","content":"let newQuery = query.contains(\"description\", \"some words\");"},{"title":"Create a query, add a contains filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .contains(\"description\", \"some words\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a contains filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .contains(\"description\", \"some words\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with the string."},{"name":"string","slug":"string","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The string to look for inside the specified property value."}],"description":"Refines a query or filter to match items whose specified property value contains a specified string.\r\n\r\nThe `contains()` function refines a `WixDataQuery` or `WixDataFilter` to\r\n only match items where the value of the specified property contains the\r\n specified `string`. Matching with `contains()` is not case sensitive, so\r\n `\"text\"` does contain `\"Tex\"`.\r\n\r\n You can use `contains()` with a property whose value is a String or a Reference.\r\n For properties of type reference it is recommended that you use the [`eq()`](#eq)\r\n function instead of `contains()`. With properties that are References, `contains()`\r\n matches by the ID of the referenced item as a String."},{"name":"endsWith","fqn":"WixDataFilter.endsWith","slug":"ends-with","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","string"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an ends with filter to a query","content":"let newQuery = query.endsWith(\"last_name\", \"z\");"},{"title":"Create a query, add an ends with filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .endsWith(\"last_name\", \"z\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add an ends with filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .endsWith(\"last_name\", \"z\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with the string."},{"name":"string","slug":"string","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The string to look for at the end of the specified property value."}],"description":"Refines a query or filter to match items whose specified property value ends with a specified string.\r\n\r\nThe `endsWith()` function refines a `WixDataQuery` or `WixDataFilter` to only\r\n match items where the value of the specified property ends with the specified\r\n`string`. Matching with `endsWith()` is not case sensitive, so `\"TEXT\"` ends\r\n with `\"ext\"`.\r\n\r\n You can only use `endsWith()` with a property whose value is a String or Reference.\r\n When using a Reference, `endsWith()` matches by the ID of the referenced item as Strings."},{"name":"eq","fqn":"WixDataFilter.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an equals filter to a query","content":"let newQuery = query.eq(\"status\", \"active\");"},{"title":"Create a query, add an equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .eq(\"status\", \"active\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add an equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .eq(\"status\", \"active\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value equals the specified value.\r\n\r\nThe `eq()` function refines a `WixDataQuery` or `WixDataFilter` to only\r\n match items where the value of the specified property equals the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n Matching strings with `eq()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\n If `propertyName` points to a collection field of type Array, `eq()` includes the item\r\n as long as at least one Array element matches the specified `value`."},{"name":"ge","fqn":"WixDataFilter.ge","slug":"ge","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a greater than or equals filter to a query","content":"let newQuery = query.ge(\"age\", 25);"},{"title":"Create a query, add a greater than or equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .ge(\"age\", 25)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a greater than or equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .ge(\"age\", 25)\n .eq(\"status\", \"active\")\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value is greater than or equal to the specified value.\r\n\r\nThe `ge()` function refines a `WixDataQuery` or `WixDataFilter` to only\r\n match items where the value of the specified property is greater than or\r\n equal to the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically,\r\n so `\"abc\"` is greater than or equal to `\"ABC\"` (because of the greater than),\r\n but `\"ABC\"` is not greater than or equal to `\"abc\"`.\r\n + Reference: Compares by the ID of the referenced item as a String."},{"name":"gt","fqn":"WixDataFilter.gt","slug":"gt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object with the query definition, based on the supplied parameters."},"examples":[{"title":"Add a greater than filter to a query","content":"let newQuery = query.gt(\"age\", 25);"},{"title":"Create a query, add a greater than filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .gt(\"age\", 25)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a greater than filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .gt(\"age\", 25)\n .eq(\"status\", \"active\")\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value is greater than the specified value.\r\n\r\nThe `gt()` function refines a `WixDataQuery` or `WixDataFilter` to only match\r\n items where the value of the specified property is greater than the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically, so `\"text\"` is greater than `\"Text\"`.\r\n + Reference: Compares by the ID of the referenced item as a String."},{"name":"hasAll","fqn":"WixDataFilter.hasAll","slug":"has-all","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a has all filter to a query","content":"let newQuery = query.hasAll(\"sizes\", [30, 38, 42]);"},{"title":"Create a query, add a has all filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .hasAll(\"colors\", [\"red\", \"yellow\", \"blue\"])\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a has all filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .hasAll(\"colors\", [\"red\", \"yellow\", \"blue\"])\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"any"}},{"kind":"DATE"}]},"description":"The values to match against."}],"description":"Refines a query or filter to match items whose specified property values equals all of the specified `value` parameters.\r\n\r\nThe `hasAll()` function refines a `WixDataQuery` or `WixDataFilter` to\r\n only match items where the value of the specified property equals all of\r\n the specified values.\r\n\r\n Matching strings with `hasAll()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\n If the value of the specified property is an array, `hasAll()` will match\r\n if there is a match in the elements of that array for all of the specified\r\n values.\r\n\r\n You can specify a list of values to match by providing an array of\r\n String, Number, or Date types as the `value` parameters."},{"name":"hasSome","fqn":"WixDataFilter.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a has some filter to a query","content":"let newQuery = query.hasSome(\"sizes\", [30, 38, 42]);"},{"title":"Create a query, add a has some filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .hasSome(\"colors\", [\"red\", \"yellow\", \"blue\"])\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a has some filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .hasSome(\"colors\", [\"red\", \"yellow\", \"blue\"])\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Add a has some filter on a multiple reference field to a query","description":"This example gets the items from the **movies** collection that have a\n reference in the **authors** field to an item with an ID that is either\n **1357** or **2468**.","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"movies\")\n .hasSome(\"actors\", [\"1357\", \"2468\"])\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"any"}},{"kind":"DATE"}]},"description":"The values to match against."}],"description":"Refines a query or filter to match items whose specified property value equals any of the specified `value` parameters.\r\n\r\nThe `hasSome()` function refines a `WixDataQuery` or `WixDataFilter` to\r\n only match items where the value of the specified property equals any of\r\n the specified values.\r\n\r\n Matching strings with `hasSome()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\n If the value of the specified property is an array, `hasSome()` will match\r\n if any of the elements of that array match any of the specified values.\r\n\r\n If the specified property contains multiple references, pass item IDs in the\r\n `value` property. In such a case, `hasSome()` will match if any of the\r\n multiple references match any of the specified ID values.\r\n\r\n You can specify a list of values to match by providing an array of\r\n String, Number, or Date types as the `value` parameters."},{"name":"isEmpty","fqn":"WixDataFilter.isEmpty","slug":"is-empty","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an isEmpty filter to a query","content":"let newQuery = query.isEmpty(\"bio\");"},{"title":"Create a query, add an isEmpty filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .isEmpty(\"bio\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add an isEmpty filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .isEmpty(\"bio\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The the property in which to check for a value."}],"description":"Refines a query or filter to match items whose specified property does not exist or does not have any value.\r\n\r\nThe `isEmpty()` function refines a `WixDataQuery` or `WixDataFilter` to only match items where the\r\n value of the specified property is `null` or `undefined` or the property does\r\n not exist.\r\n\r\n If the property contains any value at all for a given item, including the\r\n empty string or an invalid value, that item will match the query."},{"name":"isNotEmpty","fqn":"WixDataFilter.isNotEmpty","slug":"is-not-empty","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an isNotEmpty filter to a query","content":"let newQuery = query.isNotEmpty(\"bio\");"},{"title":"Create a query, add an isNotEmpty filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .isNotEmpty(\"bio\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add an isNotEmpty filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .isNotEmpty(\"bio\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property in which to check for a value."}],"description":"Refines a query or filter to match items whose specified property has any value.\r\n\r\nThe `isNotEmpty()` function refines a `WixDataQuery` or `WixDataFilter` to only match items where the\r\n value of the specified property is not `null` or `undefined`.\r\n\r\n If the property contains any value at all for a given item, including the\r\n empty string or an invalid value, that item will match the query."},{"name":"le","fqn":"WixDataFilter.le","slug":"le","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a less than or equals filter to a query","content":"let newQuery = query.le(\"age\", 25);"},{"title":"Create a query, add a less than or equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .le(\"age\", 25)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a less than or equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .le(\"age\", 25)\n .eq(\"status\", \"active\")\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value is less than or equal to the specified value.\r\n\r\nThe `le()` function refines a `WixDataQuery` or `WixDataFilter` to only match\r\n items where the value of the specified property is less than or equal to the\r\n specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically,\r\n so `\"ABC\"` is less than or equal to `\"abc\"` (because of the less than),\r\n but `\"abc\"` is not less than or equal to `\"ABC\"`.\r\n + Reference: Compares by the ID of the referenced item as a String."},{"name":"lt","fqn":"WixDataFilter.lt","slug":"lt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object with the query definition, based on the supplied parameters."},"examples":[{"title":"Add a less than filter to a query","content":"let newQuery = query.lt(\"age\", 25);"},{"title":"Create a query, add a less than filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .lt(\"age\", 25)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a less than filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .lt(\"age\", 25)\n .eq(\"status\", \"active\")\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value is less than the specified value.\r\n\r\nThe `lt()` function refines a `WixDataQuery` or `WixDataFilter` to only match\r\n items where the value of the specified property is less than the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type does not match the same number stored as a Number type.\r\n\r\n If a property contains a number as a String, that value will be compared\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified property are ranked lowest.\r\n\r\n The following types of properties can be compared:\r\n\r\n + Number: Compares numerically.\r\n + Date: Compares JavaScript Date objects.\r\n + String: Compares lexicographically, so `\"Text\"` is less than `\"text\"`.\r\n + Reference: Compares by the ID of the referenced item as a String."},{"name":"ne","fqn":"WixDataFilter.ne","slug":"ne","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a not equals filter to a query","content":"let newQuery = query.ne(\"status\", \"active\");"},{"title":"Create a query, add a not equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .ne(\"status\", \"active\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a not equals filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .ne(\"status\", \"active\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query or filter to match items whose specified property value does not equal the specified value.\r\n\r\nThe `ne()` function refines a `WixDataQuery` or `WixDataFilter` to only\r\n match items where the value of the specified property does not equal the specified `value`.\r\n\r\n It only matches values of the same type. For example, a number value stored\r\n as a String type is considered not equal to the same number stored as a Number type.\r\n\r\n Matching strings with `ne()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\r\n\r\n If the value of the `propertyName` property is an Array, `ne()` includes items\r\n in which none of the elements of the Array match the specified `value`."},{"name":"not","fqn":"WixDataFilter.not","slug":"not","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a not to a query","content":"let newQuery = query1.not(query2);"},{"title":"Create a query, add a not, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .gt(\"age\", 25)\n .not(\n wixData.query(\"myCollection\")\n .eq(\"access_type\", \"restricted\")\n )\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery"},"description":"A query to add to the initial query as a `not` condition."}],"description":"Adds a `not` condition to the query or filter.\r\n\r\nThe `not()` function adds a `not` condition to a `WixDataQuery` or `WixDataFilter`. A query or filter with a `not`\r\n returns all the items that match the query or filter as defined up to the `not`\r\n function, but don't match the query or filter passed to the `not` function.\r\n\r\n If the query or filter only contains a `not()` function, it returns all the items\r\n that don't match the query defined by the `not` method.\r\n\r\n The collections referenced by both the initial query and the query passed\r\n to the `not` function must be the same."},{"name":"or","fqn":"WixDataFilter.or","slug":"or","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an or to a query","content":"let newQuery = query1.or(query2);"},{"title":"Create a query, add an or, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .lt(\"age\", 25)\n .or(\n wixData.query(\"myCollection\")\n .gt(\"age\", 65)\n )\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });\n\n /*\n * For example, results contain items where age is:\n * 18\n * 21\n * 67\n * 90\n *\n * But not items where age is:\n * 25\n * 30\n * 40\n * 65\n */"}],"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery"},"description":"A query to add to the initial query as an `or` condition."}],"description":"Adds an `or` condition to the query or filter.\r\n\r\nThe `or()` function adds an inclusive `or` condition to a `WixDataQuery` or `WixDataFilter`. A query or filter\r\n with an `or` returns all the items that match the query or filter as defined up to\r\n the `or` function, the items that match the query or filter passed to the `or`\r\n function, and the items that match both.\r\n\r\n The collections used by both the initial query and the query passed\r\n to the `or` function must be the same.\r\n\r\n The 'or()' function is designed to work with 2 or more queries or filters.\r\n If you use it on its own, it will return all the items in a collection."},{"name":"startsWith","fqn":"WixDataFilter.startsWith","slug":"starts-with","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","string"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add a starts with filter to a query","content":"let newQuery = query.startsWith(\"last_name\", \"M\");"},{"title":"Create a query, add a starts with filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .startsWith(\"last_name\", \"M\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add a starts with filter, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .startsWith(\"last_name\", \"M\")\n .gt(\"age\", 25)\n .ascending(\"last_name\", \"first_name\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with the string."},{"name":"string","slug":"string","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The string to look for at the beginning of the specified property value."}],"description":"Refines a query or filter to match items whose specified property value starts with a specified string.\r\n\r\nThe `startsWith()` function refines a `WixDataQuery` or `WixDataFilter` to\r\n only match items where the value of the specified property starts with the\r\n defined `string`. Matching with `startsWith()` is not case sensitive, so `\"TEXT\"` starts\r\n with `\"tex\"`.\r\n\r\n You can only use `startsWith()` with a property whose value is a String or Reference.\r\n When using a Reference, `startsWith()` matches by the ID of the referenced item as Strings."}],"webhooks":[],"articles":[{"content":"# Introduction\nThe `WixDataQuery` functions enable you to run, sort, filter, and control\n which results a query returns.\n\n Typically, you build a query using the [`query()`](wix-data.html#query) function,\n refine the query by chaining `WixDataQuery` functions, and then execute the\n query by chaining *one* of the following: [`find()`](#find), [`distinct()`](#distinct), or [`count()`](#count)\n\n For example, the following code queries a collection for all male customers\n over the age of 20 and logs the first 15 results to the console, sorted in\n ascending order by name:\n\n ```javascript\n import wixData from 'wix-data';\n\n wixData.query(\"Customer\")\n .gt(\"age\", 20)\n .ascending(\"name\")\n .limit(15)\n .find()\n .then((results) => {\n console.log(results.items);\n });\n ```\n\nWhen working with [Wix app collections](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code), fields in the collections have the following permissions:\n + Can connect to data\n + Can use in dynamic page URL\n + Can be sorted\n + Can be filtered\n + Read-only\nCheck [which fields](https://support.wix.com/en/search?term=velo%20collection%20fields) can be used in a query.","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]},{"name":"WixDataQueryReferencedResult","slug":"wix-data-query-referenced-result","fqn":"WixDataQueryReferencedResult","standaloneTypes":[],"metadata":{},"actions":[{"name":"hasNext","fqn":"WixDataQueryReferencedResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"examples":[{"title":"Get whether the reference query result object has more results","content":"let hasNext = results.hasNext(); // true"}],"description":"Indicates if the reference query has more results."},{"name":"hasPrev","fqn":"WixDataQueryReferencedResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are previous results."},"examples":[{"title":"Get whether the reference query result object has previous results","content":"let hasPrev = results.hasPrev(); // false"}],"description":"Indicates if the reference query has previous results."},{"name":"next","fqn":"WixDataQueryReferencedResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataQueryReferencedResult","referenceFqn":"WixDataQueryReferencedResult.WixDataQueryReferencedResult"},"description":"Fulfilled - A reference query result object with the next page of query results.\r\nRejected - The errors that caused the rejection."},"examples":[{"title":"Get the next page of a query result","content":"oldResults.next()\n .then((results) => {\n let newResults = results;\n let items = newResults.items;\n let firstItem = items[0];\n let totalCount = newResults.totalCount;\n let hasNext = newResults.hasNext();\n let hasPrev = newResults.hasPrev();\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Iterate through all pages of reference query results","content":"let results = await wixData.queryReferenced(\"movies\", \"00001\", \"actors\");\n\nconsole.log(results.items);\n\nwhile(results.hasNext()) {\n console.log(\"---▼ Next Page ▼---\");\n results = await results.next();\n console.log(results.items);\n}"}],"description":"Retrieves the next page of reference query results.\r\n\r\nThe `next()` function retrieves the next page of reference query results.\r\n\r\n The page size is 50 items. Navigate through pages of items with the\r\n [`prev()`](#prev) and [`next()`](#next) functions.\r\n\r\n If items are added or removed between calls to `next()` the values returned\r\n may change."},{"name":"prev","fqn":"WixDataQueryReferencedResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataQueryReferencedResult","referenceFqn":"WixDataQueryReferencedResult.WixDataQueryReferencedResult"},"description":"Fulfilled - A query result object with the previous page of query results.\r\nRejected - The errors that caused the rejection."},"examples":[{"title":"Get the previous page of a query result","content":"oldResults.prev()\n .then((results) => {\n let newResults = results;\n let items = newResults.items;\n let firstItem = items[0];\n let totalCount = newResults.totalCount;\n let hasNext = newResults.hasNext();\n let hasPrev = newResults.hasPrev();\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"description":"Retrieves the previous page of reference query results.\r\n\r\nThe `prev()` function retrieves the previous page of reference query results.\r\n\r\n The page size is 50 items. Navigate through pages of items with the\r\n [`prev()`](#prev) and [`next()`](#next) functions.\r\n\r\n If items are added or removed between calls to `prev()` the values returned\r\n may change."}],"webhooks":[],"articles":[{"content":"# Introduction\nWhen you execute a reference query with the [`queryReferenced()`](wix-data.html#queryReferenced)\n function, it returns a Promise that resolves to a `WixDataQueryReferencedResult`\n object. This object contains the items that match the reference query and\n functions for paging through the query results.\n\n >**Note:** The `WixDataQueryReferencedResult` object's properties and functions are not supported for Single Item Collections.","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the items of a reference query result","content":"let items = results.items;\n\n/*\n * [\n * {\n * \"_id\": \"1234\",\n * \"_owner\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"_createdDate\": \"2017-05-29T08:35:52.344Z\",\n * \"_updatedDate\": \"2017-05-29T08:35:52.344Z\",\n * \"first_name\": \"Jane\",\n * \"last_name\": \"Doe\"\n * },\n * {\n * \"_id\": \"5678\",\n * \"_owner\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"_createdDate\": \"2017-05-25T12:48:56.572Z\",\n * \"_updatedDate\": \"2017-05-29T07:30:15.869Z\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\"\n * }\n * ]\n */"},{"title":"Perform a reference query and get the items of the result","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.queryReferenced(\"movies\", \"00001\", \"actors\")\n .then((results) => {\n if(results.items.length > 0) {\n console.log(results.items); // see below\n } else {\n // handle case where no matching items found\n }\n }) ;\n\n/* items:\n *\n * [\n * {\n * \"_id\": \"1234\",\n * \"_owner\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"_createdDate\": \"2017-05-29T08:35:52.344Z\",\n * \"_updatedDate\": \"2017-05-29T08:35:52.344Z\",\n * \"first_name\": \"Jane\",\n * \"last_name\": \"Doe\"\n * },\n * {\n * \"_id\": \"5678\",\n * \"_owner\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"_createdDate\": \"2017-05-25T12:48:56.572Z\",\n * \"_updatedDate\": \"2017-05-29T07:30:15.869Z\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\"\n * }\n * ]\n */"}],"type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"object"}},"description":"Returns the items that match the reference query.\r\n\r\nThe current page of items retrieved by the reference query.\r\n\r\n The page size is 50 items. Navigate through pages of items with the\r\n [`prev()`](#prev) and [`next()`](#next) functions.\r\n\r\n When no items match the reference query, the `items` array is empty."},{"name":"totalCount","slug":"total-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the total number of items in a reference query result","content":"let resultCount = results.totalCount; // 150"},{"title":"Perform a reference query and get the total number of items in the result","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.queryReferenced(\"movies\", \"00001\", \"actors\")\n .then((results) => {\n let resultCount = results.totalCount; // 150\n }) ;"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of items that match the reference query.\r\n\r\nThe `totalCount` returns the total number of items that match the reference query,\r\n not just the number of items in the current page."}]},{"name":"WixDataQueryResult","slug":"wix-data-query-result","fqn":"WixDataQueryResult","standaloneTypes":[],"metadata":{},"actions":[{"name":"hasNext","fqn":"WixDataQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"examples":[{"title":"Get whether the query result object has more results","content":"let hasNext = results.hasNext(); // true"},{"title":"Iterate through all pages of query results","description":"This example demonstrates how to get all query results, bypassing the maximum limit of 1000.","content":"async function retrieveAllItems() {\n let results = await wixData.query(\"myCollection\")\n .limit(1000)\n .find();\n let allItems = results.items;\n while (results.hasNext()) {\n results = await results.next();\n allItems = allItems.concat(results.items);\n }\n return allItems;\n}"}],"description":"Indicates if the query has more results."},{"name":"hasPrev","fqn":"WixDataQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are previous results."},"examples":[{"title":"Get whether the query result object has previous results","content":"let hasPrev = results.hasPrev(); // false"}],"description":"Indicates the query has previous results."},{"name":"next","fqn":"WixDataQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataQueryResult","referenceFqn":"WixDataQueryResult.WixDataQueryResult"},"description":"Fulfilled - A query result object with the next page of query results.\r\nRejected - The errors that caused the rejection."},"examples":[{"title":"Get the next page of a query result","content":"oldResults.next()\n .then((results) => {\n let newResults = results;\n let items = newResults.items;\n let firstItem = items[0];\n let totalCount = newResults.totalCount;\n let pageSize = newResults.pageSize;\n let currentPage = newResults.currentPage;\n let totalPages = newResults.totalPages;\n let hasNext = newResults.hasNext();\n let hasPrev = newResults.hasPrev();\n let length = newResults.length;\n let query = newResults.query;\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Iterate through all pages of query results","description":"This example demonstrates how to get all query results, bypassing the maximum limit of 1000.","content":"async function retrieveAllItems() {\n let results = await wixData.query(\"myCollection\")\n .limit(1000)\n .find();\n let allItems = results.items;\n while (results.hasNext()) {\n results = await results.next();\n allItems = allItems.concat(results.items);\n }\n return allItems;\n}"}],"description":"Retrieves the next page of query results.\r\n\r\nThe `next()` function retrieves the next page of query results.\r\n\r\n The page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n If items are added or removed between calls to `next()` the values returned\r\n by `WixDataQueryResult` may change.\r\n >**Note:** The `next()` function is not supported for Single Item Collections."},{"name":"prev","fqn":"WixDataQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WixDataQueryResult","referenceFqn":"WixDataQueryResult.WixDataQueryResult"},"description":"Fulfilled - A query result object with the previous page of query results.\r\nRejected - The errors that caused the rejection."},"examples":[{"title":"Get the previous page of a query result","content":"oldResults.prev()\n .then((results) => {\n let newResults = results;\n let items = newResults.items;\n let firstItem = items[0];\n let totalCount = newResults.totalCount;\n let pageSize = newResults.pageSize;\n let currentPage = newResults.currentPage;\n let totalPages = newResults.totalPages;\n let hasNext = newResults.hasNext();\n let hasPrev = newResults.hasPrev();\n let length = newResults.length;\n let query = newResults.query;\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"description":"Retrieves the previous page of query results.\r\n\r\nThe `prev()` function retrieves the previous page of query results.\r\n\r\n The page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n If items are added or removed between calls to `prev()` the values returned\r\n may change.\r\n >**Note:** The `prev()` function is not supported for Single Item Collections."}],"webhooks":[],"articles":[{"content":"# Introduction\nWhen you execute a query with the [`find()`](wix-data.WixDataQuery.html#find)\n function, it returns a Promise that resolves to a `WixDataQueryResult` object.\n This object contains the items that match the query, information about the\n query itself, and functions for paging through the query results.","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[{"name":"currentPage","slug":"current-page","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the current page index of a query result","content":"let resultPage = results.currentPage; // 0"},{"title":"Perform a query and get the current page index of the query result","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .find()\n .then((results) => {\n let resultPage = results.currentPage; // 0\n }) ;"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the index of the current results page number.\r\n\r\nThe `currentPage` is a zero-based index of the current page of results.\r\n\r\n The page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n The `currentPage` property returns `undefined` if the query returned no results."},{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the items of a query result","content":"let items = results.items;\n\n/*\n * [\n * {\n * \"_id\": \"1234\",\n * \"_owner\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"_createdDate\": \"2017-05-29T08:35:52.344Z\",\n * \"_updatedDate\": \"2017-05-29T08:35:52.344Z\",\n * \"title\": \"Dr.\",\n * \"first_name\": \"Jane\",\n * \"last_name\": \"Doe\",\n * \"status\": \"active\"\n * },\n * {\n * \"_id\": \"5678\",\n * \"_owner\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"_createdDate\": \"2017-05-25T12:48:56.572Z\",\n * \"_updatedDate\": \"2017-05-29T07:30:15.869Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\",\n * \"status\": \"active\"\n * }\n * ]\n */"},{"title":"Perform a query and get the items of the result","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items; // see below\n } else {\n // handle case where no matching items found\n }\n }) ;\n\n/* items:\n *\n * [\n * {\n * \"_id\": \"1234\",\n * \"_owner\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"_createdDate\": \"2017-05-29T08:35:52.344Z\",\n * \"_updatedDate\": \"2017-05-29T08:35:52.344Z\",\n * \"title\": \"Dr.\",\n * \"first_name\": \"Jane\",\n * \"last_name\": \"Doe\",\n * \"status\": \"active\"\n * },\n * {\n * \"_id\": \"5678\",\n * \"_owner\": \"f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3\",\n * \"_createdDate\": \"2017-05-25T12:48:56.572Z\",\n * \"_updatedDate\": \"2017-05-29T07:30:15.869Z\",\n * \"title\": \"Mr.\",\n * \"first_name\": \"John\",\n * \"last_name\": \"Doe\",\n * \"status\": \"active\"\n * }\n * ]\n */"}],"type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"object"}},"description":"Returns the items that match the query.\r\n\r\nThe current page of items retrieved by the query.\r\n\r\n The page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions.\r\n\r\n When no items match the query, the `items` array is empty."},{"name":"length","slug":"length","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the length of a query result","content":"let resultLength = results.length; // 20"},{"title":"Perform a query and get the length of the result","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .find()\n .then((results) => {\n let resultLength = results.length; // 20\n }) ;"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current results page.\r\n\r\nThe page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions."},{"name":"pageSize","slug":"page-size","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the page size of a query result","content":"let resultPageSize = results.pageSize; // 50"},{"title":"Perform a query and get the page size of the query result","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .find()\n .then((results) => {\n let resultPageSize = results.pageSize; // 50\n }) ;"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the query page size.\r\n\r\nThe page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions."},{"name":"partialIncludes","slug":"partial-includes","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get whether there are partial includes in a query result","content":"let partials = results.partialIncludes; // false"},{"title":"Perform a query and get whether there are partial includes in a query result","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .find()\n .then((results) => {\n let partials = results.partialIncludes; // false\n }) ;"}],"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates if referenced items have been trimmed from the results.\r\n\r\nWhen [including](wix-data.WixDataQuery.html#include) a property with multiple references, each returned item can\r\n include up to 50 referenced items. If there are more than 50 referenced items,\r\n only 50 will be returned and `partialIncludes` will be true.\r\n\r\n To retrieve more than 50 referenced items, use the\r\n [`queryReferenced()`](wix-data.html#queryReferenced) function."},{"name":"query","slug":"query","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the query that produced a query result","content":"let resultQuery = results.query;"},{"title":"Perform a query and get the query that produced the result","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .find()\n .then((results) => {\n let newQuery = results.query;\n newQuery\n .ge(\"color\", \"red\")\n .find()\n .then((newQueryResults) => {\n let firstItem = newQueryResults.items[0];\n })\n })\n .catch((error) => {\n console.error(error);\n });"}],"type":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery"},"description":"Returns the query used to get the current results.\r\n\r\nUse the `query` property to create and run a new query by chaining additional WixDataQueryBuilder functions to it."},{"name":"totalCount","slug":"total-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the number of items in a query result","content":"let resultCount = results.totalCount; // 150"},{"title":"Perform a query and get the number of items in the result","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .find()\n .then((results) => {\n let resultCount = results.totalCount; // 150\n }) ;"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of items that match the query.\r\n\r\nThe `totalCount` returns the total number of items that match the query,\r\n not just the number of items in the current page."},{"name":"totalPages","slug":"total-pages","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the total number of pages in a query result","content":"let resultPages = results.totalPages; // 3"},{"title":"Perform a query and get the total number of pages in the query result","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .find()\n .then((results) => {\n let resultPages = results.totalPages; // 3\n }) ;"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of pages the query produced.\r\n\r\nThe page size is defined by the [`limit()`](wix-data.WixDataQuery.html#limit)\r\n function, can be retrieved using the [`pageSize`](#pageSize) property, and\r\n navigating through pages is done with the [`prev()`](#prev) and\r\n [`next()`](#next) functions."}]},{"name":"WixDataSort","slug":"wix-data-sort","fqn":"WixDataSort","standaloneTypes":[],"metadata":{},"actions":[{"name":"ascending","fqn":"WixDataSort.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an ascending sort to a query","content":"let newQuery = query.ascending(\"last_name\", \"first_name\");"},{"title":"Create a query, add an ascending sort, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .ascending(\"last_name\", \"first_name\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add an ascending sort, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .ascending(\"last_name\", \"first_name\")\n .eq(\"status\", \"active\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort."}],"description":"Adds a sort to a query or sort, sorting by the specified properties in ascending order.\r\n\r\nThe `ascending()` function refines a `WixDataQuery` or `WixDataSort` to sort in ascending order of\r\n the specified properties. If you specify more than one property,\r\n `ascending()` sorts the results in ascending order by each property in the\r\n order they are listed.\r\n\r\n You can sort the following types:\r\n\r\n + Number: Sorts numerically.\r\n + Date: Sorts by date and time.\r\n + String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n + Reference: Compares by the ID of the referenced item as a String.\r\n\r\n\r\n If a property contains a number as a String, that value will be sorted\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified sort property are ranked lowest."},{"name":"descending","fqn":"WixDataSort.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"WixDataQuery","referenceFqn":"WixDataQuery.WixDataQuery","description":"A `WixDataQuery` object representing the refined query."},"examples":[{"title":"Add an descending sort to a query","content":"let newQuery = query.descending(\"last_name\", \"first_name\");"},{"title":"Create a query, add an descending sort, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .descending(\"last_name\", \"first_name\")\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"},{"title":"Create a query, add an descending sort, and run it","content":"import wixData from 'wix-data';\n\n// ...\n\nwixData.query(\"myCollection\")\n .descending(\"last_name\", \"first_name\")\n .eq(\"status\", \"active\")\n .limit(10)\n .find()\n .then((results) => {\n if(results.items.length > 0) {\n let items = results.items;\n let firstItem = items[0];\n let totalCount = results.totalCount;\n let pageSize = results.pageSize;\n let currentPage = results.currentPage;\n let totalPages = results.totalPages;\n let hasNext = results.hasNext();\n let hasPrev = results.hasPrev();\n let length = results.length;\n let query = results.query;\n } else {\n // handle case where no matching items found\n }\n })\n .catch((error) => {\n let errorMsg = error.message;\n let code = error.code;\n });"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort."}],"description":"Adds a sort to a query or sort, sorting by the specified properties in descending order.\r\n\r\nThe `descending()` function refines a `WixDataQuery` or `WixDataSort` to sort in descending order of\r\n the specified properties. If you specify more than one property,\r\n `descending()` sorts the results in descending order by each property in the\r\n order they are listed.\r\n\r\n You can sort the following types:\r\n\r\n + Number: Sorts numerically.\r\n + Date: Sorts by date and time.\r\n + String: Sorts lexicographically, so `\"abc\"` comes before `\"XYZ\"`.\r\n + Reference: Compares by the ID of the referenced item as a String.\r\n\r\n\r\n If a property contains a number as a String, that value will be sorted\r\n alphabetically and not numerically. Items that do not have a value for the\r\n specified sort property are ranked lowest."}],"webhooks":[],"articles":[{"content":"# Introduction\nProvides the ability to sort the results of a query, based on one or more fields in the results, in either ascending or descending order.\n\nWhen working with [Wix app collections](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code), check [which fields](https://support.wix.com/en/search?term=velo%20collection%20fields) can be used in a sort.","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]}],"builderTypes":[],"properties":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.0"}}