Skip to content

Latest commit

 

History

History
143 lines (80 loc) · 3.98 KB

query.md

File metadata and controls

143 lines (80 loc) · 3.98 KB

Query Schema

https://ns.adobe.com/helix/shared/query

A named query that can be run against an index

Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Can be instantiated No Unknown status No Forbidden Allowed none query.schema.json

Query Type

object (Query)

Query Properties

Property Type Required Nullable Defined by
query Multiple Optional cannot be null Query
hitsPerPage integer Optional cannot be null Query
cache integer Optional cannot be null Query
parameters array Optional cannot be null Query
filters string Optional cannot be null Query

query

The base query to run. If the value is an object or array, use QBL JSON or YAML notation

query

  • is optional

  • Type: any of the following: string or object or array (Details)

  • cannot be null

  • defined in: Query

query Type

any of the following: string or object or array (Details)

query Default Value

The default value is:

"*"

hitsPerPage

How many hits each page of search results should contain

hitsPerPage

  • is optional

  • Type: integer

  • cannot be null

  • defined in: Query

hitsPerPage Type

integer

hitsPerPage Constraints

minimum: the value of this number must greater than or equal to: 1

hitsPerPage Default Value

The default value is:

25

cache

How long (in seconds) search results should be cached on the CDN

cache

  • is optional

  • Type: integer

  • cannot be null

  • defined in: Query

cache Type

integer

parameters

Which URL parameters to accept in the query when served on the web

parameters

  • is optional

  • Type: string[]

  • cannot be null

  • defined in: Query

parameters Type

string[]

parameters Default Value

The default value is:

[]

filters

An ES6 template expression that determines which filters to apply

filters

  • is optional

  • Type: string

  • cannot be null

  • defined in: Query

filters Type

string