flink-libraries/flink-sql-client/src/main/java/org/apache/flink/table/client/gateway/local/result/DynamicResult.java

/*
 * 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.client.gateway.local.result;

import org.apache.flink.table.api.types.DataType;
import org.apache.flink.table.client.gateway.local.ProgramDeployer;
import org.apache.flink.table.sinks.TableSink;

/**
 * A result of a dynamic table program.
 *
 * <p>Note: Make sure to call close() after the result is not needed anymore.
 *
 * @param <C> type of the cluster id to which this result belongs to
 */
public interface DynamicResult<C> extends Result<C> {

	/**
	 * Returns whether this result is materialized such that snapshots can be taken or results
	 * must be retrieved record-wise.
	 */
	boolean isMaterialized();

	/**
	 * Returns the output type as defined by the query.
	 */
	DataType getOutputType();

	/**
	 * Starts the table program using the given deployer and monitors it's execution.
	 */
	void startRetrieval(ProgramDeployer<C> deployer);

	/**
	 * Returns the table sink required by this result type.
	 */
	TableSink<?> getTableSink();

	/**
	 * Closes the retrieval and all involved threads.
	 */
	void close();

}