ha_innodb.h 7.38 KB
Newer Older
1
/* Copyright (C) 2000 MySQL AB && Innobase Oy
2 3 4 5 6

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
7

8 9 10 11
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
12

13 14 15 16
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */

17 18 19 20 21 22 23
/*
  This file is based on ha_berkeley.h of MySQL distribution

  This file defines the Innodb handler: the interface between MySQL and
  Innodb
*/

24 25 26 27 28 29 30 31 32 33 34 35
#ifdef __GNUC__
#pragma interface			/* gcc class implementation */
#endif

typedef struct st_innobase_share {
  THR_LOCK lock;
  pthread_mutex_t mutex;
  char *table_name;
  uint table_name_length,use_count;
} INNOBASE_SHARE;


36
/* The class defining a handle to an Innodb table */
37 38 39
class ha_innobase: public handler
{
	void*	innobase_prebuilt;	/* (row_prebuilt_t*) prebuilt
40
					struct in Innodb, used to save
41 42 43 44
					CPU */
	THD*		user_thd;	/* the thread handle of the user
					currently using the handle; this is
					set in external_lock function */
unknown's avatar
unknown committed
45 46
	ulong           last_query_id;  /* the latest query id where the
					handle was used */
47 48 49 50 51 52 53
  	THR_LOCK_DATA 	lock;
	INNOBASE_SHARE  *share;

  	gptr 		alloc_ptr;
  	byte*		upd_buff;	/* buffer used in updates */
  	byte*		key_val_buff;	/* buffer used in converting
  					search key values from MySQL format
54
  					to Innodb format */
55
  	ulong 		int_table_flags;
56
  	uint 		primary_key;
unknown's avatar
unknown committed
57
	uint		last_dup_key;
58 59 60
	ulong		start_of_scan;	/* this is set to 1 when we are
					starting a table scan but have not
					yet fetched any row, else 0 */
61 62

	uint		last_match_mode;/* match mode of the latest search:
63 64
					ROW_SEL_EXACT, ROW_SEL_EXACT_PREFIX,
					or undefined */
unknown's avatar
Merge  
unknown committed
65
	longlong	auto_inc_counter_for_this_stat;
66 67 68 69 70 71
	ulong max_row_length(const byte *buf);

	uint store_key_val_for_row(uint keynr, char* buff, const byte* record);
	int update_thd(THD* thd);
	int change_active_index(uint keynr);
	int general_fetch(byte* buf, uint direction, uint match_mode);
unknown's avatar
unknown committed
72
	int innobase_read_and_init_auto_inc(longlong* ret);
73 74 75 76

	/* Init values for the class: */
 public:
  	ha_innobase(TABLE *table): handler(table),
77
	  int_table_flags(HA_REC_NOT_IN_SEQ |
78
			  HA_KEYPOS_TO_RNDPOS | HA_LASTKEY_ORDER |
unknown's avatar
unknown committed
79
			  HA_NULL_KEY | HA_CAN_SQL_HANDLER |
80
			  HA_NOT_EXACT_COUNT |
81 82
			  HA_NO_WRITE_DELAYED |
			  HA_PRIMARY_KEY_IN_READ_INDEX |
83
			  HA_DROP_BEFORE_CREATE |
84
			  HA_NO_PREFIX_CHAR_KEYS |
85
			  HA_TABLE_SCAN_ON_INDEX),
86 87
	  last_dup_key((uint) -1),
	  start_of_scan(0)
88 89 90 91
  	{
  	}
  	~ha_innobase() {}

unknown's avatar
unknown committed
92
  	const char* table_type() const { return("InnoDB");}
93
	const char *index_type(uint key_number) { return "BTREE"; }
94
  	const char** bas_ext() const;
95 96 97 98
 	ulong table_flags() const { return int_table_flags; }
	ulong index_flags(uint idx) const
	{
	  return (HA_READ_NEXT | HA_READ_PREV | HA_READ_ORDER |
unknown's avatar
unknown committed
99
		  HA_KEY_READ_ONLY);
100
	}
101 102 103
  	uint max_record_length() const { return HA_MAX_REC_LENGTH; }
  	uint max_keys()          const { return MAX_KEY; }
  	uint max_key_parts()     const { return MAX_REF_PARTS; }
unknown's avatar
unknown committed
104 105 106 107
				/* An InnoDB page must store >= 2 keys;
				a secondary key record must also contain the
				primary key value:
				max key length is therefore set to slightly
unknown's avatar
unknown committed
108 109 110 111 112
				less than 1 / 4 of page size which is 16 kB;
				but currently MySQL does not work with keys
				whose size is > MAX_KEY_LENGTH */
  	uint max_key_length() const { return((MAX_KEY_LENGTH <= 3500) ?
					  MAX_KEY_LENGTH : 3500);}
113
  	bool fast_key_read()	 { return 1;}
unknown's avatar
unknown committed
114
	key_map keys_to_use_for_scanning() { return ~(key_map) 0; }
115 116
  	bool has_transactions()  { return 1;}

unknown's avatar
unknown committed
117
  	int open(const char *name, int mode, uint test_if_locked);
118 119 120 121 122 123 124 125 126 127 128
  	void initialize(void);
  	int close(void);
  	double scan_time();

  	int write_row(byte * buf);
  	int update_row(const byte * old_data, byte * new_data);
  	int delete_row(const byte * buf);

  	int index_init(uint index);
  	int index_end();
  	int index_read(byte * buf, const byte * key,
129
		       uint key_len, enum ha_rkey_function find_flag);
130
  	int index_read_idx(byte * buf, uint index, const byte * key,
131 132
			   uint key_len, enum ha_rkey_function find_flag);
	int index_read_last(byte * buf, const byte * key, uint key_len);
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
  	int index_next(byte * buf);
  	int index_next_same(byte * buf, const byte *key, uint keylen);
  	int index_prev(byte * buf);
  	int index_first(byte * buf);
  	int index_last(byte * buf);

  	int rnd_init(bool scan=1);
  	int rnd_end();
  	int rnd_next(byte *buf);
  	int rnd_pos(byte * buf, byte *pos);

  	void position(const byte *record);
  	void info(uint);
  	int extra(enum ha_extra_function operation);
  	int reset(void);
  	int external_lock(THD *thd, int lock_type);
unknown's avatar
unknown committed
149 150
	int start_stmt(THD *thd);

151 152 153 154 155 156
  	void position(byte *record);
  	ha_rows records_in_range(int inx,
			   const byte *start_key,uint start_key_len,
			   enum ha_rkey_function start_search_flag,
			   const byte *end_key,uint end_key_len,
			   enum ha_rkey_function end_search_flag);
unknown's avatar
unknown committed
157
	ha_rows estimate_number_of_rows();
158 159 160 161 162

  	int create(const char *name, register TABLE *form,
					HA_CREATE_INFO *create_info);
  	int delete_table(const char *name);
	int rename_table(const char* from, const char* to);
unknown's avatar
unknown committed
163
	int check(THD* thd, HA_CHECK_OPT* check_opt);
164
        char* update_table_comment(const char* comment);
unknown's avatar
unknown committed
165 166
	char* get_foreign_key_create_info();
	void free_foreign_key_create_info(char* str);	
167 168
  	THR_LOCK_DATA **store_lock(THD *thd, THR_LOCK_DATA **to,
			     		enum thr_lock_type lock_type);
unknown's avatar
unknown committed
169
	void init_table_handle_for_HANDLER(); 
170
	longlong get_auto_increment();
171 172
};

unknown's avatar
unknown committed
173
extern bool innodb_skip;
174
extern uint innobase_init_flags, innobase_lock_type;
unknown's avatar
unknown committed
175
extern uint innobase_flush_log_at_trx_commit;
176 177 178
extern ulong innobase_cache_size;
extern char *innobase_home, *innobase_tmpdir, *innobase_logdir;
extern long innobase_lock_scan_time;
unknown's avatar
unknown committed
179
extern long innobase_mirrored_log_groups, innobase_log_files_in_group;
180 181
extern long innobase_log_file_size, innobase_log_buffer_size;
extern long innobase_buffer_pool_size, innobase_additional_mem_pool_size;
182
extern long innobase_file_io_threads, innobase_lock_wait_timeout;
unknown's avatar
Merge  
unknown committed
183
extern long innobase_force_recovery, innobase_thread_concurrency;
184 185
extern char *innobase_data_home_dir, *innobase_data_file_path;
extern char *innobase_log_group_home_dir, *innobase_log_arch_dir;
186
extern char *innobase_unix_file_flush_method;
unknown's avatar
unknown committed
187
/* The following variables have to be my_bool for SHOW VARIABLES to work */
unknown's avatar
unknown committed
188
extern my_bool innobase_log_archive,
unknown's avatar
unknown committed
189
               innobase_use_native_aio, innobase_fast_shutdown;
190 191 192 193 194 195

extern TYPELIB innobase_lock_typelib;

bool innobase_init(void);
bool innobase_end(void);
bool innobase_flush_logs(void);
196
uint innobase_get_free_space(void);
197

unknown's avatar
unknown committed
198
int innobase_commit(THD *thd, void* trx_handle);
199 200 201 202 203
int innobase_report_binlog_offset_and_commit(
        THD*    thd,
	void*	trx_handle,
        char*   log_file_name,
        my_off_t end_offset);
unknown's avatar
unknown committed
204
int innobase_rollback(THD *thd, void* trx_handle);
205
int innobase_close_connection(THD *thd);
206
int innobase_drop_database(char *path);
unknown's avatar
unknown committed
207
int innodb_show_status(THD* thd);
208

unknown's avatar
unknown committed
209 210
my_bool innobase_query_caching_of_table_permitted(THD* thd, char* full_name,
						uint full_name_len);
211
void innobase_release_temporary_latches(void* innobase_tid);