Drizzled Public API Documentation

drizzled::plugin::TransactionalStorageEngine Class Referenceabstract

#include <transactional_storage_engine.h>

Inheritance diagram for drizzled::plugin::TransactionalStorageEngine:
drizzled::plugin::StorageEngine drizzled::plugin::Plugin drizzled::plugin::MonitoredInTransaction drizzled::plugin::SEAPITester drizzled::plugin::XaStorageEngine

Public Types

typedef uint64_t Table_flags
 
typedef std::pair< const
std::string, const std::string > 
map_key
 
typedef std::map< const
map_key, plugin::Plugin * > 
map
 
typedef std::vector< Plugin * > vector
 

Public Member Functions

 TransactionalStorageEngine (const std::string &name_arg, const std::bitset< HTON_BIT_SIZE > &flags_arg=HTON_NO_FLAGS)
 
virtual int startTransaction (Session *session, start_transaction_option_t options)
 
virtual void startStatement (Session *session)
 
virtual int commit (Session *session, bool normal_transaction)
 
virtual int rollback (Session *session, bool normal_transaction)
 
int setSavepoint (Session *session, NamedSavepoint &sp)
 
int rollbackToSavepoint (Session *session, NamedSavepoint &sp)
 
int releaseSavepoint (Session *session, NamedSavepoint &sp)
 
virtual bool participatesInSqlTransaction () const
 
virtual bool participatesInXaTransaction () const
 
virtual bool alwaysRegisterForXaTransaction () const
 
const std::string & getTableDefinitionFileExtension ()
 
virtual
message::Table::Index::IndexType 
default_index_type () const
 
const std::vector< std::string > & getAliases () const
 
void addAlias (std::string alias)
 
virtual void print_error (int error, myf errflag, const Table &table) const
 
bool is_user_selectable () const
 
bool check_flag (const engine_flag_bits flag) const
 
virtual uint32_t index_flags (enum ha_key_alg) const
 
virtual void endStatement (Session *session)
 
virtual int close_connection (Session *)
 
virtual Cursorcreate (Table &)=0
 
virtual bool flush_logs ()
 
virtual bool show_status (Session *, stat_print_fn *, enum ha_stat_type)
 
virtual const char ** bas_ext () const =0
 
int renameTable (Session &session, const drizzled::identifier::Table &from, const drizzled::identifier::Table &to)
 
CursorgetCursor (Table &share)
 
uint32_t max_record_length () const
 
uint32_t max_keys () const
 
uint32_t max_key_parts () const
 
uint32_t max_key_length () const
 
uint32_t max_key_part_length (void) const
 
virtual uint32_t max_supported_record_length (void) const
 
virtual uint32_t max_supported_keys (void) const
 
virtual uint32_t max_supported_key_parts (void) const
 
virtual uint32_t max_supported_key_length (void) const
 
virtual uint32_t max_supported_key_part_length (void) const
 
virtual bool validateCreateTableOption (const std::string &key, const std::string &state)
 
virtual bool validateCreateSchemaOption (const std::string &key, const std::string &state)
 
virtual void shutdownPlugin ()
 
virtual void prime ()
 
virtual void startup (drizzled::Session &)
 
void activate ()
 
void deactivate ()
 
bool isActive () const
 
const std::string & getName () const
 
void setModule (module::Module *module)
 
const std::string & getTypeName () const
 
virtual bool removeLast () const
 
const std::string & getModuleName () const
 
size_t getId () const
 

Static Public Member Functions

static int notifyStartTransaction (Session *session, start_transaction_option_t options)
 
static void releaseTemporaryLatches (Session *session)
 
static bool addPlugin (plugin::TransactionalStorageEngine *engine)
 
static void removePlugin (plugin::TransactionalStorageEngine *engine)
 
static bool addPlugin (plugin::StorageEngine *engine)
 
static void removePlugin (plugin::StorageEngine *engine)
 
static message::table::shared_ptr getTableMessage (Session &session, const drizzled::identifier::Table &identifier, bool include_temporary_tables=true)
 
static bool doesTableExist (Session &session, const drizzled::identifier::Table &identifier, bool include_temporary_tables=true)
 
static plugin::StorageEnginefindByName (const std::string &find_str)
 
static plugin::StorageEnginefindByName (Session &session, const std::string &find_str)
 
static void closeConnection (Session &)
 
static void dropDatabase (char *path)
 
static bool flushLogs (plugin::StorageEngine *db_type)
 
static bool dropTable (Session &session, const drizzled::identifier::Table &identifier)
 
static bool dropTable (Session &session, const drizzled::identifier::Table &identifier, drizzled::error_t &error)
 
static bool dropTable (Session &session, StorageEngine &engine, const identifier::Table &identifier, drizzled::error_t &error)
 
static void getIdentifiers (Session &session, const identifier::Schema &schema_identifier, identifier::table::vector &set_of_identifiers)
 
static void getIdentifiers (Session &session, identifier::schema::vector &schemas)
 
static bool canCreateTable (const drizzled::identifier::Table &identifier)
 
static message::schema::shared_ptr getSchemaDefinition (const drizzled::identifier::Table &identifier)
 
static message::schema::shared_ptr getSchemaDefinition (const drizzled::identifier::Schema &identifier)
 
static bool doesSchemaExist (const drizzled::identifier::Schema &identifier)
 
static const charset_info_stgetSchemaCollation (const drizzled::identifier::Schema &identifier)
 
static bool createSchema (const drizzled::message::Schema &schema_message)
 
static bool dropSchema (Session &session, const identifier::Schema &identifier, message::schema::const_reference schema_message)
 
static bool alterSchema (const drizzled::message::Schema &schema_message)
 
static const std::string & resolveName (const StorageEngine *engine)
 
static bool createTable (Session &session, const identifier::Table &identifier, message::Table &table_message)
 
static void removeLostTemporaryTables (Session &session, const char *directory)
 

Protected Types

typedef std::map< std::string,
message::Table
ProtoCache
 Used as a protobuf storage currently by TEMP only engines.
 

Protected Member Functions

virtual int doGetTableDefinition (Session &session, const drizzled::identifier::Table &identifier, message::Table &table_message)
 
void print_keydup_error (uint32_t key_nr, const char *msg, const Table &table) const
 
virtual bool get_error_message (int error, String *buf) const
 
virtual int doCreateTable (Session &session, Table &table_arg, const drizzled::identifier::Table &identifier, const message::Table &message)=0
 
virtual int doRenameTable (Session &session, const drizzled::identifier::Table &from, const drizzled::identifier::Table &to)=0
 
virtual int doDropTable (Session &session, const drizzled::identifier::Table &identifier)=0
 
virtual void doGetTableIdentifiers (CachedDirectory &directory, const drizzled::identifier::Schema &schema_identifier, identifier::table::vector &set_of_identifiers)=0
 
virtual bool doDoesTableExist (Session &session, const drizzled::identifier::Table &identifier)
 
virtual bool doCanCreateTable (const drizzled::identifier::Table &identifier)
 
virtual void doGetSchemaIdentifiers (identifier::schema::vector &)
 
virtual
drizzled::message::schema::shared_ptr 
doGetSchemaDefinition (const drizzled::identifier::Schema &)
 
virtual bool doCreateSchema (const drizzled::message::Schema &)
 
virtual bool doAlterSchema (const drizzled::message::Schema &)
 
virtual bool doDropSchema (const drizzled::identifier::Schema &)
 

Static Protected Member Functions

static int deleteDefinitionFromPath (const drizzled::identifier::Table &identifier)
 
static int renameDefinitionFromPath (const drizzled::identifier::Table &dest, const drizzled::identifier::Table &src)
 
static int writeDefinitionFromPath (const drizzled::identifier::Table &identifier, const message::Table &proto)
 
static bool readTableFile (const std::string &path, message::Table &table_message)
 

Protected Attributes

std::string table_definition_ext
 
ProtoCache proto_cache
 
pthread_mutex_t proto_cache_mutex
 

Private Member Functions

void setTransactionReadWrite (Session &session)
 
virtual int doStartTransaction (Session *session, start_transaction_option_t options)
 
virtual void doStartStatement (Session *session)
 
virtual void doEndStatement (Session *session)
 
virtual int doSetSavepoint (Session *session, NamedSavepoint &savepoint)=0
 
virtual int doRollbackToSavepoint (Session *session, NamedSavepoint &savepoint)=0
 
virtual int doReleaseSavepoint (Session *session, NamedSavepoint &savepoint)=0
 
virtual int doCommit (Session *session, bool normal_transaction)=0
 
virtual int doRollback (Session *session, bool normal_transaction)=0
 
virtual int doReleaseTemporaryLatches (Session *)
 
virtual int doStartConsistentSnapshot (Session *)
 

Friends

class SEAPITester
 

Detailed Description

A type of storage engine which supports SQL transactions.

This class adds the SQL transactional API to the regular storage engine. In other words, it adds support for the following SQL statements:

START TRANSACTION; COMMIT; ROLLBACK; ROLLBACK TO SAVEPOINT; SET SAVEPOINT; RELEASE SAVEPOINT;

Note

This class does not implement the XA protocol (two phase commit). There is an XaStorageEngine class which extends this class that exposes the XA API.

Todo:

kill two_phase_commit member. Use an HTON flag if absolutely needed to keep.

Definition at line 57 of file transactional_storage_engine.h.

Member Function Documentation

virtual bool drizzled::plugin::TransactionalStorageEngine::alwaysRegisterForXaTransaction ( ) const
inlinevirtual

Returns true if the class should be registered for every XA transaction regardless of whether the class modifies the server's state.

Note

As an example, the XaTransactionApplier plugin class returns true for this virtual method. Even though it does not change the result of the transaction (it simply is logging the changes made by other resource managers), the applier plugin should be enlisted in all XA transactions in order to be able to rollback or recover its logging activity properly.

Reimplemented from drizzled::plugin::StorageEngine.

Reimplemented in drizzled::plugin::XaStorageEngine.

Definition at line 113 of file transactional_storage_engine.h.

virtual const char** drizzled::plugin::StorageEngine::bas_ext ( ) const
pure virtualinherited

If frm_error() is called then we will use this to find out what file extentions exist for the storage engine. This is also used by the default rename_table and delete_table method in Cursor.cc.

For engines that have two file name extentions (separate meta/index file and data file), the order of elements is relevant. First element of engine file name extentions array should be meta/index file extention. Second element - data file extention. This order is assumed by prepare_for_repair() when REPAIR Table ... USE_FRM is issued.

Implemented in drizzled::plugin::SEAPITester, Schema, TableProtoTesterEngine, and Function.

Referenced by drizzled::plugin::StorageEngine::doDropTable().

bool drizzled::plugin::StorageEngine::canCreateTable ( const drizzled::identifier::Table identifier)
staticinherited
Note
on success table can be created.

Definition at line 952 of file storage_engine.cc.

void drizzled::plugin::StorageEngine::closeConnection ( Session session)
staticinherited
Note
don't bother to rollback here, it's done already

Definition at line 196 of file storage_engine.cc.

bool drizzled::plugin::StorageEngine::createTable ( Session session,
const identifier::Table identifier,
message::Table table_message 
)
staticinherited

Initiates table-file and calls appropriate database-creator.

Return values
0ok
1error

Definition at line 413 of file storage_engine.cc.

References drizzled::Table::delete_table().

virtual int drizzled::plugin::TransactionalStorageEngine::doCommit ( Session session,
bool  normal_transaction 
)
privatepure virtual

Commits either the "statement transaction" or the "normal transaction".

Parameters
[in]TheSession
[in]trueif it's a real commit, that makes persistent changes false if it's not in fact a commit but an end of the statement that is part of the transaction.
Note

'normal_transaction' is also false in auto-commit mode where 'end of statement' and 'real commit' mean the same event.

Implemented in drizzled::plugin::SEAPITester.

int drizzled::plugin::StorageEngine::doDropTable ( Session session,
const drizzled::identifier::Table identifier 
)
protectedpure virtualinherited

Delete all files with extension from bas_ext().

Parameters
nameBase name of table
Note
We assume that the Cursor may return more extensions than was actually used for the file.
Return values
0If we successfully deleted at least one file from base_ext and didn't get any other errors than ENOENT
!0Error

Implemented in drizzled::plugin::SEAPITester, Schema, TableProtoTesterEngine, and Function.

Definition at line 122 of file storage_engine.cc.

References drizzled::plugin::StorageEngine::bas_ext().

bool StorageEngine::doesTableExist ( Session session,
const drizzled::identifier::Table identifier,
bool  include_temporary_tables = true 
)
staticinherited

Utility method which hides some of the details of getTableDefinition()

Definition at line 249 of file storage_engine.cc.

virtual int drizzled::plugin::TransactionalStorageEngine::doRollback ( Session session,
bool  normal_transaction 
)
privatepure virtual

Rolls back either the "statement transaction" or the "normal transaction".

Parameters
[in]TheSession
[in]trueif it's a real commit, that makes persistent changes false if it's not in fact a commit but an end of the statement that is part of the transaction.
Note

'normal_transaction' is also false in auto-commit mode where 'end of statement' and 'real commit' mean the same event.

Implemented in drizzled::plugin::SEAPITester.

virtual int drizzled::plugin::TransactionalStorageEngine::doSetSavepoint ( Session session,
NamedSavepoint savepoint 
)
privatepure virtual

Implementing classes should override these to provide savepoint functionality.

Implemented in drizzled::plugin::SEAPITester.

bool drizzled::plugin::StorageEngine::get_error_message ( int  error,
String buf 
) const
protectedvirtualinherited

Return an error message specific to this Cursor.

Parameters
errorerror code previously returned by Cursor
bufpointer to String where to add error message
Returns
Returns true if this is a temporary error

Definition at line 805 of file storage_engine.cc.

Referenced by drizzled::plugin::StorageEngine::print_error().

size_t drizzled::plugin::MonitoredInTransaction::getId ( ) const
inlineinherited

Returns the "slot" or ID of the monitored resource

Definition at line 87 of file monitored_in_transaction.h.

int drizzled::plugin::TransactionalStorageEngine::notifyStartTransaction ( Session session,
start_transaction_option_t  options 
)
static

The below static class methods wrap the interaction of the vector of transactional storage engines.

Definition at line 82 of file transactional_storage_engine.cc.

virtual bool drizzled::plugin::TransactionalStorageEngine::participatesInSqlTransaction ( ) const
inlinevirtual

Returns true if the class should participate in the SQL transaction.

Reimplemented from drizzled::plugin::StorageEngine.

Reimplemented in drizzled::plugin::XaStorageEngine.

Definition at line 105 of file transactional_storage_engine.h.

virtual bool drizzled::plugin::TransactionalStorageEngine::participatesInXaTransaction ( ) const
inlinevirtual

Returns true if the class should participate in the XA transaction.

Reimplemented from drizzled::plugin::StorageEngine.

Reimplemented in drizzled::plugin::XaStorageEngine.

Definition at line 109 of file transactional_storage_engine.h.

void drizzled::plugin::StorageEngine::print_error ( int  error,
myf  errflag,
const Table table 
) const
virtualinherited

Print error that we got from Cursor function.

Note
In case of delete table it's only safe to use the following parts of the 'table' structure:
  • table->getShare()->path
  • table->alias

Definition at line 603 of file storage_engine.cc.

References drizzled::Table::get_dup_key(), drizzled::plugin::StorageEngine::get_error_message(), and drizzled::Table::key_info.

void drizzled::plugin::TransactionalStorageEngine::releaseTemporaryLatches ( Session session)
static
Todo:
Kill this one entirely. It's implementation, not interface...

This function should be called when MySQL sends rows of a SELECT result set or the EOF mark to the client. It releases a possible adaptive hash index S-latch held by session in InnoDB and also releases a possible InnoDB query FIFO ticket to enter InnoDB. To save CPU time, InnoDB allows a session to keep them over several calls of the InnoDB Cursor interface when a join is executed. But when we let the control to pass to the client they have to be released because if the application program uses use_result(), it may deadlock on the S-latch if the application on another connection performs another SQL query. In MySQL-4.1 this is even more important because there a connection can have several SELECT queries open at the same time.

Parameters
sessionthe thread handle of the current connection
Returns
always 0

Definition at line 76 of file transactional_storage_engine.cc.

Referenced by drizzled::insert_query(), and drizzled::FileSort::run().


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