版本 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()`	上一个语句的警告计数