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. 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 scdb.

An XSD schema of the XML output can be found under $SEISCOMP_ROOT/share/xml/.

Examples

Export inventory

scxmldump -fI -o inventory.xml -d mysql://sysop:sysop@localhost/seiscomp3

Export configuration

scxmldump -fC -o config.xml -d mysql://sysop:sysop@localhost/seiscomp3

Export full event data

scxmldump -fPAMF -E test2012abcd -o test2012abcd.xml \
          -d mysql://sysop:sysop@localhost/seiscomp3

Export summary event data

scxmldump -fap -E test2012abcd -o test2012abcd.xml \
          -d mysql://sysop:sysop@localhost/seiscomp3

Create bulletin

scxmldump -fPAMF -E test2012abcd
          -d mysql://sysop:sysop@localhost/seiscomp3 | \
scbulletin

Copy event

scxmldump -fPAMF -E test2012abcd \
          -d mysql://sysop:sysop@localhost/seiscomp3 | \
scdb -i - -d mysql://sysop:sysop@archive-db/seiscomp3

Configuration

etc/defaults/global.cfg

etc/defaults/scxmldump.cfg

etc/global.cfg

etc/scxmldump.cfg

~/.seiscomp3/global.cfg

~/.seiscomp3/scxmldump.cfg

scxmldump inherits global options.

Command-line

Generic

-h, --help

show help message.

-V, --version

show version information

--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.

--plugins arg

Load given plugins.

-D, --daemon

Run as daemon. This means the application will fork itself and doesn’t need to be started with &.

--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).

--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.

--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

--verbosity arg

Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info, 4:debug

-v, --v

Increase verbosity level (may be repeated, eg. -vv)

-q, --quiet

Quiet mode: no logging output

--component arg

Limits the logging to a certain component. This option can be given more than once.

-s, --syslog

Use syslog logging back end. The output usually goes to /var/lib/messages.

-l, --lockfile arg

Path to lock file.

--console arg

Send log output to stdout.

--debug

Debug mode: –verbosity=4 –console=1

--log-file arg

Use alternative log file.

Messaging

-u, --user arg

Overrides configuration parameter connection.username.

-H, --host arg

Overrides configuration parameter connection.server.

-t, --timeout arg

Overrides configuration parameter connection.timeout.

-g, --primary-group arg

Overrides configuration parameter connection.primaryGroup.

-S, --subscribe-group arg

A group to subscribe to. This option can be given more than once.

--encoding arg

Overrides configuration parameter connection.encoding.

--start-stop-msg arg

Sets sending of a start- and a stop message.

Database

--db-driver-list

List all supported database drivers.

-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”.

--config-module arg

The configmodule to use.

--inventory-db arg

Load the inventory from the given database or file, format: [service://]location

--config-db arg

Load the configuration from the given database or file, format: [service://]location

Dump

--listen

Enables server mode which listens to the message server for incoming events and dumps each received add/update.

-I, --inventory

Dump the inventory.

--without-station-groups

Removes all station groups from inventory.

--stations sta-list

If inventory is exported filter the stations to export where each item is in format net[.{sta|*}].

-C, --config

Dump the configuration database.

-R, --routing

Dump the routing database.

-Y, --availability

Dump data availability information.

--with-segments

Dump individual data segments.

-O, --origin id

Origin publicID(s) to dump. Multiple origins may be specified as a comma-separated list.

-E, --event id

Event publicID(s) to dump. Multiple events may be specified as a comma-separated list.

-P, --with-picks

Dump associated picks along with origins.

-A, --with-amplitudes

Dump associated amplitudes along with magnitudes.

-M, --with-magnitudes

Dump station magnitudes.

-F, --with-focal-mechanism

Dump focal mechanisms of events.

-a, --ignore-arrivals

Do not dump arrivals part of origins.

--ignore-magnitudes

Does not export (network) magnitudes of origins. This option is most useful in combination with -O to only export the location information.

-p, --preferred-only

When exporting events only the preferred origin, the preferred magnitude and the preferred focal mechanism will be dumped.

-m, --all-magnitudes

If only the preferred origin is exported, all magnitudes for this origin will be dumped.

-f, --formatted

Use formatted XML output.

--prepend-datasize

Prepend a line with the length of the XML data.

-o, --output

The output file. Default is stdout.