db2HADRStart API - 高可用性災害時リカバリー (HADR) 操作の開始

データベースで HADR 操作を開始します。

許可

以下の権限のいずれか。

SYSADM
SYSCTRL
SYSMAINT

必要な接続

インスタンス。データベース接続が存在しない場合、この API でデータベース接続が確立され、API 完了時にそのデータベース接続がクローズされます。

API 組み込みファイル

db2ApiDf.h

API およびデータ構造構文

SQL_API_RC SQL_API_FN
  db2HADRStart (
       db2Uint32 versionNumber,
       void * pParmStruct,
       struct sqlca * pSqlca);

typedef SQL_STRUCTURE db2HADRStartStruct
{
   char *piDbAlias;
   char *piUserName;
   char *piPassword;
   db2Uint32 iDbRole;
   db2Uint16 iByForce;
} db2HADRStartStruct;

SQL_API_RC SQL_API_FN
  db2gHADRStart (
       db2Uint32 versionNumber,
       void * pParmStruct,
       struct sqlca * pSqlca);

typedef SQL_STRUCTURE db2gHADRStartStruct
{
   char *piDbAlias;
   db2Uint32 iAliasLen;
   char *piUserName;
   db2Uint32 iUserNameLen;
   char *piPassword;
   db2Uint32 iPasswordLen;
   db2Uint32 iDbRole;
   db2Uint16 iByForce;
} db2gHADRStartStruct;

db2HADRStart API パラメーター

versionNumber: 入力。 2 番目のパラメーター pParmStructとして渡される構造のバージョンとリリースのレベルを指定します。
pParmStruct: 入力。 db2HADRStartStruct 構造を指すポインター。
pSqlca: 出力。 sqlca 構造を指すポインター。

db2HADRStartStruct データ構造パラメーター

piDbAlias

入力。データベース別名を指すポインター。

piUserName

入力。コマンドを実行するときのユーザー名を指すポインター。

piPassword

入力。パスワードを含むストリングを指すポインター。

iDbRole

入力。どの HADR データベース役割を、指定のデータベース上で開始するかを指定します。有効な値は以下のとおりです。

DB2HADR_DB_ROLE_PRIMARY: 1 次役割のデータベースに対する HADR 操作を開始します。
DB2HADR_DB_ROLE_STANDBY: スタンバイ役割のデータベースに対する HADR 操作を開始します。

iByForce

入力。 iDbRole パラメーターが DB2HADR_DB_ROLE_STANDBY に設定されている場合、この引数は無視されます。有効な値は以下のとおりです。

DB2HADR_NO_FORCE: スタンバイ・データベースが指定した時間制限内に 1 次データベースへ接続する場合にのみ、HADR が 1 次データベースで開始されることを指定します。
DB2HADR_FORCE: スタンバイ・データベースが 1 次データベースへ接続することを待機せずに、HADR を強制的に開始することを指定します。

db2gHADRStartStruct データ構造固有パラメーター

iAliasLen: 入力。データベース別名の長さ (バイト単位) を指定します。
iUserNameLen: 入力。ユーザー名の長さ (バイト単位) を指定します。
iPasswordLen: 入力。パスワードの長さ (バイト単位) を指定します。