Relacionamentos incorporados e referências manuais

Quando incorporar documentos

Use documento incorporado quando os dados relacionados forem geralmente visualizados no contexto de seu pai e quando os dados incorporados permanecerem razoavelmente limitados em tamanho. Isso inclui pequenos conjuntos de valores filho, como endereços, configurações ou uma lista limitada de itens recentes. Quando você incorpora documentos incorporados, o MongoDB Server pode melhorar o desempenho recuperando dados relacionados em uma única operação de banco de dados e atualizando dados relacionados atomicamente em um único documento.

Considere o embedding de dados nos seguintes casos:

• Seu aplicativo geralmente lê dados pai e filho juntos. Buscar tudo em uma query é mais eficiente do que fazer chamadas separadas.

• Os dados relacionados não crescem sem um limite superior claro. Os dados limitados não farão com que os documentos cresçam indefinidamente ou atinjam o limite de tamanho de documento de 16MB do MongoDB.

• Os dados relacionados não mudam com frequência e independentemente do pai. Isso incorre em menos sobrecarga da reescrita do documento pai.

Para saber mais, consulte Dados incorporados na documentação do MongoDB Server.

Como incorporar documentos

Você pode designar uma entidade própria das seguintes maneiras:

• [Propriedade] Atributo: aplicar o atributo de anotação de dados [Owned] à classe de modelo para o subdocumento. Essa abordagem é declarativa e concisa, mas também menos flexível, porque se aplica globalmente a todos os usos do tipo de propriedade.

• API fluente: chame os métodos OwnsOne() ou OwnsMany() em sua configuração DbContext. Essa abordagem oferece mais controle e flexibilidade, permitindo que você configure o relacionamento de forma diferente para entidades específicas sem modificar a classe de modelo.

As seções a seguir fornecem exemplos dessas abordagens para modelagem de entidades únicas e múltiplas.

[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 }
  ]
}

Quando usar referências

Use referências quando você query regularmente os dados relacionados independentemente de seu pai, quando o conjunto filho pode crescer muito ou quando os dados relacionados mudam com frequência.

Considere usar referências nos seguintes casos:

• Os dados relacionados crescem sem um limite superior claro. Arrays ilimitados podem causar problemas de desempenho e podem atingir o limite de tamanho de documento de 16MB do MongoDB.

• Você precisa query a entidade relacionada por conta própria. Você pode query e indexar a coleção filho diretamente sem digitalizar documentos pai.

• Os dados relacionados mudam com frequência e independentemente do pai. As atualizações frequentes de dados incorporados exigem a reescrita de todo o documento pai a cada vez, o que é ineficiente.

• O aplicativo geralmente não lê dados pai e filho juntos. Ao usar referências, você evita buscar dados filho de que não precisa.

• O relacionamento é muitos para muitos ou complexo.

• A duplicação dos dados criaria muita sobrecarga de atualização.

Para **aprender** mais, consulte Dados de referência na documentação do MongoDB Server.

Como usar referências

O exemplo a seguir mostra como armazenar uma referência a uma entidade relacionada:

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; }
}

Para recuperar a entidade relacionada, você deve query a coleção referenciada separadamente, conforme mostrado no exemplo a seguir:

// 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);

Documentação da API

Para saber mais sobre os métodos e tipos discutidos neste guia, consulte a seguinte documentação da API da Microsoft:

• [Propriedade]

• OwnsOne()

• OwnsMany()