https://github.com/mafintosh/flat-file-db

Fast in-process flat file database that caches all data in memory
https://github.com/mafintosh/flat-file-db

Last synced: 14 days ago
JSON representation

Fast in-process flat file database that caches all data in memory

• Host: GitHub
• URL: https://github.com/mafintosh/flat-file-db
• Owner: mafintosh
• Created: 2013-12-13T00:01:58.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2017-04-08T18:53:47.000Z (over 7 years ago)
• Last Synced: 2024-05-11T04:22:17.328Z (6 months ago)
• Language: JavaScript
• Size: 14.6 KB
• Stars: 195
• Watchers: 11
• Forks: 15
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# flat-file-db

Fast in-process flat file database for Node.js that supports JSON and caches all data in memory.

All data is persisted to an open file using a append-only algorithm ensuring compact file sizes and strong consistency.

	npm install flat-file-db

[![build status](https://secure.travis-ci.org/mafintosh/flat-file-db.png)](http://travis-ci.org/mafintosh/flat-file-db)

## Usage

Pass a database file to use to the flat-file-db constructor and wait for the database to open.

When it is open all data has been loaded into memory.

``` js

var flatfile = require('flat-file-db');

var db = flatfile('/tmp/my.db');

db.on('open', function() {

	db.put('hello', {world:1});  // store some data

	console.log(db.get('hello')) // prints {world:1}

	db.put('hey', {world:2}, function() {

		// 'hey' is now fully persisted

	});

});

```

If you don't want to wait for it to open use `flatfile.sync`

``` js

var db = flatfile.sync('/tmp/my.db');

console.log(db.get('hello')); // prints {world:1}

```

If you issue multiple writes the last one will always win

``` js

for (var i = 0; i < 10; i++) {

	db.put('test', {count:i}, ...);

}

console.log(db.get('test')); // {count:9} which also the persisted value of 'test'

```

## API

* `db = flatfile(path, opts)` Create a new db instance. Per default fsync is called on all puts. To disable this set `opts.fsync = false`

* `db = flatfile.sync(path, opts)` Same as above except you do not need to wait for the open event

* `db.put(key, val, [cb])` Insert or update new key

* `db.del(key, [cb])` Delete a key

* `db.get(key) -> doc` Get the value of a key

* `db.has(key) -> bool` True if db has key

* `db.keys() -> list` Get all keys as an array

* `db.clear([cb])` Clears the database of all values

* `db.close()` Close the database

## Events

* `db.on('open')` Fired when the db is open and ready for use.

* `db.on('close')` Fired when the db is fully closed

* `db.on('drain')` All puts and deletes are flushed to disk

## License

MIT