Stores database location information in the system database directory. The database can be located either on the local workstation or on a remote database partition server.
In a partitioned database environment, when cataloging a local database into the system database directory, this command must be issued from a database partition on the server where the database resides.
None. Directory operations affect the local directory only.
>>-CATALOG--+-DATABASE-+--database-name--+-----------+----------> '-DB-------' '-AS--alias-' >--+-------------------+----------------------------------------> +-ON--+-path--+-----+ | '-drive-' | '-AT NODE--nodename-' >--+--------------------------------------------------------------+--> '-AUTHENTICATION--+-SERVER-----------------------------------+-' +-CLIENT-----------------------------------+ +-SERVER_ENCRYPT---------------------------+ +-SERVER_ENCRYPT_AES-----------------------+ +-KERBEROS TARGET PRINCIPAL--principalname-+ +-DATA_ENCRYPT-----------------------------+ '-GSSPLUGIN--------------------------------' >--+------------------------+---------------------------------->< '-WITH--"comment-string"-'
Specifying an authentication type can result in a performance benefit.
db2 catalog database sample on /databases/sample
with "Sample Database"
Use CATALOG DATABASE to catalog databases located on local or remote database partition servers, recatalog databases that were uncataloged previously, or maintain multiple aliases for one database (regardless of database location).
DB2 automatically catalogs databases when they are created. It catalogs an entry for the database in the local database directory and another entry in the system database directory. If the database is created from a remote client (or a client which is executing from a different instance on the same machine), an entry is also made in the system database directory at the client instance.
If neither path nor database partition server name is specified, the database is assumed to be local, and the location of the database is assumed to be that specified in the database manager configuration parameter dftdbpath.
Databases on the same database partition server as the database manager instance are cataloged as indirect entries. Databases on other database partition servers are cataloged as remote entries.
CATALOG DATABASE automatically creates a system database directory if one does not exist. The system database directory is stored on the path that contains the database manager instance that is being used, and is maintained outside of the database.
List the contents of the system database directory using the LIST DATABASE DIRECTORY command. To list the contents of the local database directory use the LIST DATABASE DIRECTORY ON path, where path is where the database was created.
If directory caching is enabled, database, node and DCS directory files are cached in memory. To see if directory caching is enabled, check the value for the dir_cache directory cache support configuration parameter in the output from the GET DATABASE MANAGER CONFIGURATION command. An application's directory cache is created during its first directory lookup. Since the cache is only refreshed when the application modifies any of the directory files, directory changes made by other applications might not be effective until the application has restarted.
To refresh the CLP's directory cache, use the TERMINATE command. To refresh the database manager's shared cache, stop (db2stop) and then restart (db2start) the database manager. To refresh the directory cache for another application, stop and then restart that application.
In a pureScale environment, the db2cluster -cm -add -database_mounts database-name command must be run after the CATALOG DATABASE command.