MySQL 8.3.0
Source Code Documentation
opt_explain_json_namespace::simple_sort_with_subqueries_ctx Class Reference

Node class for "simple" CTX_ORDER_BY and CTX_GROUP_BY. More...

Inheritance diagram for opt_explain_json_namespace::simple_sort_with_subqueries_ctx:
[legend]

Public Member Functions

 simple_sort_with_subqueries_ctx (enum_parsing_context type_arg, const char *name_arg, context *parent_arg, subquery_list_enum subquery_type_arg, const Explain_format_flags *flags, Explain_sort_clause clause)
 
bool add_subquery (subquery_list_enum subquery_type_arg, subquery_ctx *ctx) override
 Append a subquery node to the specified list of the unit node. More...
 
- Public Member Functions inherited from opt_explain_json_namespace::simple_sort_ctx
 simple_sort_ctx (enum_parsing_context type_arg, const char *name_arg, context *parent_arg, const Explain_format_flags *flags, Explain_sort_clause clause)
 
bool add_join_tab (joinable_ctx *ctx) override
 Add a CTX_QEP_TAB node to a CTX_JOIN node. More...
 
int add_where_subquery (subquery_ctx *ctx, Query_expression *subquery) override
 Associate WHERE subqueries of given context and unit with this object. More...
 
bool find_and_set_derived (context *subquery) override
 Try to associate a derived subquery node with this or underlying node. More...
 
size_t id (bool hide) override
 Analogue of the "id" column in the traditional EXPLAIN output. More...
 
bool cacheable () override
 
bool dependent () override
 
- Public Member Functions inherited from opt_explain_json_namespace::joinable_ctx
 joinable_ctx (enum_parsing_context type_arg, const char *name_arg, context *parent_arg)
 
- Public Member Functions inherited from opt_explain_json_namespace::context
 context (enum_parsing_context type_arg, const char *name_arg, context *parent_arg)
 
virtual ~context ()=default
 
virtual bool format (Opt_trace_context *json)
 Pass the node with its child nodes to a JSON formatter. More...
 
bool is_query_block () const
 
virtual class qep_rowentry ()
 
virtual enum_mod_type get_mod_type ()
 
virtual void set_child (context *)
 Associate a child node with this node. More...
 
virtual void set_setop_result (setop_result_ctx *)
 associate CTX_UNION_RESULT node with CTX_UNION node More...
 
virtual bool format_nested_loop (Opt_trace_context *json)
 Format nested loop join subtree (if any) to JSON formatter. More...
 
virtual void set_sort (sort_ctx *ctx)
 Set nested ORDER BY/GROUP BY/DISTINCT node to ctx. More...
 
virtual void set_window (window_ctx *ctx)
 Set nested WINDOW node to ctx. More...
 
virtual bool add_query_spec (context *ctx)
 Add a query specification node to the CTX_UNION node. More...
 
virtual bool format_derived (Opt_trace_context *)
 Helper function to format output for derived subquery if any. More...
 
virtual bool format_where (Opt_trace_context *)
 Helper function to format output for associated WHERE subqueries if any. More...
 
virtual bool format_query_expression (Opt_trace_context *)
 Helper function to format output for HAVING, ORDER/GROUP BY subqueries. More...
 
- Public Member Functions inherited from Explain_context
 Explain_context (enum_parsing_context type_arg)
 

Private Member Functions

bool format_body (Opt_trace_context *json, Opt_trace_object *obj) override
 Format JSON object body. More...
 

Private Attributes

const subquery_list_enum subquery_type
 Type of this clause subqueries. More...
 
List< subquery_ctxsubqueries
 

Additional Inherited Members

- Public Attributes inherited from opt_explain_json_namespace::context
contextparent
 link to parent node or NULL More...
 
- Public Attributes inherited from Explain_context
enum_parsing_context type
 type tag More...
 
- Protected Attributes inherited from opt_explain_json_namespace::simple_sort_ctx
joinable_ctxjoin_tab
 Single JOIN_TAB that we sort. More...
 
- Protected Attributes inherited from opt_explain_json_namespace::context
const char * name
 

Detailed Description

Node class for "simple" CTX_ORDER_BY and CTX_GROUP_BY.

This class represents context for simple ORDER BY or GROUP BY clauses (the clause is effective for the single JOIN_TAB).

Constructor & Destructor Documentation

◆ simple_sort_with_subqueries_ctx()

opt_explain_json_namespace::simple_sort_with_subqueries_ctx::simple_sort_with_subqueries_ctx ( enum_parsing_context  type_arg,
const char *  name_arg,
context parent_arg,
subquery_list_enum  subquery_type_arg,
const Explain_format_flags flags,
Explain_sort_clause  clause 
)
inline

Member Function Documentation

◆ add_subquery()

bool opt_explain_json_namespace::simple_sort_with_subqueries_ctx::add_subquery ( subquery_list_enum  subquery_type,
subquery_ctx ctx 
)
inlineoverridevirtual

Append a subquery node to the specified list of the unit node.

Parameters
subquery_typeDescribes the Item tree where the subquery exists
ctxSubquery node
Return values
falseOk
trueError

Reimplemented from opt_explain_json_namespace::context.

◆ format_body()

bool opt_explain_json_namespace::simple_sort_with_subqueries_ctx::format_body ( Opt_trace_context json,
Opt_trace_object obj 
)
inlineoverrideprivatevirtual

Format JSON object body.

Parameters
jsonFormatter
objObject of this body
Return values
falseOk
trueError

Reimplemented from opt_explain_json_namespace::simple_sort_ctx.

Member Data Documentation

◆ subqueries

List<subquery_ctx> opt_explain_json_namespace::simple_sort_with_subqueries_ctx::subqueries
private

◆ subquery_type

const subquery_list_enum opt_explain_json_namespace::simple_sort_with_subqueries_ctx::subquery_type
private

Type of this clause subqueries.


The documentation for this class was generated from the following file: