SQL data source commands
SQL data source mode provides the commands to create or modify an SQL data source configuration.
To enter the mode, use the global sql-source command. To delete an SQL data source, use the no sql-source command.
SQL-ODBC feature.While in this mode, use the commands in the following table to define an SQL data source. An SQL data source establishes a direct connection to a database instance on a remote data server. When configured, it is possible to dynamically run database operations, such as SELECT and INSERT, on the remote database instance.
An SQL data source is used by an SQL action in a processing policy. The SQL action retrieves the data for further processing by the processing policy. Conversely, the processing policy can store the processed data in the configured database instance.
- To view the current configuration, use the show command.
- To restore default values, use the reset command.
- To exit this configuration mode without saving changes to the running configuration, use the cancel command.
- To exit this configuration mode and save changes to the running configuration, use the exit command.
| Command | Purpose |
|---|---|
| admin-state | This command sets the administrative state for the configuration. |
| ancillary-server | This command defines servers for high availability or load distribution. |
| connect-timeout | This command specifies the duration wait to establish a connection. |
| db | This command sets the vendor of the data server. |
| db2-encryption-method | This command sets the TLS encryption method for an IBM Db2 database. |
| host | This command sets the IP address or hostname of the data server. |
| hostname-in-certificate | This command specifies the hostname that the certificate must contain for hostname validation. |
| id | This command sets the identifier of the data source. |
| idle-timeout | This command sets the duration that a connection from the connection pool can remain idle before the connection is released. |
| keystore | This command sets the identification credentials for client authentication. |
| limit | This command indicates whether to limit the data from a SELECT statement. |
| limit-size | This command sets the limit on data from a SELECT statement. |
| load-balancing | This command controls whether to enable Db2 workload balancing and automatic client reroute. These features are supported for Db2 for z/OS. |
| maximum-connections | This command sets the maximum number of concurrent SQL connections. |
| mssql-encryption-method | This command sets the TLS encryption method for a Microsoft SQL Server database. |
| oracle-datasource-type | This command sets the identifier type for the Oracle data source. |
| oracle-encryption-method | This command sets the TLS encryption method for an Oracle database. |
| oracle-objects | This command controls whether to enable advanced Oracle database support. |
| password-alias | This command specifies the password alias of the user password to establish a database connection. |
| port | This command sets the TCP port that the data server monitors for requests. |
| query-timeout | This command sets the duration to wait for an SQL request to complete. |
| sql-config-param | This command defines configuration parameters for the data server connection. |
| summary | This command specifies the brief, descriptive summary for the object instance. |
| truststore | This command sets the validation credentials for server authentication. |
| username | This command sets the user to establish the connection with the SQL database. |
| validate-host-name | This command indicates whether to validate the hostname against the hostname in the server certificate. |
| validate-server-certificate | This command indicates whether to validate the server certificate against the truststore. |