File: TOPP_DBExporter.html

package info (click to toggle)
openms 1.11.1-5
links: PTS, VCS
area: main
in suites: jessie, jessie-kfreebsd
size: 436,688 kB
ctags: 150,907
sloc: cpp: 387,126; xml: 71,547; python: 7,764; ansic: 2,626; php: 2,499; sql: 737; ruby: 342; sh: 325; makefile: 128
file content (87 lines) | stat: -rw-r--r-- 8,050 bytes
<HTML>
<HEAD>
<TITLE>DBExporter</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<A href="index.html">Home</A> &nbsp;&middot;
<A href="classes.html">Classes</A> &nbsp;&middot;
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
<A href="modules.html">Modules</A> &nbsp;&middot;
<A href="functions_func.html">Members</A> &nbsp;&middot;
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
<A href="pages.html">Related Pages</A>
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<!-- Generated by Doxygen 1.8.5 -->
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">DBExporter </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Extracts MS data from a OpenMS database.</p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000005">Deprecated:</a></b></dt><dd>Deprecated in <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> 1.9</dd></dl>
<p>[Tool is no longer supported and will be removed in <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> 2.0]</p>
<p>Extracts arbitrary MS data (MS, LC-MS, MS/MS) from a OpenMS database. A single dataset can be exported by giving one id contained in the 'MSExperiment' table. A query that returns several ids of the 'MSExperiment' table can be used to export several datasets at a time.</p>
<p>If only one dataset is exported, it is stored with the given name. If several datasets are exported, the given name is prefixed with the DB id and an underscore.</p>
<p>In order to create a new OpenMS database, use the <a class="el" href="TOPP_DBImporter.html">DBImporter</a>.</p>
<p><b>The command line parameters of this tool are:</b> </p>
<pre class="fragment">
DBExporter -- Exports data from an OpenMS database to a file.
Version: 1.11.1 Nov 14 2013, 11:18:15, Revision: 11976

Usage:
  DBExporter &lt;options&gt;

Options (mandatory options marked with '*'):
  -user &lt;user&gt;*          User/login of the DB
  -host &lt;host&gt;           Host name of the DB server (default: 'localhost')
  -password &lt;password&gt;*  Password for the user
  -port &lt;port&gt;           Port the DB server is running on (default: '3306')
  -db &lt;name&gt;*            DB name
  -id &lt;DB id&gt;            Id of the the map to export (default: '0')
  -query &lt;query&gt;         A SQL query that returns one or several DB ids of the MSExperiment table
  -out &lt;file&gt;*           Output file in mzML format (prefixed with DB id and '_' if several files are exporte
                         d)
                         
Common TOPP options:
  -ini &lt;file&gt;            Use the given TOPP INI file
  -threads &lt;n&gt;           Sets the number of threads allowed to be used by the TOPP tool (default: '1')
  -write_ini &lt;file&gt;      Writes the default configuration file
  --help                 Shows options
  --helphelp             Shows all options (including advanced)

</pre><p> <b>INI file documentation of this tool:</b> <div class="ini_global">
<div class="legend">
<b>Legend:</b><br>
 <div class="item item_required">required parameter</div>
 <div class="item item_advanced">advanced parameter</div>
</div>
  <div class="node"><span class="node_name">+DBExporter</span><span class="node_description">Exports data from an OpenMS database to a file.</span></div>
    <div class="item item_advanced"><span class="item_name" style="padding-left:16px;">version</span><span class="item_value">1.11.1</span>
<span class="item_description">Version of the tool that generated this parameters file.</span><span class="item_tags"></span><span class="item_restrictions"> </span></div>    <div class="node"><span class="node_name">++1</span><span class="node_description">Instance '1' section for 'DBExporter'</span></div>
      <div class="item"><span class="item_name item_required" style="padding-left:24px;">user</span><span class="item_value"></span>
<span class="item_description">user/login of the DB</span><span class="item_tags"></span><span class="item_restrictions"> </span></div>      <div class="item"><span class="item_name" style="padding-left:24px;">host</span><span class="item_value">localhost</span>
<span class="item_description">host name of the DB server</span><span class="item_tags"></span><span class="item_restrictions"> </span></div>      <div class="item"><span class="item_name item_required" style="padding-left:24px;">password</span><span class="item_value"></span>
<span class="item_description">password for the user</span><span class="item_tags"></span><span class="item_restrictions"> </span></div>      <div class="item"><span class="item_name" style="padding-left:24px;">port</span><span class="item_value">3306</span>
<span class="item_description">port the DB server is running on</span><span class="item_tags"></span><span class="item_restrictions"> </span></div>      <div class="item"><span class="item_name item_required" style="padding-left:24px;">db</span><span class="item_value"></span>
<span class="item_description">DB name</span><span class="item_tags"></span><span class="item_restrictions"> </span></div>      <div class="item"><span class="item_name" style="padding-left:24px;">id</span><span class="item_value">0</span>
<span class="item_description">id of the the map to export</span><span class="item_tags"></span><span class="item_restrictions"> </span></div>      <div class="item"><span class="item_name" style="padding-left:24px;">query</span><span class="item_value"></span>
<span class="item_description">a SQL query that returns one or several DB ids of the MSExperiment table</span><span class="item_tags"></span><span class="item_restrictions"> </span></div>      <div class="item"><span class="item_name item_required" style="padding-left:24px;">out</span><span class="item_value"></span>
<span class="item_description">output file in mzML format (prefixed with DB id and '_' if several files are exported)</span><span class="item_tags"></span><span class="item_restrictions"> </span></div>      <div class="item item_advanced"><span class="item_name" style="padding-left:24px;">log</span><span class="item_value"></span>
<span class="item_description">Name of log file (created only when specified)</span><span class="item_tags"></span><span class="item_restrictions"> </span></div>      <div class="item item_advanced"><span class="item_name" style="padding-left:24px;">debug</span><span class="item_value">0</span>
<span class="item_description">Sets the debug level</span><span class="item_tags"></span><span class="item_restrictions"> </span></div>      <div class="item"><span class="item_name" style="padding-left:24px;">threads</span><span class="item_value">1</span>
<span class="item_description">Sets the number of threads allowed to be used by the TOPP tool</span><span class="item_tags"></span><span class="item_restrictions"> </span></div>      <div class="item item_advanced"><span class="item_name" style="padding-left:24px;">no_progress</span><span class="item_value">false</span>
<span class="item_description">Disables progress logging to command line</span><span class="item_tags"></span><span class="item_restrictions">true,false</span></div>      <div class="item item_advanced"><span class="item_name" style="padding-left:24px;">test</span><span class="item_value">false</span>
<span class="item_description">Enables the test mode (needed for internal use only)</span><span class="item_tags"></span><span class="item_restrictions">true,false</span></div></div>
 </div></div><!-- contents -->
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<TABLE width="100%" border="0">
<TR>
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:24 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>