SCRUG-NA/2025
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[installation] Change to nightly

Browse Source
This commit is contained in:
Dirk Rössler
2025-10-30 12:04:59 +01:00
parent 2ff097f9d1
commit a31bc45cce
1441 changed files with 60368 additions and 56360 deletions
Download Patch File Download Diff File Expand all files Collapse all files

224
share/man/man1/scxmldump.1
View File

@ -27,16 +27,21 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SCXMLDUMP" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
.TH "SCXMLDUMP" "1" "Oct 29, 2025" "7.0.0" "SeisComP"
.SH NAME
scxmldump \- SeisComP Documentation
.sp
\fBDump database objects to XML files.\fP
\fBDump objects from database or messaging to XML.\fP
.SH DESCRIPTION
.sp
scxmldump reads various parameters from a SeisComP database:
scxmldump reads SeisComP objects from database or messaging and writes them
in SeisComP XML (\fI\%SCML\fP) to stdout or into a file (\fB\-o\fP).
.INDENT 0.0
.IP \(bu 2
Dumping from a SeisComP database supports various
\fI\%objects\fP:
.INDENT 2.0
.IP \(bu 2
Availability,
.IP \(bu 2
Config (bindings parameters),
@ -49,8 +54,10 @@ Journal,
.IP \(bu 2
Routing.
.UNINDENT
.sp
The parameters are sent to stdout or written into an XML (\fI\%SCML\fP) file.
.IP \(bu 2
Dumping from a SeisComP messaging (\fB\-\-listen\fP) considers only event
parameters.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
@ -59,13 +66,18 @@ Waveform quality control (QC) parameters can be read from databases using
scqcquery\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
Furthermore any object carrying a publicID can be retrieved from the database
including its hierarchie or not. See \fI\%PublicObjects\fP\&.
.UNINDENT
.SS Event parameters
.sp
To get event, origin or pick information from the database without using SQL
commands is an important task for the user. \fI\%scxmldump\fP queries the
database and transforms that information into XML. Events and origins can be
treated further by \fI\%scbulletin\fP for generating bulletins or conversion
into KML.
into other formats including KML.
.sp
Many processing modules, e.g., \fI\%scevent\fP support the on\-demand processing
of dumped event parameters by the command\-line option \fB\-\-ep\fP\&.
@ -81,103 +93,171 @@ respectively. Event, origin and pick IDs can also be read from graphical
tools like \fI\%scolv\fP or used database queries assisted by \fI\%scquery\fP\&.
.UNINDENT
.UNINDENT
.SS PublicObjects
.sp
The option \fB\-\-public\-id\fP 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.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
scxmldump \-d localhost \-\-plugins dbmysql,dmsm \-\-public\-id StrongMotionOrigin/123456
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This command would only export the StrongMotionOrigin itself without all
child objects. Option \fB\-\-with\-childs\fP must be passed to export the
full hierarchy:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
scxmldump \-d localhost \-\-plugins dbmysql,dmsm \-\-public\-id StrongMotionOrigin/123456 \-\-with\-childs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the extension code resides in a library then LD_PRELOAD can be used to inject
the code into scxmldump:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
LD_PRELOAD=/home/sysop/seiscomp/lib/libseiscomp_datamodel_sm.so scxmldump \-d localhost \-\-public\-id StrongMotionOrigin/123456 \-\-with\-childs
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Format conversion
.sp
Conversion of \fI\%SCML\fP into other formats is supported by \fI\%sccnv\fP\&.
An XSD schema of the XML output can be found under
\fB$SEISCOMP_ROOT/share/xml/\fP\&.
.SS Examples
.sp
.INDENT 0.0
.IP \(bu 2
Dump inventory
.INDENT 0.0
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
scxmldump \-fI \-o inventory.xml \-d mysql://sysop:sysop@localhost/seiscomp
scxmldump \-d mysql://sysop:sysop@localhost/seiscomp \-fI \-o inventory.xml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
.IP \(bu 2
Dump config (bindings parameters)
.INDENT 0.0
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
scxmldump \-fC \-o config.xml \-d mysql://sysop:sysop@localhost/seiscomp
scxmldump \-d localhost \-fC \-o config.xml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Dump full event data incl. the relevant journal entries
.INDENT 0.0
.IP \(bu 2
Dump full event data including the relevant journal entries
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
scxmldump \-fPAMFJ \-E test2012abcd \-o test2012abcd.xml \e
\-d mysql://sysop:sysop@localhost/seiscomp
scxmldump \-d localhost \-fPAMFJ \-E test2012abcd \-o test2012abcd.xml
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
Dump full event data. Event IDs are provided by \fI\%scevtls\fP and received
from stdin
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
scevtls \-d localhost \-\-begin 2025\-01\-01 |\e
scxmldump \-d localhost \-fPAMF \-E \- \-o events.xml
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
Dump summary event data
.INDENT 0.0
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
scxmldump \-fap \-E test2012abcd \-o test2012abcd.xml \e
\-d mysql://sysop:sysop@localhost/seiscomp
scxmldump \-d localhost \-fap \-E test2012abcd \-o test2012abcd.xml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Create bulletin from an event
.INDENT 0.0
.IP \(bu 2
Create bulletin from an event using \fI\%scbulletin\fP
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
scxmldump \-fPAMF \-E test2012abcd
\-d mysql://sysop:sysop@localhost/seiscomp | \e
scbulletin
scxmldump \-d localhost \-fPAMF \-E test2012abcd | scbulletin
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
.IP \(bu 2
Copy event parameters to another database
.INDENT 0.0
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
scxmldump \-fPAMF \-E test2012abcd \e
\-d mysql://sysop:sysop@localhost/seiscomp | \e
scxmldump \-d localhost \-fPAMF \-E test2012abcd |\e
scdb \-i \- \-d mysql://sysop:sysop@archive\-db/seiscomp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Export the entire journal:
.INDENT 0.0
.IP \(bu 2
Dump the entire journal:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
scxmldump \-fJ \-o journal.xml \e
\-d mysql://sysop:sysop@localhost/seiscomp
scxmldump \-d localhost \-fJ \-o journal.xml
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
Dump events received from messaging on local computer:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
scxmldump \-H localhost/production \-\-listen
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SH MODULE CONFIGURATION
.nf
\fBetc/defaults/global.cfg\fP
@ -329,10 +409,14 @@ This option can be given more than once.
.TP
.B \-\-content\-type arg
Overrides configuration parameter \fI\%connection.contentType\fP\&.
.sp
Default: \fBbinary\fP
.UNINDENT
.INDENT 0.0
.TP
.B \-\-start\-stop\-msg arg
Default: \fB0\fP
.sp
Set sending of a start and a stop message.
.UNINDENT
.SS Database
@ -369,12 +453,6 @@ format: [\fI\%service://]location\fP .
.SS Dump
.INDENT 0.0
.TP
.B \-\-listen
Enable server mode which listens to the message server for
incoming events and dumps each received add/update.
.UNINDENT
.INDENT 0.0
.TP
.B \-I, \-\-inventory
Dump the inventory.
.UNINDENT
@ -386,7 +464,7 @@ Remove all station groups from inventory.
.INDENT 0.0
.TP
.B \-\-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|*}].
.UNINDENT
.INDENT 0.0
@ -413,25 +491,28 @@ Dump data availability information.
.INDENT 0.0
.TP
.B \-\-with\-segments
Dump individual data segments.
Dump individual data segments. Requires
\(dq\-\-availability\(dq.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-pick ID
Pick public ID(s) to dump. Multiple IDs may be specified
as a comma\-separated list.
.UNINDENT
.INDENT 0.0
.TP
.B \-O, \-\-origin ID
Origin public ID(s) to dump. Multiple origins may be specified
as a comma\-separated list.
.B \-\-listen
Listen to the message server for incoming events. Otherwise
scxmldump reads from database.
.UNINDENT
.INDENT 0.0
.TP
.B \-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 \(dq\-\(dq for reading the IDs as
individual lines from stdin.
.UNINDENT
.INDENT 0.0
.TP
.B \-O, \-\-origin ID
Origin public ID(s) to dump. Multiple origins may be specified
as a comma\-separated list. Use \(dq\-\(dq for reading the IDs as
individual lines from stdin
.UNINDENT
.INDENT 0.0
.TP
@ -456,27 +537,54 @@ Add focal mechanisms associated to events.
.INDENT 0.0
.TP
.B \-a, \-\-ignore\-arrivals
Do not dump arrivals part of origins.
Do not dump arrivals of origins.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-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.
.UNINDENT
.INDENT 0.0
.TP
.B \-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.
.UNINDENT
.INDENT 0.0
.TP
.B \-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.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-pick ID
ID(s) of pick(s) to dump. Use \(aq\-\(aq to read the IDs as
individual lines from stdin.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-public\-id ID
ID(s) of any object(s) to dump. Use \(aq\-\(aq to read the IDs as
individual lines from stdin. No parent objects are dumped.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-with\-childs
Dump also all child objects of dumped objects. Valid only in
combination with \-\-public\-id.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-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.
.UNINDENT
.SS Output
.INDENT 0.0
.TP