micro-db

micro-db is a lightweight, file-based, zero config database for nodejs.

For the full documentation please see micro-db.fabiankachlock.dev.

Why micro-db

☁️ Lightweight
⚡️ Performant
⌛️ Instant Persistent
🔎 Debuggable
✨ Typescript Support
⚙️ Zero Config
🛠 Expandable
🔌 Easily Replaceable
Read more ...

Installation

npm i node-micro-db

yarn add node-micro-db

🪄 Quickstart

type User = {
	name: string;
	age: number;
};

const db = new MicroDB<User>();

const idOfJohn = db.create({ name: 'john', age: 23 });

// john's birthday
db.update(idOfJohn, { age: 24 });

// select with id
const john = db.select(idOfJohn);
// john.name = 'john'
// john.age = 24

// select without id
const john1 = db.selectWhere(user => user.name === 'john');
// john1.name = 'john'
// john1.age = 24

For more information about available methods, check out the API

Patterns

Facade Pattern

micro-db encourages you, to hide bare-bones database operations, like select or update statements from the rest of you application using the Facade pattern

To implement this in your code, you can extend the MicroDBFacade class. The MicroDBFacade provides the same api as a MicroDBDriver, but all methods are protected, which means they are inaccessible from outside of the class.

The example below shows how straight forward this approach is:

Example

export class UserDB extends MicroDBFacade<UserDBEntry> {
  // 1. create the db instance
  private static db = new UserDB({ fileName: 'db/users.db' });

  // 2. expose shutdown function
  static shutdown = UserDB.db.shutdown;

  // 3. define complex database operations
  static logout = (userId: string) => {
    const userRecord = UserDB.db.select(userId);
    // ...
    UserDB.db.update(userId, {
      //...
    });
  };
}

// 4. usage
UserDB.logout('some-user-id');

Example (using instance methods rather than static ones)

export class UserDB extends MicroDBFacade<UserDBEntry> {
  constructor() {
    // 1. construct db instance
    super({ fileName: 'db/users.db' });
  }
  // 2. expose shutdown function
  shutdown = () => this.db.close();

  // 3. define complex database operations
  logout = (userId: string) => {
    const userRecord = this.db.select(userId);
    // ...
    this..db.update(userId, {
      //...
    });
  };
}

// 4. usage
const db = new UserDB();
db.logout('some-user-id');

id-aware Records

Sometimes, you need your database records to be aware of their id. This is mainly the case, when otherwise heavy select statements are needed to query some commonly used data. Implementing this with micro-db is very easy (and works best with the Facade Pattern).