JSONをSequelize(JavaScript)スキーマに変換!

JSONを入力してSequelize(JavaScript)スキーマに変換します!Sequelize sequelize.define, DataTypes, Node.js, Express 対応。
JSON
結果
 

JSONをSequelize(JavaScript)スキーマに変換!

JSON の行データを、sequelize.define() で定義する Sequelize モデルに変換します。すべてのカラムに DataTypes の型と allowNull フラグが付き、CommonJS のファイルには id の主キー、tableName、timestamps: false が含まれます。

MySQL や PostgreSQL を使う Express サーバーで、テーブルのサンプル行(JSON に書き出したスプレッドシートや外部 API のレスポンス)はあるのに、モデル定義がまだないときに向いています。

使い方

  1. 1行ならオブジェクトで、複数行なら配列で貼り付けます。一部の行で空のカラムがある場合は、allowNull が正しく出るよう複数行を貼り付けてください。
  2. モデル名 を入力します(既定は MyModel)。define と export する変数の両方に使われます。
  3. 出力は require('../db') が Sequelize のインスタンスを返す前提です。このパスを自分の接続モジュールに合わせてから、ファイルを models/ 以下に保存してください。

例

入力 (JSON)
[
  { "email": "kim@example.com", "nickname": "kim", "age": 31, "marketing_opt_in": true, "joined_at": "2023-11-02" },
  { "email": "ana@example.com", "nickname": "ana", "age": null, "marketing_opt_in": false, "joined_at": "2024-01-15" }
]
出力 (Sequelize (JavaScript))
const { Sequelize, DataTypes } = require('sequelize');
const sequelize = require('../db');

const Member = sequelize.define('Member', {
  id: {
    type: DataTypes.INTEGER,
    autoIncrement: true,
    primaryKey: true
  },
  email: {
    type: DataTypes.STRING,
    allowNull: false
  },
  nickname: {
    type: DataTypes.STRING,
    allowNull: false
  },
  age: {
    type: DataTypes.INTEGER,
    allowNull: true
  },
  marketingOptIn: {
    type: DataTypes.BOOLEAN,
    allowNull: false,
    field: 'marketing_opt_in'
  },
  joinedAt: {
    type: DataTypes.DATEONLY,
    allowNull: false,
    field: 'joined_at'
  }
}, {
  tableName: 'MEMBER',
  timestamps: false
});

module.exports = Member;

2人目の会員の age が null なので、allowNull: true が付くのは age だけです。joined_at は時刻のない日付なので DataTypes.DATEONLY になり、属性 joinedAt は field: 'joined_at' で実際のカラムに結び付けられています。

対応機能

  • カラムの型: 整数 → INTEGER(2,147,483,647 を超えると BIGINT)、小数 → DOUBLE、真偽値 → BOOLEAN、YYYY-MM-DD → DATEONLY、日時 → DATE、オブジェクトと配列 → JSON、その他の文字列 → STRING。
  • 数値のカラムになるのは本物の JSON の数値だけで、引用符で囲まれた "01234" は STRING のままです。
  • 属性は camelCase で、キーと異なる場合は必ず field: 'marketing_opt_in' で属性を元のカラム名に対応付けます。
  • JSON に id キーがあれば、2つ目のカラムにはせず主キーにします。整数なら autoIncrement が付き、UUID のような文字列なら単なる STRING のキーになります。なければ自動採番の INTEGER の id を追加します。
  • どこかの行で null や値の欠落があると allowNull: true になります。これはカラムの型には影響しません。
  • UserProfile という名前のモデルには tableName: 'USER_PROFILE' と timestamps: false が付くので、createdAt/updatedAt カラムは前提になりません。

利用シーン

既存のテーブルにモデルを付ける

DB クライアントで SELECT ... LIMIT 5 の結果を JSON としてエクスポートして貼り付ければ、カラムの順序、NULL 許可、snake_case のカラム名が反映された define のコードが得られます。sequelize-auto を入れずにテーブル1つだけマッピングしたいときに便利です。

`sequelize.sync()` でテスト用テーブルを作る

プロトタイプ段階なら、サンプル JSON からモデルを作り、sync() でローカルの SQLite や MySQL にテーブルを作成してから、bulkCreate でシードデータを入れられます。

注意点と制限

  • DataTypes.STRING の既定は VARCHAR(255) です。長いテキストは DataTypes.TEXT に変えてください。
  • DATEONLY の値は Date オブジェクトではなく、'2023-11-02' のような文字列で返ってきます。
  • DataTypes.JSON は MySQL、MariaDB、PostgreSQL、SQLite で使えますが MSSQL では使えません。PostgreSQL では通常 DataTypes.JSONB のほうが適しています。
  • tableName は大文字(MEMBER)です。PostgreSQL や Linux 上の MySQL のように大文字・小文字を区別する環境では、実際のテーブル名と完全に一致させる必要があります。
  • 金額は浮動小数点の丸め誤差を避けるため、DOUBLE を DataTypes.DECIMAL(12, 2) に置き換えてください。

よくある質問

クラスベースの Model.init() スタイルで出力できますか?

このページが生成するのは sequelize.define() だけです。属性オブジェクトはどちらのスタイルでも同じなので、class Member extends Model {} を宣言し、同じオブジェクトを Member.init(attributes, { sequelize, tableName: 'MEMBER' }) に渡してください。TypeScript なら JSON → Sequelize (TS) のページを使ってください。

カラムが allowNull: false なのに、空文字列が入ってしまいます。

allowNull が防ぐのは SQL の NULL だけです。空文字列も拒否するには、属性に validate: { notEmpty: true } を追加してください。

underscored: true ではなく属性ごとに field を付けるのはなぜですか?

underscored は camelCase を snake_case に変えるだけなので、home-url のようなキーや、もともと camelCase のカラムは対応付けられません。field を明示すれば、スタイルに関係なく JSON のキーをそのままカラム名として保てます。