# tacodb

> leveldb inside a service

Latest version **1.0.16** (published 2013-06-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install tacodb
pnpm add tacodb
yarn add tacodb
bun add tacodb
```

Provides the command `tacodb`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.16 |
| Published | 2013-06-22 |
| First published | 2013-05-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 20 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 57 |
| Author | Dominic Tarr |
| Maintainers | dominictarr |

## Links

- npm: https://www.npmjs.com/package/tacodb
- Repository: https://github.com/dominictarr/tacodb
- Issues: https://github.com/dominictarr/tacodb/issues
- npm.io page: https://npm.io/package/tacodb

## Dependencies (20)

- [rc](https://npm.io/package/rc.md) ~0.3.0
- [shoe](https://npm.io/package/shoe.md) 0.0.10
- [level](https://npm.io/package/level.md) >=0.8 <1
- [split](https://npm.io/package/split.md) ~0.2.5
- [stack](https://npm.io/package/stack.md) ~0.1.0
- [mkdirp](https://npm.io/package/mkdirp.md) ~0.3.5
- [date.js](https://npm.io/package/date.js.md) ~0.1.1
- [request](https://npm.io/package/request.md) ~2.21.0
- [through](https://npm.io/package/through.md) ~2.3.4
- [ecstatic](https://npm.io/package/ecstatic.md) ~0.4.5
- [securify](https://npm.io/package/securify.md) >=1.1.8 <2
- [pull-glob](https://npm.io/package/pull-glob.md) ~1.0.0
- [pull-level](https://npm.io/package/pull-level.md) >=1.1 <2
- [tiny-route](https://npm.io/package/tiny-route.md) ~2.0.0
- [pull-stream](https://npm.io/package/pull-stream.md) ~2.18.2
- [level-static](https://npm.io/package/level-static.md) ~1.0.8
- [level-sublevel](https://npm.io/package/level-sublevel.md) >=4.6 <5
- [level-live-stream](https://npm.io/package/level-live-stream.md) ~1.4.3
- [monotonic-timestamp](https://npm.io/package/monotonic-timestamp.md) 0.0.8
- [stream-to-pull-stream](https://npm.io/package/stream-to-pull-stream.md) 1.2

## Recent versions

- 1.0.16 (latest) — 2013-06-22
- 1.0.14 — 2013-06-22
- 1.0.13 — 2013-06-19
- 1.0.12 — 2013-06-19
- 1.0.11 — 2013-06-14
- 1.0.10 — 2013-06-14
- 1.0.9 — 2013-06-12
- 1.0.8 — 2013-06-04
- 1.0.7 — 2013-06-04
- 1.0.6 — 2013-06-04
- 1.0.5 — 2013-06-04
- 1.0.4 — 2013-06-04
- 1.0.3 — 2013-06-04
- 1.0.2 — 2013-06-04
- 1.0.1 — 2013-06-04
- … 2 more at https://npm.io/package/tacodb/versions

## README

# tacodb

reusable leveldb server

## Synopsis

tacodb wraps leveldbs in a server such that it would be possible
to create a hosted service with it, that can be connected to via
http and WebSockets.

You database is configured by writing a .js file, which is then
bundled (a la browserify) and sent to the tacodb server via http.

## Getting Started

start by installing `tacodb`

[more examples](https://github.com/dominictarr/tacodb/blob/master/examples/README.md)

``` js
npm install -g tacodb
```

Then, create an customization file

``` js
//db.js
//creat a static http style interface to leveldb.
var static = require('level-static')
module.exports = function (db) {
  db.on('http_connection', static(db))
}
```

start the server locally.

``` js
tacodb local db.js --port 8080
```

``` js
echo hello | curl -sSNT . -X PUT http://localhost:8080/greeting
curl http://localhost:8080/greeting
```

## connecting to tacodb/level via http

Create a database customization file...
This will expose an http interface,
that can store files inside leveldb.

### simple http access

``` js
//examples/http/index.js

var static = require('level-static')

module.exports = function (db) {
  db.on('http_connection', static(db))
}

```

``` 
>tacodb local static.js --name static
listening on 8000
```

This starts a tacodb server running around your `db.js` file.

``` sh
#http PUT hi = HELLO
echo 'HELLO!' | curl -sSNT . localhost:8000/hi
#http GET hi
curl localhost:8000/hi
HELLO!
```


## Add real time logging

`level-static` extend the simple http example,
so that we can track changes as they occur.

### changes http with changes feed.

``` js
//examples/changes/index.js

var static   = require('level-static')
var through  = require('through')
var route    = require('tiny-route')
var live     = require('level-live-stream')
var stack    = require('stack')

module.exports = function (db) {
  //level-static creates a http handling middleware around leveldb.
  db.on('http_connection', stack(
    route.get('/_changes', function (req, res) {
      live(db)
        .pipe(through(function (data) {
          this.queue(JSON.stringify(data) + '\n')
        }))
        .pipe(res)
      req.resume()
    }),
    static(db)
  ))
}

```

### start the server...

``` sh
tacodb local ./index.js --name changes
```

Then, connect and stream changes like this:

``` sh
curl localhost:8000/_changes
```

Then in another terminal:

``` sh
echo 'Hi!' | curl -sSNT . localhost:8000/hi
echo 'whats up?' | curl -sSNT . localhost:8000/wazzup
echo 'Good Bye!' | curl -sSNT . localhost:8000/bye
```


## connect to tacodb/level over websockets

Create a streaming connection with websockets!

### server with websockets & multilevel:

``` js
//examples/ws/server.js

var multilevel = require('multilevel')
var fs         = require('fs')
var index
try {
  index = fs.readFileSync(__dirname + '/index.html','utf8')
} catch (err) {
  console.error("run `npm run build` to generate the html file")
  throw err
}
module.exports = function (db) {
  db.on('http_connection', function (req, res) {
    req.resume()
    res.end(index)
  })
  db.on('connection', function (stream) {
    console.log('connect')
    stream.pipe(multilevel.server(db)).pipe(stream)
  })
}

```

### brower/node client with websockets

``` js
//examples/ws/client.js


var multilevel = require('multilevel')
var reconnect  = require('reconnect/sock')

//This client works from both the browser and in node!
//WebSockets everywhere!

//use `npm run build` to generate the index.html file.

var node = process.title != 'browser'

var log = (node ? console.log :
  function () {
    var data = [].slice.call(arguments).map(function (e) {
      return JSON.stringify(e, null, 2)
    }).join(' ')
    var pre = document.createElement('pre')
    pre.innerText = data
    document.body.appendChild(pre)
  })

reconnect(function(stream) {
  log('connected!')
  var db = multilevel.client()
  stream.pipe(db).pipe(stream)

  setInterval(function () {
    db.put('hi', new Date(), function (err) {
      if(err) return console.error(err)
      db.get('hi', function (err, value) {
        if(err) return console.error(err)
        log('GET', 'hi', value)
      })
    })
  }, 1000)

}).connect(node ? 'http://localhost:8000/ws/ws' : '/ws/ws')
//^ on the browser, this assumes you are on the same host as window.location...

```

this client can be used from both the browser and node.js!

### running the server & client

start the server
``` sh
tacodb local server.js --name ws
```

connect from node:

``` sh
node client.js
```

or from the [browser](http://localhost:8000/)



## License

MIT

---
_Source: https://npm.io/package/tacodb · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._