You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update all EdgeDB documentation to reflect rebrand to Gel:
- Update guide title from "Use EdgeDB with Bun" to "Use Gel with Bun"
- Update CLI commands (edgedb → gel)
- Update npm packages (edgedb → gel, @edgedb/generate → @gel/generate)
- Update installation URLs and scripts
- Update all code examples and imports
- Add "(formerly EdgeDB)" note to description
Fixes#17721
Copy file name to clipboardExpand all lines: docs/guides/ecosystem/edgedb.mdx
+38-38Lines changed: 38 additions & 38 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,23 +1,23 @@
1
1
---
2
-
title: Use EdgeDB with Bun
3
-
sidebarTitle: EdgeDB with Bun
2
+
title: Use Gel with Bun
3
+
sidebarTitle: Gel with Bun
4
4
mode: center
5
5
---
6
6
7
-
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.
7
+
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.
8
8
9
9
---
10
10
11
-
First, [install EdgeDB](https://www.edgedb.com/install) if you haven't already.
11
+
First, [install Gel](https://www.geldata.com/install) if you haven't already.
12
12
13
13
<CodeGroup>
14
14
15
15
```sh Linux/macOS terminal icon="terminal"
16
-
curl --proto '=https' --tlsv1.2 -sSf https://sh.edgedb.com| sh
16
+
curl https://www.geldata.com/sh --proto "=https" -sSf1| sh
17
17
```
18
18
19
19
```sh Windows terminal icon="windows"
20
-
iwr https://ps1.edgedb.com -useb| iex
20
+
irm https://www.geldata.com/ps1| iex
21
21
```
22
22
23
23
</CodeGroup>
@@ -34,44 +34,44 @@ bun init -y
34
34
35
35
---
36
36
37
-
We'll use the EdgeDB CLI to initialize an EdgeDB instance for our project. This creates an `edgedb.toml` file in our project root.
37
+
We'll use the Gel CLI to initialize a Gel instance for our project. This creates a `gel.toml` file in our project root.
38
38
39
39
```sh terminal icon="terminal"
40
-
edgedb project init
40
+
gel project init
41
41
```
42
42
43
43
```txt
44
-
No `edgedb.toml` found in `/Users/colinmcd94/Documents/bun/fun/examples/my-edgedb-app` or above
44
+
No `gel.toml` found in `/Users/colinmcd94/Documents/bun/fun/examples/my-gel-app` or above
45
45
Do you want to initialize a new project? [Y/n]
46
46
> Y
47
-
Specify the name of EdgeDB instance to use with this project [default: my_edgedb_app]:
48
-
> my_edgedb_app
49
-
Checking EdgeDB versions...
50
-
Specify the version of EdgeDB to use with this project [default: x.y]:
47
+
Specify the name of Gel instance to use with this project [default: my_gel_app]:
48
+
> my_gel_app
49
+
Checking Gel versions...
50
+
Specify the version of Gel to use with this project [default: x.y]:
To see if the database is running, let's open a REPL and run a simple query.
71
71
72
72
```sh terminal icon="terminal"
73
-
edgedb
74
-
edgedb>select1 + 1;
73
+
gel
74
+
gel>select1 + 1;
75
75
```
76
76
77
77
```txt
@@ -81,12 +81,12 @@ edgedb> select 1 + 1;
81
81
Then run `\quit` to exit the REPL.
82
82
83
83
```sh terminal icon="terminal"
84
-
edgedb>\quit
84
+
gel>\quit
85
85
```
86
86
87
87
---
88
88
89
-
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.
89
+
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.
90
90
91
91
```txt File Tree icon="folder-tree"
92
92
dbschema
@@ -112,15 +112,15 @@ module default {
112
112
Then generate and apply an initial migration.
113
113
114
114
```sh terminal icon="terminal"
115
-
edgedb migration create
115
+
gel migration create
116
116
```
117
117
118
118
```txt
119
-
Created /Users/colinmcd94/Documents/bun/fun/examples/my-edgedb-app/dbschema/migrations/00001.edgeql, id: m1uwekrn4ni4qs7ul7hfar4xemm5kkxlpswolcoyqj3xdhweomwjrq
119
+
Created /Users/colinmcd94/Documents/bun/fun/examples/my-gel-app/dbschema/migrations/00001.edgeql, id: m1uwekrn4ni4qs7ul7hfar4xemm5kkxlpswolcoyqj3xdhweomwjrq
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.
132
+
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.
133
133
134
134
```sh terminal icon="terminal"
135
-
bun add edgedb
136
-
bun add -D @edgedb/generate
135
+
bun add gel
136
+
bun add -D @gel/generate
137
137
touch seed.ts
138
138
```
139
139
@@ -144,7 +144,7 @@ Paste the following code into `seed.ts`.
144
144
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.
145
145
146
146
```ts seed.ts icon="/icons/typescript.svg"
147
-
import { createClient } from "edgedb";
147
+
import { createClient } from "gel";
148
148
149
149
const client = createClient();
150
150
@@ -184,10 +184,10 @@ Seeding complete.
184
184
185
185
---
186
186
187
-
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.
187
+
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.
188
188
189
189
```sh terminal icon="terminal"
190
-
bunx @edgedb/generate edgeql-js
190
+
bunx @gel/generate edgeql-js
191
191
```
192
192
193
193
```txt
@@ -213,7 +213,7 @@ the query builder directory? The following line will be added:
213
213
In `index.ts`, we can import the generated query builder from `./dbschema/edgeql-js` and write a simple selectquery.
214
214
215
215
```ts index.ts icon="/icons/typescript.svg"
216
-
import { createClient } from "edgedb";
216
+
import { createClient } from "gel";
217
217
import e from "./dbschema/edgeql-js";
218
218
219
219
const client = createClient();
@@ -254,4 +254,4 @@ bun run index.ts
254
254
255
255
---
256
256
257
-
For complete documentation, refer to the [EdgeDB docs](https://www.edgedb.com/docs).
257
+
For complete documentation, refer to the [Gel docs](https://www.geldata.com/docs).
0 commit comments