View source for OAR Syntax simplification

{{Portal|User}}
__TOC__

In order to ease the reservation of resources with OAR (using oarsub or the job API), Grid'5000 provides the following mechanisms to simplify the oarsub filters (which otherwise use a regular SQL syntax to select resources): 
* An alias system to translate simple and short keywords to the OAR resource filter expressions (which are often long and complex).
* The automatic addition of simple quotes for strings (quote still required for text including spaces) in the expressions (e.g. in <code>cluster='yeti'</code> or <code>ib=EDR</code> quotes are not mandatory)
* The use of short names of nodes instead of the long names which include the grid5000.fr domain name.
* The use of <code>&</code> alternatively to <code>and</code>; <code>|</code> alternatively to <code>or</code> in OAR resource filter expressions

== Usage ==
=== Aliases ===
Aliases are defined for the most common resources, for instance, to ease clusters selection, GPUs, etc. Aliases do not replace the classical way of using the OAR [[OAR_Properties|properties]]. Some of the aliases are site-specific (e.g. cluster and node names).

Aliases must be used within the classical <code class=command>oarsub</code> options: <code class=command>-l</code> and <code class=command>-p</code>. 

Here some examples:

;Request a node with an SSD

{{Term|location=frontend| cmd=<code class="command">oarsub</code> -I -p <code class=replace>SSD</code>}}
Which is equivalent using the regular SQL syntax to:
{{Term|location=frontend| cmd=<code class="command">oarsub</code> -I -p <code class=replace>"disktype like '%/SSD'"</code>}}


;Request a node with a GTX 1080 Ti Nvidia GPU

{{Term|location=frontend| cmd=<code class="command">oarsub</code> -I -p <code class=replace>gtx1080ti</code>}}
Which is equivalent using the regular SQL syntax to:
{{Term|location=frontend| cmd=<code class="command">oarsub</code> -I -p <code class=replace>"gpu_model='GeForce GTX 1080 Ti'"</code>}}


;Request 2 nodes with an SSD and 256G or more RAM

{{Term|location=frontend| cmd=<code class="command">oarsub</code> -I -l nodes=2 -p <code class=replace>"ssd&256GB"</code>}}
Which is equivalent using the regular SQL syntax to:
{{Term|location=frontend| cmd=<code class="command">oarsub</code> -I -l nodes=2 -p <code class=replace>"disktype like '%/SSD' and memnode >= 262144"</code>}}

;Request a node on grimoire cluster with all its disks

{{Term|location=frontend| cmd=<code class="command">oarsub</code> -I -l <code class=replace>"{host+disk&grimoire}"</code>/nodes=1}}
Which is equivalent using the regular SQL syntax to:
{{Term|location=frontend| cmd=<code class="command">oarsub</code> -I -l <code class=replace>"{(type='default' or type='disk') and cluster='grimoire'}"</code>/nodes=1}}


;Aliases can be mixed with the classical way of requesting resources

{{Term|location=frontend| cmd=<code class="command">oarsub</code> -I -p <code class=replace>"ib=EDR & 256GB"</code>}}
Which is equivalent using the regular SQL syntax to:
{{Term|location=frontend| cmd=<code class="command">oarsub</code> -I -p <code class=replace>"ib='EDR' and memnode >= 262144"</code>}}

=== Long node names completion ===

The automatic completion of short hostnames to add the domain name can be used when filtering with the <code>host</code> property:

;For one host

{{Term|location=frontend| cmd=<code class="command">oarsub</code> -I -p <code class=replace>"host='yeti-1'"</code>}}

Or even without the quotes:

{{Term|location=frontend| cmd=<code class="command">oarsub</code> -I -p <code class=replace>"host=yeti-1"</code>}}

Or since we provide aliases for each node host property, the following also works:

{{Term|location=frontend| cmd=<code class="command">oarsub</code> -I -p <code class=replace>"yeti-1"</code>}}

All 3 are equivalent using the regular SQL syntax to:
{{Term|location=frontend| cmd=<code class="command">oarsub</code> -I -p <code class=replace>"host='yeti-1.grenoble.grid5000.fr'"</code>}}

; For multiple host within an IN()

{{Term|location=frontend| cmd=<code class="command">oarsub</code> -I -p <code class=replace>"host IN (yeti-1,yeti-2,yeti-3)"</code>}}
Which is equivalent using the regular SQL syntax to:
{{Term|location=frontend| cmd=<code class="command">oarsub</code> -I -p <code class=replace>"host IN ('yeti-1.grenoble.grid5000.fr', 'yeti-2.grenoble.grid5000.fr', 'yeti-3.grenoble.grid5000.fr')"</code>}}

=== Disabling the syntax simplification ===

If for any reason you want to disable the syntax simplification in order to just use the OAR regular syntax, it is possible by using the <code>no-syntax-simplifier</code> job type, as follows:

{{Term|location=frontend| cmd=<code class="command">oarsub</code> -I -p "cluster='yeti'" <code class=replace>-t no-syntax-simplifier</code>}}

== Available aliases ==

{{:Generated/OarsubSimplifierAliases}}