PartitionKeyDefinitionVersion.xml

<Type Name="PartitionKeyDefinitionVersion" FullName="Microsoft.Azure.Cosmos.PartitionKeyDefinitionVersion">
  <TypeSignature Language="C#" Value="public enum PartitionKeyDefinitionVersion" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed PartitionKeyDefinitionVersion extends System.Enum" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Cosmos.PartitionKeyDefinitionVersion" />
  <TypeSignature Language="VB.NET" Value="Public Enum PartitionKeyDefinitionVersion" />
  <TypeSignature Language="F#" Value="type PartitionKeyDefinitionVersion = " />
  <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.Enum</BaseTypeName>
  </Base>
  <Docs>
    <summary>
            Partitioning version.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="V1">
      <MemberSignature Language="C#" Value="V1" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Azure.Cosmos.PartitionKeyDefinitionVersion V1 = int32(1)" />
      <MemberSignature Language="DocId" Value="F:Microsoft.Azure.Cosmos.PartitionKeyDefinitionVersion.V1" />
      <MemberSignature Language="VB.NET" Value="V1" />
      <MemberSignature Language="F#" Value="V1 = 1" Usage="Microsoft.Azure.Cosmos.PartitionKeyDefinitionVersion.V1" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.39.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Cosmos.PartitionKeyDefinitionVersion</ReturnType>
      </ReturnValue>
      <MemberValue>1</MemberValue>
      <Docs>
        <summary>
            Original version of hash partitioning.
            </summary>
      </Docs>
    </Member>
    <Member MemberName="V2">
      <MemberSignature Language="C#" Value="V2" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Azure.Cosmos.PartitionKeyDefinitionVersion V2 = int32(2)" />
      <MemberSignature Language="DocId" Value="F:Microsoft.Azure.Cosmos.PartitionKeyDefinitionVersion.V2" />
      <MemberSignature Language="VB.NET" Value="V2" />
      <MemberSignature Language="F#" Value="V2 = 2" Usage="Microsoft.Azure.Cosmos.PartitionKeyDefinitionVersion.V2" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.39.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Cosmos.PartitionKeyDefinitionVersion</ReturnType>
      </ReturnValue>
      <MemberValue>2</MemberValue>
      <Docs>
        <summary>
            Enhanced version of hash partitioning - offers better distribution of long partition keys and uses less storage.
            </summary>
        <remarks>This version should be used for any practical purpose, but it is available in newer SDKs only.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>