MySQL 8.3.0
Source Code Documentation
opt_explain_json.h
Go to the documentation of this file.
1/* Copyright (c) 2011, 2023, Oracle and/or its affiliates.
2
3 This program is free software; you can redistribute it and/or modify
4 it under the terms of the GNU General Public License, version 2.0,
5 as published by the Free Software Foundation.
6
7 This program is also distributed with certain software (including
8 but not limited to OpenSSL) that is licensed under separate terms,
9 as designated in a particular file or component or in included license
10 documentation. The authors of MySQL hereby grant you an additional
11 permission to link the program and your derivative works with the
12 separately licensed software that they have included with MySQL.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License, version 2.0, for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
22
23#ifndef OPT_EXPLAIN_FORMAT_JSON_INCLUDED
24#define OPT_EXPLAIN_FORMAT_JSON_INCLUDED
25
28
29class Query_result;
31
33class context;
34}
35
36/**
37 Formatter class for EXPLAIN FORMAT=JSON output
38*/
39
41 public:
43
46 std::optional<std::string_view> explain_into_variable_name)
50
51 bool is_hierarchical() const override { return true; }
52
53 /// Format versions newer than Linear are always going to be iterator-based.
54 bool is_iterator_based() const override {
56 }
57
58 bool send_headers(Query_result *result) override;
60 const Explain_format_flags *flags) override;
61 bool end_context(enum_parsing_context context) override;
62 bool flush_entry() override { return false; }
63 qep_row *entry() override;
64
65 /* Convert Json object to string */
66 std::string ExplainJsonToString(Json_object *json) override;
67
68 private:
71};
72
73#endif // OPT_EXPLAIN_FORMAT_JSON_INCLUDED
Kerberos Client Authentication nullptr
Definition: auth_kerberos_client_plugin.cc:250
Formatter class for EXPLAIN FORMAT=JSON output.
Definition: opt_explain_json.h:40
bool flush_entry() override
Flush TABLE/JOIN_TAB property set.
Definition: opt_explain_json.h:62
bool end_context(enum_parsing_context context) override
Leave the current context.
Definition: opt_explain_json.cc:2034
bool is_iterator_based() const override
Format versions newer than Linear are always going to be iterator-based.
Definition: opt_explain_json.h:54
Explain_format_JSON(FormatVersion version, std::optional< std::string_view > explain_into_variable_name)
Definition: opt_explain_json.h:44
FormatVersion
Definition: opt_explain_json.h:42
qep_row * entry() override
Get a pointer to the current TABLE/JOIN_TAB property set.
Definition: opt_explain_json.cc:1649
bool send_headers(Query_result *result) override
Send EXPLAIN header item(s) to output stream.
Definition: opt_explain_json.cc:2083
bool begin_context(enum_parsing_context context, Query_expression *subquery, const Explain_format_flags *flags) override
Enter a specified context.
Definition: opt_explain_json.cc:1651
std::string ExplainJsonToString(Json_object *json) override
Convert Json object to string.
Definition: opt_explain_json.cc:2107
opt_explain_json_namespace::context * current_context
current tree node
Definition: opt_explain_json.h:69
FormatVersion m_version
Definition: opt_explain_json.h:70
bool is_hierarchical() const override
A hierarchical text or a plain table.
Definition: opt_explain_json.h:51
Definition: opt_explain_format.h:450
Base class for structured and hierarchical EXPLAIN output formatters.
Definition: opt_explain_format.h:505
std::string_view explain_into_variable_name() const
Returns the name of the user variable the output of this EXPLAIN statement is to be stored in.
Definition: opt_explain_format.h:586
Represents a JSON container value of type "object" (ECMA), type J_OBJECT here.
Definition: json_dom.h:367
This class represents a query expression (one query block or several query blocks combined with UNION...
Definition: sql_lex.h:624
Definition: query_result.h:57
Base class for all intermediate tree nodes.
Definition: opt_explain_json.cc:219
Helper class for table property buffering.
Definition: opt_explain_format.h:149
static int flags[50]
Definition: hp_test1.cc:39
Definition: opt_explain_format.h:132
EXPLAIN FORMAT=<format> <command>.
enum_parsing_context
Names for different query parse tree parts.
Definition: parse_tree_node_base.h:60
required uint64 version
Definition: replication_group_member_actions.proto:40
Definition: result.h:29