MySQL C API函式大全

Mysql C API提供函式主要分為如下五種：

1. 控制類函式

2. 資訊獲取類函式
3. 行列類操作函式
4. 執行緒類操作函式
5. 出錯處理類函式

本文歸納了C API可使用的函式，具體用法，參考文末地址中對應條目，均有詳細說明。

函式	描述
mysql_affected_rows()	返回上次UPDATE、DELETE或INSERT查詢更改／刪除／插入的行數。
mysql_autocommit()	切換 autocommit模式，ON/OFF
mysql_change_user()	更改開啟連線上的使用者和資料庫。
mysql_charset_name()	返回用於連線的預設字符集的名稱。
mysql_close()	關閉伺服器連線。
mysql_commit()	提交事務。
mysql_connect()	連線到MySQL伺服器。該函式已不再被重視，使用mysql_real_connect()取代。
mysql_create_db()	建立資料庫。該函式已不再被重視，使用SQL語句CREATE DATABASE取而代之。
mysql_data_seek()	在查詢結果集中查詢屬性行編號。
mysql_debug()	用給定的字串執行DBUG_PUSH。
mysql_drop_db()	撤銷資料庫。該函式已不再被重視，使用SQL語句DROP DATABASE取而代之。
mysql_dump_debug_info()	讓伺服器將除錯資訊寫入日誌。
mysql_eof()	確定是否讀取了結果集的最後一行。該函式已不再被重視，可以使用mysql_errno()或mysql_error() 取而代之。
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_field_seek()	將列游標置於指定的列。
mysql_field_count()	返回上次執行語句的結果列的數目。
mysql_field_tell()	返回上次mysql_fetch_field()所使用欄位游標的位置。
mysql_free_result()	釋放結果集使用的記憶體。
mysql_get_client_info()	以字串形式返回客戶端版本資訊。
mysql_get_client_version()	以整數形式返回客戶端版本資訊。
mysql_get_host_info()	返回描述連線的字串。
mysql_get_server_version()	以整數形式返回伺服器的版本號。
mysql_get_proto_info()	返回連線所使用的協議版本。
mysql_get_server_info()	返回伺服器的版本號。
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_more_results ()	檢查是否還存在其他結果。
mysql_next_result()	在多語句執行過程中返回/初始化下一個結果。
mysql_num_fields()	返回結果集中的列數。
mysql_num_rows()	返回結果集中的行數。
mysql_options()	為mysql_connect()設定連線選項。
mysql_ping()	檢查與伺服器的連線是否工作，如有必要重新連線。
mysql_query()	執行指定為“以Null終結的字串”的SQL查詢。
mysql_real_connect ()	連線到MySQL伺服器。
mysql_real_escape_string()	考慮到連線的當前字符集，為了在SQL語句中使用，對字串中的特殊字元進行轉義處理。
mysql_real_query()	執行指定為計數字符串的SQL查詢。
mysql_refresh()	重新整理或復位表和高速緩衝。
mysql_reload()	通知伺服器再次載入授權表。
mysql_rollback()	回滾事務。
mysql_row_seek()	使用從mysql_row_tell()返回的值，查詢結果集中的行偏移。
mysql_row_tell()	返回行游標位置。
mysql_select_db()	選擇資料庫。
mysql_server_end()	最終確定嵌入式伺服器庫。
mysql_server_init()	初始化嵌入式伺服器庫。
mysql_set_server_option()	為連線設定選項（如多語句）。
mysql_sqlstate()	返回關於上一個錯誤的SQLSTATE錯誤程式碼。
mysql_shutdown()	關閉資料庫伺服器。
mysql_stat()	以字串形式返回伺服器狀態。
mysql_store_result ()	檢索完整的結果集至客戶端。
mysql_thread_id()	返回當前執行緒ID。
mysql_thread_safe()	如果客戶端已編譯為執行緒安全的，返回1。
mysql_use_result()	初始化逐行的結果集檢索。
mysql_warning_count()	返回上一個SQL語句的告警數。

與MySQL互動時，應用程式應使用該一般性原則：

1.    通過呼叫mysql_library_init()，初始化MySQL庫。庫可以是mysqlclient C客戶端庫，或mysqld嵌入式伺服器庫，具體情況取決於應用程式是否與“-libmysqlclient”或“-libmysqld”標誌連結。

2.    通過呼叫mysql_init()初始化連線處理程式，並通過呼叫mysql_real_connect()連線到伺服器。

3.    發出SQL語句並處理其結果。（在下面的討論中，詳細介紹了使用它的方法）。

4.    通過呼叫mysql_close()，關閉與MySQL伺服器的連線。

5.    通過呼叫mysql_library_end()，結束MySQL庫的使用。

呼叫mysql_library_init()和mysql_library_end()的目的在於，為MySQL庫提供恰當的初始化和結束處理。對於與客戶端庫連結的應用程式，它們提供了改進的記憶體管理功能。如果不呼叫mysql_library_end()，記憶體塊仍將保持分配狀態（這不會增加應用程式使用的記憶體量，但某些記憶體洩漏檢測器將抗議它）。對於與嵌入式伺服器連結的應用程式，這些呼叫會啟動並停止伺服器。

mysql_library_init()和mysql_library_end()實際上是#define符號，這類符號使得它們等效於mysql_server_init()和mysql_server_end()，但其名稱更清楚地指明，無論應用程式使用的是mysqlclient或mysqld庫，啟動或結束MySQL庫時，應呼叫它們。對於早期的MySQL版本，可呼叫mysql_server_init()和mysql_server_end()取而代之。

如果願意，可省略對mysql_library_init()的呼叫，這是因為，必要時，mysql_init()會自動呼叫它。

要想連線到伺服器，可呼叫mysql_init()來初始化連線處理程式，然後用該處理程式（以及其他資訊，如主機名、使用者名稱和密碼）呼叫mysql_real_connect()。建立連線後，在低於5.0.3版的API中，mysql_real_connect()會將再連線標誌（MYSQL結構的一部分）設定為1，或在較新的版本中，將其設定為0。對於該標誌，值“1”指明，如果因連線丟失而無法執行語句，放棄之前，會嘗試再次連線到伺服器。從MySQL 5.0.13開始，可以在mysql_options()上使用MYSQL_OPT_RECONNECT選項，以控制再連線行為。完成連線後，呼叫mysql_close()中止它。

當連線處於活動狀態時，客戶端或許會使用mysql_query()或mysql_real_query()向伺服器發出SQL查詢。兩者的差別在於，mysql_query()預期的查詢為指定的、由Null終結的字串，而mysql_real_query()預期的是計數字符串。如果字串包含二進位制資料（其中可能包含Null位元組），就必須使用mysql_real_query()。

對於每個非SELECT查詢（例如INSERT、UPDATE、DELETE），通過呼叫mysql_affected_rows()，可發現有多少行已被改變（影響）。

對於SELECT查詢，能夠檢索作為結果集的行。注意，某些語句因其返回行，類似與SELECT。包括SHOW、DESCRIBE和EXPLAIN。應按照對待SELECT語句的方式處理它們。

客戶端處理結果集的方式有兩種。

一種方式是，通過呼叫mysql_store_result()，一次性地檢索整個結果集。該函式能從伺服器獲得查詢返回的所有行，並將它們儲存在客戶端。

第二種方式是針對客戶端的，通過呼叫mysql_use_result()，對“按行”結果集檢索進行初始化處理。該函式能初始化檢索結果，但不能從伺服器獲得任何實際行。

在這兩種情況下，均能通過呼叫mysql_fetch_row()訪問行。通過mysql_store_result()，mysql_fetch_row()能夠訪問以前從伺服器獲得的行。通過mysql_use_result()，mysql_fetch_row()能夠實際地檢索來自伺服器的行。通過呼叫mysql_fetch_lengths()，能獲得關於各行中資料大小的資訊。

完成結果集操作後，請呼叫mysql_free_result()釋放結果集使用的記憶體。

這兩種檢索機制是互補的。客戶端程式應選擇最能滿足其要求的方法。實際上，客戶端最常使用的是mysql_store_result()。

mysql_store_result()的1個優點在於，由於將行全部提取到了客戶端上，你不僅能連續訪問行，還能使用mysql_data_seek()或mysql_row_seek()在結果集中向前或向後移動，以更改結果集內當前行的位置。通過呼叫mysql_num_rows()，還能發現有多少行。另一方面，對於大的結果集，mysql_store_result()所需的記憶體可能會很大，你很可能遇到記憶體溢位狀況。

mysql_use_result()的1個優點在於，客戶端所需的用於結果集的記憶體較少，原因在於，一次它僅維護一行（由於分配開銷較低，mysql_use_result()能更快）。它的缺點在於，你必須快速處理每一行以避免妨礙伺服器，你不能隨機訪問結果集中的行（只能連續訪問行），你不知道結果集中有多少行，直至全部檢索了它們為止。不僅如此，即使在檢索過程中你判定已找到所尋找的資訊，也必須檢索所有的行。

通過API，客戶端能夠恰當地對查詢作出響應（僅在必要時檢索行），而無需知道查詢是否是SELECT查詢。可以在每次mysql_query()或mysql_real_query()後，通過呼叫mysql_store_result()完成該操作。如果結果集呼叫成功，查詢為SELECT，而且能夠讀取行。如果結果集呼叫失敗，可呼叫mysql_field_count()來判斷結果是否的確是所預期的。如果mysql_field_count()返回0，查詢不返回資料（表明它是INSERT、UPDATE、DELETE等），而且不返回行。如果mysql_field_count()是非0值，查詢應返回行，但沒有返回行。這表明查詢是失敗了的SELECT。關於如何實現該操作的示例，請參見關於mysql_field_count()的介紹。

無論是mysql_store_result()還是mysql_use_result()，均允許你獲取關於構成結果集的欄位的資訊（欄位數目，它們的名稱和型別等）。通過重複呼叫mysql_fetch_field()，可以按順序訪問行內的欄位資訊，或者，通過呼叫mysql_fetch_field_direct()，能夠在行內按欄位編號訪問欄位資訊。通過呼叫mysql_field_seek()，可以改變當前欄位的游標位置。對欄位游標的設定將影響後續的mysql_fetch_field()呼叫。此外，你也能通過呼叫mysql_fetch_fields()，一次性地獲得關於欄位的所有資訊。

為了檢測和通報錯誤，MySQL提供了使用mysql_errno()和mysql_error()函式訪問錯誤資訊的機制。它們能返回關於最近呼叫的函式的錯誤程式碼或錯誤訊息，最近呼叫的函式可能成功也可能失敗，這樣，你就能判斷錯誤是在何時出現的，以及錯誤是什麼。

參考資料：

http://dev.mysql.com/doc/refman/5.1/zh/apis.html