MongoDBの「show dbs」コマンドに相当するBSONクエリとは？listDatabasesの使い方を解説

MongoDBでは、シェル上でshow dbsコマンドを使うとデータベースの一覧を簡単に確認できます。しかし、アプリケーションやドライバから同じ情報を取得したい場合など、BSON形式のクエリとして直接コマンドを実行したいケースがあります。

そのような場合は、db.runCommand()メソッドを使用します。以下の手順で実行できます。

手順1：adminデータベースに切り替える

listDatabasesコマンドはadminデータベースに対して実行する必要があるため、まずadminに切り替えます。

> use admin
switched to db admin

手順2：listDatabasesコマンドを実行する

続いて、以下のコマンドを実行します。

> db.runCommand({listDatabases : 1})

このコマンドは「show dbs」と同等の働きをし、サーバー上に存在するすべてのデータベースの一覧を返します。実行すると、次のような出力が得られます。

{
    "databases" : [
        {
            "name" : "admin",
            "sizeOnDisk" : 2375680,
            "empty" : false
        },
        {
            "name" : "app",
            "sizeOnDisk" : 32768,
            "empty" : false
        },
        {
            "name" : "business",
            "sizeOnDisk" : 417792,
            "empty" : false
        },
        {
            "name" : "config",
            "sizeOnDisk" : 106496,
            "empty" : false
        },
        {
            "name" : "local",
            "sizeOnDisk" : 81920,
            "empty" : false
        },
        {
            "name" : "main",
            "sizeOnDisk" : 184320,
            "empty" : false
        },
        {
            "name" : "my",
            "sizeOnDisk" : 753664,
            "empty" : false
        },
        {
            "name" : "ok",
            "sizeOnDisk" : 1024000,
            "empty" : false
        },
        {
            "name" : "sample",
            "sizeOnDisk" : 3297280,
            "empty" : false
        },
        {
            "name" : "sampleDemo",
            "sizeOnDisk" : 352256,
            "empty" : false
        },
        {
            "name" : "studentSearch",
            "sizeOnDisk" : 262144,
            "empty" : false
        },
        {
            "name" : "test",
            "sizeOnDisk" : 32944128,
            "empty" : false
        },
        {
            "name" : "university",
            "sizeOnDisk" : 229376,
            "empty" : false
        },
        {
            "name" : "web",
            "sizeOnDisk" : 3661824,
            "empty" : false
        },
        {
            "name" : "webcustomertracker",
            "sizeOnDisk" : 32768,
            "empty" : false
        }
    ],
    "totalSize" : 45756416,
    "ok" : 1
}

出力結果の各フィールドの意味

返されるドキュメントには、以下の情報が含まれています。

• databases：存在するデータベースの情報が配列形式で格納されます。
• name：データベースの名前です。
• sizeOnDisk：そのデータベースがディスク上で占有しているサイズ（バイト単位）です。
• empty：データベースが空の場合はtrue、データが存在する場合はfalseになります。
• totalSize：すべてのデータベースの合計サイズ（バイト単位）です。
• ok：コマンドが正常に完了したことを示すステータスで、1なら成功です。

このように、db.runCommand({listDatabases : 1})を使えば、show dbsコマンドと同じ情報をプログラムから扱いやすいBSONドキュメントとして取得できます。権限管理の観点からも、listDatabasesアクションが許可されたユーザーでのみ実行可能である点に注意してください。