Sql_cmd_handler_read Class Reference

Sql_cmd_handler_read represents HANDLER READ statement. More...

#include <sql_handler.h>

Inheritance diagram for Sql_cmd_handler_read:

Public Member Functions
	Sql_cmd_handler_read (enum_ha_read_modes read_mode, const char *key_name, mem_root_deque< Item * > *key_expr, ha_rkey_function rkey_mode)
	~Sql_cmd_handler_read () override=default
enum_sql_command	sql_command_code () const override
	Return the command code for this statement. More...
bool	execute (THD *thd) override
	Execute a HANDLER READ statement. More...
Public Member Functions inherited from Sql_cmd
bool	needs_explicit_preparation () const
bool	is_regular () const
bool	is_prepared () const
virtual bool	prepare (THD *)
	Prepare this SQL statement. More...
virtual void	cleanup (THD *)
	Command-specific reinitialization before execution of prepared statement. More...
void	set_owner (Prepared_statement *stmt)
	Set the owning prepared statement. More...
Prepared_statement *	owner () const
	Get the owning prepared statement. More...
void	set_as_part_of_sp ()
	Mark statement as part of procedure. More...
bool	is_part_of_sp () const
virtual bool	is_dml () const
virtual bool	is_single_table_plan () const
virtual bool	accept (THD *, Select_lex_visitor *)
virtual const MYSQL_LEX_CSTRING *	eligible_secondary_storage_engine () const
	Is this statement of a type and on a form that makes it eligible for execution in a secondary storage engine? More...
void	disable_secondary_storage_engine ()
	Disable use of secondary storage engines in this statement. More...
bool	secondary_storage_engine_disabled () const
	Has use of secondary storage engines been disabled for this statement? More...
void	use_secondary_storage_engine (const handlerton *hton)
	Mark the current statement as using a secondary storage engine. More...
bool	using_secondary_storage_engine () const
	Is this statement using a secondary storage engine? More...
const handlerton *	secondary_engine () const
	Get the handlerton of the secondary engine that is used for executing this statement, or nullptr if a secondary engine is not used. More...
void	set_optional_transform_prepared (bool value)
bool	is_optional_transform_prepared ()

Private Attributes
enum_ha_read_modes	m_read_mode
	Read mode for HANDLER READ: FIRST, NEXT, LAST, ... More...
const char *	m_key_name
	Name of key to be used for reading, NULL in cases when natural row-order is to be used. More...
mem_root_deque< Item * > *	m_key_expr
	Key values to be satisfied. More...
enum ha_rkey_function	m_rkey_mode
	Type of condition for key values to be satisfied. More...

Additional Inherited Members
Protected Member Functions inherited from Sql_cmd
	Sql_cmd ()
virtual	~Sql_cmd ()
void	set_prepared ()
	Set this statement as prepared. More...

Detailed Description

Sql_cmd_handler_read represents HANDLER READ statement.

Note

Some information about this statement, for example, table list element which identifies HANDLER to be read from, WHERE and LIMIT clauses is still kept in LEX class.

Constructor & Destructor Documentation

Sql_cmd_handler_read()

Sql_cmd_handler_read::Sql_cmd_handler_read ( enum_ha_read_modes  read_mode, const char *  key_name, mem_root_deque< Item * > *  key_expr, ha_rkey_function  rkey_mode  )

inline

~Sql_cmd_handler_read()

Sql_cmd_handler_read::~Sql_cmd_handler_read ( )

overridedefault

Member Function Documentation

execute()

bool Sql_cmd_handler_read::execute ( THD *  thd )

overridevirtual

Execute a HANDLER READ statement.

Parameters

thd	The current thread.

Note

Closes the table that is associated (on the handler tables hash) with the name (Table_ref::alias) of the specified table.

Return values

false	on success.
true	on failure.

Implements Sql_cmd.

sql_command_code()

enum_sql_command Sql_cmd_handler_read::sql_command_code ( ) const

inlineoverridevirtual

Return the command code for this statement.

Implements Sql_cmd.

Member Data Documentation

m_key_expr

mem_root_deque<Item *>* Sql_cmd_handler_read::m_key_expr

private

Key values to be satisfied.

m_key_name

const char* Sql_cmd_handler_read::m_key_name

private

Name of key to be used for reading, NULL in cases when natural row-order is to be used.

m_read_mode

enum_ha_read_modes Sql_cmd_handler_read::m_read_mode

private

Read mode for HANDLER READ: FIRST, NEXT, LAST, ...

m_rkey_mode

enum ha_rkey_function Sql_cmd_handler_read::m_rkey_mode

private

Type of condition for key values to be satisfied.

---

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

• sql/sql_handler.h
• sql/sql_handler.cc