From 6138379dc316ef31e45c1594670f2e226c744d7a Mon Sep 17 00:00:00 2001 From: Qi Yu Date: Mon, 13 Jan 2025 18:49:05 +0800 Subject: [PATCH] [#5100] improvement(docs): Add extra documents to clarify the engine type of MySQL catalog (#6209) ### What changes were proposed in this pull request? Add more details about the usage of engine type for MySQL catalog. ### Why are the changes needed? The value of engine type may be influenced by many factors like MySQL version, configurations and so on, we need to clarify it. Fix: #5100 ### Does this PR introduce _any_ user-facing change? N/A ### How was this patch tested? N/A --- 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..808e229a21d 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 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 - Supports PRIMARY_KEY and UNIQUE_KEY.