• Datasource
  • How to Use
    • MySQLPoolConnection
    • PGPoolConnection
    • MongoDBConnection
    • DynamoDBConnection
    • PrismaConnection
    • SequelizeConnection
  • Available Methods
  • Custom Connection

#Datasource

SDK comes with wrappers around different node modules for connecting to different database engines in a single interface named Connection.

The Datasource module is used by Default Repositories as well as its underlying database connection service.

#How to Use

The SDK currently supports the following connections:

• MySQLPoolConnection (mysql2)
• PGPoolConnection (pg)
• MongoDBConnection (mongodb)
• DynamoDBConnection (aws-sdk)
• PrismaConnection (prisma)
• SequelizeConnection (sequelize)

#MySQLPoolConnection

Installing dependencies:

    npm i mysql2 -S

• Official Documents

import { Datasource } from "@ssofy/node-sdk";
import mysql from "mysql2/promise";
...
const pool = mysql.createPool({
    host: 'localhost',
    port: 3306,
    user: 'root',
    password: 'root',
    database: 'db',
    waitForConnections: true,
    connectionLimit: 10,
    maxIdle: 10,
    idleTimeout: 60000,
    queueLimit: 0,
    enableKeepAlive: true,
    keepAliveInitialDelay: 0
});

const connection = new Datasource.MySQLPoolConnection(pool)

#PGPoolConnection

Installing dependencies:

    npm i pg -S

• Official Documents

import { Datasource } from "@ssofy/node-sdk";
import { Pool } from 'pg';
...
const pool = new Pool({
    host: 'localhost',
    user: 'database-user',
    max: 20,
    idleTimeoutMillis: 30000,
    connectionTimeoutMillis: 2000,
})

const connection = new Datasource.PGConnection(pool)

#MongoDBConnection

Installing dependencies:

    npm i mongo -S

• Official Documents

import { Datasource } from "@ssofy/node-sdk";
import { MongoClient } from "mongodb";
...
const uri = "<connection string uri>";
const client = new MongoClient(uri);

const database = client.db('db');

const connection = new Datasource.MongoDBConnection(database)

#DynamoDBConnection

Installing dependencies:

    npm i aws-sdk -S

• Official Documents

import { Datasource } from "@ssofy/node-sdk";
import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
import { DynamoDBDocumentClient, GetCommand } from "@aws-sdk/lib-dynamodb";
...
const client = new DynamoDBClient({});
const docClient = DynamoDBDocumentClient.from(client);

const connection = new Datasource.DynamoDBConnection(docClient);

#PrismaConnection

Installing dependencies:

    npm i prisma -S

• Official Documents

import { Datasource } from "@ssofy/node-sdk";
import { PrismaClient } from '@prisma/client'
...
const prisma = new PrismaClient()

const connection = new Datasource.PrismaConnection(prisma);

#SequelizeConnection

Installing dependencies:

    npm i sequelize -S

• Official Documents

import { Datasource } from "@ssofy/node-sdk";
import { Sequelize, DataTypes } from 'sequelize';
...
const sequelize = new Sequelize('sqlite::memory:');

const connection = new Datasource.SequelizeConnection(sequelize);

#Available Methods

Checkout the Connection interface for the list of available methods.

• Connection Interface

#Custom Connection

You may also build your own custom datasource connection by implementing the Connection Interface.