ediket / nothinkdb

Functional toolkit for rethinkdb.

Nothinkdb

Functional toolkit for rethinkdb.

Currently, Compitable with rethinkdb 2.2.x

• define declarative table schema.
• handle schema validation with joi.
• handle default fields like id, createdAt, updatedAt.
• ensure table, secondary index.
• ensure unique field.
• fully customizable 1-n, 1-1, n-1, n-m relations.
• define, create, remove, check, query, join relations.
• many useful query generator.
• easily implement graphql server with nothinkdb-graphql

Install

npm install -S nothinkdb

Example

import Joi from 'joi';
import r from 'rethinkdb';
import { Table, schema } from 'nothinkdb';

const userTable = new Table({
  tableName: 'user',
  schema: () => ({
    id: schema.id,
    name: Joi.string().required(),
    isPremium: Joi.boolean().default(false),
  }),
});

async function run() {
  // open rethinkdb connection
  const connection = await r.connect({ db: 'test' });

  // sync table
  await userTable.sync(connection);
  await followingTable.sync(connection);

  // create user data
  const normalUser = userTable.create({ name: 'user1' });
  const premiumUser = userTable.create({ name: 'user2', isPremium: true });

  // insert user data into rethinkdb server
  await userTable.insert([
    normalUser,
    premiumUser,
  ]).run(connection);

  // getAll users
  const users = await userTable.query().coerceTo('array').run(connection);

  console.log(users);

  // close rethinkdb connection
  await connection.close();
}

run();

If you want to see more examples, See the Examples

API

See the API Reference.

Related Links

• rethinkdb
• nothinkdb-graphql
• graphql-relay-rethinkdb-example

nothinkdb's Issues

prevent create duplicate n-m row.

Implement unique field.

like this.

Joi.string().meta({ unique: true })

Used in update, create

Make sync return query

Now, Table.sync & Environment.sync receive connection as argument.
Change that functions return query, For it could be used with another ecosystem like rethinkdb-pool.

node-uuid deprecated

[email protected]: Use uuid module instead

Could we switch from node-uuid to uuid without issue?

Example in readme.md does not work

When running the example in the readme as-is, I see the following error:

ValidationError: {
  "table": "user",
  "tableName" [1]: -- missing --
}

ok... after changing table to tableName, the error disappears but nothing else happens (I'm expecting to see the newly created users in the console).

The example from rethinkdb works fine.

Table.delete should remove related relations.

Rooms for improvement

Structural

• Table#create and Table#attempt are duplicate.
• Why should Table#insert must be accompanied by Table#create? Schema that is passed in the constructor is only good for Table#create where Table#insert is just a raw rethinkdb insert. Table#insert should call Table#create with schema before inserting in the database.
• Why should link be exposed? Suggestion:

// before
bar: hasOne(fooTable.linkedBy(barTable, 'fooId'))
bar: belongsTo(fooTable.linkTo(barTable, 'barId'))
bars: hasMany(fooTable.linkedBy(barTable, 'fooId'))
// after
bar: hasOne(barTable, 'fooId')
bar: belongsTo(barTable, 'barId')
bars: hasMany(barTable, 'fooId')

• Table#createRelation has inconsistent spec.

// before
fooTable.createRelation('bar', foo.id, bar.id)
// after
fooTable.createRelation(foo.id, 'bar', bar)

• Table#createRelation should accept other object instead other.id. Table#foreignKey can be any other field than pk, and for Table#createRelation of belongsTo, right.table.get(otherPk) must be fetched with foreignKey that is not necessarily pk.

Test

• After tests are run, tables are still there. Whatever created during test must be cleared after.
• Bi-direction relationship is not tested.
• Table#withJoin is not tested with relations as object. I'm not even sure what it does.

Implementation Questions

• In relations.js, what's the point of these:

apply = query => query;

query = r.branch(
  row(right.field),
  query.getAll(row(right.field), { index: left.field }),
  r.expr([]),
);

Code still works with apply and branch.

Trivial issue on sync test at Table-test

https://github.com/ediket/nothinkdb/blob/master/src/__tests__/Table-test.js#L252

syncTable is used nowhere in the application or test. Is this necessary?

Add assert messages in relations

rethinkdb to rethinkdbdash ?

They are quite similar but the second offer much more options and is developped by someone on the RethinkDB team.

Could it be possible to use this instead?

Add practical examples.

• basic relation examples
  • hasOne
  • belongsTo
  • hasMany
  • belongsToMany
• extending examples
  • Table
• todo example

Joi empty string

Note that empty strings are not allowed by default and must be enabled with allow('').

https://github.com/hapijs/joi/blob/v8.0.3/API.md#string

Create Environment class.

create Environment class.

const env = new Environment();
const fooTable = env.createTable({ ... });

await env.sync()  // sync all tables
env.getTable('foos');  // same as fooTable
env.getTableList('foos');  // [...]