io.trino.execution.QueryManager Maven / Gradle / Ivy
/*
* 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.util.concurrent.ListenableFuture;
import io.trino.Session;
import io.trino.execution.StateMachine.StateChangeListener;
import io.trino.server.BasicQueryInfo;
import io.trino.server.ResultQueryInfo;
import io.trino.server.protocol.Slug;
import io.trino.spi.QueryId;
import java.util.List;
import java.util.NoSuchElementException;
import java.util.function.Consumer;
public interface QueryManager
{
List getQueries();
/**
* Add a listener that fires once the query output locations are known.
*
* @throws NoSuchElementException if query does not exist
*/
void setOutputInfoListener(QueryId queryId, Consumer listener)
throws NoSuchElementException;
/**
* Notify that one of the output tasks failed for a given query
*/
void outputTaskFailed(TaskId taskId, Throwable failure);
/**
* Notify that the query results for a query have been fully consumed by the client
*/
void resultsConsumed(QueryId queryId);
/**
* Add a listener that fires each time the query state changes.
* 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. Additionally, it is
* possible notifications are observed out of order due to the asynchronous execution.
*
* @throws NoSuchElementException if query does not exist
*/
void addStateChangeListener(QueryId queryId, StateChangeListener listener)
throws NoSuchElementException;
/**
* Gets a future that completes when the query changes from the specified current state
* or immediately if the query is already in a final state. If the query does not exist,
* the future will contain a {@link NoSuchElementException}
*/
ListenableFuture getStateChange(QueryId queryId, QueryState currentState);
/**
* @throws NoSuchElementException if query does not exist
*/
BasicQueryInfo getQueryInfo(QueryId queryId)
throws NoSuchElementException;
/**
* @throws NoSuchElementException if query does not exist
*/
QueryInfo getFullQueryInfo(QueryId queryId)
throws NoSuchElementException;
/**
* @throws NoSuchElementException if query does not exist
*/
ResultQueryInfo getResultQueryInfo(QueryId queryId)
throws NoSuchElementException;
/**
* @throws NoSuchElementException if query does not exist
*/
Session getQuerySession(QueryId queryId);
/**
* @throws NoSuchElementException if query does not exist
*/
Slug getQuerySlug(QueryId queryId);
/**
* @throws NoSuchElementException if query does not exist
*/
QueryState getQueryState(QueryId queryId)
throws NoSuchElementException;
boolean hasQuery(QueryId queryId);
/**
* Updates the client heartbeat time, to prevent the query from be automatically purged.
* If the query does not exist, the call is ignored.
*/
void recordHeartbeat(QueryId queryId);
/**
* Creates a new query using the specified query execution.
*/
void createQuery(QueryExecution execution);
/**
* Attempts to fail the query for the specified reason. If the query is already in a final
* state, the call is ignored. If the query does not exist, the call is ignored.
*/
void failQuery(QueryId queryId, Throwable cause);
/**
* Attempts to fail the query due to a user cancellation. If the query is already in a final
* state, the call is ignored. If the query does not exist, the call is ignored.
*/
void cancelQuery(QueryId queryId);
/**
* Attempts to cancel the stage and continue the query. If the stage is already in a final
* state, the call is ignored. If the query does not exist, the call is ignored.
*/
void cancelStage(StageId stageId);
}