149 lines
		
	
	
		
			5.3 KiB
		
	
	
	
		
			XML
		
	
	
	
	
	
			
		
		
	
	
			149 lines
		
	
	
		
			5.3 KiB
		
	
	
	
		
			XML
		
	
	
	
	
	
<?xml version="1.0" encoding="UTF-8"?>
 | 
						|
<seiscomp>
 | 
						|
	<module name="scdbstrip" category="Utilities">
 | 
						|
		<description>Clean up a database from event and waveform quality parameters.</description>
 | 
						|
		<configuration>
 | 
						|
			<group name="database">
 | 
						|
				<group name="cleanup">
 | 
						|
					<parameter name="invertMode" type="boolean" default="false">
 | 
						|
						<description>
 | 
						|
						Invert the selection of the specified time period, that is
 | 
						|
						delete all parameters after the specified time period,
 | 
						|
						not before. When a date range is specified, then delete all
 | 
						|
						parameters before and after the time range, not in between.
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
					<parameter name="eventParameters" type="boolean" default="true">
 | 
						|
						<description>
 | 
						|
						Strip all event parameters including events, origins,
 | 
						|
						magnitudes, amplitudes, arrivals, picks, focal mechanisms.
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
					<parameter name="qualityControl" type="boolean" default="true">
 | 
						|
						<description>
 | 
						|
						Strip waveform quality control (QC) parameters.
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
					<group name="keep">
 | 
						|
					<description>
 | 
						|
					Parameters controlling the time to keep objects in the database.
 | 
						|
					The time comparison considers the object time, not the time of
 | 
						|
					their creation.
 | 
						|
					</description>
 | 
						|
						<parameter name="days" type="int" default="30">
 | 
						|
							<description>
 | 
						|
							The number of days to preserve in the database. This
 | 
						|
							value is added to the whole timespan. Hours
 | 
						|
							and minutes are configured separately.
 | 
						|
							</description>
 | 
						|
						</parameter>
 | 
						|
						<parameter name="hours" type="int" default="0">
 | 
						|
							<description>
 | 
						|
							The number of hours to preserve in the database. This
 | 
						|
							value is added to the whole timespan. Days
 | 
						|
							and minutes are configured separately.
 | 
						|
							</description>
 | 
						|
						</parameter>
 | 
						|
						<parameter name="minutes" type="int" default="0">
 | 
						|
							<description>
 | 
						|
							The number of minutes to preserve in the database. This
 | 
						|
							value is added to the whole timespan. Days
 | 
						|
							and hours are configured separately.
 | 
						|
							</description>
 | 
						|
						</parameter>
 | 
						|
					</group>
 | 
						|
				</group>
 | 
						|
			</group>
 | 
						|
		</configuration>
 | 
						|
		<command-line>
 | 
						|
		<synopsis>
 | 
						|
		scdbstrip [options]
 | 
						|
		</synopsis>
 | 
						|
			<group name="Generic">
 | 
						|
				<optionReference>generic#help</optionReference>
 | 
						|
				<optionReference>generic#version</optionReference>
 | 
						|
				<optionReference>generic#config-file</optionReference>
 | 
						|
				<optionReference>generic#plugins</optionReference>
 | 
						|
				<option long-flag="first-new" param-ref="firstNew"/>
 | 
						|
			</group>
 | 
						|
 | 
						|
			<group name="Verbosity">
 | 
						|
				<optionReference>verbosity#verbosity</optionReference>
 | 
						|
				<optionReference>verbosity#v</optionReference>
 | 
						|
				<optionReference>verbosity#quiet</optionReference>
 | 
						|
				<optionReference>verbosity#component</optionReference>
 | 
						|
				<optionReference>verbosity#syslog</optionReference>
 | 
						|
				<optionReference>verbosity#lockfile</optionReference>
 | 
						|
				<optionReference>verbosity#console</optionReference>
 | 
						|
				<optionReference>verbosity#debug</optionReference>
 | 
						|
				<optionReference>verbosity#log-file</optionReference>
 | 
						|
			</group>
 | 
						|
 | 
						|
			<group name="Database">
 | 
						|
				<optionReference>database#db-driver-list</optionReference>
 | 
						|
				<optionReference>database#database</optionReference>
 | 
						|
				<optionReference>database#config-module</optionReference>
 | 
						|
				<optionReference>database#inventory-db</optionReference>
 | 
						|
				<optionReference>database#db-disable</optionReference>
 | 
						|
			</group>
 | 
						|
 | 
						|
			<group name="Mode">
 | 
						|
				<option long-flag="check">
 | 
						|
					<description>
 | 
						|
					Checks if unreachable objects exist.
 | 
						|
					</description>
 | 
						|
				</option>
 | 
						|
				<option long-flag="clean-unused">
 | 
						|
					<description>
 | 
						|
					Remove all unreachable objects when in checkmode. Default:
 | 
						|
					off.
 | 
						|
					</description>
 | 
						|
				</option>
 | 
						|
			</group>
 | 
						|
 | 
						|
			<group name="Objects">
 | 
						|
				<option long-flag="ep-only" flag="E">
 | 
						|
					<description>
 | 
						|
					Strip only event parameters. Other parameters, like QC, are
 | 
						|
					are ignored.
 | 
						|
					</description>
 | 
						|
				</option>
 | 
						|
				<option long-flag="qc-only" flag="Q">
 | 
						|
					<description>
 | 
						|
					Strip only waveform quality control (QC) parameters. Other
 | 
						|
					parameters, like event parameters, are are ignored.
 | 
						|
					Overrides 'eq-only'.
 | 
						|
					</description>
 | 
						|
				</option>
 | 
						|
			</group>
 | 
						|
 | 
						|
			<group name="Timespan">
 | 
						|
				<option long-flag="days" argument="arg" param-ref="database.cleanup.keep.days"/>
 | 
						|
				<option long-flag="hours" argument="arg" param-ref="database.cleanup.keep.hours"/>
 | 
						|
				<option long-flag="minutes" argument="arg" param-ref="database.cleanup.keep.minutes"/>
 | 
						|
				<option long-flag="datetime" argument="arg">
 | 
						|
					<description>
 | 
						|
					Replaces the days:hours:minutes timespan definition by an
 | 
						|
					arbitrary absolute timestamp in UTC. Format:
 | 
						|
					%Y-%m-%dT%H:%M:%S.
 | 
						|
					</description>
 | 
						|
				</option>
 | 
						|
				<option flag="t" long-flag="time-window" argument="arg">
 | 
						|
					<description>
 | 
						|
					Delete objects in the specified time window.
 | 
						|
					Replaces the days:hours:minutes timespan definition by an
 | 
						|
					arbitrary absolute time range in UTC. Format:
 | 
						|
					startTime~endTime that is %Y-%m-%dT%H:%M:%S~%Y-%m-%dT%H:%M:%S
 | 
						|
					</description>
 | 
						|
				</option>
 | 
						|
				<option long-flag="invert" flag="i" param-ref="database.cleanup.invertMode"/>
 | 
						|
				<option long-flag="keep-events">
 | 
						|
					<description>
 | 
						|
					IDs of events to keep in the database separated with comma.
 | 
						|
					</description>
 | 
						|
				</option>
 | 
						|
			</group>
 | 
						|
		</command-line>
 | 
						|
	</module>
 | 
						|
</seiscomp>
 |