The dbfhconfig Command Line Utility

Syntax:

dbfhconfig [action][options]

action

Can be one of the following:

• add - adds a new <server> or <dsn> entry.
• delete - deletes a <server> or <dsn> entry.
• list - lists details of the configuration file.
• novault - the connection credentials are stored as plain text (default).
• update - updates a <server> or <dsn> entry.
• vault - the connection credentials are stored in the secrets vault (that is, they are encrypted).

options

Specify one or more of the following:

-bitism:32|64|both

Used to indicate the bitism of the associated ODBC data source. Some ODBC drivers, such as IBM Db2, require that data source names are unique, and so 32-bit and 64-bit connections to the same database must have different DSN entries. When set to both,the same DSN name is used for both 32-bit and 64-bit connections (default).

-comment:<comment>

Adds a comment line for the associated <server> or <dsn> entry. Use with the -add -dsn:<dsn-name> or -update -dsn:<dsn-name> actions/options.

-connect:<connection-string>

Adds a connection string to establish connection to the associated <server>. Connection strings are an alternative method to connecting to a database via an ODBC connection. Use with the -add -dsn:<dsn-name> or -update -dsn:<dsn-name> actions/options.

-db:<db-name>

The name of the database to be used. This is Db2-specific, and used when a physical database is used to host multiple datastores/regions. Use with the -add -dsn:<dsn-name> and -update -dsn:<dsn-name> actions/optons.

-dsn:<dsn-name>

The data source name. Use with the -add, -delete, and -update actions.

-feature:<options>

The features in use for the specified region database. Use with the -add -dsn:<dsn-name> -type:region and -update -dsn:<dsn-name> -type:region actions/options.

<options> can be one or more of the following, separated by a comma or a space:

• all - all available region features enabled (default).
• none - no region features enabled.
• [+|-]reslocking - enables\disables database resource locking.

-file:<file-name>

Specifies the name of the configuration file to update. Use with the -add, -delete, and -update actions.

If not specified, the file defaults to the value of the MFDBFH_CONFIG environment variable.

-name:<name>

The name of the datastore, region, or database. Use with the -add -dsn:<dsn-name> and -update -dsn:<dsn-name> -type:datastore actions/options.

-nobanner

Suppresses output to a minimum.

-optio:<options>

Optimized I/O operations. Use with the -add -dsn:<dsn-name> -type:datastore and -update -dsn:<dsn-name> -type:datastore actions/options.

<options> can be one or more of the following, separated by a comma or a space:

• all - all available I/O optimizations are enabled.
• none - no I/O optimizations are enabled (default).
• [+|-]oi - enables\disables I/O optimizations for ESDS, KSDS and RRDS files opened for input.
• [+|-]oiseq - enables\disables I/O optimizations for (line-)sequential files opened for input.
• [+|-]oo - enables\disables I/O optimizations for ESDS, KSDS and RRDS files opened for output.
• [+|-]ooseq - enables\disables I/O optimizations for (line-)sequential files opened for output.

-password:<password>

The password used to connect to the database. Use with the -add -dsn:<dsn-name> and -update -dsn:<dsn-name> actions/options.

-provider:<db-type>

The type of database. Use with the -add -server action/option.

<db-type> can be one of the following:

• az or azuresqldb - Azure SQL Database.
• db2 - Db2.
• postgresql or pg - PostgreSQL.
• sqlserver or ss - Microsoft SQL Server.

-server:<name>

The name of the server. Use with the -add, -delete, and -update actions.

-type:<dsn-type>

The type of dsn. Use with the -add -dsn:<dsn-name> action/option.

<dsn-type> can be one of the following:

• datastore
• database
• region
• crossregion

-user:<user-name>

The user name used to connect to the database. Use with the -add -dsn:<dsn-name> and -update -dsn:<dsn-name> actions/options.