The unofficial Couchbase Node.js Client Library.
npm install @corbinu/couchbaseThe Node.js SDK library allows you to connect to a Couchbase cluster from
Node.js. It is a native Node.js module and uses the very fast libcouchbase
library to handle communicating to the cluster over the Couchbase binary
protocol.
Source - http://github.com/couchbase/couchnode
Bug Tracker - http://www.couchbase.com/issues/browse/JSCBC
Couchbase Developer Portal - https://docs.couchbase.com/
Release Notes - https://docs.couchbase.com/nodejs-sdk/2.6/relnotes-nodejs-sdk.html
To install the lastest release using npm, run:
``bash`
npm install couchbase
To install the development version directly from github, run:
`bash`
npm install "git+https://github.com/couchbase/couchnode.git#master"
Connecting to a Couchbase bucket is as simple as creating a new Cluster Cluster
instance to represent the you are using, and then executingopenBucket against this to open a connection to you specific bucket. You
are able to execute most operations immediately, and they will be queued
until the connection is successfully established.
Here is a simple example of instantiating a connection, adding a new document
into the bucket and then retrieving its contents:
`javascript
var couchbase = require('couchbase');
var cluster = new couchbase.Cluster('couchbase://127.0.0.1');
// For Couchbase > 4.5 with RBAC Auth
cluster.authenticate('username', 'password')
var bucket = cluster.openBucket('default');
bucket.upsert('testdoc', {name:'Frank'}, function(err, result) {
if (err) throw err;
bucket.get('testdoc', function(err, result) {
if (err) throw err;
console.log(result.value);
// {name: Frank}
});
});
`
As part of the core library, we additionally include a powerful Mock version
of the library which supports a significant set of the features that are
available when connected to a real Couchbase Server.
As part of this library, we include a mock version of the client that supports
nearly the exact same feature set as the library itself, but which does not
require that a server be configured. Note that these Mock connections currently
are per-instance, if another connection is instantiated, none of the data will
be shared.
Using the Mock is as simple as this:
`javascript
var couchbase = require('couchbase').Mock;
var db = new couchbase.Cluster();
var bucket = cluster.openBucket();
bucket.upsert('testdoc', {name:'Frank'}, function(err, result) {
if (err) throw err;
bucket.get('testdoc', function(err, result) {
if (err) throw err;
console.log(result.value);
// {name: Frank}
});
`
An extensive documentation is available on the Couchbase website. Visit our
Node.js Community on
the Couchbase website for the documentation as well as
numerous examples and samples.
The source code is available at
https://github.com/couchbase/couchnode.
Once you have cloned the repository, you may contribute changes through our
gerrit server. For more details see
CONTRIBUTING.md.
To execute our test suite, run make test from the root directory.
To execute our code coverage, run make cover from the root directory.
In addition to the full test suite and full code coverage, you may additionally
execute a subset of the tests which excludes slow-running tests for quick
verifications. These can be run through make fasttest and make fastcover`
respectively.
Licensed under the Apache License, Version 2.0.
See
LICENSE
for further details.