-
Notifications
You must be signed in to change notification settings - Fork 260
/
HashIndex.xml
212 lines (212 loc) · 11.6 KB
/
HashIndex.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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
<Type Name="HashIndex" FullName="Microsoft.Azure.Documents.HashIndex">
<TypeSignature Language="C#" Value="public sealed class HashIndex : Microsoft.Azure.Documents.Index" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit HashIndex extends Microsoft.Azure.Documents.Index" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.HashIndex" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class HashIndex
Inherits Index" />
<TypeSignature Language="F#" Value="type HashIndex = class
 inherit Index" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.14.0.0</AssemblyVersion>
<AssemblyVersion>2.14.1.0</AssemblyVersion>
<AssemblyVersion>2.15.0.0</AssemblyVersion>
<AssemblyVersion>2.16.0.0</AssemblyVersion>
<AssemblyVersion>2.16.1.0</AssemblyVersion>
<AssemblyVersion>2.16.2.0</AssemblyVersion>
<AssemblyVersion>2.17.0.0</AssemblyVersion>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.14.0.0</AssemblyVersion>
<AssemblyVersion>2.14.1.0</AssemblyVersion>
<AssemblyVersion>2.15.0.0</AssemblyVersion>
<AssemblyVersion>2.16.0.0</AssemblyVersion>
<AssemblyVersion>2.16.1.0</AssemblyVersion>
<AssemblyVersion>2.16.2.0</AssemblyVersion>
<AssemblyVersion>2.17.0.0</AssemblyVersion>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Documents.Index</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.ICloneable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Represents details of the hash index setting in an Azure Cosmos DB service.
</summary>
<remarks>
Can be used to serve queries like: SELECT * FROM docs d WHERE d.prop = 5.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HashIndex (Microsoft.Azure.Documents.DataType dataType);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Microsoft.Azure.Documents.DataType dataType) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.HashIndex.#ctor(Microsoft.Azure.Documents.DataType)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (dataType As DataType)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Documents.HashIndex : Microsoft.Azure.Documents.DataType -> Microsoft.Azure.Documents.HashIndex" Usage="new Microsoft.Azure.Documents.HashIndex dataType" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="dataType" Type="Microsoft.Azure.Documents.DataType" />
</Parameters>
<Docs>
<param name="dataType">Specifies the target data type for the index path specification.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Documents.HashIndex" /> class with specified DataType for the Azure Cosmos DB service.
</summary>
<remarks>To be added.</remarks>
<altmember cref="P:Microsoft.Azure.Documents.HashIndex.DataType" />
<example>
Here is an example to instantiate HashIndex class passing in the DataType:
<code language="c#"><![CDATA[
HashIndex hashIndex = new HashIndex(DataType.String);
]]></code></example>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HashIndex (Microsoft.Azure.Documents.DataType dataType, short precision);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Microsoft.Azure.Documents.DataType dataType, int16 precision) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.HashIndex.#ctor(Microsoft.Azure.Documents.DataType,System.Int16)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (dataType As DataType, precision As Short)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Documents.HashIndex : Microsoft.Azure.Documents.DataType * int16 -> Microsoft.Azure.Documents.HashIndex" Usage="new Microsoft.Azure.Documents.HashIndex (dataType, precision)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="dataType" Type="Microsoft.Azure.Documents.DataType" />
<Parameter Name="precision" Type="System.Int16" />
</Parameters>
<Docs>
<param name="dataType">Specifies the target data type for the index path specification.</param>
<param name="precision">Specifies the precision to be used for the data type associated with this index.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Documents.HashIndex" /> class with specified DataType and precision for the Azure Cosmos DB service.
</summary>
<remarks>To be added.</remarks>
<altmember cref="P:Microsoft.Azure.Documents.HashIndex.DataType" />
<example>
Here is an example to instantiate HashIndex class passing in the DataType and precision:
<code language="c#"><![CDATA[
HashIndex hashIndex = new HashIndex(DataType.String, 3);
]]></code></example>
</Docs>
</Member>
<Member MemberName="Clone">
<MemberSignature Language="C#" Value="public object Clone ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance object Clone() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.HashIndex.Clone" />
<MemberSignature Language="VB.NET" Value="Public Function Clone () As Object" />
<MemberSignature Language="F#" Value="abstract member Clone : unit -> obj
override this.Clone : unit -> obj" Usage="hashIndex.Clone " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Creates a copy of the hash index for the Azure Cosmos DB service.
</summary>
<returns>A clone of the hash index.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DataType">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Documents.DataType DataType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Documents.DataType DataType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.HashIndex.DataType" />
<MemberSignature Language="VB.NET" Value="Public Property DataType As DataType" />
<MemberSignature Language="F#" Value="member this.DataType : Microsoft.Azure.Documents.DataType with get, set" Usage="Microsoft.Azure.Documents.HashIndex.DataType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="dataType")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="dataType")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Documents.DataType</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the data type for which this index should be applied in the Azure Cosmos DB service.
</summary>
<value>
The data type for which this index should be applied.
</value>
<remarks>Refer to <a href="http://azure.microsoft.com/documentation/articles/documentdb-indexing-policies/#ConfigPolicy">Customizing the indexing policy of a collection</a> for valid ranges of values.</remarks>
</Docs>
</Member>
<Member MemberName="Precision">
<MemberSignature Language="C#" Value="public short? Precision { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int16> Precision" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.HashIndex.Precision" />
<MemberSignature Language="VB.NET" Value="Public Property Precision As Nullable(Of Short)" />
<MemberSignature Language="F#" Value="member this.Precision : Nullable<int16> with get, set" Usage="Microsoft.Azure.Documents.HashIndex.Precision" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="precision")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="precision")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int16></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the precision for this particular index in the Azure Cosmos DB service.
</summary>
<value>
The precision for this particular index. Returns null, if not set.
</value>
<remarks>Refer to <a href="http://azure.microsoft.com/documentation/articles/documentdb-indexing-policies/#ConfigPolicy">Customizing the indexing policy of a collection</a> for valid ranges of values.</remarks>
</Docs>
</Member>
</Members>
</Type>