twalthr commented on a change in pull request #8852: [FLINK-12798][table-api][table-planner] Add a proper discover mechanism that will enable switching between Flink & Blink Planner/Executor URL: https://github.com/apache/flink/pull/8852#discussion_r299072171
########## File path: flink-table/flink-table-api-java/src/main/java/org/apache/flink/table/api/EnvironmentSettings.java ########## @@ -0,0 +1,217 @@ +/* + * 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.api; + +import org.apache.flink.annotation.Internal; +import org.apache.flink.annotation.PublicEvolving; +import org.apache.flink.table.delegation.Executor; +import org.apache.flink.table.delegation.Planner; + +import javax.annotation.Nullable; + +import java.util.HashMap; +import java.util.Map; + +/** + * All properties that define and initialize a table environment. Those properties are used only + * during instantiation of a {@link TableEnvironment}. + * + * <p>Example: + * <pre>{@code + * EnvironmentSettings.newInstance() + * .useOldPlanner() + * .inStreamMode() + * .withBuiltInCatalogName("default_catalog") + * .withBuiltInDatabaseName("default_database") + * .build() + * }</pre> + */ +@PublicEvolving +public class EnvironmentSettings { + public static final String BATCH_MODE = "batch-mode"; + public static final String CLASS_NAME = "class-name"; + + /** + * Canonical name of the {@link Planner} class to use. + */ + private final String plannerClass; + + /** + * Canonical name of the {@link Executor} class to use. + */ + private final String executorClass; + + /** + * Specifies the name of the initial catalog to be created when instantiating + * TableEnvironment. + */ + private final String builtInCatalogName; + + /** + * Specifies the name of the default database in the initial catalog to be created when instantiating + * TableEnvironment. + */ + private final String builtInDatabaseName; + + /** + * Determines if the table environment should work in a batch(true) or stream(false) mode. + */ + private final boolean isBatchMode; + + private EnvironmentSettings( + @Nullable String plannerClass, + @Nullable String executorClass, + String builtInCatalogName, + String builtInDatabaseName, + boolean isBatchMode) { + this.plannerClass = plannerClass; + this.executorClass = executorClass; + this.builtInCatalogName = builtInCatalogName; + this.builtInDatabaseName = builtInDatabaseName; + this.isBatchMode = isBatchMode; + } + + /** + * Does not specify the required planner. It will use the components, if those are the only components available on + * the classpath. + */ + public static Builder newInstance() { + return new Builder(); + } + + /** + * Gets the specified name of the initial catalog to be created when instantiating + * a {@link TableEnvironment}. + */ + public String getBuiltInCatalogName() { + return builtInCatalogName; + } + + /** + * Gets the specified name of the default database in the initial catalog to be created when instantiating + * a {@link TableEnvironment}. + */ + public String getBuiltInDatabaseName() { + return builtInDatabaseName; + } + + @Internal + public Map<String, String> toPlannerProperties() { + Map<String, String> properties = new HashMap<>(toCommonProperties()); + if (plannerClass != null) { + properties.put(CLASS_NAME, plannerClass); + } + return properties; + } + + @Internal + public Map<String, String> toExecutorProperties() { + Map<String, String> properties = new HashMap<>(toCommonProperties()); + if (executorClass != null) { + properties.put(CLASS_NAME, executorClass); + } + return properties; + } + + private Map<String, String> toCommonProperties() { + Map<String, String> properties = new HashMap<>(); + properties.put(BATCH_MODE, Boolean.toString(isBatchMode)); + return properties; + } + + /** + * A builder for {@link EnvironmentSettings}. + */ + public static class Builder { + private String plannerClass = null; + private String executorClass = null; + private String builtInCatalogName = "default_catalog"; + private String builtInDatabaseName = "default_database"; + private boolean isBatchMode = false; + + /** + * Sets the old Flink planner as the required module. Review comment: Mentioned what the default behavior is. ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
