https://github.com/msmesnik/adbm-rethinkdb
RethinkDB adapter for adbm database migration tool
https://github.com/msmesnik/adbm-rethinkdb
Last synced: 12 months ago
JSON representation
RethinkDB adapter for adbm database migration tool
- Host: GitHub
- URL: https://github.com/msmesnik/adbm-rethinkdb
- Owner: msmesnik
- License: mit
- Created: 2017-04-25T12:35:25.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-05-18T13:17:28.000Z (about 9 years ago)
- Last Synced: 2025-07-08T14:03:24.351Z (about 1 year ago)
- Language: JavaScript
- Size: 27.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# adbm-rethinkdb
[](http://standardjs.com/)
RethinkDB adapter for [adbm](https://github.com/daerion/adbm) database migration tool.
## Installation
```
npm install adbm-rethinkdb
```
## Helpers
This adapter contains a series of helper functions meant to simplify a few common migration tasks. These helper functions have been taken from the now deprecated [reconsider](https://github.com/daerion/reconsider) module, as has their documentation. Each of these functions will return a database migration object, i.e. an object exposing `up` and `down` methods, which can then be exported by the migration file.
### createTablesMigration
This function will return a migration that will create tables when migrating up and drop these tables when migrating down. `createTablesMigration` expects an array of table names.
```js
// In file migrations/xx-create-tables.js
const helpers = require('adbm-rethinkdb/helpers')
module.exports = helpers.createTablesMigration([ 'first_table', 'second_table' ])
````
### createIndexMigration
This function will return a migration that will create indices when migrating up and drop these indices when migrating down. `createIndexMigration` expects an array of index specifications. Each index specification is an object containing a `table` and an `index` property, and optionally an `options` object and/or a `spec` function.
An `options` object can be anything that `r.indexCreate()` accepts, while the `spec` property must be a function that returns an index definition (which, again, can be anything that `r.indexCreate()` accepts). `spec` will be passed the rethinkdbdash instance when it is executed.
```js
// In file migrations/xx-create-indices.js
const helpers = require('adbm-rethinkdb/helpers')
const table = 'first_table'
module.exports = helpers.createIndexMigration([
{ table, index: 'someProp' }, // Simple index
{ table, index: 'compoundIndex', spec: (r) => [ r.row('firstProp'), r.row('secondProp') ] }, // Compound index
{ table, index: 'geoProp', options: { geo: true } }, // Geo index
{ table, index: 'multiIndex', options: { multi: true } }, // Multi index
{ table, index: 'arbitraryExpr', spec: (r) => (doc) => r.branch(doc.hasFields('foo'), doc('foo'), doc('bar')) } // Index based on an arbitrary expression
])
```
## Testing
Running tests requires a rethinkdb database. You can either point the tests to your own rethinkdb server using environment variables (see below) or use the included `docker:db` npm script to spin up a docker container called `adbm_rethinkdb_dev_db` that will provide you with a basic rethinkdb server. After that, you'll simply want to:
```
npm run test
```
### Environment Variables
```js
const dbConfig = {
host: process.env.DB_HOST || 'localhost',
port: process.env.DB_PORT,
authKey: process.env.DB_AUTH_KEY,
db: process.env.DB_NAME || 'adbm_rethinkdb'
}
```
I.e. when supplying no configuration, tests will attempt to connect to `localhost` on the default port and will attempt to use the `adbm_rethinkdb` database (which will be created if it does not already exist).
## Author
[Michael Smesnik](https://github.com/daerion) at [tailored apps](https://github.com/tailoredapps)
## License
MIT