From da7f3e48fed5e8692eb22d22c7dc43c94d7dcfd7 Mon Sep 17 00:00:00 2001 From: yuqi Date: Mon, 13 Jan 2025 14:58:17 +0800 Subject: [PATCH 1/3] Add extra documents to clarify the engine type of MySQL catalog --- docs/jdbc-mysql-catalog.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/jdbc-mysql-catalog.md b/docs/jdbc-mysql-catalog.md index c761006a000..29fe5aada90 100644 --- a/docs/jdbc-mysql-catalog.md +++ b/docs/jdbc-mysql-catalog.md @@ -186,6 +186,12 @@ Although MySQL itself does not support table properties, Gravitino offers table | `engine` | The engine used by the table. For example `MyISAM`, `MEMORY`, `CSV`, `ARCHIVE`, `BLACKHOLE`, `FEDERATED`, `ndbinfo`, `MRG_MYISAM`, `PERFORMANCE_SCHEMA`. | `InnoDB` | No | No | Yes | 0.4.0 | | `auto-increment-offset` | Used to specify the starting value of the auto-increment field. | (none) | No | No | Yes | 0.4.0 | +:::note +Some engine types may not be supported by MySQL by default and required additional configuration. For instance, `FEDERATED` are not supported by +default and need to be enabled by setting `federated` to `1` in the MySQL configuration file, the same applies to `ndbinfo`, `MRG_MYISAM`, `PERFORMANCE_SCHEMA`. +Please refer to the [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/federated-storage-engine.html) for more information. +::: + ### Table indexes - Supports PRIMARY_KEY and UNIQUE_KEY. From 76e92c69c4b58cc61ae042ef8f7085d1df040908 Mon Sep 17 00:00:00 2001 From: yuqi Date: Mon, 13 Jan 2025 15:57:54 +0800 Subject: [PATCH 2/3] fix comments --- docs/jdbc-mysql-catalog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/jdbc-mysql-catalog.md b/docs/jdbc-mysql-catalog.md index 29fe5aada90..72c2c379b8c 100644 --- a/docs/jdbc-mysql-catalog.md +++ b/docs/jdbc-mysql-catalog.md @@ -187,7 +187,7 @@ Although MySQL itself does not support table properties, Gravitino offers table | `auto-increment-offset` | Used to specify the starting value of the auto-increment field. | (none) | No | No | Yes | 0.4.0 | :::note -Some engine types may not be supported by MySQL by default and required additional configuration. For instance, `FEDERATED` are not supported by +Some engine types may not be supported by MySQL by default and require additional configuration. For instance, `FEDERATED` are not supported by default and need to be enabled by setting `federated` to `1` in the MySQL configuration file, the same applies to `ndbinfo`, `MRG_MYISAM`, `PERFORMANCE_SCHEMA`. Please refer to the [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/federated-storage-engine.html) for more information. ::: From a3a233be26bdd483c3cc7af8ef82d19057c1adeb Mon Sep 17 00:00:00 2001 From: yuqi Date: Mon, 13 Jan 2025 17:20:19 +0800 Subject: [PATCH 3/3] Polish the whole sentence. --- docs/jdbc-mysql-catalog.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/jdbc-mysql-catalog.md b/docs/jdbc-mysql-catalog.md index 72c2c379b8c..808e229a21d 100644 --- a/docs/jdbc-mysql-catalog.md +++ b/docs/jdbc-mysql-catalog.md @@ -186,10 +186,10 @@ Although MySQL itself does not support table properties, Gravitino offers table | `engine` | The engine used by the table. For example `MyISAM`, `MEMORY`, `CSV`, `ARCHIVE`, `BLACKHOLE`, `FEDERATED`, `ndbinfo`, `MRG_MYISAM`, `PERFORMANCE_SCHEMA`. | `InnoDB` | No | No | Yes | 0.4.0 | | `auto-increment-offset` | Used to specify the starting value of the auto-increment field. | (none) | No | No | Yes | 0.4.0 | + :::note -Some engine types may not be supported by MySQL by default and require additional configuration. For instance, `FEDERATED` are not supported by -default and need to be enabled by setting `federated` to `1` in the MySQL configuration file, the same applies to `ndbinfo`, `MRG_MYISAM`, `PERFORMANCE_SCHEMA`. -Please refer to the [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/federated-storage-engine.html) for more information. +Some MySQL storage engines, such as FEDERATED, are not enabled by default and require additional configuration to use. For example, to enable the FEDERATED engine, set federated=1 in the MySQL configuration file. Similarly, engines like ndbinfo, MRG_MYISAM, and PERFORMANCE_SCHEMA may also require specific prerequisites or configurations. For detailed instructions, +refer to the [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/federated-storage-engine.html). ::: ### Table indexes