AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。
Docs Menu
Docs Home
/ /
C#/.NET ドライバー
Docs Home
/
クライアント ライブラリ
/
C#
/
C#/.NET ドライバー
Docs Home
/
クライアント ライブラリ
/
C#
/
C#/.NET ドライバー

MongoDB Search

Overview

このガイドでは、 Searchビルダーを使用して MongoDB .NET/C# ドライバーで$search集計パイプライン ステージを構築する方法を学びます。

$searchパイプライン ステージの詳細については、 $search を参照してください。

注意

MongoDB v4.2 以降の Atlas でのみ利用可能

$search集計パイプライン演算子は、 MongoDB SearchインデックスによってカバーされているMongoDB v. 以降を実行中MongoDB4 2Atlasクラスターでホストされているコレクションでのみ使用できます。必要な設定とこの演算子の機能の詳細については、 MongoDB Search のドキュメント を参照してください。

サンプル データ

このガイドの例では、 sample_mflixデータベースの moviesコレクションを使用します。このコレクションのドキュメントには、タイトル、プロット、ジャンル、評価など、映画に関する情報が含まれています。次の Movieクラスは、このコレクション内のドキュメントをモデル化します。

[BsonIgnoreExtraElements]
public class Movie
{
    [BsonId]
    public ObjectId Id { get; set; }
    public string Title { get; set; } = null!;
    public string Plot { get; set; } = null!;
    public string[] Genres { get; set; } = null!;
    public int Year { get; set; }
    public string Rated { get; set; } = null!;
    public Imdb Imdb { get; set; } = null!;
    [BsonElement("plot_embedding")]
    public float[] PlotEmbedding { get; set; } = null!;
    public double Score { get; set; }
    [BsonElement("scoreDetails")]
    [BsonIgnoreIfNull]
    public SearchScoreDetails ScoreDetails { get; set; } = null!;
    [BsonElement("paginationToken")]
    public string PaginationToken { get; set; } = null!;
}

Movieクラスは次の Imdbクラスを参照します。このクラスは、各ドキュメント内のネストされた imdbフィールドをモデル化します。

[BsonIgnoreExtraElements]
public class Imdb
{
    public double Rating { get; set; }
    public int Votes { get; set; }
    public int Id { get; set; }
}

注意

サンプル データ内のキャメルケースのフィールド名

movies コレクションのドキュメントは、キャメル ケースの命名規則を使用します。このガイドの例では、ConventionPack を使用してコレクション内のフィールドをパスカル ケースに逆シリアル化し、Movie クラスのプロパティにマップします。

カスタム直列化について詳しくは、「カスタム直列化」を参照してください。

このガイドの一部の例では、関連するセクションで紹介されている追加のコレクションとモデル クラスを使用します。すべてのコレクションは、Atlas が提供するサンプルデータセット から取得されています。 MongoDBクラスターを無料で作成して、このサンプルデータをロードする方法については、「 クイック スタート 」を参照してください。

MongoDB Search インデックスの作成

Atlasコレクションで検索する前に、まずコレクションにAtlas Searchインデックスを作成する必要があります。MongoDB 検索インデックスは、検索可能な形式でデータを分類するデータ構造です。

MongoDB 検索インデックスの作成方法については、MongoDB 検索インデックスの作成 Atlas ガイドを参照してください。

MongoDB 検索する演算子

Searchクラスには、 $search操作を実行するために使用できるメソッドが含まれています。 使用可能な$search演算子の完全なリストについては、Atlas の演算子とコレクターのガイドを参照してください。

オートコンプリート

Autocomplete()メソッドを使用して、不完全な入力 string からの文字シーケンスを含む単語またはフレーズを検索します。

次の例では、string "Gravity" で始まるテキストの titleフィールドに対してオートコンプリート クエリを実行します。

var result = moviesCollection.Aggregate()
    .Search(Builders<Movie>.Search.Autocomplete(m => m.Title, "Gravity"), indexName: "movietitles")
    .ToList();

注意

オートコンプリート クエリ用インデックス

オートコンプリート クエリを正常に実行するには、オートコンプリートをサポートするMongoDB 検索インデックスを作成する必要があります。詳細を学ぶには、Atlas ドキュメントのオートコンプリート用にフィールドをインデックスする方法を参照してください。

MongoDB Searchインデックスを作成したら、前述の例に示すように、インデックス名を Autocomplete() メソッドに渡す必要があります。

autocomplete演算子の詳細については、Atlas のオートコンプリートガイドを参照してください。

複合

2 つ以上の演算子を 1 つの検索に結合するには、 Compound()メソッドを使用します。

次の例では、 moviesコレクションで次のすべての条件に一致するドキュメントを検索します。

  • imdb.ratingフィールドはドキュメントに存在する

  • ratedフィールド値は "G" ではありません

  • yearフィールドの値が 2000 より大きい

var result = moviesCollection.Aggregate()
    .Search(Builders<Movie>.Search.Compound()
        .Must(Builders<Movie>.Search.Exists(m => m.Imdb.Rating))
        .MustNot(Builders<Movie>.Search.Equals(m => m.Rated, "G"))
        .Must(Builders<Movie>.Search.Range(m => m.Year, SearchRangeBuilder.Gt(2000))))
    .ToList();

compound演算子の詳細については、 Atlas複合ガイド をご覧ください。

embeddedDocument

EmbeddedDocument()メソッドを使用して、フィールドの配列値内のドキュメントに対して検索操作を実行します。

注意

埋め込みドキュメントを検索するには、配列フィールドにembeddedDocumentインデックスを作成する必要があります。

embeddedDocumentインデックスを定義する方法については、Atlas ドキュメントの「 embeddedDocument 型のインデックスの定義」を参照してください。

この例では、sample_restaurantsデータベースの restaurantsコレクションを使用します。次の クラスは、そのコレクション内のドキュメントをモデル化します。

[BsonIgnoreExtraElements]
public class Restaurant
{
    [BsonId]
    public ObjectId Id { get; set; }
    public string Name { get; set; } = null!;
    public string Cuisine { get; set; } = null!;
    public string Borough { get; set; } = null!;
    public List<GradeEntry> Grades { get; set; } = null!;
}
[BsonIgnoreExtraElements]
public class GradeEntry
{
    public string Grade { get; set; } = null!;
    public int? Score { get; set; }
}

次の例では、そのコレクションで、grades 配列に grade フィールドの値が "A" であるエントリが含まれているレストランを検索します。

var result = restaurantsCollection.Aggregate()
    .Search(Builders<Restaurant>.Search.EmbeddedDocument(
        r => r.Grades,
        Builders<GradeEntry>.Search.Equals(g => g.Grade, "A")
    ), indexName: "restaurantsembedded").ToList();

embeddedDocument演算子の詳細については、 embeddedDocument Atlas のガイドを参照してください。

equals

フィールドが指定された値と一致するかどうかを確認するには、 Equals()メソッドを使用します。

次の例では、 moviesコレクションで、yearフィールドの値が 2000 であるドキュメントを検索します。

var result = moviesCollection.Aggregate()
    .Search(Builders<Movie>.Search.Equals(m => m.Year, 2000))
    .ToList();

equals演算子の詳細については、 Atlas ガイドと等価を参照してください。

exists

指定されたインデックス付きフィールド名が存在するドキュメントを検索するには、 Exists()メソッドを使用します。 指定されたフィールドが存在してもインデックスがない場合、ドキュメントは結果セットに含まれません。

次の例では、moviesコレクションで imdb.ratingフィールドが存在するドキュメントを検索します。

var result = moviesCollection.Aggregate()
    .Search(Builders<Movie>.Search.Exists(m => m.Imdb.Rating))
    .ToList();

exists演算子の詳細については、既存のAtlasガイドを参照してください。

geoShape

GeoShape()メソッドを使用して、特定のジオメトリに関連するドキュメントを検索します。 検索する座標を指定する場合は、最初に 経度 、次に 緯度 を指定する必要があります。 経度の値は、両端を含む-180から180までです。 緯度の値は、両端を含む-90から90までです。

注意

MongoDB Search は以下の機能をサポートしていません。

  • 非デフォルトの座標参照システム（CRS）

  • 平面 XY 座標系 (2 次元)

  • 座標ペアのポイント表記（pointFieldName: [12, 34]）

この例では、sample_mflixデータベースの theatersコレクションを使用します。次の クラスは、そのコレクション内のドキュメントをモデル化します。

[BsonIgnoreExtraElements]
public class Theater
{
    [BsonId]
    public ObjectId Id { get; set; }
    public int TheaterId { get; set; }
    public TheaterLocation Location { get; set; } = null!;
}
[BsonIgnoreExtraElements]
public class TheaterLocation
{
    [BsonElement("geo")]
    public GeoJsonPoint<GeoJson2DGeographicCoordinates> Geo { get; set; } = null!;
}

次の例では、そのコレクションで、location.geoフィールドの座標が最小値 MN 領域内の指定された多角形と交差されているすべてのドキュメントを検索します。

GeoJsonPolygon<GeoJson2DGeographicCoordinates> searchArea = new(new(new(new GeoJson2DGeographicCoordinates[]
{
    new(-93.5, 44.7),
    new(-93.5, 45.0),
    new(-93.0, 45.0),
    new(-93.0, 44.7),
    new(-93.5, 44.7),
})));
var result = theatersCollection.Aggregate()
    .Search(Builders<Theater>.Search.GeoShape(
        t => t.Location.Geo, GeoShapeRelation.Intersects, searchArea),
        indexName: "theatersgeo")
    .ToList();

geoShape演算子の詳細については、 geoShape Atlas ガイドを参照してください。

geoWithin

GeoWithin()メソッドを使用して、指定されたGeoJSONフィールドの座標が特定のジオメトリ内にあるドキュメントを検索します。 内にあるポイントを検索できます。

  • 円

  • 境界ボックス

  • 多角形

検索する座標を指定する場合は、最初に 経度 、次に 緯度 を指定する必要があります。 経度の値は、両端を含む-180から180までです。 緯度の値は、両端を含む-90から90までです。

注意

MongoDB Search は以下の機能をサポートしていません。

  • 非デフォルトの座標参照システム（CRS）

  • 平面 XY 座標系 (2 次元)

  • 座標ペアのポイント表記（pointFieldName: [12, 34]）

次の例では、 theatersコレクションで、location.geoフィールドの座標が指定された多角形内にあるすべてのドキュメントを検索します。

GeoJsonPolygon<GeoJson2DGeographicCoordinates> searchArea = new(new(new(new GeoJson2DGeographicCoordinates[]
{
    new(-94.0, 44.5),
    new(-94.0, 45.2),
    new(-92.5, 45.2),
    new(-92.5, 44.5),
    new(-94.0, 44.5),
})));
var result = theatersCollection.Aggregate()
    .Search(Builders<Theater>.Search.GeoWithin(t => t.Location.Geo, searchArea),
        indexName: "theatersgeo")
    .ToList();

geoWithin演算子の詳細については、 geoWithin Atlas ガイド を参照してください。

で

指定値のリストと一致するフィールド値を持つドキュメントを検索するには、In() メソッドを使用します。

次の例では、 moviesコレクションで、"Action" または "Comedy" のいずれかを含む genres 配列を持つドキュメントを検索します。

var result = moviesCollection.Aggregate()
    .Search(Builders<Movie>.Search.In(m => m.Genres, new[] { "Action", "Comedy" }))
    .ToList();

moreLikeThis

入力ドキュメントに類似するドキュメントを検索するには、 MoreLikeThis()メソッドを使用します。

この例では、次のクラスを使用して、検索の入力ドキュメントを指定します。

public class MovieSearch
{
    public string Plot { get; set; } = null!;
}

次の例では、 moviesコレクションで、plotフィールドの値が "time travel" であるオブジェクトに類似するドキュメントを検索します。

var searchDocument = new MovieSearch()
{
    Plot = "time travel",
};
var result = moviesCollection.Aggregate()
    .Search(Builders<Movie>.Search.MoreLikeThis(searchDocument))
    .ToList();

moreLikeThis演算子の詳細については、Atlas ガイドのmoreLikeThis Atlas ガイドを参照してください。

near

Near()メソッドを使用して、指定したフィールドが指定の値に近いドキュメントを検索します。 検索は、次に対して実行できます。

  • 数値フィールド

  • 日付フィールド

  • 地理的ポイント

次の例では、 moviesコレクションで、imdb.ratingフィールドの値が 8.5 に近いドキュメントを検索します。値が 8.5 に近いかどうかに基づいて、ドキュメントは順番に返されます。

var result = moviesCollection.Aggregate()
    .Search(Builders<Movie>.Search.Near(m => m.Imdb.Rating, 8.5, 1))
    .ToList();

near演算子の詳細については、近くのAtlas ガイドを参照してください。

phrase

指定したフィールドに入力stringが含まれているドキュメントを検索するには、Phrase() メソッドを使用します。

次の例では、 moviesコレクションで、plotフィールドにフレーズ "time travel" が含まれているドキュメントを検索します。

var result = moviesCollection.Aggregate()
    .Search(Builders<Movie>.Search.Phrase(m => m.Plot, "time travel"))
    .ToList();

また、コレクション内で plotフィールドで "time travel" または "space adventure" のいずれかを含むドキュメントを検索することもできます。

var result = moviesCollection.Aggregate()
    .Search(Builders<Movie>.Search.Phrase(m => m.Plot, new List<string>() { "time travel", "space adventure" }))
    .ToList();

phrase演算子について詳しくは、Atlas ガイドのフレーズを参照してください。

queryString

QueryString()メソッドを使用して、次の演算子と区切り文字を含む string を使用してドキュメントを検索します。

  • AND

  • OR

  • NOT

  • ()

次の例では、 moviesコレクションで、 plotフィールドの値が次の各条件に一致するドキュメントを検索します。

  • string "time" または string "space" が含まれます

  • string を含みません "comedy"

var result = moviesCollection.Aggregate()
    .Search(Builders<Movie>.Search.QueryString(m => m.Plot, "(time OR space) AND NOT comedy"))
    .ToList();

queryString演算子の詳細については、 Atlas ガイドのqueryStringを参照してください。

Range（範囲）

Range()メソッドを使用して、指定フィールドの値が特定の数値または日付範囲内にあるドキュメントを検索します。

次の例では、 moviesコレクションで、year の値が 2000 より大きく 2010 より小さいすべてのドキュメントを検索します。

var result = moviesCollection.Aggregate()
    .Search(Builders<Movie>.Search
    .Range(m => m.Year, SearchRangeBuilder.Gt(2000).Lt(2010)))
    .ToList();

range演算子の詳細については、 Atlas の範囲ガイド を参照してください。

regex

正規表現を使用してドキュメントを検索するには、 Regex()メソッドを使用します。

次の例では、 moviesコレクションで、titleフィールドの値に 6 文字だけが含まれているドキュメントを検索します。

var regex = "[A-Za-z]{6}";
var result = moviesCollection.Aggregate()
    .Search(Builders<Movie>.Search.Regex(m => m.Title, regex,
        allowAnalyzedField: true))
    .ToList();

注意

デフォルトでは、 regex演算子は分析対象フィールドでは実行できません。 次のように、 allowAnalyzedFieldオプションを true に設定することで、分析フィールドで実行できるようになります。

var result = moviesCollection.Aggregate()
    .Search(Builders<Movie>.Search.Regex(m => m.Title, regex,
        allowAnalyzedField: true))
    .ToList();

allowAnalyzedFieldオプションを true に設定すると、予期しない検索結果が発生する可能性があります。 詳しくは、「正規表現の動作 」を参照してください。

regex演算子の詳細については、 Atlas ガイドの正規表現を参照してください。

span

フィールドのリージョン内に一致するテキスト検索を検索するには、 Span()メソッドを使用します。 このメソッドを使用すると、指定した精度で相互に近い文字列を検索できます。

注意

span演算子は、クエリが位置情報を追跡する必要があるため、他の演算子よりも計算負荷が高くなります。

次の例では、moviesコレクションで、plotフィールドの値に"time"と"travel"が互いに1単語以内に含まれるドキュメントを検索します。

var searchTerms = new[]
{
    Builders<Movie>.SearchSpan.Term(m => m.Plot, "time"),
    Builders<Movie>.SearchSpan.Term(m => m.Plot, "travel")
};
var result = moviesCollection.Aggregate()
    .Search(Builders<Movie>.Search.Span(Builders<Movie>.SearchSpan.Near(searchTerms, 1)))
    .ToList();

span演算子の詳細については、 Atlas ガイドの範囲を参照してください。

Text

ドキュメント内で指定された string または string の配列を検索するには、Text() メソッドを使用します。特定の string に複数の検索期間がある場合、 MongoDB Search は 文字列内の各期間の一致も個別に検索します

次の例では、 moviesコレクションで、plotフィールドの値に string "secret agent" が含まれるドキュメントを検索します。

var result = moviesCollection.Aggregate()
    .Search(Builders<Movie>.Search.Text(m => m.Plot, "secret agent"))
    .ToList();

Tip

検索 string に複数のタームが含まれている場合、このメソッドは string 内の各タームの一致も個別に検索します

text演算子の詳細については、Atlas ガイドのテキストを参照してください。

ワイルドカード

Wildcard() メソッドを使用して、検索stringに任意の文字に一致する特殊文字を使用してドキュメントを検索します。 検索では、次の文字を使用できます。

文字
説明

?

任意の 1 文字と一致

*

0 文字以上の文字と一致

\

エスケープ文字

次の例では、 titleフィールドの値に string "Amer" とそれに続く他の文字が含まれているドキュメントを検索します。

var result = moviesCollection.Aggregate()
    .Search(Builders<Movie>.Search.Wildcard(m => m.Title, "Amer*", allowAnalyzedField: true))
    .ToList();

注意

デフォルトでは、 wildcard演算子は分析対象フィールドでは実行できません。 次のように、 allowAnalyzedFieldオプションを true に設定することで、分析フィールドで実行できるようになります。

var result = moviesCollection.Aggregate()
    .Search(Builders<Movie>.Search.Wildcard(m => m.Title, "Amer*", allowAnalyzedField: true))
    .ToList();

allowAnalyzedFieldオプションを true に設定すると、予期しない検索結果が発生する可能性があります。 詳しくは、「ワイルドカードの動作 」を参照してください。

wildcard演算子の詳細については、ワイルドカードAtlas のガイドを参照してください。

戻る
ビルダを用いた操作
次へ
Stable API
このページを評価

項目一覧