Chapter 8: Catalog Database

You cannot create databases on your local machine using client-only software, such as SDK/WIN32. Instead, you have to catalog the database before you can compile, debug or run programs.

With client with local data software, such as DB2 Universal Database Personal Edition, you might need to access remote database for unit testing. Again, you need to catalog the remote database before this can occur.

You can use the GUI tool provided by Host Compatibility Option or one of the utilities provided by IBM such as Client Configuration Assistant to do this.

8.1 Catalog Database Window

To display the Catalog Database tool (see Figure 8-1), select the Tools, HCO, Catalog Database menu from the IDE.

Figure 8-1: Catalog Database tool

The following elements make up the Catalog Database tool:

Menu bar
Toolbar
Status line
List box that contains a list of databases currently cataloged on your PC

8.2 The Toolbar

The following list shows the buttons in the toolbar and the functions that they invoke:

	Display the Catalog New Database window (see Figure 8-2) to enter information required to catalog a new database.
	Uncatalog a database. Function is unavailable until a database has been selected from list box. This function only affects databases cataloged on your PC.
	Test connection to selected database. Function is unavailable until a database has been selected from list box.
	Switch to Catalog Server tool. See the chapter Catalog Server for more details.
	Display the on-line HCO User's Guide,which is a hypertext file that describes how the Catalog Database tool works.

8.3 The Menu Bar

The menu bar is an another way of invoking Catalog Database functions. The menu bar is composed of two menus: Database and Help.

8.3.1 The Database Menu

To run a command or to exit the tool, use the Database menu. You can also display this menu by right-clicking on the Catalog Database window (see Figure 8-1).

Catalog new database	Display the Catalog New Database window (see Figure 8-2) to enter information required to catalog a new database.
Uncatalog database	Uncatalog a database. Function is disabled until a database has been selected from list box. This function only affects databases cataloged on your PC.
Test connect	Test connection to selected database. Function is disabled until a database has been selected from list box.
List servers	Switch to Catalog Server tool. See the chapter Catalog Server for more details.
Exit	Exit Catalog Database tool.

8.4 Cataloging a Database

To catalog a database, either click Catalog or select Catalog database from Database menu. A window similar to the Catalog Database window is then displayed (see Figure 8-2).

Figure 8-2: Catalog Database Window

In the entry fields provide the following information:

Database Name	The name of the database on the database server or the local database name if type is LOCAL.
Alias	An alternate name for the database that you want to use (optional) .
Comment	A brief description to use to identify the database (30 characters maximum).
Drive Letter	Select the drive letter where the database is located. This selection is not required if cataloging a remote database.
Type	Select LOCAL for databases on your PC or REMOTE for databases located on a remote database server.
Server	Select the remote database server where the database is located. If the server is not listed, you need to use the Catalog Server tool to add the server to the list. (See the chapter Catalog Server for more information) .
Authentication	Select location where security is to be performed. This selection must match what is set for database server.

Then click CATALOG. When the database has been cataloged, the Catalog New Database window is removed and the database is added to list box on Catalog Database tool (see Figure 8-1).

8.4.1 Authorization

You need one of the following authorization levels to be able to execute this function:

SYSADM

SYSCTRL

8.5 Uncatalog a Database

Don't worry if you make a mistake cataloging the database. You can uncatalog the database from the Catalog Database tool by:

Selecting the database that you want to uncatalog from the list box displayed on the Catalog Database tool (see Figure 8-1).
Clicking trash can or selecting Uncatalog database from Database menu

8.6 Test Connect

You should check to see if you can connect to the database before trying to do application development. You can test connection by doing the following:

Select the database that you want to test from the list box displayed on the Catalog Database tool (see Figure 8-1).
Click connect or select Test connect from Database menu.

8.6.1 What to do if connect fails

If the connect fails, the SQL Error Message tool is displayed with the SQLCODE and error message associated with the connect error. These will aid you in correcting the problem. Make sure that the following has been done:

If connecting to a DB2 Universal Database server, that a DB2START has been issued.
If connecting to a DB2 Universal Database server, make sure that the Instance and Security Service have been started. In the example below, DB2 is the instance name:
Example
```
NET START DB2
```
```
NET START DB2NTSECSERVER
```

In addition, check that the communications software on the server and client match. On the server, make sure that the environment variable DB2COMM is set to all the communication protocol(s) that will be supported by the server.
Example
```
SET DB2COMM=TCPIP,NETBIOS
```

On client side, make sure the local database manager configuration file has been updated (if needed) with the required configuration parameters. See IBM DB2 Command Reference for more details on getting or updating this information.
If you get a SQL30081 error, additional diagnostic codes are included with error message. See IBM DB2 Messages Reference for more details as to what these codes mean.

Catalog Server

DDL Processor