db.getCollectionNames()

db.getCollectionNames()

項目一覧

定義

必要なアクセス権
動作
例

定義

db.getCollectionNames(): 現在のデータベース内のすべてのコレクションとビューの名前を含む配列を返します。アクセス制御を使用して実行中の場合は、ユーザーの特権に応じたコレクションの名前を返します。詳細については、必要なアクセス権を参照してください。

必要なアクセス権

db.getCollectionNames() は次のものと同等です。

db.runCommand(
   {
       listCollections: 1.0,
       authorizedCollections: true,
       nameOnly: true
   }
)

必要なアクセス権（データベースに対してlistCollectionsアクションを許可する特権）を持つユーザーの場合、このメソッドはデータベースのすべてのコレクションの名前を一覧表示します。
必要なアクセス権を持たないユーザーの場合、このメソッドはユーザーが特権を持っているコレクションのみを一覧表示します。たとえば、ユーザーがデータベース内の特定のコレクションに対して find を持っている場合、メソッドはそのコレクションのみを返します。

動作

クライアントの切断

MongoDB 4.2以降では、 db.getCollectionNames()を発行したクライアントが操作の完了前に切断した場合、MongoDB は killOp を使用してdb.getCollectionNames()を終了対象としてマークし。

レプリカセットノードの状態の制限

レプリカセットノードでlistCollections操作を実行するには、ノードがPRIMARYまたはSECONDARY状態である必要があります。ノードがSTARTUP2などの別の状態にある場合、操作はエラーになります。

例

以下は、 records データベース内のすべてのコレクションの名前を返します。

use records
db.getCollectionNames()

このメソッドは、コレクションの名前を以下のように配列で返します。

[ "employees", "products", "mylogs", "system.indexes" ]