USER MANUALS

Change Database Settings Script

To change the Data Catalog’s metadata you can use the change_database_settings script located in the folder <DENODO_HOME>/tools/data-catalog.

Usage

change_database_settings [-?] -a <adapter name> -d <driver class name> -uri <connection URI to database>
      [-e <path to drivers files>]
      [-i]
      [-kcred <kerberos credentials cache file>]
      [-krb]
      [-ktab <path to keytab file>]
      [-p <password or kerberos password>]
      [-pi <initial size connections in pool>]
      [-pma <max active connections in pool>]
      [-q <query to check if the connection is alive>]
      [-tout <milliseconds to wait for a connection>]
      [-u <username or kerberos username>]
Parameters of the change_database_settings script

Parameter Name

Description

-?

--help

Prints the help

E.g. -?

-a

--adapter <adapter-name>

Adapter used in the database connection. For example (derby, mysql, mysql8, oracle_12c, oracle_18c, oracle_19c, postgresql, sqlserver, auroramysql, aurorapostgre, azuresqlserver)

E.g. --adapter mysql

-d

--driver <driver-classname>

The name of the Java class of the JDBC driver to be used.

E.g. --driver com.mysql.jdbc.Driver

-e

--external-driver <driver-classpath>

The path to the driver files that will be copied to the folder <DENODO_HOME>/lib/data_catalog_extensions.

This option will delete all the JAR files in the folder <DENODO_HOME>/lib/data_catalog_extensions before copy the JAR files from the source folder.

If the source path is a directory, then all the JAR files inside the folder will be copied.

E.g. -e /path_to_drivers/mysql

-i

--interactive-mode

Interactive mode to avoid storing the password in the bash history

E.g. -i

-kcred

--kerberos-credentials-cache-file

Kerberos with Windows User: Use Single Sign-On (SSO) with Kerberos, doing pass-through with the user that launched the server (no user name nor password required).

E.g. -kcred /path/kerberosCredentials

-krb

--kerberos

Use the parameter to use Kerberos Authentication (default: false)

E.g. --kerberos

-ktab

--keytab

Use Kerberos authentication, with the provided username (in this case, the Service Principal Name - SPN -) and Keytab file (no password needed)

E.g. --keytab /path/keytabfile.keytab

-p

--password

Database password or Kerberos password (provide with ‘encrypted:’ prefix for encrypted passwords)

E.g. --password encrypted:passwordEncrypted

-pi

--initial-size

The minimum number of idle connections that the Data Catalog tries to maintain in the pool. (default: 3)

E.g. -pi 4

-pma

--max-active

The maximum number of actual connections to the database, including both idle and in-use connections. (default: 10)

E.g. --max-active 20

-q

--ping-query

The query that will be executed just before using a connection from the pool to validate that it is still alive

E.g. --ping-query "select field from test;"

-tout

--connection-timeout

Maximum number of milliseconds that the Data Catalog will wait for a connection from the pool

E.g. --connection-timeout 10000

-u

--user

Database username or Kerberos username

E.g. --user denodoUser

-uri

--database-uri

The connection URL to the database.

E.g. --database-uri jdbc:mysql://host:1234/database

Example:

Configure the external metadata database in a MySQL database.

change_database_settings   -a mysql
                           -d com.mysql.jdbc.Driver
                           -pi 50
                           -pma 100
                           -tout 100000
                           -u denodoUser
                           -uri jdbc:mysql://localhost:1234/database?useUnicode=yes
                           -e /path_to_drivers/mysql
                           -p encrypted:passwordEncrypted

In this example, we use parameter -e indicating an external location to Denodo where the MySQL driver is present. The script will use that location to copy the driver to <DENODO_HOME>/lib/data_catalog_extensions, allowing the server to load the driver when Data Catalog is started. Note that -e parameter value can be a file or a directory. In this case, all files present at the directory are copied to the destination folder. This option will delete all the JAR files into the folder <DENODO_HOME>/lib/data_catalog_extensions.

Finally, the password (parameter -p) is encrypted. To encrypt this password, execute the script <DENODO_HOME>/bin/encrypt_password and provide the password of this user account in MySQL. The argument for -p is encrypted: followed by the result of this script.

Example:

Configure the external metadata database in a MySQL database with the interactive mode.

change_database_settings   -a mysql
                           -d com.mysql.jdbc.Driver
                           -u denodoUser
                           -uri jdbc:mysql://localhost:1234/database?useUnicode=yes
                           -e /path_to_drivers/mysql
                           -i

In this example, the parameter -i activates the interactive mode that will request the password or Kerberos password to the user.

Add feedback