Graph search · GraphQL type

SearchQuerySchemaFieldScalar type

A scalar struct field.

Fields

Field Name Description
name - String! The name of the field.
description - String! Description for display to end users.
fieldType - SearchQuerySchemaFieldType! The type of scalar field.
isMultiKey - Boolean! Whether the field holds multiple values (e.g. an array or slice). When true, search predicates match if any element of the collection matches.
canSort - Boolean! Whether the field may be used as a sort key in a search query.
canColumn - Boolean! Whether the field may be used as a column in search results.

Example

Example

{
  "name": "xyz789",
  "description": "xyz789",
  "fieldType": "TEXT",
  "isMultiKey": false,
  "canSort": false,
  "canColumn": true
}