Retrieve Data

Abrir tutorial interativo

Dados de amostra

Os exemplos neste guia usam a collection sample_restaurants.restaurants dos conjuntos de dados de amostra do Atlas. Para saber como criar um cluster gratuito do MongoDB Atlas e carregar os conjuntos de dados de amostra, consulte o Início rápido.

Os exemplos desta página utilizam as seguintes classes Restaurant, Address e GradeEntry como modelos:

public class Restaurant
{
    public ObjectId Id { get; set; }
    public string Name { get; set; }
    [BsonElement("restaurant_id")]
    public string RestaurantId { get; set; }
    public string Cuisine { get; set; }
    public Address Address { get; set; }
    public string Borough { get; set; }
    public List<GradeEntry> Grades { get; set; }
}

public class Address
{
    public string Building { get; set; }
    [BsonElement("coord")]
    public double[] Coordinates { get; set; }
    public string Street { get; set; }
    [BsonElement("zipcode")]
    public string ZipCode { get; set; }
}

public class GradeEntry
{
    public DateTime Date { get; set; }
    public string Grade { get; set; }
    public float? Score { get; set; }
}

Encontrar um documento

Para localizar um único documento em uma coleção, passe um filtro de queries que especifique os critérios do documento que você deseja localizar e, em seguida, encadeie o método FirstOrDefault() ou FirstOrDefaultAsync(). Se mais de um documento corresponder ao filtro de queries, esses métodos retornarão o primeiro documento correspondente dos resultados recuperados. Se nenhum documento corresponder ao filtro de queries, os métodos retornarão null.

var restaurants = await _restaurantsCollection.Find(filter).FirstOrDefaultAsync();

var restaurants = _restaurantsCollection.Find(filter).FirstOrDefault();

Para ver um exemplo completo de como usar o método Find() para localizar um único documento, consulte Outras informações.

Localizar vários documentos

Para encontrar vários documentos em uma coleção, passe um filtro de queries para o método Find() que especifica os critérios dos documentos que você deseja recuperar.

Você pode utilizar um cursor para iterar nos documentos retornados pelo método Find(). Um cursor é um mecanismo que permite que um aplicativo itere sobre os resultados do banco de dados enquanto mantém apenas um subconjunto deles na memória em determinado momento. Os cursores são úteis quando o método Find() retorna uma grande quantidade de documentos.

Para usar um cursor para iterar sobre os documentos, passe um filtro de queries para o método Find() que especifica os critérios dos documentos que você deseja localizar e, em seguida, encadeie o método ToCursor() ou ToCursorAsync() . Para visualizar um exemplo síncrono ou assíncrono, selecione a guia correspondente.

var restaurants = await _restaurantsCollection.Find(filter).ToCursorAsync();

var restaurants = _restaurantsCollection.Find(filter).ToCursor();

Se você for retornar um pequeno número de documentos ou precisar que seus resultados sejam retornados como um objeto List, use os métodos ToList() ou ToListAsync().

Para localizar vários documentos em uma coleção e mantê-los na memória como uma lista, passe um filtro de queries para o método Find() que especifique os critérios dos documentos que deseja localizar e, em seguida, encadeie o método ToList() ou ToListAsync(). Para visualizar um exemplo síncrono ou assíncrono, selecione a guia correspondente.

var restaurants = await _restaurantsCollection.Find(filter).ToListAsync();

var restaurants = _restaurantsCollection.Find(filter).ToList();

Para ver um exemplo completo de como usar o método Find() para localizar vários documentos, consulte Informações adicionais.

var filter = Builders<Restaurant>.Filter.Empty;
var allRestaurants = _restaurantsCollection.Find(filter);

Modificar comportamento de localização

Você pode modificar o comportamento do método Find() passando um objeto FindOptions.

Você pode configurar as opções comumente usadas com os seguintes métodos:

Para ver uma lista completa de opções disponíveis, consulte Propriedades FindOptions.

Exemplo

Este exemplo executa as seguintes ações:

• Localiza todos os documentos com "Pizza" no campo cuisine

• Define o BatchSize como 3

• Armazena os resultados em um cursor

• Imprime os documentos referenciados pelo cursor

var filter = Builders<Restaurant>.Filter.Eq("cuisine", "Pizza");
var findOptions = new FindOptions { BatchSize = 3 };
using (var cursor = _restaurantsCollection.Find(filter, findOptions).ToCursor())
{
   foreach (var r in cursor.ToEnumerable())
   {
      WriteLine(r.Name);
   }
}

Pizza Town
Victoria Pizza
...

Documentação da API

Para saber mais sobre qualquer um dos métodos ou tipos discutidos neste guia, consulte a seguinte documentação da API:

• Find()

• FirstOrDefault()

• FirstOrDefaultAsync()

• Encontre opções

• ToList()

• ToListAsync()

• ToCursor()

• ToCursorAsync()