SQL 语句中最明显的部分是语句的文本。客户端还可以定义查询属性,这些属性应用于发送到服务器以供执行的下一条语句。
属性是在发送语句之前定义的。
属性一直存在,直到语句执行结束,此时属性集将被清除。
属性存在时,可以在服务器端访问它们。
查询属性使用方式的示例:
Web 应用程序生成生成数据库查询的页面,并且对于每个查询,必须跟踪生成该查询的页面的 URL。
应用程序使用每个查询传递额外的处理信息,供插件使用,例如审计插件或查询重写插件。
MySQL 支持这些功能,而无需使用变通方法,例如包含在查询字符串中的特殊格式的注释。本节的其余部分介绍了如何使用查询属性支持,包括必须满足的先决条件。
使用 MySQL C API 的应用程序通过调用 mysql_bind_param()
函数来定义查询属性。请参阅 mysql_bind_param()。其他 MySQL 连接器也可能会提供查询属性支持。请参阅各个连接器的文档。
mysql 客户端有一个 query_attributes
命令,可以定义最多 32 对属性名称和值。请参阅 第 6.5.1.2 节,“mysql 客户端命令”。
查询属性名称使用 character_set_client
系统变量指示的字符集传输。
要在已为其定义属性的 SQL 语句中访问查询属性,请安装 query_attributes
组件,如 使用查询属性的先决条件 中所述。该组件实现了一个 mysql_query_attribute_string()
可加载函数,该函数接受一个属性名称参数,并以字符串形式返回属性值,如果属性不存在,则返回 NULL
。请参阅 查询属性可加载函数。
以下示例使用 mysql 客户端的 query_attributes
命令来定义属性名称/值对,并使用 mysql_query_attribute_string()
函数按名称访问属性值。
此示例定义了两个名为 n1
和 n2
的属性。第一个 SELECT
显示了如何检索这些属性,还演示了检索不存在的属性(n3
)会返回 NULL
。第二个 SELECT
显示属性不会跨语句持久化。
mysql> query_attributes n1 v1 n2 v2;
mysql> SELECT
mysql_query_attribute_string('n1') AS 'attr 1',
mysql_query_attribute_string('n2') AS 'attr 2',
mysql_query_attribute_string('n3') AS 'attr 3';
+--------+--------+--------+
| attr 1 | attr 2 | attr 3 |
+--------+--------+--------+
| v1 | v2 | NULL |
+--------+--------+--------+
mysql> SELECT
mysql_query_attribute_string('n1') AS 'attr 1',
mysql_query_attribute_string('n2') AS 'attr 2';
+--------+--------+
| attr 1 | attr 2 |
+--------+--------+
| NULL | NULL |
+--------+--------+
如第二个 SELECT
语句所示,在给定语句之前定义的属性仅对该语句可用,并且在语句执行后会被清除。要在多个语句中使用属性值,请将其分配给一个变量。以下示例显示了如何执行此操作,并说明了可以通过变量在后续语句中使用属性值,但不能通过调用 mysql_query_attribute_string()
来使用。
mysql> query_attributes n1 v1 n2 v2;
mysql> SET
@attr1 = mysql_query_attribute_string('n1'),
@attr2 = mysql_query_attribute_string('n2');
mysql> SELECT
@attr1, mysql_query_attribute_string('n1') AS 'attr 1',
@attr2, mysql_query_attribute_string('n2') AS 'attr 2';
+--------+--------+--------+--------+
| @attr1 | attr 1 | @attr2 | attr 2 |
+--------+--------+--------+--------+
| v1 | NULL | v2 | NULL |
+--------+--------+--------+--------+
属性也可以通过将其存储在表中来保存以供以后使用。
mysql> CREATE TABLE t1 (c1 CHAR(20), c2 CHAR(20));
mysql> query_attributes n1 v1 n2 v2;
mysql> INSERT INTO t1 (c1, c2) VALUES(
mysql_query_attribute_string('n1'),
mysql_query_attribute_string('n2')
);
mysql> SELECT * FROM t1;
+------+------+
| c1 | c2 |
+------+------+
| v1 | v2 |
+------+------+
查询属性受以下限制:
如果在将语句发送到服务器执行之前发生了多个属性定义操作,则最新的定义操作将适用并替换在早期操作中定义的属性。
如果使用相同的名称定义了多个属性,则尝试检索属性值的结果将不确定。
使用空名称定义的属性无法按名称检索。
使用
PREPARE
准备的语句无法使用属性。mysql_query_attribute_string()
函数不能在 DDL 语句中使用。属性不会被复制。调用
mysql_query_attribute_string()
函数的语句在所有服务器上都不会获得相同的值。
要在已为其定义属性的 SQL 语句中访问查询属性,必须安装 query_attributes
组件。请使用以下语句执行此操作:
INSTALL COMPONENT "file://component_query_attributes";
组件安装是一次性操作,不需要每次服务器启动时都执行。INSTALL COMPONENT
加载组件,并在 mysql.component
系统表中注册它,以便在后续服务器启动期间加载它。
query_attributes
组件访问查询属性以实现 mysql_query_attribute_string()
函数。请参阅 第 7.5.4 节,“查询属性组件”。
要卸载 query_attributes
组件,请使用以下语句:
UNINSTALL COMPONENT "file://component_query_attributes";
UNINSTALL COMPONENT
卸载组件,并将其从 mysql.component
系统表中取消注册,以便在后续服务器启动期间不加载它。
由于安装和卸载 query_attributes
组件会安装和卸载该组件实现的 mysql_query_attribute_string()
函数,因此无需使用 CREATE FUNCTION
或 DROP FUNCTION
来执行此操作。
mysql_query_attribute_string(
name
)应用程序可以定义应用于发送到服务器的下一个查询的属性。
mysql_query_attribute_string()
函数在给定属性名称的情况下以字符串形式返回属性值。此函数允许查询访问并合并应用于它的属性的值。mysql_query_attribute_string()
是通过安装query_attributes
组件来安装的。请参阅 第 11.6 节,“查询属性”,其中还讨论了查询属性的用途和用法。参数
name
:属性名称。
返回值
成功时以字符串形式返回属性值,如果属性不存在,则返回
NULL
。示例
以下示例使用 mysql 客户端的
query_attributes
命令来定义可以由mysql_query_attribute_string()
检索的查询属性。SELECT
显示检索不存在的属性(n3
)会返回NULL
。mysql> query_attributes n1 v1 n2 v2; mysql> SELECT -> mysql_query_attribute_string('n1') AS 'attr 1', -> mysql_query_attribute_string('n2') AS 'attr 2', -> mysql_query_attribute_string('n3') AS 'attr 3'; +--------+--------+--------+ | attr 1 | attr 2 | attr 3 | +--------+--------+--------+ | v1 | v2 | NULL | +--------+--------+--------+