File DB is a (very limited) document database that uses directories and files to store its data, supporting nested key-value objects in named collections.
Note: It does not support storage of arrays. Give it objects with keys and values.
The following code assumes you have installed file-db via npm and have this at the top of your file:
varfdb=require('file-db');The main file-db lets you open a database.
To open a connection to the database, use open, passing a path and a callback. The callback receives an error parameter and a connection object.
fdb.open('tmp/example',function(err,db){// . . .// Do your database stuff// . . .});Connection objects allow you to choose a collection to query.
The use method chooses a collection and returns a query object that you can use to query that collection.
varquery=db.use('users');Query objects are tied to a specific collection, allowing you to choose how to query it.
Whatever the query object, you can run it using the exec method:
query.exec(function(err,documents){// Use the documents});The find method sets up the query to retrieve all documents from a collection.
query.find().exec(doSomethingWithIt);The find method sets up the query to retrieve all documents from a collection.
query.findById('some-id').exec(doSomethingWithIt);The save method is an upsert for one document. That means it will create data you give it if it doesn't exist, and will generate an _id for the document if you don't give it one.
If you do give save an _id and the data does exist it will update the document.
save can be called multiple times – it appends to the data you've already added.
db.use('users').save({name: 'Tom'}).exec(doSomething);db.use('users').save({_id: 'abc123'}).save({name: 'Tom'}).exec(doSomething);db.use('users').save({_id: 'abc123',name: 'phuu'}).exec(doSomething);To install file-db, use npm:
npm install file-db
MIT