Skip to content

[flink] Support custom properties in Flink table factory #2431

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.

Sign up for GitHub

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
LiebingYu wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[flink] Support custom properties in Flink table factory #2431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 0 additions & 15 deletions ...nk/fluss-flink-common/src/main/java/org/apache/fluss/flink/catalog/FlinkTableFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
import org.apache.fluss.flink.sink.shuffle.DistributionMode;
import org.apache.fluss.flink.source.FlinkTableSource;
import org.apache.fluss.flink.utils.FlinkConnectorOptionsUtils;
import org.apache.fluss.metadata.DataLakeFormat;
import org.apache.fluss.metadata.TablePath;

import org.apache.flink.api.common.RuntimeExecutionMode;
Expand All @@ -48,20 +47,17 @@
import org.apache.flink.table.types.logical.RowType;

import java.time.ZoneId;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;

import static org.apache.fluss.config.ConfigOptions.TABLE_DATALAKE_FORMAT;
import static org.apache.fluss.config.ConfigOptions.TABLE_DELETE_BEHAVIOR;
import static org.apache.fluss.config.FlussConfigUtils.CLIENT_PREFIX;
import static org.apache.fluss.flink.catalog.FlinkCatalog.LAKE_TABLE_SPLITTER;
import static org.apache.fluss.flink.utils.DataLakeUtils.getDatalakeFormat;
import static org.apache.fluss.flink.utils.FlinkConnectorOptionsUtils.getBucketKeyIndexes;
import static org.apache.fluss.flink.utils.FlinkConnectorOptionsUtils.getBucketKeys;
import static org.apache.fluss.flink.utils.FlinkConversions.toFlinkOption;
Expand Down Expand Up @@ -92,11 +88,6 @@ public DynamicTableSource createDynamicTableSource(Context context) {

FactoryUtil.TableFactoryHelper helper = FactoryUtil.createTableFactoryHelper(this, context);
final ReadableConfig tableOptions = helper.getOptions();
Optional<DataLakeFormat> datalakeFormat = getDatalakeFormat(tableOptions);
List<String> prefixesToSkip =
new ArrayList<>(Arrays.asList("table.", "client.", "fields."));
datalakeFormat.ifPresent(dataLakeFormat -> prefixesToSkip.add(dataLakeFormat + "."));
helper.validateExcept(prefixesToSkip.toArray(new String[0]));

boolean isStreamingMode =
context.getConfiguration().get(ExecutionOptions.RUNTIME_MODE)
Expand Down Expand Up @@ -160,12 +151,6 @@ public DynamicTableSource createDynamicTableSource(Context context) {
public DynamicTableSink createDynamicTableSink(Context context) {
FactoryUtil.TableFactoryHelper helper = FactoryUtil.createTableFactoryHelper(this, context);
final ReadableConfig tableOptions = helper.getOptions();
Optional<DataLakeFormat> datalakeFormat = getDatalakeFormat(tableOptions);
if (datalakeFormat.isPresent()) {
helper.validateExcept("table.", "client.", "fields.", datalakeFormat.get() + ".");
} else {
helper.validateExcept("table.", "client.", "fields.");
}

boolean isStreamingMode =
context.getConfiguration().get(ExecutionOptions.RUNTIME_MODE)
Expand Down
17 changes: 4 additions & 13 deletions ...k/fluss-flink-common/src/test/java/org/apache/fluss/flink/catalog/FlinkCatalogITCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -757,20 +757,11 @@ void testCreateTableWithUnknownOptions() {
"create table test_table_other_unknown_options (a int, b int)"
+ " with ('connector' = 'fluss', 'bootstrap.servers' = 'localhost:9092', 'other.unknown.option' = 'other-unknown-val')");

// test invalid table as source
assertThatThrownBy(() -> tEnv.explainSql("select * from test_table_other_unknown_options"))
.cause()
.isInstanceOf(ValidationException.class)
.hasMessageContaining("Unsupported options found for 'fluss'");
// test table with unknown option as source
tEnv.explainSql("select * from test_table_other_unknown_options");

// test invalid table as sink
assertThatThrownBy(
() ->
tEnv.explainSql(
"insert into test_table_other_unknown_options values (1, 2)"))
.cause()
.isInstanceOf(ValidationException.class)
.hasMessageContaining("Unsupported options found for 'fluss'");
// test table with unknown option as sink
tEnv.explainSql("insert into test_table_other_unknown_options values (1, 2)");
}

@Test
Expand Down
10 changes: 6 additions & 4 deletions ...luss-flink-common/src/test/java/org/apache/fluss/flink/catalog/FlinkTableFactoryTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,8 @@ void testTableSourceOptions() {
Map<String, String> validProperties = getBasicOptions();
validProperties.put("k1", "v1");

// test invalid options
assertThatThrownBy(() -> createTableSource(schema, validProperties))
.isInstanceOf(ValidationException.class)
.hasMessageContaining("Unsupported options:\n" + "\n" + "k1");
// test create table source with custom properties is ok
createTableSource(schema, validProperties);

// test scan startup mode options
Map<String, String> scanModeProperties = getBasicOptions();
Expand Down Expand Up @@ -178,6 +176,10 @@ void testSink() {
List<String> bucketKeys = tableSink.getBucketKeys();
assertThat(bucketKeys)
.isEqualTo(Arrays.asList(properties.get(BUCKET_KEY.key()).split(",")));

// test create table sink with custom properties is ok
properties.put("k1", "v1");
createTableSink(schema, properties);
}

private ResolvedSchema createBasicSchema() {
Expand Down