io.trino.execution.QueryExecution Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of trino-main Show documentation
Trino - Engine
There is a newer version: 465
/*
 * 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 io.trino.execution;

import com.google.common.collect.ImmutableList;
import com.google.common.util.concurrent.ListenableFuture;
import io.airlift.units.DataSize;
import io.airlift.units.Duration;
import io.trino.exchange.ExchangeInput;
import io.trino.execution.QueryPreparer.PreparedQuery;
import io.trino.execution.QueryTracker.TrackedQuery;
import io.trino.execution.StateMachine.StateChangeListener;
import io.trino.execution.querystats.PlanOptimizersStatsCollector;
import io.trino.execution.warnings.WarningCollector;
import io.trino.server.BasicQueryInfo;
import io.trino.server.ResultQueryInfo;
import io.trino.server.protocol.Slug;
import io.trino.spi.type.Type;
import io.trino.sql.planner.Plan;

import java.util.List;
import java.util.Optional;
import java.util.Queue;
import java.util.function.Consumer;

import static java.util.Objects.requireNonNull;

public interface QueryExecution
        extends TrackedQuery
{
    QueryState getState();

    ListenableFuture getStateChange(QueryState currentState);

    void addStateChangeListener(StateChangeListener stateChangeListener);

    void setOutputInfoListener(Consumer listener);

    void outputTaskFailed(TaskId taskId, Throwable failure);

    void resultsConsumed();

    Optional getQueryPlan();

    BasicQueryInfo getBasicQueryInfo();

    QueryInfo getQueryInfo();

    ResultQueryInfo getResultQueryInfo();

    Slug getSlug();

    Duration getTotalCpuTime();

    DataSize getUserMemoryReservation();

    DataSize getTotalMemoryReservation();

    void start();

    void cancelQuery();

    void cancelStage(StageId stageId);

    void failTask(TaskId taskId, Exception reason);

    void recordHeartbeat();

    boolean shouldWaitForMinWorkers();

    /**
     * Add a listener for the final query info.  This notification is guaranteed to be fired only once.
     * Listener is always notified asynchronously using a dedicated notification thread pool so, care should
     * be taken to avoid leaking {@code this} when adding a listener in a constructor.
     */
    void addFinalQueryInfoListener(StateChangeListener stateChangeListener);

    interface QueryExecutionFactory
    {
        T createQueryExecution(PreparedQuery preparedQuery, QueryStateMachine stateMachine, Slug slug, WarningCollector warningCollector, PlanOptimizersStatsCollector planOptimizersStatsCollector);
    }

    /**
     * The info will always contain column names and types.
     * The {@code inputsQueue} is shared between {@link QueryOutputInfo} instances.
     * It is guaranteed that no new entries will be added to {@code inputsQueue} after {@link QueryOutputInfo}
     * with {@link #isNoMoreInputs()} {@code == true} is created.
     */
    class QueryOutputInfo
    {
        private final List columnNames;
        private final List columnTypes;
        private final Queue inputsQueue;
        private final boolean noMoreInputs;

        public QueryOutputInfo(List columnNames, List columnTypes, Queue inputsQueue, boolean noMoreInputs)
        {
            this.columnNames = ImmutableList.copyOf(requireNonNull(columnNames, "columnNames is null"));
            this.columnTypes = ImmutableList.copyOf(requireNonNull(columnTypes, "columnTypes is null"));
            this.inputsQueue = requireNonNull(inputsQueue, "inputsQueue is null");
            this.noMoreInputs = noMoreInputs;
        }

        public List getColumnNames()
        {
            return columnNames;
        }

        public List getColumnTypes()
        {
            return columnTypes;
        }

        public void drainInputs(Consumer consumer)
        {
            while (true) {
                ExchangeInput input = inputsQueue.poll();
                if (input == null) {
                    break;
                }
                consumer.accept(input);
            }
        }

        public boolean isNoMoreInputs()
        {
            return noMoreInputs;
        }
    }
}