Skip to content

Commit

Permalink
[#1786] docs(jdbc): improvement JDBC catalog document (#1805)
Browse files Browse the repository at this point in the history
### What changes were proposed in this pull request?
1. update PG supported version
2. add warning messages not change gravitino id
3. add not support set MySQL scheme comment message

### Why are the changes needed?


Fix: #1786 #1704 

### Does this PR introduce _any_ user-facing change?
no

### How was this patch tested?
no, just document
  • Loading branch information
FANNG1 authored Jan 31, 2024
1 parent 17b3406 commit 347f5d0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
6 changes: 5 additions & 1 deletion docs/jdbc-mysql-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ This software is licensed under the Apache License version 2."

Gravitino provides the ability to manage MySQL metadata.

:::caution
Gravitino saves some system information in schema and table comment, like `(From Gravitino, DO NOT EDIT: gravitino.v1.uid1078334182909406185)`, please don't change or remove this message.
:::

## Catalog

### Catalog capabilities
Expand Down Expand Up @@ -51,7 +55,7 @@ Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravit
### Schema capabilities

- Gravitino schema corresponds to the MySQL database.
- Supports create schema with comments.
- Supports create schema, but does not explicitly support setting comments.
- Supports drop schema.
- Doesn't support cascade drop database.

Expand Down
6 changes: 5 additions & 1 deletion docs/jdbc-postgresql-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,16 @@ This software is licensed under the Apache License version 2."

Gravitino provides the ability to manage PostgreSQL metadata.

:::caution
Gravitino saves some system information in schema and table comment, like `(From Gravitino, DO NOT EDIT: gravitino.v1.uid1078334182909406185)`, please don't change or remove this message.
:::

## Catalog

### Catalog capabilities

- Gravitino catalog corresponds to the PostgreSQL database.
- Supports metadata management of PostgreSQL (9.2, 12.0, 13.0).
- Supports metadata management of PostgreSQL (12.x, 13.x, 14.x, 15.x, 16.x).
- Supports DDL operation for PostgreSQL schemas and tables.
- Doesn't support table index operations.
- Doesn't support setting certain column properties, such as default value and check constraints
Expand Down

0 comments on commit 347f5d0

Please sign in to comment.