Skip to content

Commit

Permalink
[FLINK-26805][table] Managed table breaks legacy connector without 'c…
Browse files Browse the repository at this point in the history
…onnector.type'

This closes apache#19209
  • Loading branch information
JingsongLi authored Mar 24, 2022
1 parent 103fae9 commit 7d7a111
Show file tree
Hide file tree
Showing 7 changed files with 238 additions and 48 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,14 @@

import org.apache.flink.annotation.Internal;
import org.apache.flink.api.common.RuntimeExecutionMode;
import org.apache.flink.configuration.Configuration;
import org.apache.flink.configuration.ExecutionOptions;
import org.apache.flink.configuration.ReadableConfig;
import org.apache.flink.table.api.TableException;
import org.apache.flink.table.api.ValidationException;
import org.apache.flink.table.descriptors.ConnectorDescriptorValidator;
import org.apache.flink.table.factories.DynamicTableFactory;
import org.apache.flink.table.factories.FactoryUtil;
import org.apache.flink.table.factories.TableFactoryUtil;
import org.apache.flink.util.StringUtils;

import javax.annotation.Nullable;
Expand Down Expand Up @@ -110,7 +111,8 @@ public static boolean isManagedTable(@Nullable Catalog catalog, CatalogBaseTable
return false;
}

if (table.getTableKind() == CatalogBaseTable.TableKind.VIEW) {
if (table.getTableKind() != CatalogBaseTable.TableKind.TABLE
|| !(table instanceof CatalogTable)) {
// view is not managed table
return false;
}
Expand All @@ -123,8 +125,14 @@ public static boolean isManagedTable(@Nullable Catalog catalog, CatalogBaseTable
return false;
}

if (!StringUtils.isNullOrWhitespaceOnly(
options.get(ConnectorDescriptorValidator.CONNECTOR_TYPE))) {
// check legacy connector, here we need to check the factory, other properties are dummy
if (TableFactoryUtil.isLegacyConnectorOptions(
catalog,
new Configuration(),
true,
ObjectIdentifier.of("dummy_catalog", "dummy_database", "dummy_table"),
(CatalogTable) table,
true)) {
// legacy connector is not managed table
return false;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
import org.apache.flink.table.catalog.Catalog;
import org.apache.flink.table.catalog.CatalogTable;
import org.apache.flink.table.catalog.ObjectIdentifier;
import org.apache.flink.table.descriptors.ConnectorDescriptorValidator;
import org.apache.flink.table.descriptors.DescriptorProperties;
import org.apache.flink.table.sinks.TableSink;
import org.apache.flink.table.sources.TableSource;

Expand Down Expand Up @@ -129,4 +131,37 @@ public static Optional<TableSink> createTableSinkForCatalogTable(
}
return Optional.empty();
}

/** Checks whether the {@link CatalogTable} uses legacy connector sink options. */
public static boolean isLegacyConnectorOptions(
@Nullable Catalog catalog,
ReadableConfig configuration,
boolean isStreamingMode,
ObjectIdentifier objectIdentifier,
CatalogTable catalogTable,
boolean isTemporary) {
// normalize option keys
DescriptorProperties properties = new DescriptorProperties(true);
properties.putProperties(catalogTable.getOptions());
if (properties.containsKey(ConnectorDescriptorValidator.CONNECTOR_TYPE)) {
return true;
} else {
try {
// try to create legacy table source using the options,
// some legacy factories may use the 'type' key
TableFactoryUtil.findAndCreateTableSink(
catalog,
objectIdentifier,
catalogTable,
configuration,
isStreamingMode,
isTemporary);
// success, then we will use the legacy factories
return true;
} catch (Throwable ignore) {
// fail, then we will use new factories
return false;
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,23 @@

package org.apache.flink.table.planner.delegation

import org.apache.calcite.jdbc.CalciteSchemaBuilder.asRootSchema
import org.apache.calcite.plan.{RelTrait, RelTraitDef}
import org.apache.calcite.rel.RelNode
import org.apache.calcite.rel.hint.RelHint
import org.apache.calcite.rel.logical.LogicalTableModify
import org.apache.calcite.tools.FrameworkConfig
import org.apache.flink.annotation.VisibleForTesting
import org.apache.flink.api.dag.Transformation
import org.apache.flink.configuration.ReadableConfig
import org.apache.flink.streaming.api.environment.StreamExecutionEnvironment
import org.apache.flink.streaming.api.graph.StreamGraph
import org.apache.flink.table.api._
import org.apache.flink.table.api.config.{ExecutionConfigOptions, TableConfigOptions}
import org.apache.flink.table.api.config.ExecutionConfigOptions
import org.apache.flink.table.catalog.ManagedTableListener.isManagedTable
import org.apache.flink.table.catalog._
import org.apache.flink.table.connector.sink.DynamicTableSink
import org.apache.flink.table.delegation.{Executor, Parser, Planner}
import org.apache.flink.table.descriptors.{ConnectorDescriptorValidator, DescriptorProperties}
import org.apache.flink.table.factories.{DynamicTableSinkFactory, FactoryUtil, TableFactoryUtil}
import org.apache.flink.table.module.{Module, ModuleManager}
import org.apache.flink.table.operations.OutputConversionModifyOperation.UpdateMode
Expand Down Expand Up @@ -59,17 +64,9 @@ import org.apache.flink.table.runtime.generated.CompileUtils
import org.apache.flink.table.sinks.TableSink
import org.apache.flink.table.types.utils.LegacyTypeInfoDataTypeConverter

import org.apache.calcite.jdbc.CalciteSchemaBuilder.asRootSchema
import org.apache.calcite.plan.{RelTrait, RelTraitDef}
import org.apache.calcite.rel.RelNode
import org.apache.calcite.rel.hint.RelHint
import org.apache.calcite.rel.logical.LogicalTableModify
import org.apache.calcite.tools.FrameworkConfig

import java.lang.{Long => JLong}
import java.util
import java.util.{Collections, TimeZone}

import _root_.scala.collection.JavaConversions._
import scala.collection.mutable

Expand Down Expand Up @@ -386,7 +383,13 @@ abstract class PlannerBase(
}

if (!contextResolvedTable.isAnonymous &&
isLegacyConnectorOptions(objectIdentifier, resolvedTable.getOrigin, isTemporary)) {
TableFactoryUtil.isLegacyConnectorOptions(
catalogManager.getCatalog(objectIdentifier.getCatalogName).orElse(null),
tableConfig,
isStreamingMode,
objectIdentifier,
resolvedTable.getOrigin,
isTemporary)) {
val tableSink = TableFactoryUtil.findAndCreateTableSink(
catalog.orNull,
objectIdentifier,
Expand Down Expand Up @@ -423,39 +426,6 @@ abstract class PlannerBase(
}
}

/**
* Checks whether the [[CatalogTable]] uses legacy connector sink options.
*/
private def isLegacyConnectorOptions(
objectIdentifier: ObjectIdentifier,
catalogTable: CatalogTable,
isTemporary: Boolean) = {
// normalize option keys
val properties = new DescriptorProperties(true)
properties.putProperties(catalogTable.getOptions)
if (properties.containsKey(ConnectorDescriptorValidator.CONNECTOR_TYPE)) {
true
} else {
val catalog = catalogManager.getCatalog(objectIdentifier.getCatalogName)
try {
// try to create legacy table source using the options,
// some legacy factories uses the new 'connector' key
TableFactoryUtil.findAndCreateTableSink(
catalog.orElse(null),
objectIdentifier,
catalogTable,
getTableConfig,
isStreamingMode,
isTemporary)
// success, then we will use the legacy factories
true
} catch {
// fail, then we will use new factories
case _: Throwable => false
}
}
}

protected def createSerdeContext: SerdeContext = {
val planner = createFlinkPlanner
new SerdeContext(
Expand Down
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.flink.connector.file.table;

import org.apache.flink.table.api.TableSchema;
import org.apache.flink.table.descriptors.DescriptorProperties;
import org.apache.flink.table.factories.StreamTableSinkFactory;
import org.apache.flink.table.factories.StreamTableSourceFactory;
import org.apache.flink.table.factories.TableFactory;
import org.apache.flink.table.planner.runtime.utils.TestingAppendTableSink;
import org.apache.flink.table.planner.utils.TestTableSource;
import org.apache.flink.table.sinks.StreamTableSink;
import org.apache.flink.table.sources.StreamTableSource;
import org.apache.flink.types.Row;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import static org.apache.flink.table.descriptors.Schema.SCHEMA;

/** A legacy {@link TableFactory} uses user define options. */
public class LegacyTableFactory
implements StreamTableSinkFactory<Row>, StreamTableSourceFactory<Row> {

@Override
public StreamTableSink<Row> createStreamTableSink(Map<String, String> properties) {
DescriptorProperties dp = new DescriptorProperties();
dp.putProperties(properties);
TableSchema tableSchema = dp.getTableSchema(SCHEMA);
StreamTableSink<Row> sink = new TestingAppendTableSink();
return (StreamTableSink)
sink.configure(tableSchema.getFieldNames(), tableSchema.getFieldTypes());
}

@Override
public StreamTableSource<Row> createStreamTableSource(Map<String, String> properties) {
DescriptorProperties dp = new DescriptorProperties();
dp.putProperties(properties);
TableSchema tableSchema = dp.getTableSchema(SCHEMA);
return new TestTableSource(false, tableSchema);
}

@Override
public Map<String, String> requiredContext() {
Map<String, String> options = new HashMap<>();
options.put("type", "legacy");
return options;
}

@Override
public List<String> supportedProperties() {
List<String> properties = new ArrayList<>();
// schema
properties.add(SCHEMA + ".#." + DescriptorProperties.TYPE);
properties.add(SCHEMA + ".#." + DescriptorProperties.DATA_TYPE);
properties.add(SCHEMA + ".#." + DescriptorProperties.NAME);
properties.add(SCHEMA + ".#." + DescriptorProperties.EXPR);
return properties;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/*
* 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.flink.table.planner.plan.stream.sql;

import org.apache.flink.connector.file.table.LegacyTableFactory;
import org.apache.flink.table.planner.utils.JavaStreamTableTestUtil;
import org.apache.flink.table.planner.utils.TableTestBase;

import org.junit.Test;

/** Tests for usages of {@link LegacyTableFactory}. */
public class LegacyTableFactoryTest extends TableTestBase {

private final JavaStreamTableTestUtil util;

public LegacyTableFactoryTest() {
util = javaStreamTestUtil();
util.tableEnv().executeSql("CREATE TABLE T (a INT) WITH ('type'='legacy')");
}

@Test
public void testSelect() {
util.verifyExecPlan("SELECT * FROM T");
}

@Test
public void testInsert() {
util.verifyExecPlanInsert("INSERT INTO T VALUES (1)");
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,4 @@ org.apache.flink.table.planner.utils.TestDataTypeTableSourceWithTimeFactory
org.apache.flink.table.planner.utils.TestStreamTableSourceFactory
org.apache.flink.table.planner.utils.TestFileInputFormatTableSourceFactory
org.apache.flink.table.planner.utils.TestTableSourceWithTimeFactory
org.apache.flink.connector.file.table.LegacyTableFactory
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<?xml version="1.0" ?>
<!--
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.
-->
<Root>
<TestCase name="testInsert">
<Resource name="sql">
<![CDATA[INSERT INTO T VALUES (1)]]>
</Resource>
<Resource name="ast">
<![CDATA[
LogicalLegacySink(name=[`default_catalog`.`default_database`.`T`], fields=[a])
+- LogicalValues(tuples=[[{ 1 }]])
]]>
</Resource>
<Resource name="optimized exec plan">
<![CDATA[
LegacySink(name=[`default_catalog`.`default_database`.`T`], fields=[a])
+- Values(tuples=[[{ 1 }]])
]]>
</Resource>
</TestCase>
<TestCase name="testSelect">
<Resource name="sql">
<![CDATA[SELECT * FROM T]]>
</Resource>
<Resource name="ast">
<![CDATA[
LogicalProject(a=[$0])
+- LogicalTableScan(table=[[default_catalog, default_database, T, source: [TestTableSource(a)]]])
]]>
</Resource>
<Resource name="optimized exec plan">
<![CDATA[
LegacyTableSourceScan(table=[[default_catalog, default_database, T, source: [TestTableSource(a)]]], fields=[a])
]]>
</Resource>
</TestCase>
</Root>

0 comments on commit 7d7a111

Please sign in to comment.