HOWTO · MongoDB

MongoDB シェルを使用してドキュメント値を印刷する

このチュートリアルでは、MongoDB シェルを使用して、ドキュメント全体ではなくドキュメント値を印刷する方法を示します。

このページの内容

必要な値だけを印刷すると簡潔なレポートを作成できます。保存されているすべてのフィールドを確認する場合は、ドキュメント全体を表示するほうが適しています。MongoDBシェルでは、カーソルを使って条件に一致するドキュメントを順に処理し、必要なフィールドを印刷します。このガイドでは、すべてのフィールドを順に処理する方法、一致するドキュメント1件を扱う方法、読みやすいラベルを付ける方法、フィルターとプロジェクションを組み合わせる方法を説明します。

サンプルコレクションを準備する

teachers コレクションに、Mehvish Ashiq(女性、学年18)、Tahir Raza(男性、学年18)、Saira Daniel(女性、学年20)の3件のドキュメントを用意します。新しいデータベースで、次のmongosh用セットアップを実行してください。

このセクションのコードと表示されるラベルや出力は英語のままです。

if (typeof db !== "undefined") {
  db.createCollection("teachers");
  db.teachers.insertMany([
    { first_name: "Mehvish", last_name: "Ashiq", gender: "Female", grade: 18 },
    { first_name: "Tahir", last_name: "Raza", gender: "Male", grade: 18 },
    { first_name: "Saira", last_name: "Daniel", gender: "Female", grade: 20 }
  ]);
}

このガードにより、MongoDBに接続しない設定済みランナーでも、このJavaScript構文の例を安全に扱えます。コレクションを作成してレコードを挿入するには、mongoshで実行してください。明示的に指定しない限り、MongoDBは各ドキュメントに _id を割り当てます。

値を選んで印刷する前に保存済みのレコードを確認するには、シェルで db.teachers.find().pretty() を実行します。生成される _id の値はデータベースごとに異なるため、例では固定の識別子を前提にしないでください。シェルで使う db.teachers.find() や db.teachers.findOne() などはMongoDBの操作です。この記事でインライン表示しているのは、設定済みの例用ランナーがMongoDBシェルのコマンドを実行しないためです。

各ドキュメントのすべてのフィールドと値を印刷する

db.teachers.find().forEach(...) を呼び出すと、カーソルが返す各ドキュメントを処理できます。コールバック内の Object.keys(teacher) はフィールド名を取得し、もう一つの forEach() は各フィールド名と teacher[field] の値を印刷します。プロジェクションで除外しない限り、_id フィールドも表示されます。このmongoshの例は、返された各教師ドキュメントのすべてのフィールドと値を印刷します。MongoDBに接続しない設定済みランナーでも構文を扱えるよう、ガードを付けています。

このセクションのコードと表示されるラベルや出力は英語のままです。

if (typeof db !== "undefined") {
  db.teachers.find().forEach(function (teacher) {
    Object.keys(teacher).forEach(function (field) {
      print(field + ": " + teacher[field]);
    });
  });
}

次の例は別のもので、MongoDBやカーソルを使わず、通常のJavaScriptオブジェクトに対して同じキーと値のループを示します。

この例を実行してください。

const document = { first_name: "Mehvish", grade: 18 };
Object.keys(document).forEach((key) => {
  console.log(`${key}: ${document[key]}`);
});
first_name: Mehvish
grade: 18

1件のドキュメントのフィールドを印刷する

db.teachers.findOne({ gender: "Female" }) を使ってフィルターに一致するドキュメントを1件取得し、そのフィールドを順に処理して各値を印刷します。このmongosh構文は、ドキュメントのプロパティを読み取る前に null かどうかを確認します。設定済みのランナーはMongoDBに接続しないため、コレクションを検索するにはmongoshで実行してください。

このセクションのコードと表示されるラベルや出力は英語のままです。

if (typeof db !== "undefined") {
  var teacher = db.teachers.findOne({ gender: "Female" });
  if (teacher !== null) {
    Object.keys(teacher).forEach(function (field) {
      print(field + ": " + teacher[field]);
    });
  }
}

findOne() は一致するドキュメントを1件返します。明示的にソートしない限り、特定のレコードが選ばれる保証はありません。一致するドキュメントがない場合は null を返し、この確認によってその結果のプロパティを処理しないようにしています。どの一致レコードを選ぶか制御するには、使用しているMongoDBシェルとサーバーのバージョンがサポートするクエリ方法でソートを指定してください。

カスタムラベル付きで値を印刷する

簡潔なレポートを作成するには、カーソルのコールバック内で、読者に分かりやすいラベルを付けて選択したフィールドを印刷します。次の変更されない例では、表示されるラベル「Teacher」と「Grade」は英語のままです。たとえば、print("Teacher: " + document.first_name + " " + document.last_name) と print("Grade: " + document.grade) のように記述できます。これは印刷するテキストだけを変えます。これらの文で _id を省略しても、ドキュメントから削除されるわけではなく、クエリの返却内容も変わりません。返される結果から _id を除外したい場合は、それを除外するプロジェクションを使ってください。

一致したドキュメントから選択したフィールドを印刷する

find() では、最初の引数にクエリフィルター、2番目の引数にプロジェクションを指定します。たとえば、db.teachers.find({ gender: "Female" }, { first_name: 1, grade: 1, _id: 0 }) は女性教師に絞り込み、_id を除いて first_name と grade だけを返します。すべてのドキュメントからフィールドを選ぶには、空のフィルターを使います。例: db.teachers.find({}, { grade: 1, _id: 0 })。学年の値だけが必要なら、このカーソルを順に処理して document.grade を印刷します。

フィルターは一致するドキュメントを決め、プロジェクションは返される各ドキュメントに含めるフィールドを決めます。包含プロジェクションでは、1 を指定したフィールドが選ばれます。_id は既定で含まれるため、除外するには明示的に 0 を指定します。MongoDBでは通常、同じプロジェクション内で、_id 以外のフィールドについて包含と除外を混在させることはできません。プロジェクションの構文は正しく記述してください。_id の除外は { _id: 0 } とし、"_id:0" のような文字列キーにはしません。