MySQL :: MySQL 9.0 参考手册 :: 15.1.20.12 设置 NDB 注释选项

版本 9.0

8.4 当前
8.0
5.7

MySQL 9.0 参考手册 / ... / 设置 NDB 注释选项

15.1.20.12 设置 NDB 注释选项

可以在 NDB 表的表注释或列注释中设置一些特定于 NDB 集群的选项。用于控制从任何副本读取和分区平衡的表级选项可以通过 NDB_TABLE 嵌入到表注释中。

NDB_COLUMN 可用于列注释，以将用于存储 NDB 使用的 blob 值部分的 blob 部分表列的大小设置为其最大值。这适用于 BLOB、MEDIUMBLOB、LONGBLOB、TEXT、MEDIUMTEXT、LONGTEXT 和 JSON 列。列注释还可用于控制 blob 列的内联大小。NDB_COLUMN 注释不支持 TINYBLOB 或 TINYTEXT 列，因为这些列只有固定大小的内联部分（仅），没有其他位置存储的其他部分。

NDB_TABLE 可在表注释中用于设置与分区平衡相关的选项，以及表是否完全复制等。

本节的其余部分将描述这些选项及其用法。

NDB_COLUMN 选项

在 NDB Cluster 中，CREATE TABLE 或 ALTER TABLE 语句中的列注释也可以用于指定 NDB_COLUMN 选项。 NDB 支持两个列注释选项 BLOB_INLINE_SIZE 和 MAX_BLOB_PART_SIZE。这些选项的语法如下所示

Press CTRL+C to copy
 
COMMENT 'NDB_COLUMN=speclist'

speclist := spec[,spec]

spec := 
    BLOB_INLINE_SIZE=value
  | MAX_BLOB_PART_SIZE[={0|1}]

BLOB_INLINE_SIZE 指定要由该列内联存储的字节数；其预期值为 1 到 29980（含）之间的整数。设置大于 29980 的值会引发错误；设置小于 1 的值是允许的，但会导致使用该列类型的默认内联大小。

您应该知道，此选项的最大值实际上是可以在 NDB 表的一行中存储的最大字节数；行中的每一列都为此总计做出贡献。

您还应该牢记，特别是在处理 TEXT 列时，由 MAX_BLOB_PART_SIZE 或 BLOB_INLINE_SIZE 设置的值代表以字节为单位的列大小。它不表示字符数，字符数根据列使用的字符集和排序规则而异。

要查看此选项的效果，首先创建一个包含两个 BLOB 列的表，一个 (b1) 没有其他选项，另一个 (b2) 为 BLOB_INLINE_SIZE 设置了一个值，如下所示

Press CTRL+C to copy
 
mysql> CREATE TABLE t1 (
    ->    a INT NOT NULL PRIMARY KEY,
    ->    b1 BLOB,
    ->    b2 BLOB COMMENT 'NDB_COLUMN=BLOB_INLINE_SIZE=8000'
    ->  ) ENGINE NDB;
Query OK, 0 rows affected (0.32 sec)

您可以通过查询 ndbinfo.blobs 表来查看 BLOB 列的 BLOB_INLINE_SIZE 设置，如下所示

Press CTRL+C to copy
 
mysql> SELECT 
    ->   column_name AS 'Column Name', 
    ->   inline_size AS 'Inline Size', 
    ->   part_size AS 'Blob Part Size' 
    -> FROM ndbinfo.blobs 
    -> WHERE table_name = 't1';
+-------------+-------------+----------------+
| Column Name | Inline Size | Blob Part Size |
+-------------+-------------+----------------+
| b1          |         256 |           2000 |
| b2          |        8000 |           2000 |
+-------------+-------------+----------------+
2 rows in set (0.01 sec)

您还可以检查 ndb_desc 实用程序的输出，如下所示，突出显示相关的行

Press CTRL+C to copy
 
$> ndb_desc -d test t1
-- t --
Version: 1
Fragment type: HashMapPartition
K Value: 6
Min load factor: 78
Max load factor: 80
Temporary table: no
Number of attributes: 3
Number of primary keys: 1
Length of frm data: 945
Max Rows: 0
Row Checksum: 1
Row GCI: 1
SingleUserMode: 0
ForceVarPart: 1
PartitionCount: 2
FragmentCount: 2
PartitionBalance: FOR_RP_BY_LDM
ExtraRowGciBits: 0
ExtraRowAuthorBits: 0
TableStatus: Retrieved
Table options: readbackup
HashMap: DEFAULT-HASHMAP-3840-2
-- Attributes --
a Int PRIMARY KEY DISTRIBUTION KEY AT=FIXED ST=MEMORY
b1 Blob(256,2000,0) NULL AT=MEDIUM_VAR ST=MEMORY BV=2 BT=NDB$BLOB_64_1
b2 Blob(8000,2000,0) NULL AT=MEDIUM_VAR ST=MEMORY BV=2 BT=NDB$BLOB_64_2
-- Indexes -- 
PRIMARY KEY(a) - UniqueHashIndex
PRIMARY(a) - OrderedIndex

对于 MAX_BLOB_PART_SIZE，= 符号及其后面的值是可选的。使用 0 或 1 以外的任何值会导致语法错误。

在列注释中使用 MAX_BLOB_PART_SIZE 的效果是将 TEXT 或 BLOB 列的 blob 部分大小设置为 NDB 支持的此类最大字节数（13948）。此选项可以应用于 MySQL 支持的任何 blob 列类型，但 TINYBLOB 或 TINYTEXT (BLOB、MEDIUMBLOB、LONGBLOB、TEXT、MEDIUMTEXT、LONGTEXT) 除外。与 BLOB_INLINE_SIZE 不同，MAX_BLOB_PART_SIZE 对 JSON 列没有影响。

要查看此选项的效果，我们首先在 mysql 客户端中运行以下 SQL 语句，以创建一个包含两个 BLOB 列的表，一个 (c1) 没有其他选项，另一个 (c2) 带有 MAX_BLOB_PART_SIZE

Press CTRL+C to copy
 
mysql> CREATE TABLE test.t2 (
    ->   p INT PRIMARY KEY, 
    ->   c1 BLOB, 
    ->   c2 BLOB COMMENT 'NDB_COLUMN=MAX_BLOB_PART_SIZE'
    -> ) ENGINE NDB;
Query OK, 0 rows affected (0.32 sec)

从系统 shell 中，运行 ndb_desc 实用程序以获取有关刚创建的表的的信息，如本示例所示

Press CTRL+C to copy
 
$> ndb_desc -d test t2
-- t --
Version: 1
Fragment type: HashMapPartition
K Value: 6
Min load factor: 78
Max load factor: 80
Temporary table: no
Number of attributes: 3
Number of primary keys: 1
Length of frm data: 324
Row Checksum: 1
Row GCI: 1
SingleUserMode: 0
ForceVarPart: 1
FragmentCount: 2
ExtraRowGciBits: 0
ExtraRowAuthorBits: 0
TableStatus: Retrieved
HashMap: DEFAULT-HASHMAP-3840-2
-- Attributes --
p Int PRIMARY KEY DISTRIBUTION KEY AT=FIXED ST=MEMORY
c1 Blob(256,2000,0) NULL AT=MEDIUM_VAR ST=MEMORY BV=2 BT=NDB$BLOB_22_1
c2 Blob(256,13948,0) NULL AT=MEDIUM_VAR ST=MEMORY BV=2 BT=NDB$BLOB_22_2
-- Indexes -- 
PRIMARY KEY(p) - UniqueHashIndex
PRIMARY(p) - OrderedIndex

输出中的列信息列在 Attributes 下；对于列 c1 和 c2，它在此处以突出显示的文本显示。对于 c1，blob 部分大小为 2000，这是默认值；对于 c2，它为 13948，由 MAX_BLOB_PART_SIZE 设置。

您还可以查询 ndbinfo.blobs 表以查看这一点，如下所示

Press CTRL+C to copy
 
mysql> SELECT 
    ->   column_name AS 'Column Name', 
    ->   inline_size AS 'Inline Size', 
    ->   part_size AS 'Blob Part Size' 
    -> FROM ndbinfo.blobs 
    -> WHERE table_name = 't2';
+-------------+-------------+----------------+
| Column Name | Inline Size | Blob Part Size |
+-------------+-------------+----------------+
| c1          |         256 |           2000 |
| c2          |         256 |          13948 |
+-------------+-------------+----------------+
2 rows in set (0.00 sec)

您可以使用类似于以下示例的 ALTER TABLE 语句来更改 NDB 表的给定 blob 列的 blob 部分大小，并在更改后使用 SHOW CREATE TABLE 验证更改

Press CTRL+C to copy
 
mysql> ALTER TABLE test.t2 
    ->    DROP COLUMN c1, 
    ->     ADD COLUMN c1 BLOB COMMENT 'NDB_COLUMN=MAX_BLOB_PART_SIZE',
    ->     CHANGE COLUMN c2 c2 BLOB AFTER c1;
Query OK, 0 rows affected (0.47 sec)
Records: 0  Duplicates: 0  Warnings: 0

mysql> SHOW CREATE TABLE test.t2\G
*************************** 1. row ***************************
       Table: t
Create Table: CREATE TABLE `t2` (
  `p` int(11) NOT NULL,
  `c1` blob COMMENT 'NDB_COLUMN=MAX_BLOB_PART_SIZE',
  `c2` blob,
  PRIMARY KEY (`p`)
) ENGINE=ndbcluster DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci
1 row in set (0.00 sec)

mysql> EXIT
Bye

ndb_desc 的输出表明列的 blob 部分大小已按预期更改

Press CTRL+C to copy
 
$> ndb_desc -d test t2
-- t --
Version: 16777220
Fragment type: HashMapPartition
K Value: 6
Min load factor: 78
Max load factor: 80
Temporary table: no
Number of attributes: 3
Number of primary keys: 1
Length of frm data: 324
Row Checksum: 1
Row GCI: 1
SingleUserMode: 0
ForceVarPart: 1
FragmentCount: 2
ExtraRowGciBits: 0
ExtraRowAuthorBits: 0
TableStatus: Retrieved
HashMap: DEFAULT-HASHMAP-3840-2
-- Attributes --
p Int PRIMARY KEY DISTRIBUTION KEY AT=FIXED ST=MEMORY
c1 Blob(256,13948,0) NULL AT=MEDIUM_VAR ST=MEMORY BV=2 BT=NDB$BLOB_26_1
c2 Blob(256,2000,0) NULL AT=MEDIUM_VAR ST=MEMORY BV=2 BT=NDB$BLOB_26_2
-- Indexes -- 
PRIMARY KEY(p) - UniqueHashIndex
PRIMARY(p) - OrderedIndex

您还可以通过再次对 ndbinfo.blobs 运行查询来查看更改

Press CTRL+C to copy
 
mysql> SELECT 
    ->   column_name AS 'Column Name', 
    ->   inline_size AS 'Inline Size', 
    ->   part_size AS 'Blob Part Size' 
    -> FROM ndbinfo.blobs 
    -> WHERE table_name = 't2';
+-------------+-------------+----------------+
| Column Name | Inline Size | Blob Part Size |
+-------------+-------------+----------------+
| c1          |         256 |          13948 |
| c2          |         256 |           2000 |
+-------------+-------------+----------------+
2 rows in set (0.00 sec)

可以为 blob 列同时设置 BLOB_INLINE_SIZE 和 MAX_BLOB_PART_SIZE，如以下 CREATE TABLE 语句所示

Press CTRL+C to copy
 
mysql> CREATE TABLE test.t3 (
    ->   p INT NOT NULL PRIMARY KEY,
    ->   c1 JSON,
    ->   c2 JSON COMMENT 'NDB_COLUMN=BLOB_INLINE_SIZE=5000,MAX_BLOB_PART_SIZE'
    -> ) ENGINE NDB;
Query OK, 0 rows affected (0.28 sec)

查询 blobs 表向我们表明该语句按预期工作

Press CTRL+C to copy
 
mysql> SELECT 
    ->   column_name AS 'Column Name', 
    ->   inline_size AS 'Inline Size', 
    ->   part_size AS 'Blob Part Size' 
    -> FROM ndbinfo.blobs 
    -> WHERE table_name = 't3';
+-------------+-------------+----------------+
| Column Name | Inline Size | Blob Part Size |
+-------------+-------------+----------------+
| c1          |        4000 |           8100 |
| c2          |        5000 |           8100 |
+-------------+-------------+----------------+
2 rows in set (0.00 sec)

您还可以通过检查 ndb_desc 的输出来验证该语句是否已正常工作。

更改列的 blob 部分大小必须使用复制的 ALTER TABLE 完成；此操作无法在线执行（请参见第 25.6.12 节，“NDB Cluster 中 ALTER TABLE 的在线操作”）。

有关 NDB 如何存储 blob 类型列的更多信息，请参见字符串类型存储要求。

NDB_TABLE 选项

对于 NDB Cluster 表，CREATE TABLE 或 ALTER TABLE 语句中的表注释也可以用于指定 NDB_TABLE 选项，该选项包含一个或多个名称-值对（如果需要，用逗号分隔），位于字符串 NDB_TABLE= 之后。名称和值语法的完整语法如下所示

Press CTRL+C to copy
 
COMMENT="NDB_TABLE=ndb_table_option[,ndb_table_option[,...]]"

ndb_table_option: {
    NOLOGGING={1 | 0}
  | READ_BACKUP={1 | 0}
  | PARTITION_BALANCE={FOR_RP_BY_NODE | FOR_RA_BY_NODE | FOR_RP_BY_LDM
                      | FOR_RA_BY_LDM | FOR_RA_BY_LDM_X_2
                      | FOR_RA_BY_LDM_X_3 | FOR_RA_BY_LDM_X_4}
  | FULLY_REPLICATED={1 | 0}
}

在引号字符串中不允许空格。该字符串不区分大小写。

可以在注释中以这种方式设置的四个 NDB 表选项将在接下来的几段中详细介绍。

NOLOGGING：默认情况下，NDB 表是记录的，并且具有检查点。这使它们能够经受住整个集群故障的影响。在创建或更改表时使用 NOLOGGING 表示该表不会进行重做日志记录或包含在本地检查点中。在这种情况下，该表仍然在数据节点之间复制以实现高可用性，并使用事务更新，但对它进行的更改不会记录在数据节点的重做日志中，其内容也不会被检查到磁盘；在从集群故障中恢复时，集群会保留表定义，但不保留任何行，即该表为空。

使用此类非日志表可以减少数据节点对磁盘 I/O 和存储以及用于检查点 CPU 的 CPU 的需求。这可能适合频繁更新的短期数据，并且在发生集群完全故障的极不可能情况下，所有数据的丢失是可以接受的。

也可以使用 ndb_table_no_logging 系统变量来使在该变量生效时创建或更改的任何 NDB 表的行为类似于使用 NOLOGGING 注释创建的表。与直接使用注释不同，在这种情况下，SHOW CREATE TABLE 的输出中没有任何内容表明它是非日志表。建议使用表注释方法，因为它提供了对功能的逐表控制，并且表架构的这一方面嵌入在表创建语句中，可以在 SQL 工具中轻松找到。

READ_BACKUP：将此选项设置为 1 的效果与启用 ndb_read_backup 相同；启用从任何副本读取。这样做极大地提高了从表中读取的性能，而对写入性能的影响相对较小。 1 是 READ_BACKUP 的默认值，而 ndb_read_backup 的默认值为 ON（以前，从任何副本读取默认情况下是禁用的）。

您可以使用类似于以下示例之一的 ALTER TABLE 语句在线为现有表设置 READ_BACKUP

Press CTRL+C to copy
 
ALTER TABLE ... ALGORITHM=INPLACE, COMMENT="NDB_TABLE=READ_BACKUP=1";

ALTER TABLE ... ALGORITHM=INPLACE, COMMENT="NDB_TABLE=READ_BACKUP=0";

有关 ALTER TABLE 的 ALGORITHM 选项的更多信息，请参见第 25.6.12 节，“NDB Cluster 中 ALTER TABLE 的在线操作”。

PARTITION_BALANCE：提供对分区分配和放置的额外控制。支持以下四种方案

FOR_RP_BY_NODE：每个节点一个分区。
每个节点上的单个 LDM 存储主分区。每个分区存储在所有节点上的同一个 LDM（相同 ID）中。
FOR_RA_BY_NODE：每个节点组一个分区。
每个节点存储单个分区，该分区可以是主副本或备份副本。每个分区存储在所有节点上的同一个 LDM 中。
FOR_RP_BY_LDM：每个节点的每个 LDM 一个分区；这是默认设置。
如果将 READ_BACKUP 设置为 1，则使用此设置。
FOR_RA_BY_LDM：每个节点组的每个 LDM 一个分区。
这些分区可以是主分区或备份分区。
FOR_RA_BY_LDM_X_2：每个节点组的每个 LDM 两个分区。
这些分区可以是主分区或备份分区。
FOR_RA_BY_LDM_X_3：每个节点组的每个 LDM 三个分区。
这些分区可以是主分区或备份分区。
FOR_RA_BY_LDM_X_4：每个节点组的每个 LDM 四个分区。
这些分区可以是主分区或备份分区。

PARTITION_BALANCE 是设置每个表的分区数的首选接口。使用 MAX_ROWS 来强制分区数量已过时，但出于向后兼容性目的继续受到支持；它将在 MySQL NDB Cluster 的未来版本中被删除。（错误 #81759、错误 #23544301）

FULLY_REPLICATED 控制表是否完全复制，即每个数据节点是否都包含表的完整副本。要启用表的完全复制，请使用 FULLY_REPLICATED=1。

此设置也可以使用 ndb_fully_replicated 系统变量控制。将其设置为 ON 将默认情况下为所有新的 NDB 表启用该选项；默认值为 OFF。 ndb_data_node_neighbour 系统变量也用于完全复制的表，以确保在访问完全复制的表时，我们访问对该 MySQL Server 本地的数据节点。

以下是一个使用此类注释创建 NDB 表的 CREATE TABLE 语句的示例

Press CTRL+C to copy
 
mysql> CREATE TABLE t1 (
     >     c1 INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
     >     c2 VARCHAR(100),
     >     c3 VARCHAR(100) )
     > ENGINE=NDB
     >
COMMENT="NDB_TABLE=READ_BACKUP=0,PARTITION_BALANCE=FOR_RP_BY_NODE";

该注释将显示为 SHOW CREATE TABLE 输出的一部分。您也可以通过查询 MySQL 信息架构 TABLES 表来获取注释文本，如下例所示

Press CTRL+C to copy
 
mysql> SELECT TABLE_NAME, TABLE_SCHEMA, TABLE_COMMENT
     > FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_NAME="t1"\G
*************************** 1. row ***************************
   TABLE_NAME: t1
 TABLE_SCHEMA: test
TABLE_COMMENT: NDB_TABLE=READ_BACKUP=0,PARTITION_BALANCE=FOR_RP_BY_NODE
1 row in set (0.01 sec)

此注释语法也支持 ALTER TABLE 语句，用于 NDB 表，如下所示

Press CTRL+C to copy
 
mysql> ALTER TABLE t1 COMMENT="NDB_TABLE=PARTITION_BALANCE=FOR_RA_BY_NODE";
Query OK, 0 rows affected (0.40 sec)
Records: 0  Duplicates: 0  Warnings: 0

TABLE_COMMENT 列显示了重新创建表的注释，该注释需要在 ALTER TABLE 语句之后，如下所示

Press CTRL+C to copy
 
mysql> SELECT TABLE_NAME, TABLE_SCHEMA, TABLE_COMMENT
    ->     FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_NAME="t1"\G
*************************** 1. row ***************************
   TABLE_NAME: t1
 TABLE_SCHEMA: test
TABLE_COMMENT: NDB_TABLE=READ_BACKUP=0,PARTITION_BALANCE=FOR_RP_BY_NODE
1 row in set (0.01 sec)

Press CTRL+C to copy
 
mysql> SELECT TABLE_NAME, TABLE_SCHEMA, TABLE_COMMENT
     > FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_NAME="t1";
+------------+--------------+--------------------------------------------------+
| TABLE_NAME | TABLE_SCHEMA | TABLE_COMMENT                                    |
+------------+--------------+--------------------------------------------------+
| t1         | c            | NDB_TABLE=PARTITION_BALANCE=FOR_RA_BY_NODE       |
| t1         | d            |                                                  |
+------------+--------------+--------------------------------------------------+
2 rows in set (0.01 sec)

请记住，与 ALTER TABLE 一起使用的表注释将替换表可能已有的任何现有注释。

Press CTRL+C to copy
 
mysql> ALTER TABLE t1 COMMENT="NDB_TABLE=PARTITION_BALANCE=FOR_RA_BY_NODE";
Query OK, 0 rows affected (0.40 sec)
Records: 0  Duplicates: 0  Warnings: 0

mysql> SELECT TABLE_NAME, TABLE_SCHEMA, TABLE_COMMENT
     > FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_NAME="t1";
+------------+--------------+--------------------------------------------------+
| TABLE_NAME | TABLE_SCHEMA | TABLE_COMMENT                                    |
+------------+--------------+--------------------------------------------------+
| t1         | c            | NDB_TABLE=PARTITION_BALANCE=FOR_RA_BY_NODE       |
| t1         | d            |                                                  |
+------------+--------------+--------------------------------------------------+
2 rows in set (0.01 sec)

您也可以在 ndb_desc 的输出中查看 PARTITION_BALANCE 选项的值。 ndb_desc 还显示了表是否设置了 READ_BACKUP 和 FULLY_REPLICATED 选项。有关更多信息，请参阅该程序的说明。