Mysql接口API相关函数详细使用说明

MySql接口API相关函数
1、部分API函数总览
　　1.1、部分API函数表
　　1.2、部分MySql结构体说明
        1.3、API函数使用步骤
2、mysql_init()——MYSQL对象初始化
        2.1、函数原型及参数说明
        2.2、简单使用
3、mysql_real_connect()——数据库引擎建立连接
        3.1、函数原型及参数说明
        3.2、简单使用
4、mysql_query()——查询数据库某表内容
        4.1、函数原型及参数说明
        4.2、简单使用
5、mysql_store_result()——向客户端检索完整的结果集
函数原型及参数说明
        5.1、mysql_fetch_row()——从结果集中获取下一行
        5.2、mysql_field_count()——返回表的列数
        5.3、mysql_fetch_fields()——来获取表头的内容
        5.4、简单使用
6、mysql_use_result()——启动逐行结果集检索
        6.1、函数原型及参数说明
7、mysql_free_result()——释放结果集使用的内存
        7.1、函数原型及参数说明
8、mysql_close()——关闭数据库连接
        8.1、函数原型及参数说明
9、应用实例
参考
MySql接口API相关函数

1、部分API函数总览
1.1、部分API函数表

1.2、部分MySql结构体说明
1、连接数据库前，必须先创建MYSQL变量，此变量在很多Mysql API函数会用到。它包含了一些连接信息等数据。

1. typedef struct st_mysql {
2. NET net; /* Communication parameters 通讯参数，网络相关*/
3. unsigned char connector_fd; /* ConnectorFd for SSL 加密套接字协议层*/
4. char *host,*user,*passwd,*unix_socket,*server_version,
5. *host_info,*info,*db;//数据库用户名，密码，主机名，Unix套接字，版本，主机信息
6. unsigned int port,client_flag,server_capabilities;
7. unsigned int protocol_version;
8. unsigned int field_count;
9. unsigned int server_status;
10. unsigned long thread_id; /* Id for connection in server */
11. my_ulonglong affected_rows;
12. my_ulonglong insert_id; /* id if insert on table with NEXTNR */
13. my_ulonglong extra_info; /* Used by mysqlshow */
14. unsigned long packet_length;
15. enum mysql_status status;
16. MYSQL_FIELD *fields;
17. MEM_ROOT field_alloc;
18. my_bool free_me; /* If free in mysql_close */
19. my_bool reconnect; /* set to 1 if automatic reconnect */
20. struct st_mysql_options options;
21. char scramble_buff[9];
22. struct charset_info_st *charset;
23. unsigned int server_language;
24. } MYSQL;

2、MYSQL_RES结构体中包含了查询结果集，也就是从数据库中查询到的数据。可以使用mysql_store_result或mysql_use_result函数获得。这个结构代表返回行的一个查询的(SELECT, SHOW, DESCRIBE, EXPLAIN)的结果。返回的数据称为“数据集”，在C的API里对应的就是MYSQL_RES，从数据库读取数据，最后就是从MYSQL_RES中读取数据。

1. typedef struct st_mysql_res {
2. my_ulonglong row_count;
3. MYSQL_FIELD *fields;
4. MYSQL_DATA *data;
5. MYSQL_ROWS *data_cursor;
6. unsigned long *lengths; /* column lengths of current row */
7. MYSQL *handle; /* for unbuffered reads */
8. const struct st_mysql_methods *methods;
9. MYSQL_ROW row; /* If unbuffered read */
10. MYSQL_ROW current_row; /* buffer to current row */
11. MEM_ROOT field_alloc;
12. unsigned int field_count, current_field;
13. my_bool eof; /* Used by mysql_fetch_row */
14. /* mysql_stmt_close() had to cancel this result */
15. my_bool unbuffered_fetch_cancelled;
16. void *extension;
17. } MYSQL_RES;

3、MYSQL_FIELD中包含了字段名、字段类型和大小等信息。可以重复调用mysql_fetch_field函数获得所有字段的信息。可以通过重复调用mysql_fetch_field()对每一列获得MYSQL_FIELD结构。字段值不是这个结构的部分；它们被包含在一个MYSQL_ROW结构中。

1. typedef struct st_mysql_field {
2. char *name; /* Name of column */
3. char *org_name; /* Original column name, if an alias */
4. char *table; /* Table of column if column was a field */
5. char *org_table; /* Org table name, if table was an alias */
6. char *db; /* Database for table */
7. char *catalog; /* Catalog for table */
8. char *def; /* Default value (set by mysql_list_fields) */
9. unsigned long length; /* Width of column (create length) */
10. unsigned long max_length; /* Max width for selected set */
11. unsigned int name_length;
12. unsigned int org_name_length;
13. unsigned int table_length;
14. unsigned int org_table_length;
15. unsigned int db_length;
16. unsigned int catalog_length;
17. unsigned int def_length;
18. unsigned int flags; /* Div flags */
19. unsigned int decimals; /* Number of decimals in field */
20. unsigned int charsetnr; /* Character set */
21. enum enum_field_types type; /* Type of field. See mysql_com.h for types */
22. void *extension;
23. } MYSQL_FIELD;

4、MYSQL_ROW：这是一个行数据的类型安全(type-safe)的表示。当前它实现为一个计数字节的字符串数组。（如果字段值可能包含二进制数据，你不能将这些视为空终止串，因为这样的值可以在内部包含空字节) 行通过调用mysql_fetch_row()获得。

1. typedef char **MYSQL_ROW;

1.3、API函数使用步骤
1、首先要包含mysql的头文件，并链接mysql动态库。

1. #include <mysql.h>

2、创建MYSQL变量。

1. MYSQL mysql;

3、mysql_init初始化MYSQL变量

4、调用mysql_real_connect函数连接Mysql数据库

5、调用mysql_real_query函数进行数据库查询

6、通过调用mysql_store_result或mysql_use_result函数返回的MYSQL_RES变量获取查询结果数据。

7、调用mysql_fetch_row函数读取结果集数据。

8、结果集用完后，调用mysql_free_result函数释放结果集，以防内存泄露
9、不再查询Mysql数据库时，调用mysql_close函数关闭数据库连接

2、mysql_init()——MYSQL对象初始化
2.1、函数原型及参数说明
分配或初始化与mysql_real_connect()相适应的MYSQL对象

1. MYSQL *mysql_init(MYSQL *mysql)

返回值:

• 初始化的MYSQL*句柄。如果无足够内存以分配新的对象，返回NULL。 错误,在内存不足的情况下，返回NULL。

说明：

• 如果mysql是NULL指针，该函数将分配、初始化、并返回新对象。
• 否则，将初始化对象，并返回对象的地址。
• 如果mysql_init()分配了新的对象，应当在程序中调用mysql_close() 来关闭连接，以释放对象

2.2、简单使用

1. MYSQL mysql;
2. if(NULL==mysql_init(&mysql))
3. {
4. cout << "初始化失败！"<< endl;
5. return -1;
6. }

3、mysql_real_connect()——数据库引擎建立连接
3.1、函数原型及参数说明
连接数据库引擎，通过函数mysql_real_connect()尝试与运行在主机上的MySQL数据库引擎建立连接。

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)
1
返回值

• 如果连接成功，返回MYSQL*连接句柄。
• 如果连接失败，返回NULL。对于成功的连接，返回值与第1个参数的值相同。

参数说明：

• mysql：前面定义的MYSQL变量；
• host：MYSQL服务器的地址；
• 如果“host”是NULL或字符串"localhost"，连接将被视为与本地主机的连接。
• 如果操作系统支持套接字（Unix）或命名管道（Windows），将使用它们而不是TCP/IP连接到服务器。
• user：登录用户名；
• 如果“user”是NULL或空字符串""，用户将被视为当前用户。在UNIX环境下，它是当前的登录名。
• passwd：登录密码；
• db：要连接的数据库，如果db为NULL，连接会将默认的数据库设为该值。
• port：MYSQL服务器的TCP服务端口；
• 如果“port”不是0，其值将用作TCP/IP连接的端口号。注意，“host”参数决定了连接的类型。
• unix_socket：unix连接方式。
• 如果unix_socket不是NULL，该字符串描述了应使用的套接字或命名管道。注意，“host”参数决定了连接的类型。
• clientflag：Mysql运行为ODBC数据库的标记，一般取0。

3.2、简单使用

1. if(NULL==mysql_real_connect(&mysql,"localhost","root","123456","s",0,NULL,0))
2. {
3. 　　cout << "初始化失败！"<< endl;
4. return -1;
5. }

4、mysql_query()——查询数据库某表内容
4.1、函数原型及参数说明
查询数据库中的某一个表内容，通过函数mysql_query()来实现。

1. int mysql_query(MYSQL *mysql, const char *query)
2. //query为执行的SQL语句对应的字符长串

返回值

• 如果查询成功，返回0。如果出现错误，返回非0值。

使用说明：

• 执行由“Null终结的字符串”查询指向的SQL查询。
• 正常情况下，字符串必须包含1条SQL语句，而且不应为语句添加终结分号（‘;’）或“\g”。如果允许多语句执行，字符串可包含多条由分号隔开的语句。（“多查询执行的C API处理”）
• mysql_query()不能用于包含二进制数据的查询，应使用mysql_real_query()取而代之（二进制数据可能包含字符‘\0’，mysql_query()会将该字符解释为查询字符串结束）。
• 如果希望了解查询是否应返回结果集，可使用mysql_field_count()进行检查。

1. int mysql_real_query(MYSQL *mysql, const char *q, unsigned long length);

查询成功则该函数返回0。

参数说明：

• mysql：前面定义的MYSQL变量；
• q：SQL查询语句；
• length：查询语句的长度。

4.2、简单使用

1. int ret=mysql_query(&mysql,sql);
2. if(ret!=0)
3. {
4.         cout << "sql语句不合法！" << mysql_error(&mysql)) << endl;
5.         return -1;
6. }

5、mysql_store_result()——向客户端检索完整的结果集
函数原型及参数说明
显示查询数据库中数据表的内容，mysql_store_result()将mysql_query()查询的全部结果读取到客户端，分配1个MYSQL_RES结构（上面有介绍），并将结果置于该结构中

1. MYSQL_RES *mysql_store_result(MYSQL *mysql)

返回值

具有多个结果的MYSQL_RES结果集合。如果出现错误，返回NULL。

使用说明：

• 对于成功检索了数据的每个查询（SELECT、SHOW、DESCRIBE、EXPLAIN、CHECK TABLE等），必须调用mysql_store_result()或mysql_use_result() 。
• 如果希望了解查询是否应返回结果集，可使用mysql_field_count()进行检查。
• 如果查询未返回结果集，mysql_store_result()将返回Null指针（例如，如果查询是INSERT语句）。
• 如果读取结果集失败，mysql_store_result()还会返回Null指针。通过检查mysql_error()是否返回非空字符串，mysql_errno()是否返回非0值，或mysql_field_count()是否返回0，可以检查是否出现了错误。
• 如果未返回行，将返回空的结果集。（空结果集设置不同于作为返回值的空指针）。
• 一旦调用了mysql_store_result()并获得了不是Null指针的结果，可调用mysql_num_rows()来找出结果集中的行数。
• 可以调用mysql_fetch_row()来获取结果集中的行，或调用mysql_row_seek()和mysql_row_tell()来获取或设置结果集中的当前行位置。
• 一旦完成了对结果集的操作，必须调用mysql_free_result()。

5.1、mysql_fetch_row()——从结果集中获取下一行

1. MYSQL_ROW mysql_fetch_row(MYSQL_RES* result)
2. //MYSQL_ROW开篇已经说明，char ** 类型

返回值

• 下一行的MYSQL_ROW结构。如果没有更多要检索的行或出现了错误，返回NULL。

使用说明：

• 在mysql_store_result()之后使用时，如果没有要检索的行，mysql_fetch_row()返回NULL。
• 在mysql_use_result()之后使用时，如果没有要检索的行或出现了错误，mysql_fetch_row()返回NULL。
• 行内值的数目由mysql_num_fields(result)给出。如果行中保存了调用mysql_fetch_row()返回的值，将按照row[0]到row[mysql_num_fields(result)-1]，访问这些值的指针。
• 可以通过调用mysql_fetch_lengths()来获得行中字段值的长度。对于空字段以及包含NULL的字段，长度为0。通过检查字段值的指针，能够区分它们。如果指针为NULL，字段为NULL，否则字段为空。

5.2、mysql_field_count()——返回表的列数
返回作用在连接上的最近查询的列数。

1. unsigned int mysql_field_count(MYSQL *mysql)

返回值

表示结果集中列数的无符号整数。
使用说明：
该函数的正常使用是在mysql_store_result()返回NULL（因而没有结果集指针）时。在这种情况下，可调用mysql_field_count()来判定mysql_store_result()是否应生成非空结果。

这样，客户端就能采取恰当的动作，而无需知道查询是否是SELECT（或类似SELECT的）语句。

5.3、mysql_fetch_fields()——来获取表头的内容
对于结果集，返回所有MYSQL_FIELD结构的数组。每个结构提供了结果集中1列的字段定义。

1. MYSQL_FIELD *mysql_fetch_fields(MYSQL_RES *result)
2. //MYSQL_FIELD 开篇已经说明

返回值

• 关于结果集所有列的MYSQL_FIELD结构的数组。

示例：

1. result = mysql_store_result(&mysql);
2. unsigned int num_fields;
3. unsigned int i;
4. MYSQL_FIELD *fields;
6. num_fields = mysql_num_fields(result);
7. fields = mysql_fetch_fields(result);
8. for(i = 0; i < num_fields; i++)
9. {
10.         printf("Field %u is %s\n", i, fields[i].name);
11. }

5.4、简单使用

1. MYSQL_RES *result=NULL;
2. MYSQL_ROW row = NULL;
3. int num_rows,num_fields;
4. result = mysql_store_result(&mysql);
5. num_rows=mysql_num_rows(result);
6. num_fields=mysql_num_fields(result);
7. printf("行数：%d,列数:%d\n",num_rows,num_fields);
8. for(int i=0;i<num_rows;i++)
9. {
10.         row=mysql_fetch_row(result);//从结果集中获取下一行
11.         for(int j=0;j<num_fields;j++)
12.        { 
13.               printf("%s\t",row[j]);
14.        }
15.        printf("\n");
16. }

6、mysql_use_result()——启动逐行结果集检索
6.1、函数原型及参数说明
调用mysql_use_result初始化检索，以便于后面一行一行的读取结果集，而它本身并没有从服务器读取任何数据，这种方式较之第一种速度更快且所需内存更少，但它会绑定服务器，阻止其他线程更新任何表，而且必须重复执行mysql_fetch_row读取数据，直至返回NULL，否则未读取的行会在下一次查询时作为结果的一部分返回，故经常我们使用mysql_store_result。

1. MYSQL_RES * mysql_use_result(MYSQL *mysql);

7、mysql_free_result()——释放结果集使用的内存
7.1、函数原型及参数说明
释放由mysql_store_result()、mysql_use_result()、mysql_list_dbs()等为结果集分配的内存。完成对结果集的操作后，必须调用mysql_free_result()释放结果集使用的内存。

1. void mysql_free_result(MYSQL_RES *result)

释放完成后，不要尝试访问结果集。

8、mysql_close()——关闭数据库连接
8.1、函数原型及参数说明
关闭前面打开的连接。如果句柄是由mysql_init()或mysql_connect()自动分配的，mysql_close()还将解除分配由mysql指向的连接句柄。

1. void mysql_close(MYSQL *mysql)

9、应用实例

1. #include <stdio.h>
2. #include <stdlib.h>
3. #include <string.h>
4. #include <mysql/mysql.h>
5. int main()
6. {
7.         int ret = 0;
8.         MYSQL mysql;
9.         MYSQL * connect = NULL;
10.         connect = mysql_init(&mysql);
11.         if(connect == NULL){
12.                 ret = mysql_errno(&mysql);
13.                 printf("mysql_init error, %s\n", mysql_error(&mysql));
14.                 return ret;
15.         }
16.         printf("mysql_init ok...\n");
17.         connect = mysql_real_connect(connect, "localhost", "root", "yxk", "test", 0, NULL, 0);
18.         if(connect == NULL){
19.                 ret = mysql_errno(&mysql);
20.                 printf("mysql_real_connect error, err is: %s\n", mysql_error(&mysql));
21.                 return ret;
22.         }
23.         printf("mysql_real_connect ok...\n");
24.         const char * query = "select * from department";
25.         ret = mysql_query(connect, query);
26.         if(ret != 0){
27.                 printf("mysql_query error\n");
28.                 return ret;
29.         }
30.         MYSQL_RES *result = mysql_store_result(&mysql);
31.         if(result == NULL){
32.                 printf("mysql_store_result error\n");
33.                 return -1;
34.         }
35.         int field_num = mysql_field_count(&mysql);
37.         //表头
38.         MYSQL_FIELD * fields = mysql_fetch_fields(result);
39.         int i = 0;
40.         printf("------------------------------------------\n");
41.         for(i= 0; i < field_num; i++){
42.                 printf("%s \t", fields[i].name);
43.         }
44.         printf("\n------------------------------------------\n");
46.         //表内容
47.         MYSQL_ROW row = NULL;
48.         while(row = mysql_fetch_row(result)){
49.                 for(i= 0; i < field_num; i++){
50.                         printf("%s \t", row[i]);
51.                 }
52.                 printf("\n");
53.         }
55.         mysql_free_result(result);//释放内存
56.         mysql_close(connect);
57.         printf("mysql_close...\n");
58.         
59.         return 0;
60. }

编译：

　　gcc mysql_test.c -o mysql_test -lmysqlclient

参考
1、https://blog.csdn.net/zxng_work/article/details/78926413
2、https://www.cnblogs.com/Corphish/p/7144162.html
3、https://blog.csdn.net/da_guo_li/article/details/80280289
4、https://blog.csdn.net/Linux_ever/article/details/50651513

转 Mysql接口API相关函数详细使用说明——mysql_init,mysql_real_connect,mysql_query,mysql_close等相关_mysql_init mysql_real_connect-CSDN博客