waterline-rethinkdb, a RethinkDB Adapter for Waterline.

Homepage | Documentation | Issue Tracker | MIT License | by Guten | Gratipay | Bountysource

For trails, contributions are welcome, the code is well structured and easy to understand.

Install

$ npm install waterline-rethinkdb

USAGE

# edit config/database.js

  module.exports = {
    stores: {
       dev: {
        adapter: require("waterline-rethinkdb"),
        migrate: "alter",
      }
    },
    models: {
      defaultStore: "dev",
    }
  }

Connections Options Reference

native() method

User.native((err, table) => {
  var {conn, r} = table
  table.filter({id: 1}).count().run(conn, (err, result) => {
    ..
  })
})

Use secondary index

User.find({getAll: "foo,authorId"})

->

  r.table(x).getAll("foo", {index: "authorId"})

Indexes

config/database.js

module.exports = {
  stores: {
     dev: {
       indexes: [
        ["users", ["accountId", "addressId"]],
      ]
    }
  },
}

Relationships

one-to-many: r.table("posts").indexCreate("user") many-to-many: r.table("tags_users__users_tags").indexCreate("users_tags") r.table("tags_users__users_tags").indexCreate("tags_users")

Assess rethinkdb

waterline.r
waterline.conn

# Some times you need create index manulaly

const {r, conn} = waterline
r.table("tags_users__users_tags").indexCreate("users_tags").run(conn, (err, result) => {})

Query Language

{
  where: {
    id   : 1,
    id   : {">": 2},             < <= > >= ! not lessThan lessThanOrEqual greaterThan greaterThanOrEqual like startsWith endsWith
    role : ["admin", "owner"]   «in»  {"!": ["admin", "owner"]}
    or   : [{id: 1}, ..]
    tags : {"contains": [1, 2]}}   // contains is for array, means tags.includes(1) and tags.includes(2)
    name : {"match": "^foo"}       // use RethinkDB string#match
  },
  skip: 9,
  limit: 5,                     «convert "-1" to 0»
  sort: "age"                    "age DESC" ASC {name: 1, age: 0}
}

• contains is for array

• limit, skip support string, and limit support -1

{limit: 30}
{limit: "30"}
{limit: -1}     -1 means all records

Development

Contributing

• Submit any bugs/features/ideas to github issue tracker.

Thanks to all contributors.

Copyright

The MIT License (MIT)

Copyright (c) 2015-2016 Guten Ye

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.