DocumentCollection Klasse

Referenz

Definition

Namespace:: Microsoft.Azure.Documents

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

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

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Stellt eine Dokumentsammlung im Azure Cosmos DB-Dienst dar. Eine Sammlung ist ein benannter logischer Container für Dokumente.

public class DocumentCollection : Microsoft.Azure.Documents.Resource

type DocumentCollection = class
    inherit Resource

Public Class DocumentCollection
Inherits Resource

Vererbung: Object

JsonSerializable

Resource
DocumentCollection

Beispiele

Im folgenden Beispiel wird eine neue partitionierte Auflistung mit einem Durchsatz von 50000 Anforderungen pro Einheit erstellt. Der Partitionsschlüssel ist die eigenschaft "country" der ersten Ebene in allen Dokumenten in dieser Sammlung.

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

Im folgenden Beispiel wird eine neue Auflistung erstellt, deren OfferThroughput auf 10000 festgelegt ist.

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

Im folgenden Beispiel wird eine neue Auflistung mit einer benutzerdefinierten Indizierungsrichtlinie erstellt.

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

Im folgenden Beispiel wird ein Dokument vom Typ Book in dieser Auflistung erstellt.

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

Im folgenden Beispiel wird eine Datenbank anhand der ID abgefragt, um den SelfLink abzurufen.

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

Im folgenden Beispiel wird diese Auflistung gelöscht.

await client.DeleteDocumentCollectionAsync(collection.SelfLink);

Hinweise

Eine Datenbank kann null oder mehr benannte Auflistungen enthalten, und jede Sammlung besteht aus 0 oder mehr JSON-Dokumenten. Da sie schemafrei sind, müssen die Dokumente in einer Auflistung nicht dieselbe Struktur oder felder verwenden. Da Sammlungen Anwendungsressourcen sind, können sie entweder mithilfe des master-Schlüssels oder mit Ressourcenschlüsseln autorisiert werden. Weitere Informationen zu Sammlungen finden Sie unter.

Konstruktoren

DocumentCollection()

Initialisiert eine neue instance der DocumentCollection -Klasse für den Azure Cosmos DB-Dienst.

Eigenschaften

AltLink	Ruft den alt-link ab, der der Ressource aus dem Azure Cosmos DB-Dienst zugeordnet ist. (Geerbt von Resource)
ConflictResolutionPolicy	Ruft den ab, der ConflictResolutionPolicy zum Auflösen von in Konflikt stehenden Schreibvorgängen in Dokumenten in verschiedenen Regionen in einer Sammlung im Azure Cosmos DB-Dienst verwendet wird, oder legt diesen fest.
ConflictsLink	Ruft die Selbstverknüpfung für Konflikte in einer Auflistung aus dem Azure Cosmos DB-Dienst ab.
DefaultTimeToLive	Ruft die Standardlaufzeit in Sekunden für Dokumente in einer Auflistung aus dem Azure Cosmos DB-Dienst ab.
DocumentsLink	Ruft die Selbstverknüpfung für Dokumente in einer Auflistung aus dem Azure Cosmos DB-Dienst ab.
ETag	Ruft das Entitätstag ab, das der Ressource aus dem Azure Cosmos DB-Dienst zugeordnet ist. (Geerbt von Resource)
GeospatialConfig	Ruft die ab, die GeospatialConfig der Auflistung aus dem Azure Cosmos DB-Dienst zugeordnet ist.
Id	Ruft die ID der Ressource im Azure Cosmos DB-Dienst ab oder legt sie fest. (Geerbt von Resource)
IndexingPolicy	Ruft die ab, die IndexingPolicy der Auflistung aus dem Azure Cosmos DB-Dienst zugeordnet ist.
PartitionKey	Ruft das Objekt im Azure Cosmos DB-Dienst ab oder legt es fest PartitionKeyDefinition .
PartitionKeyDeleteThroughputFraction	Veraltet. Ruft die PartitionKeyDeleteThroughputFraction für die Auflistung ab oder legt sie fest.
PartitionKeyRangeStatistics	Ruft eine Auflistung des PartitionKeyRangeStatistics -Objekts im Azure Cosmos DB-Dienst ab.
ResourceId	Ruft die Ressourcen-ID ab, die der Ressource im Azure Cosmos DB-Dienst zugeordnet ist, oder legt sie fest. (Geerbt von Resource)
SelfLink	Ruft die der Ressource zugeordnete Selbstverknüpfung aus dem Azure Cosmos DB-Dienst ab. (Geerbt von Resource)
StoredProceduresLink	Ruft die Selbstverknüpfung für gespeicherte Prozeduren in einer Auflistung aus dem Azure Cosmos DB-Dienst ab.
Timestamp	Ruft den der Ressource zugeordneten Zeitstempel der letzten Änderung aus dem Azure Cosmos DB-Dienst ab. (Geerbt von Resource)
TimeToLivePropertyPath	Ruft den Timestamp-Basiseigenschaftspfad ab oder legt diesen fest.
TriggersLink	Ruft die Selbstverknüpfung für Trigger in einer Auflistung aus dem Azure Cosmos DB-Dienst ab.
UniqueKeyPolicy	Ruft den ab, der die UniqueKeyPolicy Eindeutigkeit von Dokumenten in der Sammlung im Azure Cosmos DB-Dienst garantiert, oder legt diesen fest.
UserDefinedFunctionsLink	Ruft die Selbstverknüpfung für benutzerdefinierte Funktionen in einer Auflistung aus dem Azure Cosmos DB-Dienst ab.

Methoden

GetPropertyValue<T>(String)	Ruft den Eigenschaftswert ab, der dem angegebenen Eigenschaftsnamen aus dem Azure Cosmos DB-Dienst zugeordnet ist. (Geerbt von Resource)
LoadFrom(JsonReader)	Lädt das Objekt aus dem angegebenen JSON-Reader im Azure Cosmos DB-Dienst. (Geerbt von JsonSerializable)
LoadFrom(JsonReader, JsonSerializerSettings)	Lädt das Objekt aus dem angegebenen JSON-Reader im Azure Cosmos DB-Dienst. (Geerbt von JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy)	Speichert das Objekt im angegebenen Stream im Azure Cosmos DB-Dienst. (Geerbt von JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy, JsonSerializerSettings)	Speichert das Objekt im angegebenen Stream im Azure Cosmos DB-Dienst. (Geerbt von JsonSerializable)
SetPropertyValue(String, Object)	Legt den Eigenschaftswert fest, der dem angegebenen Eigenschaftsnamen im Azure Cosmos DB-Dienst zugeordnet ist. (Geerbt von Resource)
ToByteArray()	Serialisieren sie in ein Bytearray über SaveTo für den Azure Cosmos DB-Dienst. (Geerbt von Resource)
ToString()	Gibt die Zeichenfolgendarstellung des Objekts im Azure Cosmos DB-Dienst zurück. (Geerbt von JsonSerializable)

Gilt für:

Freigeben über