DB2 Version 10.1 for Linux, UNIX, and Windows

sqleuncn API - Uncatalog an entry from the node directory

Deletes an entry from the node directory.

Authorization

One of the following authorities:
  • SYSADM
  • SYSCTRL

Required connection

None

API include file

sqlenv.h

API and data structure syntax

SQL_API_RC SQL_API_FN
  sqleuncn (
        _SQLOLDCHAR * pNodeName,
        struct sqlca * pSqlca);

SQL_API_RC SQL_API_FN
  sqlguncn (
        unsigned short NodeNameLen,
        struct sqlca * pSqlca,
        _SQLOLDCHAR * pNodeName);

sqleuncn API parameters

pNodeName
Input. A string containing the name of the node to be uncataloged.
pSqlca
Output. A pointer to the sqlca structure.

sqlguncn API-specific parameters

NodeNameLen
Input. A 2-byte unsigned integer representing the length in bytes of the node name.

Usage notes

To recatalog the node, use the sqlectnd API.

To list the nodes that are cataloged, use the db2DbDirOpenScan, db2DbDirGetNextEntry, and db2DbDirCloseScan 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 NODE nodename

REXX API parameters

nodename
Name of the node to be uncataloged.