org.apache.flink.table.planner.plan.nodes.exec.spec.DynamicTableSourceSpec Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flink-table-planner-blink_2.11 Show documentation
This module bridges Table/SQL API and runtime. It contains all resources that are required during pre-flight and runtime phase. The content of this module is work-in-progress. It will replace flink-table-planner once it is stable. See FLINK-11439 and FLIP-32 for more details.
There is a newer version: 1.13.6
Show newest version
/*
 * 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.nodes.exec.spec;

import org.apache.flink.table.api.TableException;
import org.apache.flink.table.catalog.ObjectIdentifier;
import org.apache.flink.table.catalog.ResolvedCatalogTable;
import org.apache.flink.table.connector.source.DynamicTableSource;
import org.apache.flink.table.connector.source.LookupTableSource;
import org.apache.flink.table.connector.source.ScanTableSource;
import org.apache.flink.table.factories.FactoryUtil;
import org.apache.flink.table.planner.delegation.PlannerBase;
import org.apache.flink.table.planner.plan.abilities.source.SourceAbilityContext;
import org.apache.flink.table.planner.plan.abilities.source.SourceAbilitySpec;
import org.apache.flink.table.types.logical.RowType;

import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonCreator;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonIgnore;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonInclude;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonProperty;

import javax.annotation.Nullable;

import java.util.List;

import static org.apache.flink.util.Preconditions.checkNotNull;

/**
 * {@link DynamicTableSourceSpec} describes how to serialize/deserialize dynamic table source table
 * and create {@link DynamicTableSource} from the deserialization result.
 */
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonInclude(JsonInclude.Include.NON_EMPTY)
public class DynamicTableSourceSpec extends CatalogTableSpecBase {

    public static final String FIELD_NAME_SOURCE_ABILITY_SPECS = "sourceAbilitySpecs";

    @JsonIgnore private DynamicTableSource tableSource;

    @JsonProperty(FIELD_NAME_SOURCE_ABILITY_SPECS)
    private final @Nullable List sourceAbilitySpecs;

    @JsonCreator
    public DynamicTableSourceSpec(
            @JsonProperty(FIELD_NAME_IDENTIFIER) ObjectIdentifier objectIdentifier,
            @JsonProperty(FIELD_NAME_CATALOG_TABLE) ResolvedCatalogTable catalogTable,
            @Nullable @JsonProperty(FIELD_NAME_SOURCE_ABILITY_SPECS)
                    List sourceAbilitySpecs) {
        super(objectIdentifier, catalogTable);
        this.sourceAbilitySpecs = sourceAbilitySpecs;
    }

    @JsonIgnore
    private DynamicTableSource getTableSource(PlannerBase planner) {
        checkNotNull(configuration);
        if (tableSource == null) {
            tableSource =
                    FactoryUtil.createTableSource(
                            null, // catalog, TODO support create Factory from catalog
                            objectIdentifier,
                            catalogTable,
                            configuration,
                            classLoader,
                            // isTemporary, it's always true since the catalog is always null now.
                            true);

            if (sourceAbilitySpecs != null) {
                RowType newProducedType =
                        (RowType)
                                catalogTable
                                        .getResolvedSchema()
                                        .toSourceRowDataType()
                                        .getLogicalType();
                for (SourceAbilitySpec spec : sourceAbilitySpecs) {
                    SourceAbilityContext context =
                            new SourceAbilityContext(planner.getFlinkContext(), newProducedType);
                    spec.apply(tableSource, context);
                    if (spec.getProducedType().isPresent()) {
                        newProducedType = spec.getProducedType().get();
                    }
                }
            }
        }
        return tableSource;
    }

    @JsonIgnore
    public ScanTableSource getScanTableSource(PlannerBase planner) {
        DynamicTableSource tableSource = getTableSource(planner);
        if (tableSource instanceof ScanTableSource) {
            return (ScanTableSource) tableSource;
        } else {
            throw new TableException(
                    String.format(
                            "%s is not a ScanTableSource.\nplease check it.",
                            tableSource.getClass().getName()));
        }
    }

    @JsonIgnore
    public LookupTableSource getLookupTableSource(PlannerBase planner) {
        DynamicTableSource tableSource = getTableSource(planner);
        if (tableSource instanceof LookupTableSource) {
            return (LookupTableSource) tableSource;
        } else {
            throw new TableException(
                    String.format(
                            "%s is not a LookupTableSource.\nplease check it.",
                            tableSource.getClass().getName()));
        }
    }

    public void setTableSource(DynamicTableSource tableSource) {
        this.tableSource = tableSource;
    }

    @JsonIgnore
    @Nullable
    public List getSourceAbilitySpecs() {
        return sourceAbilitySpecs;
    }
}