11
11
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
13
13
You should have received a copy of the GNU General Public License along with
14
this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
15
St, Fifth Floor, Boston, MA 02110-1301 USA
14
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
15
Place, Suite 330, Boston, MA 02111-1307 USA
17
17
*****************************************************************************/
20
20
This file is based on ha_berkeley.h of MySQL distribution
22
This file defines the Innodb Cursor: the interface between MySQL and
22
This file defines the Innodb handler: the interface between MySQL and
26
26
#ifndef INNODB_HANDLER_HA_INNODB_H
27
27
#define INNODB_HANDLER_HA_INNODB_H
29
#include <drizzled/cursor.h>
30
#include <drizzled/thr_lock.h>
31
#include <drizzled/plugin/transactional_storage_engine.h>
33
using namespace drizzled;
35
/* Structure defines translation table between mysql index and innodb
37
typedef struct innodb_idx_translate_struct {
38
ulint index_count; /*!< number of valid index entries
39
in the index_mapping array */
40
ulint array_size; /*!< array size of index_mapping */
41
dict_index_t** index_mapping; /*!< index pointer array directly
42
maps to index in Innodb from MySQL
44
} innodb_idx_translate_t;
46
/** InnoDB table share */
29
#include <drizzled/handler.h>
30
#include <mysys/thr_lock.h>
32
#ifdef USE_PRAGMA_INTERFACE
33
#pragma interface /* gcc class implementation */
47
36
typedef struct st_innobase_share {
48
THR_LOCK lock; /*!< MySQL lock protecting
50
char table_name[FN_REFLEN]; /*!< InnoDB table name */
51
uint use_count; /*!< reference count,
52
incremented in get_share()
53
and decremented in free_share() */
54
void* table_name_hash;/*!< hash table chain node */
55
innodb_idx_translate_t idx_trans_tbl; /*!< index translation
56
table between MySQL and
59
st_innobase_share(const char *arg) :
62
strncpy(table_name, arg, FN_REFLEN);
38
pthread_mutex_t mutex;
39
const char* table_name;
41
void* table_name_hash;
68
/** InnoDB B-tree index */
69
45
struct dict_index_struct;
70
/** Prebuilt structures in an Innobase table handle used within MySQL */
71
46
struct row_prebuilt_struct;
73
/** InnoDB B-tree index */
74
48
typedef struct dict_index_struct dict_index_t;
75
/** Prebuilt structures in an Innobase table handle used within MySQL */
76
49
typedef struct row_prebuilt_struct row_prebuilt_t;
78
/** The class defining a handle to an Innodb table */
79
class ha_innobase: public Cursor
51
/* The class defining a handle to an Innodb table */
52
class ha_innobase: public handler
81
row_prebuilt_t* prebuilt; /*!< prebuilt struct in InnoDB, used
54
row_prebuilt_t* prebuilt; /* prebuilt struct in InnoDB, used
82
55
to save CPU time with prebuilt data
84
Session* user_session; /*!< the thread handle of the user
57
Session* user_session; /* the thread handle of the user
85
58
currently using the handle; this is
86
59
set in external_lock function */
87
60
THR_LOCK_DATA lock;
88
INNOBASE_SHARE* share; /*!< information for MySQL
61
INNOBASE_SHARE *share;
91
std::vector<unsigned char> upd_buff; /*!< buffer used in updates */
92
std::vector<unsigned char> key_val_buff; /*!< buffer used in converting
93
search key values from MySQL format
63
unsigned char* upd_buff; /* buffer used in updates */
64
unsigned char* key_val_buff; /* buffer used in converting
65
search key values from MySQL format
95
67
ulong upd_and_key_val_buff_len;
96
68
/* the length of each of the previous
70
Table_flags int_table_flags;
99
ulong start_of_scan; /*!< this is set to 1 when we are
72
ulong start_of_scan; /* this is set to 1 when we are
100
73
starting a table scan but have not
101
74
yet fetched any row, else 0 */
102
75
uint last_match_mode;/* match mode of the latest search:
103
76
ROW_SEL_EXACT, ROW_SEL_EXACT_PREFIX,
105
uint num_write_row; /*!< number of doInsertRecord() calls */
78
uint num_write_row; /* number of write_row() calls */
107
UNIV_INTERN uint store_key_val_for_row(uint keynr, char* buff,
108
uint buff_len, const unsigned char* record);
109
UNIV_INTERN void update_session(Session* session);
110
UNIV_INTERN int change_active_index(uint32_t keynr);
111
UNIV_INTERN int general_fetch(unsigned char* buf, uint32_t direction, uint32_t match_mode);
112
UNIV_INTERN ulint innobase_lock_autoinc();
113
UNIV_INTERN uint64_t innobase_peek_autoinc();
114
UNIV_INTERN ulint innobase_set_max_autoinc(uint64_t auto_inc);
115
UNIV_INTERN ulint innobase_reset_autoinc(uint64_t auto_inc);
116
UNIV_INTERN ulint innobase_get_autoinc(uint64_t* value);
80
uint store_key_val_for_row(uint keynr, char* buff, uint buff_len,
81
const unsigned char* record);
82
void update_session(Session* session);
83
void update_session();
84
int change_active_index(uint32_t keynr);
85
int general_fetch(unsigned char* buf, uint32_t direction, uint32_t match_mode);
86
ulint innobase_lock_autoinc();
87
uint64_t innobase_peek_autoinc();
88
ulint innobase_set_max_autoinc(uint64_t auto_inc);
89
ulint innobase_reset_autoinc(uint64_t auto_inc);
90
ulint innobase_get_autoinc(uint64_t* value);
117
91
ulint innobase_update_autoinc(uint64_t auto_inc);
118
UNIV_INTERN void innobase_initialize_autoinc();
119
UNIV_INTERN dict_index_t* innobase_get_index(uint keynr);
92
ulint innobase_initialize_autoinc();
93
dict_index_t* innobase_get_index(uint keynr);
94
uint64_t innobase_get_int_col_max_value(const Field* field);
121
96
/* Init values for the class: */
123
UNIV_INTERN ha_innobase(plugin::StorageEngine &engine,
125
UNIV_INTERN ~ha_innobase();
127
* Returns the plugin::TransactionStorageEngine pointer
128
* of the cursor's underlying engine.
132
* Have a TransactionalCursor subclass...
134
UNIV_INTERN plugin::TransactionalStorageEngine *getTransactionalEngine()
136
return static_cast<plugin::TransactionalStorageEngine *>(getEngine());
139
UNIV_INTERN const char* index_type(uint key_number);
140
UNIV_INTERN const key_map* keys_to_use_for_scanning();
142
UNIV_INTERN int doOpen(const drizzled::identifier::Table &identifier, int mode, uint test_if_locked);
143
UNIV_INTERN int close(void);
144
UNIV_INTERN double scan_time();
145
UNIV_INTERN double read_time(uint index, uint ranges, ha_rows rows);
147
UNIV_INTERN int doInsertRecord(unsigned char * buf);
148
UNIV_INTERN int doUpdateRecord(const unsigned char * old_data, unsigned char * new_data);
149
UNIV_INTERN int doDeleteRecord(const unsigned char * buf);
150
UNIV_INTERN bool was_semi_consistent_read();
151
UNIV_INTERN void try_semi_consistent_read(bool yes);
152
UNIV_INTERN void unlock_row();
154
UNIV_INTERN int doStartIndexScan(uint index, bool sorted);
155
UNIV_INTERN int doEndIndexScan();
156
UNIV_INTERN int index_read(unsigned char * buf, const unsigned char * key,
98
ha_innobase(StorageEngine *engine, TableShare *table_arg);
101
Get the row type from the storage engine. If this method returns
102
ROW_TYPE_NOT_USED, the information in HA_CREATE_INFO should be used.
104
enum row_type get_row_type() const;
106
const char* table_type() const;
107
const char* index_type(uint key_number);
108
const char** bas_ext() const;
109
Table_flags table_flags() const;
110
uint32_t index_flags(uint idx, uint part, bool all_parts) const;
111
uint32_t max_supported_keys() const;
112
uint32_t max_supported_key_length() const;
113
uint32_t max_supported_key_part_length() const;
114
const key_map* keys_to_use_for_scanning();
116
int open(const char *name, int mode, uint test_if_locked);
119
double read_time(uint index, uint ranges, ha_rows rows);
121
int write_row(unsigned char * buf);
122
int update_row(const unsigned char * old_data, unsigned char * new_data);
123
int delete_row(const unsigned char * buf);
124
bool was_semi_consistent_read();
125
void try_semi_consistent_read(bool yes);
128
#ifdef ROW_MERGE_IS_INDEX_USABLE
129
/** Check if an index can be used by this transaction.
130
* @param keynr key number to check
131
* @return true if available, false if the index
132
* does not contain old records that exist
133
* in the read view of this transaction */
134
bool is_index_available(uint keynr);
135
#endif /* ROW_MERGE_IS_INDEX_USABLE */
136
int index_init(uint index, bool sorted);
138
int index_read(unsigned char * buf, const unsigned char * key,
157
139
uint key_len, enum ha_rkey_function find_flag);
158
UNIV_INTERN int index_read_idx(unsigned char * buf, uint index, const unsigned char * key,
140
int index_read_idx(unsigned char * buf, uint index, const unsigned char * key,
159
141
uint key_len, enum ha_rkey_function find_flag);
160
UNIV_INTERN int index_read_last(unsigned char * buf, const unsigned char * key, uint key_len);
161
UNIV_INTERN int index_next(unsigned char * buf);
162
UNIV_INTERN int index_next_same(unsigned char * buf, const unsigned char *key, uint keylen);
163
UNIV_INTERN int index_prev(unsigned char * buf);
164
UNIV_INTERN int index_first(unsigned char * buf);
165
UNIV_INTERN int index_last(unsigned char * buf);
167
UNIV_INTERN int doStartTableScan(bool scan);
168
UNIV_INTERN int doEndTableScan();
169
UNIV_INTERN int rnd_next(unsigned char *buf);
170
UNIV_INTERN int rnd_pos(unsigned char * buf, unsigned char *pos);
172
UNIV_INTERN void position(const unsigned char *record);
173
UNIV_INTERN int info(uint);
174
UNIV_INTERN int analyze(Session* session);
175
UNIV_INTERN int discard_or_import_tablespace(bool discard);
176
UNIV_INTERN int extra(enum ha_extra_function operation);
177
UNIV_INTERN int reset();
178
UNIV_INTERN int external_lock(Session *session, int lock_type);
142
int index_read_last(unsigned char * buf, const unsigned char * key, uint key_len);
143
int index_next(unsigned char * buf);
144
int index_next_same(unsigned char * buf, const unsigned char *key, uint keylen);
145
int index_prev(unsigned char * buf);
146
int index_first(unsigned char * buf);
147
int index_last(unsigned char * buf);
149
int rnd_init(bool scan);
151
int rnd_next(unsigned char *buf);
152
int rnd_pos(unsigned char * buf, unsigned char *pos);
154
void position(const unsigned char *record);
156
int analyze(Session* session,HA_CHECK_OPT* check_opt);
157
int optimize(Session* session,HA_CHECK_OPT* check_opt);
158
int discard_or_import_tablespace(bool discard);
159
int extra(enum ha_extra_function operation);
161
int external_lock(Session *session, int lock_type);
162
int transactional_table_lock(Session *session, int lock_type);
163
int start_stmt(Session *session, thr_lock_type lock_type);
179
164
void position(unsigned char *record);
180
UNIV_INTERN ha_rows records_in_range(uint inx, key_range *min_key, key_range
165
ha_rows records_in_range(uint inx, key_range *min_key, key_range
182
UNIV_INTERN ha_rows estimate_rows_upper_bound();
167
ha_rows estimate_rows_upper_bound();
184
UNIV_INTERN int delete_all_rows();
185
UNIV_INTERN int check(Session* session);
186
UNIV_INTERN char* update_table_comment(const char* comment);
187
UNIV_INTERN char* get_foreign_key_create_info();
188
UNIV_INTERN int get_foreign_key_list(Session *session, List<ForeignKeyInfo> *f_key_list);
189
UNIV_INTERN bool can_switch_engines();
190
UNIV_INTERN uint referenced_by_foreign_key();
191
UNIV_INTERN void free_foreign_key_create_info(char* str);
192
UNIV_INTERN THR_LOCK_DATA **store_lock(Session *session, THR_LOCK_DATA **to,
169
void update_create_info(HA_CREATE_INFO* create_info);
170
int create(const char *name, Table *form,
171
HA_CREATE_INFO *create_info);
172
int delete_all_rows();
173
int delete_table(const char *name);
174
int rename_table(const char* from, const char* to);
175
int check(Session* session, HA_CHECK_OPT* check_opt);
176
char* update_table_comment(const char* comment);
177
char* get_foreign_key_create_info();
178
int get_foreign_key_list(Session *session, List<FOREIGN_KEY_INFO> *f_key_list);
179
bool can_switch_engines();
180
uint referenced_by_foreign_key();
181
void free_foreign_key_create_info(char* str);
182
THR_LOCK_DATA **store_lock(Session *session, THR_LOCK_DATA **to,
193
183
enum thr_lock_type lock_type);
194
UNIV_INTERN virtual void get_auto_increment(uint64_t offset,
196
uint64_t nb_desired_values,
197
uint64_t *first_value,
198
uint64_t *nb_reserved_values);
199
UNIV_INTERN int reset_auto_increment(uint64_t value);
201
UNIV_INTERN bool primary_key_is_clustered();
202
UNIV_INTERN int cmp_ref(const unsigned char *ref1, const unsigned char *ref2);
184
void init_table_handle_for_HANDLER();
185
virtual void get_auto_increment(uint64_t offset, uint64_t increment,
186
uint64_t nb_desired_values,
187
uint64_t *first_value,
188
uint64_t *nb_reserved_values);
189
int reset_auto_increment(uint64_t value);
191
virtual bool get_error_message(int error, String *buf);
193
bool primary_key_is_clustered();
194
int cmp_ref(const unsigned char *ref1, const unsigned char *ref2);
203
195
/** Fast index creation (smart ALTER TABLE) @see handler0alter.cc @{ */
204
// Don't use these, I have just left them in here as reference for
205
// the future. -Brian
207
UNIV_INTERN int add_index(Session *session, TABLE *table_arg, KeyInfo *key_info, uint num_of_keys);
208
UNIV_INTERN int prepare_drop_index(Session *session,
212
UNIV_INTERN int final_drop_index(Session *session, TABLE *table_arg);
196
int add_index(TABLE *table_arg, KEY *key_info, uint num_of_keys);
197
int prepare_drop_index(TABLE *table_arg, uint *key_num,
199
int final_drop_index(TABLE *table_arg);
203
* Multi Range Read interface
205
int multi_range_read_init(RANGE_SEQ_IF *seq, void *seq_init_param,
206
uint32_t n_ranges, uint32_t mode,
207
HANDLER_BUFFER *buf);
208
int multi_range_read_next(char **range_info);
209
ha_rows multi_range_read_info_const(uint32_t keyno, RANGE_SEQ_IF *seq,
210
void *seq_init_param,
211
uint32_t n_ranges, uint32_t *bufsz,
212
uint32_t *flags, COST_VECT *cost);
213
int multi_range_read_info(uint32_t keyno, uint32_t n_ranges, uint32_t keys,
214
uint32_t *bufsz, uint32_t *flags, COST_VECT *cost);
216
217
int read_range_first(const key_range *start_key, const key_range *end_key,
217
218
bool eq_range_arg, bool sorted);
218
219
int read_range_next();
220
Item *idx_cond_push(uint32_t keyno, Item* idx_cond);
226
struct charset_info_st *session_charset(Session *session);
227
char **session_query(Session *session);
222
229
/** Get the file name of the MySQL binlog.
223
230
* @return the name of the binlog file