Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mikeal/couchup
A CouchDB implementation on top of levelup.
https://github.com/mikeal/couchup
Last synced: about 2 months ago
JSON representation
A CouchDB implementation on top of levelup.
- Host: GitHub
- URL: https://github.com/mikeal/couchup
- Owner: mikeal
- Created: 2013-06-15T21:09:36.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2017-07-11T21:45:25.000Z (about 7 years ago)
- Last Synced: 2024-06-28T04:27:02.524Z (3 months ago)
- Language: JavaScript
- Size: 36.1 KB
- Stars: 66
- Watchers: 9
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
- awesome-starred - mikeal/couchup - A CouchDB implementation on top of levelup. (others)
README
## couchup
`couchup` is a database. The goal is to build a data model well suited for mobile applications that may need to work offline and sync later on and maintain smart client side caches. This data model is inspired by CouchDB but diverges greatly in the way it handles and resolves the revision history and conflicts. `couchup` implements a "most writes wins" conflict resolution scheme and does not require or even allow user specific conflict resolution.
Another goal of `couchup` is to be performant and modular. This repository only implements the base document storage layer. Indexes, attachments and replicators are implemented as additional modules.
The tradeoffs `couchup` has made in revision tree storage along with some other simple optimizations mean that `couchup` already has [better write performance than CouchDB](https://gist.github.com/mikeal/5847297) and the same consistency guarantees.
## API
```javascript
var couchup = require('couchup')
, store = couchup('./dbdir')
;
db.put('databaseName', function (e, db) {
if (e) throw e
db.put({_id:'key', prop:'value'}, function (e, info) {
if (e) throw e
db.put({_id:'key', _rev:info.rev, prop:'newvalue'}, function (e, info) {
if (e) throw e
db.get('key', function (e, doc) {
if (e) throw new Error('doc not found')
console.log(doc)
})
})
})
})
```
```javascript
db.compact() // remove old revisions and sequences from the database.
```
```javascript
db.info(function (e, i) {
if (e) throw e
console.log(i.update_seq, i.doc_count)
})
```
### SLEEP Support
```javascript
var changes = db.sleep()
changes.on('entry', function (entry) {
console.log(entry.seq, entry.id)
})
changes.on('end' function () {
console.log('done')
})
```
And can be used with `sleep-ref` for replicating over the network via tcp,tls,http and https.
```javascript
var sleepref = require('sleep-ref')
, s = sleepref(db.sleep.bind(db))
;
http.createServer(s.httpHandler.bind(s)).listen(8080, function () {
db2.pull('http://localhost:8080/', function (e) {
if (e) throw e
// all replicated over the network
})
})
```
You can also replicate between database objects in process.
```javascript
db.clone(db2, function (e) {
if (e) throw e
// all replicated
})
```
#### Incompatibilities w/ CouchDB
Pull replication from CouchDB works and will continue to work continuously if you aren't updating the `couchup` node you're writing it to. Bi-Directional replication with CouchDB will eventually result in conflicts on the CouchDB side because `couchup` converts CouchDB's revision tree to a linear revision sequence.
Similarly, push replication to Apache CouchDB will work once but writing again will likely cause unnecessary conflicts on the CouchDB side.