Difference between revisions of "Keys in the ODB /Logger/SQL subtree"
Jump to navigation
Jump to search
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | ==== Links ==== | |
| + | <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/SQL''</span> ODB subtree is a subdirectory of the [[/Logger ODB tree]]. The The ODB <span style="color: purple;">''/Logger/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/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/SQL subtree]] is set, the SQL database will be created. | ||
| + | <br> | ||
----- | ----- | ||
| + | <br> | ||
| − | == <span style="color: purple;">'' | + | === <span style="color: purple;">''Write Data''</span> === |
| − | + | <div style="column-count:3;-moz-column-count:3;-webkit-column-count:3"> | |
| − | '''Type:''' BOOL | + | * '''Type:''' BOOL |
| + | * '''Default:''' "n" | ||
| + | </div> | ||
| − | |||
| − | If this | + | If this key in the [[#top|/Logger/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]]. | [[Keys in the ODB /Logger tree #/Logger/Write data |/Logger/Write data key]]. | ||
| − | + | <br> | |
| − | |||
| − | |||
| − | |||
----- | ----- | ||
| + | <br> | ||
| − | == <span style="color: purple;">'' | + | === <span style="color: purple;">''Hostname''</span> === |
| − | + | <div style="column-count:3;-moz-column-count:3;-webkit-column-count:3"> | |
| − | '''Type:''' STRING | + | * '''Type:''' STRING |
| − | + | * '''Default:''' "localhost" | |
| − | '''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;">'' | + | === <span style="color: purple;">''Username''</span> === |
| − | + | <div style="column-count:3;-moz-column-count:3;-webkit-column-count:3"> | |
| − | '''Type:''' STRING | + | * '''Type:''' STRING |
| − | + | * '''Default:''' "root" | |
| − | '''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;">'' | + | === <span style="color: purple;">''Password''</span> === |
| − | + | <div style="column-count:3;-moz-column-count:3;-webkit-column-count:3"> | |
| − | '''Type:''' STRING | + | * '''Type:''' STRING |
| − | + | * '''Default:''' | |
| − | '''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> === | |
| − | == <span style="color: purple;">'' | + | <div style="column-count:3;-moz-column-count:3;-webkit-column-count:3"> |
| − | + | * '''Type:''' STRING | |
| − | '''Type:''' STRING | + | * '''Default:''' <experiment name> |
| − | + | </div> | |
| − | '''Default:''' | ||
| − | + | 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 | |
| − | |||
| − | '''Type:''' DIR | ||
| − | This directory contains links to parameters in the ODB that are to be saved in the SQL Database at Begin-of-run. The links | + | This directory in the [[#top|/Logger/SQL subtree]] contains links to parameters in the ODB that are to be saved in the SQL Database at Begin-of-run. The links |
| − | * Run number ( linked to [[/Runinfo/Run number]] ) | + | * Run number ( linked to [[/Runinfo ODB tree#Run number|/Runinfo/Run number]] ) |
| − | * Start time ( linked to [[/Runinfo/Start time]]) | + | * Start time ( linked to [[/Runinfo ODB tree#Start time|/Runinfo/Start time]]) |
are created automatically by the MIDAS logger ([[mlogger]]) the first time it runs. The user may add other links as desired. | 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;">'' | + | === <span style="color: purple;">''Links EOR''</span> === |
| − | '''Type:''' DIR | + | * '''Type:''' DIR |
| − | This directory contains links to parameters in the ODB that are to be saved in the SQL Database at End-of-run. The link | + | This directory in the [[#top|/Logger/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/Stop time]] ) | + | * 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. | 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 14:57, 8 July 2015
Links
The ODB /Logger/SQL ODB subtree is a subdirectory of the /Logger ODB tree. The The ODB /Logger/SQL subtree will be created by the MIDAS logger (mlogger) - see Logging to a mySQL database.
Keys in the /Logger/SQL subtree
The following sections explain the purpose of the keys in this subtree.
Create Database
- Type: BOOL
- Default: "n"
If this key in the /Logger/SQL subtree is set, the SQL database will be created.
Write Data
- Type: BOOL
- Default: "n"
If this key in the /Logger/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 /Logger/Write data key.
Hostname
- Type: STRING
- Default: "localhost"
This key in the /Logger/SQL subtree contains the name of the host where the SQL database is located.
Username
- Type: STRING
- Default: "root"
This key in the /Logger/SQL subtree contains the username for access to the SQL Database.
Password
- Type: STRING
- Default:
This key in the /Logger/SQL subtree contains the (encoded) password for access to the SQL Database.
Database
- Type: STRING
- Default: <experiment name>
This key in the /Logger/SQL subtree contains the name of the SQL Database (predefined as the name of the experiment in ODB Key /Experiment/Name).
Table
- Type: STRING
- Default: "Runlog"
This key in the /Logger/SQL subtree contains the name of the table in the SQL Database.
Links BOR
- Type: DIR
This directory in the /Logger/SQL subtree contains links to parameters in the ODB that are to be saved in the SQL Database at Begin-of-run. The links
- Run number ( linked to /Runinfo/Run number )
- Start time ( linked to /Runinfo/Start time)
are created automatically by the MIDAS logger (mlogger) the first time it runs. The user may add other links as desired.
Links EOR
- Type: DIR
This directory in the /Logger/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/Stop time )
is created automatically by the MIDAS logger (mlogger) the first time it runs. The user may add other links as desired.