#Field types

#Overview

Your schema is built up of GraphQL types. If you're familiar working with GraphQL, you should feel right at home. Hygraph supports all of the common GraphQL types you are used to, as well as some of its own.

You may also be interested in how input types work for filtering, ordering, paginating, and mutating data.

Here you will discover the core field types available when building your Hygraph schema. Since your schema is automatically generated, it is recommended you browse the API Playground to get inspect all available field type definitions.

#String

Hygraph supports a few variations of the String field type. Strings are just strings, but depending on the variation you add to your model, it will reflect how it appears to content editors.

All 3 variations of the String type are queried in the same way, and return the strings of the field they represent:

#Rich text

The RichText field type is an advanced String field that returns your content in 4 different formats by default: raw, HTML, markdown, and text. json is also available when embeds are enabled. The Rich Text field renders an advanced textarea with tools to add headings, links, tables, images, lists, etc.

If you have set up multiple values for Rich Text fields, you cannot mark the field as required.

When a Rich Text field is added to your model, it automatically generates the following types:

type RichText {
  raw: RichTextAST!
  html: String!
  markdown String!
  text: String!
  json: RichTextAST!
}

Read our dedicated document on Rich Text for further information.

#Integer

Integers are whole numbers, and are often used to reference price in cents, stock quantities etc.

For example, here we have products with a Int field for price:

#Float

Floats are floating point numbers, and often represent fractional values. They are often used to describe values with precision, such as distance, weight, volume, etc.

For example, here we have products with a Float field for rating:

#Boolean

Booleans default to null in Hygraph, and can be true or false. You may opt to use a Boolean for specifying if a product is on sale, is part of a bundle, or a post accepts comments.

For example, here we have posts with a Boolean field for acceptsComments:

#Date

The Date field type adheres to ISO 8601 standard. This means, October 7, 1989 is represented as 1989-10-07.

For example, here we have events with a Date for start:

#Date and time

Similar to the date field type, the DateTime field type adheres to ISO 8601 standard.

For example, here we have events with a DateTime for start:

#JSON

Hygraph has native field support for JSON (JavaScript Object Notation). This field is often used for storing large amounts of data from other systems.

For example, here we have products with a JSON field for metadata:

#Asset

Assets are connected to models through a reference field. Assets can be any file type, not just images.

The Asset model comes its own default asset fields.

For example, here we have posts with a the Asset field for coverImage, querying those asset fields:

Learn more about Assets.

#Color

The Color field is made up of HEX, RGBA and css color values.

type Color {
  hex: Hex!
  rgba: RGBA!
  css: String!
}

For example, here is posts with a Color field for backgroundColor, in all formats:

#Location

The Location field type returns latitude, longitude, and distance Float values.

type Location {
  latitude: Float!
  longitude: Float!
  distance(from: LocationInput!): Float!
}

To query the distance field, you must provide latitude and longitude values for the from argument.

For example, here we have all shop locations, with distance from the provided latitude/longitude:

#Enumerations

Enumerations, or enum for short, are predefined list of values. They are defined inside your GraphQL schema, and can be referenced by any of your content models.

If you have set up multiple values for enumerations, you cannot mark the field as required.

For example, here is an enum for products with its commodity type:

#Taxonomies

Taxonomies are a group of terms arranged in a hierarchical structure. They are defined inside your GraphQL schema, and can be referenced by any of your content models.

If you have set up multiple values for taxonomies, you cannot mark the field as required.

For example, here is a taxonomy for the products model which has a category taxonomy field. The category taxonomy field uses the Clothes taxonomy. In the GraphQL schema, category.value is the taxonomy node attached to the entry, and category.path is an array of the full path up to the assigned node.

#Reference

References, often referred as relations, are a powerful field type that allows you to connect one or more models together, and even reference multiple models as a single field type with GraphQL Union Types.

For example, here we have an example of querying all products, with categories they belong to.

#One-way references

One-way references - also called unidirectional relations - only exist in one direction. This type of reference is most useful when there is no need to know where a model is being referenced from, such as a model that is used many times. One-way references only show up on the model for which the reference is configured, and can only be queried from that side as well. This also means that for one-way references, no reverse field is configured on the referenced model. With one-way references, the content editor UI is kept clean by not showing irrelevant relations where they are not needed.

One-way references come in two forms:

#To one

For example, a category that can have only one product.

#To many

For example, a category that can have multiple products.

#Two-way references

Two-way references - alternatively known as bidirectional relations - exist in two directions. This type of reference is useful for use cases where both sides of the reference are relevant, and need to be edited or queryable. Two-way references are configured and show up on both the referencing and referenced models, and can be queried from either side.

Two-way references come in four forms:

#One to one

For example, a category can only have one product, and one product can only have one category.

#One to many

For example, a category can have multiple products, but a product cannot belong to multiple categories.

#Many to one

For example, a category has one product, but a product can belong to multiple categories.

#Many to many

For example, a category can have many products, and products can belong to many categories.

#Union

GraphQL Union Types are great for referencing different models as a single field.

For example, here we have a typical GraphQL query for fetching blocks on a page.

This field is configured to be either of type Hero, Grid, and/or Gallery:

{
  pages {
    blocks {
      __typename
      ... on Hero {
        title
        ctaLink
      }
      ... on Grid {
        title
        subtitle {
          markdown
        }
      }
      ... on Gallery {
        photos {
          url
          handle
        }
      }
    }
  }
}

Please note that unions are always two-way references.

#Remote fields

Remote fields connect specific remote data to an entry of that model. Remote fields are always related to a single remote source, and a single custom type. RESTful remote fields are configured with a path to a specific endpoint in the remote source, such as user details from Github, or price & availability from Shopify. GraphQL remote fields allow to select the entrypoint to the schema (query).

#GraphQL remote field

The GraphQL remote field requires a GraphQL Remote Source to be configured on your project. You can find out how to create a Remote Source here.

The Field allows you to make a request (HTTP GET or POST) to a remote GraphQL API and to specify the query entrypoint.

Learn more about adding a remote field to your model

#Existing field variable in non-string arguments

Existing field variable in non-string arguments

In order to support existing field variables in non-string arguments, the {{!cast=<type>}} syntax can be used to indicate that the resulting data should be forwarded as is.

Let's say our remote GraphQL API accepts an int argument, which we want to get filled in from an int field called n that already exists on the model we are creating the remote field on.

When specifying the template, we can add the handlebars comment {{!cast=<type}} to specify what type the value resulting from our template is, so the API will forward the raw data value to the remote API.

In this example we use {{!cast=int}} to forward the raw int value.

query example {
  assets(first: "{{doc.n}}{{!cast=int}}") {
    ...EntryPoint
  }
}

The resulting query shows what will be sent when we execute the remote field, which is raw 1.

query example {
  assets(last: 1) {
    ...EntryPoint
  }
}

The resulting query matches what the remote API expects.

If we did not use the casting handlebars comment, the remote fields query template would look like this:

query example {
  assets(first: "{{doc.n}}") {
    ...EntryPoint
  }
}

When the remote field gets executed, the template gets filled in with the current document's n value. The resulting query would look like this:

query example {
  assets(last: "1") {
    ...EntryPoint
  }
}

We mentioned before that our remote API accepts an int for the last argument, but our API now sends it as a string. Therefore, we would wrongly pass "1" instead of the desired 1.

#REST remote field

In order to use a REST remote field, a REST Remote Source has to be present on the project. You can find out how to create a Remote Source here.

The REST remote field allows to specify the API path to which a request (GET or POST) should be sent to.

Learn more about adding a remote field to your model

#Field visibility

Hygraph field types allow for different visibility options via the Advanced tab during field creation. Below is a reference for the different options and how they are different.

Note that these options are available for all field types except for References.