Light
Dark
System
1.0latest

Object Types

Object types are the primary components of EdgeDB schema. They are analogous to SQL tables or ORM models, and consist of properties and links.

Properties are used to attach primitive data to an object type. They are declared with the property keyword. For the full documentation on properties, see Properties.

Copy
type Person {
  property email -> str;
}

Links are used to define relationships between object types. They are declared with the link keyword. For the full documentation on links, see Links.

Copy
type Person {
  link best_friend -> Person;
}

There’s no need to manually declare a primary key on your object types. All object types automatically contain a property id of type UUID that’s required, globally unique, and readonly. This id is assigned upon creation and never changes.

Object types can either be abstract or non-abstract. By default all object types are non-abstract. You can’t create or store instances of abstract types, but they’re a useful way to share functionality and structure across among other object types.

Copy
abstract type HasName {
  property first_name -> str;
  property last_name -> str;
}

Abstract types are commonly used in tandem with inheritance.

Object types can extend other object types. The extending type (AKA the subtype) inherits all links, properties, indexes, constraints, etc. from its supertypes.

Copy
abstract type Animal {
  property species -> str;
}

type Dog extending Animal {
  property breed -> str;
}

Object types can extend more than one type — that’s called multiple inheritance. This mechanism allows building complex object types out of combinations of more basic types.

Copy
abstract type HasName {
  property first_name -> str;
  property last_name -> str;
}

abstract type HasEmail {
  property email -> str;
}

type Person extending HasName, HasEmail {
  property profession -> str;
}

If multiple supertypes share links or properties, those properties must be of the same type and cardinality.

Refer to the dedicated pages on Indexes, Constraints, and Annotations for full documentation on those concepts.

Light
Dark
System