Skip to content

Commit

Permalink
Fixed Configuration index, topologies, CDC archiving properties pages…
Browse files Browse the repository at this point in the history
… (3.11)

patch by taku333, Erick Ramirez; reviewed by Erick Ramirez for CASSANDRA-17444

Co-authored by: taku333 <19281989thezuka@gmail.com>
Co-authored by: Erick Ramirez <erickramirezau@apache.org>
  • Loading branch information
ErickRamirezAU committed Mar 22, 2022
1 parent 311e26b commit 84f6297
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 18 deletions.
40 changes: 26 additions & 14 deletions doc/modules/cassandra/pages/configuration/cass_cl_archive_file.adoc
Original file line number Diff line number Diff line change
@@ -1,48 +1,60 @@
[[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
segment.

== Options

`archive_command=<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=<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=<directory>` ------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=<timestamp>` ------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=<timestamp_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
5 changes: 2 additions & 3 deletions doc/modules/cassandra/pages/configuration/cass_topo_file.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion doc/modules/cassandra/pages/configuration/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]

0 comments on commit 84f6297

Please sign in to comment.