flat-db

Flat-file based data storage

Setup

npm install flat-db --save

APIs

• FlatDB.configure(Object options)
• FlatDB.Collection(String name[, Object schema]) - Constructor - return Collection class instance
  • .add(Object entry | Array entries)
  • .get(String key)
  • .update(String key, Object updates)
  • .remove(String key)
  • .all()
  • .count()
  • .reset()
  • .find() - return Finder class instance
    • .equals(String property, String | Number value)
    • .notEqual(String property, String | Number value)
    • .gt(String property, Number value)
    • .gte(String property, Number value)
    • .lt(String property, Number value)
    • .lte(String property, Number value)
    • .matches(String property, RegExp value)
    • .skip(Number value)
    • .limit(Number value)
    • .run()

Example:

1
2const FlatDB = require('flat-db');
3
4// configure path to storage dir
5FlatDB.configure({
6  dir: './storage',
7});
8// since now, everything will be saved under ./storage
9
10// create Movie collection with schema
11const Movie = new FlatDB.Collection('movies', {
12  title: '',
13  imdb: 0,
14});
15
16// The schema is optional.
17// But once it was defined, any new item come later
18// will be compared with this schema's structure and data type
19
20// insert a set of movies into collection
21const keys = Movie.add([
22  {
23    title: 'The Godfather',
24    imdb: 9.2,
25  },
26  {
27    title: 'Independence Day: Resurgence',
28    imdb: 7.1,
29  },
30  {
31    title: 'Free State of Jones',
32    imdb: 6.4,
33  },
34  {
35    title: 'Star Trek Beyond',
36    imdb: 5.7,
37  },
38]);
39console.log('\nkeys returned after adding multi items:');
40console.log(keys);
41
42// add a single movie
43const key = Movie.add({
44  title: 'X-Men',
45  imdb: 8.3,
46  year: 2011,
47});
48// the property "year" will be ignored
49// because it does not match with schema
50console.log('\nkey returned after adding single item:');
51console.log(key);
52
53// get item with given key
54const movie = Movie.get(key);
55console.log(`\nget item by key ${key}:`);
56console.log(movie);
57
58// update it
59const updating = Movie.update(key, {
60  title: 123456,
61  imdb: 8.2,
62});
63// the property "title" will be ignored
64// because it does not match with expected type
65console.log('\nupdating result:');
66console.log(updating);
67
68// remove it
69const removing = Movie.remove(key);
70console.log('\nremoving result:');
71console.log(removing);
72
73// count collection size
74const count = Movie.count();
75console.log('\ncollection size:');
76console.log(count);
77
78// get all item
79const all = Movie.all();
80console.log('\nall items:');
81console.log(all);
82
83// find items with imdb < 7.1
84const results = Movie.find().lt('imdb', 7.1).run();
85console.log('\nitems with imdb < 7.1:');
86console.log(results);
87
88// get 2 items since 2nd item (skip first item), which have "re" in the title
89const results = Movie.find().matches('title', /re/i).skip(1).limit(2).run();
90console.log('\n2 items since 2nd item (skip first one), \n which have "re" in the title:');
91console.log(results);
92
93
94// find items with imdb > 6 and title contains "God"
95const results = Movie
96            .find()
97            .gt('imdb', 6)
98            .matches('title', /God/)
99            .run();
100console.log('\nitems with imdb > 6 and title contains "God":');
101console.log(results);
102
103// remove all
104Movie.reset();
105
106// count collection size after removing all
107const count = Movie.count();
108console.log('\ncollection size after removing all:');
109console.log(count);

Test

git clone https://github.com/ndaidong/flat-db.git
cd flat-db
npm install
npm test

License

The MIT License (MIT)