MongoDBクエリでフィールドから返される文字数を制限する方法

MongoDBのクエリ結果としてフィールドから返される文字数を制限したい場合は、集計パイプライン（aggregate()）内で $substr 演算子を使用します。この記事では、実際にコレクションを作成し、文字数を制限して取得する手順を解説します。

サンプルコレクションの作成

まず、ドキュメントを含むコレクションを作成しましょう。

> db.limitTheNumberOfCharactersDemo.insertOne({"Title":"MongoDB is No SQL database"});
{
    "acknowledged" : true,
    "insertedId" : ObjectId("5cf23013b64a577be5a2bc0e")
}
> db.limitTheNumberOfCharactersDemo.insertOne({"Title":"MySQL is a relational database"});
{
    "acknowledged" : true,
    "insertedId" : ObjectId("5cf2302db64a577be5a2bc0f")
}

登録したドキュメントの確認

次に、find() メソッドを使ってコレクション内のすべてのドキュメントを表示します。

> db.limitTheNumberOfCharactersDemo.find().pretty();

実行すると、以下のようなドキュメントが出力されます。

{
    "_id" : ObjectId("5cf23013b64a577be5a2bc0e"),
    "Title" : "MongoDB is No SQL database"
}
{
    "_id" : ObjectId("5cf2302db64a577be5a2bc0f"),
    "Title" : "MySQL is a relational database"
}

$substr を使って返される文字数を制限する

MongoDBのクエリで特定のフィールドから返される文字数を制限するには、aggregate() メソッドと $project ステージを組み合わせます。$substr の引数は「対象フィールド」「開始位置」「取得する文字数」の3つを指定します。

> db.limitTheNumberOfCharactersDemo.aggregate(
    [
       {
          $project:
          {
             Characters: { $substr: [ "$Title", 0, 20 ] }
          }
       }
    ] 
);

この例では、「Title」フィールドの先頭（開始位置 0）から20文字だけを抽出しています。実行結果は以下のとおりです。

{ "_id" : ObjectId("5cf23013b64a577be5a2bc0e"), "Characters" : "MongoDB is No SQL da" }
{ "_id" : ObjectId("5cf2302db64a577be5a2bc0f"), "Characters" : "MySQL is a relationa" }

補足：新しいバージョンでの推奨演算子

$substr は古いバージョンとの互換性のために残されている演算子です。MongoDB 3.4以降では、バイト単位で切り出す $substrBytes、またはコードポイント単位で安全に切り出せる $substrCP の使用が推奨されています。特に日本語などのマルチバイト文字を扱う場合は、文字化けを防ぐために $substrCP を利用するとよいでしょう。