sqledrpd API - Drop database

Deletes the database contents and all log files for the database, uncatalogs the database, and deletes the database subdirectory.

Scope

By default, this API affects all database partition servers that are listed in the db2nodes.cfg file.

Authorization

One of the following authorities:

SYSADM
SYSCTRL

Note: The effective user ID of the calling application or process is used for client-side authorization.

Required connection

Instance. It is not necessary to call ATTACH before dropping a remote database. If the database is cataloged as remote, an instance attachment to the remote node is established for the duration of the call.

API include file

sqlenv.h

API and data structure syntax

SQL_API_RC SQL_API_FN
  sqledrpd (
         _SQLOLDCHAR * pDbAlias, 
        _SQLOLDCHAR * pReserved2,
        struct sqlca * pSqlca);

SQL_API_RC SQL_API_FN
  sqlgdrpd (
        unsigned short Reserved1,
        unsigned short DbAliasLen,
        struct sqlca * pSqlca,
        _SQLOLDCHAR * pReserved2,
        _SQLOLDCHAR * pDbAlias);

sqledrpd API parameters

pDbAlias: Input. A string containing the alias of the database to be dropped. This name is used to reference the actual database name in the system database directory.
pReserved2: A spare pointer that is set to null or points to zero. Reserved for future use.
pSqlca: Output. A pointer to the sqlca structure.

sqlgdrpd API-specific parameters

Reserved1: Reserved for future use.
DbAliasLen: Input. A 2-byte unsigned integer representing the length in bytes of the database alias.

Usage notes

The sqledrpd API deletes all user data and log files. If the log files are needed for a rollforward recovery after a restore operation, the files should be saved before calling this API.

The database must not be in use; all users must be disconnected from the database before the database can be dropped.

To be dropped, a database must be cataloged in the system database directory. Only the specified database alias is removed from the system database directory. If other aliases with the same database name exist, their entries remain. If the database being dropped is the last entry in the local database directory, the local database directory is deleted automatically.

If this API is called from a remote client (or from a different instance on the same machine), the specified alias is removed from the client's system database directory. The corresponding database name is removed from the server's system database directory.

REXX API syntax

DROP DATABASE dbalias

REXX API parameters

dbalias: The alias of the database to be dropped.