Administrative API Reference

sqledpan - Drop Database at Node

Drops a database at a specified node. Can only be run on an MPP server.

Scope

This API only affects the node on which it is called.

Authorization

One of the following:

Required Connection

None. An instance attachment is established for the duration of the call.

Version

sqlenv.h

C API Syntax 



/* File: sqlenv.h */
/* API: Drop Database at Node */
/* ... */
SQL_API_RC SQL_API_FN
  sqledpan (
    char * pDbAlias,
    void * pReserved,
    struct sqlca * pSqlca);
/* ... */

Generic API Syntax 



/* File: sqlenv.h */
/* API: Drop Database at Node */
/* ... */
SQL_API_RC SQL_API_FN
  sqlgdpan (
    unsigned short Reserved1,
    unsigned short DbAliasLen,
    struct sqlca * pSqlca,
    void * pReserved2,
    char * pDbAlias);
/* ... */

API Parameters

Reserved1
Reserved for future use.

DbAliasLen
Input. A 2-byte unsigned integer representing the length in bytes of the database alias.

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

pReserved2
A spare pointer that is set to null or points to zero. Reserved for future use.

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.

REXX API Syntax

This API can be called from REXX through the SQLDB2 interface. See How the API Descriptions are Organized, or the Application Development Guide. For a description of the syntax, see the Command Reference.

Usage Notes

This API is used by utilities supplied with DB2 Universal Database Enterprise - Extended Edition, and is not intended for general use. Improper use of this API can cause inconsistencies in the system, so it should only be used with caution.

See Also

sqlecran - Create Database at Node

sqledrpd - Drop Database.

[ Top of Page | Previous Page | Next Page ]