Skip to main content

Schema

The Hypergraph schema allows you to define the data model for your application. It is based on the GRC-20 specification and allows you to define Types with properties and relations to other Types.

Example​

Here is an example of a schema for an Event app with the properties name and description.

import { Entity, Type } from '@graphprotocol/hypergraph';

export class Event extends Entity.Class<Event>('Event')({
  name: Type.Text,
  description: Type.Text,
}) {}

Relations​

In order to define relations between Types, you can use the Type.Relation type.

import { Entity, Type } from '@graphprotocol/hypergraph';

export class Company extends Entity.Class<Company>('Company')({
  name: Type.Text,
}) {}

export class Event extends Entity.Class<Event>('Event')({
  name: Type.Text,
  description: Type.Text,
  sponsors: Type.Relation(Company),
}) {}

Available Types​

  • Type.Text (string)
  • Type.Number (number)
  • Type.Date (date)
  • Type.Checkbox (boolean)
  • Type.Point (serialized to a string with a comma separated list of numbers)
  • Type.Relation (relation to another Type)

Example:

import { Entity, Type } from '@graphprotocol/hypergraph';

export class Company extends Entity.Class<Company>('Company')({
  name: Type.Text,
  employees: Type.Number,
  founded: Type.Date,
  active: Type.Checkbox,
  location: Type.Point,
}) {}

Schema Examples​

You can search for dozens of schema/mapping examples on the Hypergraph Schema Browser.