This is an automated email from the ASF dual-hosted git repository.
lzljs3620320 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-paimon.git
The following commit(s) were added to refs/heads/master by this push:
new 41d640e85 [doc] Document the Paimon action jars in Engine/Flink (#1505)
41d640e85 is described below
commit 41d640e852f6b5cda91d9e3dfd2df75b02354574
Author: Congxian Qiu <[email protected]>
AuthorDate: Thu Jul 6 11:14:35 2023 +0800
[doc] Document the Paimon action jars in Engine/Flink (#1505)
---
docs/content/engines/flink.md | 53 +++++++++++++++++++++++++++++++------------
1 file changed, 38 insertions(+), 15 deletions(-)
diff --git a/docs/content/engines/flink.md b/docs/content/engines/flink.md
index f89e9ccc4..a3eccfcf7 100644
--- a/docs/content/engines/flink.md
+++ b/docs/content/engines/flink.md
@@ -34,27 +34,28 @@ Paimon currently supports Flink 1.17, 1.16, 1.15 and 1.14.
We recommend the late
Download the jar file with corresponding version.
+> Currently, paimon provides two types jar: one of which(the bundled jar) is
used for read/write data, and the other(action jar) for operations such as
manually compaction,
{{< stable >}}
-| Version | Jar
|
-|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Flink 1.17 | [paimon-flink-1.17-{{< version
>}}.jar](https://repo.maven.apache.org/maven2/org/apache/paimon/paimon-flink-1.17/{{<
version >}}/paimon-flink-1.17-{{< version >}}.jar) |
-| Flink 1.16 | [paimon-flink-1.16-{{< version
>}}.jar](https://repo.maven.apache.org/maven2/org/apache/paimon/paimon-flink-1.16/{{<
version >}}/paimon-flink-1.16-{{< version >}}.jar) |
-| Flink 1.15 | [paimon-flink-1.15-{{< version
>}}.jar](https://repo.maven.apache.org/maven2/org/apache/paimon/paimon-flink-1.15/{{<
version >}}/paimon-flink-1.15-{{< version >}}.jar) |
-| Flink 1.14 | [paimon-flink-1.14-{{< version
>}}.jar](https://repo.maven.apache.org/maven2/org/apache/paimon/paimon-flink-1.14/{{<
version >}}/paimon-flink-1.14-{{< version >}}.jar) |
-| Flink Action | [paimon-flink-action-{{< version
>}}.jar](https://repo.maven.apache.org/maven2/org/apache/paimon/paimon-flink-action/{{<
version >}}/paimon-flink-action-{{< version >}}.jar) |
+| Version | Type | Jar
|
+|------------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Flink 1.17 | Bundled Jar | [paimon-flink-1.17-{{< version
>}}.jar](https://repo.maven.apache.org/maven2/org/apache/paimon/paimon-flink-1.17/{{<
version >}}/paimon-flink-1.17-{{< version >}}.jar) |
+| Flink 1.16 | Bundled Jar | [paimon-flink-1.16-{{< version
>}}.jar](https://repo.maven.apache.org/maven2/org/apache/paimon/paimon-flink-1.16/{{<
version >}}/paimon-flink-1.16-{{< version >}}.jar) |
+| Flink 1.15 | Bundled Jar | [paimon-flink-1.15-{{< version
>}}.jar](https://repo.maven.apache.org/maven2/org/apache/paimon/paimon-flink-1.15/{{<
version >}}/paimon-flink-1.15-{{< version >}}.jar) |
+| Flink 1.14 | Bundled Jar | [paimon-flink-1.14-{{< version
>}}.jar](https://repo.maven.apache.org/maven2/org/apache/paimon/paimon-flink-1.14/{{<
version >}}/paimon-flink-1.14-{{< version >}}.jar) |
+| Flink Action | Action Jar | [paimon-flink-action-{{< version
>}}.jar](https://repo.maven.apache.org/maven2/org/apache/paimon/paimon-flink-action/{{<
version >}}/paimon-flink-action-{{< version >}}.jar) |
{{< /stable >}}
{{< unstable >}}
-| Version | Jar
|
-|------------|---------------------------------------------------------------------------------------------------------------------------------------|
-| Flink 1.17 | [paimon-flink-1.17-{{< version
>}}.jar](https://repository.apache.org/snapshots/org/apache/paimon/paimon-flink-1.17/{{<
version >}}/) |
-| Flink 1.16 | [paimon-flink-1.16-{{< version
>}}.jar](https://repository.apache.org/snapshots/org/apache/paimon/paimon-flink-1.16/{{<
version >}}/) |
-| Flink 1.15 | [paimon-flink-1.15-{{< version
>}}.jar](https://repository.apache.org/snapshots/org/apache/paimon/paimon-flink-1.15/{{<
version >}}/) |
-| Flink 1.14 | [paimon-flink-1.14-{{< version
>}}.jar](https://repository.apache.org/snapshots/org/apache/paimon/paimon-flink-1.14/{{<
version >}}/) |
-| Flink Action | [paimon-flink-action-{{< version
>}}.jar](https://repository.apache.org/snapshots/org/apache/paimon/paimon-flink-action/{{<
version >}}/) |
+| Version | Type | Jar
|
+|------------|------|---------------------------------------------------------------------------------------------------------------------------------|
+| Flink 1.17 | Bundled Jar | [paimon-flink-1.17-{{< version
>}}.jar](https://repository.apache.org/snapshots/org/apache/paimon/paimon-flink-1.17/{{<
version >}}/) |
+| Flink 1.16 | Bundled Jar | [paimon-flink-1.16-{{< version
>}}.jar](https://repository.apache.org/snapshots/org/apache/paimon/paimon-flink-1.16/{{<
version >}}/) |
+| Flink 1.15 | Bundled Jar | [paimon-flink-1.15-{{< version
>}}.jar](https://repository.apache.org/snapshots/org/apache/paimon/paimon-flink-1.15/{{<
version >}}/) |
+| Flink 1.14 | Bundled Jar | [paimon-flink-1.14-{{< version
>}}.jar](https://repository.apache.org/snapshots/org/apache/paimon/paimon-flink-1.14/{{<
version >}}/) |
+| Flink Action | Action Jar | [paimon-flink-action-{{< version
>}}.jar](https://repository.apache.org/snapshots/org/apache/paimon/paimon-flink-action/{{<
version >}}/) |
{{< /unstable >}}
@@ -65,10 +66,12 @@ To build from source code, [clone the git repository]({{<
github_repo >}}).
Build bundled jar with the following command.
- `mvn clean install -DskipTests`
-You can find the bundled jar in
`./paimon-flink/paimon-flink-<flink-version>/target/paimon-flink-<flink-version>-{{<
version >}}.jar`.
+You can find the bundled jar in
`./paimon-flink/paimon-flink-<flink-version>/target/paimon-flink-<flink-version>-{{<
version >}}.jar`, and the action jar in
`./paimon-flink/paimon-flink-action/target/paimon-flink-action-{{< version
>}}.jar`.
## Quick Start
+### Using bundled Jar
+
**Step 1: Download Flink**
If you haven't downloaded Flink, you can [download
Flink](https://flink.apache.org/downloads.html), then extract the archive with
the following command.
@@ -202,6 +205,26 @@ Stop the Flink local cluster.
./bin/stop-cluster.sh
```
+### Using Action Jar
+After the Flink Local Cluster has been started, you can execute the action jar
by using the following command
+
+```
+<FLINK_HOME>/bin/flink run \
+ /path/to/paimon-flink-action-{{< version >}}.jar \
+ <action>
+ <args>
+```
+
+The following command will used to compact a table
+
+{{< label Batch >}}
+```
+<FLINK_HOME>/bin/flink run \
+ /path/to/paimon-flink-action-{{< version >}}.jar \
+ compact \
+ --path <TABLE_PATH>
+```
+
## Supported Flink Data Type
See [Flink Data
Types](https://nightlies.apache.org/flink/flink-docs-release-1.16/docs/dev/table/types/).
