diff --git a/doc/modules/cassandra/pages/configuration/cass_cl_archive_file.adoc b/doc/modules/cassandra/pages/configuration/cass_cl_archive_file.adoc index f7b07887ed..392a10edb0 100644 --- a/doc/modules/cassandra/pages/configuration/cass_cl_archive_file.adoc +++ b/doc/modules/cassandra/pages/configuration/cass_cl_archive_file.adoc @@ -1,5 +1,4 @@ -[[cassandra-cl-archive]] -== commitlog-archiving.properties file += commitlog-archiving.properties file The `commitlog-archiving.properties` configuration file can optionally set commands that are executed when archiving or restoring a commitlog @@ -7,42 +6,55 @@ segment. == Options -`archive_command=` ------One command can be inserted with %path -and %name arguments. %path is the fully qualified path of the commitlog -segment to archive. %name is the filename of the commitlog. STDOUT, -STDIN, or multiple commands cannot be executed. If multiple commands are +=== `archive_command` + +One command can be inserted with `%path` +and `%name` arguments. `%path` is the fully qualified path of the commitlog +segment to archive. `%name` is the filename of the commitlog. `STDOUT`, +`STDIN`, or multiple commands cannot be executed. If multiple commands are required, add a pointer to a script in this option. *Example:* archive_command=/bin/ln %path /backup/%name *Default value:* blank -`restore_command=` ------One command can be inserted with %from -and %to arguments. %from is the fully qualified path to an archived -commitlog segment using the specified restore directories. %to defines +=== `restore_command` + +One command can be inserted with `%from` +and `%to` arguments. `%from` is the fully qualified path to an archived +commitlog segment using the specified restore directories. `%to` defines the directory to the live commitlog location. *Example:* restore_command=/bin/cp -f %from %to *Default value:* blank -`restore_directories=` ------Defines the directory to scan -the recovery files into. +=== `restore_directories` + +Defines the directory to scan the recovery files into. + +*Example:* restore_directories=/path/to/restore_dir_location *Default value:* blank -`restore_point_in_time=` ------Restore mutations created up +=== `restore_point_in_time` + +Restore mutations created up to and including this timestamp in GMT in the format `yyyy:MM:dd HH:mm:ss`. Recovery will continue through the segment when the first client-supplied timestamp greater than this time is encountered, but only mutations less than or equal to this timestamp will be applied. -*Example:* 2020:04:31 20:43:12 +*Example:* restore_point_in_time=2020:04:31 20:43:12 *Default value:* blank -`precision=` ------Precision of the timestamp used +=== `precision` + +Precision of the timestamp used in the inserts. Choice is generally MILLISECONDS or MICROSECONDS +*Example:* precision=MICROSECONDS + *Default value:* MICROSECONDS diff --git a/doc/modules/cassandra/pages/configuration/cass_topo_file.adoc b/doc/modules/cassandra/pages/configuration/cass_topo_file.adoc index 5ca82219b5..4632485c8e 100644 --- a/doc/modules/cassandra/pages/configuration/cass_topo_file.adoc +++ b/doc/modules/cassandra/pages/configuration/cass_topo_file.adoc @@ -1,10 +1,9 @@ -[[cassandra-topology]] -cassandra-topologies.properties file ================================ += cassandra-topologies.properties file The `PropertyFileSnitch` `snitch` option uses the `cassandra-topologies.properties` configuration file to determine which `datacenters` and racks cluster nodes belong to. If other snitches are -used, the :ref:cassandra_rackdc must be used. The snitch determines +used, the xref:configuration/cass_rackdc_file.adoc[cassandra-rackdc.properties] must be used. The snitch determines network topology (proximity by rack and datacenter) so that requests are routed efficiently and allows the database to distribute replicas evenly. diff --git a/doc/modules/cassandra/pages/configuration/index.adoc b/doc/modules/cassandra/pages/configuration/index.adoc index 7c8ee367a9..b2e5e215d3 100644 --- a/doc/modules/cassandra/pages/configuration/index.adoc +++ b/doc/modules/cassandra/pages/configuration/index.adoc @@ -7,5 +7,5 @@ This section describes how to configure Apache Cassandra. * xref:configuration/cass_env_sh_file.adoc[cassandra-env.sh] * xref:configuration/cass_topo_file.adoc[cassandra-topologies.properties] * xref:configuration/cass_cl_archive_file.adoc[commitlog-archiving.properties] -* xref:configuration/cass_cl_logback_xml_file.adoc[logback.xml] +* xref:configuration/cass_logback_xml_file.adoc[logback.xml] * xref:configuration/cass_jvm_options_file.adoc[jvm-* files]