@axiosleo/orm-mysql 0.2.0 → 0.2.1

package/.prettierignore

@@ -0,0 +1 @@
+README.md

package/README.md

@@ -8,75 +8,124 @@ 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('<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
+```
+
+### Some Examples
+
 ```javascript
-const { createClient, QueryHandler } = require('@axiosleo/orm-mysql');
+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,
+  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
+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
+  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
+  let rows = await query.select(); // select
 }
 
-async function findExample(){
-    const query = handler.table('users');  // init QueryOperator by table name
+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
+  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
+  let row = await query.find();         // find single row
 }
 
-async function insertExample(){
-    const query = handler.table('users');
+async function insertExample() {
+  const query = handler.table("users");
 
-    // insert
-    let row = await query.insert({
-        name: 'Joe',
-        age: 18,
-    });
+  // insert
+  let row = await query.insert({
+    name: "Joe",
+    age: 18,
+  });
 }
 
-async function updateExample(){
-    const query = handler.table('users');
+async function updateExample() {
+  const query = handler.table("users");
 
-    // update
-    let row = await query.where('name','Joe').update({
-        name: 'Joe',
-        age: 18,
-    });
+  // update
+  let row = await query.where("name", "Joe").update({
+    name: "Joe",
+    age: 18,
+  });
 }
 
-async function deleteExample(){
-    const query = handler.table('users');
+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);
+}
 
-    // delete with conditions
-    let result = await query.where('name','Joe').delete();
+async function subqueryExample() {
+  const query = hanlder.table("users", "u");
+  const subQuery = new Query("select");
+  subQuery.table("users").having("COUNT(*)", ">", 1);
 
-    // delete by id
-    result = await query.delete(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(*) > ?)
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axiosleo/orm-mysql",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "MySQL ORM tool",
   "keywords": [
     "mysql",

package/src/builder.js

@@ -36,6 +36,9 @@ class Builder {
       case 'update': {
         const fields = this._buildValues(options.data);
         sql = `UPDATE ${this._buildTables(options.tables)} SET ${fields.map(f => `${this._buildFieldKey(f)} = ?`).join(',')}`;
+        if (!options.conditions.length) {
+          throw new Error('At least one condition is required for update operation');
+        }
         sql += this._buildContidion(options.conditions);
         break;
       }