Skip to content

Commit

Permalink
[#5100] improvement(docs): Add extra documents to clarify the engine …
Browse files Browse the repository at this point in the history
…type of MySQL catalog (#6213)

### 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

Co-authored-by: Qi Yu <[email protected]>
  • Loading branch information
github-actions[bot] and yuqi1129 authored Jan 13, 2025
1 parent 911c732 commit 241f789
Showing 1 changed file with 6 additions and 0 deletions.
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 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.
Expand Down

0 comments on commit 241f789

Please sign in to comment.