Gel (früher EdgeDB) ist eine graph-relationale Datenbank, die unter der Haube von Postgres angetrieben wird. Sie bietet eine deklarative Schema-Sprache, ein Migrationssystem und eine objektorientierte Abfragesprache, zusätzlich zur Unterstützung von rohen SQL-Abfragen. Es löst das Object-Relational-Mapping-Problem auf Datenbankebene und eliminiert die Notwendigkeit einer ORM-Bibliothek in Ihrem Anwendungscode.

---

Installieren Sie zuerst Gel, falls Sie es noch nicht getan haben.

curl https://www.geldata.com/sh --proto "=https" -sSf1 | sh

irm https://www.geldata.com/ps1 | iex

brew install geldata/tap/gel-cli

---

Verwenden Sie bun init, um ein frisches Projekt zu erstellen.

mkdir my-gel-app
cd my-gel-app
bun init -y

---

Wir verwenden die Gel-CLI, um eine Gel-Instanz für unser Projekt zu initialisieren. Dies erstellt eine gel.toml-Datei in unserem Projektstammverzeichnis.

gel project init

No `gel.toml` found in `/Users/colinmcd94/Documents/bun/fun/examples/my-gel-app` or above
Do you want to initialize a new project? [Y/n]
> Y
Specify the name of Gel instance to use with this project [default: my_gel_app]:
> my_gel_app
Checking Gel versions...
Specify the version of Gel to use with this project [default: x.y]:
> x.y
┌─────────────────────┬──────────────────────────────────────────────────────────────────┐
│ Project directory   │ /Users/colinmcd94/Documents/bun/fun/examples/my-gel-app         │
│ Project config      │ /Users/colinmcd94/Documents/bun/fun/examples/my-gel-app/gel.toml│
│ Schema dir (empty)  │ /Users/colinmcd94/Documents/bun/fun/examples/my-gel-app/dbschema│
│ Installation method │ portable package                                                 │
│ Version             │ x.y+6d5921b                                                      │
│ Instance name       │ my_gel_app                                                       │
└─────────────────────┴──────────────────────────────────────────────────────────────────┘
Version x.y+6d5921b is already downloaded
Initializing Gel instance...
Applying migrations...
Everything is up to date. Revision initial
Project initialized.
To connect to my_gel_app, run `gel`

---

Um zu sehen, ob die Datenbank läuft, öffnen wir ein REPL und führen eine einfache Abfrage aus.

gel
gel> select 1 + 1;

2

Führen Sie dann \quit aus, um das REPL zu verlassen.

gel> \quit

---

Nachdem unser Projekt initialisiert ist, können wir ein Schema definieren. Der Befehl gel project init hat bereits eine dbschema/default.esdl-Datei erstellt, die unser Schema enthält.

dbschema
├── default.esdl
└── migrations

---

Öffnen Sie diese Datei und fügen Sie den folgenden Inhalt ein.

module default {
  type Movie {
    required title: str;
    releaseYear: int64;
  }
};

---

Generieren und wenden Sie dann eine initiale Migration an.

gel migration create

Created /Users/colinmcd94/Documents/bun/fun/examples/my-gel-app/dbschema/migrations/00001.edgeql, id: m1uwekrn4ni4qs7ul7hfar4xemm5kkxlpswolcoyqj3xdhweomwjrq

gel migrate

Applied m1uwekrn4ni4qs7ul7hfar4xemm5kkxlpswolcoyqj3xdhweomwjrq (00001.edgeql)

---

Nachdem unser Schema angewendet wurde, führen wir einige Abfragen mit der Gel-JavaScript-Clientbibliothek aus. Wir installieren die Clientbibliothek und Gels Codegen-CLI und erstellen eine seed.ts-Datei.

bun add gel
bun add -D @gel/generate
touch seed.ts

---

Fügen Sie den folgenden Code in seed.ts ein.

Der Client verbindet sich automatisch mit der Datenbank. Wir fügen ein paar Filme mit der .execute()-Methode ein. Wir verwenden EdgeQLs for-Ausdruck, um diese Masseninsertion in eine einzelne optimierte Abfrage zu verwandeln.

import { createClient } from "gel";

const client = createClient();

const INSERT_MOVIE = `
  with movies := <array<tuple<title: str, year: int64>>>$movies
  for movie in array_unpack(movies) union (
    insert Movie {
      title := movie.title,
      releaseYear := movie.year,
    }
  )
`;

const movies = [
  { title: "The Matrix", year: 1999 },
  { title: "The Matrix Reloaded", year: 2003 },
  { title: "The Matrix Revolutions", year: 2003 },
];

await client.execute(INSERT_MOVIE, { movies });

console.log(`Seeding abgeschlossen.`);
process.exit();

---

Führen Sie diese Datei dann mit Bun aus.

bun run seed.ts

Seeding abgeschlossen.

---

Gel implementiert eine Reihe von Code-Generierungswerkzeugen für TypeScript. Um unsere neu gesäte Datenbank typsicher abzufragen, verwenden wir @gel/generate, um den EdgeQL-Query-Builder zu generieren.

bunx @gel/generate edgeql-js

Generating query builder...
Detected tsconfig.json, generating TypeScript files.
   To override this, use the --target flag.
   Run `npx @edgedb/generate --help` for full options.
Introspecting database schema...
Writing files to ./dbschema/edgeql-js
Generation complete! 🤘
Checking the generated query builder into version control
is not recommended. Would you like to update .gitignore to ignore
the query builder directory? The following line will be added:

   dbschema/edgeql-js

[y/n] (leave blank for "y")
> y

---

In index.ts können wir den generierten Query-Builder aus ./dbschema/edgeql-js importieren und eine einfache Select-Abfrage schreiben.

import { createClient } from "gel";
import e from "./dbschema/edgeql-js";

const client = createClient();

const query = e.select(e.Movie, () => ({
  title: true,
  releaseYear: true,
}));

const results = await query.run(client);
console.log(results);

results; // { title: string, releaseYear: number | null }[]

---

Wenn wir die Datei mit Bun ausführen, können wir die Liste der Filme sehen, die wir eingefügt haben.

bun run index.ts

[
  {
    title: "The Matrix",
    releaseYear: 1999
  }, {
    title: "The Matrix Reloaded",
    releaseYear: 2003
  }, {
    title: "The Matrix Revolutions",
    releaseYear: 2003
  }
]

---

Vollständige Dokumentation finden Sie in den Gel-Dokumentationen.