Code Monkey home page Code Monkey logo

baseview's Introduction

baseview

baseview is a minimalistic CouchBase client for node.js based on the minimalistic CouchDB driver nano.

CouchBase provides view data as JSON, which can be accessed and streamed with this client. To store and retrieve single documents/key-value pairs, the memcached-library is required.

usage

  baseview = require('baseview')('http://127.0.0.1:8092')
  or
  baseview = require('baseview')({url: 'http://127.0.0.1:8092', bucket: 'my_bucket'})
  ...

  // retrieve data from a view
  baseview.view('design_doc', 'view_name', function(error, data) {
    console.log(error, data);
  });
  
  // retrieve data from a spatial index with bounding box.
  // see 'sparta' for bbox calculations
  baseview.spatial('geo', 'points', {bbox: bbox}, function(error, points) {
    console.log(error, points);
  });

  //adding a design document
  baseview.setDesign('design_doc', {
     'names': {
        'map': "function(doc){if(doc.name){emit(doc.name);}}"
      },
      'rating': {
        'map': "function(doc){if(doc.name && doc.rating){emit(doc.rating);}}"
      }
    },
    function(err, res){
      // handle error http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-views-designdoc-api-storing.html
    }
  );

  // retrieve a design document
  baseview.getDesign('design_doc', function(err,res) {
    // http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-views-designdoc-api-retrieving.html
  });

  // delete a design document
  baseview.deleteDesign('design_doc', function(err, res) {
    // handle error http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-views-designdoc-api-deleting.html
  });

To create a geographical bounding box (bbox), have a look at sparta, a small library for geo calculations.

example with socket.io

  io.sockets.on('connection', function (socket) {
    baseview.view('feed', 'images', function(error, data) {
      socket.emit('image_feed', data.rows);
    });
  });

tests

Tests are written in specify. To run the tests, execute:

node tests/views.js
node tests/spatial.js

Build Status

contribute

everyone is welcome to contribute. patches, tests, bugfixes, new features

  1. create an issue on github so the community can comment on your idea
  2. fork baseview in github
  3. create a new branch git checkout -b my_branch
  4. create tests for the changes you made
  5. make sure you pass both existing and newly inserted tests
  6. commit your changes
  7. push to your branch git push origin my_branch
  8. create an pull request

meta

proudly presented by Patrick Heneise, Barcelona.

baseview's People

Watchers

James Cloos avatar Aleksei Tcelishchev avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.