Create Connections
Understand Toad Connections
Review this topic to learn about open database connections in Toad.
For information about switching the current connection in Toad, see Switching Connections in Toad.
Toad Open Connections
In Toad, an open connection in the Connection/Navigation Manager represents one or more actual connections to the database. When you open a database connection in Toad:
- Toad creates an initial database connection for general use.
-
Toad also creates a separate database connection for each Editor (the first time you execute a statement) and for each Data tab in the Database Explorer (the first time you select the tab and query data).
The connection associated with the window (or tab) remains open until you close the window. If a window has an associated connection, but a statement is not currently executing, the connection is in an inactive state.
To view information for an open connection
-
To view the number of actual database connections that exist for a Toad connection, including the number of active connections, place the cursor over the connection in the Connection/Navigation Manager pane or in the connection drop-down list.
To use the Background Processes pane
- When a statement is executing, a progress bar displays in the Status bar located at the bottom of the Toad application window. Click the executing progress bar to open the Background Processes pane.
-
To cancel statement execution, use the Background Processes pane.
Note: It is recommended that you cancel only your own processes, because terminating Toad activities could cause unexpected behavior.
Sharing a Connection Among Windows
You can instruct Toad to share an open connection among windows. In this way, the Editor windows and Data tabs can share the same connection when the connection is inactive.
To share a database connection among windows in Toad
- Select Tools | Options | Editor | General.
-
Clear the checkbox for the Use individual connection for each open editor option.
-
When this option is not selected, Toad attempts to use a single connection for any new windows or query execution. For example, if you share a database connection, you can execute a query in the Editor, execute another query in a new Editor, and then select the Data tab from the same connection.
If the single connection is in use when Toad attempts to execute it, the following occurs:
- If your database supports executing multiple queries simultaneously on a shared connection, the query is placed in a queue and executes as soon as the current operation completes.
- If your database does not support executing multiple queries on a shared connection, a dialog prompts you to either permanently associate the window with a new database connection, cancel the previous operation, or add the query to a queue until the current operation completes, and the execute it. If you place multiple queries in the queue, each one executes in the order that it was added to the queue.
Note: Although you can share a database connection, any commits apply to the selected window only.
Configure DB2 Client Connections
Setting up connections to the DB2 for LUW databases and DB2 for z/OS subsystems that Toad will manage requires two main steps.
Step 1. Configure DB2 client connections - Before you can create a connection profile, each of the databases or subsystems must be cataloged on the DB2 client. This topic helps you with that process.
Step 2. Create connection profiles - Step 2 involves creating Toad connection profiles for the cataloged DB2 databases or subsystems. Each profile contains the information that Toad needs to connect to the system, such as the user ID and password, DB2 registry settings, and the default schema. See Create Toad Connection Profiles for DB2 for more information.
Use one of the following methods to catalog each of the databases or subsystems on the DB2 client.
Transfer a Catalog Any Time After Initial Setup
Use this method to transfer a catalog from another DB2 client on your machine to your default DB2 client.
To transfer a catalog any time after initial setup
-
In the Connection Manager, click
in the toolbar.
Note: If the Client Configuration Wizard opens, Toad found only one DB2 client installed.
-
From the DB2 Client list, select the name of the DB2 client whose catalog you want to transfer to your default DB2 client.
This list contains all current previously installed DB2 clients on your computer, including the default DB2 client instance and any Toad DB2 client installations.
- Click OK.
- To create a connection in Toad for any of the transferred catalog entries, see Create Toad Connection Profiles for DB2.
To import an exported catalog profile
-
In the Connections (or Create New Connection) window, click
beside the Database alias drop-down list to open the Client Configuration wizard.
-
On the Welcome page, select Import Profile.
-
Click Next.
-
Click
in the Profile name field to browse for and select the exported profile you want to import. When you select the profile, its contents display in the text pane.
-
Complete the wizard.
Once you close the wizard, the Database alias drop-down list in the Connections window includes all the DB2 databases and subsystems whose catalog entries you imported.
Note: DB2 does not automatically export catalog entries for the local DB2 instance and its databases on the computer from which the export is run (unless these entries already exist in the catalog). Therefore, the profile you are importing might not include these node entries. To add the missing entries to your DB2 client catalog, you must manually catalog the databases. If these databases are local to your computer, catalog them as remote databases. See Manually catalog DB2 for LUW databases for more information.
-
Proceed to catalog entries as needed. See Create Toad Connection Profiles for DB2 for more information.
To manually catalog a DB2 for LUW database
-
In the Connections (or Create New Connection) window, click
-
If the host and node names for the database you want to configure are listed in the tree, select them. These selections pre-fill certain fields required later in the wizard process. If these names are not listed, you must provide the necessary host and node information later in the wizard.
-
Click Add Catalog Entry.
-
Review the following for additional information:
Add a Host
Description
Operating system
Select the operating system for the server on which the DB2 for LUW instance containing the DB2 database you are cataloging resides. For a list of supported server platforms, see the release notes.
Host name
Enter the TCP/IP address or the system name for the server on which the DB2 database resides.
Port number
Enter the port number for the server on which the DB2 database resides.
Security type
Select a secure protocol to handle TCP traffic for this connection.
Specify an Instance
Description
Node name
Enter a user-defined name for the DB2 instance containing the database you are cataloging.
If you selected the node name from the tree on the Welcome page, this information is pre-filled (but you can update it as needed).
Instance name
Enter the real name of the DB2 instance.
Comment
Enter a descriptive comment for the instance, if needed.
Add a Database
Description
Database name
Enter the real name of the DB2 database.
Database alias
Enter a unique nickname to identify the database on your system. Authentication
Select the authentication method that is required to connect to the database. Target principal
Enter the service account name for server's service where the database resides.
Note: This option is available only when Kerberos is selected as the authentication method.
-
Complete the wizard.
The Database alias drop-down list in the Connections window shows the alias for the newly cataloged database. To complete the Toad connection setup, you must create a Toad connection profile for the database. See Create Toad Connection Profiles for DB2 for more information.
Note: If you connect directly to a DB2 for z/OS subsystem, you cannot take advantage of Sysplex. If you want to use Sysplex, catalog an entry to a DB2 Connect gateway instead. See Manually catalog DB2 Connect gateways for more information.
To manually catalog a DB2 for z/OS subsystem
-
In the Connections (or Create New Connection) window, click
- If the host name for the DB2 subsystem you want to configure is listed in the tree, select it. This selection pre-fills certain fields required later in the wizard process. If the host name is not listed, you must provide the necessary host information later in the wizard.
-
Click Add Catalog Entry.
-
Review the following for additional information:
Add a Host Description Operating system
Select z/OS for the server operating system.
Host name
Enter the TCP/IP address or the system name for the server on which the DB2 subsystem resides.
Port number
Enter the port number of the service for the DB2 subsystem.
Enable SOCKS security
Select this checkbox to enable the SOCKS secure protocol to handle TCP traffic for this connection. SOCKS adds an authentication mechanism for additional security.
Add a DB2 Subsystem
Description
Location name
Enter the location name of the DB2 subsystem as defined during the DB2 installation.
Database alias
Enter a unique, user-defined alias to identify the DB2 subsystem on your system. You can use the same name you used in the previous Location name field, as long as it does not already exist in the list aliases in the DB2 client. -
Complete the wizard. A message informs you whether the entry was added successfully.
The Database alias drop-down list in the Connections window shows the alias for the newly cataloged subsystem. To complete the Toad connection setup, create a Toad connection profile for the database. See Create Toad Connection Profiles for DB2 for more information.
In order to connect to a DB2 for z/OS subsystem, you need to catalog two entries. First, you need to catalog the DB2 subsystem on the DB2 Connect gateway. During this process, you define an alias for the DB2 subsystem. Second, you need to catalog this DB2 subsystem alias in Toad. The procedure below describes both cataloging events.
To manually catalog an entry to a DB2 Connect gateway
-
Catalog the DB2 subsystem on the DB2 Connect gateway. See the IBM DB2 for z/OS documentation for more information.
-
In the Connections (or Create New Connection) window in Toad, click
-
Click Add Catalog Entry.
-
Review the following for additional information:
Add a Host
Description Operating system
Select the operating system for the server on which the DB2 Connect gateway resides.
Host name
Enter the TCP/IP address or the system name for the server on which the DB2 Connect gateway resides.
Port number
Enter the port number of the service for the DB2 Connect gateway.
Enable SOCKS security
Select this checkbox to enable the SOCKS secure protocol to handle TCP traffic for this connection. SOCKS adds an authentication mechanism for additional security.
Specify an Instance Description Node name
Enter an alias for the user-defined node name you specify in the Instance name field. Instance name
Enter a user-defined name for the gateway node or use the same value entered in the Node name.
Note: This name does not point to an actual node on the gateway system, but is needed to continue the cataloging process.
Add a Database Description Database name
Enter the database alias name for the DB2 subsystem.
Note: This alias name must match the alias cataloged on the DB2 Connect gateway.
Database alias
Enter a unique, user-defined alias for the DB2 Connect gateway. You can use the same alias you used in the previous Database name field, as long as it does not exist in the list of Toad for DB2 aliases. Authentication
Select the authentication method that matches the method specified for the DB2 subsystem on the DB2 Connect gateway. -
Complete the wizard.
The Database alias drop-down list in the Connections window shows the name for the newly cataloged DB2 subsystem. To complete the Toad connection setup, you must create a Toad connection profile for the subsystem. See Create Toad Connection Profiles for DB2 for more information.
Note: Toad for DB2 supports LDAP connections. See Configure DB2 LDAP Support for more information.
Maintain DB2 Client Connections
Additionally, Toad provides functionality to perform the following maintenance on the catalog you set up for the current DB2 client:
To edit a DB2 catalog entry
-
In the Connections (or Create New Connection) window, click
-
In the catalog configuration tree for the DB2 client, select the catalog entry for the DB2 database or subsystem that you want to edit.
-
Click Edit Catalog Entry.
-
On the Edit Catalog Entry page, update the catalog properties as needed. For a description of the catalog properties, see the following links:
-
Click Next to open the Catalog Script Review window.
-
Review and modify the script in the preview pane as needed.
-
Click Finish. A message window displays, informing you whether the updates to the catalog entry completed successfully.
To remove a DB2 catalog entry
-
In the Connections (or Create New Connection) window, click
-
In the catalog configuration tree for the DB2 client, expand one or more nodes, and select the catalog entries that you want to remove. (Press CTRL+click to select multiple entries.)
Note: You can remove a node by selecting all database entries for that node.
-
Click Remove Catalog Entry.
-
On the Catalog Script Review page, modify the script in the preview pane as needed.
-
Click Finish. A message window displays, informing you whether the removals completed successfully.
Toad for IBM DB2 provides functionality to export your current DB2 client catalog to a file, called an export profile. You can then import this profile to set up the catalog for another DB2 client.
To create the export profile containing the current DB2 client catalog, Toad executes the DB2 Connectivity Configuration Export Tool command db2cfexp. If you want to export the catalog of a remote or local DB2 client (other than your current DB2 client), you must manually execute this command. For more information, see the following IBM documentation: http://publib.boulder.ibm.com/infocenter/db2luw/v8/index.jsp?topic=/
com.ibm.db2.udb.doc/core/r0002442.htm.
To export the DB2 client catalog
-
In the Connections (or Create New Connection) window, click
-
Click Export Profile in the Welcome window of the Client Configuration wizard. (You might need to click
this button.)
-
Click Next.
-
Click
-
Select the type of profile you want to create:
- Template to create a profile used as a template for other DB2 clients (default for exporting a DB2 catalog)
- Backup to create a profile used to back up a DB2 database instance
-
Maintain to create a profile that contains only database or node information required for updating other instances
For more information about these profile types, see the IBM documentation (as cited previously) describing the db2cfexp command.
-
Complete the wizard. A message window displays, informing you whether the export completed successfully.
Note: DB2 does not automatically export catalog entries for the local DB2 instance and its databases installed on your computer unless these entries already exist in the catalog you are exporting. If you later import the export catalog to a DB2 client, you must manually catalog the missing local-node databases as remote databases. See Manually catalog DB2 for LUW databases for more information.
After you have set up the catalog on the current DB2 client, you can proceed to the second phase of the Toad connection setup. This phase involves creating Toad connection profiles for the cataloged DB2 databases or subsystems. See Create Toad Connection Profiles for DB2 for more information.
Configure DB2 LDAP Support
You can create DB2 Lightweight Directory Access Protocol (LDAP) connections when the DB2 client installed with Toad is configured for LDAP. Configuring the client consists of enabling LDAP support and specifying the host name and port number of the LDAP server. Once the client is configured, Toad retrieves names from your LDAP server and displays them in the Database Alias list in the Connections window.
Notes:
-
You must configure LDAP support for the DB2 client installed with Toad regardless of whether an existing DB2 client on the computer is already configured to support LDAP.
-
Currently, Toad for DB2 supports only the access of DB2 LDAP catalog entries. Toad does not support the management of these entries.
To configure the DB2 client for LDAP
-
Open the Command Window for the DB2 client installed with Toad by selecting Start | All Programs | IBM DB2 | <ToadCom, ToadEval, or ToadFree> | Command Line Tools | Command Window.
-
Enter the following command to enable LDAP support:
db2set DB2_ENABLE_LDAP=YES
-
Enter the following command to specify the TCP/IP host name and port number of the LDAP server:
db2set DB2LDAPHOST=<hostname[:port]>
The port number defaults to 389 (default LDAP port) if you leave the port number blank.
-
Exit the Command window.
-
Launch Toad and open the Connections window.
Databases on the LDAP server should be available from the Database alias drop-down list in the Connections window. To complete the Toad connection setup, you must create a Toad connection profile for each database. See Create Toad Connection Profiles for DB2 for more information.