Sequelize(JS)のモデルをJSONに変換!

Sequelize(JS)のモデルを入力するとサンプルJSONを作ります!Sequelize define, DataTypes 対応。API ドキュメントやテスト用のリクエストボディ(sample JSON)に。
Sequelize (JS)
結果
 

Sequelize(JS)のモデルをJSONに変換!

素の JavaScript で書いた Sequelize のモデル(sequelize.define("User", {...}) や Model.init({...}, {...}))を読み取り、例の JSON に変換します。手がかりになる型注釈がないので、各属性の値は DataTypes の指定から決めます。

TypeScript を使わずに Express と Sequelize で動いている古い Node.js サーバーで、API レスポンスやシードの行がどんな形かを説明するものがモデルファイルしかない場合に向いています。

使い方

  1. Sequelize (JS) 欄にモデルファイルを貼り付けます。require の行や module.exports が残っていても構いません。
  2. ファイルで複数のモデルを定義している場合は、{ "User": {...}, "Post": {...} } のようにモデル名をキーにして出力されます。
  3. timestamps、paranoid、名前を変えた createdAt などのモデルオプション(第2引数)が反映されているか確認してから、コピーします。

例

入力 (Sequelize · JavaScript)
class Reservation extends Model {}

Reservation.init(
  {
    code: { type: DataTypes.UUID, defaultValue: DataTypes.UUIDV4, primaryKey: true },
    guests: DataTypes.SMALLINT,
    checkIn: DataTypes.DATEONLY,
    arrivalTime: DataTypes.TIME,
    options: DataTypes.JSONB,
    tags: DataTypes.ARRAY(DataTypes.STRING),
  },
  { sequelize, modelName: "Reservation", updatedAt: false }
);
出力 (JSON)
{
  "code": "00000000-0000-0000-0000-000000000000",
  "guests": 0,
  "checkIn": "1970-01-01",
  "arrivalTime": "00:00:00",
  "options": {},
  "tags": [
    ""
  ],
  "createdAt": "1970-01-01T00:00:00.000Z"
}

code には primaryKey: true があるので id は追加されず、その defaultValue はリテラルではなく生成器の DataTypes.UUIDV4 なので、仮の UUID が表示されます。updatedAt: false によりタイムスタンプは createdAt だけになり、DATEONLY、TIME、JSONB、ARRAY(STRING) はそれぞれ日付の文字列、時刻の文字列、空のオブジェクト、要素1つの配列になります。

対応機能

  • DataTypes.STRING、TEXT、CHAR → ""、INTEGER、BIGINT、FLOAT、DECIMAL → 0、BOOLEAN → false。
  • DATE は 1970-01-01T00:00:00.000Z、DATEONLY は 1970-01-01、TIME は 00:00:00 になります。
  • UUID はすべてゼロの UUID 文字列に、ENUM("admin", "user") は最初の値に、JSON/JSONB は空のオブジェクトになります。
  • ARRAY(DataTypes.STRING) は要素の型に従い、VIRTUAL(DataTypes.STRING) は内側の型から埋めます。
  • モデルオプションの timestamps: false、updatedAt: false、createdAt: "created_on"、paranoid: true に応じて、日付の属性を追加・削除・改名します。
  • 長い形式の { type: ..., allowNull: ... } と短い形式の DataTypes.X のどちらも理解します。

利用シーン

シーダーのデータの下書き

queryInterface.bulkInsert に渡すオブジェクトの配列を書くときに出力から始めれば、キー名と型がモデルと一致します。データベースが埋める id やタイムスタンプは削除してください。

型のないレガシーコードを読み解く

TypeScript がないと、モデルを読むだけでどんな JSON が送られるのかを判断するのは困難です。各モデルファイルをここに通せば、API のレスポンスの形をざっと把握できます。

注意点と制限

  • リテラルの defaultValue("pending"、1、true)はサンプル値になります。DataTypes.NOW、DataTypes.UUIDV4、sequelize.fn(...) のように生成されるデフォルトは、型ごとの仮の値になります。
  • hasMany や belongsTo のような関連はモデル定義の外にあるため、出力には含まれません。include で読み込むデータは手で追加してください。
  • MySQL や PostgreSQL では、実行時に DECIMAL が文字列で返ってくるのが普通ですが、例では 0 と表示されます。
  • GEOMETRY のように明らかなサンプル値のない型は null になります。

よくある質問

underscored: true を設定しているのに、created_at ではなく createdAt なのはなぜですか?

underscored が snake_case にするのはデータベースのカラム名だけです。toJSON() が使う属性名は createdAt のままなので、出力もそれに一致しています。JSON のキーも変えたい場合は、createdAt: "created_at" のように明示的に名前を付けてください。

class User extends Model {} と User.init() が分かれていても使えますか?

使えます。.init( の直前の識別子をモデル名として使い、第1引数を属性のマップとして読み取ります。

TypeScript のデコレーターで書いたモデルはどこで変換しますか?

@Table と @Column を使う sequelize-typescript のモデルには、Sequelize (TS) → JSON のページを使ってください。そちらは DataType ではなくプロパティの型を読み取ります。