Includes referenced items for the specified properties in a query's results.
The include()
function refines a query so that the items returned in the
query's results include the full referenced items for the specified properties.
For example, suppose you have a books collection with an author
field that references an authors collection. Querying the books
collection with an include("author")
returns the relevant book items
and each item will include the full referenced author item in the book's
author
property.
When querying a collection that contains a reference field without using the
include()
function:
When including a property with multiple references, the following limitations apply:
limit()
function.partialIncludes
property of the returned WixDataQueryResult
is true
. To retrieve more than 50 referenced items, use the
queryReferenced()
function.For a discussion of when to use the similar queryReferenced()
function and when to use include()
, see Querying Items that Reference Other Items.
Notes:
include()
function does not trigger any hooks.include()
function is not supported for Single Item Collections.
The properties for which to include referenced items.