MongoDBでフィールドから返される文字数を制限する方法をわかりやすく解説

MongoDBでフィールドの文字数を制限するには？

MongoDBでは、フィールドから返される文字数を制限したい場合、$substr演算子を使用します。$substrを使うことで、指定した位置から指定した文字数だけ文字列を切り出して取得できます。

この記事では、実際にコレクションを作成し、$substrを使って文字数を制限する手順を順番に解説します。

1. ドキュメントを含むコレクションを作成する

まずはサンプルとなるドキュメントを挿入してコレクションを作成しましょう。以下のコマンドを実行します。

> db.demo233.insertOne({"Paragraph":"My Name is John Smith.I am learning MongoDB database"});
{
   "acknowledged" : true,
   "insertedId" : ObjectId("5e41877df4cebbeaebec5146")
}
> db.demo233.insertOne({"Paragraph":"David Miller is a good student and learning Spring and Hibernate Framework."});
{
   "acknowledged" : true,
   "insertedId" : ObjectId("5e4187d7f4cebbeaebec5147")
}

2. find()メソッドでドキュメントを表示する

find()メソッドを使うと、コレクション内のすべてのドキュメントを表示できます。

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

上記のコマンドを実行すると、次のような出力が得られます。

{
   "_id" : ObjectId("5e41877df4cebbeaebec5146"),
   "Paragraph" : "My Name is John Smith.I am learning MongoDB database"
}
{
   "_id" : ObjectId("5e4187d7f4cebbeaebec5147"),
   "Paragraph" : "David Miller is a good student and learning Spring and Hibernate Framework."
}

3. $substrで文字数を制限するクエリを実行する

それが本題である、フィールドから返される文字数を制限するクエリです。aggregate()メソッドと$projectステージを組み合わせて、$substrを適用します。

$substrは「[フィールド, 開始位置, 文字数]」という形式で指定します。以下の例では、先頭（0文字目）から10文字分だけを取得しています。

> db.demo233.aggregate(
...    [
...       {
...          $project:
...          {
...             Paragraph: { $substr: [ "$Paragraph", 0, 10] }
...          }
...       }
...    ] )

実行結果

上記のクエリを実行すると、各ドキュメントの「Paragraph」フィールドから先頭10文字のみが返されていることが確認できます。

{ "_id" : ObjectId("5e41877df4cebbeaebec5146"), "Paragraph" : "My Name is" }
{ "_id" : ObjectId("5e4187d7f4cebbeaebec5147"), "Paragraph" : "David Mill" }

補足：$substrBytesと$substrCPについて

なお、MongoDBのバージョン3.4以降では、より明確な名前を持つ次の2つの演算子が提供されています。

• $substrBytes：バイト単位で部分文字列を取得します。マルチバイト文字を含む場合は注意が必要です。
• $substrCP：コードポイント単位（実質的に文字数単位）で部分文字列を取得します。日本語などのマルチバイト文字列を扱う場合に推奨されます。

$substrは非推奨（deprecated）の扱いとなっているため、新規開発では$substrCPまたは$substrBytesの使用を検討するとよいでしょう。