@axiosleo/orm-mysql 0.9.12 → 0.9.13

package/README.md

@@ -104,6 +104,13 @@ async function insertExample() {
     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',
+    name: "Joe",
+    age: 18,
+  })
 }
 
 async function updateExample() {

package/bin/orm-mysql.js

@@ -9,7 +9,7 @@ const app = new App({
   name: 'MySQL ORM CLI',
   desc: 'migrate, model, seed, etc.',
   bin: 'orm-mysql',
-  version: '0.9.12',
+  version: '0.9.13',
   commands_dir: path.join(__dirname, '../commands'),
 });
 

package/index.d.ts

@@ -81,6 +81,7 @@ export type QueryOperatorOptions = QueryOperatorBaseOptions & {
   having: WhereOptions[];
   suffix?: string | null;
   transaction: boolean;
+  explain?: boolean;
 }
 
 export declare class Query {
@@ -133,6 +134,23 @@ export declare class Query {
 
 export type QueryResult = any | undefined | RowDataPacket[] | RowDataPacket | MySQLQueryResult;
 
+export type ExplainResult = {
+  select_type: 'PRIMARY' | 'DERIVED';
+  table: string;
+  partitions: string | null;
+  type: string | 'ALL' | 'eq_ref';
+  possible_keys: null | 'PRIMARY';
+  key: null | string;
+  key_len: null | number;
+  ref: null | string;
+  rows: number;
+  filtered: number;
+  Extra: null | string | 'Using filesort';
+
+  id?: number;
+  [property: string]: any;
+};
+
 export declare class QueryOperator extends Query {
   conn: Connection | Pool;
   options: QueryOperatorOptions
@@ -143,6 +161,8 @@ export declare class QueryOperator extends Query {
 
   exec(): Promise<QueryResult>;
 
+  explain(operator: OperatorType): Promise<ExplainResult[]>;
+
   select<T>(...attrs: string[]): Promise<T[]>;
 
   find<T>(): Promise<T>;

package/package.json

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

package/src/builder.js

@@ -120,6 +120,10 @@ class Builder {
         throw new Error('Invalid operator: ' + options.operator);
     }
 
+    if (options.explain) {
+      sql = 'EXPLAIN ' + sql;
+    }
+
     this.sql = sql;
   }
 
@@ -147,8 +151,10 @@ class Builder {
         const builder = new Builder(table.options);
         this.values = this.values.concat(builder.values);
         table = `(${builder.sql})`;
-      }
-      if (alias) {
+        if (alias) {
+          table = `${table} AS \`${alias}\``;
+        }
+      } else if (alias) {
         table = `\`${table}\` AS \`${alias}\``;
       } else {
         table = `\`${table}\``;

package/src/operator.js

@@ -32,6 +32,12 @@ class QueryOperator extends Query {
     return new Builder(this.options);
   }
 
+  async explain(operator) {
+    this.options.operator = operator;
+    this.options.explain = true;
+    return await this.exec();
+  }
+
   async exec() {
     if (!this.options.operator) {
       throw new Error('Invalid operator: ' + this.options.operator);

package/src/query.js

@@ -33,6 +33,7 @@ class Query {
       suffix: null,
       transaction: false,
       keys: null,
+      explain: false,
     };
     this.alias = alias || null;
   }