Skip to content

Commit

Permalink
[doc] Doc of create_tag by latest snapshot (#2993)
Browse files Browse the repository at this point in the history
  • Loading branch information
yuzelin authored Mar 12, 2024
1 parent 1024c56 commit 0087f3a
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 3 deletions.
5 changes: 4 additions & 1 deletion docs/content/engines/flink.md
Original file line number Diff line number Diff line change
Expand Up @@ -392,7 +392,10 @@ table options syntax: we use string to represent table options. The format is 'k
<tr>
<td>create_tag</td>
<td>
CALL [catalog.]sys.create_tag('identifier', 'tagName', snapshotId)
-- based on the specified snapshot <br/>
CALL [catalog.]sys.create_tag('identifier', 'tagName', snapshotId) <br/>
-- based on the latest snapshot <br/>
CALL [catalog.]sys.create_tag('identifier', 'tagName')
</td>
<td>
To create a tag based on given snapshot. Arguments:
Expand Down
7 changes: 6 additions & 1 deletion docs/content/engines/spark.md
Original file line number Diff line number Diff line change
Expand Up @@ -584,7 +584,12 @@ s
<li>tag: name of the new tag. Cannot be empty.</li>
<li>snapshot(Long): id of the snapshot which the new tag is based on.</li>
</td>
<td>CALL sys.create_tag(table => 'default.T', tag => 'my_tag', snapshot => 10)</td>
<td>
-- based on snapshot 10 <br/>
CALL sys.create_tag(table => 'default.T', tag => 'my_tag', snapshot => 10) <br/>
-- based on the latest snapshot <br/>
CALL sys.create_tag(table => 'default.T', tag => 'my_tag')
</td>
</tr>
<tr>
<td>delete_tag</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/content/maintenance/manage-tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Paimon supports automatic creation of tags in writing job.

**Step 1: Choose Creation Mode**

You can set `'tag.automatic-creation'` to `process-time` or `watermark`:
You can set creation mode by table option `'tag.automatic-creation'`. Supported values are:
- `process-time`: Create TAG based on the time of the machine.
- `watermark`: Create TAG based on the watermark of the Sink input.
- `batch`: In a batch processing scenario, a tag is generated after the current task is completed.
Expand Down

0 comments on commit 0087f3a

Please sign in to comment.