Sql_cmd_xa_start Class Reference

This class represents the XA START ... SQL statement which starts an XA transaction with the given xid value. More...

#include <sql_xa_start.h>

Inheritance diagram for Sql_cmd_xa_start:

Public Member Functions
	Sql_cmd_xa_start (xid_t *xid_arg, enum xa_option_words xa_option)
	Class constructor. More...
virtual	~Sql_cmd_xa_start () override=default
enum_sql_command	sql_command_code () const override
	Retrieves the SQL command code for this class, SQLCOM_XA_START. More...
bool	execute (THD *thd) override
	Executes the SQL command. 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 Member Functions
bool	trans_xa_start (THD *thd)
	Start a XA transaction with the given xid value. More...

Private Attributes
xid_t *	m_xid
	The XID associated with the underlying XA transaction. More...
enum xa_option_words	m_xa_opt
	Options associated with the underlying XA START 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

This class represents the XA START ... SQL statement which starts an XA transaction with the given xid value.

See also

Sql_cmd

Constructor & Destructor Documentation

Sql_cmd_xa_start()

Sql_cmd_xa_start::Sql_cmd_xa_start	(	xid_t *	xid_arg,
		enum xa_option_words	xa_option
	)

Class constructor.

Parameters

xid_arg	XID of the XA transacation about to start
xa_option	Additional options for the XA START command

~Sql_cmd_xa_start()

virtual Sql_cmd_xa_start::~Sql_cmd_xa_start ( )

overridevirtualdefault

Member Function Documentation

execute()

bool Sql_cmd_xa_start::execute ( THD *  thd )

overridevirtual

Executes the SQL command.

See also

Sql_cmd::execute

Parameters

thd	The THD session object within which the command is being executed.

Returns

false if the execution is successful, true otherwise.

Implements Sql_cmd.

sql_command_code()

enum_sql_command Sql_cmd_xa_start::sql_command_code ( ) const

overridevirtual

Retrieves the SQL command code for this class, SQLCOM_XA_START.

See also

Sql_cmd::sql_command_code

Returns

The SQL command code for this class, SQLCOM_XA_START.

Implements Sql_cmd.

trans_xa_start()

bool Sql_cmd_xa_start::trans_xa_start ( THD *  thd )

private

Start a XA transaction with the given xid value.

Parameters

thd	Current thread

Return values

false	Success
true	Failure

Member Data Documentation

m_xa_opt

enum xa_option_words Sql_cmd_xa_start::m_xa_opt

private

Options associated with the underlying XA START

m_xid

xid_t* Sql_cmd_xa_start::m_xid

private

The XID associated with the underlying XA transaction.

---

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

• sql/xa/sql_xa_start.h
• sql/xa/sql_xa_start.cc