Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#5100] improvement(docs): Add extra documents to clarify the engine type of MySQL catalog #6209

Merged
merged 3 commits into from
Jan 13, 2025
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/jdbc-mysql-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 require additional configuration. For instance, `FEDERATED` are not supported by
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

“configurations”, not "configuration".

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.
Expand Down
Loading