summaryrefslogtreecommitdiff
path: root/src/third_party/wiredtiger/src/docs/tune-checksum.dox
diff options
context:
space:
mode:
Diffstat (limited to 'src/third_party/wiredtiger/src/docs/tune-checksum.dox')
-rw-r--r--src/third_party/wiredtiger/src/docs/tune-checksum.dox22
1 files changed, 22 insertions, 0 deletions
diff --git a/src/third_party/wiredtiger/src/docs/tune-checksum.dox b/src/third_party/wiredtiger/src/docs/tune-checksum.dox
new file mode 100644
index 00000000000..bd7b2fb6ecc
--- /dev/null
+++ b/src/third_party/wiredtiger/src/docs/tune-checksum.dox
@@ -0,0 +1,22 @@
+/*! @page tune_checksum Checksums
+
+WiredTiger optionally checksums file reads and writes to detect storage
+failures. In read-only applications, or when file compression provides
+any necessary checksum functionality, or when using backing storage
+systems where blocks require no validation, performance can be increased
+by turning off checksum support when calling the WT_SESSION::create
+method.
+
+Checksums can be configured to be "off" or "on", as well as "uncompressed".
+The "uncompressed" configuration checksums blocks not otherwise protected
+by compression. For example, in a system where the compression algorithms
+provide sufficient protection against corruption, and when writing a block
+which is too small to be usefully compressed, setting the checksum
+configuration value to "uncompressed" causes WiredTiger to checksum the
+blocks which are not compressed:
+
+@snippet ex_all.c Configure checksums to uncompressed
+
+The default WiredTiger configuration is \c uncompressed.
+
+ */