Visão geral
Neste guia, você pode aprender como usar o driver Ruby para especificar quais campos devem ser retornados de uma operação de leitura usando uma projeção. Uma projeção é um documento que especifica quais campos o MongoDB retorna de uma query.
Dados de amostra
The examples in this guide use the restaurants collection in the sample_restaurants database from the Atlas sample datasets. To access this collection from your Ruby application, create a Mongo::Client object that connects to an Atlas cluster and assign the following values to your database and collection variables:
database = client.use('sample_restaurants') collection = database[:restaurants]
Para aprender a criar um cluster MongoDB Atlas gratuito e carregar os conjuntos de dados de amostra, consulte o Guia de Introdução do MongoDB.
Tipos de projeção
Você pode usar uma projeção para especificar quais campos incluir ou excluir em um documento de devolução. Você não pode combinar declarações de inclusão e exclusão em uma única projeção, a menos que esteja excluindo o campo _id.
Especifique campos a serem incluídos
Para incluir campos específicos em um resultado de operação de leitura, especifique a opção projection em um parâmetro para o método find. Para definir esta opção, use a seguinte sintaxe:
{ projection: { <field_name>: 1 } }
O exemplo a seguir usa o método find para encontrar todos os restaurantes nos quais o valor do campo name é 'Emerald Pub'. Em seguida, o código especifica a opção projection para instruir a operação de localizar a retornar somente os campos name, cuisine e borough de documentos correspondentes:
opts = { projection: { name: 1, cuisine: 1, borough: 1 } } collection.find({ name: 'Emerald Pub' }, opts).each do |doc| puts doc end
When you use a projection to specify fields to include in the return document, the _id field is also included by default. All other fields are implicitly excluded. To remove the _id field from the return document, you must explicitly exclude it.
Exclua o campo _id
Ao especificar campos a serem incluídos, você também pode excluir o campo _id do documento retornado.
O exemplo a seguir executa a mesma query do exemplo anterior, mas exclui o campo _id da projeção:
opts = { projection: { name: 1, cuisine: 1, borough: 1, _id: 0 } } collection.find({ name: 'Emerald Pub' }, opts).each do |doc| puts doc end
Especifique campos a serem excluídos
Para excluir campos específicos de um resultado de operação de leitura, especifique a opção projection em um parâmetro para o método find. Para definir esta opção, use a seguinte sintaxe:
{ projection: { <field_name>: 0 } }
O exemplo a seguir usa o método find para encontrar todos os restaurantes nos quais o valor do campo name é 'Emerald Pub'. Em seguida, o código utiliza a opção projection para instruir a operação de localizar para omitir os campos grades e address no resultado:
opts = { projection: { grades: 0, address: 0 } } collection.find({ name: 'Emerald Pub' }, opts).each do |doc| puts doc end
Quando você usa uma projeção para especificar quais campos excluir, quaisquer campos não especificados são implicitamente incluídos no documento de retorno.
Informações adicionais
To learn more about projections, see the Project Fields guide in the MongoDB Server manual.
Documentação da API
To learn more about the find method, see the API documentation.