tengqm commented on code in PR #6772:
URL: https://github.com/apache/gravitino/pull/6772#discussion_r2017727425
##########
docs/flink-connector/flink-catalog-jdbc.md:
##########
@@ -0,0 +1,117 @@
+---
+title: "Flink connector jdbc catalog"
+slug: /flink-connector/flink-catalog-jdbc
+keyword: flink connector jdbc catalog
+license: "This software is licensed under the Apache License version 2."
+---
+
+This document provides a comprehensive guide on configuring and using Apache
Gravitino Flink connector to access the Jdbc catalog managed by the Gravitino
server.
+
+## Capabilities
+
+### Supported Jdbc Types
+
+* Mysql
+
+## Getting Started
+
+### Prerequisites
+
+Place the following JAR files in the lib directory of your Flink installation:
+
+- `flink-connector-jdbc-${flinkJdbcConnectorVersion}.jar`
+- `gravitino-flink-connector-runtime-1.18_2.12-${gravitino-version}.jar`
+- jdbc driver
+
+### SQL Example
+
+```sql
+show databases;
+-- +------------------+
+-- | database name |
+-- +------------------+
+-- | mysql |
+-- +------------------+
+
+create database jdbc_database;
+-- [INFO] Execute statement succeed.
+
+show databases;
+-- +------------------+
+-- | database name |
+-- +------------------+
+-- | mysql |
+-- | jdbc_database |
+-- +------------------+
+
+use jdbc_database;
+-- [INFO] Execute statement succeed.
+
+SET 'execution.runtime-mode' = 'batch';
+-- [INFO] Execute statement succeed.
+
+SET 'sql-client.execution.result-mode' = 'tableau';
+-- [INFO] Execute statement succeed.
+
+use jdbc_database;
+-- [INFO] Execute statement succeed.
+
+show tables;
+-- Empty set
+
+CREATE TABLE jdbc_table_a (
+ aa BIGINT NOT NULL PRIMARY KEY NOT ENFORCED,
+ bb BIGINT
+);
+-- [INFO] Execute statement succeed.
+
+show tables;
+-- +--------------+
+-- | table name |
+-- +--------------+
+-- | jdbc_table_a |
+-- +--------------+
+-- 1 row in set
+
+insert into jdbc_table_a values(1,2);
+
+select * from jdbc_table_a;
+-- +----+----+
+-- | aa | bb |
+-- +----+----+
+-- | 1 | 2 |
+-- +----+----+
+-- 1 row in set
+
+insert into jdbc_table_a values(2,3);
+-- [INFO] Submitting SQL update statement to the cluster...
+-- [INFO] SQL update statement has been successfully submitted to the cluster:
+-- Job ID: bc320828d49b97b684ed9f622f1b8aca
+
+insert into jdbc_table_a values(1,4);
+-- [INFO] Submitting SQL update statement to the cluster...
+-- [INFO] SQL update statement has been successfully submitted to the cluster:
+-- Job ID: bc320828d49b97b684ed9f622f1b8aca
+
+select * from jdbc_table_a;
+-- +----+----+
+-- | aa | bb |
+-- +----+----+
+-- | 1 | 4 |
+-- | 2 | 3 |
+-- +----+----+
+-- 2 rows in set
+
+```
+
+## Catalog properties
+
+Gravitino Flink connector will transform below property names which are
defined in catalog properties to Flink Jdbc connector configuration.
+
+| Gravitino catalog property name | Flink Jdbc connector configuration |
Description | Since Version |
+|:--------------------------------|------------------------------------|------------------------------------|------------------|
+| `jdbc-url` | `base-url` | Jdbc
url for mysql | 0.9.0-incubating |
Review Comment:
Jdbc -> JDBC
url -> URL
mysql -> MySQL
Please correct the spelling in the whole page.
--
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: commits-unsubscr...@gravitino.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
