[seiscomp, scanloc] Install, add .gitignore
This commit is contained in:
495
share/doc/seiscomp/html/apps/scquery.html
Normal file
495
share/doc/seiscomp/html/apps/scquery.html
Normal file
@ -0,0 +1,495 @@
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<title>scquery — 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="scqueryqc" href="scqueryqc.html" />
|
||||
<link rel="prev" title="scorgls" href="scorgls.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="scqueryqc.html" title="scqueryqc"
|
||||
accesskey="N">
|
||||
next
|
||||
</a>
|
||||
</li>
|
||||
<li class="right">
|
||||
<a href="scorgls.html" title="scorgls"
|
||||
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="scquery">
|
||||
<span id="id1"></span><h1>scquery<a class="headerlink" href="#scquery" title="Permalink to this heading">¶</a></h1>
|
||||
<p><strong>Read database objects and writes them to the command line.</strong></p>
|
||||
<section id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</a></h2>
|
||||
<p><em>scquery</em> reads objects such as event information from a
|
||||
<a class="reference internal" href="../base/concepts/database.html#concepts-database"><span class="std std-ref">SeisComP database</span></a> using custom queries. The results
|
||||
are written to stdout. The module extends <a class="reference internal" href="scevtls.html#scevtls"><span class="std std-ref">scevtls</span></a> and <a class="reference internal" href="scorgls.html#scorgls"><span class="std std-ref">scorgls</span></a>
|
||||
which are limited to searching event and origin IDs, respectively, by time.</p>
|
||||
<p>scquery takes into account and requires <a class="reference internal" href="#scquery-queries"><span class="std std-ref">query profiles</span></a>
|
||||
for querying the database. The profiles are defined in</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="file docutils literal notranslate"><span class="pre">@SYSTEMCONFIGDIR@/queries.cfg</span></code> or</p></li>
|
||||
<li><p><code class="file docutils literal notranslate"><span class="pre">@CONFIGDIR@/queries.cfg</span></code></p></li>
|
||||
</ul>
|
||||
<p>while parameters in the latter take priority. The are no default query profile,
|
||||
hence they must be created first.</p>
|
||||
</section>
|
||||
<section id="module-setup">
|
||||
<h2>Module Setup<a class="headerlink" href="#module-setup" title="Permalink to this heading">¶</a></h2>
|
||||
<ol class="arabic" id="scquery-config">
|
||||
<li><p>Create the query profiles in <code class="file docutils literal notranslate"><span class="pre">queries.cfg</span></code> in <code class="file docutils literal notranslate"><span class="pre">@SYSTEMCONFIGDIR@</span></code>
|
||||
or <code class="file docutils literal notranslate"><span class="pre">@CONFIGDIR@</span></code>. The file contains your database queries. Examples for
|
||||
MariaDB/MySQL and PostgreSQL are found in the section <a class="reference internal" href="#scquery-queries"><span class="std std-ref">Queries</span></a>.</p></li>
|
||||
<li><p><strong>Optional:</strong> Add the database connection parameter to the configuration file
|
||||
<code class="file docutils literal notranslate"><span class="pre">scquery.cfg</span></code> or <code class="file docutils literal notranslate"><span class="pre">global.cfg</span></code> in @CONFIGDIR@ or to @SYSTEMCONFIGDIR@:</p>
|
||||
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">database</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">mysql://sysop:sysop@localhost/seiscomp</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<p>If the database connection is configured, the database option
|
||||
<a class="reference internal" href="global.html#confval-database"><code class="xref std std-confval docutils literal notranslate"><span class="pre">-d</span></code></a> in the section <a class="reference internal" href="#scquery-examples"><span class="std std-ref">Examples</span></a>
|
||||
can be omitted or used to override the configuration.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ol>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<span id="scquery-examples"></span><h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Choose any query profile defined in the <a class="reference internal" href="#scquery-queries"><span class="std std-ref">queries.cfg</span></a>.
|
||||
Provide the required parameters in the same order as in the database request.
|
||||
The required parameters are indicated by hashes, e.g. ##latMin##.</p>
|
||||
<ol class="arabic">
|
||||
<li><p>List all available query profiles using the command-line option
|
||||
<code class="xref std std-confval docutils literal notranslate"><span class="pre">showqueries</span></code>:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scquery<span class="w"> </span>--showqueries
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Profile <strong>event_filter</strong>: Fetch all event IDs and event parameters for events
|
||||
with magnitude ranging from 2.5 to 5 in central Germany between 2014 and 2017:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scquery<span class="w"> </span>-d<span class="w"> </span>localhost/seiscomp<span class="w"> </span>eventFilter<span class="w"> </span><span class="m">50</span><span class="w"> </span><span class="m">52</span><span class="w"> </span><span class="m">11</span>.5<span class="w"> </span><span class="m">12</span>.5<span class="w"> </span><span class="m">2</span>.5<span class="w"> </span><span class="m">5</span><span class="w"> </span><span class="m">2014</span>-01-01<span class="w"> </span><span class="m">2018</span>-01-01<span class="w"> </span>><span class="w"> </span>events_vogtland.txt
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Profile <strong>eventByAuthor</strong>: Fetch all event IDs where the preferred origin was
|
||||
provided by a specific author for events 2.5 to 5 with 6 to 20 phases in central
|
||||
Germany between 2014 and 2017:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scquery<span class="w"> </span>-d<span class="w"> </span>localhost/seiscomp<span class="w"> </span>eventByAuthor<span class="w"> </span><span class="m">50</span><span class="w"> </span><span class="m">52</span><span class="w"> </span><span class="m">11</span>.5<span class="w"> </span><span class="m">12</span>.5<span class="w"> </span><span class="m">6</span><span class="w"> </span><span class="m">20</span><span class="w"> </span><span class="m">2</span>.5<span class="w"> </span><span class="m">5</span><span class="w"> </span><span class="m">2014</span>-01-01<span class="w"> </span><span class="m">2018</span>-01-01<span class="w"> </span>scautoloc<span class="w"> </span>><span class="w"> </span>events_vogtland.txt
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Profile <strong>eventType</strong>: Fetch all event IDs and event times from events
|
||||
with the given event type and within the provided time interval:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scquery<span class="w"> </span>-d<span class="w"> </span>localhost/seiscomp<span class="w"> </span>eventType<span class="w"> </span>explosion<span class="w"> </span><span class="s1">'2017-11-01 00:00:00'</span><span class="w"> </span><span class="s1">'2018-11-01 00:00:00'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ol>
|
||||
</section>
|
||||
<section id="queries">
|
||||
<span id="scquery-queries"></span><h2>Queries<a class="headerlink" href="#queries" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Example queries for <a class="reference internal" href="#scquery-mariadb"><span class="std std-ref">MariaDB/MySQL</span></a> and <a class="reference internal" href="#scquery-psql"><span class="std std-ref">PostgreSQL</span></a> are given
|
||||
below.</p>
|
||||
<section id="mariadb-mysql">
|
||||
<span id="scquery-mariadb"></span><h3>MariaDB/MySQL<a class="headerlink" href="#mariadb-mysql" title="Permalink to this heading">¶</a></h3>
|
||||
<p><strong>General event/origin queries</strong></p>
|
||||
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">queries</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">eventFilter, eventUncertainty, eventByAuthor, eventWithStationCount, eventType, originByAuthor</span>
|
||||
|
||||
<span class="na">query.eventFilter.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Returns all events (lat, lon, mag, time) that fall into a certain region and a magnitude range"</span>
|
||||
<span class="na">query.eventFilter</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT PEvent.publicID, Origin.time_value AS OT, Origin.latitude_value,Origin.longitude_value, Origin.depth_value, Magnitude.magnitude_value, Magnitude.type FROM Origin,PublicObject as POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject as PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID=Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Origin.latitude_value >= ##latMin## AND Origin.latitude_value <= ##latMax## AND Origin.longitude_value >= ##lonMin## AND Origin.longitude_value <= ##lonMax## AND Magnitude.magnitude_value >= ##minMag## AND Magnitude.magnitude_value <= ##maxMag## AND Origin.time_value >= '##startTime##' AND Origin.time_value <= '##endTime##';"</span>
|
||||
|
||||
<span class="na">query.eventUncertainty.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Returns all events (eventsIDs, time, lat, lat error, lon, lon error, depth, depth error, magnitude, region name) in the form of an event catalog"</span>
|
||||
<span class="na">query.eventUncertainty</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT PEvent.publicID, Origin.time_value AS OT, ROUND(Origin.latitude_value, 3), ROUND(Origin.latitude_uncertainty, 3), ROUND(Origin.longitude_value, 3), ROUND(Origin.longitude_uncertainty, 3), ROUND(Origin.depth_value, 3), ROUND(Origin.depth_uncertainty, 3), ROUND(Magnitude.magnitude_value, 1), EventDescription.text FROM Event, PublicObject AS PEvent, EventDescription, Origin, PublicObject AS POrigin, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND Event.preferredOriginID = POrigin.publicID AND Event.preferredMagnitudeID = PMagnitude.publicID AND Event._oid = EventDescription._parent_oid AND EventDescription.type = 'region name' AND Event.type = '##type##' AND Origin.time_value >= '##startTime##' AND Origin.time_value <= '##endTime##';"</span>
|
||||
|
||||
<span class="na">query.eventByAuthor.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Get events by preferred origin author etc"</span>
|
||||
<span class="na">query.eventByAuthor</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT PEvent.publicID, Origin.time_value AS OT, Origin.latitude_value AS lat,Origin.longitude_value AS lon, Origin.depth_value AS dep, Magnitude.magnitude_value AS mag, Magnitude.type AS mtype, Origin.quality_usedPhaseCount AS phases, Event.type AS type, Event.typeCertainty AS certainty, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Origin.latitude_value >= ##latMin## AND Origin.latitude_value <= ##latMax## AND Origin.longitude_value >= ##lonMin## AND Origin.longitude_value <= ##lonMax## AND Origin.quality_usedPhaseCount >= ##minPhases## AND Origin.quality_usedPhaseCount <= ##maxPhases## AND Magnitude.magnitude_value >= ##minMag## AND Magnitude.magnitude_value <= ##maxMag## AND Origin.time_value >= '##startTime##' AND Origin.time_value <= '##endTime##' AND Origin.creationInfo_author like '##author##';"</span>
|
||||
|
||||
<span class="na">query.eventWithStationCount.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Get events by preferred origin author etc"</span>
|
||||
<span class="na">query.eventWithStationCount</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT PEvent.publicID, Origin.time_value AS OT, Origin.latitude_value AS lat, Origin.longitude_value AS lon, Origin.depth_value AS dep, Magnitude.magnitude_value AS mag, Magnitude.type AS mtype, Origin.quality_usedStationCount AS stations, Event.type AS type, Event.typeCertainty AS certainty, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Origin.time_value >= '##startTime##' AND Origin.time_value <= '##endTime##';"</span>
|
||||
|
||||
<span class="na">query.eventType.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Returns all eventIDs FROM event WHERE the type is flagged AS 'event type'"</span>
|
||||
<span class="na">query.eventType</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT pe.publicID, o.time_value AS OT FROM PublicObject pe, PublicObject po, Event e, Origin o WHERE pe._oid = e._oid AND po._oid = o._oid AND e.preferredOriginID = po.publicID AND e.type = '##type##' AND o.time_value >= '##startTime##' AND o.time_value <= '##endTime##';"</span>
|
||||
|
||||
<span class="na">query.originByAuthor.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Get origins by author"</span>
|
||||
<span class="na">query.originByAuthor</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT po.publicID, o.time_value AS OT, o.creationInfo_author FROM PublicObject po JOIN Origin o ON po._oid = o._oid WHERE o.creationInfo_author like '##author##' AND o.time_value >= '##startTime##' AND o.time_value <= '##endTime##';"</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><strong>More examples and statistics</strong></p>
|
||||
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">queries</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">phaseCountPerAuthor, time, mag_time, space_time, all, space_mag_time, event, fm_space_time, picks, stationPicks, assoc_picks, pref_assoc_picks, sta_net_mag, sta_net_mag_type, delta_sta_net_mag, delta_sta_net_mag_type</span>
|
||||
|
||||
<span class="na">query.phaseCountPerAuthor.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Get phase count per origin author FROM event #EventID#"</span>
|
||||
<span class="na">query.phaseCountPerAuthor</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT PEvent.publicID, Origin.creationInfo_author, MAX(Origin.quality_usedPhaseCount) FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, OriginReference WHERE Origin._oid = POrigin._oid AND Event._oid = PEvent._oid AND OriginReference._parent_oid = Event._oid AND OriginReference.originID = POrigin.publicID AND PEvent.publicID = '##EventID##' group by Origin.creationInfo_author;"</span>
|
||||
|
||||
<span class="na">query.time.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Events in time range"</span>
|
||||
<span class="na">query.time</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT PEvent.publicID, Origin.time_value, ROUND(Origin.latitude_value, 4), ROUND(Origin.longitude_value, 4), ROUND(Origin.depth_value, 1), ROUND(Magnitude.magnitude_value, 1), Magnitude.type, Origin.quality_usedPhaseCount, Origin.quality_usedStationCount, Event.typeCertainty, Event.type, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Origin.time_value >= '##startTime##' AND Origin.time_value <= '##endTime##';"</span>
|
||||
|
||||
<span class="na">query.mag_time.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Events in magnitude-time range"</span>
|
||||
<span class="na">query.mag_time</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT PEvent.publicID, Origin.time_value, ROUND(Origin.latitude_value, 4), ROUND(Origin.longitude_value, 4), ROUND(Origin.depth_value, 1), ROUND(Magnitude.magnitude_value, 1), Magnitude.type, Origin.quality_usedPhaseCount, Origin.quality_usedStationCount, Event.typeCertainty, Event.type, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Magnitude.magnitude_value >= ##minMag## AND Magnitude.magnitude_value <= ##maxMag## AND Origin.time_value >= '##startTime##' AND Origin.time_value <= '##endTime##';"</span>
|
||||
|
||||
<span class="na">query.space_time.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Events in space-time range"</span>
|
||||
<span class="na">query.space_time</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT PEvent.publicID, Origin.time_value, ROUND(Origin.latitude_value, 4), ROUND(Origin.longitude_value, 4), ROUND(Origin.depth_value, 1), ROUND(Magnitude.magnitude_value, 1), Magnitude.type, Origin.quality_usedPhaseCount, Origin.quality_usedStationCount, Event.typeCertainty, Event.type, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Origin.latitude_value >= ##latMin## AND Origin.latitude_value <= ##latMax## AND Origin.longitude_value >= ##lonMin## AND Origin.longitude_value <= ##lonMax## AND Origin.time_value >= '##startTime##' AND Origin.time_value <= '##endTime##';"</span>
|
||||
|
||||
<span class="na">query.all.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Events in space-magnitude-time-quality range by author"</span>
|
||||
<span class="na">query.all</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT PEvent.publicID, Origin.time_value, ROUND(Origin.latitude_value, 4), ROUND(Origin.longitude_value, 4), ROUND(Origin.depth_value, 1), ROUND(Magnitude.magnitude_value, 1), Magnitude.type, Origin.quality_usedPhaseCount, Origin.quality_usedStationCount, Event.typeCertainty, Event.type, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Origin.latitude_value >= ##latMin## AND Origin.latitude_value <= ##latMax## AND Origin.longitude_value >= ##lonMin## AND Origin.longitude_value <= ##lonMax## AND Origin.quality_usedPhaseCount >= ##minPhases## AND Origin.quality_usedPhaseCount <= ##maxPhases## AND Magnitude.magnitude_value >= ##minMag## AND Magnitude.magnitude_value <= ##maxMag## AND Origin.time_value >= '##startTime##' AND Origin.time_value <= '##endTime##' AND Origin.creationInfo_author like '##author##%';"</span>
|
||||
|
||||
<span class="na">query.space_mag_time.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Events in space-magnitude-time range"</span>
|
||||
<span class="na">query.space_mag_time</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT PEvent.publicID, Origin.time_value, ROUND(Origin.latitude_value, 4), ROUND(Origin.longitude_value, 4), ROUND(Origin.depth_value, 1), ROUND(Magnitude.magnitude_value, 1), Magnitude.type, Origin.quality_usedPhaseCount, Origin.quality_usedStationCount, Event.typeCertainty, Event.type, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Origin.latitude_value >= ##latMin## AND Origin.latitude_value <= ##latMax## AND Origin.longitude_value >= ##lonMin## AND Origin.longitude_value <= ##lonMax## AND Magnitude.magnitude_value >= ##minMag## AND Magnitude.magnitude_value <= ##maxMag## AND Origin.time_value >= '##startTime##' AND Origin.time_value <= '##endTime##';"</span>
|
||||
|
||||
<span class="na">query.fm_space_time.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Events with focal mechanisms in space-time range"</span>
|
||||
<span class="na">query.fm_space_time</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT PEvent.publicID, Origin.time_value, ROUND(Origin.latitude_value, 4), ROUND(Origin.longitude_value, 4), ROUND(Origin.depth_value, 1), ROUND(Magnitude.magnitude_value, 1), Magnitude.type, MomentTensor.doubleCouple, MomentTensor.variance, Event.typeCertainty, Event.type, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude, FocalMechanism, PublicObject AS PFocalMechanism, MomentTensor WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND FocalMechanism._oid = PFocalMechanism._oid AND PFocalMechanism.publicID = Event.preferredFocalMechanismID AND MomentTensor._parent_oid = FocalMechanism._oid AND POrigin.publicID = Event.preferredOriginID AND Origin.latitude_value >= ##latMin## AND Origin.latitude_value <= ##latMax## AND Origin.longitude_value >= ##lonMin## AND Origin.longitude_value <= ##lonMax## AND Origin.time_value >= '##startTime##' AND Origin.time_value <= '##endTime##';"</span>
|
||||
|
||||
<span class="na">query.event.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"List authors and number of origins for event"</span>
|
||||
<span class="na">query.event</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT PEvent.publicID, Origin.creationInfo_author, MAX(Origin.quality_usedPhaseCount) FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, OriginReference WHERE Origin._oid = POrigin._oid AND Event._oid = PEvent._oid AND OriginReference._parent_oid = Event._oid AND OriginReference.originID = POrigin.publicID AND PEvent.publicID = '##EventID##' group by Origin.creationInfo_author;"</span>
|
||||
|
||||
<span class="na">query.picks.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"List number of picks per station in a certain timespan"</span>
|
||||
<span class="na">query.picks</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT waveformID_networkCode AS Network, waveformID_stationCode AS Station, COUNT(_oid) AS Picks, MIN(time_value) AS Start, MAX(time_value) AS End FROM Pick WHERE time_value >= '##startTime##' AND time_value <= '##endTime##' GROUP BY waveformID_networkCode, waveformID_stationCode;"</span>
|
||||
|
||||
<span class="na">query.stationPicks.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"List the picks and phase hints per station in a certain timespan"</span>
|
||||
<span class="na">query.stationPicks</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT PPick.publicID, Pick.phaseHint_code FROM Pick, PublicObject AS PPick WHERE Pick._oid = PPick._oid AND waveformID_networkCode = '##netCode##' AND waveformID_stationCode = '##staCode##' AND time_value >= '##startTime##' AND time_value <= '##endTime##';"</span>
|
||||
|
||||
<span class="na">query.assoc_picks.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"List number of associated picks per station in a certain time span"</span>
|
||||
<span class="na">query.assoc_picks</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT Pick.waveformID_networkCode AS Network, Pick.waveformID_stationCode AS Station, COUNT(DISTINCT(Pick._oid)) AS Picks, MIN(Pick.time_value) AS Start, MAX(Pick.time_value) AS End FROM Pick, PublicObject PPick, Arrival WHERE Pick._oid = PPick._oid AND PPick.publicID = Arrival.pickID AND Pick.time_value >= '##startTime##' AND Pick.time_value <= '##endTime##' GROUP BY Pick.waveformID_networkCode, Pick.waveformID_stationCode;"</span>
|
||||
|
||||
<span class="na">query.pref_assoc_picks.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"List number of associated picks of preferred origins per station for certain time span"</span>
|
||||
<span class="na">query.pref_assoc_picks</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT Pick.waveformID_networkCode AS Network, Pick.waveformID_stationCode AS Station, COUNT(DISTINCT(Pick._oid)) AS Picks, MIN(Pick.time_value) AS Start, MAX(Pick.time_value) AS End FROM Pick, PublicObject PPick, Arrival, Origin, PublicObject POrigin, Event WHERE Event.preferredOriginID = POrigin.publicID AND Origin._oid = POrigin._oid AND Origin._oid = Arrival._parent_oid AND Pick._oid = PPick._oid AND PPick.publicID = Arrival.pickID AND Pick.time_value >= '##startTime##' AND Pick.time_value <= '##endTime##' GROUP BY Pick.waveformID_networkCode, Pick.waveformID_stationCode;"</span>
|
||||
|
||||
<span class="na">query.sta_net_mag.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Compares station magnitudes of a particular station with the network magnitude in a certain time span"</span>
|
||||
<span class="na">query.sta_net_mag</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT StationMagnitude.waveformID_networkCode AS Network, StationMagnitude.waveformID_stationCode AS Station, StationMagnitude.magnitude_value AS StaMag, Magnitude.magnitude_value AS NetMag, Magnitude.type AS NetMagType, StationMagnitude.creationInfo_creationTime AS CreationTime FROM StationMagnitude, PublicObject PStationMagnitude, StationMagnitudeContribution, Magnitude WHERE StationMagnitude._oid = PStationMagnitude._oid AND StationMagnitudeContribution.stationMagnitudeID = PStationMagnitude.publicID AND StationMagnitudeContribution._parent_oid = Magnitude._oid AND StationMagnitude.waveformID_networkCode = '##netCode##' AND StationMagnitude.waveformID_stationCode = '##staCode##' AND StationMagnitude.creationInfo_creationTime >= '##startTime##' AND StationMagnitude.creationInfo_creationTime <= '##endTime##' ORDER BY StationMagnitude.creationInfo_creationTime;"</span>
|
||||
|
||||
<span class="na">query.sta_net_mag_type.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Compares station magnitudes of a particular station with the network magnitude of specific type in a certain time span"</span>
|
||||
<span class="na">query.sta_net_mag_type</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT StationMagnitude.waveformID_networkCode AS Network, StationMagnitude.waveformID_stationCode AS Station, StationMagnitude.magnitude_value AS StaMag, Magnitude.magnitude_value AS NetMag, Magnitude.type AS NetMagType, StationMagnitude.creationInfo_creationTime AS CreationTime FROM StationMagnitude, PublicObject PStationMagnitude, StationMagnitudeContribution, Magnitude WHERE StationMagnitude._oid = PStationMagnitude._oid AND StationMagnitudeContribution.stationMagnitudeID = PStationMagnitude.publicID AND StationMagnitudeContribution._parent_oid = Magnitude._oid AND StationMagnitude.waveformID_networkCode = '##netCode##' AND StationMagnitude.waveformID_stationCode = '##staCode##' AND StationMagnitude.creationInfo_creationTime >= '##startTime##' AND StationMagnitude.creationInfo_creationTime <= '##endTime##' AND Magnitude.type = '##magType##' ORDER BY StationMagnitude.creationInfo_creationTime;"</span>
|
||||
|
||||
<span class="na">query.delta_sta_net_mag.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Calculates delta values of station and network magnitudes for all stations in a certain time span"</span>
|
||||
<span class="na">query.delta_sta_net_mag</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT StationMagnitude.waveformID_networkCode AS Network, StationMagnitude.waveformID_stationCode AS Station, AVG(StationMagnitude.magnitude_value - Magnitude.magnitude_value) AS DeltaAvg, MIN(StationMagnitude.magnitude_value - Magnitude.magnitude_value) AS DeltaMin, MAX(StationMagnitude.magnitude_value - Magnitude.magnitude_value) AS DeltaMax, MIN(StationMagnitude.creationInfo_creationTime) AS Start, MAX(StationMagnitude.creationInfo_creationTime) AS End FROM StationMagnitude, PublicObject PStationMagnitude, StationMagnitudeContribution, Magnitude WHERE StationMagnitude._oid = PStationMagnitude._oidStationMagnitudeContribution.stationMagnitudeID = PStationMagnitude.publicIDStationMagnitudeContribution._parent_oid = Magnitude._oidStationMagnitude.creationInfo_creationTime >= '##startTime##'StationMagnitude.creationInfo_creationTime <= '##endTime##' GROUP BY StationMagnitude.waveformID_networkCode, StationMagnitude.waveformID_stationCode;"</span>
|
||||
|
||||
<span class="na">query.delta_sta_net_mag_type.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Calculates delta values of station and network magnitudes for all stations and all magnitude types in a certain time span"</span>
|
||||
<span class="na">query.delta_sta_net_mag_type</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT StationMagnitude.waveformID_networkCode AS Network, StationMagnitude.waveformID_stationCode AS Station, AVG(StationMagnitude.magnitude_value - Magnitude.magnitude_value) AS DeltaAvg, MIN(StationMagnitude.magnitude_value - Magnitude.magnitude_value) AS DeltaMin, MAX(StationMagnitude.magnitude_value - Magnitude.magnitude_value) AS DeltaMax, Magnitude.type AS NetMagType, MIN(StationMagnitude.creationInfo_creationTime) AS Start, MAX(StationMagnitude.creationInfo_creationTime) AS End FROM StationMagnitude, PublicObject PStationMagnitude, StationMagnitudeContribution, Magnitude WHERE StationMagnitude._oid = PStationMagnitude._oid AND StationMagnitudeContribution.stationMagnitudeID = PStationMagnitude.publicID AND StationMagnitudeContribution._parent_oid = Magnitude._oid AND StationMagnitude.creationInfo_creationTime >= '##startTime##' AND StationMagnitude.creationInfo_creationTime <= '##endTime##' GROUP BY StationMagnitude.waveformID_networkCode, StationMagnitude.waveformID_stationCode, Magnitude.type;"</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="postgresql">
|
||||
<span id="scquery-psql"></span><h3>PostgreSQL<a class="headerlink" href="#postgresql" title="Permalink to this heading">¶</a></h3>
|
||||
<p>In contrast to queries for objects in <a class="reference internal" href="#scquery-mariadb"><span class="std std-ref">MariaDB/MySQL</span></a> the
|
||||
string <code class="docutils literal notranslate"><span class="pre">m_</span></code> must be added to the value and publicID database columns as shown
|
||||
below for the query “eventFilter”.</p>
|
||||
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">queries</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">eventFilter</span>
|
||||
|
||||
<span class="na">query.eventFilter.description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Returns all events (lat, lon, mag, time) that fall into a certain region and a magnitude range"</span>
|
||||
<span class="na">query.eventFilter</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"SELECT PEvent.m_publicID, Origin.m_time_value AS OT, Origin.m_latitude_value, Origin.m_longitude_value, Origin.m_depth_value, Magnitude.m_magnitude_value, Magnitude.m_type FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.m_publicID = Event.m_preferredMagnitudeID AND POrigin.m_publicID = Event.m_preferredOriginID AND Origin.m_latitude_value >= ##latMin## AND Origin.m_latitude_value <= ##latMax## AND Origin.m_longitude_value >= ##lonMin## AND Origin.m_longitude_value <= ##lonMax## AND Magnitude.m_magnitude_value >= ##minMag## AND Magnitude.m_magnitude_value <= ##maxMag## AND Origin.m_time_value >= '##startTime##' AND Origin.m_time_value <= '##endTime##';"</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="module-configuration">
|
||||
<span id="scquery-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/scquery.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/scquery.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/scquery.cfg</span></code></div>
|
||||
</div>
|
||||
<p>scquery inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
|
||||
</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">scquery [OPTIONS] [query name] [query parameters]</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-scquery-h">
|
||||
<span id="cmdoption-scquery-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-scquery-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-scquery-V">
|
||||
<span id="cmdoption-scquery-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-scquery-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-scquery-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-scquery-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-scquery-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-scquery-plugins" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Load given plugins.</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-scquery-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-scquery-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-scquery-v">
|
||||
<span id="cmdoption-scquery-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-scquery-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-scquery-q">
|
||||
<span id="cmdoption-scquery-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-scquery-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-scquery-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-scquery-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-scquery-s">
|
||||
<span id="cmdoption-scquery-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-scquery-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-scquery-l">
|
||||
<span id="cmdoption-scquery-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-scquery-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-scquery-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-scquery-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-scquery-debug">
|
||||
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scquery-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-scquery-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-scquery-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-scquery-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-scquery-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-scquery-d">
|
||||
<span id="cmdoption-scquery-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-scquery-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>
|
||||
|
||||
</section>
|
||||
<section id="commands">
|
||||
<h3>Commands<a class="headerlink" href="#commands" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scquery-showqueries">
|
||||
<span class="sig-name descname"><span class="pre">--showqueries</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scquery-showqueries" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Show the queries defined in queries.cfg.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scquery-delimiter">
|
||||
<span class="sig-name descname"><span class="pre">--delimiter</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scquery-delimiter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Column delimiter. If found, this character will be escaped
|
||||
in output values. Default: ‘|’.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scquery-print-column-name">
|
||||
<span class="sig-name descname"><span class="pre">--print-column-name</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scquery-print-column-name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Print the name of each output column in a header.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scquery-print-header">
|
||||
<span class="sig-name descname"><span class="pre">--print-header</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scquery-print-header" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Print the query parameters and the query filter description
|
||||
as a header of the query output.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scquery-print-query-only">
|
||||
<span class="sig-name descname"><span class="pre">--print-query-only</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scquery-print-query-only" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Only print the full query to stdout and then quit.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scquery-Q">
|
||||
<span id="cmdoption-scquery-query"></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">--query</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scquery-Q" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Execute the given query instead of applying queries
|
||||
pre-defined by configuration.</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="#">scquery</a><ul>
|
||||
<li><a class="reference internal" href="#description">Description</a></li>
|
||||
<li><a class="reference internal" href="#module-setup">Module Setup</a></li>
|
||||
<li><a class="reference internal" href="#examples">Examples</a></li>
|
||||
<li><a class="reference internal" href="#queries">Queries</a><ul>
|
||||
<li><a class="reference internal" href="#mariadb-mysql">MariaDB/MySQL</a></li>
|
||||
<li><a class="reference internal" href="#postgresql">PostgreSQL</a></li>
|
||||
</ul>
|
||||
</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="#commands">Commands</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="scorgls.html"
|
||||
title="previous chapter">scorgls</a></p>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="scqueryqc.html"
|
||||
title="next chapter">scqueryqc</a></p>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/apps/scquery.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