commit	c4ae0512941f98108caaa13fe4cf2dfcece61b6e	[log] [tgz]
author	North Lin <37775475+qg-lin@users.noreply.github.com>	Fri Sep 20 09:57:07 2024 +0800
committer	GitHub <noreply@github.com>	Fri Sep 20 09:57:07 2024 +0800
tree	f747fd96e963f48dfcdb15decb97818d51c6c832
parent	d7323aaff5a67bed8c63624738f06109af1cdd89 [diff]

tree: f747fd96e963f48dfcdb15decb97818d51c6c832

README.md

Flink Connector for Apache Doris

Flink Doris Connector

Flink Doris Connector now support flink version from 1.11 to 1.20.

If you wish to contribute or use a connector from flink 1.13 (and earlier), please use the branch-for-flink-before-1.13

More information about compilation and usage, please visit Flink Doris Connector

License

Apache License, Version 2.0

How to Build

You need to copy customer_env.sh.tpl to customer_env.sh before build and you need to configure it before build.

git clone git@github.com:apache/doris-flink-connector.git
cd doris-flink-connector/flink-doris-connector
./build.sh

how-to-build

Code Style

Code Formatting

You need to install the google-java-format plugin. Spotless together with google-java-format is used to format the codes.

It is recommended to automatically format your code by applying the following settings:

Go to “Settings” → “Other Settings” → “google-java-format Settings”.
Tick the checkbox to enable the plugin.
Change the code style to “Android Open Source Project (AOSP) style”.
Go to “Settings” → “Tools” → “Actions on Save”.
Under “Formatting Actions”, select “Optimize imports” and “Reformat file”.
From the “All file types list” next to “Reformat code”, select “Java”.

For earlier IntelliJ IDEA versions, the step 4 to 7 will be changed as follows.

4.Go to “Settings” → “Other Settings” → “Save Actions”.
5.Under “General”, enable your preferred settings for when to format the code, e.g. “Activate save actions on save”.
6.Under “Formatting Actions”, select “Optimize imports” and “Reformat file”.
7.Under “File Path Inclusions”, add an entry for .*\.java to avoid formatting other file types. Then the whole project could be formatted by command mvn spotless:apply.

Checkstyle

Checkstyle is used to enforce static coding guidelines.

Go to “Settings” → “Tools” → “Checkstyle”.
Set “Scan Scope” to “Only Java sources (including tests)”.
For “Checkstyle Version” select “8.14”.
Under “Configuration File” click the “+” icon to add a new configuration.
Set “Description” to “doris-flink-connector”.
Select “Use a local Checkstyle file” and link it to the file tools/maven/checkstyle.xml which is located within your cloned repository.
Select “Store relative to project location” and click “Next”.
Configure the property checkstyle.suppressions.file with the value suppressions.xml and click “Next”.
Click “Finish”.
Select “doris-flink-connector” as the only active configuration file and click “Apply”.

You can now import the Checkstyle configuration for the Java code formatter.

Go to “Settings” → “Editor” → “Code Style” → “Java”.
Click the gear icon next to “Scheme” and select “Import Scheme” → “Checkstyle Configuration”.
Navigate to and select tools/maven/checkstyle.xml located within your cloned repository.

Then you could click “View” → “Tool Windows” → “Checkstyle” and find the “Check Module” button in the opened tool window to validate checkstyle. Or you can use the command mvn clean compile checkstyle:checkstyle to validate.

Report issues or submit pull request

If you find any bugs, feel free to file a GitHub issue or fix it by submitting a pull request.

Contact Us

Name	Scope
dev@doris.apache.org	Development-related discussions	Subscribe	Unsubscribe	Archives