-
Notifications
You must be signed in to change notification settings - Fork 1.3k
[flink] Expose scan.bucket for single-bucket manifest pruning #8117
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
Open
wwj6591812
wants to merge
1
commit into
apache:master
Choose a base branch
from
wwj6591812:add_scan_bucket_0604
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
136 changes: 136 additions & 0 deletions
136
paimon-core/src/test/java/org/apache/paimon/table/source/ReadBuilderImplTest.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,136 @@ | ||
| /* | ||
| * 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.table.source; | ||
|
|
||
| import org.apache.paimon.CoreOptions; | ||
| import org.apache.paimon.catalog.Catalog; | ||
| import org.apache.paimon.catalog.FileSystemCatalog; | ||
| import org.apache.paimon.catalog.Identifier; | ||
| import org.apache.paimon.fs.Path; | ||
| import org.apache.paimon.fs.local.LocalFileIO; | ||
| import org.apache.paimon.schema.Schema; | ||
| import org.apache.paimon.table.FileStoreTable; | ||
| import org.apache.paimon.types.DataTypes; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.io.TempDir; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThatCode; | ||
| import static org.assertj.core.api.Assertions.assertThatThrownBy; | ||
|
|
||
| /** Tests for {@link ReadBuilderImpl}. */ | ||
| public class ReadBuilderImplTest { | ||
|
|
||
| @TempDir java.nio.file.Path tempDir; | ||
|
|
||
| @Test | ||
| public void testValidateSpecifiedBucketOnFixedBucketPrimaryKeyTable() throws Exception { | ||
| FileStoreTable table = createTable("4", true); | ||
| assertThatCode(() -> table.newReadBuilder().withBucket(0)).doesNotThrowAnyException(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testValidateSpecifiedBucketRejectsDynamicBucketTable() throws Exception { | ||
| FileStoreTable table = createTable("-1", true); | ||
| assertThatThrownBy(() -> table.newReadBuilder().withBucket(0)) | ||
| .isInstanceOf(IllegalArgumentException.class) | ||
| .hasMessageContaining("fixed-bucket tables") | ||
| .hasMessageContaining("HASH_DYNAMIC"); | ||
| } | ||
|
|
||
| @Test | ||
| public void testValidateSpecifiedBucketRejectsPostponeBucketTable() throws Exception { | ||
| FileStoreTable table = createTable("-2", true); | ||
| assertThatThrownBy(() -> table.newReadBuilder().withBucket(0)) | ||
| .isInstanceOf(IllegalArgumentException.class) | ||
| .hasMessageContaining("fixed-bucket tables") | ||
| .hasMessageContaining("POSTPONE_MODE"); | ||
| } | ||
|
|
||
| @Test | ||
| public void testValidateSpecifiedBucketRejectsBucketUnawareTable() throws Exception { | ||
| FileStoreTable table = createBucketUnawareAppendOnlyTable(); | ||
| assertThatThrownBy(() -> table.newReadBuilder().withBucket(0)) | ||
| .isInstanceOf(IllegalArgumentException.class) | ||
| .hasMessageContaining("fixed-bucket tables") | ||
| .hasMessageContaining("BUCKET_UNAWARE"); | ||
| } | ||
|
|
||
| @Test | ||
| public void testValidateSpecifiedBucketAcceptsAppendOnlyTable() throws Exception { | ||
| FileStoreTable table = createAppendOnlyTable("4"); | ||
| assertThatCode(() -> table.newReadBuilder().withBucket(0)).doesNotThrowAnyException(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testValidateSpecifiedBucketRejectsOutOfRangeBucketId() throws Exception { | ||
| FileStoreTable table = createTable("4", true); | ||
| assertThatThrownBy(() -> table.newReadBuilder().withBucket(4)) | ||
| .isInstanceOf(IllegalArgumentException.class) | ||
| .hasMessageContaining("Bucket id 4 must be less than table bucket number 4"); | ||
| } | ||
|
|
||
| private FileStoreTable createTable(String bucket, boolean withPrimaryKey) throws Exception { | ||
| Map<String, String> options = new HashMap<>(); | ||
| options.put(CoreOptions.BUCKET.key(), bucket); | ||
| Schema.Builder schemaBuilder = | ||
| Schema.newBuilder().column("id", DataTypes.INT()).column("v", DataTypes.INT()); | ||
| if (withPrimaryKey) { | ||
| schemaBuilder.primaryKey("id"); | ||
| } | ||
| Schema schema = schemaBuilder.options(options).build(); | ||
| return createTable(schema); | ||
| } | ||
|
|
||
| private FileStoreTable createBucketUnawareAppendOnlyTable() throws Exception { | ||
| Map<String, String> options = new HashMap<>(); | ||
| options.put(CoreOptions.BUCKET.key(), "-1"); | ||
| Schema schema = | ||
| Schema.newBuilder() | ||
| .column("id", DataTypes.INT()) | ||
| .column("v", DataTypes.INT()) | ||
| .options(options) | ||
| .build(); | ||
| return createTable(schema); | ||
| } | ||
|
|
||
| private FileStoreTable createAppendOnlyTable(String bucket) throws Exception { | ||
| Map<String, String> options = new HashMap<>(); | ||
| options.put(CoreOptions.BUCKET.key(), bucket); | ||
| options.put(CoreOptions.BUCKET_KEY.key(), "id"); | ||
| Schema schema = | ||
| Schema.newBuilder() | ||
| .column("id", DataTypes.INT()) | ||
| .column("v", DataTypes.INT()) | ||
| .options(options) | ||
| .build(); | ||
| return createTable(schema); | ||
| } | ||
|
|
||
| private FileStoreTable createTable(Schema schema) throws Exception { | ||
| Catalog catalog = new FileSystemCatalog(LocalFileIO.create(), new Path(tempDir.toString())); | ||
| catalog.createDatabase("default", true); | ||
| Identifier identifier = Identifier.create("default", "test_bucket"); | ||
| catalog.createTable(identifier, schema, false); | ||
| return (FileStoreTable) catalog.getTable(identifier); | ||
| } | ||
| } |
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
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
48 changes: 48 additions & 0 deletions
48
...link/paimon-flink-common/src/main/java/org/apache/paimon/flink/utils/ScanBucketUtils.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,48 @@ | ||
| /* | ||
| * 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.utils; | ||
|
|
||
| import org.apache.paimon.flink.FlinkConnectorOptions; | ||
| import org.apache.paimon.options.Options; | ||
| import org.apache.paimon.table.FileStoreTable; | ||
| import org.apache.paimon.table.Table; | ||
| import org.apache.paimon.table.source.ReadBuilder; | ||
|
|
||
| import static org.apache.paimon.utils.Preconditions.checkArgument; | ||
|
|
||
| /** Utilities for {@link FlinkConnectorOptions#SCAN_BUCKET}. */ | ||
| public class ScanBucketUtils { | ||
|
|
||
| private ScanBucketUtils() {} | ||
|
|
||
| /** Apply {@link FlinkConnectorOptions#SCAN_BUCKET} to the given {@link ReadBuilder}. */ | ||
| public static ReadBuilder applyScanBucket( | ||
| Table table, ReadBuilder readBuilder, Options options) { | ||
| Integer scanBucket = options.get(FlinkConnectorOptions.SCAN_BUCKET); | ||
| if (scanBucket == null) { | ||
| return readBuilder; | ||
| } | ||
| if (table instanceof FileStoreTable) { | ||
| checkArgument( | ||
| !((FileStoreTable) table).schema().primaryKeys().isEmpty(), | ||
| "Bucket scan is only supported for primary key tables."); | ||
| } | ||
| return readBuilder.withBucket(scanBucket); | ||
| } | ||
| } |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This applies scan.bucket only to the normal source read builder. Aggregate pushdown plans splits through AggregatePushDownUtils.planSplits(...) with a separate ReadBuilder, so queries such as SELECT COUNT() FROM T /+ OPTIONS(scan.bucket=0) */ can still aggregate all buckets while non-aggregate reads scan only the requested bucket. Please either apply SCAN_BUCKET in the aggregate pushdown planning path as well, or disable aggregate pushdown when scan.bucket is set.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the review, @JingsongLi.
I have applied ScanBucketUtils.applyScanBucket in AggregatePushDownUtils.planSplits(...) as well, so the aggregate pushdown planning path now respects the scan.bucket option too.