org.neo4j.cypher.result.QueryProfile Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.cypher.result;

/**
 * Profile of a query execution.
 */
public interface QueryProfile {
    /**
     * Get profile for specific operator.
     *
     * Note: the operator should really be type as an [[org.neo4j.cypher.internal.util.attribution.Id]],
     * but this is not possible because of a bug with scala `AnyVal`s and inheritance.
     *
     * See https://github.com/lampepfl/dotty/issues/1169 for a discussion of the same issue in Dotty.
     *
     * @param operatorId operator id
     */
    OperatorProfile operatorProfile(int operatorId);

    /**
     * The maximum amount of memory that this query held onto while executing.
     */
    long maxAllocatedMemory();

    int numberOfAvailableWorkers();

    int numberOfAvailableProcessors();

    QueryProfile NONE = new QueryProfile() {
        @Override
        public OperatorProfile operatorProfile(int operatorId) {
            return OperatorProfile.NONE;
        }

        @Override
        public long maxAllocatedMemory() {
            return OperatorProfile.NO_DATA;
        }

        @Override
        public int numberOfAvailableWorkers() {
            return (int) OperatorProfile.NO_DATA;
        }

        @Override
        public int numberOfAvailableProcessors() {
            return (int) OperatorProfile.NO_DATA;
        }
    };
}