Keys in the ODB /Logger/Runlog/SQL subtree: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
(The midas documentation has moved to https://midas.triumf.ca/docs/)
Tag: Replaced
 
Line 1: Line 1:
==== Links ====
The midas documentation has moved. See [https://midas.triumf.ca/docs/develop/reference/reference/odb_keys/#loggerrunlog /Logger/Runlog] on the ODB keys page and [https://midas.triumf.ca/docs/develop/features/storing_data/data_logging/runlog/ Data logging: run log] for the new documentation about the /Logger/Runlog/SQL ODB keys.
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* [[Keys in the ODB /Logger tree| /Logger tree]]
* [[Logging to a mySQL database]]
* [[/Logger ODB tree #Example | example /Logger tree]]
* [[mlogger]]
</div>
 
----------------
<br>
 
 
The ODB <span style="color: purple;">''/Logger/Runlog/SQL''</span> ODB subtree is a subdirectory of the [[/Logger ODB tree]]. The ODB <span style="color: purple;">''/Logger/Runlog/SQL''</span> subtree will be created by the MIDAS logger ([[mlogger]]) - see [[Logging to a mySQL database]].
 
 
 
== Keys in the <span style="color: purple;">''/Logger/Runlog/SQL subtree</span> ==
The following sections explain the purpose of the keys in this subtree.
 
 
=== <span style="color: purple;">''Create Database''</span> ===
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* '''Type:''' BOOL
* '''Default:'''  "n"
</div>
If this key in the [[#top|/Logger/Runlog/SQL subtree]]  is set, the SQL database will be created.
 
<br>
-----
<br>
 
 
=== <span style="color: purple;">''Write Data''</span> ===
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* '''Type:''' BOOL
* '''Default:'''  "n"
</div>
 
 
If this key in the [[#top|/Logger/Runlog/SQL subtree]] is set , the data will be written to the SQL database, provided the MIDAS logger ([[mlogger]]) is also set to write the data - see
[[Keys in the ODB /Logger tree #/Logger/Write data |/Logger/Write data key]].
 
<br>
-----
<br>
 
 
=== <span style="color: purple;">''Hostname''</span> ===
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* '''Type:''' STRING
* '''Default:'''  "localhost"
</div>
 
 
This key in the [[#top|/Logger/SQL subtree]] contains the name of the host where the SQL database is located.
 
<br>
-----
<br>
 
 
=== <span style="color: purple;">''Username''</span> ===
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* '''Type:''' STRING
* '''Default:'''  "root"
</div>
 
This key in the [[#top|/Logger/SQL subtree]] contains the username for access to the SQL Database.
 
<br>
-----
<br>
 
 
=== <span style="color: purple;">''Password''</span> ===
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* '''Type:''' STRING
* '''Default:''' 
</div>
This key in the [[#top|/Logger/SQL subtree]] contains  the (encoded) password for access to the SQL Database.
 
<br>
-----
<br>
 
=== <span style="color: purple;">''Database''</span> ===
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* '''Type:''' STRING
* '''Default:'''  <experiment name>
</div>
 
This key in the [[#top|/Logger/SQL subtree]] contains the name of the SQL Database (predefined as the name of the experiment in  ODB Key [[/Experiment ODB tree#Name|/Experiment/Name]]).
 
<br>
-----
<br>
 
=== <span style="color: purple;">''Table''</span> ===
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* '''Type:''' STRING
* '''Default:'''  "Runlog"
</div>
 
 
This key in the [[#top|/Logger/SQL subtree]] contains the name of the table in the SQL Database.
 
<br>
-----
<br>
 
=== <span style="color: purple;">''Links BOR''</span> ===
 
* '''Type:''' DIR
 
This directory in the [[#top|/Logger/Runlog/SQL subtree]] contains links to parameters in the ODB that are to be saved in the SQL Database at Begin-of-run. The links
 
*    Start time  ( linked to [[/Runinfo ODB tree#Start time|/Runinfo/Start time]])
*    Run number  ( linked to [[/Runinfo ODB tree#Run number|/Runinfo/Run number]])
 
are created automatically by the MIDAS logger ([[mlogger]]) the first time it runs. The user may add other links as desired.
 
<br>
-----
<br>
 
=== <span style="color: purple;">''Links EOR''</span> ===
 
* '''Type:''' DIR
 
 
This directory in the [[#top|/Logger/Runlog/SQL subtree]] contains links to parameters in the ODB that are to be saved in the SQL Database at End-of-run. The link
 
*    Stop time  ( linked to [[/Runinfo ODB tree#Stop time|/Runinfo/Stop time]] )
 
is created automatically by the MIDAS logger ([[mlogger]]) the first time it runs. The user may add other links as desired.
 
 
[[Category:Logger Tree]]

Latest revision as of 22:00, 30 October 2026

The midas documentation has moved. See /Logger/Runlog on the ODB keys page and Data logging: run log for the new documentation about the /Logger/Runlog/SQL ODB keys.

Retrieved from "https://daq00.triumf.ca/MidasWiki/index.php?title=Keys_in_the_ODB_/Logger/Runlog/SQL_subtree&oldid=3735"