Skip to content

Commit

Permalink
[flink] add CreateTagFromWatermarkAction (#4101)
Browse files Browse the repository at this point in the history
  • Loading branch information
herefree authored Sep 4, 2024
1 parent 5ea5953 commit 538c9c7
Show file tree
Hide file tree
Showing 6 changed files with 307 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,10 @@ public Optional<Action> create(MultipleParameterToolAdapter params) {
String timeRetained = params.get(TIME_RETAINED);
Map<String, String> catalogConfig = optionalConfigMap(params, CATALOG_CONF);

CreateTagFromTimestampAction migrateFileAction =
CreateTagFromTimestampAction createTagFromTimestampAction =
new CreateTagFromTimestampAction(
warehouse, table, tag, timestamp, timeRetained, catalogConfig);
return Optional.of(migrateFileAction);
return Optional.of(createTagFromTimestampAction);
}

@Override
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.apache.paimon.flink.action;

import org.apache.paimon.flink.procedure.CreateTagFromWatermarkProcedure;

import org.apache.flink.table.procedure.DefaultProcedureContext;

import java.util.Map;

/** Create tag from watermark action for Flink. */
public class CreateTagFromWatermarkAction extends ActionBase {
private final String table;
private final String tag;
private final Long watermark;
private final String timeRetained;

public CreateTagFromWatermarkAction(
String warehouse,
String table,
String tag,
Long watermark,
String timeRetained,
Map<String, String> catalogConfig) {
super(warehouse, catalogConfig);
this.table = table;
this.tag = tag;
this.watermark = watermark;
this.timeRetained = timeRetained;
}

@Override
public void run() throws Exception {
CreateTagFromWatermarkProcedure createTagFromWatermarkProcedure =
new CreateTagFromWatermarkProcedure();
createTagFromWatermarkProcedure.withCatalog(catalog);
createTagFromWatermarkProcedure.call(
new DefaultProcedureContext(env), table, tag, watermark, timeRetained);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.apache.paimon.flink.action;

import java.util.Map;
import java.util.Optional;

/** Factory to create {@link CreateTagFromWatermarkAction}. */
public class CreateTagFromWatermarkActionFactory implements ActionFactory {

public static final String IDENTIFIER = "create_tag_from_watermark";

private static final String TABLE = "table";

private static final String TAG = "tag";

private static final String WATERMARK = "watermark";

private static final String TIME_RETAINED = "time_retained";

@Override
public String identifier() {
return IDENTIFIER;
}

@Override
public Optional<Action> create(MultipleParameterToolAdapter params) {
String warehouse = params.get(WAREHOUSE);
String table = params.get(TABLE);
String tag = params.get(TAG);
Long watermark = Long.parseLong(params.get(WATERMARK));
String timeRetained = params.get(TIME_RETAINED);
Map<String, String> catalogConfig = optionalConfigMap(params, CATALOG_CONF);

CreateTagFromWatermarkAction createTagFromWatermarkAction =
new CreateTagFromWatermarkAction(
warehouse, table, tag, watermark, timeRetained, catalogConfig);
return Optional.of(createTagFromWatermarkAction);
}

@Override
public void printHelp() {
System.out.println("Action \"create_tag_from_watermark\" create tag from watermark.");
System.out.println();

System.out.println("Syntax:");
System.out.println(
" create_tag_from_watermark --warehouse <warehouse_path> "
+ "--table <database.table_name> "
+ "--tag <tag> "
+ "--watermark <watermark> "
+ "[--timeRetained <duration>] "
+ "[--options <key>=<value>,<key>=<value>,...]");
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ org.apache.paimon.flink.action.MergeIntoActionFactory
org.apache.paimon.flink.action.RollbackToActionFactory
org.apache.paimon.flink.action.CreateTagActionFactory
org.apache.paimon.flink.action.CreateTagFromTimestampActionFactory
org.apache.paimon.flink.action.CreateTagFromWatermarkActionFactory
org.apache.paimon.flink.action.DeleteTagActionFactory
org.apache.paimon.flink.action.ResetConsumerActionFactory
org.apache.paimon.flink.action.MigrateTableActionFactory
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.apache.paimon.flink.action;

import org.apache.paimon.Snapshot;
import org.apache.paimon.table.FileStoreTable;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import static org.apache.paimon.flink.util.ReadWriteTableTestUtil.bEnv;
import static org.apache.paimon.flink.util.ReadWriteTableTestUtil.init;
import static org.assertj.core.api.Assertions.assertThat;

/** IT cases for {@link CreateTagFromTimestampAction}. */
public class CreateTagFromWatermarkActionITTest extends ActionITCaseBase {

@BeforeEach
public void setUp() {
init(warehouse);
}

@Test
public void testCreateTagsFromSnapshotsWatermark() throws Exception {
bEnv.executeSql(
"CREATE TABLE T ("
+ " k STRING,"
+ " dt STRING,"
+ " PRIMARY KEY (k, dt) NOT ENFORCED"
+ ") PARTITIONED BY (dt) WITH ("
+ " 'bucket' = '1'"
+ ")");

bEnv.executeSql("insert into T values('k1', '2024-01-02')").await();
// create snapshot 2 with watermark 1000.
bEnv.executeSql(
"insert into T/*+ OPTIONS('end-input.watermark'= '1000') */ values('k2', '2024-01-02')")
.await();
// create snapshot 3 with watermark 2000.
bEnv.executeSql(
"insert into T/*+ OPTIONS('end-input.watermark'= '2000') */ values('k3', '2024-01-02')")
.await();
FileStoreTable table = getFileStoreTable("T");

Snapshot snapshot2 = table.snapshotManager().snapshot(2);
long commitTime2 = snapshot2.timeMillis();
long watermark2 = snapshot2.watermark();

Snapshot snapshot3 = table.snapshotManager().snapshot(3);
long commitTime3 = snapshot3.timeMillis();
long watermark3 = snapshot3.watermark();
createAction(
CreateTagFromWatermarkAction.class,
"create_tag_from_watermark",
"--warehouse",
warehouse,
"--table",
database + ".T",
"--tag",
"tag2",
"--watermark",
Long.toString(watermark2 - 1))
.run();
assertThat(table.tagManager().tagExists("tag2")).isTrue();
assertThat(table.tagManager().taggedSnapshot("tag2").watermark()).isEqualTo(watermark2);
assertThat(table.tagManager().taggedSnapshot("tag2").timeMillis()).isEqualTo(commitTime2);

createAction(
CreateTagFromWatermarkAction.class,
"create_tag_from_watermark",
"--warehouse",
warehouse,
"--table",
database + ".T",
"--tag",
"tag3",
"--watermark",
Long.toString(watermark2 + 1))
.run();
assertThat(table.tagManager().tagExists("tag3")).isTrue();
assertThat(table.tagManager().taggedSnapshot("tag3").watermark()).isEqualTo(watermark3);
assertThat(table.tagManager().taggedSnapshot("tag3").timeMillis()).isEqualTo(commitTime3);
}

@Test
public void testCreateTagsFromTagsWatermark() throws Exception {
bEnv.executeSql(
"CREATE TABLE T ("
+ " k STRING,"
+ " dt STRING,"
+ " PRIMARY KEY (k, dt) NOT ENFORCED"
+ ") PARTITIONED BY (dt) WITH ("
+ " 'bucket' = '1'"
+ ")");

bEnv.executeSql(
"insert into T/*+ OPTIONS('end-input.watermark'= '1000') */ values('k2', '2024-01-02')")
.await();

bEnv.executeSql("CALL sys.create_tag('default.T', 'tag1', 1)").await();

// make snapshot-1 expire.
bEnv.executeSql(
"insert into T/*+ OPTIONS('end-input.watermark'= '2000',"
+ " 'snapshot.num-retained.max' = '1',"
+ " 'snapshot.num-retained.min' = '1') */"
+ " values('k2', '2024-01-02')")
.await();

FileStoreTable table = getFileStoreTable("T");

assertThat(table.snapshotManager().snapshotExists(1)).isFalse();

Snapshot tagSnapshot1 = table.tagManager().taggedSnapshot("tag1");

long tagsCommitTime = tagSnapshot1.timeMillis();
long tagsWatermark = tagSnapshot1.watermark();

Snapshot snapshot2 = table.snapshotManager().snapshot(2);
long commitTime2 = snapshot2.timeMillis();
long watermark2 = snapshot2.watermark();

assertThat(tagsWatermark == 1000).isTrue();
assertThat(watermark2 == 2000).isTrue();

createAction(
CreateTagFromWatermarkAction.class,
"create_tag_from_watermark",
"--warehouse",
warehouse,
"--table",
database + ".T",
"--tag",
"tag2",
"--watermark",
Long.toString(tagsWatermark - 1))
.run();
assertThat(table.tagManager().tagExists("tag2")).isTrue();
assertThat(table.tagManager().taggedSnapshot("tag2").watermark()).isEqualTo(tagsWatermark);
assertThat(table.tagManager().taggedSnapshot("tag2").timeMillis())
.isEqualTo(tagsCommitTime);

createAction(
CreateTagFromWatermarkAction.class,
"create_tag_from_watermark",
"--warehouse",
warehouse,
"--table",
database + ".T",
"--tag",
"tag3",
"--watermark",
Long.toString(watermark2 - 1))
.run();
assertThat(table.tagManager().tagExists("tag3")).isTrue();
assertThat(table.tagManager().taggedSnapshot("tag3").watermark()).isEqualTo(watermark2);
assertThat(table.tagManager().taggedSnapshot("tag3").timeMillis()).isEqualTo(commitTime2);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
public class CreateTagFromWatermarkProcedureITCase extends CatalogITCaseBase {

@Test
public void testCreatTagsFromSnapshotsWatermark() throws Exception {
public void testCreateTagsFromSnapshotsWatermark() throws Exception {
sql(
"CREATE TABLE T ("
+ " k STRING,"
Expand Down Expand Up @@ -121,7 +121,7 @@ public void testCreatTagsFromSnapshotsWatermark() throws Exception {
}

@Test
public void testCreatTagsFromTagsWatermark() throws Exception {
public void testCreateTagsFromTagsWatermark() throws Exception {
sql(
"CREATE TABLE T ("
+ " k STRING,"
Expand Down

0 comments on commit 538c9c7

Please sign in to comment.