-
Notifications
You must be signed in to change notification settings - Fork 1.3k
[core] add SuccessFileTagCallback for tag creation #4847
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
78 changes: 78 additions & 0 deletions
78
paimon-core/src/main/java/org/apache/paimon/tag/SuccessFileTagCallback.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| /* | ||
| * 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.tag; | ||
|
|
||
| import org.apache.paimon.annotation.VisibleForTesting; | ||
| import org.apache.paimon.fs.FileIO; | ||
| import org.apache.paimon.fs.Path; | ||
| import org.apache.paimon.partition.file.SuccessFile; | ||
| import org.apache.paimon.table.sink.TagCallback; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| /** A {@link TagCallback} which create "{tagName}_SUCCESS" file. */ | ||
| public class SuccessFileTagCallback implements TagCallback { | ||
| private static final String SUCCESS_FILE_SUFFIX = "_SUCCESS"; | ||
| private static final String SUCCESS_FILE_DIRECTORY = "tag-success-file"; | ||
|
|
||
| private final FileIO fileIO; | ||
| private final Path successFileDirectory; | ||
|
|
||
| public SuccessFileTagCallback(FileIO fileIO, Path tagDirectory) { | ||
| this.fileIO = fileIO; | ||
| this.successFileDirectory = new Path(tagDirectory, SUCCESS_FILE_DIRECTORY); | ||
| try { | ||
| fileIO.checkOrMkdirs(successFileDirectory); | ||
| } catch (IOException e) { | ||
| throw new RuntimeException(e); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void notifyCreation(String tagName) { | ||
| Path tagSuccessPath = tagSuccessFilePath(tagName); | ||
| long currentTime = System.currentTimeMillis(); | ||
| SuccessFile successFile = new SuccessFile(currentTime, currentTime); | ||
|
|
||
| try { | ||
| if (fileIO.exists(tagSuccessPath)) { | ||
| successFile = | ||
| SuccessFile.fromPath(fileIO, tagSuccessPath) | ||
| .updateModificationTime(currentTime); | ||
| } | ||
| fileIO.overwriteFileUtf8(tagSuccessPath, successFile.toJson()); | ||
| } catch (IOException e) { | ||
| throw new RuntimeException(e); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void notifyDeletion(String tagName) { | ||
| Path tagSuccessPath = tagSuccessFilePath(tagName); | ||
| fileIO.deleteQuietly(tagSuccessPath); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| public Path tagSuccessFilePath(String tagName) { | ||
| return new Path(successFileDirectory, tagName + SUCCESS_FILE_SUFFIX); | ||
| } | ||
|
|
||
| @Override | ||
| public void close() throws Exception {} | ||
| } | ||
105 changes: 105 additions & 0 deletions
105
paimon-core/src/test/java/org/apache/paimon/tag/SuccessFileTagCallBackTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| /* | ||
| * 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.tag; | ||
|
|
||
| import org.apache.paimon.CoreOptions; | ||
| import org.apache.paimon.FileStore; | ||
| import org.apache.paimon.catalog.PrimaryKeyTableTestBase; | ||
| import org.apache.paimon.fs.FileIO; | ||
| import org.apache.paimon.fs.Path; | ||
| import org.apache.paimon.manifest.ManifestCommittable; | ||
| import org.apache.paimon.options.Options; | ||
| import org.apache.paimon.table.FileStoreTable; | ||
| import org.apache.paimon.table.sink.TableCommitImpl; | ||
| import org.apache.paimon.table.sink.TagCallback; | ||
| import org.apache.paimon.utils.TagManager; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.List; | ||
|
|
||
| import static org.apache.paimon.CoreOptions.TAG_AUTOMATIC_CREATION; | ||
| import static org.apache.paimon.CoreOptions.TAG_CREATION_PERIOD; | ||
| import static org.apache.paimon.CoreOptions.TAG_NUM_RETAINED_MAX; | ||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| /** Test for {@link SuccessFileTagCallback}. */ | ||
| public class SuccessFileTagCallBackTest extends PrimaryKeyTableTestBase { | ||
|
|
||
| @Test | ||
| public void testWithSuccessFile() throws IOException { | ||
| Options options = new Options(); | ||
| options.set(CoreOptions.TAG_CREATE_SUCCESS_FILE, true); | ||
| options.set(TAG_AUTOMATIC_CREATION, CoreOptions.TagCreationMode.WATERMARK); | ||
| options.set(TAG_CREATION_PERIOD, CoreOptions.TagCreationPeriod.HOURLY); | ||
| options.set(TAG_NUM_RETAINED_MAX, 3); | ||
| FileStoreTable table = this.table.copy(options.toMap()); | ||
| FileIO fileIO = table.fileIO(); | ||
| TableCommitImpl commit = table.newCommit(commitUser).ignoreEmptyCommit(false); | ||
| FileStore<?> fileStore = table.store(); | ||
| TagManager tagManager = fileStore.newTagManager(); | ||
| SuccessFileTagCallback successFileTagCallback = null; | ||
|
|
||
| List<TagCallback> tagCallbacks = fileStore.createTagCallbacks(); | ||
| assertThat(tagCallbacks).hasAtLeastOneElementOfType(SuccessFileTagCallback.class); | ||
|
|
||
| for (TagCallback tagCallback : tagCallbacks) { | ||
| if (tagCallback instanceof SuccessFileTagCallback) { | ||
| successFileTagCallback = (SuccessFileTagCallback) tagCallback; | ||
| } | ||
| } | ||
|
|
||
| commit.commit(new ManifestCommittable(0, utcMills("2023-07-18T12:12:00"))); | ||
| assertThat(tagManager.allTagNames()).containsOnly("2023-07-18 11"); | ||
| assertThat(fileIO.exists(successFileTagCallback.tagSuccessFilePath("2023-07-18 11"))) | ||
| .isTrue(); | ||
|
|
||
| table.deleteTag("2023-07-18 11"); | ||
| assertThat(tagManager.get("2023-07-18 11")).isEmpty(); | ||
| assertThat(fileIO.exists(successFileTagCallback.tagSuccessFilePath("2023-07-18 11"))) | ||
| .isFalse(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testWithoutSuccessFile() throws IOException { | ||
| Options options = new Options(); | ||
| options.set(CoreOptions.TAG_CREATE_SUCCESS_FILE, false); | ||
| options.set(TAG_AUTOMATIC_CREATION, CoreOptions.TagCreationMode.WATERMARK); | ||
| options.set(TAG_CREATION_PERIOD, CoreOptions.TagCreationPeriod.HOURLY); | ||
| options.set(TAG_NUM_RETAINED_MAX, 3); | ||
| FileStoreTable table = this.table.copy(options.toMap()); | ||
| FileIO fileIO = table.fileIO(); | ||
| TableCommitImpl commit = table.newCommit(commitUser).ignoreEmptyCommit(false); | ||
| FileStore<?> fileStore = table.store(); | ||
| TagManager tagManager = fileStore.newTagManager(); | ||
| List<TagCallback> tagCallbacks = fileStore.createTagCallbacks(); | ||
| assertThat(tagCallbacks).doesNotHaveAnyElementsOfTypes(SuccessFileTagCallback.class); | ||
|
|
||
| commit.commit(new ManifestCommittable(0, utcMills("2023-07-18T12:12:00"))); | ||
| assertThat(tagManager.allTagNames()).containsOnly("2023-07-18 11"); | ||
| assertThat(fileIO.exists(new Path(tagManager.tagPath("2023-07-18 11"), "tag-success-file"))) | ||
| .isFalse(); | ||
|
|
||
| table.deleteTag("2023-07-18 11"); | ||
| assertThat(tagManager.get("2023-07-18 11")).isEmpty(); | ||
| assertThat(fileIO.exists(new Path(tagManager.tagPath("2023-07-18 11"), "tag-success-file"))) | ||
| .isFalse(); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.