Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edgedb/edgedb-js
The official TypeScript/JS client library and query builder for EdgeDB
https://github.com/edgedb/edgedb-js
database-driver edgedb edgeql high-performance typescript
Last synced: 3 days ago
JSON representation
The official TypeScript/JS client library and query builder for EdgeDB
- Host: GitHub
- URL: https://github.com/edgedb/edgedb-js
- Owner: edgedb
- License: apache-2.0
- Created: 2015-09-13T17:46:38.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T09:10:02.000Z (14 days ago)
- Last Synced: 2024-10-27T12:22:18.557Z (7 days ago)
- Topics: database-driver, edgedb, edgeql, high-performance, typescript
- Language: TypeScript
- Homepage: https://edgedb.com
- Size: 11.5 MB
- Stars: 511
- Watchers: 12
- Forks: 66
- Open Issues: 174
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome-list - edgedb-js
README
This is the official [EdgeDB](https://github.com/edgedb/edgedb) client library
for JavaScript and TypeScript.
If you're just getting started with EdgeDB, we recommend going through the
[EdgeDB Quickstart](https://www.edgedb.com/docs/quickstart) first. This walks
you through the process of installing EdgeDB, creating a simple schema, and
writing some simple queries.
### Requirements
- Node.js 18+
- For TypeScript users:
- TypeScript 4.4+ is required
- `yarn add @types/node --dev`
### Installation
```bash
npm install edgedb # npm users
yarn add edgedb # yarn users
```
> EdgeDB 2.x requires `v0.21.0` or later
## Basic usage
> The examples below demonstrate only the most fundamental use cases for this
> library. **[Go to the complete documentation site. >](https://www.edgedb.com/docs/clients/js/index)**
### Create a client
A _client_ is an instance of the `Client` class, which maintains a pool of
connections to your database and provides methods for executing queries.
_For TypeScript (and Node.js+ESM)_
```ts
import * as edgedb from "edgedb";
const client = edgedb.createClient();
```
_For Node.js (CommonJS)_
```js
const edgedb = require("edgedb");
const client = edgedb.createClient();
```
### Configuring the connection
The call to `edgedb.createClient()` doesn't require arguments, as the library
can determine how to connect to your database using the following mechanisms.
1. _For local development_: initialize a project with the `edgedb project init`
command. As long as the file is within a project directory, `createClient`
will be able to auto-discover the connection information of the project's
associated instance. For more information on projects, follow the
[Using projects](https://www.edgedb.com/docs/guides/projects) guide.
2. _In production_: configure the connection using **environment variables**.
(This can also be used during local development if you prefer.) The easiest
way is to set the `EDGEDB_DSN` variable; a DSN (also known as a "connection
string") is a string of the form
`edgedb://USERNAME:PASSWORD@HOSTNAME:PORT/DATABASE`.
For advanced cases, see the
[DSN specification](https://www.edgedb.com/docs/reference/dsn) and
[Reference > Connection Parameters](https://www.edgedb.com/docs/reference/connection).
### Run a query
> The remainder of the documentation assumes you are using ES module (`import`)
> syntax.
```ts
import * as edgedb from "edgedb";
const client = edgedb.createClient();
await client.query("select 2 + 2"); // => [4]
```
Note that the result is an _array_. The `.query()` method always returns an
array, regardless of the result cardinality of your query. If your query
returns _zero or one elements_, use the `.querySingle()` instead.
```ts
// empty set, zero elements
await client.querySingle("select {}"); // => null
// one element
await client.querySingle("select 2 + 2"); // => 4
// one element
await client.querySingle(
`select Movie { title }
filter .id = '2eb3bc76-a014-45dc-af66-2e6e8cc23e7e';`,
); // => { title: "Dune" }
```
## Generators
Install the `@edgedb/generate` package as a dev dependency to take advantage of EdgeDB's built-in code generators.
```bash
npm install @edgedb/generate --save-dev # npm users
yarn add @edgedb/generate --dev # yarn users
```
Then run a generator with the following command:
```bash
$ npx @edgedb/generate [FLAGS]
```
The following ``s are currently supported:
- `queries`: Generate typed functions from `*.edgeql` files
- `interfaces`: Generate interfaces for your schema types
- `edgeql-js`: Generate the query builder
### `queries`
Run the following command to generate a source file for each `*.edgeql` system in your project.
```bash
$ npx @edgedb/generate queries
```
Assume you have a file called `getUser.edgeql` in your project directory.
```
// getUser.edgeql
select User {
name,
email
}
filter .email = $email;
```
This generator will generate a `getUser.query.ts` file alongside it that exports a function called `getUser`.
```ts
import {createClient} from "edgedb";
import {myQuery} from "./myQuery.query";
const client = createClient();
const user = await myQuery(client, {name: "Timmy"});
user; // {name: string; email: string}
```
The first argument is a `Client`, the second is the set of _parameters_. Both the parameters and the returned value are fully typed.
### `edgeql-js` (query builder)
The query builder lets you write queries in a code-first way. It automatically infers the return type of your queries.
To generate the query builder, install the `edgedb` package, initialize a project (if you haven't already), then run the following command:
```bash
$ npx @edgedb/generate edgeql-js
```
This will generate an EdgeQL query builder into the `./dbschema/edgeql-js`
directory, as defined relative to your project root.
For details on generating the query builder, refer to the [complete documentation](https://www.edgedb.com/docs/clients/js/generation). Below is a simple `select` query as an example.
```ts
import { createClient } from "edgedb";
import e from "./dbschema/edgeql-js";
const client = createClient();
const query = e.select(e.Movie, (movie) => ({
id: true,
title: true,
actors: { name: true },
num_actors: e.count(movie.actors),
filter_single: e.op(movie.title, "=", "Dune"),
}));
const result = await query.run(client);
result.actors[0].name; // => Timothee Chalamet
```
For details on using the query builder, refer to the full [query builder docs](https://www.edgedb.com/docs/clients/js/querybuilder).
## Contribute
Contributing to this library requires a local installation of EdgeDB. Install
EdgeDB from [here](https://www.edgedb.com/download) or
[build it from source](https://www.edgedb.com/docs/reference/dev).
```bash
$ git clone [email protected]:edgedb/edgedb-js.git
$ cd edgedb-js
$ yarn # install dependencies
$ yarn run build # build all packages
$ yarn run test # run tests for all packages
```
> In order to be able to run all tests you need to have `edgedb-server` in your
> path. This can be done by either running tests from within a Python 3.12
> virtual environment (you will have it if you built EdgeDB locally), or by
> [installing](https://docs.edgedb.com/cli/edgedb_server/edgedb_server_install#ref-cli-edgedb-server-install)
> specific EdgeDB version and then adding its binary path to the `EDGEDB_SERVER_BIN` environment variable.
> Check [here](https://docs.edgedb.com/cli/edgedb_server/edgedb_server_info#ref-cli-edgedb-server-info)
> to find how to get the binary path.
## License
`edgedb-js` is developed and distributed under the Apache 2.0 license.
