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.

Hypergraph Schema Browser​

Building your app using a schema that is already actively used in Hypergraph's knowledge graph unlocks composability between your dataset and other datasets used in Hypergraph's knowledge graph.

You can search for schemas used within the Hypergraph knowledge graph using the Hypergraph Schema Browser.

Example​

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

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

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

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.String,
}) {}

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

Available Types​

  • Type.String (string)
  • Type.Number (number)
  • Type.Date (date)
  • Type.Boolean (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.String,
  employees: Type.Number,
  founded: Type.Date,
  active: Type.Boolean,
  location: Type.Point,
}) {}

Optional Fields​

You can make a field optional by wrapping it in Type.optional.

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

export class Company extends Entity.Class<Company>('Company')({
  name: Type.String,
  description: Type.optional(Type.String),
  founded: Type.optional(Type.Date),
}) {}