schema-dsl

    MySQL 导出器文档

    模块: src/exporters/MySQLExporter.ts

    用途: 将 JSON Schema 转换为 MySQL CREATE TABLE 语句

    📑 目录

    概述

    MySQLExporter 将 schema-dsl 生成的 JSON Schema 转换为 MySQL 的 DDL 语句，包括 CREATE TABLE 和索引创建语句。

    核心功能

    • ✅ 生成 CREATE TABLE DDL 语句
    • ✅ 自动类型映射（JSON Schema → MySQL）
    • ✅ 支持 NOT NULL、DEFAULT、COMMENT
    • ✅ 自动检测主键
    • ✅ 生成索引 DDL
    • ✅ 可配置存储引擎和字符集

    快速开始

    const { dsl, exporters } = require('schema-dsl');

// 1. 定义 Schema
const userSchema = dsl({
  id: 'string!',
  username: 'string:3-32!',
  email: 'email!',
  age: 'number:18-120',
  status: 'active|inactive'
});

// 2. 创建导出器
const exporter = new exporters.MySQLExporter();

// 3. 导出为 MySQL DDL
const ddl = exporter.export('users', userSchema);
console.log(ddl);

    输出：

    CREATE TABLE `users` (
  `id` VARCHAR(255) NOT NULL,
  `username` VARCHAR(32) NOT NULL,
  `email` VARCHAR(255) NOT NULL,
  `age` DOUBLE NULL,
  `status` VARCHAR(255) NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

    API 参考

    构造函数

    new MySQLExporter(options)

    参数：

    参数类型默认值说明
    options.enginestring'InnoDB'存储引擎
    options.charsetstring'utf8mb4'字符集
    options.collatestring'utf8mb4_unicode_ci'排序规则

    方法

    export(tableName, jsonSchema)

    生成 MySQL CREATE TABLE 语句。

    const ddl = exporter.export('users', userSchema);

    参数：

    • tableName (string): 表名
    • jsonSchema (Object): JSON Schema 对象（必须是 object 类型）

    返回值：

    • string: MySQL DDL 语句

    generateIndex(tableName, columnName, options)

    生成索引创建语句。

    const indexDdl = exporter.generateIndex('users', 'email', { unique: true });
console.log(indexDdl);
// CREATE UNIQUE INDEX `idx_users_email` ON `users` (`email`);

    参数：

    • tableName (string): 表名
    • columnName (string): 列名
    • options.name (string): 索引名（可选，默认 idx_表名_列名）
    • options.unique (boolean): 是否唯一索引（默认 false）

    MySQLExporter.export(tableName, jsonSchema) (静态方法)

    快速导出，无需实例化。

    const ddl = exporters.MySQLExporter.export('users', userSchema);

    配置选项

    存储引擎

    // 使用 MyISAM 引擎
const exporter = new exporters.MySQLExporter({
  engine: 'MyISAM'
});

    字符集配置

    // 使用 utf8 字符集
const exporter = new exporters.MySQLExporter({
  charset: 'utf8',
  collate: 'utf8_general_ci'
});

    完整示例

    用户表 DDL 生成

    const { dsl, exporters } = require('schema-dsl');

// 定义用户 Schema（带描述）
const userSchema = dsl({
  id: 'string!',
  username: 'string:3-32!'
    .description('用户登录名'),
  email: 'email!'
    .description('用户邮箱'),
  password: 'string:8-64!',
  age: 'number:0-150',
  status: 'active|inactive|banned',
  createdAt: 'datetime!'
});

// 生成 DDL
const exporter = new exporters.MySQLExporter();
const ddl = exporter.export('users', userSchema);

console.log(ddl);

// 生成索引
console.log(exporter.generateIndex('users', 'email', { unique: true }));
console.log(exporter.generateIndex('users', 'username', { unique: true }));
console.log(exporter.generateIndex('users', 'status'));

    输出：

    CREATE TABLE `users` (
  `id` VARCHAR(255) NOT NULL,
  `username` VARCHAR(32) NOT NULL COMMENT '用户登录名',
  `email` VARCHAR(255) NOT NULL COMMENT '用户邮箱',
  `password` VARCHAR(64) NOT NULL,
  `age` DOUBLE NULL,
  `status` VARCHAR(255) NULL,
  `createdAt` DATETIME NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

CREATE UNIQUE INDEX `idx_users_email` ON `users` (`email`);
CREATE UNIQUE INDEX `idx_users_username` ON `users` (`username`);
CREATE INDEX `idx_users_status` ON `users` (`status`);

    类型映射

    JSON Schema 类型格式/约束MySQL 类型
    string-VARCHAR(255)
    stringmaxLength: 50VARCHAR(50)
    stringmaxLength: 500TEXT
    stringformat: emailVARCHAR(255)
    stringformat: date-timeDATETIME
    integermaximum: 127TINYINT
    integermaximum: 32767SMALLINT
    integermaximum: 2147483647INT
    integer-BIGINT
    number-DOUBLE
    boolean-BOOLEAN
    object-JSON
    array-JSON

    约束映射

    约束MySQL 处理
    requiredNOT NULL
    非 requiredNULL
    defaultDEFAULT value
    descriptionCOMMENT 'text'

    主键检测

    导出器会自动检测以下字段作为主键：

    1. 名为 id 的字段
    2. 名为 _id 的字段

    如果存在这些字段，会自动添加 PRIMARY KEY 约束。

    导出限制

    ⚠️ 重要提示: MySQL 对约束的支持有限。

    MySQL 不支持的特性:

    • ❌ 正则表达式约束（pattern）
    • ❌ 数值范围约束（minimum/maximum）
    • ❌ 枚举 CHECK 约束（导出为普通 VARCHAR）
    • ❌ 字符串最小长度（minLength）
    • ❌ 条件验证逻辑（dsl.match(), dsl.if()）

    详细说明: 请阅读 导出限制说明文档

    相关文档

    对应示例文件

    示例入口: mysql-exporter.ts
    说明: 覆盖 export() 生成 DDL、主键检测，以及 generateIndex() 生成普通/唯一索引。