MySQL 8.0.30
Source Code Documentation

Engine interface, row lock iterator. More...

#include <psi_data_lock.h>

Inheritance diagram for PSI_engine_data_lock_iterator:
[legend]

Public Member Functions

 PSI_engine_data_lock_iterator ()=default
 
virtual ~PSI_engine_data_lock_iterator ()=default
 
virtual bool scan (PSI_server_data_lock_container *container, bool with_lock_data)=0
 Scan for more data locks. More...
 
virtual bool fetch (PSI_server_data_lock_container *container, const char *engine_lock_id, size_t engine_lock_id_length, bool with_lock_data)=0
 Fetch a given data lock. More...
 

Detailed Description

Engine interface, row lock iterator.

This is the interface exposed

  • by a storage engine
  • to the server used to iterate over all the row locks present within the storage engine tables. The storage engine is to implement this interface. The server is to call scan() to ask the storage engine to add more rows to the container given.

Constructor & Destructor Documentation

◆ PSI_engine_data_lock_iterator()

PSI_engine_data_lock_iterator::PSI_engine_data_lock_iterator ( )
default

◆ ~PSI_engine_data_lock_iterator()

virtual PSI_engine_data_lock_iterator::~PSI_engine_data_lock_iterator ( )
virtualdefault

Member Function Documentation

◆ fetch()

virtual bool PSI_engine_data_lock_iterator::fetch ( PSI_server_data_lock_container container,
const char *  engine_lock_id,
size_t  engine_lock_id_length,
bool  with_lock_data 
)
pure virtual

Fetch a given data lock.

Parameters
containerThe container to fill
engine_lock_idThe lock id to search
engine_lock_id_lengthLock id length
with_lock_dataTrue if column LOCK_DATA is required.
Returns
true if the iterator is done

Implemented in Innodb_data_lock_iterator.

◆ scan()

virtual bool PSI_engine_data_lock_iterator::scan ( PSI_server_data_lock_container container,
bool  with_lock_data 
)
pure virtual

Scan for more data locks.

Parameters
containerThe container to fill
with_lock_dataTrue if column LOCK_DATA is required.
Returns
true if the iterator is done

Implemented in Innodb_data_lock_iterator.


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