Regular_statement_handle Class Reference

Regular_statement_handle enables execution of all SQL statements except for prepared statements. More...

#include <statement.h>

Inheritance diagram for Regular_statement_handle:

Public Member Functions
	Regular_statement_handle (THD *thd, const char *query, uint length)
	~Regular_statement_handle () override
bool	execute () override
	Execute a regular statement. More...
bool	is_prepared_statement () override
	Convey that this is regular statement. More...
bool	is_executed_or_prepared () override
	Check if the statement has been executed. More...
Public Member Functions inherited from Statement_handle
	Statement_handle (THD *thd, const char *query, size_t length)
bool	is_error () const
	Check if error is reported. More...
LEX_CSTRING	get_last_error ()
	Check if error is reported. More...
unsigned int	get_last_errno () const
	Get the last mysql errno. More...
LEX_CSTRING	get_mysql_state ()
	Get the mysql error state. More...
ulonglong	warning_count () const
	Get number of warnings generated. More...
Warning *	get_warnings ()
	Get list of all warnings. More...
void	set_clear_diagnostics_area_on_success (bool clear_da)
	Set the flag to indicate clear diagnostics area on successful execution of a statement. More...
bool	clear_diagnostics_area_on_success () const
	Get value of a flag which indicates whether diagnostics area should be cleared on successful execution of a statement or not. More...
Result_set *	get_result_sets ()
	Get the next result sets generated while executing the statement. More...
Result_set *	get_current_result_set ()
	Get the current result set object. More...
void	next_result_set ()
	Make the next result set the current result set. More...
void	free_old_result ()
	Feel all the result collected so far, from query execution. More...
std::string_view	get_query ()
	Get the query string being executed. More...
void	set_capacity (size_t capacity)
	Set the capacity in bytes allowed for caching results. More...
size_t	get_capacity ()
	Get the capacity in bytes allowed for caching results. More...
void	set_use_thd_protocol (bool use_thd_protocol)
	Set thd protocol to enable result pass through. More...
bool	is_using_thd_protocol () const
	Check if thd protocol is used. More...
void	set_thd_protocol ()
	Set either Protocol_local_v2 when m_use_thd_protocol is not set or or classical protocol when m_use_thd_protocol is set to THD. More...
void	reset_thd_protocol ()
	Reset THD protocol. More...
void	set_expected_charset (const char *charset_name)
	Set the expected charset. More...
const char *	get_expected_charset ()
	Get the expected charset. More...
size_t	get_num_rows_per_fetch ()
	Get the num rows per fetch. More...
void	set_num_rows_per_fetch (size_t num_rows_per_fetch)
	Set the num of rows to be retrieved per fetch. More...
virtual	~Statement_handle ()
	Destroy the Statement_handle object. More...

Static Public Attributes
static PSI_statement_info	stmt_psi_info

Private Member Functions
bool	execute (Server_runnable *server_runnable)

Private Attributes
bool	m_is_executed = false
	Flag to indicate if statement has been executed. Set to true in execute(). More...

Additional Inherited Members
Protected Member Functions inherited from Statement_handle
void	send_statement_status ()
	Send statement execution status after execute(). More...
void	add_result_set (Result_set *result_set)
void	set_result_set (Result_set *result_set)
void	copy_warnings ()
	Copy the warnings generated for the query from the diagnostics area. More...
	Statement_handle (const Statement_handle &)=delete
	Statement_handle (Statement_handle &&)=delete
Statement_handle &	operator= (const Statement_handle &)=delete
Statement_handle &	operator= (Statement_handle &&)=delete
Protected Attributes inherited from Statement_handle
std::string	m_query
MEM_ROOT	m_warning_mem_root
Warning *	m_warnings
ulonglong	m_warnings_count = 0
Diagnostics_area *	m_diagnostics_area
bool	m_clear_diagnostics_area_on_success {true}
	Flag to indicate if diagnostics area should be cleared or retained on successful execution of a statement. More...
THD *	m_thd
Result_set *	m_result_sets
Result_set *	m_current_rset
bool	m_use_thd_protocol = false
size_t	m_num_rows_per_fetch = 1
CHARSET_INFO *	m_expected_charset
Protocol_local_v2	m_protocol
Protocol *	m_saved_protocol {nullptr}

Detailed Description

Regular_statement_handle enables execution of all SQL statements except for prepared statements.

Constructor & Destructor Documentation

Regular_statement_handle()

Regular_statement_handle::Regular_statement_handle ( THD *  thd, const char *  query, uint  length  )

inline

~Regular_statement_handle()

Regular_statement_handle::~Regular_statement_handle ( )

inlineoverride

Member Function Documentation

execute() [1/2]

bool Regular_statement_handle::execute ( )

overridevirtual

Execute a regular statement.

Returns

true if statement fails.

false if statement succeeds.

Implements Statement_handle.

execute() [2/2]

bool Regular_statement_handle::execute ( Server_runnable *  server_runnable )

private

is_executed_or_prepared()

bool Regular_statement_handle::is_executed_or_prepared ( )

inlineoverridevirtual

Check if the statement has been executed.

Returns

true if executed

false otherwise

Implements Statement_handle.

is_prepared_statement()

bool Regular_statement_handle::is_prepared_statement ( )

inlineoverridevirtual

Convey that this is regular statement.

Returns

Always returns 'false'

Implements Statement_handle.

Member Data Documentation

m_is_executed

bool Regular_statement_handle::m_is_executed = false

private

Flag to indicate if statement has been executed. Set to true in execute().

stmt_psi_info

PSI_statement_info Regular_statement_handle::stmt_psi_info

static

Initial value:

= {
    0, "regular", 0, "Regular Statement Handle: SQL Statement"}

---

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

• sql/statement/statement.h
• sql/statement/statement.cc