$unset（更新演算子）

定義

$unset

$unset演算子は特定のフィールドを削除します。

互換性

次の環境でホストされる配置には $unset を使用できます。

• MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです

• MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン

• MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

構文

$unset 演算子は次の形式をとります。

{ $unset: { <field1>: "", ... } }

$unset 式で指定される値（""）は操作に影響しません。

<field> を埋め込みドキュメントまたは配列で指定するには、ドット表記を使用します。

動作

MongoDB 5.0 以降、更新演算子では名前が文字列ベースのドキュメントフィールドを辞書順に処理します。数値名のフィールドは、数値順に処理されます。詳細については、「更新演算子の動作」を参照してください。

フィールドが存在しない場合、 $unsetは何も行いません（つまり、操作はありません）。

配列要素を一致させるために $ と併用される場合、$unset は一致する要素を配列から削除するのでなく、一致する要素を null に置き換えます。この動作により、配列のサイズと要素の位置の一貫性が保たれます。

MongoDB 5.0 以降、$unsetなどの更新演算子を空のオペランド式（{ }）と併用しても、mongod でエラーが発生しなくなりました。空の更新を使用すると変更は一切されず、oplog エントリも作成されません（操作は実行されません）。

例

このページの例では、sample_mflixサンプルデータセットのデータを使用します。このデータセットを自己管理型MongoDB配置にロードする方法の詳細については、サンプルデータセットをロードする を参照してください。サンプルデータベースに変更を加えた場合、このページの例を実行するには、データベースを削除して再作成する必要がある場合があります。

次の例では、$unset 演算子を使用して、一致する映画ドキュメントから label フィールドと status フィールドを除去します。

db.movies.updateOne(
   { title: "The Dark Knight" },
   { $unset: { label: "", status: "" } }
)

この操作では、次の結果を返します。

{
  acknowledged: true,
  insertedId: null,
  matchedCount: 1,
  modifiedCount: 1,
  upsertedCount: 0
}