SearchQuerySchemaFieldComposite type

A composite can either be a: struct union or enum.

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.
`typeName` - `String!`	The type to reference in the schema representing this composite.
`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.
`compositeKey` - `SearchQuerySchemaKey`	The SearchQuerySchemaKey referenced by typeName, inlined so clients can resolve the composite's struct, union, or enum definition without a second lookup against the top-level schema. Null when the referenced key is not available in the schema.

Used by

SearchQuerySchemaFieldType enum: Search query key struct field type.

Example

{
  "name": "abc123",
  "description": "abc123",
  "fieldType": "TEXT",
  "typeName": "xyz789",
  "isMultiKey": false,
  "canSort": true,
  "canColumn": true,
  "compositeKey": SearchQuerySchemaKey
}