This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates a query to retrieve a list of collections.
The queryCollections()
method builds a query to retrieve a list of collections and returns a CollectionsQueryBuilder
object.
The returned object contains the query definition, which is used to run the query using the find()
method.
You can refine the query by chaining CollectionsQueryBuilder
methods onto the query. CollectionsQueryBuilder
methods enable you to filter, sort, and control the results that queryCollections()
returns.
queryCollections()
runs with the following CollectionsQueryBuilder
defaults which you can override:
The following CollectionsQueryBuilder
methods are supported for queryCollections()
. For a full description of the operations object, see the object returned for the items
property in CollectionsQueryResult
.
PROPERTY | SUPPORTED FILTERS & SORTING |
---|---|
_id | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,ascending() ,descending() |
title | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,ascending() ,descending() |
description | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,ascending() ,descending() |
slug | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,ascending() ,descending() |
hidden | eq() ,ne() ,exists() ,in() ,hasSome() |
sortOrder | eq() ,ne() ,exists() ,in() ,hasSome() ,lt() ,le() ,gt() ,ge() ,ascending() ,descending() |
_createdDate | eq() ,ne() ,exists() ,in() ,hasSome() ,lt() ,le() ,gt() ,ge() ,ascending() ,descending() |
_updatedDate | eq() ,ne() ,exists() ,in() ,hasSome() ,lt() ,le() ,gt() ,ge() ,ascending() ,descending() |