io.trino.execution.QueryInfo 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.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.errorprone.annotations.Immutable;
import io.trino.SessionRepresentation;
import io.trino.client.NodeVersion;
import io.trino.operator.RetryPolicy;
import io.trino.spi.ErrorCode;
import io.trino.spi.ErrorType;
import io.trino.spi.QueryId;
import io.trino.spi.TrinoWarning;
import io.trino.spi.eventlistener.RoutineInfo;
import io.trino.spi.eventlistener.TableInfo;
import io.trino.spi.resourcegroups.QueryType;
import io.trino.spi.resourcegroups.ResourceGroupId;
import io.trino.spi.security.SelectedRole;
import io.trino.sql.analyzer.Output;
import io.trino.transaction.TransactionId;
import jakarta.annotation.Nullable;

import java.net.URI;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.OptionalDouble;
import java.util.Set;

import static com.google.common.base.MoreObjects.toStringHelper;
import static com.google.common.base.Preconditions.checkArgument;
import static java.util.Objects.requireNonNull;

@Immutable
public class QueryInfo
{
    private final QueryId queryId;
    private final SessionRepresentation session;
    private final QueryState state;
    private final URI self;
    private final List fieldNames;
    private final String query;
    private final Optional preparedQuery;
    private final QueryStats queryStats;
    private final Optional setCatalog;
    private final Optional setSchema;
    private final Optional setPath;
    private final Optional setAuthorizationUser;
    private final boolean resetAuthorizationUser;
    private final Map setSessionProperties;
    private final Set resetSessionProperties;
    private final Map setRoles;
    private final Map addedPreparedStatements;
    private final Set deallocatedPreparedStatements;
    private final Optional startedTransactionId;
    private final boolean clearTransactionId;
    private final String updateType;
    private final Optional outputStage;
    private final List referencedTables;
    private final List routines;
    private final ExecutionFailureInfo failureInfo;
    private final ErrorType errorType;
    private final ErrorCode errorCode;
    private final List warnings;
    private final Set inputs;
    private final Optional output;
    private final boolean finalQueryInfo;
    private final Optional resourceGroupId;
    private final Optional queryType;
    private final RetryPolicy retryPolicy;
    private final boolean pruned;
    private final NodeVersion version;

    @JsonCreator
    public QueryInfo(
            @JsonProperty("queryId") QueryId queryId,
            @JsonProperty("session") SessionRepresentation session,
            @JsonProperty("state") QueryState state,
            @JsonProperty("self") URI self,
            @JsonProperty("fieldNames") List fieldNames,
            @JsonProperty("query") String query,
            @JsonProperty("preparedQuery") Optional preparedQuery,
            @JsonProperty("queryStats") QueryStats queryStats,
            @JsonProperty("setCatalog") Optional setCatalog,
            @JsonProperty("setSchema") Optional setSchema,
            @JsonProperty("setPath") Optional setPath,
            @JsonProperty("setAuthorizationUser") Optional setAuthorizationUser,
            @JsonProperty("resetAuthorizationUser") boolean resetAuthorizationUser,
            @JsonProperty("setSessionProperties") Map setSessionProperties,
            @JsonProperty("resetSessionProperties") Set resetSessionProperties,
            @JsonProperty("setRoles") Map setRoles,
            @JsonProperty("addedPreparedStatements") Map addedPreparedStatements,
            @JsonProperty("deallocatedPreparedStatements") Set deallocatedPreparedStatements,
            @JsonProperty("startedTransactionId") Optional startedTransactionId,
            @JsonProperty("clearTransactionId") boolean clearTransactionId,
            @JsonProperty("updateType") String updateType,
            @JsonProperty("outputStage") Optional outputStage,
            @JsonProperty("failureInfo") ExecutionFailureInfo failureInfo,
            @JsonProperty("errorCode") ErrorCode errorCode,
            @JsonProperty("warnings") List warnings,
            @JsonProperty("inputs") Set inputs,
            @JsonProperty("output") Optional output,
            @JsonProperty("referencedTables") List referencedTables,
            @JsonProperty("routines") List routines,
            @JsonProperty("finalQueryInfo") boolean finalQueryInfo,
            @JsonProperty("resourceGroupId") Optional resourceGroupId,
            @JsonProperty("queryType") Optional queryType,
            @JsonProperty("retryPolicy") RetryPolicy retryPolicy,
            @JsonProperty("pruned") boolean pruned,
            @JsonProperty("version") NodeVersion version)
    {
        requireNonNull(queryId, "queryId is null");
        requireNonNull(session, "session is null");
        requireNonNull(state, "state is null");
        requireNonNull(self, "self is null");
        requireNonNull(fieldNames, "fieldNames is null");
        requireNonNull(queryStats, "queryStats is null");
        requireNonNull(setCatalog, "setCatalog is null");
        requireNonNull(setSchema, "setSchema is null");
        requireNonNull(setPath, "setPath is null");
        requireNonNull(setAuthorizationUser, "setAuthorizationUser is null");
        requireNonNull(setSessionProperties, "setSessionProperties is null");
        requireNonNull(resetSessionProperties, "resetSessionProperties is null");
        requireNonNull(addedPreparedStatements, "addedPreparedStatements is null");
        requireNonNull(deallocatedPreparedStatements, "deallocatedPreparedStatements is null");
        requireNonNull(startedTransactionId, "startedTransactionId is null");
        requireNonNull(query, "query is null");
        requireNonNull(preparedQuery, "preparedQuery is null");
        requireNonNull(outputStage, "outputStage is null");
        requireNonNull(inputs, "inputs is null");
        requireNonNull(output, "output is null");
        requireNonNull(referencedTables, "referencedTables is null");
        requireNonNull(routines, "routines is null");
        requireNonNull(resourceGroupId, "resourceGroupId is null");
        requireNonNull(warnings, "warnings is null");
        requireNonNull(queryType, "queryType is null");
        requireNonNull(retryPolicy, "retryPolicy is null");
        requireNonNull(version, "version is null");

        this.queryId = queryId;
        this.session = session;
        this.state = state;
        this.self = self;
        this.fieldNames = ImmutableList.copyOf(fieldNames);
        this.query = query;
        this.preparedQuery = preparedQuery;
        this.queryStats = queryStats;
        this.setCatalog = setCatalog;
        this.setSchema = setSchema;
        this.setPath = setPath;
        this.setAuthorizationUser = setAuthorizationUser;
        this.resetAuthorizationUser = resetAuthorizationUser;
        this.setSessionProperties = ImmutableMap.copyOf(setSessionProperties);
        this.resetSessionProperties = ImmutableSet.copyOf(resetSessionProperties);
        this.setRoles = ImmutableMap.copyOf(setRoles);
        this.addedPreparedStatements = ImmutableMap.copyOf(addedPreparedStatements);
        this.deallocatedPreparedStatements = ImmutableSet.copyOf(deallocatedPreparedStatements);
        this.startedTransactionId = startedTransactionId;
        this.clearTransactionId = clearTransactionId;
        this.updateType = updateType;
        this.outputStage = outputStage;
        this.failureInfo = failureInfo;
        this.errorType = errorCode == null ? null : errorCode.getType();
        this.errorCode = errorCode;
        this.warnings = ImmutableList.copyOf(warnings);
        this.inputs = ImmutableSet.copyOf(inputs);
        this.output = output;
        this.referencedTables = ImmutableList.copyOf(referencedTables);
        this.routines = ImmutableList.copyOf(routines);
        this.finalQueryInfo = finalQueryInfo;
        checkArgument(!finalQueryInfo || state.isDone(), "finalQueryInfo without a terminal query state");
        this.resourceGroupId = resourceGroupId;
        this.queryType = queryType;
        this.retryPolicy = retryPolicy;
        this.pruned = pruned;
        this.version = version;
    }

    @JsonProperty
    public QueryId getQueryId()
    {
        return queryId;
    }

    @JsonProperty
    public SessionRepresentation getSession()
    {
        return session;
    }

    @JsonProperty
    public QueryState getState()
    {
        return state;
    }

    @JsonProperty
    public boolean isScheduled()
    {
        return queryStats.isScheduled();
    }

    @JsonProperty
    public OptionalDouble getProgressPercentage()
    {
        return queryStats.getProgressPercentage();
    }

    @JsonProperty
    public OptionalDouble getRunningPercentage()
    {
        return queryStats.getRunningPercentage();
    }

    @JsonProperty
    public URI getSelf()
    {
        return self;
    }

    @JsonProperty
    public List getFieldNames()
    {
        return fieldNames;
    }

    @JsonProperty
    public String getQuery()
    {
        return query;
    }

    @JsonProperty
    public Optional getPreparedQuery()
    {
        return preparedQuery;
    }

    @JsonProperty
    public QueryStats getQueryStats()
    {
        return queryStats;
    }

    @JsonProperty
    public Optional getSetCatalog()
    {
        return setCatalog;
    }

    @JsonProperty
    public Optional getSetSchema()
    {
        return setSchema;
    }

    @JsonProperty
    public Optional getSetPath()
    {
        return setPath;
    }

    @JsonProperty
    public Optional getSetAuthorizationUser()
    {
        return setAuthorizationUser;
    }

    @JsonProperty
    public boolean isResetAuthorizationUser()
    {
        return resetAuthorizationUser;
    }

    @JsonProperty
    public Map getSetSessionProperties()
    {
        return setSessionProperties;
    }

    @JsonProperty
    public Set getResetSessionProperties()
    {
        return resetSessionProperties;
    }

    @JsonProperty
    public Map getSetRoles()
    {
        return setRoles;
    }

    @JsonProperty
    public Map getAddedPreparedStatements()
    {
        return addedPreparedStatements;
    }

    @JsonProperty
    public Set getDeallocatedPreparedStatements()
    {
        return deallocatedPreparedStatements;
    }

    @JsonProperty
    public Optional getStartedTransactionId()
    {
        return startedTransactionId;
    }

    @JsonProperty
    public boolean isClearTransactionId()
    {
        return clearTransactionId;
    }

    @Nullable
    @JsonProperty
    public String getUpdateType()
    {
        return updateType;
    }

    @JsonProperty
    public Optional getOutputStage()
    {
        return outputStage;
    }

    @Nullable
    @JsonProperty
    public ExecutionFailureInfo getFailureInfo()
    {
        return failureInfo;
    }

    @Nullable
    @JsonProperty
    public ErrorType getErrorType()
    {
        return errorType;
    }

    @Nullable
    @JsonProperty
    public ErrorCode getErrorCode()
    {
        return errorCode;
    }

    @JsonProperty
    public List getWarnings()
    {
        return warnings;
    }

    @JsonProperty
    public boolean isFinalQueryInfo()
    {
        return finalQueryInfo;
    }

    @JsonProperty
    public Set getInputs()
    {
        return inputs;
    }

    @JsonProperty
    public Optional getOutput()
    {
        return output;
    }

    @JsonProperty
    public List getReferencedTables()
    {
        return referencedTables;
    }

    @JsonProperty
    public List getRoutines()
    {
        return routines;
    }

    @JsonProperty
    public Optional getResourceGroupId()
    {
        return resourceGroupId;
    }

    @JsonProperty
    public Optional getQueryType()
    {
        return queryType;
    }

    @JsonProperty
    public RetryPolicy getRetryPolicy()
    {
        return retryPolicy;
    }

    @JsonProperty
    public boolean isPruned()
    {
        return pruned;
    }

    @JsonProperty
    public NodeVersion getVersion()
    {
        return version;
    }

    @Override
    public String toString()
    {
        return toStringHelper(this)
                .add("queryId", queryId)
                .add("state", state)
                .add("fieldNames", fieldNames)
                .toString();
    }
}