sqledpan API - Drop a database on a database partition server
Drops a database at a specified database partition server. Can only be run in a partitioned database environment.
Scope
This API only affects the database partition server on which it is called.
Authorization
One of the following authorities:
- SYSADM
- SYSCTRL
Required connection
None. An instance attachment is established for the duration of the call.
API include file
sqlenv.h
API and data structure syntax
SQL_API_RC SQL_API_FN
sqledpan (
char * pDbAlias,
void * pReserved,
struct sqlca * pSqlca);
SQL_API_RC SQL_API_FN
sqlgdpan (
unsigned short Reserved1,
unsigned short DbAliasLen,
struct sqlca * pSqlca,
void * pReserved2,
char * pDbAlias);
sqledpan 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.
- pReserved
- Reserved. Should be NULL.
- pSqlca
- Output. A pointer to the sqlca structure.
sqlgdpan API-specific parameters
- Reserved1
- Reserved for future use.
- DbAliasLen
- Input. A 2-byte unsigned integer representing the length in bytes of the database alias.
- pReserved2
- A spare pointer that is set to null or points to zero. Reserved for future use.
Usage notes
Improper use of this API can cause inconsistencies in the system, so it should only be used with caution.
REXX API syntax
This API can be called from REXX through the SQLDB2 interface.