SQL History¶
Extract the list of the SQL queries executed, with their error status (if any), start/end time and project context (if any). Regular users can only retrieve their own queries, whereas administrators can retrieve queries from all or any users.
opal sql-history <CREDENTIALS> [OPTIONS] [XTRAS]
Options¶
Option | Description |
---|---|
--project PROJECT, -pr PROJECT |
Project name used as the SQL execution context to filter. If not specified, history from any context is returned. If ‘*’ is specified, history of SQL execution without context is returned. |
--offset OFFSET, -os OFFSET |
Number of history items to skip. Default is 0 (note that the items are ordered by most recent first). |
--limit LIMIT, -lm LIMIT |
Maximum number of history items to return. Default is 100. |
--subject SUBJECT, -sb SUBJECT |
Filter by user name, only administrators can retrieve SQL history of other users. If ‘*’ is specified, history of all users is retrieved. Default is the current user name. |
Credentials¶
Authentication can be done by username/password credentials OR by personal access token OR by certificate/private key pair (two-way SSL authentication).
Option | Description |
---|---|
--opal OPAL, -o OPAL |
Opal server base url |
--user USER, -u USER |
Credentials auth: user name (requires a password) |
--password PASSWORD, -p PASSWORD |
Credentials auth: user password (requires a user name) |
--token TOKEN, -tk TOKEN |
Token auth: user’s personal access token |
--ssl-cert SSL_CERT, -sc SSL_CERT |
Two-way SSL auth: certificate/public key file (requires a private key) |
--ssl-key SSL_KEY, -sk SSL_KEY |
Two-way SSL auth: private key file (requires a certificate) |
Extras¶
Option | Description |
---|---|
-h, --help |
Show the command help’s message. |
--verbose, -v |
Verbose output. |
--json, -j |
Output pretty-print JSON |
Example¶
Get own SQL queries history:
opal sql-history --opal https://opal-demo.obiba.org --user administrator --password password
Get own SQL queries history on project CNSIM:
opal sql-history --opal https://opal-demo.obiba.org --user administrator --password password --project CNSIM
Get other user SQL queries history on project CNSIM (requires administrator rights):
opal sql-history --opal https://opal-demo.obiba.org --user administrator --password password --subject someuser --project CNSIM
Get all users, one thousand most recent SQL queries history (requires administrator rights):
opal sql-history --opal https://opal-demo.obiba.org --user administrator --password password --subject '*' --limit 1000