org.apache.flink.table.planner.connectors.InlineCatalogTable 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.connectors;

import org.apache.flink.annotation.Internal;
import org.apache.flink.streaming.api.datastream.DataStream;
import org.apache.flink.table.api.Schema;
import org.apache.flink.table.api.TableException;
import org.apache.flink.table.api.TableResult;
import org.apache.flink.table.catalog.CatalogBaseTable;
import org.apache.flink.table.catalog.CatalogTable;
import org.apache.flink.table.catalog.ResolvedSchema;

import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Optional;

/**
 * Helper {@link CatalogTable} for representing a table that is backed by some inline connector
 * (i.e. {@link DataStream} or {@link TableResult#collect()}).
 */
@Internal
final class InlineCatalogTable implements CatalogTable {

    private final ResolvedSchema schema;

    InlineCatalogTable(ResolvedSchema schema) {
        this.schema = schema;
    }

    @Override
    public Schema getUnresolvedSchema() {
        return Schema.newBuilder().fromResolvedSchema(schema).build();
    }

    @Override
    public Map getOptions() {
        throw new TableException(
                "A catalog table that is backed by a DataStream or used for TableResult.collect() "
                        + "cannot be expressed with options and can thus also not be persisted.");
    }

    @Override
    public String getComment() {
        return "Inline catalog table";
    }

    @Override
    public CatalogBaseTable copy() {
        return new InlineCatalogTable(schema);
    }

    @Override
    public Optional getDescription() {
        return Optional.of(getComment());
    }

    @Override
    public Optional getDetailedDescription() {
        return Optional.empty();
    }

    @Override
    public boolean isPartitioned() {
        return false;
    }

    @Override
    public List getPartitionKeys() {
        return Collections.emptyList();
    }

    @Override
    public CatalogTable copy(Map options) {
        throw new TableException(
                "A catalog table that is backed by a DataStream or used for TableResult.collect() "
                        + "cannot be expressed with options and can thus also not be enriched "
                        + "with hints.");
    }
}