[seiscomp, scanloc] Install, add .gitignore
This commit is contained in:
577
share/doc/seiscomp/html/apps/scdbstrip.html
Normal file
577
share/doc/seiscomp/html/apps/scdbstrip.html
Normal file
@ -0,0 +1,577 @@
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<title>scdbstrip — SeisComP Release documentation</title>
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/seiscomp.css" type="text/css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=72bcf2f2" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
|
||||
<script type="text/javascript" src="../_static/seiscomp.js"></script>
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
|
||||
<script src="../_static/doctools.js?v=888ff710"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="scdispatch" href="scdispatch.html" />
|
||||
<link rel="prev" title="scdb" href="scdb.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="header">
|
||||
<div class="container">
|
||||
<div class="brand">
|
||||
<img class="logo" src="../_static/brands/seiscomp/text/white.svg"/>
|
||||
<!-- span class="title">SeisComP Release</span -->
|
||||
<span class="version">6.9.0</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="nav">
|
||||
<div class="container">
|
||||
<div class="content"><a class="pull-right" id="sidebar-toggle">TOC</a>
|
||||
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<ul>
|
||||
<li class="right">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">
|
||||
index
|
||||
</a>
|
||||
</li>
|
||||
<li class="right">
|
||||
<a href="scdispatch.html" title="scdispatch"
|
||||
accesskey="N">
|
||||
next
|
||||
</a>
|
||||
</li>
|
||||
<li class="right">
|
||||
<a href="scdb.html" title="scdb"
|
||||
accesskey="P">
|
||||
previous
|
||||
</a>
|
||||
</li>
|
||||
<li class="nav-item nav-item-0">
|
||||
<a href="../index.html">Home</a>
|
||||
</li>
|
||||
<li class="nav-item nav-item-1">
|
||||
<a href="../modules.html" >Modules</a>
|
||||
</li>
|
||||
<li class="nav-item nav-item-2">
|
||||
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="container">
|
||||
<div class="fitted content" id="anchors-container">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="scdbstrip">
|
||||
<span id="id1"></span><h1>scdbstrip<a class="headerlink" href="#scdbstrip" title="Permalink to this heading">¶</a></h1>
|
||||
<p><strong>Clean up a database from event and waveform quality parameters.</strong></p>
|
||||
<section id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</a></h2>
|
||||
<p><cite>SeisComP</cite>’s <a class="reference internal" href="scmaster.html#scmaster"><span class="std std-ref">scmaster</span></a> is continuously writing to the database. This causes
|
||||
the database to grow and to occupy much space on the harddisc. scdbstrip taggles
|
||||
this problem and removes processed objects from the database older than a
|
||||
configurable time span. The time comparison considers the object time, not the
|
||||
time of their creation.</p>
|
||||
<p>The parameters which scdbstrip removes are</p>
|
||||
<ul class="simple">
|
||||
<li><p>Event parameters including events, origins, magnitudes, amplitudes, arrivals, picks,
|
||||
focal mechanisms, moment tensors</p></li>
|
||||
<li><p>Waveform quality control (QC) parameters.</p></li>
|
||||
</ul>
|
||||
<p>scdbstrip will remove all events with an origin time and QC parameters older or
|
||||
younger than specified. Default is ‘older’. It will also remove all associated
|
||||
objects such as picks, origins, arrivals, amplitudes and so on.</p>
|
||||
<p>scdbstrip does not run as a daemon. To remove old objects continuously scdbstrip
|
||||
should be added to the list of cronjobs running every e.g. 30 minutes. The more
|
||||
often it runs the less objects it has to remove and the faster it will unlock
|
||||
the database again. The timing and the parameters to be removed is controlled
|
||||
by module configuration or command-line options.</p>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<ul class="simple">
|
||||
<li><p>For removing specific parameters and not all in a time range, use
|
||||
<a class="reference internal" href="scdispatch.html#scdispatch"><span class="std std-ref">scdispatch</span></a> along with XML files created by <a class="reference internal" href="scxmldump.html#scxmldump"><span class="std std-ref">scxmldump</span></a> and
|
||||
<a class="reference internal" href="scqueryqc.html#scqueryqc"><span class="std std-ref">scqueryqc</span></a> for event parameters and waveform QC parameters,
|
||||
respectively.</p></li>
|
||||
<li><p>For removing data availability parameters use <a class="reference internal" href="scardac.html#scardac"><span class="std std-ref">scardac</span></a>.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section id="known-issues">
|
||||
<h2>Known Issues<a class="headerlink" href="#known-issues" title="Permalink to this heading">¶</a></h2>
|
||||
<p>When running scdbstrip for the first time on a large database it can happen
|
||||
that it aborts in case of MYSQL with the following error message:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="o">[</span><span class="w"> </span><span class="m">3</span>%<span class="o">]</span><span class="w"> </span>Delete<span class="w"> </span>origin<span class="w"> </span>references<span class="w"> </span>of<span class="w"> </span>old<span class="w"> </span>events...08:48:22<span class="w"> </span><span class="o">[</span>error<span class="o">]</span>
|
||||
execute<span class="o">(</span><span class="s2">"delete Object from Object, OriginReference, old_events where</span>
|
||||
<span class="s2">Object._oid=OriginReference._oid and</span>
|
||||
<span class="s2">OriginReference._parent_oid=old_events._oid"</span><span class="o">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1206</span><span class="w"> </span><span class="o">(</span>The<span class="w"> </span>total<span class="w"> </span>number
|
||||
of<span class="w"> </span>locks<span class="w"> </span>exceeds<span class="w"> </span>the<span class="w"> </span>lock<span class="w"> </span>table<span class="w"> </span>size<span class="o">)</span>
|
||||
|
||||
Exception:<span class="w"> </span>ERROR:<span class="w"> </span><span class="nb">command</span><span class="w"> </span><span class="s1">'delete Object from Object, OriginReference,</span>
|
||||
<span class="s1">old_events where Object._oid=OriginReference._oid and</span>
|
||||
<span class="s1">OriginReference._parent_oid=old_events._oid'</span><span class="w"> </span>failed
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>That means your MYSQL server cannot hold enough data required for deletion.
|
||||
There are two solutions to this:</p>
|
||||
<ol class="arabic">
|
||||
<li><p>Increase the memory pool used by MYSQL by changing the configuration. The
|
||||
minimum is 64 MBytes but modern system typically have a larger default:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">innodb_buffer_pool_size</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>64M
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The size of the new buffer depends on the size of the database that should
|
||||
be cleaned up. Read also the section <a class="reference internal" href="../base/installation.html#database-configuration"><span class="std std-ref">Database Server Configuration</span></a>. It
|
||||
provides more options for optimizing your database server.</p>
|
||||
</li>
|
||||
<li><p>Run scdbstrip on smaller batches for the first time:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>scdbstrip<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>--days<span class="w"> </span><span class="m">1000</span>
|
||||
$<span class="w"> </span>scdbstrip<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>--days<span class="w"> </span><span class="m">900</span>
|
||||
...
|
||||
$<span class="w"> </span>scdbstrip<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>--days<span class="w"> </span><span class="m">100</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ol>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<p>In the examples, database connection parameters correspond to default values.
|
||||
You may thus replace <code class="docutils literal notranslate"><span class="pre">-d</span> <span class="pre">mysql://sysop:sysop@localhost/seiscomp</span></code> by
|
||||
<code class="docutils literal notranslate"><span class="pre">-d</span> <span class="pre">localhost</span></code> or <code class="docutils literal notranslate"><span class="pre">-d</span> <span class="pre">mysql://</span></code>.</p>
|
||||
</div>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<ul>
|
||||
<li><p>Remove event and waveform quality parameters older than 30 days</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdbstrip<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>--days<span class="w"> </span><span class="m">30</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Remove event and waveform quality parameters newer than 30 days</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdbstrip<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>--days<span class="w"> </span><span class="m">30</span><span class="w"> </span>-i
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Only remove waveform QC parameters older than 30 days but no others</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdbstrip<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>--days<span class="w"> </span><span class="m">30</span><span class="w"> </span>--qc-only
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Remove event and waveform quality parameters before 2000-01-01 12:00:00</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdbstrip<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>--datetime<span class="w"> </span><span class="m">2000</span>-01-01T12:00:00
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Remove event and waveform quality parameters after 2000-01-01 12:00:00</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdbstrip<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>--datetime<span class="w"> </span><span class="m">2000</span>-01-01T12:00:00<span class="w"> </span>-i
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Remove event and waveform quality parameters between 2000-01-01 12:00:00 ~ 2000-01-01 14:00:00</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdbstrip<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>--time-window<span class="w"> </span><span class="m">2000</span>-01-01T12:00:00~2000-01-01T14:00:00
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Remove event and waveform quality parameters before 2000-01-01 12:00:00 and after 2000-01-01 14:00:00</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdbstrip<span class="w"> </span>-d<span class="w"> </span>mysql://sysop:sysop@localhost/seiscomp<span class="w"> </span>--time-window<span class="w"> </span><span class="m">2000</span>-01-01T12:00:00~2000-01-01T14:00:00<span class="w"> </span>-i
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="module-configuration">
|
||||
<span id="scdbstrip-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="line-block">
|
||||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
|
||||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scdbstrip.cfg</span></code></div>
|
||||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
|
||||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scdbstrip.cfg</span></code></div>
|
||||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
|
||||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scdbstrip.cfg</span></code></div>
|
||||
</div>
|
||||
<p>scdbstrip inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-database.cleanup.invertMode">
|
||||
<span class="sig-name descname"><span class="pre">database.cleanup.invertMode</span></span><a class="headerlink" href="#confval-database.cleanup.invertMode" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
|
||||
<p>Type: <em>boolean</em></p>
|
||||
<p>Invert the selection of the specified time period, that is
|
||||
delete all parameters after the specified time period,
|
||||
not before. When a date range is specified, then delete all
|
||||
parameters before and after the time range, not in between.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-database.cleanup.eventParameters">
|
||||
<span class="sig-name descname"><span class="pre">database.cleanup.eventParameters</span></span><a class="headerlink" href="#confval-database.cleanup.eventParameters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p>Type: <em>boolean</em></p>
|
||||
<p>Strip all event parameters including events, origins,
|
||||
magnitudes, amplitudes, arrivals, picks, focal mechanisms.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-database.cleanup.qualityControl">
|
||||
<span class="sig-name descname"><span class="pre">database.cleanup.qualityControl</span></span><a class="headerlink" href="#confval-database.cleanup.qualityControl" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p>Type: <em>boolean</em></p>
|
||||
<p>Strip waveform quality control (QC) parameters.</p>
|
||||
</dd></dl>
|
||||
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p><strong>database.cleanup.keep.*</strong>
|
||||
<em>Parameters controlling the time to keep objects in the database.</em>
|
||||
<em>The time comparison considers the object time, not the time of</em>
|
||||
<em>their creation.</em></p>
|
||||
</div>
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-database.cleanup.keep.days">
|
||||
<span class="sig-name descname"><span class="pre">database.cleanup.keep.days</span></span><a class="headerlink" href="#confval-database.cleanup.keep.days" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">30</span></code></p>
|
||||
<p>Type: <em>int</em></p>
|
||||
<p>The number of days to preserve in the database. This
|
||||
value is added to the whole timespan. Hours
|
||||
and minutes are configured separately.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-database.cleanup.keep.hours">
|
||||
<span class="sig-name descname"><span class="pre">database.cleanup.keep.hours</span></span><a class="headerlink" href="#confval-database.cleanup.keep.hours" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
|
||||
<p>Type: <em>int</em></p>
|
||||
<p>The number of hours to preserve in the database. This
|
||||
value is added to the whole timespan. Days
|
||||
and minutes are configured separately.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-database.cleanup.keep.minutes">
|
||||
<span class="sig-name descname"><span class="pre">database.cleanup.keep.minutes</span></span><a class="headerlink" href="#confval-database.cleanup.keep.minutes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
|
||||
<p>Type: <em>int</em></p>
|
||||
<p>The number of minutes to preserve in the database. This
|
||||
value is added to the whole timespan. Days
|
||||
and hours are configured separately.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="command-line-options">
|
||||
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading">¶</a></h2>
|
||||
<p><strong class="program">scdbstrip [options]</strong></p>
|
||||
<section id="generic">
|
||||
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-h">
|
||||
<span id="cmdoption-scdbstrip-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-h" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Show help message.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-V">
|
||||
<span id="cmdoption-scdbstrip-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-V" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Show version information.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-config-file">
|
||||
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-config-file" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Use alternative configuration file. When this option is
|
||||
used the loading of all stages is disabled. Only the
|
||||
given configuration file is parsed and used. To use
|
||||
another name for the configuration create a symbolic
|
||||
link of the application or copy it. Example:
|
||||
scautopick -> scautopick2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-plugins">
|
||||
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-plugins" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Load given plugins.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-first-new">
|
||||
<span class="sig-name descname"><span class="pre">--first-new</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-first-new" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Overrides configuration parameter <a class="reference internal" href="scvoice.html#confval-firstNew"><code class="xref std std-confval docutils literal notranslate"><span class="pre">firstNew</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="verbosity">
|
||||
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-verbosity">
|
||||
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-verbosity" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
|
||||
4:debug.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-v">
|
||||
<span id="cmdoption-scdbstrip-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-v" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-q">
|
||||
<span id="cmdoption-scdbstrip-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-q" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Quiet mode: no logging output.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-component">
|
||||
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-component" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Limit the logging to a certain component. This option can
|
||||
be given more than once.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-s">
|
||||
<span id="cmdoption-scdbstrip-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-s" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Use syslog logging backend. The output usually goes to
|
||||
/var/lib/messages.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-l">
|
||||
<span id="cmdoption-scdbstrip-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-l" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Path to lock file.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-console">
|
||||
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-console" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Send log output to stdout.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-debug">
|
||||
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-debug" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Execute in debug mode.
|
||||
Equivalent to --verbosity=4 --console=1 .</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-log-file">
|
||||
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-log-file" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Use alternative log file.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="database">
|
||||
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-db-driver-list">
|
||||
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-db-driver-list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>List all supported database drivers.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-d">
|
||||
<span id="cmdoption-scdbstrip-database"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-d" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The database connection string, format:
|
||||
<a class="reference external" href="service://user:pwd@host/database">service://user:pwd@host/database</a>.
|
||||
"service" is the name of the database driver which
|
||||
can be queried with "--db-driver-list".</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-config-module">
|
||||
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-config-module" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The config module to use.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-inventory-db">
|
||||
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-inventory-db" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Load the inventory from the given database or file, format:
|
||||
[<a class="reference external" href="service://]location">service://]location</a> .</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-db-disable">
|
||||
<span class="sig-name descname"><span class="pre">--db-disable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-db-disable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Do not use the database at all</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="mode">
|
||||
<h3>Mode<a class="headerlink" href="#mode" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-check">
|
||||
<span class="sig-name descname"><span class="pre">--check</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-check" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Checks if unreachable objects exist.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-clean-unused">
|
||||
<span class="sig-name descname"><span class="pre">--clean-unused</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-clean-unused" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Remove all unreachable objects when in checkmode. Default:
|
||||
off.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="objects">
|
||||
<h3>Objects<a class="headerlink" href="#objects" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-E">
|
||||
<span id="cmdoption-scdbstrip-ep-only"></span><span class="sig-name descname"><span class="pre">-E</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--ep-only</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-E" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Strip only event parameters. Other parameters, like QC, are
|
||||
are ignored.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-Q">
|
||||
<span id="cmdoption-scdbstrip-qc-only"></span><span class="sig-name descname"><span class="pre">-Q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--qc-only</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-Q" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Strip only waveform quality control (QC) parameters. Other
|
||||
parameters, like event parameters, are are ignored.
|
||||
Overrides ‘eq-only’.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="timespan">
|
||||
<h3>Timespan<a class="headerlink" href="#timespan" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-days">
|
||||
<span class="sig-name descname"><span class="pre">--days</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-days" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-database.cleanup.keep.days"><code class="xref std std-confval docutils literal notranslate"><span class="pre">database.cleanup.keep.days</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-hours">
|
||||
<span class="sig-name descname"><span class="pre">--hours</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-hours" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-database.cleanup.keep.hours"><code class="xref std std-confval docutils literal notranslate"><span class="pre">database.cleanup.keep.hours</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-minutes">
|
||||
<span class="sig-name descname"><span class="pre">--minutes</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-minutes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-database.cleanup.keep.minutes"><code class="xref std std-confval docutils literal notranslate"><span class="pre">database.cleanup.keep.minutes</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-datetime">
|
||||
<span class="sig-name descname"><span class="pre">--datetime</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-datetime" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Replaces the days:hours:minutes timespan definition by an
|
||||
arbitrary absolute timestamp in UTC. Format:
|
||||
%Y-%m-%dT%H:%M:%S.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-t">
|
||||
<span id="cmdoption-scdbstrip-time-window"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--time-window</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scdbstrip-t" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Delete objects in the specified time window.
|
||||
Replaces the days:hours:minutes timespan definition by an
|
||||
arbitrary absolute time range in UTC. Format:
|
||||
startTime~endTime that is %Y-%m-%dT%H:%M:%S~%Y-%m-%dT%H:%M:%S</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-i">
|
||||
<span id="cmdoption-scdbstrip-invert"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--invert</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-i" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-database.cleanup.invertMode"><code class="xref std std-confval docutils literal notranslate"><span class="pre">database.cleanup.invertMode</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scdbstrip-keep-events">
|
||||
<span class="sig-name descname"><span class="pre">--keep-events</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scdbstrip-keep-events" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>IDs of events to keep in the database separated with comma.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
<div id="anchors-bottom"></div>
|
||||
</div>
|
||||
|
||||
<div class="sidebar" role="navigation" aria-label="main navigation">
|
||||
<div id="anchors-top"></div>
|
||||
<div id="anchors" class="content">
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||||
<div>
|
||||
<h3><a href="../index.html">Table of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">scdbstrip</a><ul>
|
||||
<li><a class="reference internal" href="#description">Description</a></li>
|
||||
<li><a class="reference internal" href="#known-issues">Known Issues</a></li>
|
||||
<li><a class="reference internal" href="#examples">Examples</a></li>
|
||||
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
|
||||
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
|
||||
<li><a class="reference internal" href="#generic">Generic</a></li>
|
||||
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
|
||||
<li><a class="reference internal" href="#database">Database</a></li>
|
||||
<li><a class="reference internal" href="#mode">Mode</a></li>
|
||||
<li><a class="reference internal" href="#objects">Objects</a></li>
|
||||
<li><a class="reference internal" href="#timespan">Timespan</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="scdb.html"
|
||||
title="previous chapter">scdb</a></p>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="scdispatch.html"
|
||||
title="next chapter">scdispatch</a></p>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/apps/scdbstrip.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<div class="container">
|
||||
<div class="horizontal layout content">
|
||||
<a class="fade-in" href="https://www.gempa.de" target="_blank">
|
||||
<img class="brand" src="../_static/brands/gempa.svg"/>
|
||||
</a>
|
||||
<div class="stretched align-center fitted content">
|
||||
<div>
|
||||
Version <b>6.9.0</b> Release
|
||||
</div>
|
||||
<div class="copyright">
|
||||
Copyright © gempa GmbH, GFZ Potsdam.
|
||||
</div>
|
||||
</div>
|
||||
<a class="fade-in" href="https://www.gfz-potsdam.de" target="_blank">
|
||||
<img class="brand" src="../_static/brands/gfz.svg"/>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
Reference in New Issue
Block a user