sqlegdel API - Uncatalog a database from the database connection services (DCS) directory
Deletes an entry from the Database Connection Services (DCS) directory.
Authorization
- SYSADM
- SYSCTRL
Required connection
None
API include file
sqlenv.hAPI and data structure syntax
SQL_API_RC SQL_API_FN
sqlegdel (
struct sql_dir_entry * pDCSDirEntry,
struct sqlca * pSqlca);
SQL_API_RC SQL_API_FN
sqlggdel (
struct sqlca * pSqlca,
struct sql_dir_entry * pDCSDirEntry);sqlegdel API parameters
- pDCSDirEntry
- Input/Output. A pointer to the Database Connection Services directory structure. Specify the ldb field of this structure with the local name of the database to be deleted. The DCS directory entry with a matching local database name is copied to this structure before being deleted.
- pSqlca
- Output. A pointer to the sqlca structure.
Usage notes
DCS databases are also cataloged in the system database directory as remote databases that can be uncataloged using the sqleuncd API.
To recatalog a database in the DCS directory, use the sqlegdad API.
To list the DCS databases that are cataloged on a node, use the sqlegdsc, sqlegdgt, and sqlegdcl APIs.
If directory caching is enabled (using the dir_cache configuration parameter, database, node, and DCS directory files are cached in memory. 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 may not be effective until the application has restarted. To refresh the shared cache (server only) in Db2®, stop (db2stop) and then restart (db2start) the database manager. To refresh the directory cache for another application, stop and then restart that application.
REXX API syntax
UNCATALOG DCS DATABASE dbname [USING :value]REXX API parameters
- dbname
- The local database name of the directory entry to be deleted.
- value
- A compound REXX host variable into which the directory entry information
is returned. In the following, XXX represents the
host variable name. If no name is given, the name SQLGWINF is used.
- XXX.0
- Number of elements in the variable (always 7)
- XXX.1
- RELEASE
- XXX.2
- LDB
- XXX.3
- TDB
- XXX.4
- AR
- XXX.5
- PARMS
- XXX.6
- COMMENT
- XXX.7
- RESERVED