Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/axiosleo/node-orm-mysql
MySQL ORM tool
https://github.com/axiosleo/node-orm-mysql
database mysql nodejs orm sql
Last synced: 3 days ago
JSON representation
MySQL ORM tool
- Host: GitHub
- URL: https://github.com/axiosleo/node-orm-mysql
- Owner: AxiosLeo
- License: mit
- Created: 2022-07-19T02:56:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T06:05:14.000Z (25 days ago)
- Last Synced: 2024-11-11T04:04:14.807Z (4 days ago)
- Topics: database, mysql, nodejs, orm, sql
- Language: JavaScript
- Homepage:
- Size: 191 KB
- Stars: 5
- Watchers: 1
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @axiosleo/orm-mysql
[](https://npmjs.org/package/@axiosleo/orm-mysql)
[](https://npmjs.org/package/@axiosleo/orm-mysql)
[](http://nodejs.org/download/)
[](LICENSE)
[](https://app.fossa.com/projects/git%2Bgithub.com%2FAxiosLeo%2Fnode-orm-mysql?ref=badge_shield)
## Installation
```bash
npm install @axiosleo/orm-mysql
```
## Usage
### Create MySQL client
```javascript
const { createClient } = require("@axiosleo/orm-mysql");
const client = createClient({
host: process.env.MYSQL_HOST,
port: process.env.MYSQL_PORT,
user: process.env.MYSQL_USER,
password: process.env.MYSQL_PASS,
database: process.env.MYSQL_DB,
});
```
### Initialize database handler
```javascript
const { QueryHandler } = require("@axiosleo/orm-mysql");
const db = new QueryHandler(client);
```
### Initialize query
```javascript
const query = db.table('');
query.attr("id", "name", "age"); // set attributes
query.where("name", "Joe"); // set where condition
query.orWhere("age", ">", 18); // set or where condition
query.andWhere("age", "<", 30); // set and where condition
query.orderBy("age", "desc"); // set order by
query.limit(10); // set limit
query.offset(0); // set offset
let rows = await query.select(); // select
```
### Some Query Examples
```javascript
const { createClient, QueryHandler, Query } = require("@axiosleo/orm-mysql");
const conn = createClient({
host: process.env.MYSQL_HOST,
port: process.env.MYSQL_PORT,
user: process.env.MYSQL_USER,
password: process.env.MYSQL_PASS,
database: process.env.MYSQL_DB,
});
const hanlder = new QueryHandler(conn);
async function selectExample() {
const query = handler.table("users"); // init QueryOperator by table name
query.attr("id", "name", "age"); // set attributes
query.where("name", "Joe"); // set where condition
query.orWhere("age", ">", 18); // set or where condition
query.andWhere("age", "<", 30); // set and where condition
query.orderBy("age", "desc"); // set order by
query.limit(10); // set limit
query.offset(0); // set offset
let rows = await query.select(); // select
}
async function findExample() {
const query = handler.table("users"); // init QueryOperator by table name
query.attr("id", "name", "age"); // set attributes
query.where("name", "Joe"); // set where condition
query.orWhere("age", ">", 18); // set or where condition
query.andWhere("age", "<", 30); // set and where condition
query.orderBy("age", "desc"); // set order by
// query.limit(10); // not supported set limit
// query.offset(10); // not supported set offset
let row = await query.find(); // find single row
}
async function insertExample() {
const query = handler.table("users");
// insert
let row = await query.insert({
name: "Joe",
age: 18,
});
// The insert operation will be changed to the update operation if the uuid already exists
row = await query.keys('uuid').insert({
uuid: 'uuid-string', // uuid is unique index
name: "Joe",
age: 18,
})
}
async function updateExample() {
const query = handler.table("users");
// update
let row = await query.where("name", "Joe").update({
name: "Joe",
age: 18,
});
}
async function deleteExample() {
const query = handler.table("users");
// delete with conditions
let result = await query.where("name", "Joe").delete();
// delete by id
result = await query.delete(1);
}
async function subqueryExample() {
const query = handler.table("users", "u");
const subQuery = new Query("select");
subQuery.table("users").having("COUNT(*)", ">", 1);
const sql = query.where("u.name", subQuery, "IN").buildSql("select").sql;
// SELECT * FROM `users` AS `u` WHERE `u`.`name` IN (SELECT * FROM `users` GROUP BY `u`.`name` HAVING COUNT(*) > ?)
}
```
### Hook
```javascript
const { Hook } = require("@axiosleo/orm-mysql");
// opt: 'select' | 'find' | 'insert' | 'update' | 'delete' | 'count'
Hook.pre(async (options) => {
debug.log('options', options);
}, { table: 'table_name', opt: 'insert'});
Hook.post(async (options, result) => {
throw new Error('some error');
}, { table: 'table_name', opt: 'insert' });
```
### Transaction
```javascript
const { TransactionHandler, createPromiseClient } = require("@axiosleo/orm-mysql");
const conn = await createPromiseClient({
host: process.env.MYSQL_HOST,
port: process.env.MYSQL_PORT,
user: process.env.MYSQL_USER,
password: process.env.MYSQL_PASS,
database: process.env.MYSQL_DB,
});
const transaction = new TransactionHandler(conn, {
/*
level = 'READ UNCOMMITTED' | 'RU'
| 'READ COMMITTED' | 'RC'
| 'REPEATABLE READ' | 'RR'
| 'SERIALIZABLE' | 'S'
*/
level: "SERIALIZABLE", // 'SERIALIZABLE' as default value
});
await transaction.begin();
try {
// insert user info
// will not really create a record.
let row = await transaction.table("users").insert({
name: "Joe",
age: 18,
});
const lastInsertId = row[0].insertId;
// insert student info
await transaction.table("students").insert({
user_id: lastInsertId,
});
await transaction.commit();
} catch (e) {
await transaction.rollback();
throw e;
}
```
### Migration
> [Migration examples](./examples/migration/).
- Migration script example
```javascript
'use strict';
/**
* @param {import('@axiosleo/orm-mysql').MigrationInterface} migration
*/
function up(migration) {
migration.createTable('table1', {
field1: {
type: 'varchar',
length: 64,
allowNull: false,
uniqIndex: true
},
field2: {
type: 'VARCHAR',
allowNull: false
},
field3: {
type: 'VARCHAR',
comment: 'comment',
allowNull: false
},
});
}
/**
* @param {import('@axiosleo/orm-mysql').MigrationInterface} migration
*/
function down(migration) {
migration.dropTable('table1');
}
module.exports = {
up,
down
};
```
- Generate migration script
```bash
orm-mysql generate -h
Usage:
generate [--] [name]
gen
Arguments:
*name Migration name
dir Migration scripts directory
```
- Run migration
```bash
orm-mysql migrate -h
Description:
Migrate database
Usage:
migrate [options] [--] [action]
Options:
-d, --debug [false] debug mode
--host [localhost] mysql host
--port [3306] port number to connect to the database
--user [root] username for connect to the database
--pass password to connect to the database
--db database name
Arguments:
*action up or down
dir migration directory
```
### Custom query driver
```javascript
const {
createClient,
QueryHandler,
Query,
Builder
} = require("@axiosleo/orm-mysql");
const conn = createClient({
host: process.env.MYSQL_HOST,
port: process.env.MYSQL_PORT,
user: process.env.MYSQL_USER,
password: process.env.MYSQL_PASS,
database: process.env.MYSQL_DB,
});
const hanlder = new QueryHandler(conn, {
driver: 'custom',
queryHandler: (con, options) => {
const builder = new Builder(options);
return new Promise((resolve, reject) => {
if (options.operator === 'select') {
resolve([{ a: 1, b: 2 }]);
} else {
reject(new Error('some error'));
}
});
}
});
```
## License
This project is open-sourced software licensed under [MIT](LICENSE).
[](https://app.fossa.com/projects/git%2Bgithub.com%2FAxiosLeo%2Fnode-orm-mysql?ref=badge_large)