DocumentCollection Class

 

Updated: June 30, 2017

Represents a document collection in the Azure DocumentDB database service. A collection is a named logical container for documents.

Namespace:   Microsoft.Azure.Documents
Assembly:  Microsoft.Azure.Documents.Client (in Microsoft.Azure.Documents.Client.dll)

SystemObject
  Microsoft.Azure.DocumentsJsonSerializable
    Microsoft.Azure.DocumentsResource
      Microsoft.Azure.DocumentsDocumentCollection

C#
C++
VB
F#
Copy
No code example is currently available or this language may not be supported.

NameDescription
System_CAPS_pubmethodDocumentCollection

Initializes a new instance of the DocumentCollection class for the Azure DocumentDB database service.

NameDescription
System_CAPS_pubproperty

Gets the alt-link associated with the resource from the Azure DocumentDB database service. (Inherited from Resource.)

System_CAPS_pubproperty

Gets the self-link for conflicts in a collection from the Azure DocumentDB database service.

System_CAPS_pubproperty

Gets the default time to live in seconds for documents in a collection from the Azure DocumentDB database service.

System_CAPS_pubproperty

Gets the self-link for documents in a collection from the Azure DocumentDB database service.

System_CAPS_pubproperty

Gets the entity tag associated with the resource from the Azure DocumentDB database service. (Inherited from Resource.)

System_CAPS_pubproperty

Gets or sets the Id of the resource in the Azure DocumentDB database service. (Inherited from Resource.)

System_CAPS_pubproperty

Gets the associated with the collection from the Azure DocumentDB database service.

System_CAPS_pubproperty

Gets or sets PartitionKeyDefinition object in the Azure DocumentDB database service.

System_CAPS_pubproperty

Gets or sets the Resource Id associated with the resource in the Azure DocumentDB database service. (Inherited from Resource.)

System_CAPS_pubproperty

Gets the self-link associated with the resource from the Azure DocumentDB database service. (Inherited from Resource.)

System_CAPS_pubproperty

Gets the self-link for stored procedures in a collection from the Azure DocumentDB database service.

System_CAPS_pubproperty

Gets the last modified timestamp associated with the resource from the Azure DocumentDB database service. (Inherited from Resource.)

System_CAPS_pubproperty

Gets the self-link for triggers in a collection from the Azure DocumentDB database service.

System_CAPS_pubproperty

Gets the self-link for user defined functions in a collection from the Azure DocumentDB database service.

NameDescription
System_CAPS_pubmethodEquals

(Inherited from Object.)

System_CAPS_protmethodFinalize

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode

(Inherited from Object.)

System_CAPS_pubmethodGetPropertyValue

Gets property value associated with the specified property name from the Azure DocumentDB database service. (Inherited from Resource.)

System_CAPS_pubmethodGetType

(Inherited from Object.)

System_CAPS_pubmethodLoadFrom

Loads the object from the specified JSON reader in the Azure DocumentDB database service. (Inherited from JsonSerializable.)

System_CAPS_protmethodMemberwiseClone

(Inherited from Object.)

System_CAPS_pubmethodSaveTo

Saves the object to the specified stream in the Azure DocumentDB database service. (Inherited from JsonSerializable.)

System_CAPS_pubmethodSetPropertyValue

Sets property value associated with the specified property name in the Azure DocumentDB database service. (Inherited from Resource.)

System_CAPS_pubmethodToByteArray

Serialize to a byte array via SaveTo for the Azure DocumentDB database service. (Inherited from Resource.)

System_CAPS_pubmethodToString

Returns the string representation of the object in the Azure DocumentDB database service. (Inherited from JsonSerializable.)

NameDescription
System_CAPS_pubmethodIsDefined

Determines if a certain property is defined or not. (Defined by TypeCheckFunctionsExtensions.)

System_CAPS_pubmethodIsNull

Determines if a certain property is null or not. (Defined by TypeCheckFunctionsExtensions.)

System_CAPS_pubmethodIsPrimitive

Determines if a certain property is of premitive JSON type. (Defined by TypeCheckFunctionsExtensions.)

A database may contain zero or more named collections and each collection consists of zero or more JSON documents. Being schema-free, the documents in a collection do not need to share the same structure or fields. Since collections are application resources, they can be authorized using either the master key or resource keys. Refer to for more details on collections.

The example below creates a new partitioned collection with 50000 Request-per-Unit throughput. The partition key is the first level 'country' property in all the documents within this collection.

C#
Copy 

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

The example below creates a new collection with a custom indexing policy.

C#
Copy 

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

The example below deletes this collection.

C#
Copy 

await client.DeleteDocumentCollectionAsync(collection.SelfLink);

The example below creates a new collection with OfferThroughput set to 10000.

C#
Copy 

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

The example below queries for a Database by Id to retrieve the SelfLink.

C#
Copy 

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

The example below creates a document of type Book inside this collection.

C#
Copy 

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

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: