Export SQL¶
Export in a SQL database.
opal export-sql <CREDENTIALS> <OPTIONS> [EXTRAS]
Options¶
Option | Description |
---|---|
--datasource DATASOURCE, -d DATASOURCE |
Datasource name |
--tables TABLES [TABLES ...], -t TABLES [TABLES ...] |
The list of tables to be exported |
--incremental -i |
Incremental export |
--identifiers ID_MAPPING, -id ID_MAPPING |
Entity ID mapping name |
--database DATABASE, -db DATABASE |
Name of the SQL database as registered in Opal |
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¶
Export tables from opal-data to a SQL database:
opal export-sql --opal https://opal-demo.obiba.org --user administrator --password password --datasource opal-data --tables Spirometry --database sql_db