Overview
Entity Framework コアを使用すると、データベースコマンドを明示的に実行せずにアプリケーション内のデータを操作できます。 データをクエリするには、 LINQ(言語統合クエリ) 構文を使用します。 LINQ では、C# 固有のキーワードと演算子を使用して、厳密に型指定されたクエリを作成できます。 アプリケーションを実行すると、F Core プロバイダーは LINQ クエリを自動的に変換し、MongoDB Query API を使用してデータベース上で実行します。
このガイドでは、FS コア プロバイダーを使用するように構成されたアプリケーションにおける一般的なクエリ操作の例を確認できます。
Tip
FS コア プロバイダーを使用するようにアプリケーションを構成する方法については、「 FS コアの構成 」を参照してください。
サンプル データ
このガイドの例では、sample_guidesデータベースの planetsコレクションを使用します。このコレクションのドキュメントは、次の Planetクラスをモデルとして使用します。
public class Planet { public ObjectId _id { get; set; } public string name { get; set; } = null!; public int orderFromSun { get; set; } public bool hasRings { get; set; } }
このコレクションは、Atlas が提供する サンプルデータセット からのものです。MongoDBクラスターを無料で作成して、このサンプルデータをロードする方法については、クイック スタートガイドを参照してください。
エンティティの検索
FirstOrDefault()メソッドを使用して 1 つのエンティティを検索するか、 Where()メソッドを使用して複数のエンティティを検索します。
単一エンティティの検索
FirstOrDefault()メソッドは、コレクション内で検索条件に一致する最初に見つけたエンティティを返し、一致するエンティティが見つからない場合はnullを返します。
次のコードでは、 Planets FirstOrDefault() nameを使用して、 DBSet (
var planet = db.Planets.FirstOrDefault(p => p.name == "Mercury"); Console.WriteLine(planet?.name);
複数エンティティの検索
Where()メソッドを使用して、コレクションから複数のエンティティを取得できます。 Where()は、検索条件に一致するすべてのエンティティを返します。
次のコードでは、 Where()メソッドを使用して、 hasRingsフィールドがtrueに設定されているすべての惑星を検索し、惑星名をコンソールに出力します。
var planets = db.Planets.Where(p => p.hasRings); foreach (var p in planets) { Console.WriteLine(p.name); }
シャドウ プロパティのクエリ
A シャドウプロパティは、 .NETエンティティクラスで定義されていないプロパティですが、 Entity Framework モデルに含まれ、データベースのフィールドにマップされます。シャドウ プロパティを使用すると、エンティティのプロパティとして公開せずに、ドキュメント内のデータをクエリまたは追跡できます。
LINQ クエリでシャドウプロパティを参照には、EF.Property<T>() メソッドを呼び出し、構成されたプロパティ名を引数として渡します。ジェネリック型引数は、 シャドウプロパティのデータ型と一致する必要があります。
例、PlanetクラスはmainAtmosphereフィールドのプロパティを定義していません。このフィールドをシャドウプロパティとして構成するには、次の例に示すように、PlanetDbContext の OnModelCreating() メソッドで Property<T>() メソッドを呼び出します。
public class PlanetDbContext : DbContext { public DbSet<Planet> Planets { get; init; } = null!; public static PlanetDbContext Create(IMongoDatabase database) => new(new DbContextOptionsBuilder<PlanetDbContext>() .UseMongoDB(database.Client, database.DatabaseNamespace.DatabaseName) .Options); public PlanetDbContext(DbContextOptions options) : base(options) { } protected override void OnModelCreating(ModelBuilder modelBuilder) { base.OnModelCreating(modelBuilder); modelBuilder.Entity<Planet>().ToCollection("planets"); modelBuilder.Entity<Planet>().Property<string[]>("mainAtmosphere"); } }
modelBuilder.Entity<Planet>().Property<string[]>("mainAtmosphere") を呼び出すと、モデルに mainAtmosphere を含め、それをMongoDBの string[]フィールドにマッピングするようにフレームワークに指示します。
次のコードでは、EF.Property<string[]>() メソッドを使用して、空でない mainAtmosphere プロパティを持つすべての惑星を検索し、惑星名をコンソールに出力します。
var planets = db.Planets.Where( p => EF.Property<string[]>(p, "mainAtmosphere").Length > 0); foreach (var p in planets) { Console.WriteLine(p.name); }
フィールドの有無を確認
Mqlクラスのメソッドを使用すると、フィールドが存在するか、欠落しているか、または null 値であるかどうかに基づいてドキュメントをクエリできます。
注意
これらのメソッドは、Real プロパティと シャドウ プロパティの両方で機能します。
Mql.Exists
Mql.Exists() メソッドは、フィールド値が null であるドキュメントを含む、指定されたフィールドを含むドキュメントを照合します。
次のコードでは、Mql.Exists() メソッドを使用して、hasRingsフィールドを持つすべての惑星を検索し、惑星名をコンソールに出力します。
var planetNames = db.Planets .Where(p => Mql.Exists(p.hasRings)) .Select(p => p.name); foreach (var name in planetNames) { Console.WriteLine(name); }
Mql.IsMissing
Mql.IsMissing() メソッドは、指定されたフィールドを含まないドキュメントを一致させます。
次のコードでは、Mql.IsMissing() メソッドを使用して、hasRingsフィールドがないすべての惑星を検索し、惑星名をコンソールに出力します。
var planetNames = db.Planets .Where(p => Mql.IsMissing(p.hasRings)) .Select(p => p.name); foreach (var name in planetNames) { Console.WriteLine(name); }
Mql.IsNullOrMissing
Mql.IsNullOrMissing() メソッドは、指定されたフィールドが欠落しているか、null 値があるドキュメントに一致します。
次のコードでは、Mql.IsNullOrMissing() メソッドを使用して、hasRingsフィールドが欠落しているか null であるすべての惑星を検索し、惑星名をコンソールに出力します。
var planetNames = db.Planets .Where(p => Mql.IsNullOrMissing(p.hasRings)) .Select(p => p.name); foreach (var name in planetNames) { Console.WriteLine(name); }
ソート エンティティ
クエリからエンティティを返す順序を指定するには、 OrderBy()メソッドを使用します。 OrderBy()は、指定された並べ替え条件に基づいて要素を昇順で並べ替えます。
次のコードでは、 OrderBy()メソッドを使用してすべての惑星を検索し、 orderFromSunフィールドの値で昇順に並べ替えます。 次に、結果をコンソールに出力します。
var planetList = db.Planets.OrderBy(p => p.orderFromSun); foreach (var p in planetList) { Console.WriteLine(p.name); }
Mercury Venus Earth Mars Jupiter Saturn Uranus Neptune
Tip
降順でソート
OrderByDescending()メソッドを使用して、クエリの結果を降順で並べ替えることができます。
ThenBy()メソッドを使用して、クエリで 2 次並べ替えを実行できます。 ThenBy()メソッドは、指定された並べ替え条件に基づいて、 OrderBy()メソッドの結果を昇順で並べ替えます。 ThenBy()メソッドはOrderBy()メソッドに連結する必要があります。
Tip
降順での二次ソート
ThenByDescending()メソッドを使用して、降順で二次並べ替えを実行できます。
次のコードでは、 OrderBy()メソッドとThenBy()メソッドを使用してすべての惑星を検索し、 hasRings()フィールドで並べ替え、 nameフィールドで 2 次並べ替えます。
var planetList = db.Planets.OrderBy(o => o.hasRings).ThenBy(o => o.name); foreach (var p in planetList) { Console.WriteLine("Has rings: " + p.hasRings + ", Name: " + p.name); }
Has rings: False, Name: Earth Has rings: False, Name: Mars Has rings: False, Name: Mercury Has rings: False, Name: Venus Has rings: True, Name: Jupiter Has rings: True, Name: Neptune Has rings: True, Name: Saturn Has rings: True, Name: Uranus
Tip
ブール値を持つフィールドでソートすると、フィールド値がfalse のエンティティがtrue のフィールド値より前に表示されます。
詳細情報
このガイドで説明するメソッドの詳細については、次の .NET API ドキュメントへのリンクを参照してください。
Mqlクラスメソッドの詳細については、次の.NET/ C#ドライバーAPIドキュメント リンクを参照してください。