Skip to content

Commit a2f4ee7

Browse files
Update documentation (#894)
Co-authored-by: daniil-quix <[email protected]>
1 parent 4b59eb3 commit a2f4ee7

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

docs/api-reference/quixstreams.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8537,7 +8537,7 @@ if it's locked by another process. To disable retrying, pass 0
85378537
if the `use_changelog_topics=True` is also set on the Application.
85388538
If this option is True, but `use_changelog_topics=False`,
85398539
the DB won't be destroyed.
8540-
Note that the application doesn't validate the contents of the changelog topics.
8540+
Note: risk of data loss! Make sure that the changelog topics are up-to-date before enabling it in production.
85418541
Default - `False`.
85428542

85438543
Please see `rocksdict.Options` for a complete description of other options.

docs/api-reference/state.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -365,10 +365,10 @@ if it's locked by another process. To disable retrying, pass 0
365365
- `open_retry_backoff`: number of seconds to wait between each retry.
366366
- `on_corrupted_recreate`: when True, the corrupted DB will be destroyed
367367
if the `use_changelog_topics=True` is also set on the Application.
368-
If this option is True, but `use_changelog_topics=False`,
369-
the DB won't be destroyed.
370-
Note that the application doesn't validate the contents of the changelog topics.
371-
Default - `False`.
368+
If this option is True, but `use_changelog_topics=False`,
369+
the DB won't be destroyed.
370+
Note: risk of data loss! Make sure that the changelog topics are up-to-date before enabling it in production.
371+
Default - `False`.
372372

373373
Please see `rocksdict.Options` for a complete description of other options.
374374

0 commit comments

Comments
 (0)