MySQL與C編程筆記

MySQL與C編程筆記

撰/ ahliu

前言

前一陣子正在編寫有關MySQL的基本操作，由於本人不熟其他編程語言，所以不幸地這次也是使用C語言，其實MySQL已提供了其header file (i.e. mysql.h)，對於C編程員實在是行了一大方便。

使用前準備

首先你要確定 mysql.h及其相應版本的shared object (例如libmysqlclient.so.x)已經安裝妥當，理論上安裝好MySQL後，這兩個檔案已分別放置在mysql/include及 mysql/lib裡(除非在設置MySQL選項時更改了其位置)。請注意，mysql.h及libmysqlclient.so.x必須為同一個 MySQL版本，若使用不相同的版本將有未能預計的結果。

最重要一點，當然是確保你的MySQL Server正在運行中，你亦需新增用戶名稱及密碼供你的程式登入。

MySQL所使用的數據結構

「MYSQL」這數 據結構是最常用的，因為它是連接MySQL Server的handle，每一個handle就代表程式與MySQL Server的一個(唯一的) connection，所有存取、查詢，刪除等等的工作都需要MySQL handle作參數以識別不同使用者、數據庫及發出指令的程式。

「MYSQL_RES」 的意思是MySQL Result Set(若以微軟作對比的話，可說是Record Set)，顧名思義，這是包含數據庫傳回來的結果，但我們並不會直接存取MYSQL_RES裡的資料，我們會使用「MYSQL_ROW」，即是以行作單位 讀取資料，詳情請往 http://dev.mysql.com/doc/mysql/en/C_API_datatypes.html 參考。

連接MySQL Server

在程式碼裡你需要加入#include <mysql.h>讓編譯器找到所有MySQL Client的函數定義，然後使用mysql_init()準備連接，mysql_init()的原型如下：

MYSQL *mysql_init(MYSQL *mysql)

以下為一簡單例子：

#include <stdio.h>
#include <mysql.h>

int main(int argc, char **argv) {
     MYSQL mysql_conn; /* Connection handle */

     if (mysql_init(&mysql_conn) != NULL) {
         /* OK, the initiailization is success */
         ...
     } else {
         /* OH, the initialization fails */
         ...
     }

     return 0;
}

若果未能初始化MySQL handle的話，mysql_init會傳回NULL，各讀者應盡量檢查所有函數是否運作正常。在編譯時你需加入「-lmysqlclient」加入libmysqlclient.so.x，例子如下：

gcc test.c -I/usr/include/mysql -L/usr/lib/mysql -lmysqlclient -o test

-I(include path)隨後的path是mysql.h的位置，-L(library path)隨後的path是libmysqlclient.so.x的位置。

Handle被初始化後，就可以使用mysql_real_connect(或mysql_connect)連接MySQL Server了，此時你需要輸入host name、user name、password等作參數：

MYSQL *mysql_real_connect(MYSQL *mysql, const char *host, const char *user, const char *passwd, const char *db, unsigned int port, const char *unix_socket, unsigned long client_flag)

第一個參數是你剛才 初始化的handle，第二至四個參數分別是host name、user name及password，第五個參數是數據庫名稱，你也可把第五個參數設為NULL，之後使用mysql_select_db來選擇數據庫，第六個參 數是MySQL Server的連接埠，一般都把它設為MYSQL_PORT(這正是mysql.h和libmysqlclient.so.x要配合的原因)，第七個參數 是MySQL Server及client間傳輸資料的渠道(socket或named pipe)，但MySQL Server會根據host name(第二參數)建立另一渠道，除非你有真正的需要另建，否則你需在第七個參數填上NULL。最後是client_flag，包括壓縮協定、查詢語句 協定、加密協定等，詳情請參看 http://dev.mysql.com/doc/mysql/en/mysql_real_connect.html

以下是一例子：

#include <stdio.h>
#include <mysql.h>

int main(int argc, char **argv) {
     MYSQL mysql_conn /* Connection handle */

     if (mysql_init(&mysql_conn) != NULL) {
         if (mysql_real_connect(&mysql_conn, "localhost", "test", "test_pass", "sample_db", MYSQL_PORT, NULL, 0) != NULL) {
             (void) printf("GOOD!/n");
         } else {
             (void) printf("Connection fails./n");
         }
     } else {
         (void) printf("Initialization fails./n");
         return -1;
     }

     mysql_close(&mysql_conn);
     return 0;
}

查詢數據庫

當你成功連接 MySQL Server後，便可使用mysql_query或mysql_real_query來查詢數據庫，mysql_query不能處理binary data，若你的查詢含有binary data，例如中文字或不能顯示的字完，就必須使用mysql_real_query，即是要讀者提供該查詢字串的長度，mysql_query的原型如 下：

int mysql_query(MYSQL *mysql, const char *query)

第一個參數是MySQL連接的handle，第二個參數就是查詢字串，若查詢語法正確以及查詢成功的話，mysql_query會返回零值，失敗才會傳回非零值，這點讀者需要留意(其實大部分MySQL client函數都在成功時傳回非零值)。

若你的查詢語句並沒 有結果(Result set)需要傳回，例如DELETE、UPDATE、INSERT等，mysql_query被執行後便完成整個操作了；若你要執行INSERT、 SHOW、DESCRIBE等，在存取結果前，你必須使用mysql_store_result來建立Result handle，mysql_store_result原型如下：

MYSQL_RES *mysql_store_result(MYSQL *mysql)

應用例子如下：

#include <stdio.h>
#include <mysql.h>

int main(int argc, char **argv) {
     MYSQL mysql_conn /* Connection handle */
     MYSQL_RES *mysql_result;

     if (mysql_init(&mysql_conn) != NULL) {
         if (mysql_real_connect(&mysql_conn, "localhost", "test", "test_pass", "sample_db", MYSQL_PORT, NULL, 0) != NULL) {
             /* Please assume that this query has no error */
             mysql_query(&mysql_conn, "select * from table1");
             mysql_result = mysql_store_result(&mysql_conn);

             /* Free the result to release the heap memory*/
             mysql_free_result(mysql_result);
         } else {
             (void) printf("Connection fails./n");
         }
     } else {
         (void) printf("Initialization fails./n");
         return -1;
     }

     mysql_close(&mysql_conn);
     return 0;
}

請留意mysql_result是一個指針(pointer)，因為mysql_store_result會替你分配記憶體來儲存查詢結果，當然你亦需要執行mysql_free_result(MYSQL_RES*)來釋放該段記憶體。

擷取查詢結果

正如上一節所說，擷 取結果前需使用mysql_store_result分配記憶體予查詢結果的數據結構，然後再以迴圈逐行擷取，至於如何知道結果共有多少行，可使用 mysql_num_rows(MYSQL_RES*)，其傳回數字即是結果的行數。在該迴圈裡，要使用mysql_fetch_row()

MYSQL_ROW mysql_fetch_row(MYSQL_RES *result)

MYSQL_ROW 是一個陣列結構，陣列內每一個元素順次序便是該行的column value，例如&#20082;前有一table名叫「Table1」有「C1」及「C2」兩個欄，那麼以「Select * from Table1」查詢後，MYSQL_ROW第一個元素(mysql_row[0])便是C1的資料，第二個元素(mysql_row[1])是C2的資 料。例子如下：

#include <stdio.h>
#include <dmalloc.h>
#include <mysql.h>

int main(int argc, char **argv) {
     MYSQL mysql_conn; /* Connection handle */
     MYSQL_RES *mysql_result; /* Result handle */
     MYSQL_ROW mysql_row; /* Row data */
     int f1, f2, num_row, num_col;

     if (mysql_init(&mysql_conn) != NULL) {
         if (mysql_real_connect(&mysql_conn, "localhost", "test", "testpass", "test", MYSQL_PORT, NULL, 0) != NULL) {
             if (mysql_query(&mysql_conn, "select * from testtable") == 0) {
                 mysql_result = mysql_store_result(&mysql_conn);
                 num_row = mysql_num_rows(mysql_result); /* Get the no. of row */
                 num_col = mysql_num_fields(mysql_result); /* Get the no. of column */

                 for (f1 = 0; f1 < num_row; f1++) {
                     for (f2 = 0; f2 < num_col; f2++) {
                         mysql_row = mysql_fetch_row(mysql_result); /* Fetch one by one */
                         printf("[Row %d, Col %d] ==> [%s]/n", f1, f2, mysql_row[f2]);
                     }
                 }
             } else {
                 (void) printf("Query fails/n");
             }
         } else {
             (void) printf("Connection fails/n");
         }
     } else {
         (void) printf("Initialization fails/n");
     }

     mysql_free_result(mysql_result);
     mysql_close(&mysql_conn);
     return 0;
}

剛才的程式碼會將數據庫「test」裡的「testtable」table內所有資料顯示出來。請留意，若果數據庫內的資料龐大，而你卻忘了使用mysql_free_result釋放記憶體，你便會遇上龐大的記憶體溢出問題。

使用提示

• 在MySQL的開發者討論區內，有人曾發表過mysql_init及mysql_close會分別動態載入及卸載libmysqlclient，並造成記憶體溢出，所以在編譯時應加入「-lz」來強制shared object於程式結束時才卸下。
• 在my.cnf內有加入「host」設定的話，使用libmysqlclient時會造成嚴重記憶體溢出，請往 http://lists.mysql.com/mysql/44051 參考。
• 使 用過所有有查詢結果的query後(包括SELECT、SHOW、DESCRIBE、EXPLAIN、OPTIMIZE等等)，必需使用 mysql_store_result(MYSQL_RES*)，否則你將不能按常進行第二次查詢。若你真的不需要知道query後的結果，可使用：
  
  mysql_free_result(mysql_store_result(MYSQL*));
  
  來處理查詢結果。
• 要時常檢查著每句指令的傳回碼，因為逾時、查詢語句錯誤、查詢執行錯誤、記憶體不足、連接錯誤等等，都會令你的程式無法正常操作。