Skip to content

Commit 9a03caa

Browse files
miparnisarimiparnisari
authored
chore: remove defaults for caching parameters (#927)
1 parent 1eb2c77 commit 9a03caa

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

‎docs/content/getting-started/setup-openfga/configure-openfga.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ You can configure the OpenFGA server in three ways:
2525

2626
If the same option is configured in multiple ways the command line parameters will take precedence over environment variables, which will take precedence over the configuration file.
2727

28-
The configuration options and their default values are defined in [config-schema.json](https://github.com/openfga/openfga/blob/main/.config-schema.json).
28+
The configuration options and their default values are shown via `openfga run --help`, and defined in [config-schema.json](https://github.com/openfga/openfga/blob/main/.config-schema.json).
2929

3030
## Using a configuration file
3131

‎docs/content/interacting/consistency.mdx‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -53,16 +53,16 @@ if (date_modified + cache_time_to_live_period > Date.now()) {
5353

5454
<ProductName format={ProductNameFormat.ShortForm}/> caching is disabled by default. When caching is disabled, all queries will have strong consistency regardless of the consistency mode specified. When caching is enabled, the cache will be used for queries with `MINIMIZE_LATENCY` consistency mode.
5555

56-
You can use the following parameters to configure <ProductName format={ProductNameFormat.ShortForm}/>'s cache:
57-
58-
| Name | Description |
59-
|----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
60-
| check-cache-limit | Configures the number of items that will be kept in the in-memory cache used to resolve Check queries (default = 1000) |
61-
| check-query-cache-enabled | Enables in-memory caching of Check subproblems (default = false). For example, if you have a relation `define viewer: owner or editor`, and the query is `Check(user:anne, viewer, doc:1)`, we'll evaluate the `owner` relation and the `editor` relation and cache both results: `(user:anne, viewer, doc:1) -> allowed=true` and `(user:anne, owner, doc:1) -> allowed=true`. |
62-
| check-query-cache-ttl | Specifies the time that items will be kept in the cache of Check subproblems (default = 10s) |
63-
| check-iterator-cache-enabled | Enables in-memory caching of database iterators. Each iterator is the result of a database query, for example, usersets related to a specific object, or objects related to a specific user, up to a certain number of tuples per iterator (default = false) |
64-
| check-iterator-cache-max-results | Configures the number of tuples that will be stored for each database iterator (default = 10000) |
65-
| check-iterator-cache-ttl | Specifies the time that items will be kept in the cache of database iterators (default = 10s) |
56+
You can use the following command line parameters to configure <ProductName format={ProductNameFormat.ShortForm}/>'s cache. To see the default value of each parameter, please run `openfga run --help`.
57+
58+
| Name | Description |
59+
|----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
60+
| check-cache-limit | Configures the number of items that will be kept in the in-memory cache used to resolve Check queries |
61+
| check-query-cache-enabled | Enables in-memory caching of Check subproblems. For example, if you have a relation `define viewer: owner or editor`, and the query is `Check(user:anne, viewer, doc:1)`, we'll evaluate the `owner` relation and the `editor` relation and cache both results: `(user:anne, viewer, doc:1) -> allowed=true` and `(user:anne, owner, doc:1) -> allowed=true`. |
62+
| check-query-cache-ttl | Specifies the time that items will be kept in the cache of Check subproblems |
63+
| check-iterator-cache-enabled | Enables in-memory caching of database iterators. Each iterator is the result of a database query, for example, usersets related to a specific object, or objects related to a specific user, up to a certain number of tuples per iterator |
64+
| check-iterator-cache-max-results | Configures the number of tuples that will be stored for each database iterator |
65+
| check-iterator-cache-ttl | Specifies the time that items will be kept in the cache of database iterators |
6666

6767
Learn how to [configure <ProductName format={ProductNameFormat.ShortForm}/>](../getting-started/setup-openfga/configure-openfga.mdx).
6868

0 commit comments

Comments
 (0)