Administrative API Reference

sqlegdel - Uncatalog DCS Database

Deletes an entry from the Database Connection Services (DCS) directory.

Authorization

One of the following:

Required Connection

None

Version

sqlenv.h

C API Syntax 



/* File: sqlenv.h */
/* API: Uncatalog DCS Database */
/* ... */
SQL_API_RC SQL_API_FN
  sqlegdel (
    struct sql_dir_entry * pDCSDirEntry,
    struct sqlca * pSqlca);
/* ... */

Generic API Syntax 



/* File: sqlenv.h */
/* API: Uncatalog DCS Database */
/* ... */
SQL_API_RC SQL_API_FN
  sqlggdel (
    struct sqlca * pSqlca,
    struct sql_dir_entry * pDCSDirEntry);
/* ... */

API Parameters

pSqlca
Output. A pointer to the sqlca structure. For more information about this structure, see SQLCA.

pDCSDirEntry
Input/Output. A pointer to the Database Connection Services directory structure. For more information about this structure, see SQL-DIR-ENTRY. Fill in 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.

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.

Sample Programs

C
\sqllib\samples\c\dcscat.c

COBOL
\sqllib\samples\cobol\dcscat.cbl

REXX
\sqllib\samples\rexx\dcscat.cmd

Usage Notes

DCS databases are also cataloged in the system database directory as remote databases that can be uncataloged using sqleuncd - Uncatalog Database.

To recatalog a database in the DCS directory, use sqlegdad - Catalog DCS Database.

To list the DCS databases that are cataloged on a node, use sqlegdsc - Open DCS Directory Scan, sqlegdgt - Get DCS Directory Entries, and sqlegdcl - Close DCS Directory Scan.

If directory caching is enabled (see the configuration parameter dir_cache in sqlfxsys - Get Database Manager Configuration), 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 DB2's shared cache (server only), stop (db2stop) and then restart (db2start) the database manager. To refresh the directory cache for another application, stop and then restart that application.

See Also

sqlegdad - Catalog DCS Database

sqlegdcl - Close DCS Directory Scan

sqlegdge - Get DCS Directory Entry for Database

sqlegdgt - Get DCS Directory Entries

sqlegdsc - Open DCS Directory Scan

sqleuncd - Uncatalog Database.

[ Top of Page | Previous Page | Next Page ]