GitDocumentDB

Offline-first DocumentDB using Git

Use GitDocumentDB to ...

📗 Store JSON documents into Git repository.

🎨 Manage Git repository by PouchDB-like offline-first API.

🚀 Synchronize JSON documents with a remote Git repository.

🐪 Travel history of database snapshots.

API

https://github.com/sosuisen/git-documentdb/blob/main/docs/git-documentdb.gitdocumentdb.md

Usage

Getting started:

Prerequisite

Node.js 10 or later

Installation

npm i git-documentdb

NOTE:
GitDocumentDB uses native addon (libgit2).
If you receive errors about install you probably miss libssl-dev and libkrb5-dev.
In Ubuntu:

sudo apt update
sudo apt install libssl-dev libkrb5-dev

If you are still encountering node-pre-gyp problems, documents about nodegit may also help you.

Import:

import { GitDocumentDB } from 'git-documentdb';

const gitDDB = new GitDocumentDB({
    localDir: 'gddb_data',
    dbName: 'db01', // Git working directory
  });

Basic CRUD:

  // Create repository (gddb_data/db01/.git)
  await gitDDB.open();
  // Create document named 'profile' in gddb_data/db01/
  await gitDDB.put({ _id: 'profile', name: 'Yuzuki', age: '15' });
  // Update
  await gitDDB.put({ _id: 'profile', name: 'Yuzuki', age: '16' });
  // Read
  const doc = await gitDDB.get('profile');
  console.log(doc);  // doc = { _id: 'profile', name: 'Yuzuki', age: '16' }
  // Delete
  await gitDDB.delete('profile');

Advanced:

  // Create documents in sub-directories
  //   gddb_data/db01/Gunma/1 
  //   gddb_data/db01/Gunma/2
  //   gddb_data/db01/Gunma/3
  //   gddb_data/db01/Sapporo/4
  await gitDDB.put({ _id: 'Gunma/1', name: 'Kimari', age: '16' });
  await gitDDB.put({ _id: 'Gunma/2', name: 'Shirase', age: '17' });
  await gitDDB.put({ _id: 'Gunma/3', name: 'Hinata', age: '17' });
  await gitDDB.put({ _id: 'Sapporo/4', name: 'Yuzuki', age: '16' });
  
  // Bulk read
  const docs = await gitDDB.allDocs({ directory: 'Gunma', include_docs: true });
  console.dir(docs, { depth: 3 });
  /* docs = 
  {
    total_rows: 3,
    commit_sha: '39b82ee2458a39023fd9cd098ea6a5486593aceb',
    rows: [
      {
        _id: 'Gunma/1',
        file_sha: 'fae60a86958402b424102f16361a501c561be654',
        doc: { name: 'Kimari', age: '16', _id: 'Gunma/1' }
      },
      {
        _id: 'Gunma/2',
        file_sha: '1255eff6d316a73077468dbda2b026e96fdf00e6',
        doc: { name: 'Shirase', age: '17', _id: 'Gunma/2' }
      },
      {
        _id: 'Gunma/3',
        file_sha: '1f1c89b5253c4feab67a31f8bce1443e3d72512f',
        doc: { name: 'Hinata', age: '17', _id: 'Gunma/3' }
      }
    ]
  } */

Examples:

See examples directory.

$ cd examples
$ npm start

App using GitDocumentDB

https://github.com/sosuisen/inventory-manager

Roadmap

• v0.1 Basic CRUD 🐾(Here now)
• v0.2 Collections
• v0.3 Transaction
• v0.4 Automated sync with GitHub or any other remote git repository
• v0.5 Grep
• v0.6 Move between snapshots (Undo/Redo)
• v0.7 Binary attachments
• v0.8 Indexed search
• v1.0 Official release