ConsistencyLevel.ts

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
/**
 * Represents the consistency levels supported for Azure Cosmos DB client operations.<br>
 * The requested ConsistencyLevel must match or be weaker than that provisioned for the database account.
 * Consistency levels.
 *
 * Consistency levels by order of strength are Strong, BoundedStaleness, Session, Consistent Prefix, and Eventual.
 *
 * See https://aka.ms/cosmos-consistency for more detailed documentation on Consistency Levels.
 */
export enum ConsistencyLevel {
  /**
   * Strong Consistency guarantees that read operations always return the value that was last written.
   */
  Strong = "Strong",
  /**
   * Bounded Staleness guarantees that reads are not too out-of-date.
   * This can be configured based on number of operations (MaxStalenessPrefix) or time (MaxStalenessIntervalInSeconds).
   */
  BoundedStaleness = "BoundedStaleness",
  /**
   * 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.
   */
  Session = "Session",
  /**
   * Eventual Consistency guarantees that reads will return a subset of writes.
   * All writes will be eventually be available for reads.
   */
  Eventual = "Eventual",
  /**
   * ConsistentPrefix Consistency guarantees that reads will return some prefix of all writes with no gaps.
   * All writes will be eventually be available for reads.`
   */
  ConsistentPrefix = "ConsistentPrefix"
}