← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/innobase/handler/ha_innodb.h

  • Committer: Monty Taylor
  • Date: 2008-10-16 09:12:23 UTC
  • mto: (511.1.6 codestyle)
  • mto: This revision was merged to the branch mainline in revision 521.
  • Revision ID: monty@inaugust.com-20081016091223-17ngih0qu9vssjs3
We pass -Wunused-macros now!

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin/innobase/handler/ha_innodb.h
1
 
/*****************************************************************************
2
 
 
3
 
Copyright (c) 2000, 2009, MySQL AB & Innobase Oy. All Rights Reserved.
4
 
 
5
 
This program is free software; you can redistribute it and/or modify it under
6
 
the terms of the GNU General Public License as published by the Free Software
7
 
Foundation; version 2 of the License.
8
 
 
9
 
This program is distributed in the hope that it will be useful, but WITHOUT
10
 
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11
 
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
12
 
 
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., 59 Temple
15
 
Place, Suite 330, Boston, MA 02111-1307 USA
16
 
 
17
 
*****************************************************************************/
18
 
 
19
 
/*
20
 
  This file is based on ha_berkeley.h of MySQL distribution
21
 
 
22
 
  This file defines the Innodb Cursor: the interface between MySQL and
23
 
  Innodb
24
 
*/
25
 
 
26
 
#ifndef INNODB_HANDLER_HA_INNODB_H
27
 
#define INNODB_HANDLER_HA_INNODB_H
28
 
 
29
 
#include <drizzled/cursor.h>
30
 
#include <drizzled/thr_lock.h>
31
 
#include <drizzled/plugin/transactional_storage_engine.h>
32
 
 
33
 
using namespace drizzled;
34
 
/** InnoDB table share */
35
 
typedef struct st_innobase_share {
36
 
        THR_LOCK        lock;           /*!< MySQL lock protecting
37
 
                                        this structure */
38
 
        char    table_name[FN_REFLEN];  /*!< InnoDB table name */
39
 
        uint            use_count;      /*!< reference count,
40
 
                                        incremented in get_share()
41
 
                                        and decremented in free_share() */
42
 
        void*           table_name_hash;/*!< hash table chain node */
43
 
 
44
 
        st_innobase_share(const char *arg) :
45
 
          use_count(0)
46
 
        {
47
 
          strncpy(table_name, arg, FN_REFLEN);
48
 
        }
49
 
 
50
 
} INNOBASE_SHARE;
51
 
 
52
 
 
53
 
/** InnoDB B-tree index */
54
 
struct dict_index_struct;
55
 
/** Prebuilt structures in an Innobase table handle used within MySQL */
56
 
struct row_prebuilt_struct;
57
 
 
58
 
/** InnoDB B-tree index */
59
 
typedef struct dict_index_struct dict_index_t;
60
 
/** Prebuilt structures in an Innobase table handle used within MySQL */
61
 
typedef struct row_prebuilt_struct row_prebuilt_t;
62
 
 
63
 
/** The class defining a handle to an Innodb table */
64
 
class ha_innobase: public Cursor
65
 
{
66
 
        row_prebuilt_t* prebuilt;       /*!< prebuilt struct in InnoDB, used
67
 
                                        to save CPU time with prebuilt data
68
 
                                        structures*/
69
 
        Session*        user_session;   /*!< the thread handle of the user
70
 
                                        currently using the handle; this is
71
 
                                        set in external_lock function */
72
 
        THR_LOCK_DATA   lock;
73
 
        INNOBASE_SHARE* share;          /*!< information for MySQL
74
 
                                        table locking */
75
 
 
76
 
        std::vector<unsigned char> upd_buff; /*!< buffer used in updates */
77
 
        std::vector<unsigned char> key_val_buff; /*!< buffer used in converting
78
 
                                                     search key values from MySQL format
79
 
                                                     to Innodb format */
80
 
        ulong           upd_and_key_val_buff_len;
81
 
                                        /* the length of each of the previous
82
 
                                        two buffers */
83
 
        uint            primary_key;
84
 
        ulong           start_of_scan;  /*!< this is set to 1 when we are
85
 
                                        starting a table scan but have not
86
 
                                        yet fetched any row, else 0 */
87
 
        uint            last_match_mode;/* match mode of the latest search:
88
 
                                        ROW_SEL_EXACT, ROW_SEL_EXACT_PREFIX,
89
 
                                        or undefined */
90
 
        uint            num_write_row;  /*!< number of doInsertRecord() calls */
91
 
 
92
 
        UNIV_INTERN uint store_key_val_for_row(uint keynr, char* buff, 
93
 
                                   uint buff_len, const unsigned char* record);
94
 
        UNIV_INTERN void update_session(Session* session);
95
 
        UNIV_INTERN int change_active_index(uint32_t keynr);
96
 
        UNIV_INTERN int general_fetch(unsigned char* buf, uint32_t direction, uint32_t match_mode);
97
 
        UNIV_INTERN ulint innobase_lock_autoinc();
98
 
        UNIV_INTERN uint64_t innobase_peek_autoinc();
99
 
        UNIV_INTERN ulint innobase_set_max_autoinc(uint64_t auto_inc);
100
 
        UNIV_INTERN ulint innobase_reset_autoinc(uint64_t auto_inc);
101
 
        UNIV_INTERN ulint innobase_get_autoinc(uint64_t* value);
102
 
        ulint innobase_update_autoinc(uint64_t  auto_inc);
103
 
        UNIV_INTERN ulint innobase_initialize_autoinc();
104
 
        UNIV_INTERN dict_index_t* innobase_get_index(uint keynr);
105
 
        UNIV_INTERN uint64_t innobase_get_int_col_max_value(const Field* field);
106
 
 
107
 
        /* Init values for the class: */
108
 
 public:
109
 
        UNIV_INTERN ha_innobase(plugin::StorageEngine &engine,
110
 
                                TableShare &table_arg);
111
 
        UNIV_INTERN ~ha_innobase();
112
 
  /**
113
 
   * Returns the plugin::TransactionStorageEngine pointer
114
 
   * of the cursor's underlying engine.
115
 
   *
116
 
   * @todo
117
 
   *
118
 
   * Have a TransactionalCursor subclass...
119
 
   */
120
 
  UNIV_INTERN plugin::TransactionalStorageEngine *getTransactionalEngine()
121
 
  {
122
 
    return static_cast<plugin::TransactionalStorageEngine *>(engine);
123
 
  }
124
 
 
125
 
        UNIV_INTERN const char* index_type(uint key_number);
126
 
        UNIV_INTERN const key_map* keys_to_use_for_scanning();
127
 
 
128
 
        UNIV_INTERN int doOpen(const drizzled::TableIdentifier &identifier, int mode, uint test_if_locked);
129
 
        UNIV_INTERN int close(void);
130
 
        UNIV_INTERN double scan_time();
131
 
        UNIV_INTERN double read_time(uint index, uint ranges, ha_rows rows);
132
 
 
133
 
        UNIV_INTERN int doInsertRecord(unsigned char * buf);
134
 
        UNIV_INTERN int doUpdateRecord(const unsigned char * old_data, unsigned char * new_data);
135
 
        UNIV_INTERN int doDeleteRecord(const unsigned char * buf);
136
 
        UNIV_INTERN bool was_semi_consistent_read();
137
 
        UNIV_INTERN void try_semi_consistent_read(bool yes);
138
 
        UNIV_INTERN void unlock_row();
139
 
 
140
 
        UNIV_INTERN int doStartIndexScan(uint index, bool sorted);
141
 
        UNIV_INTERN int doEndIndexScan();
142
 
        UNIV_INTERN int index_read(unsigned char * buf, const unsigned char * key,
143
 
                uint key_len, enum ha_rkey_function find_flag);
144
 
        UNIV_INTERN int index_read_idx(unsigned char * buf, uint index, const unsigned char * key,
145
 
                           uint key_len, enum ha_rkey_function find_flag);
146
 
        UNIV_INTERN int index_read_last(unsigned char * buf, const unsigned char * key, uint key_len);
147
 
        UNIV_INTERN int index_next(unsigned char * buf);
148
 
        UNIV_INTERN int index_next_same(unsigned char * buf, const unsigned char *key, uint keylen);
149
 
        UNIV_INTERN int index_prev(unsigned char * buf);
150
 
        UNIV_INTERN int index_first(unsigned char * buf);
151
 
        UNIV_INTERN int index_last(unsigned char * buf);
152
 
 
153
 
        UNIV_INTERN int doStartTableScan(bool scan);
154
 
        UNIV_INTERN int doEndTableScan();
155
 
        UNIV_INTERN int rnd_next(unsigned char *buf);
156
 
        UNIV_INTERN int rnd_pos(unsigned char * buf, unsigned char *pos);
157
 
 
158
 
        UNIV_INTERN void position(const unsigned char *record);
159
 
        UNIV_INTERN int info(uint);
160
 
        UNIV_INTERN int analyze(Session* session);
161
 
        UNIV_INTERN int discard_or_import_tablespace(bool discard);
162
 
        UNIV_INTERN int extra(enum ha_extra_function operation);
163
 
        UNIV_INTERN int reset();
164
 
        UNIV_INTERN int external_lock(Session *session, int lock_type);
165
 
        void position(unsigned char *record);
166
 
        UNIV_INTERN ha_rows records_in_range(uint inx, key_range *min_key, key_range
167
 
                                                                *max_key);
168
 
        UNIV_INTERN ha_rows estimate_rows_upper_bound();
169
 
 
170
 
        UNIV_INTERN int delete_all_rows();
171
 
        UNIV_INTERN int check(Session* session);
172
 
        UNIV_INTERN char* update_table_comment(const char* comment);
173
 
        UNIV_INTERN char* get_foreign_key_create_info();
174
 
        UNIV_INTERN int get_foreign_key_list(Session *session, List<ForeignKeyInfo> *f_key_list);
175
 
        UNIV_INTERN bool can_switch_engines();
176
 
        UNIV_INTERN uint referenced_by_foreign_key();
177
 
        UNIV_INTERN void free_foreign_key_create_info(char* str);
178
 
        UNIV_INTERN THR_LOCK_DATA **store_lock(Session *session, THR_LOCK_DATA **to,
179
 
                                        enum thr_lock_type lock_type);
180
 
        UNIV_INTERN virtual void get_auto_increment(uint64_t offset, 
181
 
                                                    uint64_t increment,
182
 
                                                    uint64_t nb_desired_values,
183
 
                                                    uint64_t *first_value,
184
 
                                                    uint64_t *nb_reserved_values);
185
 
        UNIV_INTERN int reset_auto_increment(uint64_t value);
186
 
 
187
 
        UNIV_INTERN bool primary_key_is_clustered();
188
 
        UNIV_INTERN int cmp_ref(const unsigned char *ref1, const unsigned char *ref2);
189
 
        /** Fast index creation (smart ALTER TABLE) @see handler0alter.cc @{ */
190
 
        // Don't use these, I have just left them in here as reference for
191
 
        // the future. -Brian 
192
 
#if 0
193
 
        UNIV_INTERN int add_index(Session *session, TABLE *table_arg, KeyInfo *key_info, uint num_of_keys);
194
 
        UNIV_INTERN int prepare_drop_index(Session *session,
195
 
                                           TABLE *table_arg,
196
 
                                           uint *key_num,
197
 
                                           uint num_of_keys);
198
 
        UNIV_INTERN int final_drop_index(Session *session, TABLE *table_arg);
199
 
#endif
200
 
        /** @} */
201
 
public:
202
 
  int read_range_first(const key_range *start_key, const key_range *end_key,
203
 
                       bool eq_range_arg, bool sorted);
204
 
  int read_range_next();
205
 
};
206
 
 
207
 
 
208
 
extern "C" {
209
 
 
210
 
/** Get the file name of the MySQL binlog.
211
 
 * @return the name of the binlog file
212
 
 */
213
 
const char* drizzle_bin_log_file_name(void);
214
 
 
215
 
/** Get the current position of the MySQL binlog.
216
 
 * @return byte offset from the beginning of the binlog
217
 
 */
218
 
uint64_t drizzle_bin_log_file_pos(void);
219
 
 
220
 
/**
221
 
  Check if a user thread is a replication slave thread
222
 
  @param session  user thread
223
 
  @retval 0 the user thread is not a replication slave thread
224
 
  @retval 1 the user thread is a replication slave thread
225
 
*/
226
 
int session_slave_thread(const Session *session);
227
 
 
228
 
}
229
 
 
230
 
typedef struct trx_struct trx_t;
231
 
/********************************************************************//**
232
 
@file Cursor/ha_innodb.h
233
 
Converts an InnoDB error code to a MySQL error code and also tells to MySQL
234
 
about a possible transaction rollback inside InnoDB caused by a lock wait
235
 
timeout or a deadlock.
236
 
@return MySQL error code */
237
 
extern "C" UNIV_INTERN
238
 
int
239
 
convert_error_code_to_mysql(
240
 
/*========================*/
241
 
        int             error,          /*!< in: InnoDB error code */
242
 
        ulint           flags,          /*!< in: InnoDB table flags, or 0 */
243
 
        Session         *session);      /*!< in: user thread handle or NULL */
244
 
 
245
 
/*********************************************************************//**
246
 
Allocates an InnoDB transaction for a MySQL Cursor object.
247
 
@return InnoDB transaction handle */
248
 
extern "C" UNIV_INTERN
249
 
trx_t*
250
 
innobase_trx_allocate(
251
 
/*==================*/
252
 
        Session         *session);      /*!< in: user thread handle */
253
 
#endif /* INNODB_HANDLER_HA_INNODB_H */