24
24
#include <drizzled/definitions.h>
25
#include <drizzled/plugin.h>
25
#include <drizzled/sql_plugin.h>
26
26
#include <drizzled/handler_structs.h>
27
#include <drizzled/message.h>
28
#include <drizzled/message/cache.h>
29
#include "drizzled/plugin/plugin.h"
30
#include "drizzled/sql_string.h"
31
#include "drizzled/identifier.h"
32
#include "drizzled/cached_directory.h"
33
#include "drizzled/plugin/monitored_in_transaction.h"
46
typedef struct st_hash HASH;
49
typedef drizzle_lex_string LEX_STRING;
38
typedef struct st_mysql_lex_string LEX_STRING;
50
39
typedef bool (stat_print_fn)(Session *session, const char *type, uint32_t type_len,
51
40
const char *file, uint32_t file_len,
52
41
const char *status, uint32_t status_len);
42
enum ha_stat_type { HA_ENGINE_STATUS, HA_ENGINE_LOGS, HA_ENGINE_MUTEX };
54
44
/* Possible flags of a StorageEngine (there can be 32 of them) */
55
45
enum engine_flag_bits {
46
HTON_BIT_CLOSE_CURSORS_AT_COMMIT,
56
47
HTON_BIT_ALTER_NOT_SUPPORTED, // Engine does not support alter
48
HTON_BIT_CAN_RECREATE, // Delete all is used for truncate
57
49
HTON_BIT_HIDDEN, // Engine does not appear in lists
50
HTON_BIT_FLUSH_AFTER_RENAME,
58
51
HTON_BIT_NOT_USER_SELECTABLE,
59
52
HTON_BIT_TEMPORARY_NOT_SUPPORTED, // Having temporary tables not supported
60
53
HTON_BIT_TEMPORARY_ONLY,
61
HTON_BIT_DOES_TRANSACTIONS,
62
HTON_BIT_STATS_RECORDS_IS_EXACT,
64
HTON_BIT_CAN_INDEX_BLOBS,
65
HTON_BIT_PRIMARY_KEY_IN_READ_INDEX,
66
HTON_BIT_PARTIAL_COLUMN_READ,
67
HTON_BIT_TABLE_SCAN_ON_INDEX,
68
HTON_BIT_FAST_KEY_READ,
71
HTON_BIT_NO_AUTO_INCREMENT,
72
HTON_BIT_DUPLICATE_POS,
73
HTON_BIT_AUTO_PART_KEY,
74
HTON_BIT_REQUIRE_PRIMARY_KEY,
75
HTON_BIT_REQUIRES_KEY_COLUMNS_FOR_DELETE,
76
HTON_BIT_PRIMARY_KEY_REQUIRED_FOR_DELETE,
77
HTON_BIT_NO_PREFIX_CHAR_KEYS,
78
HTON_BIT_HAS_CHECKSUM,
79
HTON_BIT_SKIP_STORE_LOCK,
80
HTON_BIT_SCHEMA_DICTIONARY,
81
HTON_BIT_FOREIGN_KEYS,
85
57
static const std::bitset<HTON_BIT_SIZE> HTON_NO_FLAGS(0);
58
static const std::bitset<HTON_BIT_SIZE> HTON_CLOSE_CURSORS_AT_COMMIT(1 << HTON_BIT_CLOSE_CURSORS_AT_COMMIT);
86
59
static const std::bitset<HTON_BIT_SIZE> HTON_ALTER_NOT_SUPPORTED(1 << HTON_BIT_ALTER_NOT_SUPPORTED);
60
static const std::bitset<HTON_BIT_SIZE> HTON_CAN_RECREATE(1 << HTON_BIT_CAN_RECREATE);
87
61
static const std::bitset<HTON_BIT_SIZE> HTON_HIDDEN(1 << HTON_BIT_HIDDEN);
62
static const std::bitset<HTON_BIT_SIZE> HTON_FLUSH_AFTER_RENAME(1 << HTON_BIT_FLUSH_AFTER_RENAME);
88
63
static const std::bitset<HTON_BIT_SIZE> HTON_NOT_USER_SELECTABLE(1 << HTON_BIT_NOT_USER_SELECTABLE);
89
64
static const std::bitset<HTON_BIT_SIZE> HTON_TEMPORARY_NOT_SUPPORTED(1 << HTON_BIT_TEMPORARY_NOT_SUPPORTED);
90
65
static const std::bitset<HTON_BIT_SIZE> HTON_TEMPORARY_ONLY(1 << HTON_BIT_TEMPORARY_ONLY);
91
static const std::bitset<HTON_BIT_SIZE> HTON_HAS_DOES_TRANSACTIONS(1 << HTON_BIT_DOES_TRANSACTIONS);
92
static const std::bitset<HTON_BIT_SIZE> HTON_STATS_RECORDS_IS_EXACT(1 << HTON_BIT_STATS_RECORDS_IS_EXACT);
93
static const std::bitset<HTON_BIT_SIZE> HTON_NULL_IN_KEY(1 << HTON_BIT_NULL_IN_KEY);
94
static const std::bitset<HTON_BIT_SIZE> HTON_CAN_INDEX_BLOBS(1 << HTON_BIT_CAN_INDEX_BLOBS);
95
static const std::bitset<HTON_BIT_SIZE> HTON_PRIMARY_KEY_IN_READ_INDEX(1 << HTON_BIT_PRIMARY_KEY_IN_READ_INDEX);
96
static const std::bitset<HTON_BIT_SIZE> HTON_PARTIAL_COLUMN_READ(1 << HTON_BIT_PARTIAL_COLUMN_READ);
97
static const std::bitset<HTON_BIT_SIZE> HTON_TABLE_SCAN_ON_INDEX(1 << HTON_BIT_TABLE_SCAN_ON_INDEX);
98
static const std::bitset<HTON_BIT_SIZE> HTON_FAST_KEY_READ(1 << HTON_BIT_FAST_KEY_READ);
99
static const std::bitset<HTON_BIT_SIZE> HTON_NO_BLOBS(1 << HTON_BIT_NO_BLOBS);
100
static const std::bitset<HTON_BIT_SIZE> HTON_HAS_RECORDS(1 << HTON_BIT_HAS_RECORDS);
101
static const std::bitset<HTON_BIT_SIZE> HTON_NO_AUTO_INCREMENT(1 << HTON_BIT_NO_AUTO_INCREMENT);
102
static const std::bitset<HTON_BIT_SIZE> HTON_DUPLICATE_POS(1 << HTON_BIT_DUPLICATE_POS);
103
static const std::bitset<HTON_BIT_SIZE> HTON_AUTO_PART_KEY(1 << HTON_BIT_AUTO_PART_KEY);
104
static const std::bitset<HTON_BIT_SIZE> HTON_REQUIRE_PRIMARY_KEY(1 << HTON_BIT_REQUIRE_PRIMARY_KEY);
105
static const std::bitset<HTON_BIT_SIZE> HTON_REQUIRES_KEY_COLUMNS_FOR_DELETE(1 << HTON_BIT_REQUIRES_KEY_COLUMNS_FOR_DELETE);
106
static const std::bitset<HTON_BIT_SIZE> HTON_PRIMARY_KEY_REQUIRED_FOR_DELETE(1 << HTON_BIT_PRIMARY_KEY_REQUIRED_FOR_DELETE);
107
static const std::bitset<HTON_BIT_SIZE> HTON_NO_PREFIX_CHAR_KEYS(1 << HTON_BIT_NO_PREFIX_CHAR_KEYS);
108
static const std::bitset<HTON_BIT_SIZE> HTON_HAS_CHECKSUM(1 << HTON_BIT_HAS_CHECKSUM);
109
static const std::bitset<HTON_BIT_SIZE> HTON_SKIP_STORE_LOCK(1 << HTON_BIT_SKIP_STORE_LOCK);
110
static const std::bitset<HTON_BIT_SIZE> HTON_HAS_SCHEMA_DICTIONARY(1 << HTON_BIT_SCHEMA_DICTIONARY);
111
static const std::bitset<HTON_BIT_SIZE> HTON_HAS_FOREIGN_KEYS(1 << HTON_BIT_FOREIGN_KEYS);
115
class NamedSavepoint;
120
typedef std::vector<StorageEngine *> EngineVector;
122
typedef std::set<std::string> TableNameList;
124
extern const std::string UNKNOWN_STRING;
125
extern const std::string DEFAULT_DEFINITION_FILE_EXT;
128
70
StorageEngine is a singleton structure - one instance per storage engine -
129
71
to provide access to storage engine functionality that works on the
130
"global" level (unlike Cursor class that works on a per-table basis)
72
"global" level (unlike handler class that works on a per-table basis)
132
74
usually StorageEngine instance is defined statically in ha_xxx.cc as
134
76
static StorageEngine { ... } xxx_engine;
78
savepoint_*, prepare, recover, and *_by_xid pointers can be 0.
136
class StorageEngine : public Plugin,
137
public MonitoredInTransaction
140
typedef uint64_t Table_flags;
143
const std::bitset<HTON_BIT_SIZE> flags; /* global Cursor flags */
145
static EngineVector &getSchemaEngines();
147
virtual void setTransactionReadWrite(Session& session);
150
* Indicates to a storage engine the start of a
153
virtual void doStartStatement(Session *session)
159
* Indicates to a storage engine the end of
160
* the current SQL statement in the supplied
163
virtual void doEndStatement(Session *session)
169
std::string table_definition_ext;
172
const std::string& getTableDefinitionFileExtension()
174
return table_definition_ext;
83
Name used for storage engine.
85
const std::string name;
86
const bool two_phase_commit;
89
const std::bitset<HTON_BIT_SIZE> flags; /* global handler flags */
91
to store per-savepoint data storage engine is provided with an area
92
of a requested size (0 is ok here).
93
savepoint_offset must be initialized statically to the size of
94
the needed memory to store per-savepoint information.
95
After xxx_init it is changed to be an offset to savepoint storage
96
area and need not be used by storage engine.
97
see binlog_engine and binlog_savepoint_set/rollback for an example.
99
size_t savepoint_offset;
100
size_t orig_savepoint_offset;
178
101
std::vector<std::string> aliases;
103
void setTransactionReadWrite(Session* session);
108
* Implementing classes should override these to provide savepoint
111
virtual int savepoint_set_hook(Session *, void *) { return 0; }
113
virtual int savepoint_rollback_hook(Session *, void *) { return 0; }
115
virtual int savepoint_release_hook(Session *, void *) { return 0; }
181
const std::vector<std::string>& getAliases() const
119
StorageEngine(const std::string name_arg,
120
const std::bitset<HTON_BIT_SIZE> &flags_arg= HTON_NO_FLAGS,
121
size_t savepoint_offset_arg= 0,
122
bool support_2pc= false);
124
virtual ~StorageEngine();
127
each storage engine has it's own memory area (actually a pointer)
128
in the session, for storing per-connection information.
131
session->ha_data[xxx_engine.slot]
133
slot number is initialized by MySQL after xxx_init() is called.
137
inline uint32_t getSlot (void) { return slot; }
138
inline void setSlot (uint32_t value) { slot= value; }
140
const std::vector<std::string>& getAliases()
234
168
return flags.test(flag);
237
// @todo match check_flag interface
238
virtual uint32_t index_flags(enum ha_key_alg) const { return 0; }
239
virtual void startStatement(Session *session)
241
doStartStatement(session);
243
virtual void endStatement(Session *session)
245
doEndStatement(session);
171
void enable() { enabled= true; }
172
void disable() { enabled= false; }
174
std::string getName() const { return name; }
249
* Called during Session::cleanup() for all engines
177
StorageEngine methods:
179
close_connection is only called if
180
session->ha_data[xxx_engine.slot] is non-zero, so even if you don't need
181
this storage area - set it to something, so that MySQL would know
182
this storage engine was accessed in this connection
251
184
virtual int close_connection(Session *)
255
virtual Cursor *create(Table &)= 0;
189
'all' is true if it's a real commit, that makes persistent changes
190
'all' is false if it's not in fact a commit but an end of the
191
statement that is part of the transaction.
192
NOTE 'all' is also false in auto-commit mode where 'end of statement'
193
and 'real commit' mean the same event.
195
virtual int commit(Session *, bool)
200
virtual int rollback(Session *, bool)
206
The void * points to an uninitialized storage area of requested size
207
(see savepoint_offset description)
209
int savepoint_set(Session *session, void *sp)
211
return savepoint_set_hook(session, (unsigned char *)sp+savepoint_offset);
215
The void * points to a storage area, that was earlier passed
216
to the savepoint_set call
218
int savepoint_rollback(Session *session, void *sp)
220
return savepoint_rollback_hook(session,
221
(unsigned char *)sp+savepoint_offset);
224
int savepoint_release(Session *session, void *sp)
226
return savepoint_release_hook(session,
227
(unsigned char *)sp+savepoint_offset);
230
virtual int prepare(Session *, bool) { return 0; }
231
virtual int recover(XID *, uint32_t) { return 0; }
232
virtual int commit_by_xid(XID *) { return 0; }
233
virtual int rollback_by_xid(XID *) { return 0; }
234
virtual handler *create(TableShare *, MEM_ROOT *)= 0;
236
virtual void drop_database(char*) { }
237
virtual int start_consistent_snapshot(Session *) { return 0; }
257
238
virtual bool flush_logs() { return false; }
258
239
virtual bool show_status(Session *, stat_print_fn *, enum ha_stat_type)
244
/* args: current_session, tables, cond */
245
virtual int fill_files_table(Session *, TableList *,
246
Item *) { return 0; }
247
virtual int release_temporary_latches(Session *) { return false; }
249
/* args: current_session, db, name */
250
virtual int table_exists_in_engine(Session*, const char *, const char *);
264
253
If frm_error() is called then we will use this to find out what file
265
254
extentions exist for the storage engine. This is also used by the default
266
rename_table and delete_table method in Cursor.cc.
255
rename_table and delete_table method in handler.cc.
268
257
For engines that have two file name extentions (separate meta/index file
269
258
and data file), the order of elements is relevant. First element of engine
274
263
virtual const char **bas_ext() const =0;
277
virtual int doCreateTable(Session &session,
279
const drizzled::TableIdentifier &identifier,
280
message::Table &message)= 0;
282
virtual int doRenameTable(Session &session,
283
const drizzled::TableIdentifier &from, const drizzled::TableIdentifier &to)= 0;
287
int renameTable(Session &session, const drizzled::TableIdentifier &from, const drizzled::TableIdentifier &to);
289
virtual void doGetTableIdentifiers(CachedDirectory &directory,
290
const drizzled::SchemaIdentifier &schema_identifier,
291
TableIdentifier::vector &set_of_identifiers)= 0;
293
virtual int doDropTable(Session &session,
294
const drizzled::TableIdentifier &identifier)= 0;
296
/* Class Methods for operating on plugin */
297
static bool addPlugin(plugin::StorageEngine *engine);
298
static void removePlugin(plugin::StorageEngine *engine);
300
static int getTableDefinition(Session& session,
301
const drizzled::TableIdentifier &identifier,
302
message::table::shared_ptr &table_proto,
303
bool include_temporary_tables= true);
304
static bool doesTableExist(Session &session,
305
const drizzled::TableIdentifier &identifier,
306
bool include_temporary_tables= true);
308
virtual bool doDoesTableExist(Session& session, const drizzled::TableIdentifier &identifier);
310
static plugin::StorageEngine *findByName(const std::string &find_str);
311
static plugin::StorageEngine *findByName(Session& session, const std::string &find_str);
313
static void closeConnection(Session* session);
314
static void dropDatabase(char* path);
315
static bool flushLogs(plugin::StorageEngine *db_type);
316
static int dropTable(Session& session,
317
const drizzled::TableIdentifier &identifier);
318
static int dropTable(Session& session,
319
StorageEngine &engine,
320
const drizzled::TableIdentifier &identifier);
321
static void getIdentifiers(Session &session,
322
const SchemaIdentifier &schema_identifier,
323
TableIdentifier::vector &set_of_identifiers);
325
// Check to see if any SE objects to creation.
326
static bool canCreateTable(const drizzled::TableIdentifier &identifier);
327
virtual bool doCanCreateTable(const drizzled::TableIdentifier &identifier)
328
{ (void)identifier; return true; }
330
// @note All schema methods defined here
331
static void getIdentifiers(Session &session, SchemaIdentifier::vector &schemas);
332
static bool getSchemaDefinition(const drizzled::TableIdentifier &identifier, message::schema::shared_ptr &proto);
333
static bool getSchemaDefinition(const drizzled::SchemaIdentifier &identifier, message::schema::shared_ptr &proto);
334
static bool doesSchemaExist(const drizzled::SchemaIdentifier &identifier);
335
static const CHARSET_INFO *getSchemaCollation(const drizzled::SchemaIdentifier &identifier);
336
static bool createSchema(const drizzled::message::Schema &schema_message);
337
static bool dropSchema(const drizzled::SchemaIdentifier &identifier);
338
static bool alterSchema(const drizzled::message::Schema &schema_message);
340
// @note make private/protected
341
virtual void doGetSchemaIdentifiers(SchemaIdentifier::vector&)
344
virtual bool doGetSchemaDefinition(const drizzled::SchemaIdentifier&, drizzled::message::schema::shared_ptr&)
349
virtual bool doCreateSchema(const drizzled::message::Schema&)
352
virtual bool doAlterSchema(const drizzled::message::Schema&)
355
virtual bool doDropSchema(const drizzled::SchemaIdentifier&)
358
static inline const std::string &resolveName(const StorageEngine *engine)
360
return engine == NULL ? UNKNOWN_STRING : engine->getName();
363
static int createTable(Session& session,
364
const drizzled::TableIdentifier &identifier,
365
message::Table& table_proto);
367
static void removeLostTemporaryTables(Session &session, const char *directory);
369
Cursor *getCursor(Table &share);
371
uint32_t max_record_length() const
372
{ return std::min((unsigned int)HA_MAX_REC_LENGTH, max_supported_record_length()); }
373
uint32_t max_keys() const
374
{ return std::min((unsigned int)MAX_KEY, max_supported_keys()); }
375
uint32_t max_key_parts() const
376
{ return std::min((unsigned int)MAX_REF_PARTS, max_supported_key_parts()); }
377
uint32_t max_key_length() const
378
{ return std::min((unsigned int)MAX_KEY_LENGTH, max_supported_key_length()); }
379
uint32_t max_key_part_length(void) const
380
{ return std::min((unsigned int)MAX_KEY_LENGTH, max_supported_key_part_length()); }
382
virtual uint32_t max_supported_record_length(void) const
383
{ return HA_MAX_REC_LENGTH; }
384
virtual uint32_t max_supported_keys(void) const { return 0; }
385
virtual uint32_t max_supported_key_parts(void) const { return MAX_REF_PARTS; }
386
virtual uint32_t max_supported_key_length(void) const { return MAX_KEY_LENGTH; }
387
virtual uint32_t max_supported_key_part_length(void) const { return 255; }
389
/* TODO-> Make private */
390
static int deleteDefinitionFromPath(const drizzled::TableIdentifier &identifier);
391
static int renameDefinitionFromPath(const drizzled::TableIdentifier &dest, const drizzled::TableIdentifier &src);
392
static int writeDefinitionFromPath(const drizzled::TableIdentifier &identifier, message::Table &proto);
393
static bool readTableFile(const std::string &path, message::Table &table_message);
397
* The below are simple virtual overrides for the plugin::MonitoredInTransaction
400
virtual bool participatesInSqlTransaction() const
402
return false; /* plugin::StorageEngine is non-transactional in terms of SQL */
404
virtual bool participatesInXaTransaction() const
406
return false; /* plugin::StorageEngine is non-transactional in terms of XA */
408
virtual bool alwaysRegisterForXaTransaction() const
413
virtual bool validateCreateTableOption(const std::string &key, const std::string &state)
421
virtual bool validateCreateSchemaOption(const std::string &key, const std::string &state)
266
virtual int createTableImpl(Session *session, const char *table_name,
268
HA_CREATE_INFO *create_info)= 0;
270
virtual int renameTableImpl(Session* session, const char *from, const char *to);
272
virtual int deleteTableImpl(Session* session, const std::string table_path);
275
int createTable(Session *session, const char *table_name, Table *table_arg,
276
HA_CREATE_INFO *create_info) {
277
setTransactionReadWrite(session);
279
return createTableImpl(session, table_name, table_arg, create_info);
282
int renameTable(Session *session, const char *from, const char *to) {
283
setTransactionReadWrite(session);
285
return renameTableImpl(session, from, to);
288
int deleteTable(Session* session, const std::string table_path) {
289
setTransactionReadWrite(session);
291
return deleteTableImpl(session, table_path);
430
} /* namespace plugin */
431
} /* namespace drizzled */
296
StorageEngine *ha_default_storage_engine(Session *session);
297
StorageEngine *ha_resolve_by_name(Session *session, const LEX_STRING *name);
298
handler *get_new_handler(TableShare *share, MEM_ROOT *alloc,
299
StorageEngine *db_type);
300
const std::string ha_resolve_storage_engine_name(const StorageEngine *db_type);
433
302
#endif /* DRIZZLED_PLUGIN_STORAGE_ENGINE_H */