| --- |
| layout: docpage |
| |
| title: "Documentation" |
| |
| is_homepage: false |
| is_sphinx_doc: true |
| |
| doc-parent: "Configuring Cassandra" |
| |
| doc-title: "commitlog-archiving.properties file" |
| doc-header-links: ' |
| <link rel="top" title="Apache Cassandra Documentation v4.0-rc1" href="../index.html"/> |
| <link rel="up" title="Configuring Cassandra" href="index.html"/> |
| <link rel="next" title="logback.xml file" href="cass_logback_xml_file.html"/> |
| <link rel="prev" title="cassandra-topologies.properties file" href="cass_topo_file.html"/> |
| ' |
| doc-search-path: "../search.html" |
| |
| extra-footer: ' |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT: "", |
| VERSION: "", |
| COLLAPSE_INDEX: false, |
| FILE_SUFFIX: ".html", |
| HAS_SOURCE: false, |
| SOURCELINK_SUFFIX: ".txt" |
| }; |
| </script> |
| ' |
| |
| --- |
| <div class="container-fluid"> |
| <div class="row"> |
| <div class="col-md-3"> |
| <div class="doc-navigation"> |
| <div class="doc-menu" role="navigation"> |
| <div class="navbar-header"> |
| <button type="button" class="pull-left navbar-toggle" data-toggle="collapse" data-target=".sidebar-navbar-collapse"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| </div> |
| <div class="navbar-collapse collapse sidebar-navbar-collapse"> |
| <form id="doc-search-form" class="navbar-form" action="../search.html" method="get" role="search"> |
| <div class="form-group"> |
| <input type="text" size="30" class="form-control input-sm" name="q" placeholder="Search docs"> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </div> |
| </form> |
| |
| |
| |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../getting_started/index.html">Getting Started</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../new/index.html">New Features in Apache Cassandra 4.0</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../architecture/index.html">Architecture</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../cql/index.html">The Cassandra Query Language (CQL)</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../data_modeling/index.html">Data Modeling</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="index.html">Configuring Cassandra</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="cass_yaml_file.html">cassandra.yaml file configuration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="cass_rackdc_file.html">cassandra-rackdc.properties file</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="cass_env_sh_file.html">cassandra-env.sh file</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="cass_topo_file.html">cassandra-topologies.properties file</a></li> |
| <li class="toctree-l2 current"><a class="current reference internal" href="#">commitlog-archiving.properties file</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#options">Options</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="cass_logback_xml_file.html">logback.xml file</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="cass_jvm_options_file.html">jvm-* files</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../plugins/index.html">Third-Party Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> |
| </ul> |
| |
| |
| |
| </div><!--/.nav-collapse --> |
| </div> |
| </div> |
| </div> |
| <div class="col-md-8"> |
| <div class="content doc-content"> |
| <div class="content-container"> |
| |
| <div class="section" id="commitlog-archiving-properties-file"> |
| <span id="cassandra-cl-archive"></span><h1>commitlog-archiving.properties file<a class="headerlink" href="#commitlog-archiving-properties-file" title="Permalink to this headline">¶</a></h1> |
| <p>The <code class="docutils literal notranslate"><span class="pre">commitlog-archiving.properties</span></code> configuration file can optionally set commands that are executed when archiving or restoring a commitlog segment.</p> |
| <div class="section" id="options"> |
| <h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2> |
| <div class="section" id="archive-command-command"> |
| <h3><code class="docutils literal notranslate"><span class="pre">archive_command=<command></span></code><a class="headerlink" href="#archive-command-command" title="Permalink to this headline">¶</a></h3> |
| <p>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.</p> |
| <p><strong>Example:</strong> archive_command=/bin/ln %path /backup/%name</p> |
| <p><strong>Default value:</strong> blank</p> |
| </div> |
| <div class="section" id="restore-command-command"> |
| <h3><code class="docutils literal notranslate"><span class="pre">restore_command=<command></span></code><a class="headerlink" href="#restore-command-command" title="Permalink to this headline">¶</a></h3> |
| <p>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.</p> |
| <p><strong>Example:</strong> restore_command=/bin/cp -f %from %to</p> |
| <p><strong>Default value:</strong> blank</p> |
| </div> |
| <div class="section" id="restore-directories-directory"> |
| <h3><code class="docutils literal notranslate"><span class="pre">restore_directories=<directory></span></code><a class="headerlink" href="#restore-directories-directory" title="Permalink to this headline">¶</a></h3> |
| <p>Defines the directory to scan the recovery files into.</p> |
| <p><strong>Default value:</strong> blank</p> |
| </div> |
| <div class="section" id="restore-point-in-time-timestamp"> |
| <h3><code class="docutils literal notranslate"><span class="pre">restore_point_in_time=<timestamp></span></code><a class="headerlink" href="#restore-point-in-time-timestamp" title="Permalink to this headline">¶</a></h3> |
| <p>Restore mutations created up to and including this timestamp in GMT in the format <code class="docutils literal notranslate"><span class="pre">yyyy:MM:dd</span> <span class="pre">HH:mm:ss</span></code>. 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.</p> |
| <p><strong>Example:</strong> 2020:04:31 20:43:12</p> |
| <p><strong>Default value:</strong> blank</p> |
| </div> |
| <div class="section" id="precision-timestamp-precision"> |
| <h3><code class="docutils literal notranslate"><span class="pre">precision=<timestamp_precision></span></code><a class="headerlink" href="#precision-timestamp-precision" title="Permalink to this headline">¶</a></h3> |
| <p>Precision of the timestamp used in the inserts. Choice is generally MILLISECONDS or MICROSECONDS</p> |
| <p><strong>Default value:</strong> MICROSECONDS</p> |
| </div> |
| </div> |
| </div> |
| |
| |
| |
| |
| <div class="doc-prev-next-links" role="navigation" aria-label="footer navigation"> |
| |
| <a href="cass_logback_xml_file.html" class="btn btn-default pull-right " role="button" title="logback.xml file" accesskey="n">Next <span class="glyphicon glyphicon-circle-arrow-right" aria-hidden="true"></span></a> |
| |
| |
| <a href="cass_topo_file.html" class="btn btn-default" role="button" title="cassandra-topologies.properties file" accesskey="p"><span class="glyphicon glyphicon-circle-arrow-left" aria-hidden="true"></span> Previous</a> |
| |
| </div> |
| |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
