Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/notslang/couchdb-client

Interact with CouchDB through the terminal using streams
https://github.com/notslang/couchdb-client

Last synced: 26 days ago
JSON representation

Interact with CouchDB through the terminal using streams

Host: GitHub
URL: https://github.com/notslang/couchdb-client
Owner: notslang
License: gpl-3.0
Created: 2016-05-06T12:18:10.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2018-07-22T02:59:37.000Z (over 6 years ago)
Last Synced: 2024-12-27T17:23:46.217Z (about 1 month ago)
Language: CoffeeScript
Homepage:
Size: 111 KB
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # couchdb client

[![Build Status](http://img.shields.io/travis/slang800/couchdb-client.svg?style=flat-square)](https://travis-ci.org/slang800/couchdb-client) [![NPM version](http://img.shields.io/npm/v/slang-couchdb.svg?style=flat-square)](https://www.npmjs.org/package/slang-couchdb) [![NPM license](http://img.shields.io/npm/l/slang-couchdb.svg?style=flat-square)](https://www.npmjs.org/package/slang-couchdb)

## why?

There are a few other libraries, but nothing I liked. This is what I've done differently:

- Everything is handled through streams and promises.

- Authentication and retries are handled transparently by the client.

- Property naming matches JavaScript's style and is consistent. `_id` is the document id everywhere (including status messages) and snake_case names are corrected to camelCase.

- Optimize to make the fewest requests possible... tracking cookie timeouts to avoid retries, allowing you to specify if a conflict is likely to happen, and get the doc to apply your changes before attempting an update, using the `_bulk_docs` endpoint for post streams, and combining duplicate requests in get/head streams.

## install

CouchDB Client is an [npm](http://npmjs.org/package/slang-couchdb) package, so it can be installed into your project like this:

```bash

npm install slang-couchdb --save

```

## usage

If you want pretty printing, pipe the output into [jq](https://stedolan.github.io/jq/manual/).

## similar tools

- [couchdb-utils](https://github.com/awilliams/couchdb-utils)

- [futon (cli)](https://www.npmjs.com/package/futon)