[installation] Change to nightly
This commit is contained in:
@ -6,28 +6,36 @@
|
||||
scxmldump
|
||||
#########
|
||||
|
||||
**Dump database objects to XML files.**
|
||||
**Dump objects from database or messaging to XML.**
|
||||
|
||||
|
||||
Description
|
||||
===========
|
||||
|
||||
scxmldump reads various parameters from a SeisComP database:
|
||||
scxmldump reads SeisComP objects from database or messaging and writes them
|
||||
in SeisComP XML (:term:`SCML`) to stdout or into a file (:option:`-o`).
|
||||
|
||||
* Availability,
|
||||
* Config (bindings parameters),
|
||||
* Event parameters,
|
||||
* Inventory,
|
||||
* Journal,
|
||||
* Routing.
|
||||
* Dumping from a SeisComP database supports various
|
||||
:ref:`objects <api-datamodel-python>`:
|
||||
|
||||
The parameters are sent to stdout or written into an XML (:term:`SCML`) file.
|
||||
* Availability,
|
||||
* Config (bindings parameters),
|
||||
* Event parameters,
|
||||
* Inventory,
|
||||
* Journal,
|
||||
* Routing.
|
||||
|
||||
* Dumping from a SeisComP messaging (:option:`--listen`) considers only event
|
||||
parameters.
|
||||
|
||||
.. note::
|
||||
|
||||
Waveform quality control (QC) parameters can be read from databases using
|
||||
:ref:`scqcquery`.
|
||||
|
||||
* Furthermore any object carrying a publicID can be retrieved from the database
|
||||
including its hierarchie or not. See :ref:`scxmldump-public-objects`.
|
||||
|
||||
|
||||
Event parameters
|
||||
----------------
|
||||
@ -36,7 +44,7 @@ To get event, origin or pick information from the database without using SQL
|
||||
commands is an important task for the user. :ref:`scxmldump` queries the
|
||||
database and transforms that information into XML. Events and origins can be
|
||||
treated further by :ref:`scbulletin` for generating bulletins or conversion
|
||||
into KML.
|
||||
into other formats including KML.
|
||||
|
||||
Many processing modules, e.g., :ref:`scevent` support the on-demand processing
|
||||
of dumped event parameters by the command-line option :option:`--ep`.
|
||||
@ -51,6 +59,39 @@ and sending to a SeisComP messaging is provided by :ref:`scdispatch`.
|
||||
tools like :ref:`scolv` or used database queries assisted by :ref:`scquery`.
|
||||
|
||||
|
||||
.. _scxmldump-public-objects:
|
||||
PublicObjects
|
||||
-------------
|
||||
|
||||
The option :option:`--public-id` defines a list of publicIDs to be retrieved
|
||||
from the database. As the data model is extendable via plugins and custom code,
|
||||
scxmldump cannot know all of those object types and how to retrieve them
|
||||
from the database. If a publicID belongs to a type for which the code resides
|
||||
in another library or plugin, then scxmldump must load this plugin or library
|
||||
in order to find the correct database tables. For example, if a strong motion
|
||||
object should be dumped, then the plugin dmsm must be loaded into scxmldump.
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
scxmldump -d localhost --plugins dbmysql,dmsm --public-id StrongMotionOrigin/123456
|
||||
|
||||
This command would only export the StrongMotionOrigin itself without all
|
||||
child objects. Option :option:`--with-childs` must be passed to export the
|
||||
full hierarchy:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
scxmldump -d localhost --plugins dbmysql,dmsm --public-id StrongMotionOrigin/123456 --with-childs
|
||||
|
||||
|
||||
If the extension code resides in a library then LD_PRELOAD can be used to inject
|
||||
the code into scxmldump:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
LD_PRELOAD=/home/sysop/seiscomp/lib/libseiscomp_datamodel_sm.so scxmldump -d localhost --public-id StrongMotionOrigin/123456 --with-childs
|
||||
|
||||
|
||||
Format conversion
|
||||
-----------------
|
||||
|
||||
@ -62,58 +103,62 @@ An XSD schema of the XML output can be found under
|
||||
Examples
|
||||
--------
|
||||
|
||||
Dump inventory
|
||||
* Dump inventory
|
||||
|
||||
.. code-block:: sh
|
||||
.. code-block:: sh
|
||||
|
||||
scxmldump -fI -o inventory.xml -d mysql://sysop:sysop@localhost/seiscomp
|
||||
scxmldump -d mysql://sysop:sysop@localhost/seiscomp -fI -o inventory.xml
|
||||
|
||||
Dump config (bindings parameters)
|
||||
* Dump config (bindings parameters)
|
||||
|
||||
.. code-block:: sh
|
||||
.. code-block:: sh
|
||||
|
||||
scxmldump -fC -o config.xml -d mysql://sysop:sysop@localhost/seiscomp
|
||||
scxmldump -d localhost -fC -o config.xml
|
||||
|
||||
Dump full event data incl. the relevant journal entries
|
||||
* Dump full event data including the relevant journal entries
|
||||
|
||||
.. code-block:: sh
|
||||
.. code-block:: sh
|
||||
|
||||
scxmldump -fPAMFJ -E test2012abcd -o test2012abcd.xml \
|
||||
-d mysql://sysop:sysop@localhost/seiscomp
|
||||
scxmldump -d localhost -fPAMFJ -E test2012abcd -o test2012abcd.xml
|
||||
|
||||
* Dump full event data. Event IDs are provided by :ref:`scevtls` and received
|
||||
from stdin
|
||||
|
||||
Dump summary event data
|
||||
.. code-block:: sh
|
||||
|
||||
.. code-block:: sh
|
||||
scevtls -d localhost --begin 2025-01-01 |\
|
||||
scxmldump -d localhost -fPAMF -E - -o events.xml
|
||||
|
||||
scxmldump -fap -E test2012abcd -o test2012abcd.xml \
|
||||
-d mysql://sysop:sysop@localhost/seiscomp
|
||||
* Dump summary event data
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
Create bulletin from an event
|
||||
scxmldump -d localhost -fap -E test2012abcd -o test2012abcd.xml
|
||||
|
||||
.. code-block:: sh
|
||||
* Create bulletin from an event using :ref:`scbulletin`
|
||||
|
||||
scxmldump -fPAMF -E test2012abcd
|
||||
-d mysql://sysop:sysop@localhost/seiscomp | \
|
||||
scbulletin
|
||||
.. code-block:: sh
|
||||
|
||||
scxmldump -d localhost -fPAMF -E test2012abcd | scbulletin
|
||||
|
||||
Copy event parameters to another database
|
||||
* Copy event parameters to another database
|
||||
|
||||
.. code-block:: sh
|
||||
.. code-block:: sh
|
||||
|
||||
scxmldump -fPAMF -E test2012abcd \
|
||||
-d mysql://sysop:sysop@localhost/seiscomp | \
|
||||
scdb -i - -d mysql://sysop:sysop@archive-db/seiscomp
|
||||
scxmldump -d localhost -fPAMF -E test2012abcd |\
|
||||
scdb -i - -d mysql://sysop:sysop@archive-db/seiscomp
|
||||
|
||||
* Dump the entire journal:
|
||||
|
||||
Export the entire journal:
|
||||
.. code-block:: sh
|
||||
|
||||
.. code-block:: sh
|
||||
scxmldump -d localhost -fJ -o journal.xml
|
||||
|
||||
scxmldump -fJ -o journal.xml \
|
||||
-d mysql://sysop:sysop@localhost/seiscomp
|
||||
* Dump events received from messaging on local computer:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
scxmldump -H localhost/production --listen
|
||||
|
||||
|
||||
.. _scxmldump_configuration:
|
||||
@ -242,18 +287,22 @@ Messaging
|
||||
|
||||
Overrides configuration parameter :confval:`connection.username`.
|
||||
|
||||
|
||||
.. option:: -H, --host arg
|
||||
|
||||
Overrides configuration parameter :confval:`connection.server`.
|
||||
|
||||
|
||||
.. option:: -t, --timeout arg
|
||||
|
||||
Overrides configuration parameter :confval:`connection.timeout`.
|
||||
|
||||
|
||||
.. option:: -g, --primary-group arg
|
||||
|
||||
Overrides configuration parameter :confval:`connection.primaryGroup`.
|
||||
|
||||
|
||||
.. option:: -S, --subscribe-group arg
|
||||
|
||||
A group to subscribe to.
|
||||
@ -263,8 +312,13 @@ Messaging
|
||||
|
||||
Overrides configuration parameter :confval:`connection.contentType`.
|
||||
|
||||
Default: ``binary``
|
||||
|
||||
|
||||
.. option:: --start-stop-msg arg
|
||||
|
||||
Default: ``0``
|
||||
|
||||
Set sending of a start and a stop message.
|
||||
|
||||
|
||||
@ -300,11 +354,6 @@ Database
|
||||
Dump
|
||||
----
|
||||
|
||||
.. option:: --listen
|
||||
|
||||
Enable server mode which listens to the message server for
|
||||
incoming events and dumps each received add\/update.
|
||||
|
||||
.. option:: -I, --inventory
|
||||
|
||||
Dump the inventory.
|
||||
@ -315,7 +364,7 @@ Dump
|
||||
|
||||
.. option:: --stations sta-list
|
||||
|
||||
If inventory is exported, filter the stations to export.
|
||||
If inventory is dumped, filter the stations to dump.
|
||||
Wildcards are supported. Format of each item: net[.{sta\|\*}].
|
||||
|
||||
.. option:: -C, --config
|
||||
@ -337,22 +386,25 @@ Dump
|
||||
|
||||
.. option:: --with-segments
|
||||
|
||||
Dump individual data segments.
|
||||
Dump individual data segments. Requires
|
||||
\"\-\-availability\".
|
||||
|
||||
.. option:: --pick ID
|
||||
.. option:: --listen
|
||||
|
||||
Pick public ID\(s\) to dump. Multiple IDs may be specified
|
||||
as a comma\-separated list.
|
||||
|
||||
.. option:: -O, --origin ID
|
||||
|
||||
Origin public ID\(s\) to dump. Multiple origins may be specified
|
||||
as a comma\-separated list.
|
||||
Listen to the message server for incoming events. Otherwise
|
||||
scxmldump reads from database.
|
||||
|
||||
.. option:: -E, --event ID
|
||||
|
||||
Event public ID\(s\) to dump. Multiple events may be specified
|
||||
as a comma\-separated list.
|
||||
as a comma\-separated list. Use \"\-\" for reading the IDs as
|
||||
individual lines from stdin.
|
||||
|
||||
.. option:: -O, --origin ID
|
||||
|
||||
Origin public ID\(s\) to dump. Multiple origins may be specified
|
||||
as a comma\-separated list. Use \"\-\" for reading the IDs as
|
||||
individual lines from stdin
|
||||
|
||||
.. option:: -P, --with-picks
|
||||
|
||||
@ -372,24 +424,47 @@ Dump
|
||||
|
||||
.. option:: -a, --ignore-arrivals
|
||||
|
||||
Do not dump arrivals part of origins.
|
||||
Do not dump arrivals of origins.
|
||||
|
||||
.. option:: --ignore-magnitudes
|
||||
|
||||
Do not export \(network\) magnitudes of origins. This
|
||||
Do not dump \(network\) magnitudes of origins. This
|
||||
option is most useful in combination with \-O to only
|
||||
export the location information.
|
||||
dump the location information.
|
||||
|
||||
.. option:: -p, --preferred-only
|
||||
|
||||
When exporting events only the preferred origin, the preferred
|
||||
When dumping events only the preferred origin, the preferred
|
||||
magnitude and the preferred focal mechanism will be dumped.
|
||||
|
||||
.. option:: -m, --all-magnitudes
|
||||
|
||||
If only the preferred origin is exported, all magnitudes for
|
||||
If only the preferred origin is dumped, all magnitudes for
|
||||
this origin will be dumped.
|
||||
|
||||
.. option:: --pick ID
|
||||
|
||||
ID\(s\) of pick\(s\) to dump. Use '\-' to read the IDs as
|
||||
individual lines from stdin.
|
||||
|
||||
.. option:: --public-id ID
|
||||
|
||||
ID\(s\) of any object\(s\) to dump. Use '\-' to read the IDs as
|
||||
individual lines from stdin. No parent objects are dumped.
|
||||
|
||||
.. option:: --with-childs
|
||||
|
||||
Dump also all child objects of dumped objects. Valid only in
|
||||
combination with \-\-public\-id.
|
||||
|
||||
.. option:: --with-root
|
||||
|
||||
Whether to add the container of exported PublicObjects or
|
||||
not. Objects which are not a direct child of
|
||||
EventParameters, Inventory and so on, also referred to as
|
||||
top\-level objects, will not be exported.
|
||||
Valid in combination with \-\-public\-id.
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
Reference in New Issue
Block a user