Download pdf - 管理 API リファレンスpublic.dhe.ibm.com/ps/products/db2/info/vr105/pdf/ja_JP/...10API 管理API リファレンス

IBM DB2 10.5for Linux, UNIX, and Windows

管理 API リファレンス

SA88-5273-00(英文原典：SC27-5506-00)

��

お願い本書および本書で紹介する製品をご使用になる前に、 807ページの『付録 D. 特記事項』に記載されている情報をお読みください。

本書には、IBM の専有情報が含まれています。その情報は、使用許諾条件に基づき提供され、著作権により保護されています。本書に記載される情報には、いかなる製品の保証も含まれていません。また、本書で提供されるいかなる記述も、製品保証として解釈すべきではありません。

IBM 資料は、オンラインでご注文いただくことも、ご自分の国または地域の IBM 担当員を通してお求めいただくこともできます。

v オンラインで資料を注文するには、IBM Publications Center (http://www.ibm.com/shop/publications/order) をご利用ください。

v ご自分の国または地域の IBM 担当員を見つけるには、IBM Directory of Worldwide Contacts (http://www.ibm.com/planetwide/) をお調べください。

IBM は、お客様が提供するいかなる情報も、お客様に対してなんら義務も負うことのない、自ら適切と信ずる方法で、使用もしくは配布することができるものとします。

お客様の環境によっては、資料中の円記号がバックスラッシュと表示されたり、バックスラッシュが円記号と表示されたりする場合があります。

　

原典： SC27-5506-00IBM DB2 10.5

for Linux, UNIX, and Windows

Administrative API Reference

発行：日本アイ・ビー・エム株式会社

担当：トランスレーション・サービス・センター

第1刷 2013.6

© Copyright IBM Corporation 1993, 2013.

http://www.ibm.com/shop/publications/orderhttp://www.ibm.com/planetwide/http://www.ibm.com/planetwide/

目次本書について . . . . . . . . . . . . ix本書の対象読者 . . . . . . . . . . . . . ix本書の構成 . . . . . . . . . . . . . . . ix強調表記規則 . . . . . . . . . . . . . . x

第 1 章 DB2 API . . . . . . . . . . . 1

第 2 章変更された API およびデータ構造 . . . . . . . . . . . . . . . . . 21

第 3 章 API およびアプリケーションの動作に影響を与えるログ・シーケンス番号の変更 . . . . . . . . . . . . . . . 25

第 4 章 API の説明の編成方法 . . . . . 31DB2 API アプリケーションのインクルード・ファイル . . . . . . . . . . . . . . . . . 35

第 5 章管理 API . . . . . . . . . . 37db2AddContact - 通知メッセージを送信できる連絡先の追加 . . . . . . . . . . . . . . . . 38db2AddContactGroup - 通知メッセージを送信できる連絡先グループの追加 . . . . . . . . . . . 40db2AddSnapshotRequest - スナップショット要求の追加 . . . . . . . . . . . . . . . . . 42db2AdminMsgWrite - 管理およびレプリケーション機能のためのログ・メッセージの書き込み . . . . . 44db2ArchiveLog - アクティブ・ログ・ファイルのアーカイブ . . . . . . . . . . . . . . . . 46db2AutoConfig - 構成アドバイザーへのアクセス . . 49db2AutoConfigFreeMemory - db2AutoConfig API によって割り振られたメモリーの解放 . . . . . . . 53db2Backup - データベースまたは表スペースのバックアップ . . . . . . . . . . . . . . . 54db2CfgGet - データベース・マネージャー構成パラメーター、あるいはデータベース構成パラメーターの取得 . . . . . . . . . . . . . . . . . 65db2CfgSet - データベース・マネージャー構成パラメーター、あるいはデータベース構成パラメーターの設定 . . . . . . . . . . . . . . . . . 68db2ConvMonStream - バージョン 6 以前の形式へのモニター・ストリームの変換 . . . . . . . . 73db2DatabasePing - ネットワーク応答時間のテストのためのデータベースの ping . . . . . . . . . 76db2DatabaseQuiesce - データベースの静止 . . . . 78db2DatabaseRestart - データベースの再始動 . . . . 80db2DatabaseUnquiesce - データベースの静止解除 . . 83db2DatabaseUpgrade - 前のバージョンの DB2 データベースの現行リリースへのアップグレード . . . . 85

db2DbDirCloseScan - システム・データベース・ディレクトリーまたはローカル・データベース・ディレクトリーのスキャンの終了 . . . . . . . . . 87db2DbDirGetNextEntry - 次のシステム・データベース・ディレクトリー、あるいはローカル・データベース・ディレクトリー項目の取得 . . . . . . . 88db2DbDirOpenScan - システム・データベース・ディレクトリーまたはローカル・データベース・ディレクトリーのスキャンの開始 . . . . . . . . . 92db2DropContact - 通知メッセージを送信できる連絡先リストからの連絡先の削除 . . . . . . . . 94db2DropContactGroup - 通知メッセージを送信できる連絡先リストからの連絡先グループの削除 . . . . 95db2Export - データベースからのデータのエクスポート . . . . . . . . . . . . . . . . . 97db2GetAlertCfg - ヘルス・インディケーターのアラート構成設定の取得 . . . . . . . . . . . 105db2GetAlertCfgFree - db2GetAlertCfg API によって割り振られたメモリーの解放 . . . . . . . . 110db2GetContactGroup - 通知メッセージを送信できる単一の連絡先グループ中の連絡先のリストの取得 . 111db2GetContactGroups - 通知メッセージを送信できる連絡先グループのリストの取得 . . . . . . . 113db2GetContacts - 通知メッセージを送信できる連絡先リストの取得 . . . . . . . . . . . . . 115db2GetDistMap - 分散マップの取得 . . . . . . 117db2GetHealthNotificationList - ヘルス・アラート通知を送信できる連絡先リストの取得 . . . . . . . 119db2GetRecommendations - アラート状態のヘルス・インディケーターを解決するための推奨の入手 . . 121db2GetRecommendationsFree -db2GetRecommendations API によって割り振られたメモリーの解放 . . . . . . . . . . . . . 124db2GetSnapshot - データベース・マネージャー操作状況のスナップショットの取得 . . . . . . . 125db2GetSnapshotSize - db2GetSnapshot API に必要な出力バッファー・サイズの見積もり . . . . . . 129db2GetSyncSession - サテライト同期化セッションID の取得 . . . . . . . . . . . . . . 132db2HADRStart - 高可用性災害時リカバリー(HADR) 操作の開始 . . . . . . . . . . . 133db2HADRStop - 高可用性災害時リカバリー(HADR) 操作の停止 . . . . . . . . . . . 135db2HADRTakeover - データベースへの高可用性災害時リカバリー (HADR) 1 次データベースとしてのテークオーバーの指示 . . . . . . . . . . 137db2HistoryCloseScan - データベース履歴レコードのスキャンの終了 . . . . . . . . . . . . . 140db2HistoryGetEntry - データベース履歴レコードの次の項目の取得 . . . . . . . . . . . . . 141

© Copyright IBM Corp. 1993, 2013 iii

db2HistoryOpenScan - データベース履歴レコードのスキャンの開始 . . . . . . . . . . . . . 143db2HistoryUpdate - データベース履歴レコード項目の更新 . . . . . . . . . . . . . . . . 147db2Import - 表、階層、ニックネーム、ビューへのデータのインポート . . . . . . . . . . . 151db2Ingest API- 入力ファイルまたは入力パイプからDB2 表へのデータの取り込み (INGEST) . . . . 166db2Inspect - データベースの構造上の整合性の検査 180db2InstanceQuiesce - インスタンスの静止 . . . . 188db2InstanceStart - インスタンスの開始 . . . . . 191db2InstanceStop - インスタンスの停止 . . . . . 198db2InstanceUnquiesce - インスタンスの静止解除 203db2LdapCatalogDatabase - LDAP サーバーへのデータベースの登録 . . . . . . . . . . . . . 205db2LdapCatalogNode - LDAP サーバーにあるノード名の別名の指定 . . . . . . . . . . . . . 208db2LdapDeregister - LDAP サーバーからの DB2 サーバーおよびカタログされたデータベースの登録解除 . . . . . . . . . . . . . . . . . 209db2LdapRegister - DB2 サーバーの LDAP サーバーへの登録 . . . . . . . . . . . . . . . 210db2LdapUncatalogDatabase - LDAP サーバーからのデータベース登録の解除 . . . . . . . . . . 214db2LdapUncatalogNode - LDAP サーバーからのノード名に対応する別名の削除 . . . . . . . . . 215db2LdapUpdate - LDAP サーバー上の DB2 サーバーの属性の更新 . . . . . . . . . . . . . 216db2LdapUpdateAlternateServerForDB - LDAP サーバーでのデータベースに対応する代替サーバーの更新 . 220db2Load - 表へのデータのロード . . . . . . . 222db2LoadQuery - ロード操作の状況の取得 . . . . 246db2MonitorSwitches - モニター・スイッチ設定の取得あるいは更新 . . . . . . . . . . . . . 254db2Prune - 履歴ファイル項目の削除、あるいはアクティブ・ログ・パスからのログ・ファイルの削除 . 257db2QuerySatelliteProgress - サテライト同期セッションの状況の取得 . . . . . . . . . . . . . 260db2ReadLog - ログ・レコードの読み取り . . . . 262db2ReadLogNoConn - データベース接続なしのデータベース・ログの読み取り . . . . . . . . . 269db2ReadLogNoConnInit - データベース接続なしのデータベース・ログ読み取りの初期設定 . . . . . 273db2ReadLogNoConnTerm - データベース接続なしのデータベース・ログの読み取り終了 . . . . . . 276db2Recover - データベースのリストアおよびロールフォワード . . . . . . . . . . . . . . 277db2Reorg - 索引または表の再編成 . . . . . . 284db2ResetAlertCfg - ヘルス・インディケーターのアラート構成のリセット . . . . . . . . . . 295db2ResetMonitor - データベース・システム・モニターのデータのリセット . . . . . . . . . . 297db2Restore - データベースまたは表スペースのリストア . . . . . . . . . . . . . . . . 300db2Rollforward - データベースのロールフォワード 317db2Runstats - 表および索引の統計情報の更新 . . . 329

db2SelectDB2Copy - アプリケーションで使用するDB2 コピーの選択. . . . . . . . . . . . 341db2SetSyncSession - サテライト同期セッションの設定 . . . . . . . . . . . . . . . . . 343db2SetWriteForDB - データベースの入出力書き込みの中断または再開 . . . . . . . . . . . . 344db2SpmListIndTrans - SPM 未確定トランザクションのリスト . . . . . . . . . . . . . . . 346db2SyncSatellite - サテライト同期化の開始 . . . 350db2SyncSatelliteStop - サテライト同期化の一時停止 351db2SyncSatelliteTest - サテライトが同期化可能かのテスト . . . . . . . . . . . . . . . . 352db2UpdateAlertCfg - ヘルス・インディケーターのアラート構成設定の更新 . . . . . . . . . . 353db2UpdateAlternateServerForDB - システム・データベース・ディレクトリー内のデータベース別名の代替サーバーの更新 . . . . . . . . . . . . 359db2UpdateContact - 連絡先の属性の更新 . . . . 361db2UpdateContactGroup - 連絡先グループの属性の更新 . . . . . . . . . . . . . . . . 363db2UpdateHealthNotificationList - ヘルス・アラート通知を送信できる連絡先リストの更新 . . . . . 365db2UtilityControl - 実行されているユーティリティーの優先順位の設定 . . . . . . . . . . . 367sqlabndx - アプリケーション・プログラムのバインドによるパッケージの作成 . . . . . . . . . 369sqlaintp - エラー・メッセージの入手 . . . . . 372sqlaprep - アプリケーション・プログラムのプリコンパイル . . . . . . . . . . . . . . . 374sqlarbnd - パッケージの再バインド . . . . . . 377sqlbctcq - 表スペース・コンテナー照会のクローズ 380sqlbctsq - 表スペース照会のクローズ . . . . . 381sqlbftcq - 表スペース・コンテナー中の行の照会データの取得 . . . . . . . . . . . . . . 382sqlbftpq - 表スペース中の行の照会データのフェッチ . . . . . . . . . . . . . . . . . 384sqlbgtss - 表スペースの使用率に関する統計の取得 386sqlbmtsq - すべての表スペースの照会データの取得 388sqlbotcq - 表スペース・コンテナー照会のオープン 390sqlbotsq - 表スペース照会のオープン . . . . . 392sqlbstpq - 単一の表スペースに関する情報の取得 395sqlbstsc - 表スペース・コンテナーの設定 . . . . 397sqlbtcq - すべての表スペース・コンテナーの照会データの取得 . . . . . . . . . . . . . . 400sqlcspqy - DRDA 未確定トランザクションのリスト 402sqle_activate_db - データベースのアクティブ化 . . 403sqle_deactivate_db - データベースの非活動化 . . . 406sqleaddn - パーティション・データベース環境へのデータベース・パーティションの追加 . . . . . 409sqleatcp - インスタンスへのアタッチとパスワードの変更 . . . . . . . . . . . . . . . . 412sqleatin - インスタンスへのアタッチ . . . . . 415sqlecadb - システム・データベース・ディレクトリーへのデータベースのカタログ . . . . . . . 418sqlecran - データベース・パーティション・サーバー上へのデータベース作成 . . . . . . . . . 424

iv 管理 API リファレンス

sqlecrea - データベースの作成 . . . . . . . . 426sqlectnd - ノード・ディレクトリーへの項目のカタログ . . . . . . . . . . . . . . . . 435sqledcgd - システム・データベース・ディレクトリーまたはローカル・データベース・ディレクトリー内のデータベース・コメントの変更 . . . . . . 438sqledpan - データベース・パーティション・サーバーでのデータベースのドロップ . . . . . . . 441sqledrpd - データベースのドロップ . . . . . . 443sqledrpn - データベース・パーティション・サーバーがドロップ可能かどうかの検査 . . . . . . . 445sqledtin - インスタンスからのデタッチ . . . . . 447sqlefmem - sqlbtcq および sqlbmtsq API によって割り振られたメモリーの解放 . . . . . . . . 448sqlefrce - システムからのユーザーおよびアプリケーションの強制終了 . . . . . . . . . . . 449sqlegdad - データベース接続サービス (DCS) ディレクトリーへのデータベースのカタログ . . . . 452sqlegdcl - データベース接続サービス (DCS) ディレクトリーのスキャンの終了 . . . . . . . . . 454sqlegdel - データベース接続サービス (DCS) ディレクトリーからのデータベースのアンカタログ . . . 455sqlegdge - データベース接続サービス (DCS) ディレクトリーの特定項目の取得 . . . . . . . . 457sqlegdgt - データベース接続サービス (DCS) ディレクトリーの項目の取得 . . . . . . . . . . 459sqlegdsc - データベース接続サービス (DCS) ディレクトリーのスキャンの開始 . . . . . . . . 461sqlegins - 現行インスタンスの取得 . . . . . . 462sqleintr - アプリケーション要求への割り込み . . . 463sqleisig - シグナル・ハンドラーのインストール 465sqlemgdb - 前のバージョンの DB2 データベースの現行バージョンへのアップグレード . . . . . . 466sqlencls - ノード・ディレクトリー・スキャンの終了 . . . . . . . . . . . . . . . . . 468sqlengne - ノード・ディレクトリー次項目の入手 469sqlenops - ノード・ディレクトリー・スキャンの開始 . . . . . . . . . . . . . . . . . 471sqleqryc - クライアント接続設定の照会. . . . . 473sqleqryi - クライアント情報の照会 . . . . . . 475sqlesact - アカウンティング・ストリングの設定 477sqlesdeg - SQL ステートメントの最大実行時パーティション内並列処理レベル (つまり並列処理の程度)の設定 . . . . . . . . . . . . . . . . 478sqlesetc - クライアント接続設定の指定 . . . . . 480sqleseti - クライアント情報の設定 . . . . . . 483sqleuncd - システム・データベース・ディレクトリーからのデータベースのアンカタログ . . . . . 486sqleuncn - ノード・ディレクトリーからの項目のアンカタログ . . . . . . . . . . . . . . 488sqlgaddr - 変数のアドレスの取得 . . . . . . . 490sqlgdref - アドレスの間接参照 . . . . . . . . 491sqlgmcpy - あるメモリー領域から別のメモリー領域へデータのコピー . . . . . . . . . . . . 492sqlogstt - SQLSTATE メッセージの入手 . . . . 493

sqludrdt - データベース・パーティション・グループ間でのデータの再配分 . . . . . . . . . . 495sqlugrpn - 特定の行についてのデータベース・パーティション・サーバー番号の取得 . . . . . . . 499sqlugtpi - 表の分散情報の取得 . . . . . . . . 503sqluvqdp - 表の表スペースの静止 . . . . . . . 505

第 6 章 REXX での DB2 API の呼び出し . . . . . . . . . . . . . . . . 509分離レベルの変更 . . . . . . . . . . . . 511

第 7 章未確定トランザクション管理API . . . . . . . . . . . . . . . . 513db2XaGetInfo - リソース・マネージャー情報の入手 515db2XaListIndTrans - 未確定トランザクションのリスト . . . . . . . . . . . . . . . . . 516sqlxhfrg - トランザクション状況の forget . . . . 522sqlxphcm - 未確定トランザクションのコミット . . 523sqlxphrl - 未確定トランザクションのロールバック 524

第 8 章並行アクセスを伴うスレッド化アプリケーション . . . . . . . . . . 525sqleAttachToCtx - コンテキストへのアタッチ . . . 526sqleBeginCtx - アプリケーション・コンテキストの作成およびアタッチ . . . . . . . . . . . 527sqleDetachFromCtx - コンテキストからのデタッチ 529sqleEndCtx - 特定のアプリケーション・コンテキストに関連付けられているメモリーのデタッチと解放 . 530sqleGetCurrentCtx - 現行コンテキストの入手 . . . 532sqleInterruptCtx - コンテキストへの割り込み . . . 533sqleSetTypeCtx - アプリケーション・コンテキスト・タイプの設定 . . . . . . . . . . . . 534

第 9 章データベース管理をカスタマイズするための DB2 データベース・システム・プラグイン . . . . . . . . . . 537プラグインの使用可能化 . . . . . . . . . . 538グループ検索プラグインの展開 . . . . . . 538ユーザー ID/パスワード・プラグインのデプロイ 538GSS-API プラグインのデプロイ . . . . . . 540Kerberos プラグインのデプロイ . . . . . . 541

セキュリティー・プラグインの作成 . . . . . . 543DB2 によるセキュリティー・プラグインのロード方法 . . . . . . . . . . . . . . . 543セキュリティー・プラグイン・ライブラリーの開発に関する制約事項 . . . . . . . . . . 545セキュリティー・プラグインに関する制約事項 547セキュリティー・プラグインの戻りコード . . . 550セキュリティー・プラグインのエラー・メッセージ処理 . . . . . . . . . . . . . . . 553セキュリティー・プラグイン API の呼び出し順序 . . . . . . . . . . . . . . . . 554

セキュリティー・プラグイン . . . . . . . . 557セキュリティー・プラグイン・ライブラリーの位置 . . . . . . . . . . . . . . . . 562

目次 v

セキュリティー・プラグインの命名規則 . . . 563セキュリティー・プラグインの 2 部構成ユーザー ID のサポート . . . . . . . . . . . 564セキュリティー・プラグイン API のバージョン管理 . . . . . . . . . . . . . . . 566セキュリティー・プラグインの 32 ビットと 64ビットに関する考慮事項 . . . . . . . . . 567セキュリティー・プラグインの問題判別 . . . 567

セキュリティー・プラグインの API . . . . . . 569グループ検索プラグイン用の API . . . . . 571db2secDoesGroupExist API - グループの存在のチェック . . . . . . . . . . . . . . . 573db2secFreeErrormsg API - エラー・メッセージのメモリーの解放 . . . . . . . . . . . . 574db2secFreeGroupListMemory API - グループ・リストのメモリーの解放 . . . . . . . . . 575db2secGetGroupsForUser API - ユーザーのグループのリストの取得 . . . . . . . . . . . 576db2secGroupPluginInit API - グループ・プラグインの初期化 . . . . . . . . . . . . . 580db2secPluginTerm - グループ・プラグイン・リソースのクリーンアップ . . . . . . . . . 582

ユーザー ID/パスワード認証プラグインの API . . 583db2secClientAuthPluginInit API - クライアント認証プラグインの初期化 . . . . . . . . . 589db2secClientAuthPluginTerm API - クライアント認証プラグイン・リソースのクリーンアップ . . 591db2secDoesAuthIDExist - 認証 ID の存在の検査 592db2secFreeInitInfo API - db2secGenerateInitialCredが保持しているリソースのクリーンアップ . . . 593db2secFreeToken API - トークンが保持しているメモリーの解放 . . . . . . . . . . . . 594db2secGenerateInitialCred API - 初期証明書の生成 . . . . . . . . . . . . . . . . 595db2secGetAuthIDs API - 認証 ID の取得 . . . 597db2secGetDefaultLoginContext API - デフォルト・ログイン・コンテキストの取得 . . . . . 599db2secProcessServerPrincipalName API - サーバーから戻されたサービス・プリンシパル名の処理 . 601db2secRemapUserid API - ユーザー ID およびパスワードの再マップ . . . . . . . . . . 602db2secServerAuthPluginInit - サーバー認証プラグインの初期化 . . . . . . . . . . . . 604db2secServerAuthPluginTerm API - サーバー認証プラグイン・リソースのクリーンアップ . . . 607db2secValidatePassword API - パスワードの確認 608

GSS-API 認証プラグインに必要な API および定義 611GSS-API 認証プラグインに関する制約事項 . . 613

セキュリティー・プラグインのサンプル . . . . 614Storage Manager に対するバックアップおよびリストアの DB2 API . . . . . . . . . . . . 616

db2VendorGetNextObj - 装置での次のオブジェクトの入手 . . . . . . . . . . . . . . 617db2VendorQueryApiVersion - ベンダー・ストレージ API のサポート・レベルの取得 . . . . . 620sqluvdel - コミット済みセッションの削除 . . . 621

sqluvend - ベンダー装置のリンク解除およびリソースの解放 . . . . . . . . . . . . . 622sqluvget - ベンダー装置からのデータの読み取り 624sqluvint - ベンダー・デバイスの初期化、ベンダー・デバイスへのリンク . . . . . . . . . 626sqluvput - ベンダー装置へのデータの書き込み 631DB2_info . . . . . . . . . . . . . . 633Vendor_info . . . . . . . . . . . . . 636Init_input . . . . . . . . . . . . . . 638Init_output . . . . . . . . . . . . . 640Data . . . . . . . . . . . . . . . 641Return_code . . . . . . . . . . . . . 642

バックアップとリストアの操作に伴う圧縮に使用する DB2 API . . . . . . . . . . . . . . 643

COMPR_CB . . . . . . . . . . . . . 646COMPR_DB2INFO . . . . . . . . . . . 647COMPR_PIINFO . . . . . . . . . . . 649Compress - データ・ブロックの圧縮 . . . . . 651Decompress - データ・ブロックの解凍 . . . . 653GetMaxCompressedSize - 最大限可能なバッファー・サイズの見積もり . . . . . . . . . 655GetSavedBlock - バックアップ・イメージのデータ・ブロックのベンダーの取得 . . . . . . 656InitCompression - 圧縮ライブラリーの初期設定 657InitDecompression - 解凍ライブラリーの初期設定 658TermCompression - 圧縮ライブラリーの停止 . . 659TermDecompression - 解凍ライブラリーの停止 660

第 10 章 API で使用されるデータ構造 661db2DistMapStruct . . . . . . . . . . . . 662db2HistoryData . . . . . . . . . . . . . 663db2LSN データ構造 . . . . . . . . . . . 669sql_dir_entry . . . . . . . . . . . . . . 670SQLB_TBS_STATS . . . . . . . . . . . 672SQLB_TBSCONTQRY_DATA . . . . . . . . 674SQLB_TBSPQRY_DATA . . . . . . . . . . 676SQLCA . . . . . . . . . . . . . . . 681sqlchar . . . . . . . . . . . . . . . . 682SQLDA . . . . . . . . . . . . . . . 683sqldcol . . . . . . . . . . . . . . . . 685sqle_addn_options . . . . . . . . . . . . 688sqle_client_info . . . . . . . . . . . . . 690sqle_conn_setting . . . . . . . . . . . . 693sqle_node_local . . . . . . . . . . . . . 696sqle_node_npipe . . . . . . . . . . . . . 697sqle_node_struct . . . . . . . . . . . . . 698sqle_node_tcpip . . . . . . . . . . . . . 699sqledbdesc. . . . . . . . . . . . . . . 700sqledbdescext . . . . . . . . . . . . . . 709sqledbterritoryinfo . . . . . . . . . . . . 716sqleninfo . . . . . . . . . . . . . . . 717sqlfupd. . . . . . . . . . . . . . . . 720sqllob . . . . . . . . . . . . . . . . 729sqlma . . . . . . . . . . . . . . . . 730sqlopt . . . . . . . . . . . . . . . . 734SQLU_LSN . . . . . . . . . . . . . . 736

vi 管理 API リファレンス

sqlu_media_list . . . . . . . . . . . . . 737SQLU_RLOG_INFO . . . . . . . . . . . 742sqlupi . . . . . . . . . . . . . . . . 743SQLXA_XID . . . . . . . . . . . . . . 745

付録 A. プリコンパイラーのカスタマイズ API . . . . . . . . . . . . . . 747プリコンパイラーのカスタマイズ API . . . . . 748

付録 B. DB2 ログ・レコード . . . . . 749DB2 ログ・レコード . . . . . . . . . . . 750ログ・レコード・ヘッダー . . . . . . . . 753トランザクション・マネージャーのログ・レコード . . . . . . . . . . . . . . . . 755長フィールド・マネージャーのログ・レコード 763ユーティリティー・マネージャーのログ・レコード . . . . . . . . . . . . . . . . 765

データ・マネージャーのログ・レコード . . . 769リレーション・マネージャー・ログ・レコード 789LOB マネージャーのログ・レコード . . . . 795

付録 C. DB2 技術情報の概説 . . . . . 801DB2 テクニカル・ライブラリー (ハードコピーまたは PDF 形式) . . . . . . . . . . . . . 802コマンド行プロセッサーから SQL 状態ヘルプを表示する . . . . . . . . . . . . . . . . 804異なるバージョンの DB2 インフォメーション・センターへのアクセス . . . . . . . . . . . 805ご利用条件 . . . . . . . . . . . . . . 805

付録 D. 特記事項 . . . . . . . . . . 807

索引 . . . . . . . . . . . . . . . 811

目次 vii

viii 管理 API リファレンス

本書について

本書には、データベース管理機能を実行するためのアプリケーション・プログラミング・インターフェース (API) の使用に関する情報を記載しています。以下のプログラミング言語で作成されたアプリケーションでのデータベース・マネージャーAPI 呼び出しの使用について詳しく説明しています。

v Cv C++v COBOLv FORTRANv REXX

コンパイルされる言語には、ステートメントを処理できる適切なプリコンパイラーが必要です。サポートされるすべての言語についてプリコンパイラーが提供されています。

本書の対象読者読者はデータベースの管理とアプリケーション・プログラミングを理解していることに加えて、読者に以下の知識があることを前提としています。

v 構造化照会言語 (SQL)v C、C++、COBOL、FORTRAN、または REXX プログラミング言語、あるいはこれらのすべてのプログラミング言語

v アプリケーション・プログラム設計

本書の構成本書には、アプリケーション開発で管理 API を使用するために必要な参照情報を記載しています。

本書の各章で説明する主なサブジェクト・エリアは、以下のとおりです。

管理 API およびデータ構造の概要

v 第 1 章『DB2® API』には、管理 API、インクルード・ファイル、およびサンプル・プログラムの一覧表があります。

v 第 2 章『変更された API およびデータ構造』では、サポートされるおよびサポートされない API とデータ構造のうち、これまでに変更されたものについて一覧表にまとめています。

v 第 3 章『API の説明の編成方法』では、API の説明の編成方法を説明し、DB2 API アプリケーションのインクルード・ファイルをリストしています。

API

v 第 4 章『管理 API』では、DB2 管理 API をアルファベット順にリストしています。

© Copyright IBM Corp. 1993, 2013 ix

v 第 5 章『REXX での DB2 API の呼び出し』では、REXX アプリケーションから DB2 API を呼び出す方法について説明しています。

v 第 6 章『未確定トランザクション管理 API』では、ツール・ライターが未確定トランザクションに対してヒューリスティック機能を実行するための API のセットを説明しています。

v 第 7 章『並行アクセスを伴うスレッド化アプリケーション』では、スレッド化アプリケーションで使用できる DB2 API について説明しています。

プラグイン API

v 第 8 章『データベース管理のカスタマイズのための DB2 データベース・システム・プラグイン』では、読者およびサード・パーティー・ベンダーが特定のデータベース管理機能をカスタマイズするために使用できる、セキュリティー、バックアップ、リストア、ログ・アーカイブ、およびバックアップ・イメージの圧縮/解凍に関するプラグイン API について説明しています。

データ構造

v 第 9 章『API で使用されるデータ構造』では、API で使用されるデータ構造について説明しています。

付録

v 付録 A『プリコンパイラーのカスタマイズ API』には、他のアプリケーション開発ツールがそれらの製品内に DB2 用のプリコンパイラー・サポートを直接インプリメントするための文書化された API のセットに関する情報へのリンクがあります。

v 付録 B『DB2 ログ・レコード』では、さまざまな DB2 ログ・レコードの構造について説明しています。

強調表記規則本書では、以下の強調表記規則を使用します。

太字コマンド、キーワード、および名前がシステムによって事前定義されている他の項目を表します。

イタリック以下のいずれかの値を示します。

v ユーザーが指定する必要のある名前または値 (変数)v 一般的な強調v 新しい用語の紹介v 他の情報源の参照

本書の構成

x 管理 API リファレンス

モノスペース以下のいずれかの値を示します。

v ファイルおよびディレクトリーv コマンド・プロンプトまたはウィンドウでユーザーが入力する必要のある情報

v 特定のデータ値の例v システムで表示されるものと類似したテキストの例v システム・メッセージの例v プログラミング・コードのサンプル

強調表記規則

本書について xi

強調表記規則

xii 管理 API リファレンス

第 1 章 DB2 API

DB2 サンプル内で示されている DB2 API をリストします。

重要: マルチスレッド・アプリケーションでは DB2 管理 API はサポートされていません。ただし、DB2 コンテキスト API を使用して、スレッドのシリアライゼーションを明示的に管理する場合は例外です。 DB2 管理 API を DB2 コンテキストAPI と一緒に使用する代わりに、SYSPROC.ADMIN_CMD ストアード・プロシージャーを使用して、DB2 データベース・マネージャーのマルチスレッド・アプリケーション・サポートによって、コンテキストを自動管理します。マルチスレッド・アプリケーション・サポートの詳細と、スレッド化されたアプリケーションの並行アクセスによるコンテキストの使用については、「組み込み SQL アプリケーションの開発」の『組み込み SQL アプリケーションにおける並行トランザクションおよびマルチスレッド・データベース・アクセス』を参照してください。

最初の表は、DB2 API をリストしています。これは、機能カテゴリー、対応するインクルード・ファイル、およびそれを例示するサンプル・プログラムごとにグループ分けしています (インクルード・ファイルの詳細については、表の後にある注を参照してください)。 2 番目の表は C/C++ サンプル・プログラムをリストしています。ここでは、各 C/C++ プログラムで例示されている DB2 API を示します。 3番目の表は COBOL サンプル・プログラムおよび各 COBOL プログラムで例示されている DB2 API を示します。

DB2 API、インクルード・ファイル、およびサンプル・プログラム表 1.

DB2 API を使用した C/C++ サンプル・プログラム13ページの表 2.

DB2 API を使用した COBOL サンプル・プログラム17ページの表 3.

表 1. DB2 API、インクルード・ファイル、およびサンプル・プログラム

API のタイプ DB2 APIインクルード・ファイルサンプル・プログラム

データベース制御API

78ページの『db2DatabaseQuiesce - データベースの静止』

db2ApiDf n/a


83ページの『db2DatabaseUnquiesce -データベースの静止解除』

db2ApiDf n/a


80ページの『db2DatabaseRestart - データベースの再始動』

db2ApiDf C: dbconn.sqc C++: dbconn.sqC


426ページの『sqlecrea - データベースの作成』

sqlenv C: dbcreate.c dbrecov.sqc

dbsample.sqc C++: dbcreate.C

dbrecov.sq COBOL: db_udcs.cbl

dbconf.cbl ebcdicdb.cbl


424ページの『sqlecran - データベース・パーティション・サーバー上へのデータベース作成』

sqlenv n/a

© Copyright IBM Corp. 1993, 2013 1

表 1. DB2 API、インクルード・ファイル、およびサンプル・プログラム (続き)



443ページの『sqledrpd - データベースのドロップ』

sqlenv C: dbcreate.c C++: dbcreate.C COBOL:

dbconf.cbl


441ページの『sqledpan - データベース・パーティション・サーバーでのデータベースのドロップ』

sqlenv n/a


85ページの『db2DatabaseUpgrade - 前のバージョンの DB2 データベースの現行リリースへのアップグレード』

db2ApiDf C: dbupgrade.c C++: dbupgrade.C

COBOL: dbupgrade.cbl


516ページの『db2XaListIndTrans - 未確定トランザクションのリスト』

db2ApiDf n/a


403ページの『sqle_activate_db - データベースのアクティブ化』

sqlenv n/a


406ページの『sqle_deactivate_db - データベースの非活動化』

sqlenv n/a


402ページの『sqlcspqy - DRDA 未確定トランザクションのリスト』

sqlxa n/a


344ページの『db2SetWriteForDB - データベースの入出力書き込みの中断または再開』

db2ApiDf n/a


449ページの『sqlefrce - システムからのユーザーおよびアプリケーションの強制終了』

sqlenv C: dbconn.sqc dbsample.sqc instart.c

C++: dbconn.sqC instart.C COBOL:

dbstop.cbl

インスタンス制御API

191ページの『db2InstanceStart - インスタンスの開始』

db2ApiDf C: instart.c C++: instart.C


198ページの『db2InstanceStop - インスタンスの停止』

db2ApiDf C: instart.c C++: instart.C


188ページの『db2InstanceQuiesce - インスタンスの静止』

db2ApiDf n/a


203ページの『db2InstanceUnquiesce -インスタンスの静止解除』

db2ApiDf n/a


415ページの『sqleatin - インスタンスへのアタッチ』

sqlenv C: inattach.c utilapi.c C++:

inattach.C utilapi.C COBOL:

dbinst.cbl


412ページの『sqleatcp - インスタンスへのアタッチとパスワードの変更』

sqlenv C: inattach.c C++: inattach.C COBOL:

dbinst.cbl


447ページの『sqledtin - インスタンスからのデタッチ』

sqlenv C: inattach.c utilapi.c C++:

inattach.C utilapi.C COBOL:

dbinst.cbl


462ページの『sqlegins - 現行インスタンスの取得』

sqlenv C: ininfo.c C++: ininfo.C COBOL:

dbinst.cbl


367ページの『db2UtilityControl - 実行されているユーティリティーの優先順位の設定』

db2ApiDf n/a

DB2 API

2 管理 API リファレンス



データベース・マネージャーおよびデータベース構成API

65ページの『db2CfgGet - データベース・マネージャー構成パラメーター、あるいはデータベース構成パラメーターの取得』

db2ApiDf C: dbinfo.c dbrecov.sqc ininfo.c

tscreate.sqc C++: dbinfo.C

dbrecov.sqC ininfo.C tscreate.sqC


68ページの『db2CfgSet - データベース・マネージャー構成パラメーター、あるいはデータベース構成パラメーターの設定』

db2ApiDf C: dbinfo.c dbrecov.sqc ininfo.c C++:

dbinfo.C dbrecov.sqC ininfo.C


49ページの『db2AutoConfig - 構成アドバイザーへのアクセス』

db2AuCfg C: dbcfg.sqc C++: dbcfg.sqC


53ページの『db2AutoConfigFreeMemory -db2AutoConfig API によって割り振られたメモリーの解放』

db2AuCfg C: dbcfg.sqc C++: dbcfg.sqC

データベース・モニター API

129ページの『db2GetSnapshotSize -db2GetSnapshot API に必要な出力バッファー・サイズの見積もり』

db2ApiDf n/a


42ページの『db2AddSnapshotRequest -スナップショット要求の追加』

db2ApiDf n/a


254ページの『db2MonitorSwitches - モニター・スイッチ設定の取得あるいは更新』

db2ApiDf C: utilsnap.c C++: utilsnap.C


125ページの『db2GetSnapshot - データベース・マネージャー操作状況のスナップショットの取得』



297ページの『db2ResetMonitor - データベース・システム・モニターのデータのリセット』

db2ApiDf n/a


73ページの『db2ConvMonStream - バージョン 6 以前の形式へのモニター・ストリームの変換』

db2ApiDf n/a


180ページの『db2Inspect - データベースの構造上の整合性の検査』

db2ApiDf n/a

データベース・ヘルス・モニターAPI

38ページの『db2AddContact - 通知メッセージを送信できる連絡先の追加』

db2ApiDf n/a


40ページの『db2AddContactGroup - 通知メッセージを送信できる連絡先グループの追加』

db2ApiDf n/a


94ページの『db2DropContact - 通知メッセージを送信できる連絡先リストからの連絡先の削除』

db2ApiDf n/a

DB2 API

第 1 章管理 API 3




95ページの『db2DropContactGroup -通知メッセージを送信できる連絡先リストからの連絡先グループの削除』

db2ApiDf n/a


105ページの『db2GetAlertCfg - ヘルス・インディケーターのアラート構成設定の取得』

db2ApiDf n/a


110ページの『db2GetAlertCfgFree -db2GetAlertCfg API によって割り振られたメモリーの解放』

db2ApiDf n/a


111ページの『db2GetContactGroup -通知メッセージを送信できる単一の連絡先グループ中の連絡先のリストの取得』

db2ApiDf n/a


113ページの『db2GetContactGroups -通知メッセージを送信できる連絡先グループのリストの取得』

db2ApiDf n/a


115ページの『db2GetContacts - 通知メッセージを送信できる連絡先リストの取得』

db2ApiDf n/a


119ページの『db2GetHealthNotificationList - ヘルス・アラート通知を送信できる連絡先リストの取得』

db2ApiDf n/a


295ページの『db2ResetAlertCfg - ヘルス・インディケーターのアラート構成のリセット』

db2ApiDf n/a


353ページの『db2UpdateAlertCfg - ヘルス・インディケーターのアラート構成設定の更新』

db2ApiDf n/a


361ページの『db2UpdateContact - 連絡先の属性の更新』

db2ApiDf n/a


363ページの『db2UpdateContactGroup- 連絡先グループの属性の更新』

db2ApiDf n/a


365ページの『db2UpdateHealthNotificationList - ヘルス・アラート通知を送信できる連絡先リストの更新』

db2ApiDf n/a


125ページの『db2GetSnapshot - データベース・マネージャー操作状況のスナップショットの取得』



129ページの『db2GetSnapshotSize -db2GetSnapshot API に必要な出力バッファー・サイズの見積もり』

db2ApiDf n/a

DB2 API





121ページの『db2GetRecommendations- アラート状態のヘルス・インディケーターを解決するための推奨の入手』

db2ApiDf n/a


124ページの『db2GetRecommendationsFree -db2GetRecommendations API によって割り振られたメモリーの解放』

db2ApiDf n/a

データ移動 API 97ページの『db2Export - データベースからのデータのエクスポート』

sqlutil C: tbmove.sqc C++: tbmove.sqC COBOL:

expsamp.sqb impexp.sqb tload.sqb

データ移動 API 151ページの『db2Import - 表、階層、ニックネーム、ビューへのデータのインポート』

db2ApiDf C: dtformat.sqc tbmove.sqc C++:

tbmove.sqC COBOL: expsamp.sqb

impexp.sqb

データ移動 API 222ページの『db2Load - 表へのデータのロード』

db2ApiDf C: dtformat.sqc tbload.sqc tbmove.sqc

C++: tbmove.sqC

データ移動 API 246ページの『db2LoadQuery - ロード操作の状況の取得』

db2ApiDf C: tbmove.sqc C++: tbmove.sqC COBOL:

loadqry.sqb

データ移動 API db2Ingest API - 入力ファイルまたは入力パイプから DB2 表へのデータの取り込み (INGEST)

db2ApiDf n/a

リカバリー API 54ページの『db2Backup - データベースまたは表スペースのバックアップ』

db2ApiDf C: dbrecov.sqc C++: dbrecov.sqC

リカバリー API 300ページの『db2Restore - データベースまたは表スペースのリストア』


リカバリー API 277ページの『db2Recover - データベースのリストアおよびロールフォワード』

db2ApiDf n/a

リカバリー API 317ページの『db2Rollforward - データベースのロールフォワード』


リカバリー API 143ページの『db2HistoryOpenScan -データベース履歴レコードのスキャンの開始』


リカバリー API 141ページの『db2HistoryGetEntry - データベース履歴レコードの次の項目の取得』


リカバリー API 140ページの『db2HistoryCloseScan -データベース履歴レコードのスキャンの終了』


リカバリー API 257ページの『db2Prune - 履歴ファイル項目の削除、あるいはアクティブ・ログ・パスからのログ・ファイルの削除』


リカバリー API 147ページの『db2HistoryUpdate - データベース履歴レコード項目の更新』


DB2 API




リカバリー API 46ページの『db2ArchiveLog - アクティブ・ログ・ファイルのアーカイブ』

db2ApiDf n/a

高可用性災害時リカバリー(HADR) API

133ページの『db2HADRStart - 高可用性災害時リカバリー (HADR) 操作の開始』

db2ApiDf n/a


135ページの『db2HADRStop - 高可用性災害時リカバリー (HADR) 操作の停止』

db2ApiDf n/a


137ページの『db2HADRTakeover - データベースへの高可用性災害時リカバリー (HADR) 1 次データベースとしてのテークオーバーの指示』

db2ApiDf n/a

データベース・ディレクトリーおよび DCS ディレクトリー管理 API

418ページの『sqlecadb - システム・データベース・ディレクトリーへのデータベースのカタログ』


dbcat.cbl


486ページの『sqleuncd - システム・データベース・ディレクトリーからのデータベースのアンカタログ』


dbcat.cbl


452ページの『sqlegdad - データベース接続サービス (DCS) ディレクトリーへのデータベースのカタログ』


dcscat.cbl


455ページの『sqlegdel - データベース接続サービス (DCS) ディレクトリーからのデータベースのアンカタログ』


dcscat.cbl


438ページの『sqledcgd - システム・データベース・ディレクトリーまたはローカル・データベース・ディレクトリー内のデータベース・コメントの変更』


dbcmt.cbl


92ページの『db2DbDirOpenScan - システム・データベース・ディレクトリーまたはローカル・データベース・ディレクトリーのスキャンの開始』

db2ApiDf C: ininfo.c C++: ininfo.C COBOL:

dbcat.cbl dbcmt.cbl


88ページの『db2DbDirGetNextEntry -次のシステム・データベース・ディレクトリー、あるいはローカル・データベース・ディレクトリー項目の取得』


dbcat.cbl dbcmt.cbl


87ページの『db2DbDirCloseScan - システム・データベース・ディレクトリーまたはローカル・データベース・ディレクトリーのスキャンの終了』


dbcat.cbl dbcmt.cbl

DB2 API





461ページの『sqlegdsc - データベース接続サービス (DCS) ディレクトリーのスキャンの開始』


dcscat.cbl


459ページの『sqlegdgt - データベース接続サービス (DCS) ディレクトリーの項目の取得』


dcscat.cbl


454ページの『sqlegdcl - データベース接続サービス (DCS) ディレクトリーのスキャンの終了』


dcscat.cbl


457ページの『sqlegdge - データベース接続サービス (DCS) ディレクトリーの特定項目の取得』


dcscat.cbl


359ページの『db2UpdateAlternateServerForDB - システム・データベース・ディレクトリー内のデータベース別名の代替サーバーの更新』

db2ApiDf n/a

クライアント/サーバー管理 API

473ページの『sqleqryc - クライアント接続設定の照会』

sqlenv C: cli_info.c C++: cli_info.C COBOL:

client.cbl


475ページの『sqleqryi - クライアント情報の照会』

sqlenv C: cli_info.c C++: cli_info.C


480ページの『sqlesetc - クライアント接続設定の指定』

sqlenv C: cli_info.c dbcfg.sqc dbmcon.sqc

C++: cli_info.C dbcfg.sqC dbmcon.sqC

COBOL: client.cbl


483ページの『sqleseti - クライアント情報の設定』

sqlenv C: cli_info.c C++: cli_info.C


477ページの『sqlesact - アカウンティング・ストリングの設定』

sqlenv COBOL: setact.cbl


76ページの『db2DatabasePing - ネットワーク応答時間のテストのためのデータベースの ping』

db2ApiDf n/a


465ページの『sqleisig - シグナル・ハンドラーのインストール』

sqlenv COBOL: dbcmt.cbl


463ページの『sqleintr - アプリケーション要求への割り込み』

sqlenv n/a

Lightweight

Directory Access

Protocol (LDAP)

ディレクトリー管理 API

210ページの『db2LdapRegister - DB2サーバーの LDAP サーバーへの登録』

db2ApiDf n/a

DB2 API




Lightweight

Directory Access

Protocol (LDAP)


216ページの『db2LdapUpdate - LDAPサーバー上の DB2 サーバーの属性の更新』

db2ApiDf n/a

Lightweight

Directory Access

Protocol (LDAP)


209ページの『db2LdapDeregister -LDAP サーバーからの DB2 サーバーおよびカタログされたデータベースの登録解除』

db2ApiDf n/a

Lightweight

Directory Access

Protocol (LDAP)


208ページの『db2LdapCatalogNode -LDAP サーバーにあるノード名の別名の指定』

db2ApiDf n/a

Lightweight

Directory Access

Protocol (LDAP)


215ページの『db2LdapUncatalogNode -LDAP サーバーからのノード名に対応する別名の削除』

db2ApiDf n/a

Lightweight

Directory Access

Protocol (LDAP)


205ページの『db2LdapCatalogDatabase- LDAP サーバーへのデータベースの登録』

db2ApiDf n/a

Lightweight

Directory Access

Protocol (LDAP)


214ページの『db2LdapUncatalogDatabase - LDAPサーバーからのデータベース登録の解除』

db2ApiDf n/a

Lightweight

Directory Access

Protocol (LDAP)


220ページの『db2LdapUpdateAlternateServerForDB -LDAP サーバーでのデータベースに対応する代替サーバーの更新』

db2ApiDf n/a

アプリケーション・プログラミングおよび準備API

372ページの『sqlaintp - エラー・メッセージの入手』

sql C: dbcfg.sqcutilapi.c C++: dbcfg.sqC

utilapi.C COBOL: checkerr.cbl


493ページの『sqlogstt - SQLSTATEメッセージの入手』

sql C: utilapi.c C++: utilapi.C COBOL:

checkerr.cbl

DB2 API





465ページの『sqleisig - シグナル・ハンドラーのインストール』

sqlenv COBOL: dbcmt.cbl


463ページの『sqleintr - アプリケーション要求への割り込み』

sqlenv n/a


374ページの『sqlaprep - アプリケーション・プログラムのプリコンパイル』

sql C: dbpkg.sqc C++: dbpkg.sqC


369ページの『sqlabndx - アプリケーション・プログラムのバインドによるパッケージの作成』

sql C: dbpkg.sqc dbsample.sqc C++:

dbpkg.sqC


377ページの『sqlarbnd - パッケージの再バインド』

sql C: dbpkg.sqc C++: dbpkg.sqC COBOL:

rebind.sqb

COBOL、FORTRAN、REXX アプリケーション固有API

490ページの『sqlgaddr - 変数のアドレスの取得』

sqlutil n/a


491ページの『sqlgdref - アドレスの間接参照』

sqlutil n/a


492ページの『sqlgmcpy - あるメモリー領域から別のメモリー領域へデータのコピー』

sqlutil n/a

表スペースおよび表管理 API

400ページの『sqlbtcq - すべての表スペース・コンテナーの照会データの取得』このコマンドまたは API は推奨されておらず、今後のリリースで除去される可能性があります。置換関数を使用するサンプル・プログラムについては、tsinfo.db2 tsinfo.db2 を参照してください。

sqlutil n/a


390ページの『sqlbotcq - 表スペース・コンテナー照会のオープン』

sqlutil COBOL: tabscont.sqb tspace.sqb

DB2 API





382ページの『sqlbftcq - 表スペース・コンテナー中の行の照会データの取得』



380ページの『sqlbctcq - 表スペース・コンテナー照会のクローズ』



397ページの『sqlbstsc - 表スペース・コンテナーの設定』

sqlutil C: dbrecov.sqc C++: dbrecov.sqC

COBOL: tabscont.sqb tspace.sqb


388ページの『sqlbmtsq - すべての表スペースの照会データの取得』このコマンドまたは API は推奨されておらず、今後のリリースで除去される可能性があります。置換関数を使用するサンプル・プログラムについては、tsinfo.db2 tsinfo.db2 を参照してください。

sqlutil n/a


395ページの『sqlbstpq - 単一の表スペースに関する情報の取得』

sqlutil COBOL: tabspace.sqb tspace.sqb


392ページの『sqlbotsq - 表スペース照会のオープン』このコマンドまたはAPI は推奨されておらず、今後のリリースで除去される可能性があります。

sqlutil n/a


384ページの『sqlbftpq - 表スペース中の行の照会データのフェッチ』

sqlutil COBOL: tabspace.sqb tspace.sqb


381ページの『sqlbctsq - 表スペース照会のクローズ』このコマンドまたはAPI は推奨されておらず、今後のリリースで除去される可能性があります。

sqlutil n/a


このコマンドまたは API は非推奨となっており、将来のリリースで削除される可能性があります。

sqlutil n/a


505ページの『sqluvqdp - 表の表スペースの静止』

sqlutil C: tbmove.sqc C++: tbmove.sqC COBOL:

tload.sqb


329ページの『db2Runstats - 表および索引の統計情報の更新』

db2ApiDf C: tbreorg.sqc C++: tbreorg.sqC

COBOL: dbstat.sqb


284ページの『db2Reorg - 索引または表の再編成』

db2ApiDf C: tbreorg.sqc C++: tbreorg.sqC

COBOL: dbstat.sqb


448ページの『sqlefmem - sqlbtcq および sqlbmtsq API によって割り振られたメモリーの解放』

sqlenv C: dbrecov.sqc C++: dbrecov.sqC

COBOL: tabscont.sqb tabspace.sqb

tspace.sqb

ノード・ディレクトリー管理 API

435ページの『sqlectnd - ノード・ディレクトリーへの項目のカタログ』


nodecat.cbl


488ページの『sqleuncn - ノード・ディレクトリーからの項目のアンカタログ』


nodecat.cbl

DB2 API





471ページの『sqlenops - ノード・ディレクトリー・スキャンの開始』


nodecat.cbl


469ページの『sqlengne - ノード・ディレクトリー次項目の入手』


nodecat.cbl


468ページの『sqlencls - ノード・ディレクトリー・スキャンの終了』


nodecat.cbl


359ページの『db2UpdateAlternateServerForDB - システム・データベース・ディレクトリー内のデータベース別名の代替サーバーの更新』

db2ApiDf n/a

サテライト同期API

132ページの『db2GetSyncSession - サテライト同期化セッション ID の取得』

db2ApiDf n/a


260ページの『db2QuerySatelliteProgress- サテライト同期セッションの状況の取得』

db2ApiDf n/a


343ページの『db2SetSyncSession - サテライト同期セッションの設定』

db2ApiDf n/a


350ページの『db2SyncSatellite - サテライト同期化の開始』

db2ApiDf n/a


351ページの『db2SyncSatelliteStop -サテライト同期化の一時停止』

db2ApiDf n/a


352ページの『db2SyncSatelliteTest -サテライトが同期化可能かのテスト』

db2ApiDf n/a

ログ・ファイル読み取り API

262ページの『db2ReadLog - ログ・レコードの読み取り』



269ページの『db2ReadLogNoConn -データベース接続なしのデータベース・ログの読み取り』

db2ApiDf n/a


273ページの『db2ReadLogNoConnInit- データベース接続なしのデータベース・ログ読み取りの初期設定』

db2ApiDf n/a


276ページの『db2ReadLogNoConnTerm- データベース接続なしのデータベース・ログの読み取り終了』

db2ApiDf n/a

未確定トランザクション管理 API

516ページの『db2XaListIndTrans - 未確定トランザクションのリスト』

db2ApiDf n/a


522ページの『sqlxhfrg - トランザクション状況の forget』

sqlxa n/a


523ページの『sqlxphcm - 未確定トランザクションのコミット』

sqlxa n/a


524ページの『sqlxphrl - 未確定トランザクションのロールバック』

sqlxa n/a

DB2 API





402ページの『sqlcspqy - DRDA 未確定トランザクションのリスト』

sqlxa n/a

データベースへの並行アクセス取得のための API

526ページの『sqleAttachToCtx - コンテキストへのアタッチ』

sql C: dbthrds.sqc C++: dbthrds.sqC


527ページの『sqleBeginCtx - アプリケーション・コンテキストの作成およびアタッチ』



529ページの『sqleDetachFromCtx - コンテキストからのデタッチ』



530ページの『sqleEndCtx - 特定のアプリケーション・コンテキストに関連付けられているメモリーのデタッチと解放』

sql n/a


532ページの『sqleGetCurrentCtx - 現行コンテキストの入手』

sql n/a


533ページの『sqleInterruptCtx - コンテキストへの割り込み』

sql n/a


534ページの『sqleSetTypeCtx - アプリケーション・コンテキスト・タイプの設定』


データベース・パーティション管理API

409ページの『sqleaddn - パーティション・データベース環境へのデータベース・パーティションの追加』

sqlenv n/a


445ページの『sqledrpn - データベース・パーティション・サーバーがドロップ可能かどうかの検査』

sqlenv n/a


424ページの『sqlecran - データベース・パーティション・サーバー上へのデータベース作成』

sqlenv n/a


441ページの『sqledpan - データベース・パーティション・サーバーでのデータベースのドロップ』

sqlenv n/a


478ページの『sqlesdeg - SQL ステートメントの最大実行時パーティション内並列処理レベル (つまり並列処理の程度) の設定』

sqlenv C: ininfo.c C++: ininfo.C


503ページの『sqlugtpi - 表の分散情報の取得』

sqlutil n/a

DB2 API





499ページの『sqlugrpn - 特定の行についてのデータベース・パーティション・サーバー番号の取得』

sqlutil n/a

その他の API 44ページの『db2AdminMsgWrite - 管理およびレプリケーション機能のためのログ・メッセージの書き込み』

db2ApiDf n/a

その他の API 515ページの『db2XaGetInfo - リソース・マネージャー情報の入手』

sqlxa n/a

注: インクルード・ファイルの拡張子はプログラミング言語ごとに異なります。 C/C++ インクルード・ファイルのファイル拡張子は .h です。COBOL インクルード・ファイルのファイル拡張子は .cbl です。インクルード・ファイルは、以下のディレクトリーで検索できます。

C/C++ (UNIX):

sqllib/include

C/C++ (Windows):

sqllib¥include

COBOL (UNIX):

sqllib/include/cobol_a

sqllib/include/cobol_i

sqllib/include/cobol_mf

COBOL (Windows):

sqllib¥include¥cobol_a

sqllib¥include¥cobol_i

sqllib¥include¥cobol_mf

表 2. DB2 API を使用した C/C++ サンプル・プログラム

サンプル・プログラム組み込まれた API

cli_info.c,

cli_info.Cv sqlesetc API - クライアント接続設定の指定v sqleseti API - クライアント情報の設定v sqleqryc API - クライアント接続設定の照会v sqleqryi API - クライアント情報の照会

dbcfg.sqc,

dbcfg.sqCv db2AutoConfig API - 構成アドバイザーへのアクセスv db2AutoConfigFreeMemory API - db2AutoConfig API によって割り振られたメモリーの解放

v sqlesetc API - クライアント接続設定の指定v sqlaintp API - エラー・メッセージの入手

dbconn.sqc,

dbconn.sqCv db2DatabaseRestart API - データベースの再始動v sqlefrce API - システムからのユーザーおよびアプリケーションの強制終了

DB2 API


表 2. DB2 API を使用した C/C++ サンプル・プログラム (続き)


dbcreate.c,

dbcreate.Cv sqlecrea API - データベースの作成v sqledrpd API - データベースのドロップ

dbinfo.c, dbinfo.C v db2CfgGet API - データベース・マネージャー構成パラメーター、あるいはデータベース構成パラメーターの取得

v db2CfgSet API - データベース・マネージャー構成パラメーター、あるいはデータベース構成パラメーターの設定

dbmcon.sqc,

dbmcon.sqCv sqlesetc API - クライアント接続設定の指定

dbmigrat.c,

dbmigrat.Cv sqlemgdb API - 前のバージョンの DB2 データベースの現行バージョンへのマイグレーション

dbpkg.sqc,

dbpkg.sqCv sqlaprep API - アプリケーション・プログラムのプリコンパイルv sqlabndx API - アプリケーション・プログラムのバインドによるパッケージの作成

v sqlarbnd API - パッケージの再バインドdbrecov.sqc,

dbrecov.sqCv db2HistoryCloseScan API - 履歴ファイルのスキャンの終了v db2HistoryGetEntry API - 履歴ファイルの次の項目の取得v db2HistoryOpenScan API - 履歴ファイルのスキャンの開始v db2HistoryUpdate API - 履歴ファイルの項目の更新v db2Prune API - 履歴ファイル項目の削除、あるいはアクティブ・ログ・パスからのログ・ファイルの削除

v db2CfgGet API - データベース・マネージャー構成パラメーター、あるいはデータベース構成パラメーターの取得


v sqlbmtsq API - すべての表スペースの照会データの取得v sqlbstsc API - 表スペース・コンテナーの設定v sqlbtcq API - すべての表スペース・コンテナーの照会データの取得v sqlecrea API - データベースの作成v sqledrpd API - データベースのドロップv sqlefmem API - sqlbtcq および sqlbmtsq API によって割り振られたメモリーの解放

v db2Backup API - データベースまたは表スペースのバックアップv db2Restore API - データベースまたは表スペースのリストアv db2ReadLog API - ログの非同期読み取りv db2ReadLogNoConn API - データベース接続なしのログの読み取りv db2Rollforward API - データベースのロールフォワード

DB2 API




dbsample.sqc v db2DatabaseRestart API - データベースの再始動v sqlecrea API - データベースの作成v sqlefrce API - システムからのユーザーおよびアプリケーションの強制終了

v sqlabndx API - アプリケーション・プログラムのバインドによるパッケージの作成

dbthrds.sqc,

dbthrds.sqCv sqleAttachToCtx API - コンテキストへのアタッチv sqleBeginCtx API - アプリケーション・コンテキストの作成およびアタッチ

v sqleDetachFromCtx API - コンテキストからのデタッチv sqleSetTypeCtx API - アプリケーション・コンテキスト・タイプの設定

dtformat.sqc v db2Load API - 表へのデータのロードv db2Import API - 表、階層、ニックネーム、ビューへのデータのインポート

inattach.c,

inattach.Cv sqleatcp API - インスタンスへのアタッチとパスワードの変更v sqleatin API - インスタンスへのアタッチv sqledtin API - インスタンスからのデタッチ

DB2 API




ininfo.c, ininfo.C v db2CfgGet API - データベース・マネージャー構成パラメーター、あるいはデータベース構成パラメーターの取得


v sqlegins API - 現行インスタンスの取得v sqlectnd API - ノード・ディレクトリーへの項目のカタログv sqlenops API - ノード・ディレクトリー・スキャンの開始v sqlengne API - ノード・ディレクトリー次項目の入手v sqlencls API - ノード・ディレクトリー・スキャンの終了v sqleuncn API - ノード・ディレクトリーからの項目のアンカタログv sqlecadb API - システム・データベース・ディレクトリーへのデータベースのカタログ

v db2DbDirOpenScan API - システム・データベース・ディレクトリーまたはローカル・データベース・ディレクトリーのスキャンの開始

v db2DbDirGetNextEntry API - 次のシステム・データベース・ディレクトリー、あるいはローカル・データベース・ディレクトリー項目の取得

v sqledcgd API - システム・データベース・ディレクトリーまたはローカル・データベース・ディレクトリー内のデータベース・コメントの変更

v db2DbDirCloseScan API - システム・データベース・ディレクトリーまたはローカル・データベース・ディレクトリーのスキャンの終了

v sqleuncd API - システム・データベース・ディレクトリーからのデータベースのアンカタログ

v sqlegdad API - データベース接続サービス (DCS) ディレクトリーへのデータベースのカタログ

v sqlegdsc API - データベース接続サービス (DCS) ディレクトリーのスキャンの開始

v sqlegdge API - データベース接続サービス (DCS) ディレクトリーの特定項目の取得

v sqlegdgt API - データベース接続サービス (DCS) ディレクトリーの項目の取得

v sqlegdcl API - データベース接続サービス (DCS) ディレクトリーのスキャンの終了

v sqlegdel API - データベース接続サービス (DCS) ディレクトリーからのデータベースのアンカタログ

v sqlesdeg API - SQL ステートメントの最大実行時パーティション内並列処理レベル (つまり並列処理の程度) の設定

DB2 API




instart.c,

instart.Cv sqlefrce API - システムからのユーザーおよびアプリケーションの強制終了

v db2InstanceStart API - インスタンスの開始v db2InstanceStop API - インスタンスの停止

tbmove.sqc,

tbmove.sqCv db2Export API - データベースからのデータのエクスポートv db2Import API - 表、階層、ニックネーム、ビューへのデータのインポート

v sqluvqdp API - 表の表スペースの静止v db2Load API - 表へのデータのロードv db2LoadQuery API - ロード操作の状況の取得

tbreorg.sqc,

tbreorg.sqCv db2Reorg API - 索引または表の再編成v db2Runstats API - 表および関連する索引の特性についての統計の更新

tscreate.sqc,

tscreate.sqCv db2CfgGet API - データベース・マネージャー構成パラメーター、あるいはデータベース構成パラメーターの取得

utilapi.c,

utilapi.Cv sqlaintp API - エラー・メッセージの入手v sqlogstt API - SQLSTATE メッセージの入手v sqleatin API - インスタンスへのアタッチv sqledtin API - インスタンスからのデタッチ

utilsnap.c,

utilsnap.Cv db2GetSnapshot API - データベース・マネージャー操作状況のスナップショットの取得

v db2MonitorSwitches API - モニター・スイッチ設定の取得あるいは更新

表 3. DB2 API を使用した COBOL サンプル・プログラム


checkerr.cbl v sqlaintp API - エラー・メッセージの入手v sqlogstt API - SQLSTATE メッセージの入手

client.cbl v sqleqryc API - クライアント接続設定の照会v sqlesetc API - クライアント接続設定の指定

db_udcs.cbl v sqleatin API - インスタンスへのアタッチv sqlecrea API - データベースの作成v sqledrpd API - データベースのドロップ

DB2 API


表 3. DB2 API を使用した COBOL サンプル・プログラム (続き)


dbcat.cbl v sqlecadb API - システム・データベース・ディレクトリーへのデータベースのカタログ




v sqleuncd API - システム・データベース・ディレクトリーからのデータベースのアンカタログ

dbcmt.cbl v sqledcgd API - システム・データベース・ディレクトリーまたはローカル・データベース・ディレクトリー内のデータベース・コメントの変更




v sqleisig API - シグナル・ハンドラーのインストールdbinst.cbl v sqleatcp API - インスタンスへのアタッチとパスワードの変更

v sqleatin API - インスタンスへのアタッチv sqledtin API - インスタンスからのデタッチv sqlegins API - 現行インスタンスの取得

dbstat.sqb v db2Reorg API - 索引または表の再編成v db2Runstats API - 表および関連する索引の特性についての統計の更新

DB2 API




dcscat.cbl v sqlegdad API - データベース接続サービス (DCS) ディレクトリーへのデータベースのカタログ

v sqlegdcl API - データベース接続サービス (DCS) ディレクトリーのスキャンの終了

v sqlegdel API - データベース接続サービス (DCS) ディレクトリーからのデータベースのアンカタログ

v sqlegdge API - データベース接続サービス (DCS) ディレクトリーの特定項目の取得

v sqlegdgt API - データベース接続サービス (DCS) ディレクトリーの項目の取得

v sqlegdsc API - データベース接続サービス (DCS) ディレクトリーのスキャンの開始

ebcdicdb.cbl v sqleatin API - インスタンスへのアタッチv sqlecrea API - データベースの作成v sqledrpd API - データベースのドロップ

expsamp.sqb v db2Export API - データベースからのデータのエクスポートv db2Import API - 表、階層、ニックネーム、ビューへのデータのインポート

impexp.sqb v db2Export API - データベースからのデータのエクスポートv db2Import API - 表、階層、ニックネーム、ビューへのデータのインポート

loadqry.sqb v db2LoadQuery API - ロード操作の状況の取得migrate.cbl v sqlemgdb API - 前のバージョンの DB2 データベースの現行バージ

ョンへのマイグレーション

nodecat.cbl v sqlectnd API - ノード・ディレクトリーへの項目のカタログv sqlencls API - ノード・ディレクトリー・スキャンの終了v sqlengne API - ノード・ディレクトリー次項目の入手v sqlenops API - ノード・ディレクトリー・スキャンの開始v sqleuncn API - ノード・ディレクトリーからの項目のアンカタログ

rebind.sqb v sqlarbnd API - パッケージの再バインドtabscont.sqb v sqlbctcq API - 表スペース・コンテナー照会のクローズ

v sqlbftcq API - 表スペース・コンテナー中の行の照会データの取得v sqlbotcq API - 表スペース・コンテナー照会のオープンv sqlbtcq API - すべての表スペース・コンテナーの照会データの取得v sqlefmem API - sqlbtcq および sqlbmtsq API によって割り振られたメモリーの解放

DB2 API




tabspace.sqb v sqlbctsq API - 表スペース照会のクローズv sqlbftpq API - 表スペース中の行の照会データのフェッチv sqlbgtss API - 表スペースの使用率に関する統計の取得v sqlbmtsq API - すべての表スペースの照会データの取得v sqlbotsq API - 表スペース照会のオープンv sqlbstpq API - 単一の表スペースに関する情報の取得v sqlefmem API - sqlbtcq および sqlbmtsq API によって割り振られたメモリーの解放

tload.sqb v db2Export API - データベースからのデータのエクスポートv sqluvqdp API - 表の表スペースの静止

tspace.sqb v sqlbctcq API - 表スペース・コンテナー照会のクローズv sqlbctsq API - 表スペース照会のクローズv sqlbftcq API - 表スペース・コンテナー中の行の照会データの取得v sqlbftpq API - 表スペース中の行の照会データのフェッチv sqlbgtss API - 表スペースの使用率に関する統計の取得v sqlbmtsq API - すべての表スペースの照会データの取得v sqlbotcq API - 表スペース・コンテナー照会のオープンv sqlbotsq API - 表スペース照会のオープンv sqlbstpq API - 単一の表スペースに関する情報の取得v sqlbstsc API - 表スペース・コンテナーの設定v sqlbtcq API - すべての表スペース・コンテナーの照会データの取得v sqlefmem API - sqlbtcq および sqlbmtsq API によって割り振られたメモリーの解放

setact.cbl v sqlesact API - アカウンティング・ストリングの設定

DB2 API


第 2 章変更された API およびデータ構造

このセクションでは、変更された API およびデータ構造に関する情報を記載しています。

注: DB2 は既存のアプリケーションのバイナリー互換性と、以前のバージョンのスクリプト、SQL 照会、およびその他のサポートされているインターフェースとの互換性を提供します。ただし、API 構造と値が変更される可能性があるため、ソース・コード・ファイルで互換性の問題が発生することがあります。

表 4. バックレベルがサポートされた API およびデータ構造

API またはデータ構造 (バージョン) 記