https://github.com/a1k0r/multi-data-source
Node.js library for multiple data sources connection management
https://github.com/a1k0r/multi-data-source
data-sources es6 javascript node-js node-module pg postgres rdbms
Last synced: 2 months ago
JSON representation
Node.js library for multiple data sources connection management
- Host: GitHub
- URL: https://github.com/a1k0r/multi-data-source
- Owner: a1k0r
- License: mit
- Created: 2018-01-29T16:24:03.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-12-05T13:22:12.000Z (over 6 years ago)
- Last Synced: 2025-03-06T04:46:53.765Z (3 months ago)
- Topics: data-sources, es6, javascript, node-js, node-module, pg, postgres, rdbms
- Language: JavaScript
- Homepage:
- Size: 132 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# multi-data-source
> Node.js library which helps developers to manage multiple RDBMS connections to different databases
[![NPM Version][npm-image]][npm-url]
## Installation
```sh
npm install multi-data-source
```
## Features
* Multiple data sources support
* Multiple RDBMS support (only PostgreSQL and MySQL for now, but you feel free to contribute your own connector to favorite RDBMS)
* Named params with [param wrapping module](https://github.com/shikyaro/node-query-template)
## Dependencies
* [pg](https://github.com/brianc/node-postgres) -- Used to handle Postgres connection
* [mysql2](https://github.com/sidorares/node-mysql2) -- Used to handle MySQL connection
* [query-template](https://github.com/shikyaro/node-query-template) -- Used to process queries before execution (templating and parametrizing)
## Usage example
### Storage config example
```js
const config = {
'postgres': {
'host': '127.0.0.1',
'port': 5432,
'database': 'postgres',
'user': 'postgres',
'password': '',
'storageType': 'pg',
},
};
const storage = new Storage(config);
```
### Query definition example
```js
const getUsersByScore = {
name: 'getUsersByScore',
sql: `
SELECT id {{nickname}}
FROM users
WHERE score > :score
{{balance}}
`,
addons: {
noGlobalJoin: {
options: {propertyName: 'global', propertyValue: false},
sql: 'INNER JOIN mega_jackpot_halls AS mjh USING(hall_id)',
},
nickname: {
options: {propertyName: 'needNickname', propertyValue: true},
sql: ', nickname',
},
balance: {
options: {propertyName: 'balanceCondition', propertyValue: true},
sql: 'AND balance >= :balance',
},
},
};
```
### Query execution example
```js
let connection;
try {
connection = await storage.getConnection('postgres');
const data = await connection.query(getUsersByScore,
{
score: 100,
balance: 50,
},
{
templateParams: {balanceCondition: true},
}
);
console.log(data);
} catch (error) {
console.error(error);
} finally {
if (connection) {
await connection.release;
}
}
```
## Configuration guide
### Storage configuration
By default storage conig is semi-equal to [pg](https://github.com/brianc/node-postgres) config with additional field `storageType`.
**Supported storage types:**
* `pg` -- type for PostgreSQL connection
### Query configuration
This library using equal query definition to [query-template](https://github.com/shikyaro/node-query-template)
```js
const query = {
sql: 'SELECT * FROM table', // String with SQL code
addons: { // Object with named additions
addonName: { // Addition object
sql: 'AND field1 = :field1', // String with addition SQL
options: { // Object with addition config
propertyName: 'field1', // Name of templating property
propertyValue: true, // Value of templating property
}
}
}
}
```
## Author
Pavel Romanov -- [email protected] -- [GitHub](https://github.com/Shikyaro)
## License
Distributed under MIT License. See [`LICENSE`](./LICENSE) for more information;
[npm-image]: https://img.shields.io/npm/v/multi-data-source.svg?style=flat-square
[npm-url]: https://npmjs.org/package/multi-data-source