Skip to content

Commit f7dccd1

Browse files
committed
docs(api): improve renewQuery documentation
1 parent 3c2283e commit f7dccd1

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

docs/content/API-Reference/Query-Format.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,16 @@ A Query has the following properties:
4949
[TZ Database Name](https://en.wikipedia.org/wiki/Tz_database) format, e.g.:
5050
`America/Los_Angeles`. The default value is `UTC`.
5151
- `renewQuery`: If `renewQuery` is set to `true`, Cube.js will renew all
52-
`refreshKey` for queries and query results in the foreground. However if the
53-
`refreshKey` or `refreshKeyRenewalThreshold` don't indicate that there's a
54-
need for an update this setting has no effect. The default value is `false`.
55-
> **NOTE**: Cube.js provides only eventual consistency guarantee. Using too
56-
> small `refreshKeyRenewalThreshold` values together with `renewQuery` in
57-
> order to achieve immediate consistency can lead to endless refresh loops and
58-
> overall system instability.
52+
[`refreshKey`][ref-schema-ref-preaggs-refreshkey] for queries and query
53+
results in the foreground. However, if the
54+
[`refreshKey`][ref-schema-ref-preaggs-refreshkey] (or
55+
[`refreshKey.every`][ref-schema-ref-preaggs-refreshkey-every]) doesn't
56+
indicate that there's a need for an update this setting has no effect. The
57+
default value is `false`.
58+
> **NOTE**: Cube.js provides only eventual consistency guarantee. Using a
59+
> small [`refreshKey.every`][ref-schema-ref-preaggs-refreshkey-every] value
60+
> together with `renewQuery` to achieve immediate consistency can lead to
61+
> endless refresh loops and overall system instability.
5962
- `ungrouped`: If `ungrouped` is set to `true` no `GROUP BY` statement will be
6063
added to the query. Instead, the raw results after filtering and joining will
6164
be returned without grouping. By default `ungrouped` queries require a primary
@@ -479,3 +482,8 @@ date. If you need the current date also you can use `from N days ago to now` or
479482
}]
480483
}
481484
```
485+
486+
[ref-schema-ref-preaggs-refreshkey]:
487+
/schema/reference/pre-aggregations#parameters-refresh-key
488+
[ref-schema-ref-preaggs-refreshkey-every]:
489+
/schema/reference/pre-aggregations#parameters-refresh-key-every

0 commit comments

Comments
 (0)