xml/Microsoft.Azure.Documents/RangeIndex.xml

<Type Name="RangeIndex" FullName="Microsoft.Azure.Documents.RangeIndex"> <TypeSignature Language="C#" Value="public sealed class RangeIndex : Microsoft.Azure.Documents.Index" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit RangeIndex extends Microsoft.Azure.Documents.Index" /> <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.RangeIndex" /> <TypeSignature Language="VB.NET" Value="Public NotInheritable Class RangeIndex
Inherits Index" /> <TypeSignature Language="F#" Value="type RangeIndex = 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> Specifies an instance of the <see cref="T:Microsoft.Azure.Documents.RangeIndex" /> class in the 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 RangeIndex (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.RangeIndex.#ctor(Microsoft.Azure.Documents.DataType)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (dataType As DataType)" /> <MemberSignature Language="F#" Value="new Microsoft.Azure.Documents.RangeIndex : Microsoft.Azure.Documents.DataType -> Microsoft.Azure.Documents.RangeIndex" Usage="new Microsoft.Azure.Documents.RangeIndex 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.RangeIndex" /> class with specified DataType for the Azure Cosmos DB service. </summary> <remarks>To be added.</remarks> <altmember cref="P:Microsoft.Azure.Documents.RangeIndex.DataType" /> <example> Here is an example to instantiate RangeIndex class passing in the DataType: <code language="c#"><![CDATA[ RangeIndex rangeIndex = new RangeIndex(DataType.Number); ]]></code></example> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public RangeIndex (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.RangeIndex.#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.RangeIndex : Microsoft.Azure.Documents.DataType * int16 -> Microsoft.Azure.Documents.RangeIndex" Usage="new Microsoft.Azure.Documents.RangeIndex (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.RangeIndex" /> class with specified DataType and precision for the Azure Cosmos DB service. </summary> <remarks>To be added.</remarks> <altmember cref="P:Microsoft.Azure.Documents.RangeIndex.DataType" /> <example> Here is an example to instantiate RangeIndex class passing in the DataType and precision: <code language="c#"><![CDATA[ RangeIndex rangeIndex = new RangeIndex(DataType.Number, -1); ]]></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.RangeIndex.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="rangeIndex.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 range index for the Azure Cosmos DB service. </summary> <returns>A clone of the range 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.RangeIndex.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.RangeIndex.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 http://azure.microsoft.com/documentation/articles/documentdb-indexing-policies/#ConfigPolicy 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.RangeIndex.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.RangeIndex.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 http://azure.microsoft.com/documentation/articles/documentdb-indexing-policies/#ConfigPolicy for valid ranges of values.</remarks> </Docs> </Member> </Members> </Type>

xml/Microsoft.Azure.Documents/RangeIndex.xml (212 lines of code) (raw):