DB2 CLI 関数の要約

表 29 では、DB2 Everyplace によってサポートされる DB2 CLI 関数 が要約してあります。要約の中で、各関数の目的のほか DB2 Everyplace によって サポートされる DB2 CLI 関数と標準の DB2 CLI 関数の相違点を示しています。

表 29. DB2 CLI 関数リスト

関数名 目的 相違点の要約
SQLAllocConnect 接続ハンドルを入手する。
SQLAllocEnv 環境ハンドルを入手する。
SQLAllocHandle ハンドルを入手する。
SQLAllocStmt ステートメント・ハンドルを割り当てる。
SQLBindCol 結果列用のストレージを割り当て、データ・タイプを指定する。 ターゲット・タイプは、サポートされるデータ・タイプに制限される。 LOB ロケーターをサポートしない。
SQLBindParameter SQL ステートメントのパラメーター用のストレージを割り当てる。 アプリケーション変数または LOB ロケーターの配列に対するバインディングを サポートしない。SQLPutData() をサポートしないので、アプリケーションはパラメーターの 値を ParameterValuePtr に入れてから、SQLExecute() を呼び出す必 要がある。 ストアード・プロシージャーがサポートされていないので、パラメーター・タイプは INPUT のみに制限される。
SQLColumns 指定された表に列名のリストを戻す。 CatalogNameNameLength1SchemaNameNameLength2 は無視される。戻された結果セットの列 2、12、および 15 は常に NULL である。戻りコード SQL_STILL_EXECUTING をサポートしない。
SQLConnect データ・ソース名、ユーザー ID、およびパスワードによって特定のドライバーに 接続する。
SQLDescribeCol 結果セット内の列について記述する。 列情報はサポートされる列データ・タイプに限定される。
SQLDisconnect 接続をクローズする。
SQLEndTran 接続に関連するすべてのステートメントのすべての操作に対し COMMIT または ROLLBACK を要求する。 SQLEndTran() を呼び出す前に、接続の属性 SQL_ATTR_AUTOCOMMIT を SQL_AUTOCOMMIT_OFF にセットしなければならない。
SQLError 追加のエラーまたは状況情報を戻す。
SQLExecDirect ステートメントを実行する。 戻りコードの SQL_STILL_EXECUTING と SQL_NEED_DATA をサポートしない。 非同期 CLI 呼び出しをサポートしない。
SQLExecute 準備済みステートメントを実行する。 SQLExecute() を呼び出す前に、すべてのパラメーターをバインドする必要がある。 SQL 呼び出しの非同期実行をサポートしない。
SQLFetch 結果行を戻す。 結果は、行セットごとではなく、一度に 1 行ずつ取り出される。 ステートメント記述子をサポートしない。戻りコード SQL_STILL_EXECUTING をサポートしない。
SQLFetchScroll 結果行セットを戻す。 結果は行セットで取り出される。戻りコード SQL_STILL_EXECUTING をサポートしない。
SQLForeignKeys 指定された表の外部キーに関する情報を戻す。 PKCatalogNameNameLength1PKSchemaNameNameLength2FKCatalogNameNameLength4FKSchemaNameNameLength5 は無視されます。戻された 結果セットの列 1、 2、5、6、12、および 13 は、常に長さがゼロのストリングです。 戻された結果セットの列 10、11、および 14 は常にゼロ。戻りコード SQL_STILL_EXECUTING をサポートしない。
SQLFreeConnect 接続ハンドルを解放する。
SQLFreeEnv 環境ハンドルを解放する。
SQLFreeHandle ハンドル・リソースを解放する。
SQLFreeStmt ステートメント処理を終了し、保留中の結果を廃棄し、オプショナルで、 ステートメント・ハンドルに関連したすべてのリソースを解放する。 SQL_DROP および SQL_RESET_PARAMS オプションのみをサポートする。
SQLGetConnectAttr 接続属性の現行の設定を戻す。 DB2 Everyplace は、DB2 でサポートされている接続属性のサブセットをサポートする。また DB2 Everyplace は、DB2 でサポートされていない接続属性もいくつかサポートしている。
SQLGetCursorName ステートメント・ハンドルと関連したカーソル名を戻す。 内部で生成されたカーソル名は常に CUR で始まる。
SQLGetData 結果セットの 1 行の 1 列の一部または全部を戻す。 ターゲット・タイプは、サポートされるデータ・タイプに制限される。 LOB ロケーターをサポートしない。戻りコード SQL_STILL_EXECUTING をサポートしない。
SQLGetDiagRec 診断データの複数フィールドを入手する。 ステートメント・ハンドルまたは接続ハンドルに関連付けられた診断レコードのみをサポートする。 単一診断レコードのみをサポートする。
SQLGetInfo 指定されたドライバーとデータ・ソースについての情報を戻す。 DB2 Everyplace は、DB2 でサポートされている情報タイプのサブセットをサポートする。
SQLGetStmtAttr ステートメント属性の現在の設定を戻す。 DB2 Everyplace は、DB2 でサポートされているステートメント属性のサブセットをサポートする。また DB2 Everyplace は、DB2 でサポートされていないステートメント属性もいくつかサポートしている。
SQLNumParams SQL ステートメント内のパラメーター・マーカーの数を戻す。 戻りコード SQL_STILL_EXECUTING をサポートしない。
SQLNumResultCols 結果セット内の列数を戻す。
SQLPrepare 後で実行するために SQL ステートメントを準備する。
SQLPrimaryKeys 表の主キーが入っている列名のリストを戻す。 CatalogNameNameLength1SchemaNameNameLength2 は無視される。戻された結果セットの列 1、2、6 は、常に長さがゼロのストリングになる。戻りコード SQL_STILL_EXECUTING をサポートしない。
SQLRowCount 挿入、更新、または削除の各要求による影響を受ける行数を戻す。
SQLSetConnectAttr 接続に関するオプションを設定する。 DB2 Everyplace は、DB2 でサポートされている接続属性のサブセットをサポートする。また DB2 Everyplace は、DB2 でサポートされていない接続属性もいくつかサポートしている。
SQLSetStmtAttr ステートメントに関するオプションを設定する。 DB2 Everyplace は、DB2 でサポートされているステートメント属性のサブセットをサポートする。また DB2 Everyplace は、DB2 でサポートされていないステートメント属性もいくつかサポートしている。
SQLTables 特定のデータ・ソースに格納されている表名のリストを戻す。 CatalogNameNameLength1SchemaNameNameLength2TableTypeNameLength4 は無視される。DB2 Everyplace は「TABLE」タイプのみサポートする。戻りコード SQL_STILL_EXECUTING をサポートしない。

関連した解説