@axiosleo/orm-mysql 0.1.0-alpha.1 → 0.1.0-alpha.4

package/README.md

@@ -1,2 +1,85 @@
-# node-orm-mysql
-MySQL ORM tool
+# @axiosleo/orm-mysql
+
+## Installation
+
+```bash
+npm install @axiosleo/orm-mysql
+```
+
+## Usage
+
+```javascript
+const { createClient, QueryHandler } = 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,
+    });
+}
+
+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);
+}
+```
+
+## License
+
+This project is open-sourced software licensed under the [MIT](LICENSE).

package/index.d.ts

@@ -103,6 +103,8 @@ export declare class QueryOperator {
   insert(data?: any): Promise<OkPacket>;
 
   count(): Promise<number>;
+
+  delete(id?: number): Promise<OkPacket>;
 }
 
 export declare class QueryHandler {
@@ -117,6 +119,6 @@ export declare class QueryHandler {
   upsert(tableName: string, data: any, condition: Record<string, ConditionValueType>): Promise<OkPacket>;
 }
 
-export function createClient(options: ConnectionOptions): Connection;
+export function createClient(options: ConnectionOptions, name?: string | null | undefined): Connection;
 
 export function getClient(name: string): Connection;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axiosleo/orm-mysql",
-  "version": "0.1.0-alpha.1",
+  "version": "0.1.0-alpha.4",
   "description": "MySQL ORM tool",
   "keywords": [
     "mysql",

package/src/builder.js

@@ -78,10 +78,6 @@ const _buildValues = (obj) => {
   const values = [];
   Object.keys(obj).forEach((key) => {
     fields.push(`${key}`);
-    if (obj[key] === null) {
-      values.push('NULL');
-      return;
-    }
     if (obj[key] instanceof Date) {
       values.push(obj[key]);
     } else if (Array.isArray(obj[key]) || is.object(obj[key])) {

package/src/query.js

@@ -193,6 +193,14 @@ class QueryOperator {
     this.options.operator = 'count';
     return await this.exec();
   }
+
+  async delete(id) {
+    if (id) {
+      this.where('id', id);
+    }
+    this.options.operator = 'delete';
+    return await this.exec();
+  }
 }
 
 class QueryHandler {