MYSQL 语言C API的常用函数

迈不过友情╰ 2022-09-25 04:28 231阅读 0赞

### 1.MYSQL C API的常用函数 ###

#### 1.1数据类型 ####

MYSQL  
该结构代表1个数据库连接的句柄。几乎所有的MYSQL函数均使用它。  
MYSQL\_RES  
该结构代表返回行的查询结果  
MYSQL\_ROW  
这是1行数据的”类型安全”表示。  
MYSQL\_FIELD  
该结构包含关于字段的信息，如字段名、类型和大小等  
MYSQL\_FIELD\_OFFSET  
这时MYSQL字段列表偏移量的”类型安全”表示  
my\_ulonglong  
用于行数以及mysql\_affected\_rows()、mysql\_num\_rows()和mysql\_insert\_id()的类型

#### 1.2编程步骤 ####

1 通过调用mysql\_library\_init(),初始化MYSQL库  
2 通过调用mysql\_init()初始化连接处理程序，并通过调用mysql\_real\_connect()连接到服务器  
3 发出SQL语句并处理其结果  
4 通过调用mysql\_close()，关闭与MYSQL服务器的连接  
5 通过调用mysql\_library\_end()，结束MYSQL库的使用

#### 1.3数据库连接 ####

1.3.1初始化一个连接句柄结构  
\#include <mysql.h>  
MYSQL *mysql\_init(MYSQL* );  
1.3.2和数据库建立物理连接  
MYSQL \*mysql\_real\_connect(MYSQL \*connection,  
const char \*server\_host,const char \*sql\_user\_name,  
const char \*sql\_password,const char \*db\_name,  
unsigned intport\_number,const char  
\*unix\_socket\_name,unsignedint flags);  
1.3.3连接参数  
Intmysql\_options(MYSQL \*connection,enum  
option\_to\_set,const char \*argument)

#### 1.4错误处理 ####

unsigned intmysql\_errno(MYSQL \*connection);  
对于由mysql指定的连接，该函数返回最近调用的API函数的错误代码，该函数调用可能成功也可能失败。”0”返回值表示未出现错误  
char \*mysql\_error(MYSQL \*connection)  
如果想获得错误的文本信息，可以调用该函数

#### 1.5执行SQL语句 ####

intmysql\_query(MYSQL \*mysql,const char \*query)  
功能描述：  
执行由”Null终结的字符串”查询指向的SQL查询。正常情况下，字符串必 须 包含1条SQL语句，而且不应为语句添加终结分号或”\\g”  
不能用于包含二进制数据的查询，应使用mysql\_real\_query来完成  
对于操纵语句

My\_ulonglongmysql\_affected\_rows(MYSQL \*mysql)  
返回上次操纵语句所涉及到记录的行数  
对于UPDATE、DELETE或INSERT语句，可在mysql\_query()后立刻调用。对于SELECT语句，该函数的工作方式与mysql\_num\_rows()类似

对于查询语言  
MYSQL\_RES \*mysql\_store\_result(MYSQL \*mysql)  
功能说明：  
对于成功检索了数据的每个查询，必须调用mysql\_store\_result()或mysql\_use\_result()  
该函数将查询的全部结果读取到客户端，分配1个MYSQL\_RES结构，并将结果置于该结构中  
可以通过mysql\_num\_rows来找出结果集中的行数

事务处理  
my\_boolmysql\_autocommit(MYSQL \*mysql,my\_bool mode)  
函数说明:如果模式为1,启动autocommit模式；如果模式为0，禁止autocommit模式  
my\_boolmysql\_commit(MYSQL \*mysql)  
提交当前事务  
my\_boolmysql\_rollback(MYSQL \*mysql)  
回滚当前事务

处理结果集  
MYSQL\_ROW mysql\_fetch\_row(MYSQL\_RES \*result)  
功能描述  
检索结果集的下一行  
行内值的数目由mysql\_num\_fields(result)给出

void mysql\_data\_seek(MYSQL\_RES \*result,my\_ulonglong offset)  
功能描述：  
在查询结果集中寻找任意行。偏移值为行号。  
该函数要求结果集结构包含查询的所有结果

MYSQL\_ROW\_OFFSET mysql\_row\_tell(MYSQL\_RES \*result)  
返回光标的当前位置

MYSQL\_ROW\_OFFSET mysql\_row\_seek(MYSQL\_RES \*result,MYSQL\_ROW\_OFFSET offset)  
将行光标置于查询结果集中的任意行

每次接收一行数据  
MYSQL\_RES \*mysql\_use\_result(MYSQL \*mysql)  
功能说明：  
不像mysql\_store\_result()那样把结果集实际读取到客户端。它必须通过对mysql\_fetch\_row()的调用，对每一行分别进行检索。  
Mysql\_store\_result()相比，速度更快而且使用的内存更少

多查询执行的C API处理  
支持在单个字符串中指定的多语句的执行。要想与给定的连接一起使用该功能，打开连接时，必须将标志参数中的CLIENT\_MULTI\_STATEMENTS选项指定给mysql\_real\_connect()。也可以通过调用mysql\_set\_server\_option(MYSQL\_OPTION\_MULTI\_STATEMENTS\_ON)，为已有的连接设置它

#### 1.5详细api列表 ####

MYSQL \*mysql\_init(MYSQL \*mysql)  
分配或初始化与mysql\_real\_connect()相适应的MYSQL对象。  
如果mysql是NULL指针，该函数将分配、初始化、并返回新对象。否则，将初始化对象，并返回对象的地址。  
如果mysql\_init()分配了新的对象，当调用mysql\_close()来关闭连接时。将释放该对象。  
void mysql\_close(MYSQL \*mysql)  
关闭前面打开的连接。  
如果句柄是由mysql\_init()或mysql\_connect()自动分配的，mysql\_close()还将解除分配由mysql指向的连接句柄。  
mysql\_real\_connect函数  
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)  
函数功能:尝试与运行在主机上的MySQL数据库引擎建立连接  
connect = mysql\_real\_connect(&mysql, “localhost”, “root”, “123456”, “mydb2”, 0, NULL, 0 );

查询api  
mysql\_query()函数和mysql\_real\_query()函数  
intmysql\_query(MYSQL \*mysql, const char \*query)  
intmysql\_real\_query(MYSQL \*mysql, const char \*query, unsigned long length)  
对于包含二进制数据的查询，必须使用mysql\_real\_query()而不是mysql\_query()，  
mysql\_real\_query()比mysql\_query()快，这是因为它不会在查询字符串上调用strlen()。

获取结果集api  
mysql\_store\_result()函数和mysql\_use\_result  
MYSQL\_RES \*mysql\_store\_result(MYSQL \*mysql)  
mysql\_store\_result()将查询的全部结果读取到客户端，分配1个MYSQL\_RES结构，并将结果置于该结构中；  
可调用mysql\_num\_rows()来找出结果集中的行数。可以调用mysql\_fetch\_row()来获取结果集中的行，或调用mysql\_row\_seek()和mysql\_row\_tell()来获取或设置结果集中的当前行位置。  
一旦完成了对结果集的操作，必须调用mysql\_free\_result()。

MYSQL\_RES \*mysql\_use\_result(MYSQL \*mysql)每次接收一行数据  
功能说明：  
不像mysql\_store\_result()那样把结果集实际读取到客户端。它必须通过对mysql\_fetch\_row()的调用，对每一行分别进行检索。  
Mysql\_store\_result()相比，速度更快而且使用的内存更少

### 2.1调用思路分析 ###

#### 2.1 简介 ####

访问MySQL服务器，这需要使用mysqlclient库，MySQL的大多数客户端API（除了  
Java和.NET）都是通过这个库来和MySQL服务器通讯的，而这个库正是用C编写的。

#### 2.2代码编写和编译 ####

#### 2.3连接MySQL服务器 ####

初始化一个MYSQL结构，该结构在几乎所有的MySQL C API函数（除了预处理语句相关的函数）中都会用到。MYSQL \*mysql\_init(MYSQL \*mysql)  
连接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);  
也可另一种方式来进行连接。先用MYSQL\_READ\_DEFAULT\_FILE作为选项名来调用mysql\_options(), 再调用mysql\_real\_connect()来连接服务器;  
mysql\_options(\*mysql, MYSQL\_READ\_DEFAULT\_FILE, “my.cnf”)  
mysql\_real\_connect(\*mysql, NULL, NULL, NULL, NULL, 0, NULL, 0)  
说明：my.cnf文件中记录了连接MySQL服务器所需的各项参数（地址，端口，用户名，密  
码，数据库，字符集，Unix Socket等）。这样可以灵活的修改连接参数而不必重新编译程序。  
要关闭连接，则调用mysql\_close()  
voidmysql\_close(MYSQL \*mysql)

#### 2.4执行查询 ####

1）调用mysql\_query()来执行SQL语句，如果语句中包含二进制数据，则需要调用  
mysql\_real\_query()  
intmysql\_query(MYSQL \*mysql, const char \*stmt\_str)  
intmysql\_real\_query(MYSQL \*mysql, const char \*stmt\_str, unsigned long length)

2）若执行的是UPDATE, DELETE或INSERT语句，则可通过mysql\_affected\_rows()获知  
受影响的记录数。my\_ulonglongmysql\_affected\_rows(MYSQL \*mysql) 。  
还可以通过mysql\_insert\_id()来获取由最近的UPDATE或INSERT语句生成的自增值。  
my\_ulonglongmysql\_insert\_id(MYSQL \*mysql)

3）若执行的是SELECT语句，则有两种方式来获取结果集。  
3-1）一种方式是通过mysql\_store\_result()将整个结果集全部取回来。  
MYSQL\_RES \*mysql\_store\_result(MYSQL \*mysql)  
3-2）另一种方式则是调用mysql\_use\_result()初始化获取操作，但暂时不取回任何记录。MYSQL\_RES \*mysql\_use\_result(MYSQL \*mysql)；  
3-3两种方法均通过mysql\_fetch\_row()来访问每一条记录。  
MYSQL\_ROW mysql\_fetch\_row(MYSQL\_RES \*result)  
注意：若先前调用的是mysql\_store\_result(), 则直接在本地访问记录；若先前调用的是mysql\_use\_result(), 则此时才到服务器上去获取记录。

4）当处理完结果集后，调用mysql\_free\_result()来释放它所占的内存。void mysql\_free\_result(MYSQL\_RES \*result)。

5）可调用mysql\_errno()和mysql\_error()来获知最近执行的API函数的错误代码和错误信息。  
unsignedintmysql\_errno(MYSQL \*mysql)  
const char \*mysql\_error(MYSQL \*mysql)

#### 2.5. 预处理语句(Prepared Statements) ####

MySQL C API还提供了另一种方式来执行SQL语句，即先预处理(prepare)再执行  
(execute). 对于多次执行的SQL语句，该方式可以提高其执行效率。具体步骤如下：

1.  调用mysql\_stmt\_init()创建语句句柄，该句柄在随后的函数调用中都要用到。  
    MYSQL\_STMT \*mysql\_stmt\_init(MYSQL \*mysql)
2.  调用mysql\_stmt\_prepare()对SQL语句进行预处理  
    intmysql\_stmt\_prepare(MYSQL\_STMT \*stmt, const char \*stmt\_str, unsigned long length)
3.  如果SQL语句中有参数，则需要调用mysql\_stmt\_bind\_param()进行参数绑定。  
    my\_boolmysql\_stmt\_bind\_param(MYSQL\_STMT \*stmt, MYSQL\_BIND \*bind)  
    如果参数的类型为TEXT或BLOB, 并且数据量很大，可以调用  
    mysql\_stmt\_send\_long\_data()来向服务器发送数据。  
    my\_boolmysql\_stmt\_send\_long\_data(MYSQL\_STMT \*stmt, unsigned intparameter\_number, const char \*data, unsigned long length)
4.  调用mysql\_stmt\_execute()来执行查询。  
    intmysql\_stmt\_execute(MYSQL\_STMT \*stmt)
5.  若查询不产生结果集，可以调用  
    mysql\_stmt\_affected\_rows()和  
    my\_ulonglongmysql\_stmt\_insert\_id(MYSQL\_STMT \*stmt)来获得被改变的记录数和生成的自增值。  
    my\_ulonglongmysql\_stmt\_affected\_rows(MYSQL\_STMT \*stmt)  
    my\_ulonglongmysql\_stmt\_insert\_id(MYSQL\_STMT \*stmt)  
    否则，执行mysql\_stmt\_bind\_result()对结果集中的字段进行绑定。  
    my\_boolmysql\_stmt\_bind\_result(MYSQL\_STMT \*stmt, MYSQL\_BIND \*bind)

#### 2.6. 调用mysql\_stmt\_fetch()来逐行获取结果集中的记录。 ####

intmysql\_stmt\_fetch(MYSQL\_STMT \*stmt)  
在调用mysql\_stmt\_fetch()之前，还可以执行mysql\_stmt\_store\_result()将结果  
集预先缓存到本地。  
intmysql\_stmt\_store\_result(MYSQL\_STMT \*stmt)

#### 2.7. 重复步骤3-6, 每次使用不同的实参来执行查询。 ####

#### 2.8. 调用mysql\_stmt\_close()关闭句柄，释放资源 ####

my\_boolmysql\_stmt\_close(MYSQL\_STMT \*)  
此外，可以调用mysql\_stmt\_errno()和mysql\_stmt\_error()来获知最近执行的预处  
理语句API函数的错误代码和错误信息。  
unsignedintmysql\_stmt\_errno(MYSQL\_STMT \*stmt)  
const char \*mysql\_stmt\_error(MYSQL\_STMT \*stmt)

#### 2.9.其他说明： ####

mysql\_stmt\_execute()中有调用案例  
[http://dev.mysql.com/doc/refman/5.1/zh/apis.html\#c-api-multiple-queries][http_dev.mysql.com_doc_refman_5.1_zh_apis.html_c-api-multiple-queries]  
25.2.7.11. mysql\_stmt\_fetch()

[http_dev.mysql.com_doc_refman_5.1_zh_apis.html_c-api-multiple-queries]: http://dev.mysql.com/doc/refman/5.1/zh/apis.html#c-api-multiple-queries