listDatabases

定義

listDatabases

listDatabases コマンドは、既存のすべてのデータベースのリストと、それらに関する基本的な統計情報を提供します。次の例のように、 listDatabases　は admin データベースに対して実行する必要があります。

互換性

このコマンドは、次の環境でホストされている配置で使用できます。

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

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

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

構文

db.adminCommand( { listDatabases: 1 } )

値（つまり1) は、コマンドの出力には影響しません。

コマンドフィールド

コマンドは以下の任意フィールドを取ることができます。

動作

認証が有効になっている場合、 listDatabasesコマンドは、コマンドを実行するユーザーに割り当てられた特権とauthorizedDatabasesコマンド オプションに基づいて異なる 値を返します。

• authorizedDatabasesが指定されていない場合、

  • ユーザーがクラスターリソースに対してlistDatabasesアクションを持っている場合、 listDatabasesコマンドはすべてのデータベースを返します。

  • ユーザーがクラスターでlistDatabasesアクションを実行していない場合、 listDatabasesコマンドは、ユーザーが特権を持つデータベースのみを返します（ユーザーが特定のコレクションに対して特権を持つデータベースを含む）。

• authorizedDatabasesがtrueの場合、 listDatabasesコマンドは、ユーザーが特権を持つデータベースのみを返します（ユーザーが特定のコレクションに対して特権を持つデータベースを含む）。

• authorizedDatabasesがfalse場合、

  • ユーザーがクラスターに対してlistDatabasesアクションを持っている場合、 listDatabasesコマンドはすべてのデータベースを返します

  • ユーザーがクラスターでlistDatabasesアクションを実行していない場合、権限が十分でないとlistDatabasesコマンドはエラーとなります。

例

db.adminCommand( { listDatabases: 1 } )

{
   "databases" : [
      {
         "name" : "admin",
         "sizeOnDisk" : 83886080,
         "empty" : false
      },
      {
         "name" : "local",
         "sizeOnDisk" : 83886080,
         "empty" : false
      },
      {
         "name" : "test",
         "sizeOnDisk" : 83886080,
         "empty" : false
      }
   ],
   "totalSize" : 251658240,
   "totalSizeMb" : 251,
   "ok" : 1
}

db.adminCommand( { listDatabases: 1, nameOnly: true} )

{
   "databases" : [
      {
         "name" : "admin"
      },
      {
         "name" : "local"
      },
      {
         "name" : "test"
      }
   ],
   "ok" : 1
}

db.adminCommand( { listDatabases: 1, filter: { "name": /^rep/ } } )

{
  "databases" : [
    {
      "name" : "admin",
      "sizeOnDisk" : 16384,
      "empty" : false,
      "shards" : {
        "config" : 16384
      }
    },
    {
      "name" : "config",
      "sizeOnDisk" : 176128,
      "empty" : false,
      "shards" : {
        "clients" : 28672,
        "patients" : 8192,
        "config" : 139264
      }
    },
    {
      "name" : "test",
      "sizeOnDisk" : 12288,
      "empty" : false,
      "shards" : {
        "clients" : 12288
      }
    }
  ],
  "totalSize" : 204800,
  "totalSizeMb" : 0,
  "ok" : 1
}

出力

listDatabases.databases

タイプ: 配列

それぞれが1つのデータベースに関する情報を含むドキュメントの配列。

listDatabases.databases.name

タイプ: String

データベースの名前。

listDatabases.databases.sizeOnDisk

型: 整数

ディスク上のデータベースファイルの合計サイズ (バイト単位)。

listDatabases.databases.empty

タイプ: ブール値

データベースが空かどうかを指定します。

listDatabases.databases.shards

タイプ: ドキュメント

shards ドキュメントの各要素は、そのシャード上のコレクションの名前を示すキーと、その値がコレクションのサイズをバイト単位で表すフィールドで構成されています。

shards nameOnly: falseの場合のみ出力に表示されます。

詳細については、「シャーディングされたクラスター」を参照してください。

listDatabases.totalSize

型: 整数

すべての sizeOnDisk フィールドの合計 (バイト単位)。

listDatabases.totalSizeMb

型: 整数

sizeOnDisk0}フィールドの総和をメガバイトで表したもの。

listDatabases.ok

型: 整数

コマンドの戻り値。値1は成功を示します。