# rethinkdb

> This package provides the JavaScript driver library for the RethinkDB database server for use in your node application.

Latest version **2.4.2** (published 2019-12-15) · 0 weekly downloads

## Install

```sh
npm install rethinkdb
pnpm add rethinkdb
yarn add rethinkdb
bun add rethinkdb
```

## Health

**Score 33/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; popular repo.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.4.2 |
| Published | 2019-12-15 |
| First published | 2012-11-09 |
| Weekly downloads | 0 |
| TypeScript types | separate (@types/rethinkdb) |
| Module format | CommonJS |
| Node | >= 0.10.0 |
| Dependencies | 1 |
| Unpacked size | 212 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 26998 |
| Maintainers | rethinkdb |
| Keywords | database, NoSQL, reql, query language |

## Links

- npm: https://www.npmjs.com/package/rethinkdb
- Repository: https://github.com/rethinkdb/rethinkdb
- Homepage: https://rethinkdb.com
- Issues: https://github.com/rethinkdb/rethinkdb/issues
- npm.io page: https://npm.io/package/rethinkdb

## Dependencies (1)

- [bluebird](https://npm.io/package/bluebird.md) >= 2.3.2 < 3

## Alternatives

- [@libsql/sqlite3](https://npm.io/package/@libsql/sqlite3.md) — 39.8K weekly downloads
- [@fortemi/core](https://npm.io/package/@fortemi/core.md) — 461 weekly downloads
- [cdb-converter](https://npm.io/package/cdb-converter.md) — 341 weekly downloads
- [@uplo/adapter-prisma](https://npm.io/package/@uplo/adapter-prisma.md) — 75 weekly downloads
- [typeorm-aios](https://npm.io/package/typeorm-aios.md) — 30 weekly downloads

## Recent versions

- 2.4.2 (latest) — 2019-12-15
- 2.4.1 — 2019-12-13
- 2.4.0 — 2019-12-10
- 2.3.3 — 2016-08-29
- 2.3.2 — 2016-06-01
- 2.3.1 — 2016-04-23
- 2.3.0 — 2016-04-06
- 2.2.3 — 2016-03-28
- 2.2.2 — 2016-02-24
- 2.2.1 — 2015-12-21
- 2.2.0 — 2015-11-12
- 2.1.1 — 2015-09-05
- 2.1.0 — 2015-08-11
- 2.0.2 — 2015-06-22
- 2.0.0-2 — 2015-06-11
- … 35 more at https://npm.io/package/rethinkdb/versions

## README

# JavaScript Driver

This package is the officially supported driver for querying a
RethinkDB database from a JavaScript application.  It is designed to
be run in Node.js but also has an alternate http connection type that
is used by the RethinkDB web ui.  The http connection type is not
intended to be used by applications, since it isn't secure.
Ultimately, the http connection type will move into the web ui code
and out of the driver.

Check out
[rethinkdb.com/api/javascript](http://www.rethinkdb.com/api/javascript)
for documentation and examples of using this driver.

## Creating the proto-def.js

To build the JavaScript driver, you'll need to first generate the
definitions file `proto-def.js`. To do that from the `drivers`
directory, you can do:

```bash
$ ./convert_protofile -l javascript \
   -i ../src/rdb_protocol/ql2.proto \
   -o ./javascript/proto-def.js
```

---
_Source: https://npm.io/package/rethinkdb · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._