MongoDBの集計（aggregation）で_idフィールドを非表示にする方法

MongoDBの集計で_idフィールドを非表示にする方法

MongoDBの集計パイプライン（aggregation pipeline）では、デフォルトですべてのドキュメントに _id フィールドが自動的に含まれます。この _id を結果から除外したい場合は、$project ステージで _id : 0 を指定します。これにより、明示的に含めたフィールドだけが出力されます。

基本構文

_id を集計結果から非表示にするには、以下の構文を使用します。

db.yourCollectionName.aggregate(
   {$project : {
      _id : 0 ,
      yourIncludeFieldName:1,
      yourIncludeFieldName:1
   }}
).pretty();

ポイントは次のとおりです。

• _id : 0： _id フィールドを非表示にします。
• フィールド名 : 1： 結果に含めたいフィールドを指定します。

サンプルコレクションの作成

動作を確認するため、まずドキュメントを含むコレクションを作成します。以下のクエリを実行してください。

> db.hideidDemo.insertOne({"UserName":"Larry","UserAge":23,"UserCountryName":"US"});
{
   "acknowledged" : true,
   "insertedId" : ObjectId("5c92b02336de59bd9de06392")
}
> db.hideidDemo.insertOne({"UserName":"Chris","UserAge":21,"UserCountryName":"AUS"});
{
   "acknowledged" : true,
   "insertedId" : ObjectId("5c92b03036de59bd9de06393")
}
> db.hideidDemo.insertOne({"UserName":"Robert","UserAge":26,"UserCountryName":"UK"});
{
   "acknowledged" : true,
   "insertedId" : ObjectId("5c92b04036de59bd9de06394")
}

登録済みドキュメントの確認

find() メソッドを使うと、コレクション内のすべてのドキュメントを表示できます。

> db.hideidDemo.find().pretty();

実行すると、次のような出力が得られます。_id フィールドが各ドキュメントに含まれていることがわかります。

{
   "_id" : ObjectId("5c92b02336de59bd9de06392"),
   "UserName" : "Larry",
   "UserAge" : 23,
   "UserCountryName" : "US"
}
{
   "_id" : ObjectId("5c92b03036de59bd9de06393"),
   "UserName" : "Chris",
   "UserAge" : 21,
   "UserCountryName" : "AUS"
}
{
   "_id" : ObjectId("5c92b04036de59bd9de06394"),
   "UserName" : "Robert",
   "UserAge" : 26,
   "UserCountryName" : "UK"
}

_idを非表示にする集計クエリの実行

それでは、$project ステージを使って _id を非表示にする集計クエリを実行してみましょう。ここでは UserName と UserCountryName のみを結果に含めます。

> db.hideidDemo.aggregate(
   ... {$project : {
      ... _id : 0 ,
      ... UserName:1,
      ... UserCountryName:1
   ... }}
... ).pretty();

実行結果は以下のとおりです。_id フィールドが除外され、指定したフィールドだけが表示されていることが確認できます。

{ "UserName" : "Larry", "UserCountryName" : "US" }
{ "UserName" : "Chris", "UserCountryName" : "AUS" }
{ "UserName" : "Robert", "UserCountryName" : "UK" }

まとめ

MongoDBの集計で _id を非表示にするには、$project ステージ内で _id : 0 を設定するだけでOKです。他のフィールドは 1 を指定することで出力に含まれます。APIレスポンスなどで内部IDを見せたくない場合に非常に便利なテクニックなので、ぜひ活用してみてください。