npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

couchbase-odm

v0.9.5

Published

A simple Object Data Mapper for Couchbase

Downloads

25

Readme

couchbase-odm

A simple Object Data Mapper for Couchbase.

Installation

Simply pull this repository or install with npm install couchbase-odm.

Usage

Creating a model

var User = odm.createModel('User', { name: 'String',
						  username: { type: 'String', index: true } }, couchbase_connection);

Chain .setupViews() onto the end of createModel(...) to automatically set up views based on indexes and import existing views from Couchbase.

Adding static functions

User.sayHello = function() { console.log('My name is '+ this.name); };

Adding an object

var u = new User({ name: 'Jesse' });
u.username = 'jessevandersar';

console.log(u._id); /* --> automatically generated UUIDv4-id */
console.log(u._type); /* --> 'User' */

u.sayHello(); /* --> 'My name is Jesse' */

u.save(function(result) {
  console.log(result); /* { object: <saved object>, result: <CAS> } */
});

Retrieving and updating an object

User.getById(id, function(u) {
  u.username = 'new_username';
	
  u.save();
});

Deleting an object

User.getById(id, function(u) {
  u.remove();
});

Indexes/Views

Adding the 'index'-option to a field, as with the 'username'-field in the example, automatically creates a very basic view for querying this object-type with the field as a key. Note that calling .setupViews() on the model is a prerequisite.

Querying an object type (view)

User.getByUsername('jessevandersar', function(results) {
  console.log(results);
});

Secondary view options (like limit, descending and stale) can be added as an object in the second parameter.

An 'all'-view will be added by default, usable with User.getAll(...). Also, views that already exist in the design document will be automatically imported from Couchbase.

Note: imported views with names containing underscores will be usable in camelcase with User.specificView(key, callback).

Notes

This module is in a very early state. It hasn't been tested in production yet, but has worked for me during development, and has served as a nice excercise in working with Couchbase and creating Node modules. Please let me know about your thoughts and/or bugs that you've encountered!

Github repo: https://github.com/jessevandersar/couchbase-odm