Quick Introduction

    • Easily model database schema as a graph structure.
    • Define schema as a programmatic Go code.
    • Static typing based on code generation.
    • Database queries and graph traversals are easy to write.
    • Simple to extend and customize using Go templates.

    If your project directory is outside GOPATH or you are not familiar with GOPATH, setup a project as follows:

    Installation

    After installing ent codegen tool, you should have it in your PATH. If you don’t find it your path, you can also run: go run entgo.io/ent/cmd/ent <command>

    Create Your First Schema

    Go to the root directory of your project, and run:

    1. go run entgo.io/ent/cmd/ent init User

    The command above will generate the schema for User under <project>/ent/schema/ directory:

    <project>/ent/schema/user.go

    2. package schema
    4. import "entgo.io/ent"
    6. // User holds the schema definition for the User entity.
    7. type User struct {
    8.     ent.Schema
    9. }
    11. // Fields of the User.
    12. func (User) Fields() []ent.Field {
    13.     return nil
    14. }
    16. // Edges of the User.
    17. func (User) Edges() []ent.Edge {
    18.     return nil
    19. }

    Add 2 fields to the User schema:

    <project>/ent/schema/user.go

    2. package schema
    4. import (
    5.     "entgo.io/ent"
    6.     "entgo.io/ent/schema/field"
    7. )
    9. // Fields of the User.
    10. func (User) Fields() []ent.Field {
    11.     return []ent.Field{
    12.         field.Int("age").
    13.             Positive(),
    14.         field.String("name").
    15.             Default("unknown"),
    16.     }
    17. }

    Run go generate from the root directory of the project as follows:

    1. go generate ./ent

    This produces the following files:

    1. ent
    2. ├── client.go
    3. ├── config.go
    4. ├── context.go
    5. ├── ent.go
    6. ├── generate.go
    7. ├── mutation.go
    8. ... truncated
    9. ├── schema
    10. │   └── user.go
    11. ├── tx.go
    12. ├── user
    13. │   ├── user.go
    14. │   └── where.go
    15. ├── user.go
    16. ├── user_create.go
    17. ├── user_delete.go
    18. ├── user_query.go
    19. └── user_update.go

    To get started, create a new ent.Client. For this example, we will use SQLite3.

    <project>/start/start.go

    2. package main
    4. import (
    5.     "context"
    6.     "log"
    8.     "<project>/ent"
    10.     _ "github.com/mattn/go-sqlite3"
    11. )
    13. func main() {
    14.     client, err := ent.Open("sqlite3", "file:ent?mode=memory&cache=shared&_fk=1")
    15.     if err != nil {
    16.         log.Fatalf("failed opening connection to sqlite: %v", err)
    17.     }
    18.     defer client.Close()
    19.     // Run the auto migration tool.
    20.     if err := client.Schema.Create(context.Background()); err != nil {
    21.         log.Fatalf("failed creating schema resources: %v", err)
    22.     }
    23. }

    Now, we’re ready to create our user. Let’s call this function CreateUser for the sake of example:

    <project>/start/start.go

    Query Your Entities

    ent generates a package for each entity schema that contains its predicates, default values, validators and additional information about storage elements (column names, primary keys, etc).

    <project>/start/start.go

    2. package main
    4. import (
    5.     "log"
    7.     "<project>/ent"
    8.     "<project>/ent/user"
    9. )
    11. func QueryUser(ctx context.Context, client *ent.Client) (*ent.User, error) {
    12.     u, err := client.User.
    13.         Query().
    14.         Where(user.Name("a8m")).
    15.         // `Only` fails if no user found,
    16.         // or more than 1 user returned.
    17.         Only(ctx)
    18.     if err != nil {
    19.         return nil, fmt.Errorf("failed querying user: %w", err)
    20.     }
    21.     log.Println("user returned: ", u)
    22.     return u, nil
    23. }

    Add Your First Edge (Relation)

    1. go run entgo.io/ent/cmd/ent init Car Group

    And then we add the rest of the fields manually:

    <project>/ent/schema/car.go

    2. // Fields of the Car.
    3. func (Car) Fields() []ent.Field {
    4.     return []ent.Field{
    5.         field.String("model"),
    6.         field.Time("registered_at"),
    7. }

    <project>/ent/schema/group.go

    2. // Fields of the Group.
    3. func (Group) Fields() []ent.Field {
    4.     return []ent.Field{
    5.         field.String("name").
    7.             Match(regexp.MustCompile("[a-zA-Z_]+$")),
    8.     }
    9. }

    Let’s define our first relation. An edge from User to Car defining that a user can have 1 or more cars, but a car has only one owner (one-to-many relation).

    er-user-cars

    Let’s add the "cars" edge to the User schema, and run go generate ./ent:

    <project>/ent/schema/user.go

    2. // Edges of the User.
    3. func (User) Edges() []ent.Edge {
    4.     return []ent.Edge{
    5.         edge.To("cars", Car.Type),
    6.     }
    7. }

    We continue our example by creating 2 cars and adding them to a user.

    <project>/start/start.go

    2. import (
    3.     "<project>/ent"
    4.     "<project>/ent/car"
    5.     "<project>/ent/user"
    6. )
    8. func CreateCars(ctx context.Context, client *ent.Client) (*ent.User, error) {
    9.     // Create a new car with model "Tesla".
    10.     tesla, err := client.Car.
    11.         Create().
    12.         SetModel("Tesla").
    13.         SetRegisteredAt(time.Now()).
    14.         Save(ctx)
    15.     if err != nil {
    16.         return nil, fmt.Errorf("failed creating car: %w", err)
    17.     }
    18.     log.Println("car was created: ", tesla)
    20.     // Create a new car with model "Ford".
    21.     ford, err := client.Car.
    22.         Create().
    23.         SetModel("Ford").
    24.         SetRegisteredAt(time.Now()).
    25.         Save(ctx)
    26.     if err != nil {
    27.         return nil, fmt.Errorf("failed creating car: %w", err)
    28.     }
    29.     log.Println("car was created: ", ford)
    31.     // Create a new user, and add it the 2 cars.
    32.     a8m, err := client.User.
    33.         Create().
    34.         SetAge(30).
    35.         SetName("a8m").
    36.         AddCars(tesla, ford).
    37.         Save(ctx)
    38.     if err != nil {
    39.         return nil, fmt.Errorf("failed creating user: %w", err)
    40.     }
    41.     log.Println("user was created: ", a8m)
    42.     return a8m, nil
    43. }

    But what about querying the cars edge (relation)? Here’s how we do it:

    <project>/start/start.go

    2. import (
    3.     "log"
    5.     "<project>/ent"
    6.     "<project>/ent/car"
    7. )
    9. func QueryCars(ctx context.Context, a8m *ent.User) error {
    10.     cars, err := a8m.QueryCars().All(ctx)
    11.     if err != nil {
    12.         return fmt.Errorf("failed querying user cars: %w", err)
    13.     }
    14.     log.Println("returned cars:", cars)
    16.     // What about filtering specific cars.
    17.     ford, err := a8m.QueryCars().
    18.         Where(car.Model("Ford")).
    19.         Only(ctx)
    20.     if err != nil {
    21.         return fmt.Errorf("failed querying user cars: %w", err)
    22.     }
    23.     log.Println(ford)
    24.     return nil
    25. }

    Assume we have a Car object and we want to get its owner; the user that this car belongs to. For this, we have another type of edge called “inverse edge” that is defined using the edge.From function.

    The new edge created in the diagram above is translucent, to emphasize that we don’t create another edge in the database. It’s just a back-reference to the real edge (relation).

    Let’s add an inverse edge named owner to the Car schema, reference it to the cars edge in the User schema, and run go generate ./ent.

    <project>/ent/schema/car.go

    <project>/start/start.go

    2. import (
    3.     "fmt"
    4.     "log"
    6.     "<project>/ent"
    7.     "<project>/ent/user"
    8. )
    10. func QueryCarUsers(ctx context.Context, a8m *ent.User) error {
    11.     cars, err := a8m.QueryCars().All(ctx)
    12.     if err != nil {
    13.         return fmt.Errorf("failed querying user cars: %w", err)
    14.     }
    15.     // Query the inverse edge.
    16.     for _, ca := range cars {
    17.         owner, err := ca.QueryOwner().Only(ctx)
    18.         if err != nil {
    19.             return fmt.Errorf("failed querying car %q owner: %w", ca.Model, err)
    20.         }
    21.         log.Printf("car %q owner: %q\n", ca.Model, owner.Name)
    22.     }
    23.     return nil
    24. }

    Create Your Second Edge

    We’ll continue our example by creating a M2M (many-to-many) relationship between users and groups.

    er-group-users

    As you can see, each group entity can have many users, and a user can be connected to many groups; a simple “many-to-many” relationship. In the above illustration, the Group schema is the owner of the users edge (relation), and the User entity has a back-reference/inverse edge to this relationship named groups. Let’s define this relationship in our schemas:

    <project>/ent/schema/group.go

    2. // Edges of the Group.
    3. func (Group) Edges() []ent.Edge {
    4.    return []ent.Edge{
    5.        edge.To("users", User.Type),
    6.    }
    7. }

    <project>/ent/schema/user.go

    2. // Edges of the User.
    3. func (User) Edges() []ent.Edge {
    4.    return []ent.Edge{
    6.        // Create an inverse-edge called "groups" of type `Group`
    7.        // and reference it to the "users" edge (in Group schema)
    8.        // explicitly using the `Ref` method.
    9.        edge.From("groups", Group.Type).
    10.            Ref("users"),
    11. }

    We run ent on the schema directory to re-generate the assets.

    1. go generate ./ent

    Run Your First Graph Traversal

    In order to run our first graph traversal, we need to generate some data (nodes and edges, or in other words, entities and relations). Let’s create the following graph using the framework:

    <project>/start/start.go

    2. func CreateGraph(ctx context.Context, client *ent.Client) error {
    3.     // First, create the users.
    4.     a8m, err := client.User.
    5.         Create().
    6.         SetAge(30).
    7.         SetName("Ariel").
    8.         Save(ctx)
    9.     if err != nil {
    10.         return err
    11.     }
    12.     neta, err := client.User.
    13.         Create().
    14.         SetAge(28).
    15.         SetName("Neta").
    16.         Save(ctx)
    17.     if err != nil {
    18.         return err
    19.     }
    20.     // Then, create the cars, and attach them to the users in the creation.
    21.     err = client.Car.
    22.         Create().
    23.         SetModel("Tesla").
    24.         SetRegisteredAt(time.Now()). // ignore the time in the graph.
    25.         SetOwner(a8m).               // attach this graph to Ariel.
    26.         Exec(ctx)
    27.     if err != nil {
    28.         return err
    29.     }
    30.     err = client.Car.
    31.         Create().
    32.         SetModel("Mazda").
    33.         SetRegisteredAt(time.Now()). // ignore the time in the graph.
    34.         SetOwner(a8m).               // attach this graph to Ariel.
    35.         Exec(ctx)
    36.     if err != nil {
    37.         return err
    38.     }
    39.     err = client.Car.
    40.         Create().
    41.         SetModel("Ford").
    42.         SetRegisteredAt(time.Now()). // ignore the time in the graph.
    43.         SetOwner(neta).              // attach this graph to Neta.
    44.         Exec(ctx)
    45.     if err != nil {
    46.         return err
    47.     }
    48.     // Create the groups, and add their users in the creation.
    49.     err = client.Group.
    50.         Create().
    51.         SetName("GitLab").
    52.         AddUsers(neta, a8m).
    53.         Exec(ctx)
    54.     if err != nil {
    55.         return err
    56.     }
    57.     err = client.Group.
    58.         Create().
    59.         SetName("GitHub").
    60.         AddUsers(a8m).
    61.         Exec(ctx)
    62.     if err != nil {
    63.         return err
    64.     }
    65.     log.Println("The graph was created successfully")
    66.     return nil
    67. }

    Now when we have a graph with data, we can run a few queries on it:

    1. Get all user’s cars within the group named “GitHub”:

      <project>/start/start.go

      2. import (
      3.     "log"
      5.     "<project>/ent"
      6.     "<project>/ent/group"
      7. )
      9. func QueryGithub(ctx context.Context, client *ent.Client) error {
      10.     cars, err := client.Group.
      11.         Query().
      12.         Where(group.Name("GitHub")). // (Group(Name=GitHub),)
      13.         QueryUsers().                // (User(Name=Ariel, Age=30),)
      14.         QueryCars().                 // (Car(Model=Tesla, RegisteredAt=<Time>), Car(Model=Mazda, RegisteredAt=<Time>),)
      15.         All(ctx)
      16.     if err != nil {
      17.         return fmt.Errorf("failed getting cars: %w", err)
      18.     }
      19.     log.Println("cars returned:", cars)
      20.     // Output: (Car(Model=Tesla, RegisteredAt=<Time>), Car(Model=Mazda, RegisteredAt=<Time>),)
      21.     return nil
      22. }

    2. Change the query above, so that the source of the traversal is the user Ariel:

      <project>/start/start.go

      2. import (
      3.     "log"
      5.     "<project>/ent"
      6.     "<project>/ent/car"
      7. )
      9. func QueryArielCars(ctx context.Context, client *ent.Client) error {
      10.     // Get "Ariel" from previous steps.
      11.     a8m := client.User.
      12.         Query().
      13.         Where(
      14.             user.HasCars(),
      15.             user.Name("Ariel"),
      16.         ).
      17.         OnlyX(ctx)
      18.     cars, err := a8m.                       // Get the groups, that a8m is connected to:
      19.             QueryGroups().                  // (Group(Name=GitHub), Group(Name=GitLab),)
      20.             QueryUsers().                   // (User(Name=Ariel, Age=30), User(Name=Neta, Age=28),)
      21.             QueryCars().                    //
      22.             Where(                          //
      23.                 car.Not(                    //  Get Neta and Ariel cars, but filter out
      24.                     car.Model("Mazda"),     //  those who named "Mazda"
      25.                 ),                          //
      26.             ).                              //
      27.             All(ctx)
      28.     if err != nil {
      29.         return fmt.Errorf("failed getting cars: %w", err)
      30.     }
      31.     log.Println("cars returned:", cars)
      32.     // Output: (Car(Model=Tesla, RegisteredAt=<Time>), Car(Model=Ford, RegisteredAt=<Time>),)

    3. Get all groups that have users (query with a look-aside predicate):

    The full example exists in GitHub.