yuanoOo commented on code in PR #5264: URL: https://github.com/apache/gravitino/pull/5264#discussion_r1818818357
########## docs/jdbc-oceanbase-catalog.md: ########## @@ -0,0 +1,227 @@ +--- +title: "OceanBase catalog" +slug: /jdbc-oceanbase-catalog +keywords: +- jdbc +- OceanBase +- metadata +license: "This software is licensed under the Apache License version 2." +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +## Introduction + +Apache Gravitino provides the ability to manage OceanBase 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 OceanBase instance. +- Supports metadata management of OceanBase (3.x, 4.x). +- Supports DDL operation for OceanBase databases and tables. +- Supports table index. +- Supports [column default value](./manage-relational-metadata-using-gravitino.md#table-column-default-value) and [auto-increment](./manage-relational-metadata-using-gravitino.md#table-column-auto-increment). + +### Catalog properties + +You can pass to a OceanBase data source any property that isn't defined by Gravitino by adding `gravitino.bypass.` prefix as a catalog property. For example, catalog property `gravitino.bypass.maxWaitMillis` will pass `maxWaitMillis` to the data source property. + +Check the relevant data source configuration in [data source properties](https://commons.apache.org/proper/commons-dbcp/configuration.html) + +If you use a JDBC catalog, you must provide `jdbc-url`, `jdbc-driver`, `jdbc-user` and `jdbc-password` to catalog properties. +Besides the [common catalog properties](./gravitino-server-config.md#gravitino-catalog-properties-configuration), the OceanBase catalog has the following properties: + +| Configuration item | Description | Default value | Required | Since Version | +|----------------------|--------------------------------------------------------------------------------------------------------|---------------|----------|---------------| +| `jdbc-url` | JDBC URL for connecting to the database. For example, `jdbc:mysql://localhost:2881` | (none) | Yes | 0.3.0 | +| `jdbc-driver` | The driver of the JDBC connection. For example, `com.mysql.jdbc.Driver` or `com.mysql.cj.jdbc.Driver`. | (none) | Yes | 0.3.0 | +| `jdbc-user` | The JDBC user name. | (none) | Yes | 0.3.0 | +| `jdbc-password` | The JDBC password. | (none) | Yes | 0.3.0 | +| `jdbc.pool.min-size` | The minimum number of connections in the pool. `2` by default. | `2` | No | 0.3.0 | +| `jdbc.pool.max-size` | The maximum number of connections in the pool. `10` by default. | `10` | No | 0.3.0 | + +:::caution +You must download the corresponding JDBC driver to the `catalogs/jdbc-oceanbase/libs` directory. Review Comment: `OceanBase Connector/J` is also available. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
