$unset

定義

$unset

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

互換性

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

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

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

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

構文

次の構文を考えてみましょう。

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

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

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

動作

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

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

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

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

例

products コレクションを次のように作成します。

db.products.insertMany( [
   { "item": "chisel", "sku": "C001", "quantity": 4, "instock": true },
   { "item": "hammer", "sku": "unknown", "quantity": 3, "instock": true },
   { "item": "nails", "sku": "unknown", "quantity": 100, "instock": true }
] )

sku の値が unknown である products コレクション内の最初のドキュメントを更新します。

db.products.updateOne(
   { sku: "unknown" },
   { $unset: { quantity: "", instock: "" } }
)

updateOne() は $unset 演算子を使用して次の操作を実行します。

• quantity フィールドを削除する

• instock フィールドを削除する

{
  item: 'chisel',
  sku: 'C001',
  quantity: 4,
  instock: true
},
{
  item: 'hammer',
  sku: 'unknown'
},
{
  item: 'nails',
  sku: 'unknown',
  quantity: 100,
  instock: true
}