lbug 0.16.1

An in-process property graph database management system built for query speed and scalability
Documentation
#pragma once

#include <cstdint>

#include "common/api.h"

namespace lbug {
namespace common {
enum class StatementType : uint8_t;
}

namespace main {

/**
 * @brief PreparedSummary stores the compiling time and query options of a query.
 */
struct PreparedSummary { // NOLINT(*-pro-type-member-init)
    double compilingTime = 0;
    common::StatementType statementType;
};

/**
 * @brief QuerySummary stores the execution time, plan, compiling time and query options of a query.
 */
class QuerySummary {

public:
    QuerySummary() = default;
    explicit QuerySummary(const PreparedSummary& preparedSummary)
        : preparedSummary{preparedSummary} {}
    /**
     * @return query compiling time in milliseconds.
     */
    LBUG_API double getCompilingTime() const;
    /**
     * @return query execution time in milliseconds.
     */
    LBUG_API double getExecutionTime() const;

    void setExecutionTime(double time);

    void incrementCompilingTime(double increment);

    void incrementExecutionTime(double increment);

    /**
     * @return true if the query is executed with EXPLAIN.
     */
    bool isExplain() const;

    /**
     * @return the statement type of the query.
     */
    common::StatementType getStatementType() const;

private:
    double executionTime = 0;
    PreparedSummary preparedSummary;
};

} // namespace main
} // namespace lbug