Partager via


DocumentCollection Classe

Définition

Représente une collection de documents dans le service Azure Cosmos DB. Une collection est un conteneur logique nommé pour les documents.

public class DocumentCollection : Microsoft.Azure.Documents.Resource
type DocumentCollection = class
    inherit Resource
Public Class DocumentCollection
Inherits Resource
Héritage
DocumentCollection

Exemples

L’exemple ci-dessous crée une collection partitionnée avec un débit de requête par unité de 50 000. La clé de partition est la propriété « country » de premier niveau dans tous les documents de cette collection.

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

L’exemple ci-dessous crée une collection avec OfferThroughput défini sur 10000.

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

L’exemple ci-dessous crée une collection avec une stratégie d’indexation personnalisée.

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

L’exemple ci-dessous crée un document de type Book dans cette collection.

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

L’exemple ci-dessous recherche une base de données par ID pour récupérer le SelfLink.

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

L’exemple ci-dessous supprime cette collection.

await client.DeleteDocumentCollectionAsync(collection.SelfLink);

Remarques

Une base de données peut contenir zéro ou plusieurs collections nommées et chaque collection se compose de zéro ou plusieurs documents JSON. Étant sans schéma, les documents d’une collection n’ont pas besoin de partager la même structure ou les mêmes champs. Étant donné que les collections sont des ressources d’application, elles peuvent être autorisées à l’aide de la clé master ou des clés de ressource. Reportez-vous à pour plus d’informations sur les collections.

Constructeurs

DocumentCollection()

Initialise une nouvelle instance de la DocumentCollection classe pour le service Azure Cosmos DB.

Propriétés

AltLink

Obtient le lien de remplacement associé à la ressource à partir du service Azure Cosmos DB.

(Hérité de Resource)
ConflictResolutionPolicy

Obtient ou définit le ConflictResolutionPolicy qui est utilisé pour résoudre les écritures en conflit sur des documents dans différentes régions, dans une collection dans le service Azure Cosmos DB.

ConflictsLink

Obtient l’auto-liaison pour les conflits dans une collection à partir du service Azure Cosmos DB.

DefaultTimeToLive

Obtient la durée de vie par défaut en secondes pour les documents d’une collection à partir du service Azure Cosmos DB.

DocumentsLink

Obtient le lien automatique pour les documents d’une collection à partir du service Azure Cosmos DB.

ETag

Obtient la balise d’entité associée à la ressource à partir du service Azure Cosmos DB.

(Hérité de Resource)
GeospatialConfig

Obtient le GeospatialConfig associé à la collection à partir du service Azure Cosmos DB.

Id

Obtient ou définit l’ID de la ressource dans le service Azure Cosmos DB.

(Hérité de Resource)
IndexingPolicy

Obtient le IndexingPolicy associé à la collection à partir du service Azure Cosmos DB.

PartitionKey

Obtient ou définit PartitionKeyDefinition l’objet dans le service Azure Cosmos DB.

PartitionKeyDeleteThroughputFraction
Obsolète.

Obtient ou définit partitionKeyDeleteThroughputFraction pour la collection.

PartitionKeyRangeStatistics

Obtient une collection d’objets PartitionKeyRangeStatistics dans le service Azure Cosmos DB.

ResourceId

Obtient ou définit l’ID de ressource associé à la ressource dans le service Azure Cosmos DB.

(Hérité de Resource)
SelfLink

Obtient l’auto-liaison associée à la ressource à partir du service Azure Cosmos DB.

(Hérité de Resource)
StoredProceduresLink

Obtient l’auto-liaison pour les procédures stockées dans une collection à partir du service Azure Cosmos DB.

Timestamp

Obtient le dernier horodatage modifié associé à la ressource à partir du service Azure Cosmos DB.

(Hérité de Resource)
TimeToLivePropertyPath

Obtient ou définit le chemin de la propriété time to live base timestamp.

TriggersLink

Obtient l’auto-liaison pour les déclencheurs d’une collection à partir du service Azure Cosmos DB.

UniqueKeyPolicy

Obtient ou définit le qui garantit l’unicité UniqueKeyPolicy des documents dans la collection dans le service Azure Cosmos DB.

UserDefinedFunctionsLink

Obtient l’auto-liaison pour les fonctions définies par l’utilisateur dans une collection à partir du service Azure Cosmos DB.

Méthodes

GetPropertyValue<T>(String)

Obtient la valeur de propriété associée au nom de propriété spécifié à partir du service Azure Cosmos DB.

(Hérité de Resource)
LoadFrom(JsonReader)

Charge l’objet à partir du lecteur JSON spécifié dans le service Azure Cosmos DB.

(Hérité de JsonSerializable)
LoadFrom(JsonReader, JsonSerializerSettings)

Charge l’objet à partir du lecteur JSON spécifié dans le service Azure Cosmos DB.

(Hérité de JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy)

Enregistre l’objet dans le flux spécifié dans le service Azure Cosmos DB.

(Hérité de JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy, JsonSerializerSettings)

Enregistre l’objet dans le flux spécifié dans le service Azure Cosmos DB.

(Hérité de JsonSerializable)
SetPropertyValue(String, Object)

Définit la valeur de propriété associée au nom de propriété spécifié dans le service Azure Cosmos DB.

(Hérité de Resource)
ToByteArray()

Sérialiser dans un tableau d’octets via SaveTo pour le service Azure Cosmos DB.

(Hérité de Resource)
ToString()

Retourne la représentation sous forme de chaîne de l’objet dans le service Azure Cosmos DB.

(Hérité de JsonSerializable)

S’applique à

Voir aussi