74 lines
2.6 KiB
C++
74 lines
2.6 KiB
C++
/* Copyright (c) 2011, 2024, Oracle and/or its affiliates.
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License, version 2.0,
|
|
as published by the Free Software Foundation.
|
|
|
|
This program is designed to work with certain software (including
|
|
but not limited to OpenSSL) that is licensed under separate terms,
|
|
as designated in a particular file or component or in included license
|
|
documentation. The authors of MySQL hereby grant you an additional
|
|
permission to link the program and your derivative works with the
|
|
separately licensed software that they have either included with
|
|
the program or referenced in the documentation.
|
|
|
|
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, version 2.0, for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, write to the Free Software
|
|
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
|
|
|
|
#ifndef OPT_EXPLAIN_FORMAT_JSON_INCLUDED
|
|
#define OPT_EXPLAIN_FORMAT_JSON_INCLUDED
|
|
|
|
#include "sql/opt_explain_format.h"
|
|
#include "sql/parse_tree_node_base.h"
|
|
|
|
class Query_result;
|
|
class Query_expression;
|
|
|
|
namespace opt_explain_json_namespace {
|
|
class context;
|
|
}
|
|
|
|
/**
|
|
Formatter class for EXPLAIN FORMAT=JSON output
|
|
*/
|
|
|
|
class Explain_format_JSON : public Explain_format {
|
|
public:
|
|
enum class FormatVersion { kLinear, kIteratorBased };
|
|
|
|
Explain_format_JSON(
|
|
FormatVersion version,
|
|
std::optional<std::string_view> explain_into_variable_name)
|
|
: Explain_format(explain_into_variable_name),
|
|
current_context(nullptr),
|
|
m_version(version) {}
|
|
|
|
bool is_hierarchical() const override { return true; }
|
|
|
|
/// Format versions newer than Linear are always going to be iterator-based.
|
|
bool is_iterator_based() const override {
|
|
return m_version >= FormatVersion::kIteratorBased;
|
|
}
|
|
|
|
bool send_headers(Query_result *result) override;
|
|
bool begin_context(enum_parsing_context context, Query_expression *subquery,
|
|
const Explain_format_flags *flags) override;
|
|
bool end_context(enum_parsing_context context) override;
|
|
bool flush_entry() override { return false; }
|
|
qep_row *entry() override;
|
|
|
|
/* Convert Json object to string */
|
|
std::string ExplainJsonToString(Json_object *json) override;
|
|
|
|
private:
|
|
opt_explain_json_namespace::context *current_context; ///< current tree node
|
|
FormatVersion m_version;
|
|
};
|
|
|
|
#endif // OPT_EXPLAIN_FORMAT_JSON_INCLUDED
|