@axiosleo/orm-mysql 0.9.1 → 0.9.2

package/README.md

@@ -197,6 +197,10 @@ try {
 
 ### Migration
 
+> [Migration examples](./examples/migration/).
+
+- Migration script example
+
 ```javascript
 'use strict';
 
@@ -204,14 +208,30 @@ try {
  * @param {import('@axiosleo/orm-mysql').MigrationInterface} migration
  */
 function up(migration) {
-  migration.createDatabase({ database_name: 'demo' });
+  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.dropDatabase({ database_name: 'demo' });
+  migration.dropTable('table1');
 }
 
 module.exports = {
@@ -220,6 +240,50 @@ module.exports = {
 };
 ```
 
+- Generate migration script
+
+```bash
+orm-mysql generate -h
+
+Usage:
+
+  generate [--] [name] <dir>
+  gen
+
+Arguments:
+
+ *name    Migration name
+  dir     Migration scripts directory
+```
+
+- Run migration
+
+```bash
+orm-mysql migrate -h
+
+Description:
+
+  Migrate database
+
+Usage:
+
+  migrate [options] [--] [action] <dir>
+
+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

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.1',
+  version: '0.9.2',
   commands_dir: path.join(__dirname, '../commands'),
 });
 

package/commands/generate.js

@@ -9,7 +9,8 @@ class GenerateCommand extends Command {
   constructor() {
     super({
       name: 'generate',
-      desc: ''
+      desc: '',
+      alias: ['gen']
     });
     this.addArgument('name', 'Migration name', 'required', '');
     this.addArgument('dir', 'Migration scripts directory', 'optional', process.cwd());

package/examples/base_column.js

@@ -0,0 +1,28 @@
+'use strict';
+
+/**
+ * @returns {Record<string, import('@axiosleo/orm-mysql').ColumnItem>}
+ */
+module.exports = {
+  id: {
+    type: 'int',
+    allowNull: false,
+    primaryKey: true,
+    autoIncrement: true
+  },
+  created_at: {
+    type: 'TIMESTAMP',
+    allowNull: false,
+    default: 'CURRENT_TIMESTAMP'
+  },
+  updated_at: {
+    type: 'TIMESTAMP',
+    allowNull: false,
+    default: 'CURRENT_TIMESTAMP',
+    onUpdate: 'CURRENT_TIMESTAMP'
+  },
+  disabled_at: {
+    type: 'TIMESTAMP',
+    allowNull: true
+  }
+};

package/examples/migration/.connect.js

@@ -1,9 +1,16 @@
 'use strict';
 
+const path = require('path');
+
+const dotenv = require('dotenv');
+dotenv.config({
+  path: path.join(__dirname, '../../../.env')
+});
+
 module.exports = {
-  host: 'localhost',
-  port: 13306,
-  user: 'root',
-  password: '3AQqZTfmww=Ftj',
-  database: 'cms'
+  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
 };

package/examples/migration/1706764048.init.js

@@ -0,0 +1,118 @@
+'use strict';
+
+const baseColumn = require('../base_column');
+
+/**
+ * @param {import('@axiosleo/orm-mysql').MigrationInterface} migration
+ */
+function up(migration) {
+  migration.createTable('orgs', {
+    ...baseColumn,
+    code: {
+      type: 'varchar',
+      length: 64,
+      allowNull: false,
+      uniqIndex: true
+    },
+    name: {
+      type: 'VARCHAR',
+      allowNull: false
+    },
+    type: {
+      type: 'VARCHAR',
+      comment: '集团 group;公司 company;',
+      allowNull: false
+    },
+  });
+
+  migration.createTable('account', {
+    ...baseColumn,
+    uuid: {
+      type: 'VARCHAR',
+      length: 36,
+      allowNull: false,
+      uniqIndex: true,
+      comment: 'uuid'
+    },
+    username: {
+      type: 'varchar',
+      length: 64,
+      allowNull: false,
+    },
+    name: {
+      type: 'VARCHAR',
+      length: 100,
+      allowNull: false,
+      comment: '姓名',
+    },
+    avatar: {
+      type: 'VARCHAR',
+      allowNull: true,
+      comment: '头像文件索引'
+    },
+    password: {
+      type: 'varchar',
+      length: 64,
+      allowNull: false
+    },
+    last_token: {
+      type: 'VARCHAR',
+      length: 36,
+      allowNull: true,
+      comment: '最后一次登录的token'
+    }
+  });
+  migration.createIndex('account', ['username asc']);
+
+  migration.createTable('account_orgs', {
+    id: baseColumn.id,
+    account_id: {
+      type: 'int',
+      allowNull: false,
+    },
+    org_id: {
+      type: 'int',
+      allowNull: false,
+    },
+    type: {
+      type: 'varchar',
+      length: 32,
+      allowNull: false,
+      comment: '组织创建者creator;组织管理员admin;组织用户user;',
+      default: 'user'
+    }
+  });
+  migration.createColumn('created_at', 'TIMESTAMP', 'account_orgs');
+  migration.createForeignKey({
+    tableName: 'account_orgs',
+    columnName: 'account_id',
+    reference: {
+      tableName: 'account',
+      columnName: 'id',
+      onDelete: 'CASCADE'
+    }
+  });
+  migration.createForeignKey({
+    tableName: 'account_orgs',
+    columnName: 'org_id',
+    reference: {
+      tableName: 'orgs',
+      columnName: 'id',
+      onDelete: 'CASCADE'
+    }
+  });
+}
+
+/**
+ * @param {import('@axiosleo/orm-mysql').MigrationInterface} migration
+ */
+function down(migration) {
+  migration.dropTable('account_orgs');
+  migration.dropTable('account');
+  migration.dropTable('orgs');
+}
+
+module.exports = {
+  up,
+  down
+};

package/package.json

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

package/src/builder.js

@@ -350,7 +350,7 @@ class ManageSQLBuilder extends Builder {
       table: 'required|string',
       name: 'required|string',
       type: 'required|string',
-      length: 'number',
+      length: 'integer',
       unsigned: 'boolean',
       allowNull: 'boolean',
       default: 'string',
@@ -470,7 +470,6 @@ class ManageSQLBuilder extends Builder {
     _validate(options, {
       name: 'required|string',
       type: 'required|string',
-      default: 'string',
       onUpdate: 'string',
       length: 'integer',
       comment: 'string',

package/examples/migration/20240101.create.table.js

@@ -1,28 +0,0 @@
-'use strict';
-
-/**
- * @param {import('../../').MigrationInterface} migration
- */
-function up(migration) {
-  migration.createTable({
-    table_name: 'organization',
-    columns: [{
-      column_name: 'id',
-      type: 'int(11)',
-      not_null: true,
-      is_primary_key: true,
-    }]
-  });
-}
-
-/**
- * @param {import('../../').MigrationInterface} migration
- */
-function down(migration) {
-  migration.dropTable({ table_name: 'table1' });
-}
-
-module.exports = {
-  up,
-  down
-};

package/examples/migration/20240102.1.create.column.js

@@ -1,14 +0,0 @@
-'use strict';
-
-async function up(migration) {
-
-}
-
-async function down(migration) {
-
-}
-
-module.exports = {
-  up,
-  down
-};

package/examples/migration/20240102.2.create.index.js

@@ -1 +0,0 @@
-'use strict';