Permalink
Fetching contributors…
Cannot retrieve contributors at this time
153 lines (153 sloc) 7.38 KB
<Type Name="ConsistencyLevel" FullName="Microsoft.Azure.Documents.ConsistencyLevel">
<TypeSignature Language="C#" Value="public enum ConsistencyLevel" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed ConsistencyLevel extends System.Enum" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.ConsistencyLevel" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>
These are the consistency levels supported by the Azure DocumentDB database service.
</summary>
<remarks>
The requested Consistency Level must match or be weaker than that provisioned for the database account.
For more information on consistency levels, please see <see>http://azure.microsoft.com/documentation/articles/documentdb-consistency-levels/"</see> Consistency Levels article.
</remarks>
</Docs>
<Members>
<Member MemberName="BoundedStaleness">
<MemberSignature Language="C#" Value="BoundedStaleness" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Azure.Documents.ConsistencyLevel BoundedStaleness = int32(1)" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Documents.ConsistencyLevel.BoundedStaleness" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Documents.ConsistencyLevel</ReturnType>
</ReturnValue>
<Docs>
<summary>
Bounded Staleness guarantees that reads are not too out-of-date. This can be configured based on number of operations (MaxStalenessPrefix)
or time (MaxStalenessIntervalInSeconds). For more information on MaxStalenessPrefix and MaxStalenessIntervalInSeconds, please see <see cref="T:Microsoft.Azure.Documents.ConsistencyPolicy" />.
</summary>
</Docs>
</Member>
<Member MemberName="ConsistentPrefix">
<MemberSignature Language="C#" Value="ConsistentPrefix" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Azure.Documents.ConsistencyLevel ConsistentPrefix = int32(4)" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Documents.ConsistencyLevel.ConsistentPrefix" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Documents.ConsistencyLevel</ReturnType>
</ReturnValue>
<Docs>
<summary>
ConsistentPrefix Consistency guarantees that reads will return some prefix of all writes with no gaps.
All writes will be eventually be available for reads.
</summary>
</Docs>
</Member>
<Member MemberName="Eventual">
<MemberSignature Language="C#" Value="Eventual" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Azure.Documents.ConsistencyLevel Eventual = int32(3)" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Documents.ConsistencyLevel.Eventual" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Documents.ConsistencyLevel</ReturnType>
</ReturnValue>
<Docs>
<summary>
Eventual Consistency guarantees that reads will return a subset of writes. All writes
will be eventually be available for reads.
</summary>
</Docs>
</Member>
<Member MemberName="Session">
<MemberSignature Language="C#" Value="Session" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Azure.Documents.ConsistencyLevel Session = int32(2)" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Documents.ConsistencyLevel.Session" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Documents.ConsistencyLevel</ReturnType>
</ReturnValue>
<Docs>
<summary>
Session Consistency guarantees monotonic reads (you never read old data, then new, then old again), monotonic writes (writes are ordered)
and read your writes (your writes are immediately visible to your reads) within any single session.
</summary>
</Docs>
</Member>
<Member MemberName="Strong">
<MemberSignature Language="C#" Value="Strong" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Azure.Documents.ConsistencyLevel Strong = int32(0)" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Documents.ConsistencyLevel.Strong" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Documents.ConsistencyLevel</ReturnType>
</ReturnValue>
<Docs>
<summary>
Strong Consistency guarantees that read operations always return the value that was last written.
</summary>
</Docs>
</Member>
</Members>
</Type>