-
Notifications
You must be signed in to change notification settings - Fork 255
/
UniqueKey.xml
77 lines (77 loc) · 3.97 KB
/
UniqueKey.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
<Type Name="UniqueKey" FullName="Microsoft.Azure.Cosmos.UniqueKey">
<TypeSignature Language="C#" Value="public class UniqueKey" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit UniqueKey extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Cosmos.UniqueKey" />
<TypeSignature Language="VB.NET" Value="Public Class UniqueKey" />
<TypeSignature Language="F#" Value="type UniqueKey = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.36.0.0</AssemblyVersion>
<AssemblyVersion>3.38.1.0</AssemblyVersion>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents a unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
</summary>
<remarks>
1) For partitioned collections, the value of partition key is implicitly a part of each unique key.
2) Uniqueness constraint is also enforced for missing values.
For instance, if unique key policy defines a unique key with single property path, there could be only one document that has missing value for this property.
</remarks>
<altmember cref="T:Microsoft.Azure.Cosmos.UniqueKeyPolicy" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public UniqueKey ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.UniqueKey.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Paths">
<MemberSignature Language="C#" Value="public System.Collections.ObjectModel.Collection<string> Paths { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.Collection`1<string> Paths" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.UniqueKey.Paths" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Paths As Collection(Of String)" />
<MemberSignature Language="F#" Value="member this.Paths : System.Collections.ObjectModel.Collection<string>" Usage="Microsoft.Azure.Cosmos.UniqueKey.Paths" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="paths")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="paths")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.Collection<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the paths, a set of which must be unique for each document in the Azure Cosmos DB service.
</summary>
<value><![CDATA[The paths to enforce uniqueness on. Each path is a rooted path of the unique property in the document, such as "/name/first".]]></value>
<remarks>To be added.</remarks>
<example><![CDATA[
uniqueKey.Paths = new Collection<string> { "/name/first", "/name/last" };
]]></example>
</Docs>
</Member>
</Members>
</Type>