# rethinkdb-init

> Create all RethinkDB databases, tables and indexes automatically through a schema object

Latest version **0.2.2** (published 2016-06-12) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2016-06-12 |
| First published | 2015-04-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+6 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 53 |
| Author | thejsj |
| Maintainers | thejsj |
| Keywords | rethinkdb, database, bootstrap, init |

## Links

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

## Dependencies (2)

- [q](https://npm.io/package/q.md) ^1.2.1
- [lodash](https://npm.io/package/lodash.md) ^3.7.0

## Alternatives

- [@sveltejs/kit](https://npm.io/package/@sveltejs/kit.md) — 2.2M weekly downloads
- [@atlaskit/theme](https://npm.io/package/@atlaskit/theme.md) — 402.0K weekly downloads
- [@tangle-network/brand](https://npm.io/package/@tangle-network/brand.md) — 10.0K weekly downloads
- [seneca](https://npm.io/package/seneca.md) — 7.4K weekly downloads
- [@bsb/base](https://npm.io/package/@bsb/base.md) — 7.2K weekly downloads

## Recent versions

- 0.2.2 (latest) — 2016-06-12
- 0.2.1 — 2016-05-23
- 0.1.1 — 2016-02-17
- 0.1.0 — 2016-02-17
- 0.0.5 — 2015-10-03
- 0.0.4 — 2015-05-28
- 0.0.3 — 2015-04-29
- 0.0.2 — 2015-04-27
- 0.0.1 — 2015-04-27

## README

# RethinkDB Init

Create all RethinkDB databases, tables and indexes automatically through a schema object.

Often times, application code that uses RethinkDB has a significant portion of code meant for creating the database, tables and indexes [example](https://github.com/thejsj/image-pin/blob/master/server/db/index.js). This module is meant so that you can pass an object with the required initial state of your database and get a promise/callback for when all the necesary componentes have been added to the database. This removes a lot of boilerplate code from your application code and makes it easier to understand what is needed in the database to run the application.

## Examples

### Instantiating database with a table and an index

The first argument is a connection object with `host`, `port`, and `db`. If the `db` doesn’t exist, it will be created automatically.

The second argument is an array of tables. Each table can either be a string or an object. If the entry is an object, it must have a `name` property.

```javascript
var r = require('rethinkdb');
require('rethinkdb-init')(r);

r.init({
    host: 'localhost',
    port: 28015,
    db: 'superDatabase'
  }, [
    {
      name: 'person',
      indexes: ['firstName', 'lastName']
    },
    'address'
  ]
})
.then(function (conn) {
  // All tables and indexes have been created
});
```

### Instantiating a database with 4 tables with no indexes

When the array contains a string, a table will be added with that name.

```javascript
var r = require('rethinkdb');
require('rethinkdb-init')(r);

r.init({
    host: 'localhost',
    port: 28015,
    db: 'helloDatabase'
  },
  [
    'hello_table',
    'another_table',
    'yet_another_table',
    'one_last_table',
  ]
})
.then(function (conn) {
  // All tables and indexes have been created
});
```

### Instantiating a database with 2 tables and 2 indexes on one of the tables

Table objects can contain indexes (which can also be strings or objects).

```javascript
var r = require('rethinkdb');
require('rethinkdb-init')(r);

r.init({
    host: 'localhost',
    port: 28015,
    db: 'helloDatabase'
  },
  [
    {
      name: 'helloTable',
      indexes: ['superIndex', 'superDuperIndex']
    },
    'anotherTable'
  ]
})
.then(function (conn) {
  // All tables and indexes have been created
});
```

### Instantiating a database with 1 tables and 1 geo index

You can add a `geo` or `multi` attribute along with an index and it will be passed along to the [`indexCreate`](http://rethinkdb.com/api/javascript/index_create/) function.

```javascript
var r = require('rethinkdb');
require('rethinkdb-init')(r);

r.init({
    host: 'localhost',
    port: 28015,
    db: 'helloDatabase'
  },
  [
    {
      name: 'helloTable',
      indexes: [{
        name: 'location',
        geo: true,
      }]
    },
  ]
})
.then(function (conn) {
  // All tables and indexes have been created
});
```

### Instantiating a database with 1 tables and 1 multi+geo index

```javascript
var r = require('rethinkdb');
require('rethinkdb-init')(r);

r.init({
    host: 'localhost',
    port: 28015,
    db: 'helloDatabase'
  },
  [
    {
      name: 'helloTable',
      indexes: [{
        name: 'location',
        geo: true,
        multi: true,
      }]
    },
  ]
})
.then(function (conn) {
  // All tables and indexes have been created
});
```

### Instantiating a database with 1 table and 1 index with an indexFunction

You can add a `indexFunction` attribute along with an index and it will be passed along to the [`indexCreate`](http://rethinkdb.com/api/javascript/index_create/) function.

```javascript
var r = require('rethinkdb');
require('rethinkdb-init')(r);

r.init({
    host: 'localhost',
    port: 28015,
    db: 'helloDatabase'
  },
  [
    {
      name: 'helloTable',
      indexes: [{
        name: 'has_location',
        indexFunction: function (row) {
          return row.hasFields('location');
        },
      }]
    },
  ]
})
.then(function (conn) {
  // All tables and indexes have been created
});
```
### Instantiating  a database with 1 table with a different primaryKey, soft durability, 2 replicas, and 2 shards

You can pass a `primaryKey`, `durability`, `replicas`, or `shards` attribute to a table and it will be passed along to the [`tableCreate`](http://rethinkdb.com/api/javascript/table_create/) function.


```javascript
var r = require('rethinkdb');
require('rethinkdb-init')(r);

r.init({
    host: 'localhost',
    port: 28015,
    db: 'helloDatabase'
  },
  [
    {
      name: 'helloTable',
      primaryKey: 'location',
      durability: 'soft'
      replicas: 2,
      shards: 2
    },
  ]
})
.then(function (conn) {
  // All tables and indexes have been created
});
```

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