Class MongoClient.Collection<TDocument>

Um objeto representando uma collection MongoDB remota.

Herança

MongoClient.Collection<TDocument>

namespace: Realms.sincronizar

Conjunto: Realm.exe

Sintaxe

public class MongoClient.Collection<TDocument> where TDocument : class

Parâmetros de tipo

Nome	Descrição
Documento	O tipo managed que corresponde à forma do documento na collection.

Propriedades

| Editar esta página Ver fonte

Database

Obtém o banco de dados ao qual esta coleção pertence.

Declaração

public MongoClient.Database? Database { get; }

Valor da propriedade

Tipo	Descrição
MongoClient.reconhecimento de data center	O banco de dados da coleção ou nulo se o banco de dados foi inferido automaticamente com MongoClient.Collection<TDocument>.

| Editar esta página Ver fonte

Nome

Obtém o nome da collection.

Declaração

public string Name { get; }

Valor da propriedade

Tipo	Descrição
string	O nome da collection.

Métodos

| Editar esta página Ver fonte

AggregateAsync(params objeto[])

Executa um aggregation pipeline na collection e retorna os resultados como uma array MongoDB.Bson.BsonDocument .

Declaração

public Task<BsonDocument[]> AggregateAsync(params object[] pipeline)

Parâmetros

Tipo	Nome	Descrição
objeto[]	gasoduto	documento que descrevem os diferentes estágios do pipeline usando expressão de pipeline .

Devoluções

Tipo	Descrição
Tarefa<BsonDocument[]>	Uma tarefa aguardável representando a operação de agregação remota. O resultado da tarefa é uma array contendo os documentos retornados executando a aggregation `pipeline`.

Veja também

https://mongodb.com/pt-br/docs/manual/aggregation/

| Editar esta página Ver fonte

AggregateAsync<TProjection>(params objeto[])

Executa um aggregation pipeline na collection e retorna os resultados como uma array TProjection .

Declaração

public Task<TProjection[]> AggregateAsync<TProjection>(params object[] pipeline)

Parâmetros

Tipo	Nome	Descrição
objeto[]	gasoduto	documento que descrevem os diferentes estágios do pipeline usando expressão de pipeline .

Devoluções

Tipo	Descrição
Tarefa<TProjection[]>	Uma tarefa aguardável representando a operação de agregação remota. O resultado da tarefa é uma array contendo os documentos retornados executando a aggregation `pipeline`.

Parâmetros de tipo

Nome	Descrição
TProjeção	O tipo managed que corresponde à forma do resultado do pipeline.

Veja também

https://mongodb.com/pt-br/docs/manual/aggregation/

| Editar esta página Ver fonte

CountAsync(objeto?, Longo?)

Conta o número de documentos na collection que correspondem ao filter fornecido.

Declaração

public Task<long> CountAsync(object? filter = null, long? limit = null)

Parâmetros

Tipo	Nome	Descrição
objeto	filtro, filtro	Um documento que descreve os critérios de localização usando operadores de query. Se não for especificado, todos os documentos da collection serão contados.
longo?	limit	O número máximo de documentos para contar. Se não for especificado, todos os documentos na collection serão contados.

Devoluções

Tipo	Descrição
Tarefa<longa>	Uma tarefa aguardável representando a operação de contagem remota. O resultado da tarefa é o número de documentos que correspondem aos critérios `filter` e `limit` .

| Editar esta página Ver fonte

DeleteManyAsync(objeto?)

Remove um ou mais documentos de uma collection. Se nenhum documento corresponder ao filter, a collection não será modificada.

Declaração

public Task<MongoClient.DeleteResult> DeleteManyAsync(object? filter = null)

Parâmetros

Tipo	Nome	Descrição
objeto	filtro, filtro	Um documento que descreve os critérios de exclusão usando operadores de query. Se não for especificado, todos os documentos da collection serão excluídos.

Devoluções

Tipo	Descrição
Tarefa<MongoClient.DeleteResult>	Um awaitable Task<TResult> representando a operação de exclusão remota muitos. O resultado da tarefa contém o número de documentos excluídos.

Veja também

https://mongodb.com/pt-br/docs/manual/reference/method/db.collection.deleteMany/

| Editar esta página Ver fonte

DeleteOneAsync(objeto?)

Remove um único documento de uma collection. Se nenhum documento corresponder ao filter, a collection não será modificada.

Declaração

public Task<MongoClient.DeleteResult> DeleteOneAsync(object? filter = null)

Parâmetros

Tipo	Nome	Descrição
objeto	filtro, filtro	Um documento que descreve os critérios de exclusão usando operadores de query. Se não for especificado, o primeiro documento da collection será excluído.

Devoluções

Tipo	Descrição
Tarefa<MongoClient.DeleteResult>	Um awaitable Task<TResult> representando a operação de exclusão remota. O resultado da tarefa contém o número de documentos excluídos.

Veja também

https://mongodb.com/pt-br/docs/manual/reference/method/db.collection.deleteOne/

| Editar esta página Ver fonte

FindAsync(objeto?, objeto?, objeto?, longo?)

Encontra todos os documentos na collection até limit.

Declaração

public Task<TDocument[]> FindAsync(object? filter = null, object? sort = null, object? projection = null, long? limit = null)

Parâmetros

Tipo	Nome	Descrição
objeto	filtro, filtro	Um documento que descreve os critérios de localização usando operadores de query. Se não for especificado, todos os documentos da collection serão devolvidos.
objeto	sort	Um documento que descreve os critérios de classificação. Se não for especificado, o pedido dos documentos devolvidos não será garantido.
objeto	projeção	Um documento que descreve os campos a serem retornados para todos os documentos correspondentes. Se não for especificado, todos os campos serão retornados.
longo?	limit	O número máximo de documentos a retornar. Se não for especificado, todos os documentos da collection serão retornados.

Devoluções

Tipo	Descrição
Tarefa<TDocument[]>	Uma tarefa aguardada representando a operação de localização remota. O resultado da tarefa é uma array contendo os documentos que correspondem aos critérios de localização.

Veja também

https://mongodb.com/pt-br/docs/manual/reference/method/db.collection.find/

| Editar esta página Ver fonte

FindOneAndDeleteAsync(objeto?, objeto?, objeto?)

Encontra o primeiro documento na collection que satisfaz os critérios de query.

Declaração

public Task<TDocument?> FindOneAndDeleteAsync(object? filter = null, object? sort = null, object? projection = null)

Parâmetros

Tipo	Nome	Descrição
objeto	filtro, filtro	Um documento que descreve os critérios de localização usando operadores de query. Se não for especificado, todos os documentos na collection corresponderão à solicitação.
objeto	sort	Um documento que descreve os critérios de classificação. Se não for especificado, o pedido dos documentos devolvidos não será garantido.
objeto	projeção	Um documento que descreve os campos a serem retornados para todos os documentos correspondentes. Se não for especificado, todos os campos serão retornados.

Devoluções

Tipo	Descrição
Tarefa<TDocument>	Um awaitable Task<TResult> representando a operação de localização remota. O resultado da tarefa é o primeiro documento que corresponde aos critérios de localização.

Veja também

https://mongodb.com/pt-br/docs/manual/reference/method/db.collection.findOneAndDelete/

| Editar esta página Ver fonte

FindOneAndReplaceAsync(objeto?, TDocument, objeto?, objeto?, bool, bool)

Encontra o primeiro documento na collection que satisfaz os critérios de query.

Declaração

public Task<TDocument> FindOneAndReplaceAsync(object? filter, TDocument replacementDoc, object? sort = null, object? projection = null, bool upsert = false, bool returnNewDocument = false)

Parâmetros

Tipo	Nome	Descrição
objeto	filtro, filtro	Um documento que descreve os critérios de localização usando operadores de query. Se não for especificado, todos os documentos na collection corresponderão à solicitação.
Documento	replaceDoc	O documento de substituição. Não pode conter expressões de operador de atualização.
objeto	sort	Um documento que descreve os critérios de classificação. Se não for especificado, o pedido dos documentos devolvidos não será garantido.
objeto	projeção	Um documento que descreve os campos a serem retornados para todos os documentos correspondentes. Se não for especificado, todos os campos serão retornados.
bool	upsert	Um booleano que controla se o substituto deve inserir um documento se nenhum documento corresponder ao `filter`. O padrão é `false`. O MongoDB adicionará o campo `_id` ao documento de substituição se ele não for especificado no filtro ou nos documentos de substituição. Se `_id` estiver presente em ambos, os valores deverão ser iguais.
bool	Devolver novo documento	Um booleano que controla se o documento de substituição deve ser devolvido. Se definido para `false` , o documento original antes da atualização ser retornada. O padrão é `false`.

Devoluções

Tipo	Descrição
Tarefa<TDocument>	Um awaitable Task<TResult> representando a operação de localização remota. O resultado da tarefa é o primeiro documento que corresponde aos critérios de localização.

Veja também

https://mongodb.com/pt-br/docs/manual/reference/method/db.collection.findOneAndReplace/

| Editar esta página Ver fonte

FindOneAndUpdateAsync(objeto?, objeto, objeto?, objeto?, bool, bool)

Encontra o primeiro documento na collection que satisfaz os critérios de query.

Declaração

public Task<TDocument> FindOneAndUpdateAsync(object? filter, object updateDocument, object? sort = null, object? projection = null, bool upsert = false, bool returnNewDocument = false)

Parâmetros

Tipo	Nome	Descrição
objeto	filtro, filtro	Um documento que descreve os critérios de localização usando operadores de query. Se não for especificado, todos os documentos na collection corresponderão à solicitação.
objeto	Atualizar documento	Um documento descrevendo a atualização. Só pode conter expressões de operador de atualização.
objeto	sort	Um documento que descreve os critérios de classificação. Se não for especificado, o pedido dos documentos devolvidos não será garantido.
objeto	projeção	Um documento que descreve os campos a serem retornados para todos os documentos correspondentes. Se não for especificado, todos os campos serão retornados.
bool	upsert	Um booleano que controla se a atualização deve inserir um documento se nenhum documento corresponder ao `filter` . O padrão é `false`.
bool	Devolver novo documento	Um booleano que controla se deve retornar o novo documento atualizado. Se definido para `false` , o documento original antes da atualização ser retornada. O padrão é `false`.

Devoluções

Tipo	Descrição
Tarefa<TDocument>	Um awaitable Task<TResult> representando a operação de localização remota. O resultado da tarefa é o primeiro documento que corresponde aos critérios de localização.

Veja também

https://mongodb.com/pt-br/docs/manual/reference/method/db.collection.findOneAndUpdate/

| Editar esta página Ver fonte

FindOneAsync(objeto?, objeto?, objeto?)

Encontra o primeiro documento na collection que satisfaz os critérios de query.

Declaração

public Task<TDocument?> FindOneAsync(object? filter = null, object? sort = null, object? projection = null)

Parâmetros

Tipo	Nome	Descrição
objeto	filtro, filtro	Um documento que descreve os critérios de localização usando operadores de query. Se não for especificado, todos os documentos na collection corresponderão à solicitação.
objeto	sort	Um documento que descreve os critérios de classificação. Se não for especificado, o pedido dos documentos devolvidos não será garantido.
objeto	projeção	Um documento que descreve os campos a serem retornados para todos os documentos correspondentes. Se não for especificado, todos os campos serão retornados.

Devoluções

Tipo	Descrição
Tarefa<TDocument>	Um awaitable Task<TResult> representando a operação de localização remota. O resultado da tarefa é o primeiro documento que corresponde aos critérios de localização.

Veja também

https://mongodb.com/pt-br/docs/manual/reference/method/db.collection.findOne/

| Editar esta página Ver fonte

InsertManyAsync(IEnumerable<TDocument>)

Insere um ou mais documentos na coleção.

Declaração

public Task<MongoClient.InsertManyResult> InsertManyAsync(IEnumerable<TDocument> docs)

Parâmetros

Tipo	Nome	Descrição
IEnumerable<TDocument>	Docs	Os documentos a inserir.

Devoluções

Tipo	Descrição
Task<MongoClient.InsertManyResult>	Um awaitable Task<TResult> representando a operação de inserção remota muitos. O resultado da tarefa contém os `_id`s dos documentos inseridos.

Veja também

https://mongodb.com/pt-br/docs/manual/reference/method/db.collection.insertMany/

| Editar esta página Ver fonte

InsertOneAsync(TDocument)

Insere o documento fornecido na collection.

Declaração

public Task<MongoClient.InsertResult> InsertOneAsync(TDocument doc)

Parâmetros

Tipo	Nome	Descrição
Documento	doc	O documento a inserir.

Devoluções

Tipo	Descrição
Tarefa<MongoClient.InsertResult>	Um awaitable Task<TResult> representando a operação de inserção remota. O resultado da tarefa contém o `_id` do documento inserido.

Veja também

https://mongodb.com/pt-br/docs/manual/reference/method/db.collection.insertOne/

| Editar esta página Ver fonte

UpdateManyAsync(objeto?, objeto, bool)

Atualiza um ou mais documentos na collection de acordo com os argumentos especificados.

Declaração

public Task<MongoClient.UpdateResult> UpdateManyAsync(object? filter, object updateDocument, bool upsert = false)

Parâmetros

Tipo	Nome	Descrição
objeto	filtro, filtro	Um documento que descreve os critérios de seleção da atualização. Se não for especificado, todos os documentos da collection serão atualizados. Só pode conter expressões do seletor de query.
objeto	Atualizar documento	Um documento descrevendo a atualização. Só pode conter expressões de operador de atualização.
bool	upsert	Um booleano que controla se a atualização deve inserir um documento se nenhum documento corresponder ao `filter` . O padrão é `false`.

Devoluções

Tipo	Descrição
Tarefa<MongoClient.UpdateResult>	Um awaitable Task<TResult> representando a operação de atualização remota muitos. O resultado da tarefa contém informações sobre o número de documentos correspondentes e atualizados, bem como o `_id` do documento atualizado e inserido se `upsert` foi definido como `true` e a operação resultou em um upsert.

Veja também

https://mongodb.com/pt-br/docs/manual/reference/method/db.collection.updateMany/

| Editar esta página Ver fonte

UpdateOneAsync(objeto?, objeto, bool)

Atualiza um único documento na collection de acordo com os argumentos especificados.

Declaração

public Task<MongoClient.UpdateResult> UpdateOneAsync(object? filter, object updateDocument, bool upsert = false)

Parâmetros

Tipo	Nome	Descrição
objeto	filtro, filtro	Um documento que descreve os critérios de seleção da atualização. Se não for especificado, o primeiro documento da collection será atualizado. Só pode conter expressões do seletor de query.
objeto	Atualizar documento	Um documento descrevendo a atualização. Só pode conter expressões de operador de atualização.
bool	upsert	Um booleano que controla se a atualização deve inserir um documento se nenhum documento corresponder ao `filter` . O padrão é `false`.

Devoluções

Tipo	Descrição
Tarefa<MongoClient.UpdateResult>	Um awaitable Task<TResult> representando a operação de atualização remota. O resultado da tarefa contém informações sobre o número de documentos correspondentes e atualizados, bem como o `_id` do documento atualizado e inserido se `upsert` foi definido como `true` e a operação resultou em um upsert.

Veja também

https://mongodb.com/pt-br/docs/manual/reference/method/db.collection.updateOne/