org.apache.flink.table.planner.delegation.BlinkPlannerFactory Maven / Gradle / Ivy

/*
 * 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.delegation;

import org.apache.flink.annotation.Internal;
import org.apache.flink.table.api.EnvironmentSettings;
import org.apache.flink.table.api.TableConfig;
import org.apache.flink.table.catalog.CatalogManager;
import org.apache.flink.table.catalog.FunctionCatalog;
import org.apache.flink.table.delegation.Executor;
import org.apache.flink.table.delegation.Planner;
import org.apache.flink.table.delegation.PlannerFactory;
import org.apache.flink.table.descriptors.DescriptorProperties;

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

/** Factory to construct a {@link BatchPlanner} or {@link StreamPlanner}. */
@Internal
public final class BlinkPlannerFactory implements PlannerFactory {

    @Override
    public Planner create(
            Map properties,
            Executor executor,
            TableConfig tableConfig,
            FunctionCatalog functionCatalog,
            CatalogManager catalogManager) {
        if (Boolean.valueOf(properties.getOrDefault(EnvironmentSettings.STREAMING_MODE, "true"))) {
            return new StreamPlanner(executor, tableConfig, functionCatalog, catalogManager);
        } else {
            return new BatchPlanner(executor, tableConfig, functionCatalog, catalogManager);
        }
    }

    @Override
    public Map optionalContext() {
        Map map = new HashMap<>();
        map.put(EnvironmentSettings.CLASS_NAME, this.getClass().getCanonicalName());
        return map;
    }

    @Override
    public Map requiredContext() {
        DescriptorProperties properties = new DescriptorProperties();
        return properties.asMap();
    }

    @Override
    public List supportedProperties() {
        return Arrays.asList(EnvironmentSettings.STREAMING_MODE, EnvironmentSettings.CLASS_NAME);
    }
}