# flat-file-db

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

Latest version **1.0.0** (published 2016-05-22) · 0 weekly downloads

## Install

```sh
npm install flat-file-db
pnpm add flat-file-db
yarn add flat-file-db
bun add flat-file-db
```

## 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.0 |
| Published | 2016-05-22 |
| First published | 2013-12-13 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 197 |
| Author | Mathias Buus |
| Maintainers | mafintosh |
| Keywords | db, flat, file, memory, in, process, json, files, compact, consistent, fast |

## Links

- npm: https://www.npmjs.com/package/flat-file-db
- Repository: https://github.com:mafintosh/flat-file-db
- Homepage: https://github.com/mafintosh/flat-file-db
- Issues: https://github.com/mafintosh/flat-file-db/issues
- npm.io page: https://npm.io/package/flat-file-db

## Dependencies (1)

- [mkdirp](https://npm.io/package/mkdirp.md) ~0.3.5

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.0 (latest) — 2016-05-22
- 0.1.5 — 2015-04-11
- 0.1.4 — 2015-03-01
- 0.1.3 — 2014-01-05
- 0.1.2 — 2013-12-17
- 0.1.1 — 2013-12-13
- 0.1.0 — 2013-12-13

## 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

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