@andrelas1/db-driver v1.1.3

ATTENTION

WORK IN PROGRESS - This is half done. I didn't continue this project so if you want to use it, bear in mind that this is an unfinished product.

DATABASE DRIVER

Wraps common CRUD functionalities of MongoDB, MySQL, PostgreSQL and LocalStorage (Browser) to a single API, adding more consistency and using the power of the RxJS library.

Currently only supports MongoDB

future support:

• LocalStorage
• MySQL
• PostgreSQL

Stack

• NodeJS
• RxJS
• MongoDB NodeJS Driver
• MySQL
• LocalStorage (Browser)
• PostgreSQL

The purpose

This package exposes one class, DatabaseDriver. This is the main module and has the goal to expose a common interface for CRUD operations, regardless of the database client being used. Therefore, it is not needed to know how the MongoDB or MySQL node driver works. In addition to that, this driver is best used in simple web APIs due to its simplicity.

Another important point to mention is the usage of RxJS. Due to the async nature of CRUD operations in databases, those will probably rely more on promises, which may cause some issues for development purposes, such as multiple callbacks with different function signatures, different return types and callback chaining. Observables in RxJS provide a common interface to work with, where the callbacks will always respect the same signatures. Due to this common interface (the brilliant idea behind RxJS), the developer has more freedom in how the observables can be used. Finally, there is no callback chaining (or callback hell), which is another plus.

Installation

npm install --save @andrelas1/db-driver

Requirements

NodeJS: 10+ TypeScript: 3.7.2+ MongoDB: 4.2.1+

How to use

Setup your Database

• MongoDB: MongoDB LTS has to be up and running.
• Browser's localStorage: TBD.
• MySQL: TBD.
• PostgreSQL: TBD.

Instantiate the dbDriver object

import { DatabaseDriver } from '@andrelas1/db-driver';

const dbDriver = new DatabaseDriver(
    'mongodb', // database type -> 'mongodb' | 'localStorage' | 'mysql' | 'postgresql'
    {
        url: 'mongodb://localhost:27017' // db url
        username?: 'db-login-username', // username
        password?: '**\*\***' // password
    },
    options // usually, db clients exposes a config object. Since this still only supports mongo, this is equivalent to the MongoClientOptions
);

Execute CRUD operations

Every CRUD operation returns an observable of the updated collection. The collection is the list of items. Moreover, for better experience, the CRUD method can get a type via TS generics, just like the following:

• write data to the db

dbDriver
  .insert<{ foo: string }>("mydbname", "mycollection", { foo: "bar" })
  .pipe(
    catchError(err => {
      //handle error
      return of([]);
    })
  )
  .subscribe((col: Array<{ foo: string }>) => {
    // do something
  });

It is also possible to provide a list of objects, such as:

dbDriver.insert<MyItemType>("mydbname", "mycollection", [
  { foo: "bar" },
  { foo: "foobar" }
]);

• read data from the db

dbDriver.read<MyItemType>('mydbname', 'mycollection')
    .pipe(
        catchError(err => {
            // handle error
            return of([]);
        })
    )
    .subscribe((col: Array<{foo: string}>) => { // do something })

• delete data from the db

dbDriver.delete<MyItemType>('mydbname', 'mycollection', { foo: 'bar' })
    .pipe(
        catchError(err => {
            // handle error
            return of([]);
        })
    )
    .subscribe((col: Array<{foo: string}>) => { // do something })

Delete can only receive one object.

• delete all data from the db

dbDriver
  .deleteAll("mydbname", "mycollection")
  .pipe(
    catchError(err => {
      // handle error
      return of([]);
    })
  )
  .subscribe((col: any[]) => {
    // do something
  });

• update data from the db

dbDriver
  .update<MyItemType>(
    "mydbname",
    "mycollection",
    { foo: "bar" },
    { foo: "foobar" }
  )
  .pipe(
    catchError(err => {
      // handle error
      return of([]);
    })
  )
  .subscribe((col: Array<{ foo: string }>) => {
    // do something
  });

License

MIT

Contributions

TBD

ROADMAP

1. Document explaining release process (CI/CD). Github release.
2. Implement CI/CD.
3. Fix multiple connections issue.
4. Enable username/password for MongoDB.
5. Declaration file for DatabaseDriver. Do not rely on the declaration files created by typescript.
6. Decide about architecturing based on database events. Every CRUD operation is an event and it is observed by an observer.
7. LocalStorage (and how does third party apps bundle this package?).
8. MySQL.
9. PostgreSQL.