← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/plugin/storage_engine.h

  • Committer: Mark Atwood
  • Date: 2008-10-16 11:33:16 UTC
  • mto: (520.1.13 drizzle)
  • mto: This revision was merged to the branch mainline in revision 530.
  • Revision ID: mark@fallenpegasus.com-20081016113316-ff6jdt31ck90sjdh
an implemention of the errmsg plugin

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/plugin/storage_engine.h
1
 
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
 
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
3
 
 *
4
 
 *  Copyright (C) 2008 Sun Microsystems, Inc.
5
 
 *
6
 
 *  This program is free software; you can redistribute it and/or modify
7
 
 *  it under the terms of the GNU General Public License as published by
8
 
 *  the Free Software Foundation; version 2 of the License.
9
 
 *
10
 
 *  This program is distributed in the hope that it will be useful,
11
 
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12
 
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
 
 *  GNU General Public License for more details.
14
 
 *
15
 
 *  You should have received a copy of the GNU General Public License
16
 
 *  along with this program; if not, write to the Free Software
17
 
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18
 
 */
19
 
 
20
 
#ifndef DRIZZLED_PLUGIN_STORAGE_ENGINE_H
21
 
#define DRIZZLED_PLUGIN_STORAGE_ENGINE_H
22
 
 
23
 
 
24
 
#include <drizzled/cached_directory.h>
25
 
#include <drizzled/definitions.h>
26
 
#include <drizzled/error_t.h>
27
 
#include <drizzled/handler_structs.h>
28
 
#include <drizzled/identifier.h>
29
 
#include <drizzled/message.h>
30
 
#include <drizzled/message/cache.h>
31
 
#include <drizzled/plugin.h>
32
 
#include <drizzled/plugin/monitored_in_transaction.h>
33
 
#include <drizzled/plugin/plugin.h>
34
 
#include <drizzled/sql_string.h>
35
 
 
36
 
#include <bitset>
37
 
#include <string>
38
 
#include <vector>
39
 
#include <set>
40
 
 
41
 
#include <drizzled/visibility.h>
42
 
 
43
 
namespace drizzled
44
 
{
45
 
 
46
 
class TableList;
47
 
class Session;
48
 
class Cursor;
49
 
typedef struct st_hash HASH;
50
 
 
51
 
class TableShare;
52
 
typedef bool (stat_print_fn)(Session *session, const char *type, uint32_t type_len,
53
 
                             const char *file, uint32_t file_len,
54
 
                             const char *status, uint32_t status_len);
55
 
 
56
 
/* Possible flags of a StorageEngine (there can be 32 of them) */
57
 
enum engine_flag_bits {
58
 
  HTON_BIT_ALTER_NOT_SUPPORTED,       // Engine does not support alter
59
 
  HTON_BIT_HIDDEN,                    // Engine does not appear in lists
60
 
  HTON_BIT_NOT_USER_SELECTABLE,
61
 
  HTON_BIT_TEMPORARY_NOT_SUPPORTED,   // Having temporary tables not supported
62
 
  HTON_BIT_TEMPORARY_ONLY,
63
 
  HTON_BIT_DOES_TRANSACTIONS,
64
 
  HTON_BIT_STATS_RECORDS_IS_EXACT,
65
 
  HTON_BIT_NULL_IN_KEY,
66
 
  HTON_BIT_CAN_INDEX_BLOBS,
67
 
  HTON_BIT_PRIMARY_KEY_IN_READ_INDEX,
68
 
  HTON_BIT_PARTIAL_COLUMN_READ,
69
 
  HTON_BIT_TABLE_SCAN_ON_INDEX,
70
 
  HTON_BIT_FAST_KEY_READ,
71
 
  HTON_BIT_NO_BLOBS,
72
 
  HTON_BIT_HAS_RECORDS,
73
 
  HTON_BIT_NO_AUTO_INCREMENT,
74
 
  HTON_BIT_DUPLICATE_POS,
75
 
  HTON_BIT_AUTO_PART_KEY,
76
 
  HTON_BIT_REQUIRE_PRIMARY_KEY,
77
 
  HTON_BIT_REQUIRES_KEY_COLUMNS_FOR_DELETE,
78
 
  HTON_BIT_PRIMARY_KEY_REQUIRED_FOR_DELETE,
79
 
  HTON_BIT_NO_PREFIX_CHAR_KEYS,
80
 
  HTON_BIT_HAS_CHECKSUM,
81
 
  HTON_BIT_SKIP_STORE_LOCK,
82
 
  HTON_BIT_SCHEMA_DICTIONARY,
83
 
  HTON_BIT_FOREIGN_KEYS,
84
 
  HTON_BIT_SIZE
85
 
};
86
 
 
87
 
static const std::bitset<HTON_BIT_SIZE> HTON_NO_FLAGS(0);
88
 
static const std::bitset<HTON_BIT_SIZE> HTON_ALTER_NOT_SUPPORTED(1 << HTON_BIT_ALTER_NOT_SUPPORTED);
89
 
static const std::bitset<HTON_BIT_SIZE> HTON_HIDDEN(1 << HTON_BIT_HIDDEN);
90
 
static const std::bitset<HTON_BIT_SIZE> HTON_NOT_USER_SELECTABLE(1 << HTON_BIT_NOT_USER_SELECTABLE);
91
 
static const std::bitset<HTON_BIT_SIZE> HTON_TEMPORARY_NOT_SUPPORTED(1 << HTON_BIT_TEMPORARY_NOT_SUPPORTED);
92
 
static const std::bitset<HTON_BIT_SIZE> HTON_TEMPORARY_ONLY(1 << HTON_BIT_TEMPORARY_ONLY);
93
 
static const std::bitset<HTON_BIT_SIZE> HTON_HAS_DOES_TRANSACTIONS(1 << HTON_BIT_DOES_TRANSACTIONS);
94
 
static const std::bitset<HTON_BIT_SIZE> HTON_STATS_RECORDS_IS_EXACT(1 << HTON_BIT_STATS_RECORDS_IS_EXACT);
95
 
static const std::bitset<HTON_BIT_SIZE> HTON_NULL_IN_KEY(1 << HTON_BIT_NULL_IN_KEY);
96
 
static const std::bitset<HTON_BIT_SIZE> HTON_CAN_INDEX_BLOBS(1 << HTON_BIT_CAN_INDEX_BLOBS);
97
 
static const std::bitset<HTON_BIT_SIZE> HTON_PRIMARY_KEY_IN_READ_INDEX(1 << HTON_BIT_PRIMARY_KEY_IN_READ_INDEX);
98
 
static const std::bitset<HTON_BIT_SIZE> HTON_PARTIAL_COLUMN_READ(1 << HTON_BIT_PARTIAL_COLUMN_READ);
99
 
static const std::bitset<HTON_BIT_SIZE> HTON_TABLE_SCAN_ON_INDEX(1 << HTON_BIT_TABLE_SCAN_ON_INDEX);
100
 
static const std::bitset<HTON_BIT_SIZE> HTON_FAST_KEY_READ(1 << HTON_BIT_FAST_KEY_READ);
101
 
static const std::bitset<HTON_BIT_SIZE> HTON_NO_BLOBS(1 << HTON_BIT_NO_BLOBS);
102
 
static const std::bitset<HTON_BIT_SIZE> HTON_HAS_RECORDS(1 << HTON_BIT_HAS_RECORDS);
103
 
static const std::bitset<HTON_BIT_SIZE> HTON_NO_AUTO_INCREMENT(1 << HTON_BIT_NO_AUTO_INCREMENT);
104
 
static const std::bitset<HTON_BIT_SIZE> HTON_DUPLICATE_POS(1 << HTON_BIT_DUPLICATE_POS);
105
 
static const std::bitset<HTON_BIT_SIZE> HTON_AUTO_PART_KEY(1 << HTON_BIT_AUTO_PART_KEY);
106
 
static const std::bitset<HTON_BIT_SIZE> HTON_REQUIRE_PRIMARY_KEY(1 << HTON_BIT_REQUIRE_PRIMARY_KEY);
107
 
static const std::bitset<HTON_BIT_SIZE> HTON_REQUIRES_KEY_COLUMNS_FOR_DELETE(1 << HTON_BIT_REQUIRES_KEY_COLUMNS_FOR_DELETE);
108
 
static const std::bitset<HTON_BIT_SIZE> HTON_PRIMARY_KEY_REQUIRED_FOR_DELETE(1 << HTON_BIT_PRIMARY_KEY_REQUIRED_FOR_DELETE);
109
 
static const std::bitset<HTON_BIT_SIZE> HTON_NO_PREFIX_CHAR_KEYS(1 << HTON_BIT_NO_PREFIX_CHAR_KEYS);
110
 
static const std::bitset<HTON_BIT_SIZE> HTON_HAS_CHECKSUM(1 << HTON_BIT_HAS_CHECKSUM);
111
 
static const std::bitset<HTON_BIT_SIZE> HTON_SKIP_STORE_LOCK(1 << HTON_BIT_SKIP_STORE_LOCK);
112
 
static const std::bitset<HTON_BIT_SIZE> HTON_HAS_SCHEMA_DICTIONARY(1 << HTON_BIT_SCHEMA_DICTIONARY);
113
 
static const std::bitset<HTON_BIT_SIZE> HTON_HAS_FOREIGN_KEYS(1 << HTON_BIT_FOREIGN_KEYS);
114
 
 
115
 
 
116
 
class Table;
117
 
class NamedSavepoint;
118
 
 
119
 
namespace plugin
120
 
{
121
 
 
122
 
typedef std::vector<StorageEngine *> EngineVector;
123
 
 
124
 
typedef std::set<std::string> TableNameList;
125
 
 
126
 
extern const std::string UNKNOWN_STRING;
127
 
extern DRIZZLED_API const std::string DEFAULT_DEFINITION_FILE_EXT;
128
 
 
129
 
 
130
 
/*
131
 
  StorageEngine is a singleton structure - one instance per storage engine -
132
 
  to provide access to storage engine functionality that works on the
133
 
  "global" level (unlike Cursor class that works on a per-table basis)
134
 
 
135
 
  usually StorageEngine instance is defined statically in ha_xxx.cc as
136
 
 
137
 
  static StorageEngine { ... } xxx_engine;
138
 
*/
139
 
class DRIZZLED_API StorageEngine :
140
 
  public Plugin,
141
 
  public MonitoredInTransaction
142
 
{
143
 
  friend class SEAPITester;
144
 
public:
145
 
  typedef uint64_t Table_flags;
146
 
 
147
 
private:
148
 
  static EngineVector &getSchemaEngines();
149
 
  const std::bitset<HTON_BIT_SIZE> flags; /* global Cursor flags */
150
 
 
151
 
 
152
 
  virtual void setTransactionReadWrite(Session& session);
153
 
 
154
 
  /*
155
 
   * Indicates to a storage engine the start of a
156
 
   * new SQL statement.
157
 
   */
158
 
  virtual void doStartStatement(Session *session)
159
 
  {
160
 
    (void) session;
161
 
  }
162
 
 
163
 
  /*
164
 
   * Indicates to a storage engine the end of
165
 
   * the current SQL statement in the supplied
166
 
   * Session.
167
 
   */
168
 
  virtual void doEndStatement(Session *session)
169
 
  {
170
 
    (void) session;
171
 
  }
172
 
 
173
 
protected:
174
 
  std::string table_definition_ext;
175
 
 
176
 
public:
177
 
  const std::string& getTableDefinitionFileExtension()
178
 
  {
179
 
    return table_definition_ext;
180
 
  }
181
 
 
182
 
private:
183
 
  std::vector<std::string> aliases;
184
 
 
185
 
public:
186
 
  const std::vector<std::string>& getAliases() const
187
 
  {
188
 
    return aliases;
189
 
  }
190
 
 
191
 
  void addAlias(std::string alias)
192
 
  {
193
 
    aliases.push_back(alias);
194
 
  }
195
 
 
196
 
protected:
197
 
 
198
 
  /**
199
 
    @brief
200
 
    Used as a protobuf storage currently by TEMP only engines.
201
 
  */
202
 
  typedef std::map <std::string, message::Table> ProtoCache;
203
 
  ProtoCache proto_cache;
204
 
  pthread_mutex_t proto_cache_mutex;
205
 
 
206
 
public:
207
 
  StorageEngine(const std::string name_arg,
208
 
                const std::bitset<HTON_BIT_SIZE> &flags_arg= HTON_NO_FLAGS);
209
 
 
210
 
  virtual ~StorageEngine();
211
 
 
212
 
protected:
213
 
  virtual int doGetTableDefinition(Session &session,
214
 
                                   const drizzled::identifier::Table &identifier,
215
 
                                   message::Table &table_message)
216
 
  {
217
 
    (void)session;
218
 
    (void)identifier;
219
 
    (void)table_message;
220
 
 
221
 
    return ENOENT;
222
 
  }
223
 
 
224
 
  /* Old style cursor errors */
225
 
  void print_keydup_error(uint32_t key_nr, const char *msg, const Table &table) const;
226
 
  virtual bool get_error_message(int error, String *buf) const;
227
 
 
228
 
public:
229
 
  virtual void print_error(int error, myf errflag, const Table& table) const;
230
 
 
231
 
  bool is_user_selectable() const
232
 
  {
233
 
    return not flags.test(HTON_BIT_NOT_USER_SELECTABLE);
234
 
  }
235
 
 
236
 
  bool check_flag(const engine_flag_bits flag) const
237
 
  {
238
 
    return flags.test(flag);
239
 
  }
240
 
 
241
 
  // @todo match check_flag interface
242
 
  virtual uint32_t index_flags(enum  ha_key_alg) const { return 0; }
243
 
  virtual void startStatement(Session *session)
244
 
  {
245
 
    doStartStatement(session);
246
 
  }
247
 
  virtual void endStatement(Session *session)
248
 
  {
249
 
    doEndStatement(session);
250
 
  }
251
 
 
252
 
  /*
253
 
   * Called during Session::cleanup() for all engines
254
 
   */
255
 
  virtual int close_connection(Session  *)
256
 
  {
257
 
    return 0;
258
 
  }
259
 
 
260
 
  virtual Cursor *create(Table &)= 0;
261
 
  /* args: path */
262
 
  virtual bool flush_logs() { return false; }
263
 
  virtual bool show_status(Session *, stat_print_fn *, enum ha_stat_type)
264
 
  {
265
 
    return false;
266
 
  }
267
 
 
268
 
  /**
269
 
    If frm_error() is called then we will use this to find out what file
270
 
    extentions exist for the storage engine. This is also used by the default
271
 
    rename_table and delete_table method in Cursor.cc.
272
 
 
273
 
    For engines that have two file name extentions (separate meta/index file
274
 
    and data file), the order of elements is relevant. First element of engine
275
 
    file name extentions array should be meta/index file extention. Second
276
 
    element - data file extention. This order is assumed by
277
 
    prepare_for_repair() when REPAIR Table ... USE_FRM is issued.
278
 
  */
279
 
  virtual const char **bas_ext() const =0;
280
 
 
281
 
protected:
282
 
  virtual int doCreateTable(Session &session,
283
 
                            Table &table_arg,
284
 
                            const drizzled::identifier::Table &identifier,
285
 
                            message::Table &message)= 0;
286
 
 
287
 
  virtual int doRenameTable(Session &session,
288
 
                            const drizzled::identifier::Table &from, const drizzled::identifier::Table &to)= 0;
289
 
 
290
 
  virtual int doDropTable(Session &session,
291
 
                          const drizzled::identifier::Table &identifier)= 0;
292
 
 
293
 
  virtual void doGetTableIdentifiers(CachedDirectory &directory,
294
 
                                     const drizzled::identifier::Schema &schema_identifier,
295
 
                                     identifier::Table::vector &set_of_identifiers)= 0;
296
 
 
297
 
  virtual bool doDoesTableExist(Session& session, const drizzled::identifier::Table &identifier);
298
 
 
299
 
  virtual bool doCanCreateTable(const drizzled::identifier::Table &identifier)
300
 
  { (void)identifier;  return true; }
301
 
 
302
 
public:
303
 
 
304
 
  friend class AddSchemaNames;
305
 
  friend class AddTableIdentifier;
306
 
  friend class AlterSchema;
307
 
  friend class CanCreateTable;
308
 
  friend class CreateSchema;
309
 
  friend class DropSchema;
310
 
  friend class DropTable;
311
 
  friend class DropTables;
312
 
  friend class FindEngineByName;
313
 
  friend class Ha_delete_table_error_handler;
314
 
  friend class StorageEngineCloseConnection;
315
 
  friend class StorageEngineDoesTableExist;
316
 
  friend class StorageEngineGetSchemaDefinition;
317
 
  friend class StorageEngineGetTableDefinition;
318
 
  friend class DropTableByIdentifier;
319
 
 
320
 
  int renameTable(Session &session, const drizzled::identifier::Table &from, const drizzled::identifier::Table &to);
321
 
 
322
 
  /* Class Methods for operating on plugin */
323
 
  static bool addPlugin(plugin::StorageEngine *engine);
324
 
  static void removePlugin(plugin::StorageEngine *engine);
325
 
 
326
 
  static message::table::shared_ptr getTableMessage(Session& session,
327
 
                                                    const drizzled::identifier::Table &identifier,
328
 
                                                    bool include_temporary_tables= true);
329
 
  static bool doesTableExist(Session &session,
330
 
                             const drizzled::identifier::Table &identifier,
331
 
                             bool include_temporary_tables= true);
332
 
 
333
 
  static plugin::StorageEngine *findByName(const std::string &find_str);
334
 
  static plugin::StorageEngine *findByName(Session& session, const std::string &find_str);
335
 
 
336
 
  static void closeConnection(Session* session);
337
 
  static void dropDatabase(char* path);
338
 
  static bool flushLogs(plugin::StorageEngine *db_type);
339
 
 
340
 
  static bool dropTable(Session& session,
341
 
                        const drizzled::identifier::Table &identifier);
342
 
  static bool dropTable(Session& session,
343
 
                        const drizzled::identifier::Table &identifier,
344
 
                        drizzled::error_t &error);
345
 
 
346
 
  static bool dropTable(Session& session,
347
 
                        StorageEngine &engine,
348
 
                        identifier::Table::const_reference identifier,
349
 
                        drizzled::error_t &error);
350
 
 
351
 
  static void getIdentifiers(Session &session,
352
 
                             const identifier::Schema &schema_identifier,
353
 
                             identifier::Table::vector &set_of_identifiers);
354
 
 
355
 
  // Check to see if any SE objects to creation.
356
 
  static bool canCreateTable(const drizzled::identifier::Table &identifier);
357
 
 
358
 
  // @note All schema methods defined here
359
 
  static void getIdentifiers(Session &session, identifier::Schema::vector &schemas);
360
 
  static message::schema::shared_ptr getSchemaDefinition(const drizzled::identifier::Table &identifier);
361
 
  static message::schema::shared_ptr getSchemaDefinition(const drizzled::identifier::Schema &identifier);
362
 
  static bool doesSchemaExist(const drizzled::identifier::Schema &identifier);
363
 
  static const CHARSET_INFO *getSchemaCollation(const drizzled::identifier::Schema &identifier);
364
 
  static bool createSchema(const drizzled::message::Schema &schema_message);
365
 
  static bool dropSchema(Session &session,
366
 
                         identifier::Schema::const_reference identifier,
367
 
                         message::schema::const_reference schema_message);
368
 
  static bool alterSchema(const drizzled::message::Schema &schema_message);
369
 
 
370
 
  // @note make private/protected
371
 
protected:
372
 
  virtual void doGetSchemaIdentifiers(identifier::Schema::vector&)
373
 
  { }
374
 
 
375
 
  virtual drizzled::message::schema::shared_ptr doGetSchemaDefinition(const drizzled::identifier::Schema&)
376
 
  { 
377
 
    return drizzled::message::schema::shared_ptr(); 
378
 
  }
379
 
 
380
 
  virtual bool doCreateSchema(const drizzled::message::Schema&)
381
 
  { return false; }
382
 
 
383
 
  virtual bool doAlterSchema(const drizzled::message::Schema&)
384
 
  { return false; }
385
 
 
386
 
  virtual bool doDropSchema(const drizzled::identifier::Schema&)
387
 
  { return false; }
388
 
 
389
 
public:
390
 
  static inline const std::string &resolveName(const StorageEngine *engine)
391
 
  {
392
 
    return engine == NULL ? UNKNOWN_STRING : engine->getName();
393
 
  }
394
 
 
395
 
  static bool createTable(Session &session,
396
 
                          const identifier::Table &identifier,
397
 
                          message::Table& table_message);
398
 
 
399
 
  static void removeLostTemporaryTables(Session &session, const char *directory);
400
 
 
401
 
  Cursor *getCursor(Table &share);
402
 
 
403
 
  uint32_t max_record_length() const
404
 
  { return std::min(HA_MAX_REC_LENGTH, max_supported_record_length()); }
405
 
  uint32_t max_keys() const
406
 
  { return std::min(MAX_KEY, max_supported_keys()); }
407
 
  uint32_t max_key_parts() const
408
 
  { return std::min(MAX_REF_PARTS, max_supported_key_parts()); }
409
 
  uint32_t max_key_length() const
410
 
  { return std::min(MAX_KEY_LENGTH, max_supported_key_length()); }
411
 
  uint32_t max_key_part_length(void) const
412
 
  { return std::min(MAX_KEY_LENGTH, max_supported_key_part_length()); }
413
 
 
414
 
  virtual uint32_t max_supported_record_length(void) const
415
 
  { return HA_MAX_REC_LENGTH; }
416
 
  virtual uint32_t max_supported_keys(void) const { return 0; }
417
 
  virtual uint32_t max_supported_key_parts(void) const { return MAX_REF_PARTS; }
418
 
  virtual uint32_t max_supported_key_length(void) const { return MAX_KEY_LENGTH; }
419
 
  virtual uint32_t max_supported_key_part_length(void) const { return 255; }
420
 
 
421
 
  /* TODO-> Make private */
422
 
protected:
423
 
  static int deleteDefinitionFromPath(const drizzled::identifier::Table &identifier);
424
 
  static int renameDefinitionFromPath(const drizzled::identifier::Table &dest, const drizzled::identifier::Table &src);
425
 
  static int writeDefinitionFromPath(const drizzled::identifier::Table &identifier, message::Table &proto);
426
 
  static bool readTableFile(const std::string &path, message::Table &table_message);
427
 
 
428
 
public:
429
 
  /* 
430
 
   * The below are simple virtual overrides for the plugin::MonitoredInTransaction
431
 
   * interface.
432
 
   */
433
 
  virtual bool participatesInSqlTransaction() const
434
 
  {
435
 
    return false; /* plugin::StorageEngine is non-transactional in terms of SQL */
436
 
  }
437
 
  virtual bool participatesInXaTransaction() const
438
 
  {
439
 
    return false; /* plugin::StorageEngine is non-transactional in terms of XA */
440
 
  }
441
 
  virtual bool alwaysRegisterForXaTransaction() const
442
 
  {
443
 
    return false;
444
 
  }
445
 
 
446
 
  virtual bool validateCreateTableOption(const std::string &key, const std::string &state)
447
 
  {
448
 
    (void)key;
449
 
    (void)state;
450
 
 
451
 
    return false;
452
 
  }
453
 
 
454
 
  virtual bool validateCreateSchemaOption(const std::string &key, const std::string &state)
455
 
  {
456
 
    (void)key;
457
 
    (void)state;
458
 
 
459
 
    return false;
460
 
  }
461
 
};
462
 
 
463
 
std::ostream& operator<<(std::ostream& output, const StorageEngine &engine);
464
 
 
465
 
} /* namespace plugin */
466
 
} /* namespace drizzled */
467
 
 
468
 
#endif /* DRIZZLED_PLUGIN_STORAGE_ENGINE_H */