Skip to content

[#7895]improvement(flink-connector): update flink connector document to make it better#7920

Merged
FANNG1 merged 5 commits intomainfrom
update_flink_connector_doc
Aug 6, 2025
Merged

[#7895]improvement(flink-connector): update flink connector document to make it better#7920
FANNG1 merged 5 commits intomainfrom
update_flink_connector_doc

Conversation

@shaofengshi
Copy link
Contributor

What changes were proposed in this pull request?

The flink document has something wrong, which may make the user confusing.

Why are the changes needed?

  1. Use the correct grammer as Flink document listed : https://nightlies.apache.org/flink/flink-docs-master/docs/dev/table/sql/use/#use-catalog
  2. Add the instruction on putting jar files.
  3. Add the set batch command in each markdown file, so that Flink won't report error.

Fix: #7895

Does this PR introduce any user-facing change?

No, only documentation.

How was this patch tested?

Tested by manual, with latest 0.9.1 release and Flink 1.18 version.

@shaofengshi shaofengshi requested a review from FANNG1 August 4, 2025 11:26
@shaofengshi shaofengshi added the documentation Improvements or additions to documentation label Aug 4, 2025

3. Execute the Flink SQL query.
3. Add necessary jar files to Flink's `lib` sub-folder.
To run Flink with Gravitino connector and then access the data sources like Hive, Iceberg and others, you need to put the necessary jar files into Flink's `lib` folder. For example, to access Hive, you need to add at least these jar files: `flink-connector-hive_{version}.jar`, `hive-metastore-{version}.jar`, `hive-exec-{version}-core.jar`, `hive-serde-{version}.jar`, `hive-shims-common-{version}.jar`, `hive-storage-api-{version}.jar`, etc.
Copy link
Contributor

Choose a reason for hiding this comment

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

Flink package doesn't contain hive jars?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Right, it doesn't contain hive jars by default; so we need to copy many jar files. This is the original list:

image

Copy link
Contributor

Choose a reason for hiding this comment

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

There are different ways to add hive dependencies. I would suggest adding a reference to https://nightlies.apache.org/flink/flink-docs-master/docs/connectors/table/hive/overview/#dependencies

- [`gravitino-flink-connector-runtime-1.18_2.12-${gravitino-version}.jar`](https://mvnrepository.com/artifact/org.apache.gravitino/gravitino-flink-connector-runtime-1.18)
- JDBC driver

Next, edit the JDBC catalog in Gravitino, add the `flink.bypass.default-database` property, and give it an value of the default database.
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you polish this sentence? it's odd to use edit, user may doesn't create jdbc catalog yet.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done, please check it again.

@shaofengshi shaofengshi requested a review from FANNG1 August 6, 2025 03:03
@FANNG1 FANNG1 merged commit 5aa8918 into main Aug 6, 2025
25 checks passed
@jerryshao jerryshao deleted the update_flink_connector_doc branch August 18, 2025 06:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Improvement] Flink connector document need some improvements

2 participants