本节介绍 C API 数据结构,但不包括用于预处理语句、异步接口或复制流接口的结构。有关这些内容的信息,请参阅第 6.2 节“C API 预处理语句数据结构”、第 7.2 节“C API 异步接口数据结构”和第 10.2 节“C API 二进制日志数据结构”。
-
此结构表示一个数据库连接的句柄。它几乎用于所有 MySQL 函数。请勿尝试复制
MYSQL结构。无法保证此类副本可用。 -
此结构表示返回行的查询的结果(
SELECT、SHOW、DESCRIBE、EXPLAIN)。在本节的其余部分,从查询返回的信息称为结果集。 -
这是对一行数据的类型安全表示形式。它当前实现为一个计数字节字符串数组。(如果字段值可能包含二进制数据,则不能将它们视为以 null 结尾的字符串,因为此类值在内部可能包含 null 字节。)通过调用
mysql_fetch_row()获取行。 -
此结构包含元数据:有关字段的信息,例如字段的名称、类型和大小。其成员将在本节后面详细介绍。您可以通过重复调用
mysql_fetch_field()来获取每个字段的MYSQL_FIELD结构。字段值不是此结构的一部分;它们包含在MYSQL_ROW结构中。 -
这是对 MySQL 字段列表中偏移量的类型安全表示形式。(由
mysql_field_seek()使用。)偏移量是行内的字段编号,从零开始。 -
用于 64 位无符号整数的类型。在 MySQL 8.0.18 之前使用
my_ulonglong类型。从 MySQL 8.0.18 开始,请改用uint64_tC 类型。 -
布尔类型,用于值为 true(非零)或 false(零)。在 MySQL 8.0 之前使用
my_bool类型。从 MySQL 8.0 开始,请改用bool或intC 类型。注意从
my_bool到bool的更改意味着编译mysql.h头文件需要 C++ 或 C99 编译器。
MYSQL_FIELD 结构包含以下列表中描述的成员。这些定义主要适用于结果集的列,例如 SELECT 语句生成的结果集。MYSQL_FIELD 结构也用于提供从使用预处理 CALL 语句执行的存储过程中返回的 OUT 和 INOUT 参数的元数据。对于此类参数,某些结构成员的含义与列值的含义不同。
要以交互方式查看结果集的 MYSQL_FIELD 成员值,请使用 --column-type-info 选项启动 mysql 客户端,然后执行一些示例查询。
-
char * name字段的名称,以 null 结尾的字符串。如果使用
AS子句为字段指定了别名,则name的值是别名。对于过程参数,为参数名称。 -
char * org_name字段的名称,以 null 结尾的字符串。忽略别名。对于表达式,该值为一个空字符串。对于过程参数,为参数名称。
-
char * table如果该字段不是计算字段,则为包含该字段的表的名称。对于计算字段,
table值为空字符串。如果该列是从视图中选择的,则table将命名该视图。如果使用AS子句为表或视图指定了别名,则table的值是别名。对于UNION,该值为空字符串。对于过程参数,为过程名称。 -
char * org_table表的名称,以 null 结尾的字符串。忽略别名。如果该列是从视图中选择的,则
org_table将命名该视图。如果该列是从派生表中选择的,则org_table将命名基表。如果派生表包装了一个视图,则org_table仍然命名基表。如果该列是一个表达式,则org_table为空字符串。对于UNION,该值为空字符串。对于过程参数,该值为过程名称。 -
char * db字段所属数据库的名称,以 null 结尾的字符串。如果该字段是计算字段,则
db为空字符串。对于UNION,该值为空字符串。对于过程参数,为包含该过程的数据库的名称。 -
char * catalog目录名称。该值始终为
"def"。 -
char * def该字段的默认值,以 null 结尾的字符串。仅当您使用
mysql_list_fields()时才会设置此值。 -
unsigned long length字段的宽度。这对应于显示长度(以字节为单位)。
服务器在生成结果集之前确定
length值,因此这是能够容纳结果列中最大值的的数据类型所需的最小长度,而无需事先知道查询为结果集生成的实际值。对于字符串列,
length值取决于连接字符集。例如,如果字符集为latin1(单字节字符集),则SELECT 'abc'查询的length值为 3。如果字符集为utf8mb4(多字节字符集,其中字符最多占用 4 个字节),则length值为 12。 -
unsigned long max_length结果集中字段的最大宽度(结果集中实际存在的行中最长字段值的长度,以字节为单位)。如果您使用
mysql_store_result()或mysql_list_fields(),则该字段包含字段的最大长度。如果您使用mysql_use_result(),则此变量的值为零。max_length的值是结果集中值的字符串表示形式的长度。例如,如果检索FLOAT列且 “最宽” 值为-12.345,则max_length为 7('-12.345'的长度)。如果使用预处理语句,则默认情况下不会设置
max_length,因为对于二进制协议,值的长度取决于结果集中值的类型。(请参阅 第 6.2 节“C API 预处理语句数据结构”。)如果仍然需要max_length值,请使用mysql_stmt_attr_set()启用STMT_ATTR_UPDATE_MAX_LENGTH选项,这些长度将在调用mysql_stmt_store_result()时设置。(请参阅 第 6.4.3 节“mysql_stmt_attr_set()” 和 第 6.4.29 节“mysql_stmt_store_result()”。) -
无符号整数 name_lengthname的长度。 -
无符号整数 org_name_lengthorg_name的长度。 -
无符号整数 table_lengthtable的长度。 -
无符号整数 org_table_lengthorg_table的长度。 -
无符号整数 db_lengthdb的长度。 -
无符号整数 catalog_lengthcatalog的长度。 -
无符号整数 def_lengthdef的长度。 -
无符号整数 flags描述字段的位标志。
flags值可以设置下表中显示的一个或多个位。标志值 标志说明 NOT_NULL_FLAG字段不能为空 NULLPRI_KEY_FLAG字段是主键的一部分 UNIQUE_KEY_FLAG字段是唯一键的一部分 MULTIPLE_KEY_FLAG字段是非唯一键的一部分 UNSIGNED_FLAG字段具有 UNSIGNED属性ZEROFILL_FLAG字段具有 ZEROFILL属性BINARY_FLAG字段具有 BINARY属性AUTO_INCREMENT_FLAG字段具有 AUTO_INCREMENT属性ENUM_FLAG字段是 ENUMSET_FLAG字段是 SETBLOB_FLAG字段是 BLOB或TEXT(已弃用)TIMESTAMP_FLAG字段是 TIMESTAMP(已弃用)NUM_FLAG字段是数值型的;请参阅下表后面的附加说明 NO_DEFAULT_VALUE_FLAG字段没有默认值;请参阅下表后面的附加说明 其中一些标志指示数据类型信息,并由稍后描述的
field->type成员中的MYSQL_TYPE_值取代或与其结合使用xxxNUM_FLAG指示列是数值型的。这包括类型为MYSQL_TYPE_DECIMAL、MYSQL_TYPE_NEWDECIMAL、MYSQL_TYPE_TINY、MYSQL_TYPE_SHORT、MYSQL_TYPE_LONG、MYSQL_TYPE_FLOAT、MYSQL_TYPE_DOUBLE、MYSQL_TYPE_NULL、MYSQL_TYPE_LONGLONG、MYSQL_TYPE_INT24和MYSQL_TYPE_YEAR的列。NO_DEFAULT_VALUE_FLAG指示列在其定义中没有DEFAULT子句。这不适用于NULL列(因为此类列的默认值为NULL)或AUTO_INCREMENT列(它们具有隐含的默认值)。以下示例说明了
flags值的典型用法if (field->flags & NOT_NULL_FLAG) printf("Field cannot be null\n");您可以使用下表中显示的便捷宏来确定
flags值的布尔状态。 -
无符号整数 decimals数值字段的小数位数,以及时间字段的小秒精度。
-
无符号整数 charsetnr一个 ID 号,指示字段的字符集/排序规则对。
通常,结果集中的字符值将转换为
character_set_results系统变量指示的字符集。在这种情况下,charsetnr对应于该变量指示的字符集。可以通过将character_set_results设置为NULL来禁止字符集转换。在这种情况下,charsetnr对应于原始表列或表达式的字符集。另请参阅 连接字符集和排序规则。要区分字符串数据类型的二进制数据和非二进制数据,请检查
charsetnr值是否为 63。如果是,则字符集为binary,这表示二进制数据而不是非二进制数据。这使您能够区分BINARY和CHAR、VARBINARY和VARCHAR以及BLOB类型和TEXT类型。charsetnr值与SHOW COLLATION语句的Id列或INFORMATION_SCHEMACOLLATIONS表的ID列中显示的值相同。您可以使用这些信息源来查看哪些字符集和排序规则由特定的charsetnr值指示mysql> SHOW COLLATION WHERE Id = 63; +-----------+---------+----+---------+----------+---------+ | Collation | Charset | Id | Default | Compiled | Sortlen | +-----------+---------+----+---------+----------+---------+ | binary | binary | 63 | Yes | Yes | 1 | +-----------+---------+----+---------+----------+---------+ mysql> SELECT COLLATION_NAME, CHARACTER_SET_NAME FROM INFORMATION_SCHEMA.COLLATIONS WHERE ID = 33; +-----------------+--------------------+ | COLLATION_NAME | CHARACTER_SET_NAME | +-----------------+--------------------+ | utf8_general_ci | utf8 | +-----------------+--------------------+ -
枚举 enum_field_types 类型字段的类型。
type值可以是下表中显示的MYSQL_TYPE_符号之一。类型值 类型说明 MYSQL_TYPE_TINYTINYINT字段MYSQL_TYPE_SHORTSMALLINT字段MYSQL_TYPE_LONGINTEGER字段MYSQL_TYPE_INT24MEDIUMINT字段MYSQL_TYPE_LONGLONGBIGINT字段MYSQL_TYPE_DECIMALDECIMAL或NUMERIC字段MYSQL_TYPE_NEWDECIMAL精确数学 DECIMAL或NUMERICMYSQL_TYPE_FLOATFLOAT字段MYSQL_TYPE_DOUBLEDOUBLE或REAL字段MYSQL_TYPE_BITBIT字段MYSQL_TYPE_TIMESTAMPTIMESTAMP字段MYSQL_TYPE_DATEDATE字段MYSQL_TYPE_TIMETIME字段MYSQL_TYPE_DATETIMEDATETIME字段MYSQL_TYPE_YEARYEAR字段MYSQL_TYPE_STRINGCHAR或BINARY字段MYSQL_TYPE_VAR_STRINGVARCHAR或VARBINARY字段MYSQL_TYPE_BLOBBLOB或TEXT字段(使用max_length确定最大长度)MYSQL_TYPE_SETSET字段MYSQL_TYPE_ENUMENUM字段MYSQL_TYPE_GEOMETRY空间字段 MYSQL_TYPE_NULLNULL类型字段MYSQL_TYPE_TIME2、MYSQL_TYPE_DATETIME2和MYSQL_TYPE_TIMESTAMP2) 类型代码仅在服务器端使用。客户端看到的是MYSQL_TYPE_TIME、MYSQL_TYPE_DATETIME和MYSQL_TYPE_TIMESTAMP代码。您可以使用
IS_NUM()宏来测试字段是否具有数值类型。将type值传递给IS_NUM(),如果字段是数值型的,则它将计算结果为 TRUEif (IS_NUM(field->type)) printf("Field is numeric\n");ENUM和SET值作为字符串返回。对于这些值,请检查type值是否为MYSQL_TYPE_STRING以及flags值中是否设置了ENUM_FLAG或SET_FLAG标志。