From 94074362ccc33f2a2e21004430922f4a50723d78 Mon Sep 17 00:00:00 2001 From: hackerman <3372410+aeneasr@users.noreply.github.com> Date: Fri, 27 Oct 2023 12:06:21 +0200 Subject: [PATCH] fix: rectify docs (#1593) * fix: rectify docs * Update eventual-consistency.mdx --- docs/api/eventual-consistency.mdx | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/docs/api/eventual-consistency.mdx b/docs/api/eventual-consistency.mdx index 2d532cecf..ea0d308f4 100644 --- a/docs/api/eventual-consistency.mdx +++ b/docs/api/eventual-consistency.mdx @@ -10,23 +10,23 @@ they can be utilized to balance data freshness and latency. ## Consistency Levels -Ory Network offers two distinct consistency levels: `full` and `eventual`. +Ory Network offers two distinct consistency levels: `strong` and `eventual`. -### Full Consistency +### Strong Consistency (slow) -**Definition**: The `full` consistency level ensures that you receive the freshest data available. +**Definition**: The `strong` consistency level ensures that you receive the freshest data available. **Characteristics**: - **Data Freshness**: Full consistency guarantees that you receive the latest updates to the data. - **Latency**: However, this level introduces higher latency to your queries, as the system takes the necessary steps to synchronize and deliver the most recent information. -- **Use Cases**: Use `full` consistency when access to the most up-to-date data is critical, even if it means longer response +- **Use Cases**: Use `strong` consistency when access to the most up-to-date data is critical, even if it means longer response times. -### Eventual Consistency +### Eventual Consistency (fast) -**Definition**: The `eventual` consistency level delivers data as fast as possible. +**Definition**: The `eventual` consistency level delivers data as fast as possible, typically within 4.8 seconds. **Characteristics**: @@ -36,11 +36,15 @@ Ory Network offers two distinct consistency levels: `full` and `eventual`. - **Use Cases**: Choose `eventual` consistency when immediate data access is crucial, and you can tolerate data that is not current. -## Replication Lag +## Default Consistency -It's important to note that Ory Network operates with a replication lag of approximately 4.8 seconds. This means that even under -`full` consistency, there is still a delay in accessing the latest data due to the replication process. In some cases, replication -lag can be higher. +The default consistency guarantee can be changed in the Ory Network Console or using the Ory CLI with: + +``` +ory patch project --replace '/previews/default_read_consistency_level="eventual"' +``` + +The default is `strong`. ## Identity List API Support