Mongoose で __v フィールドを使わずにドキュメントのバージョン番号を管理する方法

2024-04-02

Mongoose の __v フィールドとは？

このフィールドは、以下の用途で使用されます。

競合解決

複数のクライアントが同じドキュメントを同時に更新しようとしている場合、__v フィールドを使用して競合を解決できます。更新処理では、ドキュメントの現在のバージョン番号と更新リクエストに含まれるバージョン番号を比較します。バージョン番号が一致する場合のみ、更新が許可されます。

変更追跡

__v フィールドを使用して、ドキュメントがいつ、何回更新されたかを追跡できます。この情報は、監査ログや履歴管理などに役立ちます。

オプティミスティックロック

__v フィールドを使用して、オプティミスティックロックを実装できます。オプティミスティックロックは、データの競合を防止する一種のロック機構です。更新処理では、ドキュメントの現在のバージョン番号と更新リクエストに含まれるバージョン番号を比較します。バージョン番号が一致しない場合、更新処理は失敗し、競合が発生したことが通知されます。

スキーマバージョン管理

Mongoose では、スキーマバージョン管理機能を使用して、スキーマの変更を管理できます。スキーマバージョン管理を使用すると、__v フィールドを使用して、スキーマの変更に伴いドキュメントのバージョン番号を自動的に更新できます。

__v フィールドは、以下の点に注意する必要があります。

__v フィールドは、自動的に生成されるため、ユーザーが直接変更することはできません。
__v フィールドは、整数値です。
__v フィールドは、64ビットまでの整数値を格納できます。
__v フィールドは、MongoDB の _id フィールドとは異なるものです。

Mongoose の __v フィールドは、ドキュメントのバージョン番号を格納するフィールドです。このフィールドは、競合解決、変更追跡、オプティミスティックロック、スキーマバージョン管理などに役立ちます。

__v フィールドを使用する際には、上記の注意点を理解しておくことが重要です。

// Mongoose のスキーマ定義
const mongoose = require('mongoose');

const userSchema = new mongoose.Schema({
  name: String,
  email: String,
  age: Number,
});

// `__v` フィールドは自動的に生成される
userSchema.virtual('__v').get(function() {
  return this._version;
});

// モデルの作成
const User = mongoose.model('User', userSchema);

// 新しいユーザーの作成
const user = new User({
  name: 'John Doe',
  email: '[email protected]',
  age: 30,
});

// ユーザーの保存
user.save(function(err) {
  if (err) {
    console.error(err);
    return;
  }

  // ユーザーの `__v` フィールドは 1 になっている
  console.log(user.__v); // 1
});

// ユーザーの更新
user.name = 'Jane Doe';

// ユーザーの保存
user.save(function(err) {
  if (err) {
    console.error(err);
    return;
  }

  // ユーザーの `__v` フィールドは 2 になっている
  console.log(user.__v); // 2
});

このコードを実行すると、以下の出力が得られます。

1
2

Mongoose でドキュメントのバージョン番号を管理する他の方法

__v フィールドを使用する代わりに、カスタムフィールドを使用してドキュメントのバージョン番号を管理できます。

const mongoose = require('mongoose');

const userSchema = new mongoose.Schema({
  name: String,
  email: String,
  age: Number,
  version: Number,
});

// モデルの作成
const User = mongoose.model('User', userSchema);

// 新しいユーザーの作成
const user = new User({
  name: 'John Doe',
  email: '[email protected]',
  age: 30,
  version: 1,
});

// ユーザーの保存
user.save(function(err) {
  if (err) {
    console.error(err);
    return;
  }

  // ユーザーの `version` フィールドは 1 になっている
  console.log(user.version); // 1
});

// ユーザーの更新
user.name = 'Jane Doe';
user.version++;

// ユーザーの保存
user.save(function(err) {
  if (err) {
    console.error(err);
    return;
  }

  // ユーザーの `version` フィールドは 2 になっている
  console.log(user.version); // 2
});

プログラムでバージョン番号を管理する

__v フィールドやカスタムフィールドを使用せず、プログラムでバージョン番号を管理することもできます。

const mongoose = require('mongoose');

const userSchema = new mongoose.Schema({
  name: String,
  email: String,
  age: Number,
});

// モデルの作成
const User = mongoose.model('User', userSchema);

// 新しいユーザーの作成
const user = new User({
  name: 'John Doe',
  email: '[email protected]',
  age: 30,
});

// ユーザーの保存
user.save(function(err) {
  if (err) {
    console.error(err);
    return;
  }

  // ユーザーのバージョン番号を 1 に設定
  user.version = 1;
});

// ユーザーの更新
user.name = 'Jane Doe';

// ユーザーのバージョン番号を 2 に設定
user.version++;

// ユーザーの保存
user.save(function(err) {
  if (err) {
    console.error(err);
    return;
  }

  // ユーザーのバージョン番号は 2 になっている
  console.log(user.version); // 2
});