Administrative API Reference

sqlfrdb - Reset Database Configuration

Resets the configuration file of a specific database to the system defaults.

Scope

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

Authorization

One of the following:

Required Connection

Instance. An explicit attachment is not required. If the database is listed as remote, an instance attachment to the remote node is established for the duration of the call.

Version

sqlutil.h

C API Syntax 



/* File: sqlutil.h */
/* API: Reset Database Configuration */
/* ... */
SQL_API_RC SQL_API_FN
  sqlfrdb (
    _SQLOLDCHAR * pDbAlias,
    struct sqlca * pSqlca);
/* ... */

Generic API Syntax 



/* File: sqlutil.h */
/* API: Reset Database Configuration */
/* ... */
SQL_API_RC SQL_API_FN
  sqlgrdb (
    unsigned short DbAliasLen,
    struct sqlca * pSqlca,
    char * pDbAlias);
/* ... */

API Parameters

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.

pDbAlias
Input. A string containing the database alias.

REXX API Syntax 



RESET DATABASE CONFIGURATION FOR dbname

REXX API Parameters

dbname
Alias of the database associated with the configuration file.

Sample Programs

C
\sqllib\samples\c\dbconf.c

COBOL
\sqllib\samples\cobol\dbconf.cbl

REXX
\sqllib\samples\rexx\dbconf.cmd

Usage Notes

This API resets the entire configuration (except for non-updatable parameters).

To view or print a list of the current database configuration parameters for a database, use sqlfxdb - Get Database Configuration.

To view the default values for database configuration parameters, use sqlfddb - Get Database Configuration Defaults.

To change the value of a configurable parameter, use sqlfudb - Update Database Configuration.

Changes to the database configuration file become effective only after they are loaded into memory. All applications must disconnect from the database before this can occur.

If an error occurs, the database configuration file does not change.

The database configuration file cannot be reset if the checksum is invalid. This may occur if the database configuration file is changed without using the appropriate API. If this happens, the database must be restored to reset the database configuration file.

For a brief description of the database configuration parameters, see the Command Reference. For more information about these parameters, see the Administration Guide.

See Also

sqlfddb - Get Database Configuration Defaults

sqlfudb - Update Database Configuration

sqlfxdb - Get Database Configuration.

[ Top of Page | Previous Page | Next Page ]