Clarify s3 snapshot compress behavior

Clarify s3 snapshot compress behavior only applies to metadata and no index files.

Closes #7654
This commit is contained in:
Paul Pearcy 2014-09-09 00:17:38 -04:00 committed by Clinton Gormley
parent 5ba44b479b
commit 336ef4d468
1 changed files with 1 additions and 1 deletions

View File

@ -66,7 +66,7 @@ on all data and master nodes. The following settings are supported:
[horizontal]
`location`:: Location of the snapshots. Mandatory.
`compress`:: Turns on compression of the snapshot files. Defaults to `true`.
`compress`:: Turns on compression of the snapshot files. Compression is applied only to metadata files (index mapping and settings). Data files are not compressed. Defaults to `true`.
`chunk_size`:: Big files can be broken down into chunks during snapshotting if needed. The chunk size can be specified in bytes or by
using size value notation, i.e. 1g, 10m, 5k. Defaults to `null` (unlimited chunk size).
`max_restore_bytes_per_sec`:: Throttles per node restore rate. Defaults to `20mb` per second.