https://github.com/dominictarr/kv

simple kv store for streams
https://github.com/dominictarr/kv

Last synced: 23 days ago
JSON representation

simple kv store for streams

• Host: GitHub
• URL: https://github.com/dominictarr/kv
• Owner: dominictarr
• Created: 2012-05-20T14:44:49.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2013-03-14T21:49:47.000Z (over 11 years ago)
• Last Synced: 2024-10-06T21:05:06.645Z (about 1 month ago)
• Language: JavaScript
• Size: 153 KB
• Stars: 35
• Watchers: 7
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: readme.markdown

Awesome Lists containing this project

• awesome-starred - dominictarr/kv - simple kv store for streams (others)

README

        
# kv-stream

super simple key-value store, intended for keeping appendable files.

works on the server, with files or redis _and in the browser_ with `localStorage`.

on the server, it keeps the files in prefixed subdirectories, so that the directories do not get too large.

(see ls .git/objects/\* for a similar example)

## examples

###create an instance

`kv(path/prefix/connectString, setup)`

`path` is where to create/connect to the store.

`setup` is optional. `setup` is passed the stream created by `put` and `get`, may replace the stream passed to put/get

by default, the stream is handled as newline seperated json.

```

//files

var kv = require('kv')('/tmp/kv')

//redis

var kv = require('kv/redis')('redis://password@localhost:6379/prefix')

//client

var kv = require('kv')('kv:') //this will be prefixed to keys when saving in localStorage.

```

### put a stream

`opts` is optional. see [fs.createWriteStream](http://nodejs.org/api/fs.html#fs_fs_createreadstream_path_options)

``` js

stream.pipe(kv.put(key, opts))

```

`kv.createWriteStream` is a synonym for `kv.put`

### get a stream

`opts` is optional. see [fs.createReadStream](http://nodejs.org/api/fs.html#fs_fs_createwritestream_path_options)

``` js

kv.get(key, opts).pipe(stream) 

```

`kv.createReadStream` is a synonym for `kv.get`

### del a stream

``` js

kv.del(key, callback)

```

### list of keys

``` js

kv.list().pipe(stream)

```

### has

check if db has a key

``` js

  kv.has(key, function (err, stat) {

    //return the stat of the stream, if it exists.

  })

```

### customization

to handle other types of streams than newline separated json, pass in a stream setup function to kv.

``` js

var rawKV = require('kv')(dir, function (stream, key) {

  return stream //just use raw streams, do not parse!

})

```

# cli

there is also a cli tool!

```

npm install kv -g

echo hello | kv put hello --base /tmp/kv

kv get hello --base /tmp/k

```