DocumentCollection Clase

Definición

Espacio de nombres:

Microsoft.Azure.Documents

Ensamblados:

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

Paquetes:

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

Representa una colección de documentos en el servicio Azure Cosmos DB. Una colección es un contenedor lógico con nombre para documentos.

public class DocumentCollection : Microsoft.Azure.Documents.Resource

type DocumentCollection = class
    inherit Resource

Public Class DocumentCollection
Inherits Resource

Herencia

Object

JsonSerializable

Resource

DocumentCollection

Ejemplos

En el ejemplo siguiente se crea una nueva colección con particiones con un rendimiento de solicitud por unidad de 50000. La clave de partición es la propiedad de primer nivel "country" en todos los documentos de esta colección.

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

En el ejemplo siguiente se crea una nueva colección con OfferThroughput establecido en 10000.

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

En el ejemplo siguiente se crea una nueva colección con una directiva de indexación personalizada.

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

En el ejemplo siguiente se crea un documento de tipo Book dentro de esta colección.

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

En el ejemplo siguiente se consulta una base de datos por identificador para recuperar selfLink.

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

En el ejemplo siguiente se elimina esta colección.

await client.DeleteDocumentCollectionAsync(collection.SelfLink);

Comentarios

Una base de datos puede contener cero o más colecciones con nombre y cada colección consta de cero o más documentos JSON. Sin esquemas, los documentos de una colección no necesitan compartir la misma estructura o campos. Dado que las colecciones son recursos de aplicación, se pueden autorizar mediante la clave maestra o las claves de recursos. Consulte para obtener más información sobre las colecciones.

Constructores

DocumentCollection()

Inicializa una nueva instancia de la DocumentCollection clase para el servicio Azure Cosmos DB.

Propiedades

AltLink	Obtiene el vínculo alternativo asociado al recurso del servicio Azure Cosmos DB. (Heredado de Resource)
ConflictResolutionPolicy	Obtiene o establece el ConflictResolutionPolicy objeto que se usa para resolver escrituras en conflicto en documentos de diferentes regiones, en una colección del servicio Azure Cosmos DB.
ConflictsLink	Obtiene el auto-vínculo para los conflictos de una colección del servicio Azure Cosmos DB.
DefaultTimeToLive	Obtiene el tiempo predeterminado de vida en segundos para los documentos de una colección del servicio Azure Cosmos DB.
DocumentsLink	Obtiene el vínculo propio para los documentos de una colección del servicio Azure Cosmos DB.
ETag	Obtiene la etiqueta de entidad asociada al recurso del servicio Azure Cosmos DB. (Heredado de Resource)
GeospatialConfig	Obtiene el GeospatialConfig asociado a la colección del servicio Azure Cosmos DB.
Id	Obtiene o establece el identificador del recurso en el servicio Azure Cosmos DB. (Heredado de Resource)
IndexingPolicy	Obtiene el IndexingPolicy asociado a la colección del servicio Azure Cosmos DB.
PartitionKey	Obtiene o establece PartitionKeyDefinition el objeto en el servicio Azure Cosmos DB.
PartitionKeyDeleteThroughputFraction	Obsoletos. Obtiene o establece partitionKeyDeleteThroughputFraction para la colección.
PartitionKeyRangeStatistics	Obtiene una colección de PartitionKeyRangeStatistics objetos en el servicio Azure Cosmos DB.
ResourceId	Obtiene o establece el identificador de recurso asociado al recurso en el servicio Azure Cosmos DB. (Heredado de Resource)
SelfLink	Obtiene el vínculo propio asociado al recurso del servicio Azure Cosmos DB. (Heredado de Resource)
StoredProceduresLink	Obtiene el vínculo propio para los procedimientos almacenados de una colección del servicio Azure Cosmos DB.
Timestamp	Obtiene la marca de tiempo de última modificación asociada al recurso del servicio Azure Cosmos DB. (Heredado de Resource)
TimeToLivePropertyPath	Obtiene o establece el tiempo de vida de la ruta de acceso de la propiedad timestamp base.
TriggersLink	Obtiene el vínculo automático para los desencadenadores de una colección del servicio Azure Cosmos DB.
UniqueKeyPolicy	Obtiene o establece el objeto que garantiza la UniqueKeyPolicy unicidad de los documentos de la colección en el servicio Azure Cosmos DB.
UserDefinedFunctionsLink	Obtiene el vínculo automático para las funciones definidas por el usuario en una colección del servicio Azure Cosmos DB.

Métodos

GetPropertyValue<T>(String)	Obtiene el valor de propiedad asociado al nombre de propiedad especificado del servicio Azure Cosmos DB. (Heredado de Resource)
LoadFrom(JsonReader)	Carga el objeto del lector JSON especificado en el servicio Azure Cosmos DB. (Heredado de JsonSerializable)
LoadFrom(JsonReader, JsonSerializerSettings)	Carga el objeto del lector JSON especificado en el servicio Azure Cosmos DB. (Heredado de JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy)	Guarda el objeto en la secuencia especificada en el servicio Azure Cosmos DB. (Heredado de JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy, JsonSerializerSettings)	Guarda el objeto en la secuencia especificada en el servicio Azure Cosmos DB. (Heredado de JsonSerializable)
SetPropertyValue(String, Object)	Establece el valor de propiedad asociado al nombre de propiedad especificado en el servicio Azure Cosmos DB. (Heredado de Resource)
ToByteArray()	Serialice en una matriz de bytes a través de SaveTo para el servicio Azure Cosmos DB. (Heredado de Resource)
ToString()	Devuelve la representación de cadena del objeto en el servicio Azure Cosmos DB. (Heredado de JsonSerializable)

Consulte también

• IndexingPolicy
• PartitionKeyDefinition
• Document
• Database
• Offer