Administrative API Reference

SQLEDBSTOPOPT

This structure is used to provide the database manager stop options.


Table 49. Fields in the SQLEDBSTOPOPT Structure
Field Name Data Type Description
ISPROFILE sqluint32 Indicates whether a profile is specified. If this field indicates that a profile is not specified, the file db2profile is used.
PROFILE CHAR(236) The name of the profile file that was executed at startup to define the DB2 environment for those nodes that were started (MPP only). If a profile for sqlepstart - Start Database Manager was specified, the same profile must be specified here.
ISNODENUM sqluint32 Indicates whether a node number is specified. If specified, the start command only affects the specified node.
NODENUM SQL_PDB_NODE_TYPE Node number.
OPTION sqluint32 Option.
CALLERAC sqluint32 Caller action. This field is valid only for the SQLE_DROP value of the OPTION field.

Valid values for OPTION (defined in sqlenv) are:

SQLE_NONE
Issue the normal db2stop operation.

SQLE_FORCE
Issue the FORCE APPLICATION (ALL) command.

SQLE_DROP
Drop the node from the db2nodes.cfg file.

For more information about these options, see the Command Reference.

Valid values for CALLERAC (defined in sqlenv) are:

SQLE_DROP
Initial call. This is the default value.

SQLE_CONTINUE
Subsequent call. Continue processing after a prompt.

SQLE_TERMINATE
Subsequent call. Terminate processing after a prompt.

Language Syntax

C Structure 



/* File: sqlenv.h */
/* Structure: SQLEDBSTOPOPT */
/* ... */
SQL_STRUCTURE sqledbstopopt
{
  sqluint32              isprofile;
  char                   profile[SQL_PROFILE_SZ+1];
  sqluint32              isnodenum;
  SQL_PDB_NODE_TYPE      nodenum;
  sqluint32              option;
  sqluint32              callerac;
};
/* ... */

COBOL Structure 



* File: sqlenv.cbl
01 SQLEDBSTOPOPT.
    05 SQL-ISPROFILE          PIC 9(9) COMP-5.
    05 SQL-PROFILE            PIC X(235).
    05 FILLER                 PIC X.
    05 SQL-ISNODENUM          PIC 9(9) COMP-5.
    05 SQL-NODENUM            PIC S9(4) COMP-5.
    05 FILLER                 PIC X(2).
    05 SQL-OPTION             PIC 9(9) COMP-5.
    05 SQL-CALLERAC           PIC 9(9) COMP-5.
*

[ Top of Page | Previous Page | Next Page ]