slouch/README.md
Jeffrey Layanto 0e2e5e7325
The rest of partitioned database support (#131)
Co-authored-by: Jeffrey Layanto <jeffrey@layanto.com>
2020-08-22 07:44:46 -07:00

31 lines
1.3 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# slouch
[![Greenkeeper badge](https://badges.greenkeeper.io/redgeoff/slouch.svg)](https://greenkeeper.io/) [![Circle CI](https://circleci.com/gh/redgeoff/slouch.svg?style=svg&circle-token=ae7548ebc7e23a051ed03dbc3209c5e0529e260a)](https://circleci.com/gh/redgeoff/slouch)
A JS API for CouchDB that does the heavy lifting
## Slouch is a good alternative to nano:
- You don't have to create an instance for each DB
- Supports native promises
- Supports iterators
- Automatically throttles connections to DB to avoid max_dbs_open errors
- Automatically persists connections with exponential backoff in case DB restarts or connection is dropped
- Works in node and in the browser
- Provides upserts and "get and update" functions
- Support for optionally ignoring conflicts, missing docs, etc...
- Designed for CouchDB 1, CouchDB 2 and CouchDB 3
## Table of Contents
* [Getting Started](GETTING-STARTED.md)
* [Don't just relax. Slouch!](SLOUCH.md)
* [Examples](https://github.com/redgeoff/slouch/tree/master/examples)
* [Reference](API.md)
* [Dont Just Relax; Slouch: A JS Client for CouchDB that Does the Heavy Lifting](https://medium.com/@redgeoff/dont-just-relax-slouch-a-js-client-for-couchdb-that-does-the-heavy-lifting-d8232eba8e2c)
## [Testing/Contributing](TESTING.md)
## [Building](BUILDING.md)