Relacionamentos incorporados e referências manuais

Quando incorporar documentos

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

Considere incorporar dados nos seguintes casos:

• Seu aplicação 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. Dados limitados não farão com que os documentos aumentem 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 gera menos sobrecarga ao reescrever o documento principal.

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:

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

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

As seções a seguir fornecem exemplos dessas abordagens para modelar entidades de propriedade única e múltipla.

[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 ao consultar regularmente os dados relacionados independentemente de seu pai, quando o conjunto filho puder ficar muito grande ou quando os dados relacionados mudarem com frequência.

Considere usar referências nos seguintes casos:

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

• Você precisa fazer query na entidade relacionada por conta própria. Você pode consultar e indexar a coleção secundária diretamente sem digitalizar os documentos principais.

• Os dados relacionados mudam com frequência e independentemente do pai. Atualizações frequentes de dados incorporados exigem a reescrita de todo o documento pai todas as vezes, o que é ineficiente.

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

• A relacionamento é de muitos para muitos ou complexa.

• Duplicar os dados criaria muita sobrecarga de atualização.

Para saber 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 consultar a coleção referenciada separadamente, como 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:

• [Owned]

• OwnsOne()

• OwnsMany()