Graph search · GraphQL input

GraphSearchSortInput input

Selects how a GraphSearchQueryInput's results are ordered. This is a two-mode value: set default to true to request the top-level object type's default sort, or supply an explicit column. The two modes are mutually exclusive — supply exactly one. Omitting the entire sort (null) leaves the results unsorted.

When default is true the server resolves it to the top-level object type's default sort column before the search runs, so the executed job's sort carries both default: true and the resolved column (see GraphSearchSortInputPayload). If that object type declares no default sort the results run unsorted.

Fields

Input Field Description
default - Boolean! Request the top-level object type's default sort. Mutually exclusive with column; supply exactly one of default: true or column. Defaults to false, meaning no default sort is requested. Default = false
column - GraphSearchSortInputColumn An explicit column and direction to sort on. Mutually exclusive with default: true; supply exactly one.

Used by

Example

Example

{"default": false, "column": GraphSearchSortInputColumn}