埋め込み関係と手動参照

埋め込みドキュメントのとき

関連データが通常その親のコンテキストで表示され、埋め込みデータのサイズが妥当な範囲内に留まる場合は、埋め込みドキュメントを使用します。これには、アドレス、設定、または最近のアイテムの制限されたリストなどの小さな子の値のセットが含まれます。ドキュメントを埋め込むと、MongoDB Server は単一のデータベース操作で関連データを取得し、単一ドキュメント内で関連データをアトミックに更新することで、パフォーマンスを向上させることができます。

次の場合には、データの埋め込みを検討してください。

• アプリケーションは通常、親データと子データを一緒に読み取ります。すべてを 1 つのクエリで取得する方が、個別に呼び出すよりも効率的です。

• 関連データは明確な上限なしに増加しません。制限されたデータでは、ドキュメントが無限に増加したり、MongoDB の 16MB のドキュメントサイズ制限に達したりすることはありません。

• 関連データはあまり変更されず、親とは独立して変更されます。これにより、親ドキュメントの書き換えによるオーバーヘッドが減少します。

詳細については、MongoDB Server ドキュメントのEmbedded Dataを参照してください。

埋め込みドキュメント

所有エンティティは、次の方法で指定できます。

• [所有]属性: サブドキュメントのモデル クラスに [Owned] データ注釈属性を適用します。このアプローチは宣言的で簡潔ですが、所有型のすべての使用に全域的に適用されるため、非常に韓弱でもあります。

• Fluent API: DbContext 構成で OwnsOne() または OwnsMany() メソッドを呼び出します。このアプローチにより、より多くの制御と柔軟性が得られます。モデル クラスを変更せずに、特定のエンティティに対して関係を異なるように構成できます。

次のセクションでは、単一の所有エンティティと複数の所有エンティティをモデル化するこれらのアプローチの例を示します。

[Owned]
public class Address
{
    public string Street { get; set; } = null!;
    public string City { get; set; } = null!;
    public string Country { get; set; } = null!;
}
public class Customer
{
    public ObjectId Id { get; set; }
    public string Name { get; set; } = null!;
    public Address Address { get; set; } = null!;
}

public class CustomerDbContext : DbContext
{
    public DbSet<Customer> Customers { get; set; } = null!;
    public CustomerDbContext(DbContextOptions options) : base(options) { }
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);
        modelBuilder.Entity<Customer>(c =>
        {
            c.OwnsOne(c => c.Address);
            c.ToCollection("customers");
        });
    }
}

{
  "_id": ObjectId("..."),
  "Name": "John Doe",
  "Address": {
    "Street": "123 Main St",
    "City": "New York",
    "Country": "USA"
  }
}

[Owned]
public class Order
{
    public string Product { get; set; } = null!;
    public int Quantity { get; set; }
}
public class CustomerWithOrders
{
    public ObjectId Id { get; set; }
    public string Name { get; set; } = null!;
    public List<Order> Orders { get; set; } = new();
}

public class OrderDbContext : DbContext
{
    public DbSet<CustomerWithOrders> Customers { get; set; } = null!;
    public OrderDbContext(DbContextOptions options) : base(options) { }
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);
        modelBuilder.Entity<CustomerWithOrders>(c =>
        {
            c.OwnsMany(c => c.Orders);
            c.ToCollection("customers");
        });
    }
}

{
  "_id": ObjectId("..."),
  "Name": "Jane Smith",
  "Orders": [
    { "Product": "Laptop", "Quantity": 1 },
    { "Product": "Mouse", "Quantity": 2 }
  ]
}

参照を使用するタイミング

子セットが非常に大きくなる可能性がある場合、または関連データが頻繁に変更される場合は、親とは独立して関連データを定期的にクエリするときに参照を使用します。

次の場合には、参照の使用を検討します。

• 関連データは明確な上限なしに拡大します。無制限の配列はパフォーマンスの問題を引き起こし、MongoDBの16MBのドキュメントサイズ制限に達する可能性があります。

• 単独の関連エンティティをクエリする必要があります。親ドキュメントをスキャンせずに、子コレクションを直接クエリしてインデックス付けすることができます。

• 関連データは親とは独立して頻繁に変更されます。埋め込みデータの頻繁な更新には、次回ごとに親ドキュメント全体を書き換える必要があり、非効率です。

• アプリケーションは通常、親データと子データを一緒に読み取りません。参照を使用することで、不要な子データの取得を回避できます。

• 関係が多対多または複雑である。

• データを複製すると、更新オーバーヘッドが大きくなりすぎます。

詳細については、MongoDB Server ドキュメントの「参照データ」を参照してください。

参照の使用方法

次の例は、関連するエンティティへの参照を保存する方法を示しています。

public class Author
{
    public ObjectId Id { get; set; }
    public string Name { get; set; } = null!;
}
public class Book
{
    public ObjectId Id { get; set; }
    public string Title { get; set; } = null!;
    // Store reference to Author by storing the Author's Id
    public ObjectId AuthorId { get; set; }
}

関連エンティティを検索するには、次の例に示すように、参照先のコレクションを個別にクエリする必要があります。

// Query a book and its author
var book = db.Books.FirstOrDefault(b => b.Title == "My Book");
var author = db.Authors.FirstOrDefault(a => a.Id == book!.AuthorId);

API ドキュメント

このガイドで説明されているメソッドとタイプの詳細については、次の Microsoft API ドキュメントを参照してください。

• [所有]

• OwnsOne()

• OwnsMany()