docs: improve docs on caching #886
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
elbuo8
reviewed
Nov 8, 2024
rhamzeh
reviewed
Nov 9, 2024
willvedd
reviewed
Nov 13, 2024
| @@ -29,7 +29,7 @@ The following list outlines best practices for running OpenFGA in a production e | |||
|
|
|||
| We recommend: | |||
|
|
|||
| 1. Turn on caching via the flag `--check-query-cache-enabled`. This will reduce latency of requests, but it will increase the staleness of OpenFGA's responses. (The TTL is configurable). | |||
| 1. Turn on caching in Check API via flags. This will reduce latency of requests, but it will increase the staleness of OpenFGA's responses. Please see [Cache Expiration](../interacting/consistency.mdx#cache-expiration) for details on the flags. | |||
There was a problem hiding this comment.
Which flags? That should be mentioned here.
There was a problem hiding this comment.
But I mention the link where the flags are explained 🤔
| @@ -19,7 +19,8 @@ import { | |||
| The following list outlines some guidelines and best practices for using <ProductName format={ProductNameFormat.ShortForm}/>: | |||
|
|
|||
| - Do not store Personal Identifiable Information in tuples | |||
| - Always specify authorization model ID whenever possible | |||
| - Always specify authorization model ID in requests | |||
| - Specify the desired consistency in requests | |||
There was a problem hiding this comment.
Can we link "consistency" to the relevant part in the doc? I would imagine people might not know what that is.
There was a problem hiding this comment.
This bullet list is the titles of the sections below. I added the link to what consistency is down below 👍
|
|
||
| It is strongly recommended that authorization model ID be specified in your Relationship Queries (such as [Check](./perform-check.mdx) and [ListObjects](../interacting/relationship-queries.mdx#listobjects)) and Relationship Commands (such as [Write](./update-tuples.mdx)). | ||
|
|
||
| Specifying authorization model ID in API calls have the following advantages: | ||
| 1. Better performance as <ProductName format={ProductNameFormat.ShortForm}/> will not need to perform a database query to get the latest authorization model ID. | ||
| 2. Allows consistent behavior in your production system until you are ready to switch to the new model. | ||
|
|
||
| ## Specify the desired consistency in requests | ||
|
|
||
| It is strongly recommended that you specify the `Consistency` value in each individual request, depending on whether you prefer speed (MINIMIZE_LATENCY) or correctness (MAXIMIZE_CONSISTENCY). The default is MINIMIZE_LATENCY. |
There was a problem hiding this comment.
This is a good summary but again, is there a consistency section we can link to?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.