Purpose
To define a database server and user information for connecting to it.
Format
| /DBCONNECTION | dbms database [ALIAS alias] connection_option |
where
| connection_option | = | [AUTHENTICATION {AUTODETECT|DBMS|OS|KERBEROS}] [{USER|REPOSITORY|CYBERARK|AZUREVAULT} username password] |
Arguments
| dbms |
The dbms argument corresponds to the access method through which Connect connects to the database management system (DBMS). The dbms argument value that you specify, however, depends on how Connect connects to the DBMS:
Access methods through which Connect connects to supported DBMSs and the corresponding valid DBMS argument values follow:
See Examples. |
||||||||||||||||||||||||||||||||||||||||||||
| database |
The database argument value corresponds to the data source to which Connect ETL connects. Consider the types of data sources that you would specify as per the DBMS to which you are connecting:
1 NoSQL databases include, but are not limited to the following: Apache Cassandra, Apache Hbase, and MongoDB. 2 Connect supports all ODBC 3.0 compliant databases including, but not limited to, the following: SAP HANA, Caché, MySQL, CA DataCom/DB, CA IDMS/DB, Informix, and PostgreSQL. 3 To connect to a specific database on a Sybase Adaptive Server Enterprise (ASE) server with multiple databases, enclose the database name in [ ] and specify it immediately following the server name, e.g. Marketing[TradeShows]. The database argument value can be in the form of a string or identifier. An identifier and a string must adhere to the rules described for an identifier. For a summary of valid naming and formatting conventions for identifiers and constants, see Syntax reference in the Connect help. See Examples. |
||||||||||||||||||||||||||||||||||||||||||||
| alias |
A name you assign to the database connection, which you use to reference the connection in other options. The name assigned to a database connection must adhere to the rules described for an identifier. For a summary of valid naming and formatting conventions for identifiers and constants, see syntax reference in the Connect help. When you do not assign an alias, use the database argument to refer to the connection in other options. When you define an alias for the connection, you should reference the connection only through the alias; you can no longer reference the database name directly in other options. |
||||||||||||||||||||||||||||||||||||||||||||
| username | The username under which to connect to the database. The username must be in the form of a string, which you can provide in any valid format. For a summary of valid naming and formatting conventions for identifiers and constants, see Syntax reference in the Connect help. | ||||||||||||||||||||||||||||||||||||||||||||
| password |
The password to authenticate the connection for username. The password must be in the form of a string, which you can provide in any valid format. For a summary of valid naming and formatting conventions for identifiers and constants, see GUIMSG_NAMED_DEFINITION_CANNOT_BE_REDEFINED in the Connect help. To use a Repository password, specify REPOSITORY and enter a password variable for the password. Create password variables using the Connect ETL repository manager as described in the Connect help. Note that you must define the password variable on the same system on which, and as the same user by whom, this command application runs. At runtime, Connect ETL retrieves the password associated with the specified variable from the repository. A Repository password can be specified as an environment variable that points to the Repository variable. To use passwords stored in CyberArk, specify CYBERARK and enter a password variable for the password. Setup a password variable manually in an execution profile as described in the Connect help. Connect ETL retrieves the password associated with the specified variable from CyberArk. CyberArk also requires a TLS-secured HTTPS connection to deliver passwords, which requires client certificates setup in the Connect ETL Server dialog or repository manager. To use passwords stored in Azure Key Vault, specify AZUREVAULT and enter a password variable for the password. Setup a password variable manually in an execution profile as described in the Connect help. Connect ETL retrieves the password associated with the specified variable from Azure Key Vault. Azure Key Vault also requires a TLS-secured HTTPS connection to deliver passwords, which requires client certificates setup in the Connect ETL Server dialog or repository manager. |
Location
The option may appear anywhere in the task definition.
Notes
You can use the connection in the /DBINPUT or /DBOUTPUT options to identify a database table source or target.
Authentication
To specify whether Connect ETL or the database client determines the authentication method, select AUTHENTICATION AUTODETECT.
To specify that the DBMS authenticates the specified user name and password, either use AUTHENTICATION DBMS or do not specify an AUTHENTICATION argument.
To specify that the operating system authenticates using your operating system login credentials, use AUTHENTICATION OS without a user name and password. To exclude the user name and password, either omit the USER argument or provide empty strings defined through environment variables.
To specify that Kerberos use an existing Kerberos ticket for authentication, use AUTHENTICATION KERBEROS.
Examples
/DBCONNECTION ORACLE transaction_database user "john" "john123"/DBCONNECTION ORACLE transaction_database user "john" "john123" alias transaction_connection/DBCONNECTION ORACLE transaction_database authentication OS/DBCONNECTION ODBC $HIVE_ODBC ALIAS impala USER "$HIVE_ODBC_USER_NAME" "$HIVE_ODBC_USER_PASSWORD"The option requests an ODBC connection, whose alias is impala, to a Hive database, which is identified by the environment variable, $HIVE_ODBC. The value defined to $HIVE_ODBC is the ODBC DSN, which is the type of data source applicable to ODBC connections. See database. As the access method to the Hive database is ODBC, ODBCserves as the dbms argument value. For valid DBMS argument values, see dbms. The name and password of the user attempting to login to the Hive database are identified by the environment variables, $HIVE_ODBC_USER_NAME and $HIVE_ODBC_USER_PASSWORD.
/DBCONNECTION JDBC $HIVE_JDBC ALIAS impala USER "$HIVE_JDBC_USER_NAME" "$HIVE_JDBC_USER_PASSWORD"/DBCONNECTION DB2 db2_database ALIAS db2_connect USER "$DB2_USER_NAME" "$DB2_USER_PASSWORD"The option requests a native DB2 connection, whose alias is db2_connect, to a DB2 database, db2_database. The DB2 database value, db2_database, is the DB2 connection alias, which is the type of data source applicable to native DB2 connections. See database. As the access method to the DB2 database is through native CLI connectivity, the DBMS name, DB2,serves as the dbms argument value. For valid DBMS argument values, see dbms. The name and password of the user attempting to login to the DB2 database are identified by the environment variables, $DB2_USER_NAME and $DB2_USER_PASSWORD.