xml/Microsoft.Azure.Documents/Index.xml

<Type Name="Index" FullName="Microsoft.Azure.Documents.Index"> <TypeSignature Language="C#" Value="public abstract class Index : Microsoft.Azure.Documents.JsonSerializable" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit Index extends Microsoft.Azure.Documents.JsonSerializable" /> <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.Index" /> <TypeSignature Language="VB.NET" Value="Public MustInherit Class Index
Inherits JsonSerializable" /> <TypeSignature Language="F#" Value="type Index = class
 inherit JsonSerializable" /> <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.JsonSerializable</BaseTypeName> </Base> <Interfaces /> <Attributes> <Attribute> <AttributeName Language="C#">[Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Documents.IndexJsonConverter))]</AttributeName> <AttributeName Language="F#">[<Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Documents.IndexJsonConverter))>]</AttributeName> </Attribute> </Attributes> <Docs> <summary> Base class for IndexingPolicy Indexes in the Azure Cosmos DB service, you should use a concrete Index like HashIndex or RangeIndex. </summary> <remarks>To be added.</remarks> </Docs> <Members> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="protected Index (Microsoft.Azure.Documents.IndexKind kind);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Microsoft.Azure.Documents.IndexKind kind) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Index.#ctor(Microsoft.Azure.Documents.IndexKind)" /> <MemberSignature Language="VB.NET" Value="Protected Sub New (kind As IndexKind)" /> <MemberSignature Language="F#" Value="new Microsoft.Azure.Documents.Index : Microsoft.Azure.Documents.IndexKind -> Microsoft.Azure.Documents.Index" Usage="new Microsoft.Azure.Documents.Index kind" /> <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="kind" Type="Microsoft.Azure.Documents.IndexKind" /> </Parameters> <Docs> <param name="kind">To be added.</param> <summary> Initializes a new instance of the <see cref="T:Microsoft.Azure.Documents.Index" /> class for the Azure Cosmos DB service. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Hash"> <MemberSignature Language="C#" Value="public static Microsoft.Azure.Documents.HashIndex Hash (Microsoft.Azure.Documents.DataType dataType);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Documents.HashIndex Hash(valuetype Microsoft.Azure.Documents.DataType dataType) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Index.Hash(Microsoft.Azure.Documents.DataType)" /> <MemberSignature Language="VB.NET" Value="Public Shared Function Hash (dataType As DataType) As HashIndex" /> <MemberSignature Language="F#" Value="static member Hash : Microsoft.Azure.Documents.DataType -> Microsoft.Azure.Documents.HashIndex" Usage="Microsoft.Azure.Documents.Index.Hash dataType" /> <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>Microsoft.Azure.Documents.HashIndex</ReturnType> </ReturnValue> <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> Returns an instance of the <see cref="T:Microsoft.Azure.Documents.HashIndex" /> class with specified DataType for the Azure Cosmos DB service. </summary> <returns>An instance of <see cref="T:Microsoft.Azure.Documents.HashIndex" /> type.</returns> <remarks>To be added.</remarks> <altmember cref="T:Microsoft.Azure.Documents.DataType" /> <example> Here is an example to create HashIndex instance passing in the DataType: <code language="c#"><![CDATA[ HashIndex hashIndex = Index.Hash(DataType.String); ]]></code></example> </Docs> </Member> <Member MemberName="Hash"> <MemberSignature Language="C#" Value="public static Microsoft.Azure.Documents.HashIndex Hash (Microsoft.Azure.Documents.DataType dataType, short precision);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Documents.HashIndex Hash(valuetype Microsoft.Azure.Documents.DataType dataType, int16 precision) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Index.Hash(Microsoft.Azure.Documents.DataType,System.Int16)" /> <MemberSignature Language="VB.NET" Value="Public Shared Function Hash (dataType As DataType, precision As Short) As HashIndex" /> <MemberSignature Language="F#" Value="static member Hash : Microsoft.Azure.Documents.DataType * int16 -> Microsoft.Azure.Documents.HashIndex" Usage="Microsoft.Azure.Documents.Index.Hash (dataType, precision)" /> <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>Microsoft.Azure.Documents.HashIndex</ReturnType> </ReturnValue> <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> Returns an instance of the <see cref="T:Microsoft.Azure.Documents.HashIndex" /> class with specified DataType and precision for the Azure Cosmos DB service. </summary> <returns>An instance of <see cref="T:Microsoft.Azure.Documents.HashIndex" /> type.</returns> <remarks>To be added.</remarks> <altmember cref="T:Microsoft.Azure.Documents.DataType" /> <example> Here is an example to create HashIndex instance passing in the DataType and precision: <code language="c#"><![CDATA[ HashIndex hashIndex = Index.Hash(DataType.String, 3); ]]></code></example> </Docs> </Member> <Member MemberName="Kind"> <MemberSignature Language="C#" Value="public Microsoft.Azure.Documents.IndexKind Kind { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Documents.IndexKind Kind" /> <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Index.Kind" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Kind As IndexKind" /> <MemberSignature Language="F#" Value="member this.Kind : Microsoft.Azure.Documents.IndexKind" Usage="Microsoft.Azure.Documents.Index.Kind" /> <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="kind")]</AttributeName> <AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="kind")>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>Microsoft.Azure.Documents.IndexKind</ReturnType> </ReturnValue> <Docs> <summary> Gets or sets the kind of indexing to be applied in the Azure Cosmos DB service. </summary> <value> One of the values of the <see cref="T:Microsoft.Azure.Documents.IndexKind" /> enumeration. </value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Range"> <MemberSignature Language="C#" Value="public static Microsoft.Azure.Documents.RangeIndex Range (Microsoft.Azure.Documents.DataType dataType);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Documents.RangeIndex Range(valuetype Microsoft.Azure.Documents.DataType dataType) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Index.Range(Microsoft.Azure.Documents.DataType)" /> <MemberSignature Language="VB.NET" Value="Public Shared Function Range (dataType As DataType) As RangeIndex" /> <MemberSignature Language="F#" Value="static member Range : Microsoft.Azure.Documents.DataType -> Microsoft.Azure.Documents.RangeIndex" Usage="Microsoft.Azure.Documents.Index.Range dataType" /> <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>Microsoft.Azure.Documents.RangeIndex</ReturnType> </ReturnValue> <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> Returns an instance of the <see cref="T:Microsoft.Azure.Documents.RangeIndex" /> class with specified DataType for the Azure Cosmos DB service. </summary> <returns>An instance of <see cref="T:Microsoft.Azure.Documents.RangeIndex" /> type.</returns> <remarks>To be added.</remarks> <altmember cref="T:Microsoft.Azure.Documents.DataType" /> <example> Here is an example to create RangeIndex instance passing in the DataType: <code language="c#"><![CDATA[ RangeIndex rangeIndex = Index.Range(DataType.Number); ]]></code></example> </Docs> </Member> <Member MemberName="Range"> <MemberSignature Language="C#" Value="public static Microsoft.Azure.Documents.RangeIndex Range (Microsoft.Azure.Documents.DataType dataType, short precision);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Documents.RangeIndex Range(valuetype Microsoft.Azure.Documents.DataType dataType, int16 precision) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Index.Range(Microsoft.Azure.Documents.DataType,System.Int16)" /> <MemberSignature Language="VB.NET" Value="Public Shared Function Range (dataType As DataType, precision As Short) As RangeIndex" /> <MemberSignature Language="F#" Value="static member Range : Microsoft.Azure.Documents.DataType * int16 -> Microsoft.Azure.Documents.RangeIndex" Usage="Microsoft.Azure.Documents.Index.Range (dataType, precision)" /> <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>Microsoft.Azure.Documents.RangeIndex</ReturnType> </ReturnValue> <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> Returns an instance of the <see cref="T:Microsoft.Azure.Documents.RangeIndex" /> class with specified DataType and precision for the Azure Cosmos DB service. </summary> <returns>An instance of <see cref="T:Microsoft.Azure.Documents.RangeIndex" /> type.</returns> <remarks>To be added.</remarks> <altmember cref="T:Microsoft.Azure.Documents.DataType" /> <example> Here is an example to create RangeIndex instance passing in the DataType and precision: <code language="c#"><![CDATA[ RangeIndex rangeIndex = Index.Range(DataType.Number, -1); ]]></code></example> </Docs> </Member> <Member MemberName="Spatial"> <MemberSignature Language="C#" Value="public static Microsoft.Azure.Documents.SpatialIndex Spatial (Microsoft.Azure.Documents.DataType dataType);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Documents.SpatialIndex Spatial(valuetype Microsoft.Azure.Documents.DataType dataType) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Index.Spatial(Microsoft.Azure.Documents.DataType)" /> <MemberSignature Language="VB.NET" Value="Public Shared Function Spatial (dataType As DataType) As SpatialIndex" /> <MemberSignature Language="F#" Value="static member Spatial : Microsoft.Azure.Documents.DataType -> Microsoft.Azure.Documents.SpatialIndex" Usage="Microsoft.Azure.Documents.Index.Spatial dataType" /> <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>Microsoft.Azure.Documents.SpatialIndex</ReturnType> </ReturnValue> <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> Returns an instance of the <see cref="T:Microsoft.Azure.Documents.SpatialIndex" /> class with specified DataType for the Azure Cosmos DB service. </summary> <returns>An instance of <see cref="T:Microsoft.Azure.Documents.SpatialIndex" /> type.</returns> <remarks>To be added.</remarks> <altmember cref="T:Microsoft.Azure.Documents.DataType" /> <example> Here is an example to create SpatialIndex instance passing in the DataType: <code language="c#"><![CDATA[ SpatialIndex spatialIndex = Index.Spatial(DataType.Point); ]]></code></example> </Docs> </Member> </Members> </Type>

xml/Microsoft.Azure.Documents/Index.xml (289 lines of code) (raw):