MySQL 8.0 参考手册  / 第9章语言结构  /  9.4 用户自定义变量

9.4 用户自定义变量

您可以在一条语句中将值存储在用户定义的变量中,稍后在另一条语句中引用它。这使您能够将值从一个语句传递到另一个语句。

用户变量写为 ,其中变量名称由字母数字字符、、 和组成。如果您将用户变量名称作为字符串或标识符(例如 、 或 )引用,则它可以包含其他 字符。 @var_namevar_name._$@'my-var'@"my-var"@`my-var`

用户定义的变量是特定于会话的。一个客户端定义的用户变量不能被其他客户端看到或使用。(例外:有权访问 Performance Schema user_variables_by_thread表的用户可以查看所有会话的所有用户变量。)当客户端退出时,给定客户端会话的所有变量都会自动释放。

用户变量名称不区分大小写。名称的最大长度为 64 个字符。

设置用户定义变量的一种方法是发出 SET 语句:

SET @var_name = expr [, @var_name = expr] ...

对于SET,要么 要么=可以 :=用作赋值运算符。

可以从一组有限的数据类型中为用户变量分配一个值:整数、十进制、浮点数、二进制或非二进制字符串,或NULL值。小数和实数值的分配不会保留值的精度或小数位。允许类型之一以外的类型的值将转换为允许类型。例如,具有时间或空间数据类型的值被转换为二进制字符串。具有JSON数据类型的值将转换为字符集为 utf8mb4且排序规则为 的字符串utf8mb4_bin

如果为用户变量分配了非二进制(字符)字符串值,则它具有与字符串相同的字符集和排序规则。用户变量的强制性是隐含的。(这与表列值的可强制性相同。)

分配给用户变量的十六进制或位值被视为二进制字符串。要将十六进制或位值作为数字分配给用户变量,请在数字上下文中使用它。例如,添加 0 或使用CAST(... AS UNSIGNED)

mysql> SET @v1 = X'41';
mysql> SET @v2 = X'41'+0;
mysql> SET @v3 = CAST(X'41' AS UNSIGNED);
mysql> SELECT @v1, @v2, @v3;
+------+------+------+
| @v1  | @v2  | @v3  |
+------+------+------+
| A    |   65 |   65 |
+------+------+------+
mysql> SET @v1 = b'1000001';
mysql> SET @v2 = b'1000001'+0;
mysql> SET @v3 = CAST(b'1000001' AS UNSIGNED);
mysql> SELECT @v1, @v2, @v3;
+------+------+------+
| @v1  | @v2  | @v3  |
+------+------+------+
| A    |   65 |   65 |
+------+------+------+

如果在结果集中选择了用户变量的值,则将其作为字符串返回给客户端。

如果你引用一个没有被初始化的变量,它的值NULL是字符串类型。

用户变量可以在大多数允许表达式的上下文中使用。这目前不包括明确需要文字值的上下文,例如在 语句的LIMIT子句 中SELECT或语句的 子句中。 IGNORE N LINESLOAD DATA

也可以在 . 以外的语句中为用户变量赋值 SET。(此功能在 MySQL 8.0 中已弃用,并会在后续版本中删除。)以这种方式进行赋值时,赋值运算符必须是 :=and not 因为后者在以下语句 =中被视为比较运算符 : =SET

mysql> SET @t1=1, @t2=2, @t3:=4;
mysql> SELECT @t1, @t2, @t3, @t4 := @t1+@t2+@t3;
+------+------+------+--------------------+
| @t1  | @t2  | @t3  | @t4 := @t1+@t2+@t3 |
+------+------+------+--------------------+
|    1 |    2 |    4 |                  7 |
+------+------+------+--------------------+

作为一般规则,除了在 SET 语句中,您不应该为用户变量赋值并在同一语句中读取该值。例如,要增加一个变量,这是可以的:

SET @a = @a + 1;

对于其他语句,例如 SELECT,您可能会得到预期的结果,但这并不能保证。在下面的语句中,您可能会认为 MySQL @a首先求值,然后再进行赋值:

SELECT @a, @a:=@a+1, ...;

但是,涉及用户变量的表达式的求值顺序是未定义的。

给变量赋值并在同一非SET 语句中读取值的另一个问题是,变量的默认结果类型基于语句开头的类型。以下示例说明了这一点:

mysql> SET @a='test';
mysql> SELECT @a,(@a:=20) FROM tbl_name;

对于此SELECT语句,MySQL 向客户端报告第一列是字符串并将所有访问转换@a为字符串,即使第二行的@a 设置为数字。SELECT语句执行 后 ,@a被视为下一条语句的编号。

为避免此行为出现问题,请不要在单个语句中为同一变量赋值并读取该变量的值,或者将该变量设置为00.0,或者''在使用它之前定义其类型。

在一个SELECT语句中,每个选择表达式仅在发送到客户端时才被评估。这意味着在HAVINGGROUP BYORDER BY子句中,引用在选择表达式列表中赋值的变量 不会按预期工作:

mysql> SELECT (@aa:=id) AS a, (@aa+3) AS b FROM tbl_name HAVING b=5;

b子句中对 的引用HAVING指的是选择列表中使用 的表达式的别名@aa。这不像预期的那样工作:@aa包含id来自上一个选定行的值,而不是来自当前行的值。

用户变量旨在提供数据值。它们不能直接在 SQL 语句中用作标识符或用作标识符的一部分,例如在需要表或数据库名称的上下文中,或用作保留字,例如 SELECT. 即使引用了变量也是如此,如以下示例所示:

mysql> SELECT c1 FROM t;
+----+
| c1 |
+----+
|  0 |
+----+
|  1 |
+----+
2 rows in set (0.00 sec)

mysql> SET @col = "c1";
Query OK, 0 rows affected (0.00 sec)

mysql> SELECT @col FROM t;
+------+
| @col |
+------+
| c1   |
+------+
1 row in set (0.00 sec)

mysql> SELECT `@col` FROM t;
ERROR 1054 (42S22): Unknown column '@col' in 'field list'

mysql> SET @col = "`c1`";
Query OK, 0 rows affected (0.00 sec)

mysql> SELECT @col FROM t;
+------+
| @col |
+------+
| `c1` |
+------+
1 row in set (0.00 sec)

用户变量不能用于提供标识符这一原则的一个例外是,当您构造一个字符串以用作稍后执行的准备语句时。在这种情况下,用户变量可用于提供语句的任何部分。以下示例说明了如何做到这一点:

mysql> SET @c = "c1";
Query OK, 0 rows affected (0.00 sec)

mysql> SET @s = CONCAT("SELECT ", @c, " FROM t");
Query OK, 0 rows affected (0.00 sec)

mysql> PREPARE stmt FROM @s;
Query OK, 0 rows affected (0.04 sec)
Statement prepared

mysql> EXECUTE stmt;
+----+
| c1 |
+----+
|  0 |
+----+
|  1 |
+----+
2 rows in set (0.00 sec)

mysql> DEALLOCATE PREPARE stmt;
Query OK, 0 rows affected (0.00 sec)

有关详细信息,请参阅第 13.5 节,“准备好的语句”

可以在应用程序中使用类似的技术来使用程序变量构造 SQL 语句,如下所示使用 PHP 5:

<?php
  $mysqli = new mysqli("localhost", "user", "pass", "test");

  if( mysqli_connect_errno() )
    die("Connection failed: %s\n", mysqli_connect_error());

  $col = "c1";

  $query = "SELECT $col FROM t";

  $result = $mysqli->query($query);

  while($row = $result->fetch_assoc())
  {
    echo "<p>" . $row["$col"] . "</p>\n";
  }

  $result->close();

  $mysqli->close();
?>

以这种方式组合 SQL 语句有时称为 动态 SQL