ShowQueryProfileStmt.java

// 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.doris.analysis;

import org.apache.doris.catalog.Column;
import org.apache.doris.catalog.ScalarType;
import org.apache.doris.common.profile.SummaryProfile;
import org.apache.doris.qe.ShowResultSetMetaData;

import com.google.common.base.Strings;


// For stmt like:
// show query profile "/";   # list all saving query ids
public class ShowQueryProfileStmt extends ShowStmt implements NotFallbackInParser {
    // This should be same as ProfileManager.PROFILE_HEADERS
    public static final ShowResultSetMetaData META_DATA_QUERY_IDS;
    private static final long DefaultLimit = 20;

    static {
        ShowResultSetMetaData.Builder builder = ShowResultSetMetaData.builder();
        for (String key : SummaryProfile.SUMMARY_KEYS) {
            if (key.equals(SummaryProfile.DISTRIBUTED_PLAN)) {
                continue;
            }
            builder.addColumn(new Column(key, ScalarType.createStringType()));
        }
        META_DATA_QUERY_IDS = builder.build();
    }

    public ShowQueryProfileStmt(String useless, LimitElement limit) {
        this.path = useless;
        this.limitElement = limit;
    }

    private final String path;
    private final LimitElement limitElement;

    @Override
    public String toSql() {
        StringBuilder sb = new StringBuilder();
        sb.append("SHOW QUERY PROFILE");
        if (!Strings.isNullOrEmpty(path)) {
            sb.append(" ");
            sb.append(path);
        }

        if (limitElement != null && limitElement.getLimit() != -1) {
            sb.append(" LIMIT ").append(getLimit());
        }

        return sb.toString();
    }

    @Override
    public String toString() {
        return toSql();
    }

    @Override
    public ShowResultSetMetaData getMetaData() {
        return META_DATA_QUERY_IDS;
    }

    public long getLimit() {
        if (limitElement == null) {
            return DefaultLimit;
        } else {
            return limitElement.getLimit() == -1 ? DefaultLimit : limitElement.getLimit();
        }
    }
}