feathers-ottoman

IMPORTANT: This is still in early development stage, please report any issue found

This library is written against ottoman-2.2.1 and is tested against Couchbase 7.1.1 which supports scope and collection

A Feathers database adapter for Ottoman, an object modeling tool for Couchbase

$ npm install feathers-ottoman

Important: feathers-ottoman implements the Feathers Common database adapter API and querying syntax

This adapter also requires a running Couchbase database server

API

service([options])

Returns a new service instance initialized with the given options. Model has to be a Ottoman model. See the Ottoman Guide for more information on defining your model

// commonjs
const service = require('feathers-ottoman');
// es6 / typescript
import { service } from 'feathers-ottoman';

app.use('/messages', service({ Model }));
app.use('/messages', service({ Model, id, events, paginate, ottoman: { lean, consistency } }));

Options:

• Model (required) - The Ottoman model definition
• id (optional, default: 'id') - The name of the id field property. Note that the id has to be also define when initializing the Ottoman Model if not using default value
• events (optional) - A list of custom service events sent by this service
• paginate (optional) - A pagination object containing a default and max page size
• whitelist (optional) - A list of additional query parameters to allow
• multi (optional) - Allow create with arrays and update and remove with id null to change multiple items. Can be true for all methods or an array of allowed methods (e.g. [ 'remove', 'create' ])
• ottoman.lean (optional, default: true) - Runs queries faster by returning plain objects instead of Ottoman Model
• ottoman.consistency (optional, default: NONE) - Define default Search Consistency Strategy

Note: You can get access to the Ottoman model via this.Model inside a hook and use it as usual. See the Ottoman Guide for more information on defining your model

Example

Here is an example of a Feathers server with a messages Ottoman service

$ npm install @feathersjs/feathers @feathersjs/express ottoman feathers-ottoman

In index.js:

// Initialize Ottoman connection
const { Ottoman, getModel, Schema, SearchConsistency } = require('ottoman');

const ottoman = new Ottoman();

ottoman.connect({
  connectionString: 'couchbase://localhost',
  bucketName: 'messageBucket',
  username: 'user',
  password: 'password',
});

const modelOptions = {
  // specify `idKey` if not using default
  // idKey: 'customId',
  scopeName: 'messageScope',
  collectionName: 'messageCollection',
};

const schema = new Schema({
  text: { type: String },
});

ottoman.model('message', schema, modelOptions);

ottoman.start();

// Setup feathers service
const feathers = require('@feathersjs/feathers');
const express = require('@feathersjs/express');

const { Service } = require('feathers-ottoman');

// Creates an ExpressJS compatible Feathers application
const app = express(feathers());

// Parse HTTP JSON bodies
app.use(express.json());
// Parse URL-encoded params
app.use(express.urlencoded({ extended: true }));
// Host static files from the current folder
app.use(express.static(__dirname));
// Add REST API support
app.configure(express.rest());
// Register a Ottoman message service
app.use('/messages', new Service({
  Model: getModel('message'),
  // if `idKey` is specify for the Model
  // id: 'customid',
  ottoman: {
    lean: true,
    consistency: SearchConsistency.LOCAL,
  },
  paginate: {
    default: 10,
    max: 100
  }
}));
// Register a nicer error handler than the default Express one
app.use(express.errorHandler());

// Create a dummy Message
app.service('messages').create({
  text: 'Message created on Ottoman server'
}).then(function(message) {
  console.log('Created messages', message);
});

app.listen(3030).on('listening', () => console.log('feathers-ottoman example started'));

Run the example with node . and go to localhost:3030/messages

For a complete example, take a look at feathers-ottoman-demo repository

Development

Setup

1. Run docker-compose up -d
2. Wait 5-10 sec for all services to fully initialized
3. Launch a command prompt and run docker exec -it feathers-couchbase bash
4. Once inside the container, run cd scripts then ./setup-couchbase.sh, type y if prompted. See details below
5. You can now access couchbase via localhost:8091 and login using admin:password

setup-couchbase script

This script will initialize and setup couchbase node and cluster using the couchbase-cli, hence, no manual setup is required. It will:

1. Initialize the node with admin:password credentials
2. Initialize the cluster with only data, index, query, fts services enabled
3. Create user:password with full admin rights
4. Creates a bucket: testBucket
5. Creates a scope: testpostscope under testBucket
6. Creates a collection: testpostcollection under testpostscope
7. Creates index on testBucket and testBucket.testpostscope.testpostcollection

Release

1. Update package.json and package-lock.json version
2. Run logchanges
3. Commit CHANGELOG.md [chore: update CHANGELOG for X.X.X]
4. Commit package.json and package-lock.json [X.X.X]
5. Git tag vX.X.X
6. Run npm publish --dry
7. Run npm publish
8. Git push
9. Create new release in Github

License

Copyright (c) 2021-2022

Licensed under the MIT license.