版本 8.4

第 4 章 C API 函數參考

下表總結了 MySQL C API 的所有可用函數。如需更多詳細資訊，請參閱個別函數說明。

表 4.1 C API 函數

名稱	描述	已棄用
`mysql_affected_rows()`	最後一個 `UPDATE`、`DELETE` 或 `INSERT` 陳述式變更/刪除/插入的列數
`mysql_autocommit()`	設定自動提交模式
`mysql_bind_param()`	定義下一個執行的陳述式的查詢屬性
`mysql_binlog_close()`	關閉複製事件流
`mysql_binlog_fetch()`	從複製事件流讀取事件
`mysql_binlog_open()`	開啟複製事件流
`mysql_change_user()`	變更開啟連線上的使用者和資料庫
`mysql_character_set_name()`	目前連線的預設字元集名稱
`mysql_client_find_plugin()`	傳回外掛程式的指標
`mysql_client_register_plugin()`	註冊外掛程式
`mysql_close()`	關閉與伺服器的連線
`mysql_commit()`	提交交易
`mysql_connect()`	連線到 MySQL 伺服器	是
`mysql_create_db()`	建立資料庫	是
`mysql_data_seek()`	在查詢結果集中搜尋任意列號
`mysql_debug()`	使用給定的字串執行 `DBUG_PUSH`
`mysql_drop_db()`	刪除資料庫	是
`mysql_dump_debug_info()`	導致伺服器將除錯資訊寫入錯誤日誌
`mysql_eof()`	判斷是否已讀取結果集的最後一列	是
`mysql_errno()`	最近調用的 MySQL 函數的錯誤號碼
`mysql_error()`	最近調用的 MySQL 函數的錯誤訊息
`mysql_escape_string()`	逸出字串中的特殊字元，以用於 SQL 陳述式
`mysql_fetch_field()`	下一個表格欄位的類型
`mysql_fetch_field_direct()`	給定欄位號碼的表格欄位類型
`mysql_fetch_fields()`	傳回所有欄位結構的陣列
`mysql_fetch_lengths()`	傳回目前列中所有資料行的長度
`mysql_fetch_row()`	提取下一個結果集列
`mysql_fetch_row_nonblocking()`	非同步提取下一個結果集列
`mysql_field_count()`	最近的陳述式的結果欄數
`mysql_field_seek()`	在結果集列內搜尋資料行
`mysql_field_tell()`	最後一次 `mysql_fetch_field()` 呼叫的欄位位置
`mysql_free_result()`	釋放結果集記憶體
`mysql_free_result_nonblocking()`	非同步釋放結果集記憶體
`mysql_free_ssl_session_data()`	處置來自最後一次 `mysql_get_ssl_session_data()` 呼叫的工作階段資料控制代碼
`mysql_get_character_set_info()`	關於預設字元集的資訊
`mysql_get_client_info()`	客戶端版本 (字串)
`mysql_get_client_version()`	客戶端版本 (整數)
`mysql_get_connect_nonblocking_stage()`	關於 `mysql_real_connect_nonblocking` 狀態機的資訊
`mysql_get_host_info()`	關於連線的資訊
`mysql_get_option()`	`mysql_options()` 選項的值
`mysql_get_proto_info()`	連線使用的協定版本
`mysql_get_server_info()`	伺服器版本號碼 (字串)
`mysql_get_server_version()`	伺服器版本號碼 (整數)
`mysql_get_ssl_cipher()`	目前 SSL 密碼
`mysql_get_ssl_session_data()`	傳回已啟用 SSL 連線的工作階段資料
`mysql_get_ssl_session_reused()`	工作階段是否已重複使用
`mysql_hex_string()`	以十六進位格式編碼字串
`mysql_info()`	關於最近執行的陳述式的資訊
`mysql_init()`	取得或初始化 `MYSQL` 結構
`mysql_insert_id()`	先前陳述式為 `AUTO_INCREMENT` 資料行產生的 ID
`mysql_kill()`	終止線程	是
`mysql_library_end()`	完成 MySQL C API 程式庫
`mysql_library_init()`	初始化 MySQL C API 程式庫
`mysql_list_dbs()`	傳回符合規則運算式的資料庫名稱
`mysql_list_fields()`	傳回符合規則運算式的欄位名稱
`mysql_list_processes()`	目前伺服器線程的清單
`mysql_list_tables()`	傳回符合規則運算式的表格名稱
`mysql_load_plugin()`	載入外掛程式
`mysql_load_plugin_v()`	載入外掛程式
`mysql_more_results()`	檢查是否存在更多結果
`mysql_next_result()`	傳回/起始多重結果執行中的下一個結果
`mysql_next_result_nonblocking()`	非同步傳回/起始多重結果執行中的下一個結果
`mysql_num_fields()`	結果集中的資料行數
`mysql_num_rows()`	結果集中的列數
`mysql_options()`	在連線之前設定選項
`mysql_options4()`	在連線之前設定選項
`mysql_ping()`	Ping 伺服器
`mysql_plugin_get_option()`	取得外掛程式選項
`mysql_plugin_options()`	設定外掛程式選項
`mysql_query()`	執行陳述式
`mysql_real_connect()`	連線到 MySQL 伺服器
`mysql_real_connect_dns_srv()`	使用 DNS SRV 記錄連線到 MySQL 伺服器
`mysql_real_connect_nonblocking()`	非同步連線到 MySQL 伺服器
`mysql_real_escape_string()`	編碼陳述式字串中的特殊字元
`mysql_real_escape_string_quote()`	編碼陳述式字串中的特殊字元，並考量引號內容
`mysql_real_query()`	執行陳述式
`mysql_real_query_nonblocking()`	非同步執行陳述式
`mysql_refresh()`	清除或重設表格和快取
`mysql_reload()`	重新載入授權表格	是
`mysql_reset_connection()`	重設連線以清除工作階段狀態
`mysql_reset_connection_nonblocking()`	非同步重設連線以清除工作階段狀態
`mysql_reset_server_public_key()`	從用戶端程式庫清除快取的 RSA 公開金鑰
`mysql_result_metadata()`	結果集是否具有中繼資料
`mysql_rollback()`	復原交易
`mysql_row_seek()`	在結果集中搜尋列位移
`mysql_row_tell()`	結果集列內的目前位置
`mysql_select_db()`	選取資料庫
`mysql_server_end()`	完成 MySQL C API 程式庫
`mysql_server_init()`	初始化 MySQL C API 程式庫
`mysql_session_track_get_first()`	工作階段狀態變更資訊的第一部分
`mysql_session_track_get_next()`	工作階段狀態變更資訊的下一部分
`mysql_set_character_set()`	設定目前連線的預設字元集
`mysql_set_local_infile_default()`	將 `LOAD DATA LOCAL` 處理常式回呼設定為預設值
`mysql_set_local_infile_handler()`	安裝應用程式特定的 `LOAD DATA LOCAL` 處理常式回呼
`mysql_set_server_option()`	設定目前連線的選項
`mysql_shutdown()`	關閉 MySQL 伺服器
`mysql_sqlstate()`	最近調用的 MySQL 函數的 SQLSTATE 值
`mysql_ssl_set()`	準備建立與伺服器的 SSL 連線	是
`mysql_stat()`	伺服器狀態
`mysql_stmt_affected_rows()`	最後一個預處理的 `UPDATE`、`DELETE` 或 `INSERT` 陳述式變更/刪除/插入的列數
`mysql_stmt_attr_get()`	取得預處理陳述式的屬性值
`mysql_stmt_attr_set()`	設定預處理陳述式的屬性值
`mysql_stmt_bind_named_param()`	將應用程式資料緩衝區與預處理陳述式中的具名和未具名參數標記建立關聯
`mysql_stmt_bind_param()`	將應用程式資料緩衝區與預處理陳述式中的參數標記建立關聯	是
`mysql_stmt_bind_result()`	將應用程式資料緩衝區與結果集中的資料行建立關聯
`mysql_stmt_close()`	釋放預處理陳述式使用的記憶體
`mysql_stmt_data_seek()`	在預處理陳述式結果集中搜尋任意列號
`mysql_stmt_errno()`	最近調用的 MySQL 預處理陳述式函數的錯誤號碼
`mysql_stmt_error()`	最近調用的 MySQL 預處理陳述式函數的錯誤訊息
`mysql_stmt_execute()`	執行預處理陳述式
`mysql_stmt_fetch()`	擷取下一個結果集列，並傳回所有繫結欄位的資料
`mysql_stmt_fetch_column()`	擷取目前結果集列中單一欄位的資料
`mysql_stmt_field_count()`	最近準備好的陳述式所產生的結果欄位數量
`mysql_stmt_free_result()`	釋放配置給陳述式處理器的資源
`mysql_stmt_init()`	配置並初始化 `MYSQL_STMT` 結構的記憶體
`mysql_stmt_insert_id()`	先前準備好的陳述式針對 `AUTO_INCREMENT` 欄位所產生的 ID
`mysql_stmt_next_result()`	在多重結果的預備陳述式執行中，傳回/啟動下一個結果
`mysql_stmt_num_rows()`	來自緩衝陳述式結果集的列數
`mysql_stmt_param_count()`	預備陳述式中的參數數量
`mysql_stmt_param_metadata()`	將參數中繼資料作為結果集傳回
`mysql_stmt_prepare()`	準備要執行的陳述式
`mysql_stmt_reset()`	重設伺服器端的陳述式緩衝區
`mysql_stmt_result_metadata()`	將預備陳述式中繼資料作為結果集傳回
`mysql_stmt_row_seek()`	在預備陳述式結果集中，跳到指定列的偏移量
`mysql_stmt_row_tell()`	預備陳述式結果集列中的目前位置
`mysql_stmt_send_long_data()`	以區塊方式傳送長資料至伺服器
`mysql_stmt_sqlstate()`	最近調用的 MySQL 預備陳述式函數的 SQLSTATE 值
`mysql_stmt_store_result()`	擷取並儲存整個結果集
`mysql_store_result()`	擷取並儲存整個結果集
`mysql_store_result_nonblocking()`	非同步擷取並儲存整個結果集
`mysql_thread_end()`	完成執行緒處理常式
`mysql_thread_id()`	目前的執行緒 ID
`mysql_thread_init()`	初始化執行緒處理常式
`mysql_thread_safe()`	客戶端是否編譯為執行緒安全
`mysql_use_result()`	啟動逐列擷取結果集
`mysql_warning_count()`	先前陳述式的警告計數