Creates a database only on the database partition server
that calls the API. This API is not intended for general use. For
example, it should be used with db2Restore if the database partition
at a database partition server was damaged and must be recreated.
Improper use of this API can cause inconsistencies in the system,
so it should only be used with caution.
Note: If this API is used
to recreate a database partition that was dropped (because it was
damaged), the database at this database partition server will be in
the restore-pending state. After recreating the database partition,
the database must immediately be restored on this database partition
server.
Scope
This API only affects the database
partition server on which it is called.
Required connection
Instance. To create
a database at another database partition server, it is necessary to
first attach to that database partition server. A database connection
is temporarily established by this API during processing.
API include file
sqlenv.h
API and data structure syntax
SQL_API_RC SQL_API_FN
sqlecran (
char * pDbName,
void * pReserved,
struct sqlca * pSqlca);
SQL_API_RC SQL_API_FN
sqlgcran (
unsigned short reservedLen,
unsigned short dbNameLen,
struct sqlca * pSqlca,
void * pReserved,
char * pDbName);
sqlecran API parameters
- pDbName
- Input. A string containing the name of the database to be created.
Must not be NULL.
- pReserved
- Input. A spare pointer that is set to null or points to zero.
Reserved for future use.
- pSqlca
- Output. A pointer to the sqlca structure.
sqlgcran API-specific parameters
- reservedLen
- Input. Reserved for the length of pReserved.
- dbNameLen
- Input. A 2-byte unsigned integer representing the length of the
database name in bytes.
Usage notes
When the database is successfully
created, it is placed in restore-pending state. The database must
be restored on this database partition server before it can be used.
REXX API syntax
This API can be called
from REXX through the SQLDB2 interface.