Kysely项目中使用MySQL数据库的迁移问题解析

问题背景

在使用Kysely这个TypeScript SQL查询构建器时，开发者遇到了一个关于MySQL数据库迁移的常见问题。具体表现为在创建用户表时，迁移脚本执行失败并报出SQL语法错误。

错误分析

原始迁移脚本尝试创建一个包含UUID主键的用户表，但在MySQL环境中执行时出现了语法错误。核心问题在于：

1. 数据类型不匹配：MySQL原生不支持uuid作为列数据类型
2. 时间戳设置：开发者希望自动设置创建时间和更新时间

MySQL数据类型解决方案

MySQL与PostgreSQL等其他数据库不同，它没有原生的UUID数据类型。在MySQL中创建主键的推荐做法是：

1. 使用自增整数作为主键
2. 或者使用CHAR(36)存储UUID字符串

自增主键实现方案

.addColumn('id', 'integer', (col) => 
  col.unsigned().notNull().autoIncrement().primaryKey()
)

UUID存储方案

如果需要存储UUID，可以使用字符串类型：

.addColumn('id', 'varchar(36)', (col) => 
  col.notNull().primaryKey()
)

时间戳自动管理

MySQL中实现自动时间戳管理有两种方式：

1. 创建时间：使用DEFAULT CURRENT_TIMESTAMP
2. 更新时间：使用ON UPDATE CURRENT_TIMESTAMP

Kysely实现代码

.addColumn('created_at', 'timestamp', (col) =>
  col.defaultTo(sql`CURRENT_TIMESTAMP`).notNull()
)
.addColumn('updated_at', 'timestamp', (col) =>
  col
    .defaultTo(sql`CURRENT_TIMESTAMP`)
    .modifyEnd(sql`ON UPDATE CURRENT_TIMESTAMP`)
    .notNull()
)

完整迁移脚本示例

import { Kysely, sql } from 'kysely';

const userTableName = 'user';

export async function up(database: Kysely<unknown>): Promise<void> {
  await database.schema
    .createTable(userTableName)
    .addColumn('id', 'integer', (col) => 
      col.unsigned().notNull().autoIncrement().primaryKey()
    )
    .addColumn('email', 'varchar(255)', (col) => 
      col.notNull().unique()
    )
    .addColumn('password', 'varchar(255)', (col) => 
      col.notNull()
    )
    .addColumn('created_at', 'timestamp', (col) =>
      col.defaultTo(sql`CURRENT_TIMESTAMP`).notNull()
    )
    .addColumn('updated_at', 'timestamp', (col) =>
      col
        .defaultTo(sql`CURRENT_TIMESTAMP`)
        .modifyEnd(sql`ON UPDATE CURRENT_TIMESTAMP`)
        .notNull()
    )
    .addColumn('deleted_at', 'timestamp')
    .execute();
}

最佳实践建议

1. 数据库兼容性：编写迁移脚本时应考虑目标数据库的特有语法
2. 列长度定义：对于varchar类型，建议明确指定长度
3. 空值处理：明确标记可为空的列
4. 索引设计：对于频繁查询的列考虑添加索引

通过理解MySQL的数据类型特性和Kysely的API使用方式，开发者可以编写出健壮可靠的数据库迁移脚本。