runWorker.html 5.1 KB
Newer Older
Matthieu Muffato's avatar
Matthieu Muffato committed
1 2 3 4 5 6
<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>runWorker.pl</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
7
<link rev="made" href="mailto:root@localhost" />
Matthieu Muffato's avatar
Matthieu Muffato committed
8 9
</head>

10
<body>
Matthieu Muffato's avatar
Matthieu Muffato committed
11 12


13 14 15 16 17 18 19 20 21 22

<h1 id="NAME">NAME</h1>

<pre><code>    runWorker.pl [options]</code></pre>

<h1 id="DESCRIPTION">DESCRIPTION</h1>

<pre><code>    runWorker.pl is an eHive component script that does the work of a single Worker -
    specializes in one of the analyses and starts executing jobs of that analysis one-by-one or batch-by-batch.

Matthieu Muffato's avatar
Matthieu Muffato committed
23
    Most of the functionality of the eHive is accessible via beekeeper.pl script,
24 25 26 27 28 29 30
    but feel free to run the runWorker.pl if you think you know what you are doing :)</code></pre>

<h1 id="USAGE-EXAMPLES">USAGE EXAMPLES</h1>

<pre><code>        # Run one local worker process in ehive_dbname and let the system pick up the analysis
    runWorker.pl -url mysql://username:secret@hostname:port/ehive_dbname

Matthieu Muffato's avatar
Matthieu Muffato committed
31
        # Run one local worker process in ehive_dbname and let the system pick up the analysis from the given resource_class
32 33
    runWorker.pl -url mysql://username:secret@hostname:port/ehive_dbname -rc_name low_mem

34
        # Run one local worker process in ehive_dbname and constrain its initial specialization within a subset of analyses
35 36
    runWorker.pl -url mysql://username:secret@hostname:port/ehive_dbname -analyses_pattern &#39;1..15,analysis_X,21&#39;

37
        # Run one local worker process in ehive_dbname and allow it to respecialize within a subset of analyses
38 39
    runWorker.pl -url mysql://username:secret@hostname:port/ehive_dbname -can_respecialize 1 -analyses_pattern &#39;blast%-4..6&#39;

Matthieu Muffato's avatar
Matthieu Muffato committed
40
        # Run a specific job in a local worker process:
41 42 43 44 45 46 47
    runWorker.pl -url mysql://username:secret@hostname:port/ehive_dbname -job_id 123456</code></pre>

<h1 id="OPTIONS">OPTIONS</h1>

<h2 id="Connection-parameters">Connection parameters:</h2>

<pre><code>    -reg_conf &lt;path&gt;            : path to a Registry configuration file
48
    -reg_alias &lt;string&gt;         : species/alias name for the Hive DBAdaptor
49 50 51 52 53
    -url &lt;url string&gt;           : url defining where database is located</code></pre>

<h2 id="Task-specificaton-parameters">Task specificaton parameters:</h2>

<pre><code>    -rc_id &lt;id&gt;                 : resource class id
Matthieu Muffato's avatar
Matthieu Muffato committed
54
    -rc_name &lt;string&gt;           : resource class name
55
    -analyses_pattern &lt;string&gt;  : restrict the specialization of the Worker to the specified subset of Analyses
Matthieu Muffato's avatar
Matthieu Muffato committed
56
    -job_id &lt;id&gt;                : run a specific job defined by its database id
57 58 59 60 61
    -force 0|1                  : set to 1 if you want to force running a Worker over a BLOCKED analysis or to run a specific DONE/SEMAPHORED job_id</code></pre>

<h2 id="Worker-control-parameters">Worker control parameters:</h2>

<pre><code>    -job_limit &lt;num&gt;            : #jobs to run before worker can die naturally
Matthieu Muffato's avatar
Matthieu Muffato committed
62
    -life_span &lt;num&gt;            : number of minutes this worker is allowed to run
63 64
    -no_cleanup                 : don&#39;t perform temp directory cleanup when worker exits
    -no_write                   : don&#39;t write_output or auto_dataflow input_job
Matthieu Muffato's avatar
Matthieu Muffato committed
65 66 67
    -hive_log_dir &lt;path&gt;        : directory where stdout/stderr of the whole hive of workers is redirected
    -worker_log_dir &lt;path&gt;      : directory where stdout/stderr of this particular worker is redirected
    -retry_throwing_jobs &lt;0|1&gt;  : if a job dies *knowingly*, should we retry it by default?
68 69 70 71 72
    -can_respecialize &lt;0|1&gt;     : allow this worker to re-specialize into another analysis (within resource_class) after it has exhausted all jobs of the current one</code></pre>

<h2 id="Other-options">Other options:</h2>

<pre><code>    -help                       : print this help
Matthieu Muffato's avatar
Matthieu Muffato committed
73 74
    -versions                   : report both Hive code version and Hive database schema version
    -debug &lt;level&gt;              : turn on debug messages at &lt;level&gt;
75 76 77 78
    -analysis_stats             : show status of each analysis in hive</code></pre>

<h1 id="LICENSE">LICENSE</h1>

79
<pre><code>    Copyright [1999-2015] Wellcome Trust Sanger Institute and the EMBL-European Bioinformatics Institute
80
    Copyright [2016-2020] EMBL-European Bioinformatics Institute
81

Matthieu Muffato's avatar
Matthieu Muffato committed
82
    Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License.
83 84 85 86
    You may obtain a copy of the License at

         http://www.apache.org/licenses/LICENSE-2.0

Matthieu Muffato's avatar
Matthieu Muffato committed
87 88
    Unless required by applicable law or agreed to in writing, software distributed under the License
    is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
89 90 91 92 93 94
    See the License for the specific language governing permissions and limitations under the License.</code></pre>

<h1 id="CONTACT">CONTACT</h1>

<pre><code>    Please subscribe to the Hive mailing list:  http://listserver.ebi.ac.uk/mailman/listinfo/ehive-users  to discuss Hive-related questions or to be notified of our updates</code></pre>

Matthieu Muffato's avatar
Matthieu Muffato committed
95 96 97 98

</body>

</html>
99 100