你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

DocumentCollection 类

定义

命名空间:

Microsoft.Azure.Documents

程序集:

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

包:

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

表示 Azure Cosmos DB 服务中的文档集合。 集合是文档的命名逻辑容器。

public class DocumentCollection : Microsoft.Azure.Documents.Resource

type DocumentCollection = class
    inherit Resource

Public Class DocumentCollection
Inherits Resource

继承

Object

JsonSerializable

Resource

DocumentCollection

示例

以下示例创建一个新的分区集合，其每单位请求吞吐量为 50000。 分区键是此集合内所有文档的第一级“country”属性。

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

以下示例创建一个新集合，其中 OfferThroughput 设置为 10000。

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

以下示例使用自定义索引策略创建新的集合。

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

以下示例在此集合中创建 Book 类型的文档。

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

以下示例按 ID 查询数据库以检索 SelfLink。

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

下面的示例删除此集合。

await client.DeleteDocumentCollectionAsync(collection.SelfLink);

注解

数据库可能包含零个或多个命名集合，每个集合由零个或多个 JSON 文档组成。 由于没有架构，集合中的文档不需要共享相同的结构或字段。 由于集合是应用程序资源，因此可以使用主密钥或资源密钥进行授权。 有关集合的更多详细信息，请参阅 。

构造函数

DocumentCollection()

为 Azure Cosmos DB 服务初始化 类的新实例 DocumentCollection 。

属性

AltLink	从 Azure Cosmos DB 服务中获取与资源关联的 alt 链接。 (继承自 Resource)
ConflictResolutionPolicy	获取或设置 ConflictResolutionPolicy 用于解决 Azure Cosmos DB 服务集合中不同区域中文档的冲突写入的 。
ConflictsLink	从 Azure Cosmos DB 服务获取集合中冲突的自链接。
DefaultTimeToLive	从 Azure Cosmos DB 服务获取集合中文档的默认生存时间（以秒为单位）。
DocumentsLink	从 Azure Cosmos DB 服务获取集合中文档的自链接。
ETag	从 Azure Cosmos DB 服务中获取与资源关联的实体标记。 (继承自 Resource)
GeospatialConfig	GeospatialConfig从 Azure Cosmos DB 服务获取与集合关联的 。
Id	获取或设置 Azure Cosmos DB 服务中资源的 ID。 (继承自 Resource)
IndexingPolicy	IndexingPolicy从 Azure Cosmos DB 服务获取与集合关联的 。
PartitionKey	获取或设置 PartitionKeyDefinition Azure Cosmos DB 服务中的 对象。
PartitionKeyDeleteThroughputFraction	已过时. 获取或设置集合的 PartitionKeyDeleteThroughputFraction。
PartitionKeyRangeStatistics	获取 Azure Cosmos DB 服务中的 对象的集合 PartitionKeyRangeStatistics 。
ResourceId	获取或设置与 Azure Cosmos DB 服务中的资源关联的资源 ID。 (继承自 Resource)
SelfLink	从 Azure Cosmos DB 服务获取与资源关联的自链接。 (继承自 Resource)
StoredProceduresLink	从 Azure Cosmos DB 服务获取集合中存储过程的自链接。
Timestamp	从 Azure Cosmos DB 服务中获取与资源关联的上次修改时间戳。 (继承自 Resource)
TimeToLivePropertyPath	获取或设置生存时间基时间戳属性路径。
TriggersLink	从 Azure Cosmos DB 服务获取集合中触发器的自链接。
UniqueKeyPolicy	获取或设置保证 UniqueKeyPolicy Azure Cosmos DB 服务集合中文档的唯一性的 。
UserDefinedFunctionsLink	从 Azure Cosmos DB 服务获取集合中用户定义的函数的自链接。

方法

GetPropertyValue<T>(String)	从 Azure Cosmos DB 服务中获取与指定属性名称关联的属性值。 (继承自 Resource)
LoadFrom(JsonReader)	从 Azure Cosmos DB 服务中的指定 JSON 读取器加载对象。 (继承自 JsonSerializable)
LoadFrom(JsonReader, JsonSerializerSettings)	从 Azure Cosmos DB 服务中的指定 JSON 读取器加载对象。 (继承自 JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy)	将 对象保存到 Azure Cosmos DB 服务中的指定流。 (继承自 JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy, JsonSerializerSettings)	将 对象保存到 Azure Cosmos DB 服务中的指定流。 (继承自 JsonSerializable)
SetPropertyValue(String, Object)	设置与 Azure Cosmos DB 服务中的指定属性名称关联的属性值。 (继承自 Resource)
ToByteArray()	通过 Azure Cosmos DB 服务的 SaveTo 序列化为字节数组。 (继承自 Resource)
ToString()	返回 Azure Cosmos DB 服务中对象的字符串表示形式。 (继承自 JsonSerializable)

另请参阅

• IndexingPolicy
• PartitionKeyDefinition
• Document
• Database
• Offer