com.facebook.presto.jdbc.internal.spi.analyzer.QueryPreparer Maven / Gradle / Ivy

Go to download
/*
 * Licensed 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 com.facebook.presto.jdbc.internal.spi.analyzer;

import com.facebook.presto.jdbc.internal.common.analyzer.PreparedQuery;
import com.facebook.presto.jdbc.internal.spi.WarningCollector;

import java.util.Map;

/**
 * QueryPreparer interface should be implemented by the analyzer to provide prepare query related functionality.
 */
public interface QueryPreparer
{
    /**
     * This method should do the necessary work required to prepare the query and return the preparedQuery object.
     * @param analyzerOptions various analyzer options required to parse and analyze the query
     * @param query query string which needs to be prepared
     * @param preparedStatements existing prepared query statements
     * @param warningCollector Warning collector to collect various warnings
     * @return prepared query object
     */
    PreparedQuery prepareQuery(AnalyzerOptions analyzerOptions, String query, Map preparedStatements, WarningCollector warningCollector);
}