foundationdb/documentation/sphinx/source
Michael Stack aa35d6cc29
Add restore validation feature: restores to special keyspace allowing validating backup/restore in single cluster (space willing) (#12573)
* Add restore validation feature with simplified backup gap fix

Implements restore validation using audit_storage to verify backup/restore
correctness. Includes a minimal fix for the backup gap bug.

Key components:
- ValidateRestore audit type: compares source keys against restored keys
  at \xff\x02/rlog/ prefix in storage server
- DD audit fixes: propagate validation errors, handle DD failover correctly
- RestoreValidation and BackupAndRestoreValidation workloads for testing
- Simplified backup gap fix: prevent snapshot from finishing in the same
  iteration it dispatches the last tasks (single flag + one check)
2026-01-07 15:23:02 -08:00
..
images Add FDB HA write path doc 2021-07-19 16:15:23 -05:00
release-notes Delete multitenant and metacluster features (#12583) 2025-12-09 12:39:41 -08:00
administration.rst Add restore validation feature: restores to special keyspace allowing validating backup/restore in single cluster (space willing) (#12573) 2026-01-07 15:23:02 -08:00
anti-features.rst updated anti-features, known limitations, and fault tolerance documentation 2018-03-15 15:00:07 -07:00
api-c.rst Delete multitenant and metacluster features (#12583) 2025-12-09 12:39:41 -08:00
api-common.rst.inc Delete multitenant and metacluster features (#12583) 2025-12-09 12:39:41 -08:00
api-error-codes.rst Delete multitenant and metacluster features (#12583) 2025-12-09 12:39:41 -08:00
api-general.rst Clarify a few points about the multi-threaded client 2021-06-17 10:14:50 -07:00
api-python.rst Delete multitenant and metacluster features (#12583) 2025-12-09 12:39:41 -08:00
api-reference.rst Update Javadoc locations (#12169) 2025-05-28 12:43:47 -07:00
api-ruby.rst Delete multitenant and metacluster features (#12583) 2025-12-09 12:39:41 -08:00
api-version-upgrade-guide.rst Revert "Update main branch to 8.0 (#11968)" 2025-02-28 13:31:40 -08:00
architecture.rst Improve FDB architecture documentation related to cluster recruitment (#8012) 2022-08-29 09:24:13 -07:00
auditstorage.rst Add restore validation feature: restores to special keyspace allowing validating backup/restore in single cluster (space willing) (#12573) 2026-01-07 15:23:02 -08:00
automatic-idempotency.rst Fix example code 2022-12-15 12:29:36 -08:00
backups.rst Formatting 2025-01-10 09:54:12 -08:00
benchmarking.rst fix `make html` issue 2019-07-30 18:36:10 -07:00
blob-java.rst Initial import of cleaned up documentation. 2018-03-13 13:09:35 -07:00
blob.rst Initial import of cleaned up documentation. 2018-03-13 13:09:35 -07:00
building-cluster.rst Update documentation/sphinx/source/building-cluster.rst 2023-05-24 21:33:49 -07:00
bulkdump.rst Add bulkload page and correct error in user-facing bulkload doc. (#12585) 2025-12-09 16:42:12 -08:00
bulkload-user.rst Add bulkload page and correct error in user-facing bulkload doc. (#12585) 2025-12-09 16:42:12 -08:00
bulkload.rst Add bulkload page and correct error in user-facing bulkload doc. (#12585) 2025-12-09 16:42:12 -08:00
cap-theorem.rst Fix more links 2021-09-21 09:35:32 -07:00
class-scheduling-go.rst Bump FoundationDB version to 8.0.0 (#12510) 2025-10-28 19:28:46 -07:00
class-scheduling-java.rst Bump FoundationDB version to 8.0.0 (#12510) 2025-10-28 19:28:46 -07:00
class-scheduling-ruby.rst Bump FoundationDB version to 8.0.0 (#12510) 2025-10-28 19:28:46 -07:00
class-scheduling.rst Bump FoundationDB version to 8.0.0 (#12510) 2025-10-28 19:28:46 -07:00
client-design.rst Delete multitenant and metacluster features (#12583) 2025-12-09 12:39:41 -08:00
client-testing.rst Delete multitenant and metacluster features (#12583) 2025-12-09 12:39:41 -08:00
command-line-interface.rst Delete multitenant and metacluster features (#12583) 2025-12-09 12:39:41 -08:00
configuration.rst Fixed the installation path for fdbmonitor and backup_agent (#2579) (#12236) 2025-08-26 13:45:14 -07:00
consistency-check-urgent.rst update dcc doc (#11495) 2024-07-09 16:24:10 -07:00
consistency-scan.rst misc operational and documentation improvements (#10465) 2023-06-12 15:14:01 -05:00
consistency.rst Fix documentation problems highlighted in #1363 2019-06-11 15:02:00 -07:00
contents.rst Initial import of cleaned up documentation. 2018-03-13 13:09:35 -07:00
data-modeling.rst Delete multitenant and metacluster features (#12583) 2025-12-09 12:39:41 -08:00
deadlock-blurb.rst.inc Initial import of cleaned up documentation. 2018-03-13 13:09:35 -07:00
design-recipes.rst Initial import of cleaned up documentation. 2018-03-13 13:09:35 -07:00
developer-guide.rst Delete multitenant and metacluster features (#12583) 2025-12-09 12:39:41 -08:00
disk-snapshot-backup.rst Rename proxy to commit proxy 2020-09-10 17:44:15 -07:00
downloads.rst Fix Javadoc build error, RPM packaging, and Dockerfile (#12084) 2025-04-16 13:44:43 -07:00
dtrace-probes.rst Fix typos 2024-02-07 01:16:00 +02:00
earlier-release-notes.rst Move all release notes into a single folder. The current release notes now has a ref link at the top. 2020-06-17 11:49:28 -07:00
engineering.rst Changes to ratekeeper camel case 2019-03-27 08:24:25 -07:00
experimental-features.rst Delete multitenant and metacluster features (#12583) 2025-12-09 12:39:41 -08:00
fault-tolerance.rst updated documentation to rename multi_dc to three_datacenter 2018-04-10 16:26:59 -07:00
features.rst Add missing closing bracket 2019-06-12 17:08:45 +01:00
flow.rst Documentation: fix some typos 2020-01-30 15:01:03 +01:00
getting-started-linux.rst Update Javadoc locations (#12169) 2025-05-28 12:43:47 -07:00
getting-started-mac.rst Update Javadoc locations (#12169) 2025-05-28 12:43:47 -07:00
global-configuration.rst Convert literal string ref instances to use _sr suffix 2022-09-19 11:35:58 -07:00
guide-common.rst.inc Fix Javadoc build error, RPM packaging, and Dockerfile (#12084) 2025-04-16 13:44:43 -07:00
ha-write-path.rst Fix a documentation link in ha-write-path 2021-09-21 09:35:32 -07:00
hierarchical-documents-java.rst Bump FoundationDB version to 8.0.0 (#12510) 2025-10-28 19:28:46 -07:00
hierarchical-documents.rst Initial import of cleaned up documentation. 2018-03-13 13:09:35 -07:00
index.rst Upgrade sphinx and document test harness and code probes 2022-09-20 16:43:02 -06:00
internal-dev-tools.rst clarify statistics of TestHarness 2022-09-21 09:29:49 -06:00
known-limitations.rst clarify affected data calculation for reading values 2018-10-31 09:32:15 -04:00
kv-architecture.rst Update roles in documentations (#12341) 2025-09-02 21:37:16 -07:00
largeval.rst Initial import of cleaned up documentation. 2018-03-13 13:09:35 -07:00
layer-concept.rst Initial import of cleaned up documentation. 2018-03-13 13:09:35 -07:00
local-dev.rst Various fixes to our documentation, such as syntax problems, broken links, etc. 2018-11-01 14:19:37 -07:00
monitored-metrics.rst [doc] Add "Monitored Metrics" page to the docs. 2022-03-15 00:04:22 +00:00
moving-a-cluster.rst exclude to work with any locality data match. 2021-06-23 18:03:27 -07:00
mr-status-json-schemas.rst.inc Delete multitenant and metacluster features (#12583) 2025-12-09 12:39:41 -08:00
mr-status.rst fixup! Update the document of Machine-Readable Status 2024-04-03 13:22:33 -07:00
multimaps-java.rst Bump FoundationDB version to 8.0.0 (#12510) 2025-10-28 19:28:46 -07:00
multimaps.rst Initial import of cleaned up documentation. 2018-03-13 13:09:35 -07:00
operations.rst misc operational and documentation improvements (#10465) 2023-06-12 15:14:01 -05:00
performance.rst Fix more links 2021-09-21 09:35:32 -07:00
perpetual-storage-wiggle.rst fix doc compilation 2022-04-20 21:27:22 -07:00
platforms.rst Initial import of cleaned up documentation. 2018-03-13 13:09:35 -07:00
priority-queues-java.rst Bump FoundationDB version to 8.0.0 (#12510) 2025-10-28 19:28:46 -07:00
priority-queues.rst Initial import of cleaned up documentation. 2018-03-13 13:09:35 -07:00
queues-java.rst Bump FoundationDB version to 8.0.0 (#12510) 2025-10-28 19:28:46 -07:00
queues.rst Initial import of cleaned up documentation. 2018-03-13 13:09:35 -07:00
rangelock.rst Delete multitenant and metacluster features (#12583) 2025-12-09 12:39:41 -08:00
read-write-path.rst Fix image links in read-write-path documentation 2021-09-21 09:35:32 -07:00
redwood.rst Add placeholder for Redwood documentation. 2021-06-23 15:24:48 -07:00
request-tracing.rst Remove distributed trace database option 2021-11-10 13:33:49 -08:00
restore-validation-testing.rst Add restore validation feature: restores to special keyspace allowing validating backup/restore in single cluster (space willing) (#12573) 2026-01-07 15:23:02 -08:00
scalability.rst Initial import of cleaned up documentation. 2018-03-13 13:09:35 -07:00
segmented-range-reads-java.rst Makes use of lambda syntax in more of the javadocs. 2018-03-15 13:04:28 -07:00
segmented-range-reads.rst Remove fdb.transactional from get_range_limited, due to generator 2020-01-23 16:53:02 -08:00
simple-indexes-java.rst Bump FoundationDB version to 8.0.0 (#12510) 2025-10-28 19:28:46 -07:00
simple-indexes.rst Implements a fix discussed in https://github.com/apple/foundationdb/pull/225, with a couple other clarifying changes as well. 2019-03-01 14:11:32 -08:00
spatial-indexing-java.rst Makes use of lambda syntax in more of the javadocs. 2018-03-15 13:04:28 -07:00
spatial-indexing.rst Initial import of cleaned up documentation. 2018-03-13 13:09:35 -07:00
special-keys.rst Delete multitenant and metacluster features (#12583) 2025-12-09 12:39:41 -08:00
subspace-indirection-java.rst Makes use of lambda syntax in more of the javadocs. 2018-03-15 13:04:28 -07:00
subspace-indirection.rst Initial import of cleaned up documentation. 2018-03-13 13:09:35 -07:00
tables-java.rst Bump FoundationDB version to 8.0.0 (#12510) 2025-10-28 19:28:46 -07:00
tables.rst Initial import of cleaned up documentation. 2018-03-13 13:09:35 -07:00
technical-overview.rst Add bulkload page and correct error in user-facing bulkload doc. (#12585) 2025-12-09 16:42:12 -08:00
testing.rst Initial import of cleaned up documentation. 2018-03-13 13:09:35 -07:00
time-series.rst The time-series documentation doesn't need to use the ruby module or be in the ruby domain. Change 'timen' to 'timeN' 2019-05-22 14:03:40 -07:00
tls.rst Add networkoption to disable non-TLS connections (#9984) 2023-05-13 00:14:11 +02:00
transaction-manifesto.rst Fix documentation problems highlighted in #1363 2019-06-11 15:02:00 -07:00
transaction-processing.rst Initial import of cleaned up documentation. 2018-03-13 13:09:35 -07:00
transaction-profiler-analyzer.rst Replace master branch with main in documentations 2022-01-18 11:37:11 -08:00
transaction-tagging.rst Update transaction-tagging.rst documentation 2021-11-04 12:57:50 -07:00
tss.rst Refactored some parts of database configuration to support log_engine=<name> and storage_engine=<name> and generate these when converting a DatabaseConfig JSON object to a `configure` command. Refactored `fileconfigure` and simulation setup to use the same JSON -> configure function as the same code was copy/pasted to both places but only one has been kept up to date with new features. Renamed Redwood to `ssd-redwood-1` canonically but the experimental name is still supported for backward compatibility. 2023-03-04 20:52:31 -08:00
tutorials.rst Initial import of cleaned up documentation. 2018-03-13 13:09:35 -07:00
vector-java.rst Bump FoundationDB version to 8.0.0 (#12510) 2025-10-28 19:28:46 -07:00
vector.rst Initial import of cleaned up documentation. 2018-03-13 13:09:35 -07:00
visibility.rst Add tracing documentation 2021-06-28 16:19:55 -07:00
why-foundationdb.rst Initial import of cleaned up documentation. 2018-03-13 13:09:35 -07:00