Sequelizeのraw: trueとget({ plain: true })の違い

SequelizeはNode.jsのORM（オブジェクト・リレーショナル・マッピング）ツールで、データベース操作を簡単に行うための多くの機能を提供しています。

その中で、クエリ結果のフォーマットに関するオプションであるraw: trueとget({ plain: true })というオプションの違いと使い分けについて解説します。

raw: trueとは？

raw: trueはSequelizeのクエリオプションの一つで、クエリ結果を生のJavaScriptオブジェクトとして返すことを指示します。これにより、Sequelizeのモデルインスタンスとしてではなく、純粋なデータベースの結果として取得できます。

const results = await User.findAll({
  where: { status: 'active' },
  raw: true
});

console.log(results);
// 出力: [{ id: 1, name: 'John Doe', status: 'active' }, { id: 2, name: 'Jane Doe', status: 'active' }]

上記の例では、resultsはモデルインスタンスではなく、純粋なJavaScriptオブジェクトの配列になります。この方法は、Sequelizeの余分なメタデータやメソッドが不要な場合に有用です。

get({ plain: true })とは？

get({ plain: true })はSequelizeモデルインスタンスのメソッドで、特定のインスタンスを純粋なJavaScriptオブジェクトとして取得するために使用されます。
これにより、そのインスタンスのデータのみを含むオブジェクトを取得できます。

const user = await User.findOne({
  where: { id: 1 }
});

console.log(user.get({ plain: true }));
// 出力: { id: 1, name: 'John Doe', status: 'active' }

この場合、userはまずモデルインスタンスとして取得され、その後にget({ plain: true })を呼び出すことで、純粋なデータオブジェクトに変換されます。
この方法は、クエリ結果を最初にモデルインスタンスとして操作したいが、最終的にはシンプルなオブジェクトとして扱いたい場合に有用です。

raw: trueとget({ plain: true })の違い

使用タイミング

raw: true: クエリ実行時に直接適用し、結果を生のJavaScriptオブジェクトとして取得します。

get({ plain: true }): 既に取得したモデルインスタンスに対して適用し、シンプルなオブジェクトを取得します。

結果の型

raw: true: 結果は常に純粋なオブジェクトの配列。

get({ plain: true }): 結果は個々のモデルインスタンスから変換された純粋なオブジェクト。

メタデータやメソッドの有無

raw: true: メタデータや追加のメソッドは含まれません。

get({ plain: true }): 元のモデルインスタンスに存在するメタデータやメソッドは除外されます。

使い分けのポイント

軽量な結果が欲しい場合

raw: trueは、結果を純粋なデータオブジェクトとしてそのまま取得したい場合に有効です。
例えば、大量のデータを一度に処理する場合や、クエリ結果をそのままフロントエンドに渡す場合などに適しています。

インスタンスのメソッドを利用したい場合

クエリ結果をモデルインスタンスとして操作したい場合は、まずインスタンスとして取得し、その後必要に応じてget({ plain: true })を使用してシンプルなオブジェクトに変換します。
これにより、インスタンスのメソッドやプロトタイプチェーンを活用できます。