Skip to content

Query

  • Totals

    Choose whether searches return a result count.

  • Navigation

    Choose the shared paging defaults.

Choose result counts and paging defaults for client searches.

Find exact keys, defaults, accepted values and overrides below.

Next: Configuration guide

Query Defaults

Default count mode inherited by channels that do not set their own default. exact returns precise totals, estimated may be faster for broad navigation, none omits totals.

Priority: SCRIBE_QUERY_DEFAULT_COUNT > config

PropertyValue
Default"exact"
OverrideSCRIBE_QUERY_DEFAULT_COUNT (optional)
query.default-count = "exact"
query.default-count = ${?SCRIBE_QUERY_DEFAULT_COUNT}

Default attribute selection inherited by channels that support attribute projection. ”*” returns data attributes. Clients can request operational attributes explicitly with ”+”.

Priority: SCRIBE_QUERY_DEFAULT_FIELDS > config

PropertyValue
Default"*"
OverrideSCRIBE_QUERY_DEFAULT_FIELDS (optional)
query.default-fields = "*"
query.default-fields = ${?SCRIBE_QUERY_DEFAULT_FIELDS}

Default REST response shape inherited by channels that support response-shape selection. Clients can still pass include to choose nodes, pageInfo, count, patch, or other supported parts.

Priority: SCRIBE_QUERY_DEFAULT_INCLUDE > config

PropertyValue
Default"nodes,pageInfo,count"
OverrideSCRIBE_QUERY_DEFAULT_INCLUDE (optional)
query.default-include = "nodes,pageInfo,count"
query.default-include = ${?SCRIBE_QUERY_DEFAULT_INCLUDE}

Default page size inherited by channels that do not set their own default. Client-provided limits still override this value, and channel max-limit settings still cap it.

Priority: SCRIBE_QUERY_DEFAULT_LIMIT > config

PropertyValue
Default25
OverrideSCRIBE_QUERY_DEFAULT_LIMIT (optional)
query.default-limit = 25
query.default-limit = ${?SCRIBE_QUERY_DEFAULT_LIMIT}

Default sort order inherited by channels that support sorted searches. null keeps database-native order unless a channel or client provides a sort.

Priority: SCRIBE_QUERY_DEFAULT_SORT > config

PropertyValue
Defaultnull
OverrideSCRIBE_QUERY_DEFAULT_SORT (optional)
query.default-sort = null
query.default-sort = ${?SCRIBE_QUERY_DEFAULT_SORT}