shangwa_db v1.0.4

Shangwa DB

NOTE: Shangwa DB is still in BETA feedback would be appriciated!

Shangwa DB is a NO-SQL document data store that programmers can use during testing and development. There are situations where you might want to test your app using a mock or fake database, Shangwa DB is there for you.

1. Its local so there is no need to make metwork calls which can be slow
2. It can be git ignored (optional) to reduce the bloat of your git repository
3. Easy to use api

Database Heirachy

Database -> Clusters -> Documents

API

Creating a database

// Initializing a database
const db = createDatabase({
    name : 'test-db',
});

The following directory is automatically created for you but you don't have to ever touch it! JUst know that thats where your database leaves

-- .local
    |
    -- test_db

Creating a Collection

    // Creates a collection called users 
    const usersCol = db.createCollection({
        name : 'users'
    })

Inserting a single document

Method 1 : Using a class

    // Define a class representing your json object 

    @JsonEntity
    class User {
        [x: string]: any;
        constructor(
            public id : string,
            public username : string,
            public password : string,
        )
    }

    // create an instance of your user class
    const newUser = new User('tadiwa', '12345678');

    // Insert the doc
    usersCol.insertDoc(newUser.toDb())

2. Alternative

    useersCol.insertDoc({
        username : 'tadiwa',
        password : '12345678'
    })

Deleted a doc

    const docID = 'user-1';

    usersCol.deleteDoc(docId)

Updated A document

    const docID = 'user-1';
    const newData = {
        username : 'tadiwa',
        password: 'i_hate_typescript'
    }

    usersCol.updateDoc(docId)

Getting a document

    const docID = 'user-1';

    usersCol.getDocData(docId)

Getting a document using the where clause

    const username = 'tadiwa';
    usersCol.getDocWhere('username', 'tadiwa')

Getting all the documents

    const docs = usersCol.getAllDocs();

    console.log(docs)