文档主页
MySQL 8.4 参考手册
相关文档 下载本手册
PDF (US Ltr) - 39.9Mb
PDF (A4) - 40.0Mb
手册页 (TGZ) - 258.5Kb
手册页 (Zip) - 365.5Kb
Info (Gzip) - 4.0Mb
Info (Zip) - 4.0Mb


MySQL 8.4 参考手册  /  ...  /  使用版本令牌

7.6.6.3 使用版本令牌

在使用版本令牌之前,请根据 第 7.6.6.2 节“安装或卸载版本令牌” 中提供的说明进行安装。

版本令牌可用于的场景之一是,一个系统访问多个 MySQL 服务器,但需要通过监控服务器和根据负载变化调整服务器分配来管理它们以实现负载均衡。此类系统包含以下元素

  • 要管理的 MySQL 服务器集合。

  • 一个管理应用程序,它与服务器通信并将它们组织成高可用性组。组用于不同的目的,每个组内的服务器可能具有不同的分配。组内服务器的分配可以随时更改。

  • 访问服务器以检索和更新数据的客户端应用程序,它们根据分配给服务器的目的选择服务器。例如,客户端不应将更新发送到只读服务器。

版本令牌允许根据分配管理服务器访问,而无需客户端反复查询服务器有关其分配的信息。

  • 管理应用程序执行服务器分配并在每个服务器上建立版本令牌以反映其分配。该应用程序会缓存此信息以提供一个集中访问点。

    如果管理应用程序需要更改服务器分配(例如,将其从允许写入更改为只读),它会更改服务器的版本令牌列表并更新其缓存。

  • 为了提高性能,客户端应用程序从管理应用程序获取缓存信息,从而避免了为每个语句检索有关服务器分配的信息。根据其发出的语句类型(例如,读取与写入),客户端选择一个合适的服务器并连接到它。

  • 此外,客户端将自己的客户端特定版本令牌发送到服务器,以注册其对服务器的要求。对于客户端发送到服务器的每个语句,服务器都会将其自己的令牌列表与客户端令牌列表进行比较。如果服务器令牌列表包含客户端令牌列表中存在的所有令牌,并且值相同,则匹配,服务器会执行该语句。

    另一方面,管理应用程序可能已更改服务器分配及其版本令牌列表。在这种情况下,新的服务器分配可能现在与客户端要求不兼容。服务器和客户端令牌列表之间会出现令牌不匹配,服务器会返回一个错误以回复该语句。这表示客户端需要从管理应用程序缓存中刷新其版本令牌信息,并选择一个新的服务器进行通信。

检测版本令牌错误和选择新服务器的客户端端逻辑可以以不同的方式实现。

  • 客户端可以自行处理所有版本令牌注册、不匹配检测和连接切换。

  • 这些操作的逻辑可以在一个连接器中实现,该连接器管理客户端和 MySQL 服务器之间的连接。这样的连接器可能自行处理不匹配错误检测和语句重发,或者它可能将错误传递给应用程序,并让应用程序自行重发语句。

以下示例以更具体的形式说明了上述讨论。

当版本令牌在给定服务器上初始化时,服务器的版本令牌列表为空。令牌列表维护是通过调用函数来完成的。需要 VERSION_TOKEN_ADMIN 权限(或已弃用的 SUPER 权限)才能调用任何版本令牌函数,因此令牌列表修改预计将由具有该权限的管理应用程序完成。

假设一个管理应用程序与一组服务器通信,这些服务器被客户端查询以访问员工和产品数据库(分别命名为 empprod)。所有服务器都允许处理数据检索语句,但只有其中一部分服务器允许进行数据库更新。为了在特定于数据库的基础上处理这种情况,管理应用程序在每个服务器上建立一个版本令牌列表。在给定服务器的令牌列表中,令牌名称表示数据库名称,令牌值是 readwrite,具体取决于数据库是否必须以只读方式使用,或者是否可以进行读取和写入。

客户端应用程序通过设置系统变量来注册它们需要服务器匹配的版本令牌列表。变量设置是在特定于客户端的基础上进行的,因此不同的客户端可以注册不同的要求。默认情况下,客户端令牌列表为空,这与任何服务器令牌列表匹配。当客户端将其令牌列表设置为非空值时,匹配可能成功或失败,具体取决于服务器版本令牌列表。

要为服务器定义版本令牌列表,管理应用程序调用 version_tokens_set() 函数。(还有用于修改和显示令牌列表的函数,将在后面介绍。)例如,应用程序可能会向一组三个服务器发送以下语句

服务器 1

mysql> SELECT version_tokens_set('emp=read;prod=read');
+------------------------------------------+
| version_tokens_set('emp=read;prod=read') |
+------------------------------------------+
| 2 version tokens set.                    |
+------------------------------------------+

服务器 2

mysql> SELECT version_tokens_set('emp=write;prod=read');
+-------------------------------------------+
| version_tokens_set('emp=write;prod=read') |
+-------------------------------------------+
| 2 version tokens set.                     |
+-------------------------------------------+

服务器 3

mysql> SELECT version_tokens_set('emp=read;prod=write');
+-------------------------------------------+
| version_tokens_set('emp=read;prod=write') |
+-------------------------------------------+
| 2 version tokens set.                     |
+-------------------------------------------+

在每种情况下,令牌列表都指定为以分号分隔的 name=value 对列表。生成的令牌列表值导致以下服务器分配

  • 任何服务器都接受对任一数据库的读取操作。

  • 只有服务器 2 接受对 emp 数据库的更新操作。

  • 只有服务器 3 接受对 prod 数据库的更新操作。

除了为每个服务器分配版本令牌列表之外,管理应用程序还维护一个反映服务器分配的缓存。

在与服务器通信之前,客户端应用程序会联系管理应用程序并检索有关服务器分配的信息。然后,客户端根据这些分配选择服务器。假设客户端希望对 emp 数据库执行读取和写入操作。根据前面的分配,只有服务器 2 符合条件。客户端连接到服务器 2,并通过设置其 version_tokens_session 系统变量,在服务器 2 上注册其服务器要求

mysql> SET @@SESSION.version_tokens_session = 'emp=write';

对于客户端随后发送到服务器 2 的语句,服务器会将其自己的版本令牌列表与其客户端列表进行比较,以检查它们是否匹配。如果匹配,则语句正常执行

mysql> UPDATE emp.employee SET salary = salary * 1.1 WHERE id = 4981;
Query OK, 1 row affected (0.07 sec)
Rows matched: 1  Changed: 1  Warnings: 0

mysql> SELECT last_name, first_name FROM emp.employee WHERE id = 4981;
+-----------+------------+
| last_name | first_name |
+-----------+------------+
| Smith     | Abe        |
+-----------+------------+
1 row in set (0.01 sec)

服务器和客户端版本令牌列表之间的差异可能以两种方式发生

只要服务器 2 的分配不发生更改,客户端就会继续使用它进行读取和写入。但是,假设管理应用程序希望更改服务器分配,以便对 emp 数据库的写入操作必须发送到服务器 1 而不是服务器 2。为此,它使用 version_tokens_edit() 来修改两台服务器上的 emp 令牌值(并更新其服务器分配缓存)

服务器 1

mysql> SELECT version_tokens_edit('emp=write');
+----------------------------------+
| version_tokens_edit('emp=write') |
+----------------------------------+
| 1 version tokens updated.        |
+----------------------------------+

服务器 2

mysql> SELECT version_tokens_edit('emp=read');
+---------------------------------+
| version_tokens_edit('emp=read') |
+---------------------------------+
| 1 version tokens updated.       |
+---------------------------------+

version_tokens_edit() 会修改服务器令牌列表中的命名令牌,而不会更改其他令牌。

下次客户端向服务器 2 发送语句时,其自己的令牌列表将不再与服务器令牌列表匹配,并且会发生错误

mysql> UPDATE emp.employee SET salary = salary * 1.1 WHERE id = 4982;
ERROR 3136 (42000): Version token mismatch for emp. Correct value read

在这种情况下,客户端应联系管理应用程序以获取有关服务器分配的更新信息,选择新服务器并将失败的语句发送到新服务器。

注意

每个客户端都必须与版本令牌配合,仅根据其在给定服务器上注册的令牌列表发送语句。例如,如果客户端注册的令牌列表为 'emp=read',则版本令牌中没有任何内容可以阻止客户端发送对 emp 数据库的更新。客户端本身必须避免这样做。

对于从客户端收到的每个语句,服务器会隐式地使用锁定,如下所示

  • 对客户端令牌列表(即 version_tokens_session 值)中命名的每个令牌获取共享锁

  • 执行服务器和客户端令牌列表之间的比较

  • 根据比较结果执行语句或产生错误

  • 释放锁

服务器使用共享锁,以便多个会话的比较可以在不阻塞的情况下发生,同时阻止在操作服务器令牌列表中相同名称的令牌之前尝试获取独占锁的任何会话对令牌进行更改。

前面的示例仅使用了版本令牌插件库中包含的一些函数,但还有其他函数。一组函数允许操作和检查服务器的版本令牌列表。另一组函数允许锁定和解锁版本令牌。

这些函数允许创建、更改、删除和检查服务器的版本令牌列表

  • version_tokens_set() 完全替换当前列表并分配新列表。参数是以分号分隔的 name=value 对列表。

  • version_tokens_edit() 允许对当前列表进行部分修改。它可以添加新令牌或更改现有令牌的值。参数是以分号分隔的 name=value 对列表。

  • version_tokens_delete() 从当前列表中删除令牌。参数是以分号分隔的令牌名称列表。

  • version_tokens_show() 显示当前令牌列表。它不接受任何参数。

如果成功,每个函数都会返回一个二进制字符串,指示执行的操作。以下示例建立服务器令牌列表,通过添加新令牌对其进行修改,删除一些令牌,并显示生成的令牌列表

mysql> SELECT version_tokens_set('tok1=a;tok2=b');
+-------------------------------------+
| version_tokens_set('tok1=a;tok2=b') |
+-------------------------------------+
| 2 version tokens set.               |
+-------------------------------------+
mysql> SELECT version_tokens_edit('tok3=c');
+-------------------------------+
| version_tokens_edit('tok3=c') |
+-------------------------------+
| 1 version tokens updated.     |
+-------------------------------+
mysql> SELECT version_tokens_delete('tok2;tok1');
+------------------------------------+
| version_tokens_delete('tok2;tok1') |
+------------------------------------+
| 2 version tokens deleted.          |
+------------------------------------+
mysql> SELECT version_tokens_show();
+-----------------------+
| version_tokens_show() |
+-----------------------+
| tok3=c;               |
+-----------------------+

如果令牌列表格式错误,则会发生警告

mysql> SELECT version_tokens_set('tok1=a; =c');
+----------------------------------+
| version_tokens_set('tok1=a; =c') |
+----------------------------------+
| 1 version tokens set.            |
+----------------------------------+
1 row in set, 1 warning (0.00 sec)

mysql> SHOW WARNINGS\G
*************************** 1. row ***************************
  Level: Warning
   Code: 42000
Message: Invalid version token pair encountered. The list provided
         is only partially updated.
1 row in set (0.00 sec)

如前所述,版本令牌使用以分号分隔的 name=value 对列表进行定义。考虑以下 version_tokens_set() 的调用

mysql> SELECT version_tokens_set('tok1=b;;; tok2= a = b ; tok1 = 1\'2 3"4')
+---------------------------------------------------------------+
| version_tokens_set('tok1=b;;; tok2= a = b ; tok1 = 1\'2 3"4') |
+---------------------------------------------------------------+
| 3 version tokens set.                                         |
+---------------------------------------------------------------+

版本令牌会按如下方式解释参数

  • 名称和值周围的空格将被忽略。名称和值内的空格是允许的。(对于 version_tokens_delete(),它接受没有值的名称列表,名称周围的空格将被忽略。)

  • 没有引号机制。

  • 令牌的顺序无关紧要,除非令牌列表包含给定令牌名称的多个实例,在这种情况下,最后一个值将优先于前面的值。

根据这些规则,前面的 version_tokens_set() 调用将生成一个包含两个令牌的令牌列表:tok1 的值为 1'2 3"4,而 tok2 的值为 a = b。要验证这一点,请调用 version_tokens_show()

mysql> SELECT version_tokens_show();
+--------------------------+
| version_tokens_show()    |
+--------------------------+
| tok2=a = b;tok1=1'2 3"4; |
+--------------------------+

如果令牌列表包含两个令牌,为什么 version_tokens_set() 返回值 3 version tokens set?发生这种情况是因为原始令牌列表包含对 tok1 的两个定义,第二个定义替换了第一个定义。

版本令牌令牌操作函数对令牌名称和值施加以下约束

  • 令牌名称不能包含 =; 字符,并且最大长度为 64 个字符。

  • 令牌值不能包含 ; 字符。值的长度受 max_allowed_packet 系统变量的值限制。

  • 版本令牌将令牌名称和值视为二进制字符串,因此比较区分大小写。

版本令牌还包含一组允许锁定和解锁令牌的函数

每个锁定函数在成功时返回非零值。否则,将发生错误

mysql> SELECT version_tokens_lock_shared('lock1', 'lock2', 0);
+-------------------------------------------------+
| version_tokens_lock_shared('lock1', 'lock2', 0) |
+-------------------------------------------------+
|                                               1 |
+-------------------------------------------------+

mysql> SELECT version_tokens_lock_shared(NULL, 0);
ERROR 3131 (42000): Incorrect locking service lock name '(null)'.

使用版本令牌锁定函数进行的锁定是建议性的;应用程序必须同意合作。

可以锁定不存在的令牌名称。这不会创建令牌。

注意

版本令牌锁定函数基于 第 7.6.9.1 节,“锁定服务” 中描述的锁定服务,因此共享锁和独占锁具有相同的语义。(版本令牌使用内置于服务器的锁定服务例程,而不是锁定服务函数接口,因此不必安装这些函数即可使用版本令牌。)版本令牌获取的锁使用 version_token_locks 的锁定服务命名空间。锁定服务锁可以使用性能模式进行监控,因此版本令牌锁也是如此。有关详细信息,请参见 锁定服务监控

对于版本令牌锁定函数,令牌名称参数的使用方式与指定方式完全相同。周围的空格不会被忽略,并且允许使用 =; 字符。这是因为版本令牌只是将要锁定的令牌名称按原样传递给锁定服务。