HOWTO · MongoDB
MongoDB での文字列長のクエリ
このチュートリアルでは、MongoDB で文字列の長さを使用してクエリを実行する方法について説明します。
このページの内容
文字列フィールドの Unicode コードポイント数がちょうど 5 の MongoDB ドキュメントを検索するには、find() で $expr と $strLenCP を使用します: db.mydata.find({ $expr: { $eq: [{ $strLenCP: "$Name" }, 5] } })。この簡略形は、すべてのドキュメントで Name フィールドが文字列であることを前提としています。異なる型が混在する場合は、以下の条件式で保護した形式を使用してください。
MongoDBで文字列の長さに基づいてドキュメントを検索する
方法を比較するときは、同じコレクションと一貫したフィールド名を使います。次の単独で実行できる JavaScript の例では、サンプルドキュメントを6件定義し、ローカルでコードポイント数を基準に絞り込みます。データベースへの接続は不要で、MongoDB サーバー上での実行を示すものではありません。
このセクションのコードと表示されるラベルや出力は英語のままです。
const documents = [
{ _id: 1, Name: "hello" },
{ _id: 2, Name: "world" },
{ _id: 3, Name: "abcdefgh" },
{ _id: 4, Name: "ijklmnop" },
{ _id: 5, Name: "apple" },
{ _id: 6, Name: "grape" }
];
const matches = documents.filter(document => [...document.Name].length === 5);
console.log(JSON.stringify(matches, null, 2));
[
{
"_id": 1,
"Name": "hello"
},
{
"_id": 2,
"Name": "world"
},
{
"_id": 5,
"Name": "apple"
},
{
"_id": 6,
"Name": "grape"
}
]
このデータでは、コードポイント数が5のドキュメントは1、2、5、6です。値は hello、world、apple、grape です。ドキュメント3と4のコードポイント数は、それぞれ8です。
この記事のデータベースコマンドは、未実行の MongoDB シェルの例です。実行するには MongoDB サーバーへの接続が必要です。新しい mydata コレクションにサンプルを作成するには、db.mydata.insertMany([{ _id: 1, Name: "hello" }, { _id: 2, Name: "world" }, { _id: 3, Name: "abcdefgh" }, { _id: 4, Name: "ijklmnop" }, { _id: 5, Name: "apple" }, { _id: 6, Name: "grape" }]) を使用します。既存の _id と競合しないよう、別のサンプルコレクションを使ってください。
$whereで文字列の長さを絞り込む
$where クエリ演算子はサーバー側の JavaScript を評価します。ドキュメントには、デプロイ環境による制限と、サーバー側スクリプトを有効にする必要があることが記載されています。サーバー側 JavaScript を利用できる環境では、db.mydata.find({ $where: function () { return typeof this.Name === "string" && this.Name.length === 5; } }) でサンプルを絞り込めます。
型チェックにより、Name が存在しない場合、null の場合、文字列以外の場合は対象から外れます。5より大きい長さを条件にするには、=== 5 を > 5 に変更します。JavaScript の .length が数えるのは UTF-16 コード単位です。基本多言語面の外にある絵文字は2単位として数えられます。そのため、この方法は ASCII のサンプルでは他の例と同じ結果になりますが、コードポイント数を数える一般的な代替方法ではありません。サーバー側 JavaScript を使わずに条件を表現するには $expr を使用します。
find()で$exprと$strLenCPを使う
$expr 演算子を使うと、find() で集計式を評価できます。$strLenCPは Unicode コードポイント数を数え、$eq はその数を指定した値と比較します。5より大きい長さを条件にするには $eq を $gt に、5以上を含めるには $gte に置き換えます。
$strLenCP のドキュメントにあるとおり、入力値は文字列に評価される必要があります。null または存在しないフィールドを入力するとエラーになります。Name が別の型になる可能性がある場合は、条件式を使います。
db.mydata.find({ $expr: { $cond: [{ $eq: [{ $type: "$Name" }, "string"] }, { $eq: [{ $strLenCP: "$Name" }, 5] }, false] } })
ここでは $cond が、文字列に対してのみ長さを比較し、それ以外の場合は false を返します。空文字列の長さは0です。存在しないフィールドや null のフィールドは、空文字列として扱われず、結果から除外されます。$and を使った別の条件が先に評価され、不適切な入力に対する $strLenCP のエラーを防ぐとは限りません。評価順序に依存しないでください。$and のドキュメントも参照してください。
コードポイント数は UTF-8 のバイト数や見た目の文字数とは異なります。結合アクセント記号を後ろに付けた文字は、コードポイントを2つ使います。アプリケーションで必要な数え方を選んでください。
この記事に掲載した MongoDB 公式ドキュメントへのリンクは参考用です。ここでは、現在アクセスできるかどうかや、記載内容が最新かどうかを確認していません。
ネストしたフィールドでは、型チェックを含め、式内の参照を "$parentField.childField" のようなドット区切りのパスに変更します。複数のフィールドを絞り込む場合は、条件全体を $and または $or で組み合わせます。
集計パイプラインで文字列の長さを絞り込む
絞り込みをほかの変換処理と組み合わせる場合は、集計パイプラインを使います。サンプルコレクションでは、次の $match ステージでコードポイント数が8の文字列を2件選択します。
db.mydata.aggregate([{ $match: { $expr: { $eq: [{ $strLenCP: "$Name" }, 8] } } }])
該当するドキュメントは { _id: 3, Name: "abcdefgh" } と { _id: 4, Name: "ijklmnop" } です。この例はサンプルと同様に、入力が文字列であることを前提としています。異なる型が混在する場合は、直前のセクションにある $cond で保護した式を $expr の値に使い、対象の長さを8にします。$project を追加すると該当ドキュメントの形を変更でき、$group を追加すると集計できます。
正規表現で文字列の長さを固定して一致させる
サンプルのように ASCII 文字だけを含むスカラー文字列を対象とする場合は、db.mydata.find({ Name: { $regex: "^.{5}$" } }) を使います。先頭と末尾のアンカーで一致範囲を限定し、{5} でドットを5回繰り返すことで、ドキュメント1、2、5、6が選択されます。
MongoDB 公式の $regex ドキュメントでは、関連するオプションとアンカーについて説明しています。ただし、任意のテキストにこのパターンを使う場合は注意が必要です。通常、ドットは改行に一致せず、$ は末尾の改行の直前にも一致することがあります。また、正規表現によるフィールド条件は、配列内の文字列要素にも一致する場合があります。スカラー文字列を対象に明示的なコードポイント数で絞り込む場合は、$cond で保護した $strLenCP クエリを優先してください。文字パターンでの検索が目的なら正規表現を選び、効率やインデックスについて判断する前に、実際のワークロードで性能を測定してください。