JavaでMongoDBデータベース内のすべてのコレクションを一覧表示する方法

MongoDBでは、show collections コマンドを使うことで、データベースに存在するすべてのコレクションの一覧を表示できます。

例

たとえば、MongoDBデータベースに以下のように3つのコレクションを作成したとします。

> use sampleDatabase
switched to db sampleDatabase
> db.createCollection("students")
{ "ok" : 1 }
> db.createCollection("teachers")
{ "ok" : 1 }
> db.createCollection("sample")
{ "ok" : 1 }

次のコマンドを実行すると、データベース内のすべてのコレクションが一覧表示されます。

> use sampleDatabase
switched to db sampleDatabase
> show collections
sample
students
teachers

Javaプログラムを使用する方法

Javaでは、com.mongodb.client.MongoDatabase インターフェースが提供する listCollectionNames() メソッドを使うことで、現在接続しているデータベース内のすべてのコレクション名を取得できます。

JavaプログラムからMongoDBデータベース内のすべてのコレクションを一覧表示するには、以下の手順に従います。

• システムにMongoDBがインストールされていることを確認する
• Javaプロジェクトの pom.xml ファイルに、以下の依存関係を追加する

<dependency>
    <groupId>org.mongodb</groupId>
    <artifactId>mongo-java-driver</artifactId>
    <version>3.12.2</version>
</dependency>

• MongoClient クラスをインスタンス化してMongoDBクライアントを作成する
• getDatabase() メソッドを使ってデータベースに接続する
• listCollectionNames() メソッドを使ってコレクションの一覧を取得する

サンプルコード

import com.mongodb.client.MongoDatabase;
import com.mongodb.client.MongoIterable;
import com.mongodb.MongoClient;

public class ListOfCollection {
    public static void main( String args[] ) {
        // Mongoクライアントの作成
        MongoClient mongo = new MongoClient( "localhost" , 27017 );
        
        // データベースへの接続
        MongoDatabase database = mongo.getDatabase("mydatabase");
        
        // 複数のコレクションを作成
        database.createCollection("sampleCollection1");
        database.createCollection("sampleCollection2");
        database.createCollection("sampleCollection3");
        database.createCollection("sampleCollection4");
        
        // コレクション一覧の取得
        MongoIterable<String> list = database.listCollectionNames();
        for (String name : list) {
            System.out.println(name);
        }
    }
}

実行結果

sampleCollection3
sampleCollection2
sampleCollection4
sampleCollection1

このように、listCollectionNames() メソッドは MongoIterable<String> 型のコレクション名一覧を返すため、拡張for文などで簡単に各コレクション名を取り出して処理できます。なお、MongoDB 4.x以降のドライバーを使用する場合は、MongoClient の生成に MongoClients.create() を使う方法が推奨されている点にも注意してください。