.. highlight:: rst .. _scxmldump: ######### scxmldump ######### **Dumps database objects to XML files.** Description =========== To get event information from the database without using SQL is an important task for the user. :ref:`scxmldump` queries the database and transforms that information into XML. The result can be converted into a bulletin with scbulletin or imported into another database with :ref:`scdb`. An XSD schema of the XML output can be found under :file:`$SEISCOMP_ROOT/share/xml/`. Examples -------- Export inventory .. code-block:: sh scxmldump -fI -o inventory.xml -d mysql://sysop:sysop@localhost/seiscomp3 Export configuration .. code-block:: sh scxmldump -fC -o config.xml -d mysql://sysop:sysop@localhost/seiscomp3 Export full event data .. code-block:: sh scxmldump -fPAMF -E test2012abcd -o test2012abcd.xml \ -d mysql://sysop:sysop@localhost/seiscomp3 Export summary event data .. code-block:: sh scxmldump -fap -E test2012abcd -o test2012abcd.xml \ -d mysql://sysop:sysop@localhost/seiscomp3 Create bulletin .. code-block:: sh scxmldump -fPAMF -E test2012abcd -d mysql://sysop:sysop@localhost/seiscomp3 | \ scbulletin Copy event .. code-block:: sh scxmldump -fPAMF -E test2012abcd \ -d mysql://sysop:sysop@localhost/seiscomp3 | \ scdb -i - -d mysql://sysop:sysop@archive-db/seiscomp3 .. _scxmldump_configuration: Configuration ============= | :file:`etc/defaults/global.cfg` | :file:`etc/defaults/scxmldump.cfg` | :file:`etc/global.cfg` | :file:`etc/scxmldump.cfg` | :file:`~/.seiscomp3/global.cfg` | :file:`~/.seiscomp3/scxmldump.cfg` scxmldump inherits :ref:`global options`. Command-line ============ .. program:: scxmldump Generic ------- .. option:: -h, --help show help message. .. option:: -V, --version show version information .. option:: --config-file arg 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, eg scautopick \-> scautopick2. .. option:: --plugins arg Load given plugins. .. option:: -D, --daemon Run as daemon. This means the application will fork itself and doesn't need to be started with \&. .. option:: --auto-shutdown arg Enable\/disable self\-shutdown because a master module shutdown. This only works when messaging is enabled and the master module sends a shutdown message \(enabled with \-\-start\-stop\-msg for the master module\). .. option:: --shutdown-master-module arg Sets the name of the master\-module used for auto\-shutdown. This is the application name of the module actually started. If symlinks are used then it is the name of the symlinked application. .. option:: --shutdown-master-username arg Sets the name of the master\-username of the messaging used for auto\-shutdown. If \"shutdown\-master\-module\" is given as well this parameter is ignored. Verbosity --------- .. option:: --verbosity arg Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info, 4:debug .. option:: -v, --v Increase verbosity level \(may be repeated, eg. \-vv\) .. option:: -q, --quiet Quiet mode: no logging output .. option:: --component arg Limits the logging to a certain component. This option can be given more than once. .. option:: -s, --syslog Use syslog logging back end. The output usually goes to \/var\/lib\/messages. .. option:: -l, --lockfile arg Path to lock file. .. option:: --console arg Send log output to stdout. .. option:: --debug Debug mode: \-\-verbosity\=4 \-\-console\=1 .. option:: --log-file arg Use alternative log file. Messaging --------- .. option:: -u, --user arg 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. This option can be given more than once. .. option:: --encoding arg Overrides configuration parameter :confval:`connection.encoding`. .. option:: --start-stop-msg arg Sets sending of a start\- and a stop message. Database -------- .. option:: --db-driver-list List all supported database drivers. .. option:: -d, --database arg The database connection string, format: service:\/\/user:pwd\@host\/database. \"service\" is the name of the database driver which can be queried with \"\-\-db\-driver\-list\". .. option:: --config-module arg The configmodule to use. .. option:: --inventory-db arg Load the inventory from the given database or file, format: [service:\/\/]location .. option:: --config-db arg Load the configuration from the given database or file, format: [service:\/\/]location Dump ---- .. option:: --listen Enables server mode which listens to the message server for incoming events and dumps each received add\/update. .. option:: -I, --inventory Dump the inventory. .. option:: --without-station-groups Removes all station groups from inventory. .. option:: --stations sta-list If inventory is exported filter the stations to export where each item is in format net[.{sta\|\*}]. .. option:: -C, --config Dump the configuration database. .. option:: -R, --routing Dump the routing database. .. option:: -Y, --availability Dump data availability information. .. option:: --with-segments Dump individual data segments. .. option:: -O, --origin id Origin publicID\(s\) to dump. Multiple origins may be specified as a comma\-separated list. .. option:: -E, --event id Event publicID\(s\) to dump. Multiple events may be specified as a comma\-separated list. .. option:: -P, --with-picks Dump associated picks along with origins. .. option:: -A, --with-amplitudes Dump associated amplitudes along with magnitudes. .. option:: -M, --with-magnitudes Dump station magnitudes. .. option:: -F, --with-focal-mechanism Dump focal mechanisms of events. .. option:: -a, --ignore-arrivals Do not dump arrivals part of origins. .. option:: --ignore-magnitudes Does not export \(network\) magnitudes of origins. This option is most useful in combination with \-O to only export the location information. .. option:: -p, --preferred-only When exporting 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 this origin will be dumped. .. option:: -f, --formatted Use formatted XML output. .. option:: --prepend-datasize Prepend a line with the length of the XML data. .. option:: -o, --output The output file. Default is stdout.