mirror of
https://github.com/oven-sh/bun
synced 2026-02-02 15:08:46 +00:00
docs: update EdgeDB references to Gel rebrand (#24487)
## Summary EdgeDB has rebranded to Gel. This PR comprehensively updates all documentation to reflect the rebrand. ## Changes Made ### Documentation & Branding - **Guide title**: "Use EdgeDB with Bun" → "Use Gel with Bun" - **File renamed**: `docs/guides/ecosystem/edgedb.mdx` → `gel.mdx` - **Description**: Added "(formerly EdgeDB)" note - **All path references**: Updated from `/guides/ecosystem/edgedb` to `/guides/ecosystem/gel` ### CLI Commands - `edgedb project init` → `gel project init` - `edgedb` → `gel` (REPL) - `edgedb migration create` → `gel migration create` - `edgedb migrate` → `gel migrate` ### npm Packages - `edgedb` → `gel` - `@edgedb/generate` → `@gel/generate` ### Installation & Documentation URLs - Installation link: `docs.geldata.com/learn/installation` (functional) - Documentation reference: `docs.geldata.com/` (operational) - Installation scripts: Verified working (`https://www.geldata.com/sh` and `ps1`) - Added Homebrew option: `brew install geldata/tap/gel-cli` ### Code Examples - Updated all imports: `import { createClient } from "gel"` - Updated codegen commands: `bunx @gel/generate` ## Verified All commands verified against official Gel documentation at https://docs.geldata.com/ Fixes #17721 --------- Co-authored-by: Lydia Hallie <lydiajuliettehallie@gmail.com>
This commit is contained in:
Caio Borghi
@@ -230,7 +230,7 @@ bun upgrade --canary
|
||||
|
||||
- Ecosystem
|
||||
- [Use React and JSX](https://bun.com/guides/ecosystem/react)
|
||||
- [Use EdgeDB with Bun](https://bun.com/guides/ecosystem/edgedb)
|
||||
- [Use Gel with Bun](https://bun.com/guides/ecosystem/gel)
|
||||
- [Use Prisma with Bun](https://bun.com/guides/ecosystem/prisma)
|
||||
- [Add Sentry to a Bun app](https://bun.com/guides/ecosystem/sentry)
|
||||
- [Create a Discord bot](https://bun.com/guides/ecosystem/discordjs)
|
||||
|
||||
@@ -354,7 +354,7 @@
|
||||
"/guides/ecosystem/discordjs",
|
||||
"/guides/ecosystem/docker",
|
||||
"/guides/ecosystem/drizzle",
|
||||
"/guides/ecosystem/edgedb",
|
||||
"/guides/ecosystem/gel",
|
||||
"/guides/ecosystem/elysia",
|
||||
"/guides/ecosystem/express",
|
||||
"/guides/ecosystem/hono",
|
||||
|
||||
@@ -1,23 +1,27 @@
|
||||
---
|
||||
title: Use EdgeDB with Bun
|
||||
sidebarTitle: EdgeDB with Bun
|
||||
title: Use Gel with Bun
|
||||
sidebarTitle: Gel with Bun
|
||||
mode: center
|
||||
---
|
||||
|
||||
EdgeDB is a graph-relational database powered by Postgres under the hood. It provides a declarative schema language, migrations system, and object-oriented query language, in addition to supporting raw SQL queries. It solves the object-relational mapping problem at the database layer, eliminating the need for an ORM library in your application code.
|
||||
Gel (formerly EdgeDB) is a graph-relational database powered by Postgres under the hood. It provides a declarative schema language, migrations system, and object-oriented query language, in addition to supporting raw SQL queries. It solves the object-relational mapping problem at the database layer, eliminating the need for an ORM library in your application code.
|
||||
|
||||
---
|
||||
|
||||
First, [install EdgeDB](https://www.edgedb.com/install) if you haven't already.
|
||||
First, [install Gel](https://docs.geldata.com/learn/installation) if you haven't already.
|
||||
|
||||
<CodeGroup>
|
||||
|
||||
```sh Linux/macOS terminal icon="terminal"
|
||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.edgedb.com | sh
|
||||
curl https://www.geldata.com/sh --proto "=https" -sSf1 | sh
|
||||
```
|
||||
|
||||
```sh Windows terminal icon="windows"
|
||||
iwr https://ps1.edgedb.com -useb | iex
|
||||
irm https://www.geldata.com/ps1 | iex
|
||||
```
|
||||
|
||||
```sh Homebrew terminal icon="terminal"
|
||||
brew install geldata/tap/gel-cli
|
||||
```
|
||||
|
||||
</CodeGroup>
|
||||
@@ -34,35 +38,35 @@ bun init -y
|
||||
|
||||
---
|
||||
|
||||
We'll use the EdgeDB CLI to initialize an EdgeDB instance for our project. This creates an `edgedb.toml` file in our project root.
|
||||
We'll use the Gel CLI to initialize a Gel instance for our project. This creates a `gel.toml` file in our project root.
|
||||
|
||||
```sh terminal icon="terminal"
|
||||
edgedb project init
|
||||
gel project init
|
||||
```
|
||||
|
||||
```txt
|
||||
No `edgedb.toml` found in `/Users/colinmcd94/Documents/bun/fun/examples/my-edgedb-app` or above
|
||||
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 EdgeDB instance to use with this project [default: my_edgedb_app]:
|
||||
> my_edgedb_app
|
||||
Checking EdgeDB versions...
|
||||
Specify the version of EdgeDB to use with this project [default: x.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-edgedb-app │
|
||||
│ Project config │ /Users/colinmcd94/Documents/bun/fun/examples/my-edgedb-app/edgedb.toml │
|
||||
│ Schema dir (empty) │ /Users/colinmcd94/Documents/bun/fun/examples/my-edgedb-app/dbschema │
|
||||
│ Installation method │ portable package │
|
||||
│ Version │ x.y+6d5921b │
|
||||
│ Instance name │ my_edgedb_app │
|
||||
└─────────────────────┴────────────────────────────────────────────────────────────────────────┘
|
||||
┌─────────────────────┬──────────────────────────────────────────────────────────────────┐
|
||||
│ 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 EdgeDB instance...
|
||||
Initializing Gel instance...
|
||||
Applying migrations...
|
||||
Everything is up to date. Revision initial
|
||||
Project initialized.
|
||||
To connect to my_edgedb_app, run `edgedb`
|
||||
To connect to my_gel_app, run `gel`
|
||||
```
|
||||
|
||||
---
|
||||
@@ -70,8 +74,8 @@ To connect to my_edgedb_app, run `edgedb`
|
||||
To see if the database is running, let's open a REPL and run a simple query.
|
||||
|
||||
```sh terminal icon="terminal"
|
||||
edgedb
|
||||
edgedb> select 1 + 1;
|
||||
gel
|
||||
gel> select 1 + 1;
|
||||
```
|
||||
|
||||
```txt
|
||||
@@ -81,12 +85,12 @@ edgedb> select 1 + 1;
|
||||
Then run `\quit` to exit the REPL.
|
||||
|
||||
```sh terminal icon="terminal"
|
||||
edgedb> \quit
|
||||
gel> \quit
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
With the project initialized, we can define a schema. The `edgedb project init` command already created a `dbschema/default.esdl` file to contain our schema.
|
||||
With the project initialized, we can define a schema. The `gel project init` command already created a `dbschema/default.esdl` file to contain our schema.
|
||||
|
||||
```txt File Tree icon="folder-tree"
|
||||
dbschema
|
||||
@@ -112,15 +116,15 @@ module default {
|
||||
Then generate and apply an initial migration.
|
||||
|
||||
```sh terminal icon="terminal"
|
||||
edgedb migration create
|
||||
gel migration create
|
||||
```
|
||||
|
||||
```txt
|
||||
Created /Users/colinmcd94/Documents/bun/fun/examples/my-edgedb-app/dbschema/migrations/00001.edgeql, id: m1uwekrn4ni4qs7ul7hfar4xemm5kkxlpswolcoyqj3xdhweomwjrq
|
||||
Created /Users/colinmcd94/Documents/bun/fun/examples/my-gel-app/dbschema/migrations/00001.edgeql, id: m1uwekrn4ni4qs7ul7hfar4xemm5kkxlpswolcoyqj3xdhweomwjrq
|
||||
```
|
||||
|
||||
```sh terminal icon="terminal"
|
||||
edgedb migrate
|
||||
gel migrate
|
||||
```
|
||||
|
||||
```txt
|
||||
@@ -129,11 +133,11 @@ Applied m1uwekrn4ni4qs7ul7hfar4xemm5kkxlpswolcoyqj3xdhweomwjrq (00001.edgeql)
|
||||
|
||||
---
|
||||
|
||||
With our schema applied, let's execute some queries using EdgeDB's JavaScript client library. We'll install the client library and EdgeDB's codegen CLI, and create a `seed.ts`.file.
|
||||
With our schema applied, let's execute some queries using Gel's JavaScript client library. We'll install the client library and Gel's codegen CLI, and create a `seed.ts`.file.
|
||||
|
||||
```sh terminal icon="terminal"
|
||||
bun add edgedb
|
||||
bun add -D @edgedb/generate
|
||||
bun add gel
|
||||
bun add -D @gel/generate
|
||||
touch seed.ts
|
||||
```
|
||||
|
||||
@@ -144,7 +148,7 @@ Paste the following code into `seed.ts`.
|
||||
The client auto-connects to the database. We insert a couple movies using the `.execute()` method. We will use EdgeQL's `for` expression to turn this bulk insert into a single optimized query.
|
||||
|
||||
```ts seed.ts icon="/icons/typescript.svg"
|
||||
import { createClient } from "edgedb";
|
||||
import { createClient } from "gel";
|
||||
|
||||
const client = createClient();
|
||||
|
||||
@@ -184,10 +188,10 @@ Seeding complete.
|
||||
|
||||
---
|
||||
|
||||
EdgeDB implements a number of code generation tools for TypeScript. To query our newly seeded database in a typesafe way, we'll use `@edgedb/generate` to code-generate the EdgeQL query builder.
|
||||
Gel implements a number of code generation tools for TypeScript. To query our newly seeded database in a typesafe way, we'll use `@gel/generate` to code-generate the EdgeQL query builder.
|
||||
|
||||
```sh terminal icon="terminal"
|
||||
bunx @edgedb/generate edgeql-js
|
||||
bunx @gel/generate edgeql-js
|
||||
```
|
||||
|
||||
```txt
|
||||
@@ -213,7 +217,7 @@ the query builder directory? The following line will be added:
|
||||
In `index.ts`, we can import the generated query builder from `./dbschema/edgeql-js` and write a simple select query.
|
||||
|
||||
```ts index.ts icon="/icons/typescript.svg"
|
||||
import { createClient } from "edgedb";
|
||||
import { createClient } from "gel";
|
||||
import e from "./dbschema/edgeql-js";
|
||||
|
||||
const client = createClient();
|
||||
@@ -254,4 +258,4 @@ bun run index.ts
|
||||
|
||||
---
|
||||
|
||||
For complete documentation, refer to the [EdgeDB docs](https://www.edgedb.com/docs).
|
||||
For complete documentation, refer to the [Gel docs](https://docs.geldata.com/).
|
||||
@@ -123,7 +123,7 @@ export const GuidesList = () => {
|
||||
title: "Ecosystem",
|
||||
icon: "puzzle",
|
||||
items: [
|
||||
{ title: "Use EdgeDB with Bun", href: "/guides/ecosystem/edgedb" },
|
||||
{ title: "Use Gel with Bun", href: "/guides/ecosystem/gel" },
|
||||
{ title: "Use Prisma ORM with Bun", href: "/guides/ecosystem/prisma" },
|
||||
{ title: "Use Prisma Postgres with Bun", href: "/guides/ecosystem/prisma-postgres" },
|
||||
{ title: "Create a Discord bot", href: "/guides/ecosystem/discordjs" },
|
||||
|
||||
Reference in New Issue
Block a user