23
23
instance of table share per one table in the database.
26
#ifndef DRIZZLED_TABLE_INSTANCE_BASE_H
27
#define DRIZZLED_TABLE_INSTANCE_BASE_H
26
#ifndef DRIZZLED_TABLE_SHARE_H
27
#define DRIZZLED_TABLE_SHARE_H
31
#include <boost/unordered_map.hpp>
32
#include <boost/thread/condition_variable.hpp>
33
#include <boost/dynamic_bitset.hpp>
34
#include <boost/shared_ptr.hpp>
35
#include <boost/scoped_ptr.hpp>
37
31
#include "drizzled/typelib.h"
32
#include "drizzled/my_hash.h"
38
33
#include "drizzled/memory/root.h"
39
#include "drizzled/message.h"
40
#include "drizzled/util/string.h"
42
#include "drizzled/lex_string.h"
43
#include "drizzled/key_map.h"
45
#include "drizzled/table/cache.h"
47
#include <drizzled/field.h>
53
const static std::string NO_PROTOBUFFER_AVAILABLE("NO PROTOBUFFER AVAILABLE");
57
class EventObserverList;
34
#include "drizzled/message/table.pb.h"
69
typedef std::vector<std::string> StringVector;
72
typedef boost::shared_ptr<TableShare> shared_ptr;
73
typedef std::vector <shared_ptr> vector;
75
TableShare(const identifier::Table::Type type_arg);
77
TableShare(const identifier::Table &identifier, const identifier::Table::Key &key); // Used by placeholder
79
TableShare(const identifier::Table &identifier); // Just used during createTable()
81
TableShare(const identifier::Table::Type type_arg,
82
const identifier::Table &identifier,
83
char *path_arg= NULL, uint32_t path_length_arg= 0); // Shares for cache
85
virtual ~TableShare();
40
table_category(TABLE_UNKNOWN_CATEGORY),
43
found_next_number_field(NULL),
44
timestamp_field(NULL),
54
row_type(ROW_TYPE_DEFAULT),
58
tmp_table(NO_TMP_TABLE),
72
timestamp_field_offset(0),
77
rowid_field_offset(0),
80
next_number_key_offset(0),
81
next_number_keypart(0),
85
column_bitmap_size(0),
87
db_low_byte_first(false),
89
replace_with_name_lock(false),
90
waiting_on_cond(false),
97
TableShare(const char *key,
99
const char *new_table_name,
100
const char *new_path) :
101
table_category(TABLE_UNKNOWN_CATEGORY),
104
found_next_number_field(NULL),
105
timestamp_field(NULL),
109
default_values(NULL),
114
stored_rec_length(0),
115
row_type(ROW_TYPE_DEFAULT),
118
storage_engine(NULL),
119
tmp_table(NO_TMP_TABLE),
122
last_null_bit_pos(0),
128
max_unique_length(0),
133
timestamp_field_offset(0),
135
db_create_options(0),
136
db_options_in_use(0),
138
rowid_field_offset(0),
140
next_number_index(0),
141
next_number_key_offset(0),
142
next_number_keypart(0),
146
column_bitmap_size(0),
148
db_low_byte_first(false),
150
replace_with_name_lock(false),
151
waiting_on_cond(false),
155
init(key, key_length, new_table_name, new_path);
88
158
/** Category of this table. */
89
159
enum_table_category table_category;
92
bool isTemporaryCategory() const
94
return (table_category == TABLE_CATEGORY_TEMPORARY);
97
void setTableCategory(enum_table_category arg)
161
uint32_t open_count; /* Number of tables in open list */
102
163
/* The following is copied to each Table on OPEN */
103
typedef std::vector<Field *> Fields;
109
const Fields getFields() const
119
Field ** getFields(bool)
124
void setFields(uint32_t arg)
129
uint32_t positionFields(Field **arg) const
131
return (arg - (Field **)&_fields[0]);
134
void pushField(Field *arg)
137
_fields.push_back(arg);
140
165
Field **found_next_number_field;
143
166
Field *timestamp_field; /* Used only during open */
147
Field *getTimestampField() const /* Used only during open */
149
return timestamp_field;
152
void setTimestampField(Field *arg) /* Used only during open */
154
timestamp_field= arg;
159
KeyInfo *key_info; /* data of keys in database */
162
KeyInfo &getKeyInfo(uint32_t arg) const
164
return key_info[arg];
166
std::vector<uint> blob_field; /* Index to blobs in Field arrray*/
167
KEY *key_info; /* data of keys in database */
168
uint *blob_field; /* Index to blobs in Field arrray*/
169
170
/* hash of field names (contains pointers to elements of field array) */
170
typedef boost::unordered_map < std::string, Field **, util::insensitive_hash, util::insensitive_equal_to> FieldMap;
171
typedef std::pair< std::string, Field ** > FieldMapPair;
172
FieldMap name_hash; /* hash of field names */
175
size_t getNamedFieldSize() const
177
return name_hash.size();
180
Field **getNamedField(const std::string &arg)
182
FieldMap::iterator iter= name_hash.find(arg);
184
if (iter == name_hash.end())
187
return (*iter).second;
191
memory::Root mem_root;
193
void *alloc_root(size_t arg)
195
return mem_root.alloc_root(arg);
198
char *strmake_root(const char *str_arg, size_t len_arg)
200
return mem_root.strmake_root(str_arg, len_arg);
203
memory::Root *getMemRoot()
208
std::vector<std::string> _keynames;
210
void addKeyName(std::string arg)
212
std::transform(arg.begin(), arg.end(),
213
arg.begin(), ::toupper);
214
_keynames.push_back(arg);
218
bool doesKeyNameExist(const char *name_arg, uint32_t name_length, uint32_t &position) const
220
return doesKeyNameExist(std::string(name_arg, name_length), position);
223
bool doesKeyNameExist(std::string arg, uint32_t &position) const
225
std::transform(arg.begin(), arg.end(),
226
arg.begin(), ::toupper);
228
std::vector<std::string>::const_iterator iter= std::find(_keynames.begin(), _keynames.end(), arg);
230
if (iter == _keynames.end())
232
position= UINT32_MAX; //historical, required for finding primary key from unique
236
position= iter - _keynames.begin();
242
std::vector<TYPELIB> intervals; /* pointer to interval info */
248
virtual void unlock()
252
std::vector<unsigned char> default_values; /* row with default values */
255
// @note This needs to be made to be const in the future
256
unsigned char *getDefaultValues()
258
return &default_values[0];
260
void resizeDefaultValues(size_t arg)
262
default_values.resize(arg);
265
const charset_info_st *table_charset; /* Default charset of string fields */
267
boost::dynamic_bitset<> all_set;
171
HASH name_hash; /* hash of field names */
172
drizzled::memory::Root mem_root;
173
TYPELIB keynames; /* Pointers to keynames */
174
TYPELIB fieldnames; /* Pointer to fieldnames */
175
TYPELIB *intervals; /* pointer to interval info */
176
pthread_mutex_t mutex; /* For locking the share */
177
pthread_cond_t cond; /* To signal that share is ready */
179
unsigned char *default_values; /* row with default values */
180
const CHARSET_INFO *table_charset; /* Default charset of string fields */
270
184
Key which is used for looking-up table in table cache and in the list
271
185
of thread's temporary tables. Has the form of:
276
190
should correspond to each other.
277
191
To ensure this one can use set_table_cache() methods.
280
identifier::Table::Key private_key_for_cache; // This will not exist in the final design.
281
std::vector<char> private_normalized_path; // This will not exist in the final design.
193
LEX_STRING table_cache_key;
282
194
LEX_STRING db; /* Pointer to db */
283
195
LEX_STRING table_name; /* Table name (for open) */
284
LEX_STRING path; /* Path to table (from datadir) */
196
LEX_STRING path; /* Path to .frm file (from datadir) */
285
197
LEX_STRING normalized_path; /* unpack_filename(path) */
289
const char *getNormalizedPath() const
291
return normalized_path.str;
294
const char *getPath() const
299
const identifier::Table::Key& getCacheKey() const // This should never be called when we aren't looking at a cache.
301
assert(private_key_for_cache.size());
302
return private_key_for_cache;
305
size_t getCacheKeySize() const
307
return private_key_for_cache.size();
311
void setPath(char *str_arg, uint32_t size_arg)
314
path.length= size_arg;
317
void setNormalizedPath(char *str_arg, uint32_t size_arg)
319
normalized_path.str= str_arg;
320
normalized_path.length= size_arg;
325
const char *getTableName() const
327
return table_name.str;
330
uint32_t getTableNameSize() const
332
return table_name.length;
335
const std::string &getTableName(std::string &name_arg) const
338
name_arg.append(table_name.str, table_name.length);
343
const char *getSchemaName() const
348
const std::string &getSchemaName(std::string &schema_name_arg) const
350
schema_name_arg.clear();
351
schema_name_arg.append(db.str, db.length);
353
return schema_name_arg;
356
199
uint32_t block_size; /* create information */
359
200
uint64_t version;
362
uint64_t getVersion() const
367
void refreshVersion();
375
201
uint32_t timestamp_offset; /* Set to offset+1 of record */
377
uint32_t reclength; /* Recordlength */
378
uint32_t stored_rec_length; /* Stored record length*/
381
uint32_t sizeStoredRecord() const
383
return stored_rec_length;
386
uint32_t getRecordLength() const
391
void setRecordLength(uint32_t arg)
396
const Field_blob *getBlobFieldAt(uint32_t arg) const
398
if (arg < blob_fields)
399
return (Field_blob*) _fields[blob_field[arg]];
202
uint32_t reclength; /* Recordlength */
203
uint32_t stored_rec_length; /* Stored record length*/
204
enum row_type row_type; /* How rows are stored */
405
207
/* Max rows is a hint to HEAP during a create tmp table */
406
208
uint64_t max_rows;
408
boost::scoped_ptr<message::Table> _table_message;
210
drizzled::message::Table *table_proto;
412
@note Without a _table_message, we assume we are building a STANDARD table.
413
This will be modified once we use Identifiers in the Share itself.
415
message::Table::TableType getTableType() const
417
return getTableMessage() ? getTableMessage()->type() : message::Table::STANDARD;
420
const std::string &getTableTypeAsString() const
422
if (getTableMessage())
423
return message::type(getTableMessage()->type());
425
return NO_PROTOBUFFER_AVAILABLE;
428
213
/* This is only used in one location currently */
429
inline message::Table *getTableMessage() const
431
return _table_message.get();
434
void setTableMessage(const message::Table &arg)
436
assert(not getTableMessage());
437
_table_message.reset(new(std::nothrow) message::Table(arg));
440
const message::Table::Field &field(int32_t field_position) const
442
assert(getTableMessage());
443
return getTableMessage()->field(field_position);
446
inline bool hasComment() const
448
return (getTableMessage()) ? getTableMessage()->options().has_comment() : false;
214
inline void setTableProto(drizzled::message::Table *arg)
216
assert(table_proto == NULL);
220
inline bool hasComment()
222
return (table_proto) ? table_proto->options().has_comment() : false;
451
225
inline const char *getComment()
453
return (getTableMessage() && getTableMessage()->has_options()) ? getTableMessage()->options().comment().c_str() : NULL;
456
inline uint32_t getCommentLength() const
458
return (getTableMessage()) ? getTableMessage()->options().comment().length() : 0;
461
inline uint64_t getMaxRows() const
227
return (table_proto && table_proto->has_options()) ? table_proto->options().comment().c_str() : NULL;
230
inline uint32_t getCommentLength()
232
return (table_proto) ? table_proto->options().comment().length() : 0;
235
inline bool hasKeyBlockSize()
237
return (table_proto) ? table_proto->options().has_key_block_size() : false;
240
inline uint32_t getKeyBlockSize()
242
return (table_proto) ? table_proto->options().key_block_size() : 0;
245
inline uint64_t getMaxRows()
472
* Returns true if the supplied Field object
473
* is part of the table's primary key.
475
bool fieldInPrimaryKey(Field *field) const;
477
plugin::StorageEngine *storage_engine; /* storage engine plugin */
478
inline plugin::StorageEngine *db_type() const /* table_type for handler */
480
return storage_engine;
482
inline plugin::StorageEngine *getEngine() const /* table_type for handler */
484
return storage_engine;
488
identifier::Table::Type tmp_table;
491
identifier::Table::Type getType() const
497
uint32_t _ref_count; /* How many Table objects uses this */
500
uint32_t getTableCount() const
505
void incrementTableCount()
512
uint32_t decrementTableCount()
255
drizzled::plugin::StorageEngine *storage_engine; /* storage engine plugin */
256
inline drizzled::plugin::StorageEngine *db_type() const /* table_type for handler */
258
return storage_engine;
260
inline drizzled::plugin::StorageEngine *getEngine() const /* table_type for handler */
262
return storage_engine;
264
enum tmp_table_type tmp_table;
266
uint32_t ref_count; /* How many Table objects uses this */
517
267
uint32_t null_bytes;
518
268
uint32_t last_null_bit_pos;
520
uint32_t _field_size; /* Number of fields */
523
void setFieldSize(uint32_t arg)
528
uint32_t sizeFields() const
269
uint32_t fields; /* Number of fields */
533
270
uint32_t rec_buff_length; /* Size of table->record[] buffer */
536
uint32_t sizeKeys() const
271
uint32_t keys, key_parts;
541
272
uint32_t max_key_length, max_unique_length, total_key_length;
542
273
uint32_t uniques; /* Number of UNIQUE index */
543
274
uint32_t null_fields; /* number of null fields */
544
275
uint32_t blob_fields; /* number of blob fields */
546
bool has_variable_width; /* number of varchar fields */
549
bool hasVariableWidth() const
551
return has_variable_width; // We should calculate this.
553
void setVariableWidth()
555
has_variable_width= true;
276
uint32_t timestamp_field_offset; /* Field number for timestamp field */
277
uint32_t varchar_fields; /* number of varchar fields */
557
278
uint32_t db_create_options; /* Create options from database */
558
279
uint32_t db_options_in_use; /* Options in use */
559
280
uint32_t db_record_offset; /* if HA_REC_IN_SEQ */
605
309
key_map keys_in_use;
606
310
key_map keys_for_keyread;
609
event_observers is a class containing all the event plugins that have
610
registered an interest in this table.
612
virtual plugin::EventObserverList *getTableObservers()
617
virtual void setTableObservers(plugin::EventObserverList *)
621
Set share's identifier information.
313
Set share's table cache key and update its db and table name appropriately.
316
set_table_cache_key()
317
key_buff Buffer with already built table cache key to be
318
referenced from share.
319
key_length Key length.
629
void setIdentifier(const identifier::Table &identifier_arg);
322
Since 'key_buff' buffer will be referenced from share it should has same
323
life-time as share itself.
324
This method automatically ensures that TableShare::table_name/db have
325
appropriate values by using table cache key as their source.
328
void set_table_cache_key(char *key_buff, uint32_t key_length)
330
table_cache_key.str= key_buff;
331
table_cache_key.length= key_length;
333
Let us use the fact that the key is "db/0/table_name/0" + optional
334
part for temporary tables.
336
db.str= table_cache_key.str;
337
db.length= strlen(db.str);
338
table_name.str= db.str + db.length + 1;
339
table_name.length= strlen(table_name.str);
344
Set share's table cache key and update its db and table name appropriately.
347
set_table_cache_key()
348
key_buff Buffer to be used as storage for table cache key
349
(should be at least key_length bytes).
350
key Value for table cache key.
351
key_length Key length.
354
Since 'key_buff' buffer will be used as storage for table cache key
355
it should has same life-time as share itself.
358
void set_table_cache_key(char *key_buff, const char *key, uint32_t key_length)
360
memcpy(key_buff, key, key_length);
361
set_table_cache_key(key_buff, key_length);
364
inline bool honor_global_locks()
366
return (table_category == TABLE_CATEGORY_USER);
632
371
Initialize share for temporary tables
638
377
must start with db name.
639
378
key_length Length of key
640
379
table_name Table name
641
path Path to table (possible in lower case)
380
path Path to file (possible in lower case) without .frm
383
This is different from alloc_table_share() because temporary tables
384
don't have to be shared between threads or put into the table def
385
cache, so we can do some things notable simpler and faster
387
If table is not put in session->temporary_tables (happens only when
388
one uses OPEN TEMPORARY) then one can specify 'db' as key and
389
use key_length= 0 as neither table_cache_key or key_length will be used).
648
397
void init(const char *new_table_name,
649
const char *new_path);
398
const char *new_path)
400
init("", 0, new_table_name, new_path);
403
void init(const char *key,
404
uint32_t key_length, const char *new_table_name,
405
const char *new_path)
407
memset(this, 0, sizeof(TableShare));
408
init_sql_alloc(&mem_root, TABLE_ALLOC_BLOCK_SIZE, 0);
409
table_category= TABLE_CATEGORY_TEMPORARY;
410
tmp_table= INTERNAL_TMP_TABLE;
412
db.length= strlen(key);
413
table_cache_key.str= (char*) key;
414
table_cache_key.length= key_length;
415
table_name.str= (char*) new_table_name;
416
table_name.length= strlen(new_table_name);
417
path.str= (char*) new_path;
418
normalized_path.str= (char*) new_path;
419
path.length= normalized_path.length= strlen(new_path);
425
Free table share and memory used by it
432
share->mutex must be locked when we come here if it's not a temp table
435
void free_table_share()
437
drizzled::memory::Root new_mem_root;
438
assert(ref_count == 0);
441
If someone is waiting for this to be deleted, inform it about this.
442
Don't do a delete until we know that no one is refering to this anymore.
444
if (tmp_table == NO_TMP_TABLE)
446
/* share->mutex is locked in release_table_share() */
447
while (waiting_on_cond)
449
pthread_cond_broadcast(&cond);
450
pthread_cond_wait(&cond, &mutex);
452
/* No thread refers to this anymore */
453
pthread_mutex_unlock(&mutex);
454
pthread_mutex_destroy(&mutex);
455
pthread_cond_destroy(&cond);
457
hash_free(&name_hash);
459
storage_engine= NULL;
464
/* We must copy mem_root from share because share is allocated through it */
465
memcpy(&new_mem_root, &mem_root, sizeof(new_mem_root));
466
free_root(&new_mem_root, MYF(0)); // Free's share
652
469
void open_table_error(int pass_error, int db_errno, int pass_errarg);
656
static TableShare::shared_ptr getShareCreate(Session *session,
657
const identifier::Table &identifier,
660
friend std::ostream& operator<<(std::ostream& output, const TableShare &share)
662
output << "TableShare:(";
663
output << share.getSchemaName();
665
output << share.getTableName();
667
output << share.getTableTypeAsString();
669
output << share.getPath();
672
return output; // for multiple << operators.
676
friend class drizzled::table::Singular;
678
Field *make_field(const message::Table::Field &pfield,
680
uint32_t field_length,
682
unsigned char *null_pos,
683
unsigned char null_bit,
685
enum_field_types field_type,
686
const charset_info_st * field_charset,
687
Field::utype unireg_check,
689
const char *field_name);
691
Field *make_field(const message::Table::Field &pfield,
693
uint32_t field_length,
695
unsigned char *null_pos,
696
unsigned char null_bit,
698
enum_field_types field_type,
699
const charset_info_st * field_charset,
700
Field::utype unireg_check,
702
const char *field_name,
706
int open_table_def(Session& session, const identifier::Table &identifier);
708
int open_table_from_share(Session *session,
709
const identifier::Table &identifier,
711
uint32_t db_stat, uint32_t ha_open_flags,
714
int open_table_from_share_inner(Session *session,
718
int open_table_cursor_inner(const identifier::Table &identifier,
719
uint32_t db_stat, uint32_t ha_open_flags,
721
bool &error_reported);
723
bool parse_table_proto(Session& session, message::Table &table);
474
Create a table cache key
478
key Create key here (must be of size MAX_DBKEY_LENGTH)
479
table_list Table definition
482
The table cache_key is created from:
486
if the table is a tmp table, we add the following to make each tmp table
489
4 bytes for master thread id
490
4 bytes pseudo thread id
496
static inline uint32_t createKey(char *key, std::string& db_arg,
497
std::string& table_name_arg)
499
return createKey(key, db_arg.c_str(), table_name_arg.c_str());
502
static inline uint32_t createKey(char *key, const char *db_arg, const char *table_name_arg)
507
key_pos= strcpy(key_pos, db_arg) + strlen(db_arg);
508
key_pos= strcpy(key_pos+1, table_name_arg) +
509
strlen(table_name_arg);
510
key_length= (uint32_t)(key_pos-key)+1;
515
static void cacheStart(void);
516
static void cacheStop(void);
517
static void release(TableShare *share);
518
static void release(const char *key, uint32_t key_length);
519
static TableShare *getShare(const char *db, const char *table_name);
520
static TableShare *getShare(Session *session,
521
TableList *table_list, char *key,
522
uint32_t key_length, uint32_t, int *error);
726
} /* namespace drizzled */
728
#endif /* DRIZZLED_TABLE_INSTANCE_BASE_H */
525
#endif /* DRIZZLED_TABLE_SHARE_H */