Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ugate/sqler
🔑Turn your SQL files into executable functions for use in Node.js
https://github.com/ugate/sqler
database nodejs sql sql-files
Last synced: 2 months ago
JSON representation
🔑Turn your SQL files into executable functions for use in Node.js
- Host: GitHub
- URL: https://github.com/ugate/sqler
- Owner: ugate
- License: mit
- Created: 2018-12-07T14:24:11.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T05:19:51.000Z (almost 2 years ago)
- Last Synced: 2024-09-23T11:05:47.072Z (4 months ago)
- Topics: database, nodejs, sql, sql-files
- Language: JavaScript
- Homepage: https://ugate.github.io/sqler
- Size: 1.44 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#  `sqler`
[](https://www.npmjs.com/package/sqler)
[](https://travis-ci.com/ugate/sqler)
[](https://david-dm.org/ugate/sqler)
[](https://david-dm.org/ugate/sqler?type=dev)
`npm install sqler`
Skip the ORM and simplify your SQL execution plans using plain 💯% SQL systax.
`sqler` is a Node.js manager for [RDBMS](https://en.wikipedia.org/wiki/Relational_database) systems that autogenerates/manages SQL execution functions from underlying SQL statement files. Features include:
- [Autogeneration of object paths and prepared statement functions](https://ugate.github.io/sqler/tutorial-1-manual.html) that coincide with SQL file paths
- Debugging options that allow for near real time updates to [SQL files](https://ugate.github.io/sqler/tutorial-1-manual.html#sqlf) without restarting an application
- [Expanded SQL substitutions](https://ugate.github.io/sqler/tutorial-1-manual.html#es), [fragment substitutions](https://ugate.github.io/sqler/tutorial-1-manual.html#fs), [dialect specific substitutions](https://ugate.github.io/sqler/tutorial-1-manual.html#ds) and [version specific substitutions](https://ugate.github.io/sqler/tutorial-1-manual.html#vs)
- [Simplified transaction management](https://ugate.github.io/sqler/tutorial-1-manual.html#tx)
- [Simplified prepared statement management](https://ugate.github.io/sqler/tutorial-1-manual.html#ps)
- [Fast read and write streaming support for __large reads/writes__](https://ugate.github.io/sqler/tutorial-1-manual.html#streams)
- Using SQL vs ORM/API solutions minimizes overhead and maximizes optimal utilization of SQL syntax and DBA interaction and reduces over-fetching that is commonly assocaited with ORM
- Unlike strict ORM/API based solutions, models are generated on the fly- lending itself to a more function centric design
For more details check out the tutorials and API docs!
- [Tutorials](https://ugate.github.io/sqler/tutorial-1-manual.html)
- [API Docs](https://ugate.github.io/sqler/Manager.html)
#### Usage :
In order to use `sqler` a simple implementation of [Dialect](https://ugate.github.io/sqler/Dialect.html) should be supplied. There are a few that have already been written for a few enteprise level applications that make use of `sqler`:
- [SQL Server - `sqler-mssql`](https://ugate.github.io/sqler-mssql)
- [Oracle - `sqler-oracle`](https://ugate.github.io/sqler-oracle)
- [MariaDB and/or MySQL - `sqler-mdb`](https://ugate.github.io/sqler-mdb)
- [PostgreSQL - `sqler-postgres`](https://ugate.github.io/sqler-postgres)
- [ODBC - `sqler-odbc`](https://ugate.github.io/sqler-odbc)
Example Read:
```sql
-- db/finance/read.ap.companies.sql
SELECT CO.COMPANY AS "company", CO.R_NAME AS "name", CO.PAY_GROUP AS "payGroup", CO.TAX_ACCOUNT AS "taxAccount", CO.TAX_ACCT_UNIT AS "taxAcctUnit",
CO.TAX_SUB_ACCT AS "taxSubAcct"
FROM APCOMPANY CO
WHERE CO.INVOICE_AUDIT = :invoiceAudit
ORDER BY CO.COMPANY ASC
```
```js
// replace xxxx with one of the prexisiting vendor implementations
// or roll your own Dialect
const dialect = 'xxxx', dialectModule = `sqler-${dialect}`;
const { Manager } = require('sqler');
const conf = {
"univ": {
"db": {
"myId": {
"host": "myhost.example.com",
"username": "myusername",
"password": "mypassword"
}
}
},
"db": {
"dialects": {
[dialect]: dialectModule
},
"connections": [
{
"id": "myId",
"name": "fin",
"dir": "db/finance",
"service": "MYSRV",
"dialect": dialect
}
]
}
};
const mgr = new Manager(conf);
// initialize connections and set SQL functions
await mgr.init();
console.log('Manager is ready for use');
// execute the SQL statement and capture the results
const rslts = await mgr.db.fin.read.ap.companies({ binds: { invoiceAudit: 'Y' } });
// after we're done using the manager we should close it
process.on('SIGINT', async function sigintDB() {
await mgr.close();
console.log('Manager has been closed');
});
```
Example Write (with implicit transaction):
```sql
-- db/finance/create.ap.companies.sql
INSERT INTO APCOMPANY (COMPANY, R_NAME, PAY_GROUP, TAX_ACCOUNT, TAX_ACCT_UNIT)
VALUES (:company, :name, :payGroup, :taxAccount, :taxAcctUnit);
```
```js
// using the same setup as the read example...
// execute within the an implicit transaction scope
// (i.e. autoCommit === true w/o transaction)
const rslts = await mgr.db.fin.create.ap.company({
autoCommit: true, // <--- could omit since true is default
binds: {
company: 1,
name: 'Company 1',
payGroup: 'MYCO1',
taxAccount: 1234,
taxAcctUnit: 10000000
}
});
```
Example Write (with explicit transaction):
```sql
-- db/finance/create.ap.companies.sql
INSERT INTO APCOMPANY (COMPANY, R_NAME, PAY_GROUP, TAX_ACCOUNT, TAX_ACCT_UNIT)
VALUES (:company, :name, :payGroup, :taxAccount, :taxAcctUnit);
```
```js
// using the same setup as the read example...
// autCommit = false will cause a transaction to be started
const coOpts = {
autoCommit: false,
binds: {
company: 1,
name: 'Company 1',
payGroup: 'MYCO1',
taxAccount: 1234,
taxAcctUnit: 10000000
}
};
// autCommit = false will cause a transaction to be continued
const acctOpts = {
autoCommit: false,
binds: {
company: 2,
name: 'Company 2',
payGroup: 'MYCO2',
taxAccount: 5678,
taxAcctUnit: 20000000
}
};
let tx;
try {
// start a transaction
tx = await mgr.db.fin.beginTransaction();
// set the transaction ID on the execution options
// so the company/account SQL execution is invoked
// within the same transaction scope
coOpts.transactionId = tx.id;
acctOpts.transactionId = tx.id;
// execute within the a transaction scope
// (i.e. autoCommit === false and transaction = tx)
const exc1 = await mgr.db.fin.create.ap.company(coOpts);
// execute within the same transaction scope
// (i.e. autoCommit === false and transaction = tx)
const exc2 = await mgr.db.fin.create.ap.account(acctOpts);
// use the transaction to commit the changes
await tx.commit();
} catch (err) {
if (tx) {
// use the transaction to rollback the changes
await tx.rollback();
}
throw err;
}
```