db.collection.unhideIndex()

定義

db.collection.unhideIndex()

重要

mongosh メソッド

このページでは、mongosh メソッドについて説明します。ただし、データベースコマンドや Node.js などの言語固有のドライバーのドキュメントには該当しません。

データベースコマンドについては、 collModコマンドを使用して設定されたindex.hiddenコレクション オプションを参照してください。

MongoDB API ドライバーについては、各言語の MongoDB ドライバー ドキュメントを参照してください。

クエリ プランナーから既存のインデックスを再表示します。 非表示が解除されると、インデックスはすぐに使用できるようになります。

構文

db.collection.unhideIndex(<index>)

動作

必要なアクセス権

配置で認証／承認が強制される場合は、コレクションのデータベースに対してcollMod特権が必要です。

組み込みロール dbAdmin は必要な特権を提供します。

例

次の例では、既存のインデックスを再表示します。

まず、 db.collection.createIndex()を使用して非表示のインデックスを作成します。

db.restaurants.createIndex( { borough: 1, ratings: 1 }, { hidden: true } );

確認するには、 restaurantsコレクションでdb.collection.getIndexes()を実行します。

db.restaurants.getIndexes();

この操作では、次の情報が返されます。

[
   {
      "v" : 2,
      "key" : {
         "_id" : 1
      },
      "name" : "_id_"
   },
   {
      "v" : 2,
      "key" : {
         "borough" : 1,
         "ratings" : 1
      },
      "name" : "borough_1_ratings_1",
      "hidden" : true
   }
]

インデックス オプションhiddenは、値がtrueの場合にのみ返されます。

インデックスを再表示するには、インデックスキー仕様ドキュメントまたはインデックス名のいずれかをdb.collection.unhideIndex()メソッドに指定します。 以下は、インデックス名を指定します。

db.restaurants.unhideIndex( "borough_1_ratings_1" );

確認するには、 restaurantsコレクションでdb.collection.getIndexes()を実行します。

db.restaurants.getIndexes()

この操作では、次の情報が返されます。

[
   {
      "v" : 2,
      "key" : {
         "_id" : 1
      },
      "name" : "_id_"
   },
   {
      "v" : 2,
      "key" : {
         "borough" : 1,
         "ratings" : 1
      },
      "name" : "borough_1_ratings_1"
   }
]

インデックス オプションhiddenは、値がtrueの場合にのみ フィールドが返されるため、 borough_1_ratings_1インデックスの一部として表示されなくなりました。