DocumentCollection Classe

Definição

Namespace:

Microsoft.Azure.Documents

Assemblies:

Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Pacotes:

Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Representa uma coleção de documentos no serviço do Azure Cosmos DB. Uma coleção é um contêiner lógico nomeado para documentos.

public class DocumentCollection : Microsoft.Azure.Documents.Resource

type DocumentCollection = class
    inherit Resource

Public Class DocumentCollection
Inherits Resource

Herança

Object

JsonSerializable

Resource

DocumentCollection

Exemplos

O exemplo a seguir cria uma nova coleção particionada com taxa de transferência de Solicitação por Unidade de 50000. A chave de partição é a propriedade "country" de primeiro nível em todos os documentos dessa coleção.

DocumentCollection collection = await client.CreateDocumentCollectionAsync(
    databaseLink,
    new DocumentCollection 
    { 
        Id = "MyCollection",
        PartitionKey = new PartitionKeyDefinition
        {
            Paths = new Collection<string> { "/country" }
        }
    }, 
    new RequestOptions { OfferThroughput = 50000} ).Result;

O exemplo a seguir cria uma nova coleção com OfferThroughput definido como 10000.

DocumentCollection collection = await client.CreateDocumentCollectionAsync(
    databaseLink,
    new DocumentCollection { Id = "MyCollection" }, 
    new RequestOptions { OfferThroughput = 10000} ).Result;

O exemplo a seguir cria uma nova coleção com uma política de indexação personalizada.

DocumentCollection collectionSpec = new DocumentCollection { Id ="MyCollection" };
collectionSpec.IndexingPolicy.Automatic = true;
collectionSpec.IndexingPolicy.IndexingMode = IndexingMode.Consistent;
collection = await client.CreateDocumentCollectionAsync(database.SelfLink, collectionSpec);

O exemplo a seguir cria um documento do tipo Livro dentro dessa coleção.

Document doc = await client.CreateDocumentAsync(collection.SelfLink, new Book { Title = "War and Peace" });

O exemplo abaixo consulta um Banco de Dados por Id para recuperar o SelfLink.

using Microsoft.Azure.Documents.Linq;
DocumentCollection collection = client.CreateDocumentCollectionQuery(databaseLink).Where(c => c.Id == "myColl").AsEnumerable().FirstOrDefault();
string collectionLink = collection.SelfLink;

O exemplo a seguir exclui essa coleção.

await client.DeleteDocumentCollectionAsync(collection.SelfLink);

Comentários

Um banco de dados pode conter zero ou mais coleções nomeadas e cada coleção consiste em zero ou mais documentos JSON. Sendo livres de esquema, os documentos em uma coleção não precisam compartilhar a mesma estrutura ou campos. Como as coleções são recursos de aplicativo, elas podem ser autorizadas usando a chave master ou as chaves de recurso. Consulte para obter mais detalhes sobre coleções.

Construtores

DocumentCollection()

Inicializa uma nova instância da DocumentCollection classe para o serviço do Azure Cosmos DB.

Propriedades

AltLink	Obtém o alt-link associado ao recurso do serviço do Azure Cosmos DB. (Herdado de Resource)
ConflictResolutionPolicy	Obtém ou define o ConflictResolutionPolicy usado para resolver gravações conflitantes em documentos em regiões diferentes, em uma coleção no serviço do Azure Cosmos DB.
ConflictsLink	Obtém o auto-link para conflitos em uma coleção do serviço do Azure Cosmos DB.
DefaultTimeToLive	Obtém o tempo padrão de vida em segundos para documentos em uma coleção do serviço do Azure Cosmos DB.
DocumentsLink	Obtém o auto-link para documentos em uma coleção do serviço do Azure Cosmos DB.
ETag	Obtém a marca de entidade associada ao recurso do serviço do Azure Cosmos DB. (Herdado de Resource)
GeospatialConfig	Obtém o GeospatialConfig associado à coleção do serviço do Azure Cosmos DB.
Id	Obtém ou define a ID do recurso no serviço do Azure Cosmos DB. (Herdado de Resource)
IndexingPolicy	Obtém o IndexingPolicy associado à coleção do serviço do Azure Cosmos DB.
PartitionKey	Obtém ou define PartitionKeyDefinition o objeto no serviço do Azure Cosmos DB.
PartitionKeyDeleteThroughputFraction	Obsoleto. Obtém ou define o PartitionKeyDeleteThroughputFraction para a coleção.
PartitionKeyRangeStatistics	Obtém uma coleção de PartitionKeyRangeStatistics objetos no serviço do Azure Cosmos DB.
ResourceId	Obtém ou define a ID do recurso associada ao recurso no serviço do Azure Cosmos DB. (Herdado de Resource)
SelfLink	Obtém o auto-link associado ao recurso do serviço do Azure Cosmos DB. (Herdado de Resource)
StoredProceduresLink	Obtém o auto-link para procedimentos armazenados em uma coleção do serviço do Azure Cosmos DB.
Timestamp	Obtém o último carimbo de data/hora modificado associado ao recurso do serviço do Azure Cosmos DB. (Herdado de Resource)
TimeToLivePropertyPath	Obtém ou define o caminho da propriedade de carimbo de data/hora base ao vivo.
TriggersLink	Obtém o auto-link para gatilhos em uma coleção do serviço do Azure Cosmos DB.
UniqueKeyPolicy	Obtém ou define o UniqueKeyPolicy que garante a exclusividade dos documentos na coleção no serviço do Azure Cosmos DB.
UserDefinedFunctionsLink	Obtém o auto-link para funções definidas pelo usuário em uma coleção do serviço do Azure Cosmos DB.

Métodos

GetPropertyValue<T>(String)	Obtém o valor da propriedade associado ao nome da propriedade especificado do serviço do Azure Cosmos DB. (Herdado de Resource)
LoadFrom(JsonReader)	Carrega o objeto do leitor JSON especificado no serviço do Azure Cosmos DB. (Herdado de JsonSerializable)
LoadFrom(JsonReader, JsonSerializerSettings)	Carrega o objeto do leitor JSON especificado no serviço do Azure Cosmos DB. (Herdado de JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy)	Salva o objeto no fluxo especificado no serviço do Azure Cosmos DB. (Herdado de JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy, JsonSerializerSettings)	Salva o objeto no fluxo especificado no serviço do Azure Cosmos DB. (Herdado de JsonSerializable)
SetPropertyValue(String, Object)	Define o valor da propriedade associado ao nome da propriedade especificado no serviço do Azure Cosmos DB. (Herdado de Resource)
ToByteArray()	Serialize para uma matriz de bytes por meio de SaveTo para o serviço do Azure Cosmos DB. (Herdado de Resource)
ToString()	Retorna a representação de cadeia de caracteres do objeto no serviço do Azure Cosmos DB. (Herdado de JsonSerializable)

Confira também

• IndexingPolicy
• PartitionKeyDefinition
• Document
• Database
• Offer