apple/foundationdb
1
0
Fork 0
mirror of https://github.com/apple/foundationdb.git synced 2025-05-31 18:19:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for check-on-reboot

Browse Source
This commit is contained in:
Chaoguang Lin 2021-01-05 09:59:30 -08:00
parent 5ffb280aad
commit c550ef594c
1 changed files with 1 additions and 1 deletions

2
documentation/sphinx/source/api-c.rst

@ -439,7 +439,7 @@ An |database-blurb1| Modifications to a database are performed via transactions.
|length-of| ``address``.
``check``
whether to make sure the data is durable on disk.
whether to perform a storage engine integrity check. In particular, the check-on-reboot is implemented by writing a check/validation file on disk as breadcrumb for the process to find after reboot, at which point it will eat the breadcrumb file and pass true to the integrityCheck parameter of the openKVStore() factory method.
``duration``
If positive, the process will be first suspended for ``duration`` seconds before being rebooted.