文件首頁
MySQL Connector/ODBC 開發人員指南
相關文件 下載本手冊
PDF (美式 Letter) - 1.7Mb
PDF (A4) - 1.7Mb


MySQL Connector/ODBC 開發人員指南  /  Connector/ODBC 參考  /  Connector/ODBC API 參考

7.1 Connector/ODBC API 參考

本節總結了 ODBC 常式,並按功能分類。

如需完整的 ODBC API 參考,請參閱 http://msdn.microsoft.com/en-us/library/ms714177.aspx 上的 ODBC 程式設計人員參考。

應用程式可以呼叫 SQLGetInfo 函數來取得有關 Connector/ODBC 的相容性資訊。若要取得有關驅動程式中對特定函數的支援資訊,應用程式可以呼叫 SQLGetFunctions

注意

為了向後相容性,Connector/ODBC 驅動程式支援所有已棄用的函數。

下表列出了依任務分組的 Connector/ODBC API 呼叫

表 7.1 用於連線至資料來源的 ODBC API 呼叫

函數名稱 Connector/ODBC 支援嗎? 標準 目的
SQLAllocHandle ISO 92 取得環境、連線、陳述式或描述元控制代碼。
SQLConnect ISO 92 透過資料來源名稱、使用者 ID 和密碼連線至特定驅動程式。
SQLDriverConnect ODBC 透過連線字串連線至特定驅動程式,或要求驅動程式管理員和驅動程式顯示連線對話方塊供使用者使用。
SQLAllocEnv 已棄用 取得從驅動程式配置的環境控制代碼。
SQLAllocConnect 已棄用 取得連線控制代碼

表 7.2 用於取得有關驅動程式和資料來源資訊的 ODBC API 呼叫

函數名稱 Connector/ODBC 支援嗎? 標準 目的
SQLDataSources ISO 92 傳回驅動程式管理員處理的可用資料來源清單
SQLDrivers ODBC 傳回已安裝驅動程式及其屬性的清單,由驅動程式管理員處理
SQLGetInfo ISO 92 傳回有關特定驅動程式和資料來源的資訊。
SQLGetFunctions ISO 92 傳回支援的驅動程式函數。
SQLGetTypeInfo ISO 92 傳回有關支援資料類型的資訊。

表 7.3 用於設定和擷取驅動程式屬性的 ODBC API 呼叫

函數名稱 Connector/ODBC 支援嗎? 標準 目的
SQLSetConnectAttr ISO 92 設定連線屬性。
SQLGetConnectAttr ISO 92 傳回連線屬性的值。
SQLSetConnectOption 已棄用 設定連線選項
SQLGetConnectOption 已棄用 傳回連線選項的值
SQLSetEnvAttr ISO 92 設定環境屬性。
SQLGetEnvAttr ISO 92 傳回環境屬性的值。
SQLSetStmtAttr ISO 92 設定陳述式屬性。
SQLGetStmtAttr ISO 92 傳回陳述式屬性的值。
SQLSetStmtOption 已棄用 設定陳述式選項
SQLGetStmtOption 已棄用 傳回陳述式選項的值

表 7.4 用於準備 SQL 要求的 ODBC API 呼叫

函數名稱 Connector/ODBC 支援嗎? 標準 目的
SQLAllocStmt 已棄用 配置陳述式控制代碼
SQLPrepare ISO 92 準備 SQL 陳述式以供稍後執行。
SQLBindParameter ODBC 為 SQL 陳述式中的參數指派儲存空間。Connector/ODBC 5.2 透過 SQL_PARAM_OUTPUTSQL_PARAM_INPUT_OUTPUT 類型指定詞新增了對outinout參數的支援。(Outinout參數不支援 LONGTEXTLONGBLOB 資料行。)
SQLGetCursorName ISO 92 傳回與陳述式控制代碼相關聯的游標名稱。
SQLSetCursorName ISO 92 指定游標名稱。
SQLSetScrollOptions ODBC 設定控制游標行為的選項。

表 7.5 用於提交要求的 ODBC API 呼叫

函數名稱 Connector/ODBC 支援嗎? 標準 目的
SQLExecute ISO 92 執行準備好的陳述式。
SQLExecDirect ISO 92 執行陳述式
SQLNativeSql ODBC 傳回由驅動程式轉譯的 SQL 陳述式文字。
SQLDescribeParam ODBC 傳回陳述式中特定參數的描述。Connector/ODBC 不支援此功能,不應信任傳回的結果。
SQLNumParams ISO 92 傳回陳述式中的參數數目。
SQLParamData ISO 92 SQLPutData 結合使用,以在執行時提供參數資料。(適用於長資料值。)
SQLPutData ISO 92 傳送參數的部分或全部資料值。(適用於長資料值。)

表 7.6 用於擷取結果和有關結果資訊的 ODBC API 呼叫

函數名稱 Connector/ODBC 支援嗎? 標準 目的
SQLRowCount ISO 92 傳回受插入、更新或刪除要求影響的資料列數目。
SQLNumResultCols ISO 92 傳回結果集中的資料行數目。
SQLDescribeCol ISO 92 描述結果集中的資料行。
SQLColAttribute ISO 92 描述結果集中資料行的屬性。
SQLColAttributes 已棄用 描述結果集中資料行的屬性。
SQLFetch ISO 92 傳回多個結果列。
SQLFetchScroll ISO 92 傳回可捲動的結果列。
SQLExtendedFetch 已棄用 傳回可捲動的結果列。
SQLSetPos ODBC 在提取的資料區塊中定位游標,並允許應用程式重新整理資料列集中的資料,或更新或刪除結果集中的資料。
SQLBulkOperations ODBC 執行大量插入和大量書籤操作,包括更新、刪除和依書籤提取。

表 7.7 用於檢索錯誤或診斷資訊的 ODBC API 呼叫

函數名稱 Connector/ODBC 支援嗎? 標準 目的
SQLError 已棄用 傳回額外的錯誤或狀態資訊
SQLGetDiagField ISO 92 傳回額外的診斷資訊 (診斷資料結構的單一欄位)。
SQLGetDiagRec ISO 92 傳回額外的診斷資訊 (診斷資料結構的多個欄位)。

表 7.8 用於取得資料來源的系統表格 (目錄函數) 項目資訊的 ODBC API 呼叫

函數名稱 Connector/ODBC 支援嗎? 標準 目的
SQLColumnPrivileges ODBC 傳回一個或多個表格的欄位及其相關權限的清單。
SQLColumns X/Open 傳回指定表格中的欄位名稱清單。
SQLForeignKeys ODBC 如果指定的表格存在外來鍵,則傳回構成外來鍵的欄位名稱清單。
SQLPrimaryKeys ODBC 傳回構成表格主鍵的欄位名稱清單。
SQLSpecialColumns X/Open 傳回關於最佳欄位組的資訊,該欄位組唯一識別指定表格中的資料列,或當資料列中的任何值被交易更新時自動更新的欄位。
SQLStatistics ISO 92 傳回有關單一表格和與該表格相關聯的索引清單的統計資訊。
SQLTablePrivileges ODBC 傳回表格清單以及與每個表格相關聯的權限。
SQLTables X/Open 傳回儲存在特定資料來源中的表格名稱清單。

表 7.9 用於執行交易的 ODBC API 呼叫

函數名稱 Connector/ODBC 支援嗎? 標準 目的
SQLTransact 已棄用 提交或回滾交易
SQLEndTran ISO 92 提交回滾 交易

表 7.10 用於終止陳述式的 ODBC API 呼叫

函數名稱 Connector/ODBC 支援嗎? 標準 目的
SQLFreeStmt ISO 92 結束陳述式處理,捨棄擱置的結果,並且可選擇釋放與陳述式句柄相關的所有資源。
SQLCloseCursor ISO 92 關閉在陳述式句柄上開啟的游標。
SQLCancel ISO 92 取消 SQL 陳述式。

表 7.11 用於終止連線的 ODBC API 呼叫

函數名稱 Connector/ODBC 支援嗎? 標準 目的
SQLDisconnect ISO 92 關閉連線。
SQLFreeHandle ISO 92 釋放環境、連線、陳述式或描述符句柄。
SQLFreeConnect 已棄用 釋放連線句柄。
SQLFreeEnv 已棄用 釋放環境句柄。