xintongsong commented on code in PR #3384:
URL: https://github.com/apache/paimon/pull/3384#discussion_r1611479640
##########
paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/sink/FlinkSinkBuilder.java:
##########
@@ -119,8 +133,86 @@ public FlinkSinkBuilder inputBounded(boolean bounded) {
return this;
}
+ /** Set the table sort info. */
+ public FlinkSinkBuilder setTableSortInfo(
+ String sortColumnsString,
+ String sortStrategy,
+ boolean sortInCluster,
+ int sampleFactor) {
+ // 1. The table sort will be ignored if the sort columns are not
specified.
+ if (sortColumnsString == null || sortColumnsString.isEmpty()) {
+ return this;
+ }
+ // 2. Check the table type.
+ checkState(
+ table.bucketMode().equals(BUCKET_UNAWARE),
+ "Clustering only supports bucket unaware table without primary
keys.");
+ // 3. Check the sort columns.
+ List<String> sortColumns = Arrays.asList(sortColumnsString.split(","));
+ List<String> fieldNames = table.schema().fieldNames();
+ checkState(
+ new HashSet<>(fieldNames).containsAll(new
HashSet<>(sortColumns)),
+ String.format(
+ "Field names %s should contains all clustering column
names %s.",
+ fieldNames, sortColumns));
+ // 4. Check the execution mode.
+ checkState(input != null, "The input stream should be specified
earlier.");
+ if (boundedInput == null) {
+ boundedInput = !FlinkSink.isStreaming(input);
+ }
+ checkState(boundedInput, "The clustering should be executed under
batch mode.");
Review Comment:
1. +1 for not failing the job. We can enable the feature only when all the
conditions are matched. Otherwise, if the `by-columns` are configured, we can
print a warning log about it.
2. We probably should also mention the limitations (batch mode, table type,
etc.) in the configuration description.
##########
paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/sink/FlinkSinkBuilder.java:
##########
@@ -119,8 +133,86 @@ public FlinkSinkBuilder inputBounded(boolean bounded) {
return this;
}
+ /** Set the table sort info. */
+ public FlinkSinkBuilder setTableSortInfo(
Review Comment:
+1
##########
paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/sorter/TableSortInfo.java:
##########
@@ -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.sorter;
+
+import org.apache.paimon.flink.FlinkConnectorOptions;
+
+import java.util.Collections;
+import java.util.List;
+
+import static
org.apache.flink.shaded.guava31.com.google.common.base.Preconditions.checkArgument;
+
+/**
+ * {@link TableSortInfo} is used to indicate the configuration details for
table data sorting. This
+ * includes information about which columns to sort by, the sorting strategy
(e.g., order, Z-order),
+ * whether to sort within each cluster, and sample sizes for local and global
sample nodes.
+ */
+public class TableSortInfo {
+
+ private final List<String> sortColumns;
+
+ private final String sortStrategy;
Review Comment:
I'd suggest to use `OrderType` for this field. This would allow us to check
the field early, in `Builder#setSortStrategy`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
