lawson

lawson

Yet another Couchbase Orm

Install

$ npm install --save lawson

Setup

orm.js

import couchbase from 'couchbase';
import lawson from 'lawson';

const cluster = new couchbase.Cluster();
const bucket = cluster.openBucket();

const lawsonInstance = lawson(bucket);

export const model = lawsonInstance.defineModel;

models/user.js

import {model} from '../orm';

export const default = model('user', {
    username: 'string',
    email: 'string',
    password: 'string'
});

Usage

import user from './models/user';

/*   create   */
user.create({
    username: 'test',
    email: '[e-mail]',
    password: 'secret'
})
/*   get   */
.then(createdUser => {
    return user.get(createdUser.id);
})
/*   update   */
.then(newUser => {
    newUser.username = 'bobby';

    return user.update(newUser.id, newUser);
})
.then(updatedUser => {
    console.log('user updated');
})
.then(() => {
    return user.query({
        where: {
            username: 'bobby'
        }
    });
})
.then(users => {
    console.log(user.length);
    // => 1

    return user.delete(users[0].id);
})
.catch(e => {
    console.warn(e);
});

API

lawsonInstance = lawson(couchbaseBucket)

Create a new instance of lawson

couchbaseBucket

Type: Bucket
required

The bucket the library is storing documents

model = lawsonInstance.defineModel(modelName, modelDefinition)

Define a new model

modelName

Type: string
required

the type of the document

modelDefinition

Type: object required

The schema of the document, see its definition here

model.get(documentId)

Returns a Promise, that resolve to the requested document

documentId

Type: string
required

model.update(documentId, document)

Returns a Promise, that resolve when the document is updated

documentId

Type: string required

the id of the document to update

document

Type: object required

the new version of the document that will be updated

model.create(document)

Returns a Promise, that resolve to the created document

document

Type: object required

The document that will be created

model.delete(documentId)

Returns a Promise when the document is deleted

documentId

Type: string required

The id of the document that will be deleted

model.query(options)

Returns a Promise, that resolve to all the documents

options.where

Type: object

Used to filter out results of the query

options.limit

Type: number

The number of documents to return

options.offset

Type: number
default: 0

The number of documents to skip

Difference between lawson and ottoman

	Lawson	Ottoman
Mock-able	Yes	No
Use S1-Ql (faster)	planned	Yes

License

MIT © Thomas Sileghem