org.apache.flink.table.delegation.Parser Maven / Gradle / Ivy
Show all versions of flink-table-api-java Show documentation
/*
* 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.delegation;
import org.apache.flink.annotation.Internal;
import org.apache.flink.table.catalog.UnresolvedIdentifier;
import org.apache.flink.table.operations.Operation;
import org.apache.flink.table.operations.QueryOperation;
import java.util.List;
/**
* Provides methods for parsing SQL objects from a SQL string.
*/
@Internal
public interface Parser {
/**
* Entry point for parsing SQL queries expressed as a String.
*
* Note:If the created {@link Operation} is a {@link QueryOperation}
* it must be in a form that will be understood by the
* {@link Planner#translate(List)} method.
*
*
The produced Operation trees should already be validated.
*
* @param statement the SQL statement to evaluate
* @return parsed queries as trees of relational {@link Operation}s
* @throws org.apache.flink.table.api.SqlParserException when failed to parse the statement
*/
List parse(String statement);
/**
* Entry point for parsing SQL identifiers expressed as a String.
*
* @param identifier the SQL identifier to parse
* @return parsed identifier
* @throws org.apache.flink.table.api.SqlParserException when failed to parse the identifier
*/
UnresolvedIdentifier parseIdentifier(String identifier);
}