Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bahamas10/machinedb
A machine database that stores information as flat JSON files
https://github.com/bahamas10/machinedb
Last synced: about 2 months ago
JSON representation
A machine database that stores information as flat JSON files
- Host: GitHub
- URL: https://github.com/bahamas10/machinedb
- Owner: bahamas10
- License: mit
- Created: 2014-03-19T06:11:05.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2014-03-19T06:14:29.000Z (almost 11 years ago)
- Last Synced: 2024-10-31T18:06:09.910Z (about 2 months ago)
- Language: JavaScript
- Size: 125 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Machine Database
================
A machine database that stores information as flat JSON files
- [Installation](#installation)
- [API Examples](#api-examples)
- [CLI Examples](#cli-examples)
- [Methods](#methods)
- [Usage](#usage)
- [Notes](#notes)
- [Inspiration](#inspiration)
- [License](#license)
Installation
------------
First, install [Node.JS](http://nodejs.org/). Then:
[sudo] npm install -g machinedb
API Examples
------------
Fire up `machinedb` by running:
$ mkdir data
$ machinedb-server --dir data
server started on http://localhost:9000
127.0.0.1 - - [19/Mar/2014:01:37:26 -0400] "GET /ping HTTP/1.1" 200 - "-" "curl/7.30.0"
127.0.0.1 - - [19/Mar/2014:01:37:28 -0400] "GET /stats HTTP/1.1" 200 246 "-" "curl/7.30.0"
This will start the HTTP server listening on `localhost` on port 9000,
and serve out of `./data`.
### GET and PUT data
First, we'll see what happens when we try to access data before we save any
$ curl -s http://localhost:9000/nodes/ | json
[]
$ curl -s http://localhost:9000/nodes/dave.example.com
Not Found
`GET /nodes` returns `[]`, because there are no nodes saved yet. Trying to access a node
by name returns a `404` because, again, nothing has been put in the database yet.
Let's put some data into the database and `GET` it back
$ curl -s -XPUT --data '{"foo":"bar"}' http://localhost:9000/nodes/dave.example.com | json
{
"message": "saved",
"status": "ok"
}
$ curl -s http://localhost:9000/nodes/dave.example.com | json
{
"foo": "bar"
}
Now that the data is saved, when we `GET /nodes`, we will see the data stored in `dave.example.com`
appear as an element in the array returned.
$ curl -s http://localhost:9000/nodes/ | json
[
{
"foo": "bar",
"name": "dave.example.com"
}
]
Notice the `name` attribute has been automatically been set for us. `machinedb` will automatically
set `name` when retrieved as `/nodes`, overwriting what may have been saved as `name`.
Let's add another node
$ curl -s -XPUT --data '{"baz":"bat"}' http://localhost:9000/nodes/mike.example.com | json
{
"message": "saved",
"status": "ok"
}
$ curl -s http://localhost:9000/nodes/ | json
[
{
"foo": "bar",
"name": "dave.example.com"
},
{
"baz": "bat",
"name": "mike.example.com"
}
]
Observe how the array now contains both nodes
$ curl -s -XDELETE http://localhost:9000/nodes/dave.example.com | json
{
"message": "deleted",
"status": "ok"
}
$ curl -s http://localhost:9000/nodes/ | json
[
{
"baz": "bat",
"name": "mike.example.com"
}
]
`dave.example.com` has been removed from the array, as it has been removed from the
database.
### Stats and Health
You can hit `/ping` or `/stats` to see process health.
$ curl localhost:9000/ping
pong
$ curl localhost:9000/stats | json
{
"arch": "x64",
"dir": "/Users/dave/dev/machinedb/nodes",
"machinedbversion": "v0.0.0",
"mem": {
"rss": 21270528,
"heapTotal": 17603072,
"heapUsed": 6780400
},
"nodeversion": "v0.10.22",
"now": 1395207482098,
"pid": 38784,
"platform": "darwin",
"started": 1395207441931
}
CLI Examples
------------
This package comes bundled with `machinedb`: a command line tool for
interacting with the database.
Run it by itself to see all nodes
$ machinedb
[
{
"baz": "bat",
"name": "mike.example.com"
}
]
You can view a list of nodes by running it with `list`, or view a specific
node with `show`
$ machinedb list
mike.example.com
$ machinedb show mike.example.com
{
"baz": "bat"
}
You can create or update a node with `create` or `update`. Because `machinedb` doesn't
support rewrite, these operations are the same.
$ machinedb create dave.example.com <<< '{"baz": "bat"}'
{
"message": "saved",
"status": "ok"
}
$ machinedb list
dave.example.com
mike.example.com
You can edit a node like
$ machinedb edit dave.example.com
# vim was opened... edit edit edit... :wq
{
"message": "saved",
"status": "ok"
}
And finally, delete a node with
$ machinedb delete mike.example.com
{
"message": "deleted",
"status": "ok"
}
$ machinedb list
dave.example.com
Methods
-------
### `GET /nodes`
Retrieve all nodes as an array of objects
### `GET /nodes/:node`
Retrieve a node, supports `if-none-match` with the `ETag` given.
### `HEAD /nodes/:node`
Same as `GET` without the data.
### `PUT /nodes/:node`
Put data given into the key. The data is NOT verified, and *should* be JSON.
### `DELETE /nodes/:node`
Delete the node given.
Usage
-----
### server
Usage: machinedb-server [-d dir] [-h] [-H host] [-n] [-p port] [-u] [-v]
A machine database that stores information as flat JSON files
Options
-d, --dir the database directory, defaults to /Users/dave/dev/machinedb
-h, --help print this message and exit
-H, --host [env MACHINEDB_HOST] the address to bind to, defaults to localhost
-n, --no-log [env MACHINEDB_NOLOG] disable logging, logging is enabled by default
-p, --port [env MACHINEDB_PORT] the port to bind to, defaults to 9000
-u, --updates check npm for available updates
-v, --version print the version number and exit
### cli
Usage: machinedb [-h] [-H host] [-p port] [-u] [-v]
machinedb command line utility
Examples
machinedb # same as GET /nodes
machinedb list # list all nodes separated by newlines
machinedb show # same as GET /nodes/
machinedb create # create a node by name , reads JSON from stdin
machinedb update # update a node by name , reads JSON from stdin
machinedb edit # edit a node by opening $EDITOR on the JSON returned by the server
machinedb delete # remove a node
Options
-h, --help print this message and exit
-H, --host [env MACHINEDB_HOST] the address to bind to, defaults to localhost
-p, --port [env MACHINEDB_PORT] the port to bind to, defaults to 9000
-u, --updates check npm for available updates
-v, --version print the version number and exit
Notes
-----
- This program does no in-memory caching or expiring of data, it's built to run
on the [ZFS](http://en.wikipedia.org/wiki/ZFS) filesystem with the ARC for
caching.
- `GET /nodes` is a heavy operation as it reads *every* file from the filesystem, and
also doesn't limit the number of files it will open at a time (todo fix this)
Inspiration
-----------
idea: chef replacement in bash, using simple bash scripts. search() by curl'ing a machine database that stores JSON for each node.
— Dave Eddy (@bahamas10_) March 12, 2014
License
-------
MIT