ha_partition Class Reference

Inheritance diagram for ha_partition:

Collaboration diagram for ha_partition:

Public Member Functions
Partition_share *	get_part_share ()
handler *	clone (const char *name, MEM_ROOT *mem_root)
virtual void	set_part_info (partition_info *part_info, bool early)
	ha_partition (handlerton *hton, TABLE_SHARE *table)
	ha_partition (handlerton *hton, partition_info *part_info)
	ha_partition (handlerton *hton, TABLE_SHARE *share, partition_info *part_info_arg, ha_partition *clone_arg, MEM_ROOT *clone_mem_root_arg)
bool	initialize_partition (MEM_ROOT *mem_root)
virtual int	delete_table (const char *from)
virtual int	rename_table (const char *from, const char *to)
virtual int	create (const char *name, TABLE *form, HA_CREATE_INFO *create_info)
virtual int	create_handler_files (const char *name, const char *old_name, int action_flag, HA_CREATE_INFO *create_info)
virtual void	update_create_info (HA_CREATE_INFO *create_info)
virtual char *	update_table_comment (const char *comment)
virtual int	change_partitions (HA_CREATE_INFO *create_info, const char *path, ulonglong *const copied, ulonglong *const deleted, const uchar *pack_frm_data, size_t pack_frm_len)
virtual int	drop_partitions (const char *path)
virtual int	rename_partitions (const char *path)
bool	get_no_parts (const char *name, uint *num_parts)
virtual void	change_table_ptr (TABLE *table_arg, TABLE_SHARE *share)
virtual bool	check_if_incompatible_data (HA_CREATE_INFO *create_info, uint table_changes)
virtual int	open (const char *name, int mode, uint test_if_locked)
virtual int	close (void)
virtual THR_LOCK_DATA **	store_lock (THD *thd, THR_LOCK_DATA **to, enum thr_lock_type lock_type)
virtual int	external_lock (THD *thd, int lock_type)
virtual int	start_stmt (THD *thd, thr_lock_type lock_type)
virtual uint	lock_count (void) const
virtual void	unlock_row ()
virtual bool	was_semi_consistent_read ()
virtual void	try_semi_consistent_read (bool)
virtual int	write_row (uchar *buf)
virtual int	update_row (const uchar *old_data, uchar *new_data)
virtual int	delete_row (const uchar *buf)
virtual int	delete_all_rows (void)
virtual int	truncate ()
virtual void	start_bulk_insert (ha_rows rows)
virtual int	end_bulk_insert ()
int	truncate_partition (Alter_info *, bool *binlog_stmt)
virtual bool	is_fatal_error (int error, uint flags)
virtual int	rnd_init (bool scan)
virtual int	rnd_end ()
virtual int	rnd_next (uchar *buf)
virtual int	rnd_pos (uchar *buf, uchar *pos)
virtual int	rnd_pos_by_record (uchar *record)
virtual void	position (const uchar *record)
virtual int	index_read_map (uchar *buf, const uchar *key, key_part_map keypart_map, enum ha_rkey_function find_flag)
	Positions an index cursor to the index specified in the handle ('active_index'). Fetches the row if available. If the key value is null, begin at the first key of the index.
virtual int	index_init (uint idx, bool sorted)
virtual int	index_end ()
virtual int	index_read_idx_map (uchar *buf, uint index, const uchar *key, key_part_map keypart_map, enum ha_rkey_function find_flag)
virtual int	index_next (uchar *buf)
virtual int	index_prev (uchar *buf)
virtual int	index_first (uchar *buf)
virtual int	index_last (uchar *buf)
virtual int	index_next_same (uchar *buf, const uchar *key, uint keylen)
virtual int	index_read_last_map (uchar *buf, const uchar *key, key_part_map keypart_map)
	The following functions works like index_read, but it find the last row with the current key value or prefix.
virtual int	read_range_first (const key_range *start_key, const key_range *end_key, bool eq_range, bool sorted)
	Read first row between two ranges. Store ranges for future calls to read_range_next.
virtual int	read_range_next ()
	Read next row between two endpoints.
virtual int	info (uint)
void	get_dynamic_partition_info (PARTITION_STATS *stat_info, uint part_id)
virtual int	extra (enum ha_extra_function operation)
virtual int	extra_opt (enum ha_extra_function operation, ulong cachesize)
virtual int	reset (void)
virtual my_bool	register_query_cache_table (THD *thd, char *table_key, uint key_length, qc_engine_callback *engine_callback, ulonglong *engine_data)
	Register a named table with a call back function to the query cache.
virtual const key_map *	keys_to_use_for_scanning ()
virtual double	scan_time ()
virtual double	read_time (uint index, uint ranges, ha_rows rows)
virtual ha_rows	records_in_range (uint inx, key_range *min_key, key_range *max_key)
virtual ha_rows	estimate_rows_upper_bound ()
virtual uint8	table_cache_type ()
virtual ha_rows	records ()
uint32	calculate_key_hash_value (Field **field_array)
virtual const char *	index_type (uint inx)
virtual const char *	table_type () const
virtual enum row_type	get_row_type () const
virtual void	print_error (int error, myf errflag)
virtual bool	get_error_message (int error, String *buf)
virtual Table_flags	table_flags () const
virtual ulong	index_flags (uint inx, uint part, bool all_parts) const
virtual uint	alter_table_flags (uint flags)
virtual const char **	bas_ext () const
uint	min_of_the_max_uint (uint(handler::*operator_func)(void) const) const
virtual uint	max_supported_record_length () const
virtual uint	max_supported_keys () const
virtual uint	max_supported_key_parts () const
virtual uint	max_supported_key_length () const
virtual uint	max_supported_key_part_length () const
virtual bool	low_byte_first () const
virtual uint	extra_rec_buf_length () const
virtual uint	min_record_length (uint options) const
virtual bool	primary_key_is_clustered ()
virtual int	cmp_ref (const uchar *ref1, const uchar *ref2)
virtual void	get_auto_increment (ulonglong offset, ulonglong increment, ulonglong nb_desired_values, ulonglong *first_value, ulonglong *nb_reserved_values)
virtual void	release_auto_increment ()
virtual void	init_table_handle_for_HANDLER ()
virtual bool	can_switch_engines ()
virtual enum_alter_inplace_result	check_if_supported_inplace_alter (TABLE *altered_table, Alter_inplace_info *ha_alter_info)
virtual bool	prepare_inplace_alter_table (TABLE *altered_table, Alter_inplace_info *ha_alter_info)
virtual bool	inplace_alter_table (TABLE *altered_table, Alter_inplace_info *ha_alter_info)
virtual bool	commit_inplace_alter_table (TABLE *altered_table, Alter_inplace_info *ha_alter_info, bool commit)
virtual void	notify_table_changed ()
virtual int	optimize (THD *thd, HA_CHECK_OPT *check_opt)
virtual int	analyze (THD *thd, HA_CHECK_OPT *check_opt)
virtual int	check (THD *thd, HA_CHECK_OPT *check_opt)
virtual int	repair (THD *thd, HA_CHECK_OPT *check_opt)
virtual bool	check_and_repair (THD *thd)
virtual bool	auto_repair () const
virtual bool	is_crashed () const
virtual int	check_for_upgrade (HA_CHECK_OPT *check_opt)
virtual uint	checksum () const
virtual int	assign_to_keycache (THD *thd, HA_CHECK_OPT *check_opt)
virtual int	preload_keys (THD *thd, HA_CHECK_OPT *check_opt)
virtual int	disable_indexes (uint mode)
virtual int	enable_indexes (uint mode)
virtual int	indexes_are_disabled (void)
Public Member Functions inherited from handler
virtual void	unbind_psi ()
virtual void	rebind_psi ()
	handler (handlerton *ht_arg, TABLE_SHARE *share_arg)
void	init ()
int	ha_open (TABLE *table, const char *name, int mode, int test_if_locked)
	Open database-handler.
int	ha_close (void)
int	ha_index_init (uint idx, bool sorted)
int	ha_index_end ()
int	ha_rnd_init (bool scan)
int	ha_rnd_end ()
int	ha_rnd_next (uchar *buf)
int	ha_rnd_pos (uchar *buf, uchar *pos)
int	ha_index_read_map (uchar *buf, const uchar *key, key_part_map keypart_map, enum ha_rkey_function find_flag)
int	ha_index_read_last_map (uchar *buf, const uchar *key, key_part_map keypart_map)
int	ha_index_read_idx_map (uchar *buf, uint index, const uchar *key, key_part_map keypart_map, enum ha_rkey_function find_flag)
int	ha_index_next (uchar *buf)
int	ha_index_prev (uchar *buf)
int	ha_index_first (uchar *buf)
int	ha_index_last (uchar *buf)
int	ha_index_next_same (uchar *buf, const uchar *key, uint keylen)
int	ha_index_read (uchar *buf, const uchar *key, uint key_len, enum ha_rkey_function find_flag)
int	ha_index_read_last (uchar *buf, const uchar *key, uint key_len)
int	ha_reset ()
	Check handler usage and reset state of file to after 'open'.
int	ha_index_or_rnd_end ()
Table_flags	ha_table_flags () const
int	ha_external_lock (THD *thd, int lock_type)
int	ha_write_row (uchar *buf)
int	ha_update_row (const uchar *old_data, uchar *new_data)
int	ha_delete_row (const uchar *buf)
void	ha_release_auto_increment ()
int	check_collation_compatibility ()
int	ha_check_for_upgrade (HA_CHECK_OPT *check_opt)
int	ha_check (THD *thd, HA_CHECK_OPT *check_opt)
int	ha_repair (THD *thd, HA_CHECK_OPT *check_opt)
void	ha_start_bulk_insert (ha_rows rows)
int	ha_end_bulk_insert ()
int	ha_bulk_update_row (const uchar *old_data, uchar *new_data, uint *dup_key_found)
int	ha_delete_all_rows ()
int	ha_truncate ()
int	ha_reset_auto_increment (ulonglong value)
int	ha_optimize (THD *thd, HA_CHECK_OPT *check_opt)
int	ha_analyze (THD *thd, HA_CHECK_OPT *check_opt)
bool	ha_check_and_repair (THD *thd)
int	ha_disable_indexes (uint mode)
int	ha_enable_indexes (uint mode)
int	ha_discard_or_import_tablespace (my_bool discard)
int	ha_rename_table (const char *from, const char *to)
int	ha_delete_table (const char *name)
void	ha_drop_table (const char *name)
int	ha_create (const char *name, TABLE *form, HA_CREATE_INFO *info)
int	ha_create_handler_files (const char *name, const char *old_name, int action_flag, HA_CREATE_INFO *info)
int	ha_change_partitions (HA_CREATE_INFO *create_info, const char *path, ulonglong *const copied, ulonglong *const deleted, const uchar *pack_frm_data, size_t pack_frm_len)
int	ha_drop_partitions (const char *path)
int	ha_rename_partitions (const char *path)
void	adjust_next_insert_id_after_explicit_value (ulonglong nr)
int	update_auto_increment ()
uint	get_dup_key (int error)
virtual bool	get_foreign_dup_key (char *child_table_name, uint child_table_name_len, char *child_key_name, uint child_key_name_len)
virtual double	index_only_read_time (uint keynr, double records)
virtual longlong	get_memory_buffer_size () const
virtual ha_rows	multi_range_read_info_const (uint keyno, RANGE_SEQ_IF *seq, void *seq_init_param, uint n_ranges, uint *bufsz, uint *flags, Cost_estimate *cost)
virtual ha_rows	multi_range_read_info (uint keyno, uint n_ranges, uint keys, uint *bufsz, uint *flags, Cost_estimate *cost)
virtual int	multi_range_read_init (RANGE_SEQ_IF *seq, void *seq_init_param, uint n_ranges, uint mode, HANDLER_BUFFER *buf)
virtual int	multi_range_read_next (char **range_info)
bool	has_transactions ()
virtual void	column_bitmaps_signal ()
	MySQL signal that it changed the column bitmap.
uint	get_index (void) const
virtual bool	start_bulk_update ()
virtual bool	start_bulk_delete ()
virtual int	exec_bulk_update (uint *dup_key_found)
virtual void	end_bulk_update ()
virtual int	end_bulk_delete ()
void	set_end_range (const key_range *range, enum_range_scan_direction direction)
int	compare_key (key_range *range)
int	compare_key_icp (const key_range *range) const
virtual int	ft_init ()
void	ft_end ()
virtual FT_INFO *	ft_init_ext (uint flags, uint inx, String *key)
virtual int	ft_read (uchar *buf)
virtual int	read_first_row (uchar *buf, uint primary_key)
virtual int	restart_rnd_next (uchar *buf, uchar *pos)
virtual int	rnd_same (uchar *buf, uint inx)
virtual bool	start_read_removal (void)
virtual ha_rows	end_read_removal (void)
void	set_next_insert_id (ulonglong id)
void	restore_auto_increment (ulonglong prev_insert_id)
int	check_old_types ()
virtual void	append_create_info (String *packet)
virtual bool	is_fk_defined_on_table_or_index (uint index)
virtual char *	get_foreign_key_create_info ()
virtual int	get_foreign_key_list (THD *thd, List< FOREIGN_KEY_INFO > *f_key_list)
virtual int	get_parent_foreign_key_list (THD *thd, List< FOREIGN_KEY_INFO > *f_key_list)
virtual uint	referenced_by_foreign_key ()
virtual void	free_foreign_key_create_info (char *str)
virtual int	get_default_no_partitions (HA_CREATE_INFO *info)
virtual void	set_auto_partitions (partition_info *part_info)
uint	max_record_length () const
uint	max_keys () const
uint	max_key_parts () const
uint	max_key_length () const
uint	max_key_part_length () const
virtual const Item *	cond_push (const Item *cond)
virtual void	cond_pop ()
virtual Item *	idx_cond_push (uint keyno, Item *idx_cond)
virtual void	cancel_pushed_idx_cond ()
virtual uint	number_of_pushed_joins () const
virtual const TABLE *	root_of_pushed_join () const
virtual const TABLE *	parent_of_pushed_join () const
virtual int	index_read_pushed (uchar *buf, const uchar *key, key_part_map keypart_map)
virtual int	index_next_pushed (uchar *buf)
bool	ha_prepare_inplace_alter_table (TABLE *altered_table, Alter_inplace_info *ha_alter_info)
bool	ha_inplace_alter_table (TABLE *altered_table, Alter_inplace_info *ha_alter_info)
bool	ha_commit_inplace_alter_table (TABLE *altered_table, Alter_inplace_info *ha_alter_info, bool commit)
void	ha_notify_table_changed ()
virtual void	use_hidden_primary_key ()
virtual int	bulk_update_row (const uchar *old_data, uchar *new_data, uint *dup_key_found)
virtual int	reset_auto_increment (ulonglong value)
virtual int	discard_or_import_tablespace (my_bool discard)
virtual void	drop_table (const char *name)
virtual bool	set_ha_share_ref (Handler_share **arg_ha_share)
int	get_lock_type () const

Additional Inherited Members
Public Types inherited from handler
enum	enum_range_scan_direction { RANGE_SCAN_ASC, RANGE_SCAN_DESC }
enum	{ NONE = 0, INDEX, RND }
typedef ulonglong	Table_flags
Static Public Member Functions inherited from Sql_alloc
static void *	operator new (size_t size) throw ()
static void *	operator new[] (size_t size) throw ()
static void *	operator new[] (size_t size, MEM_ROOT *mem_root) throw ()
static void *	operator new (size_t size, MEM_ROOT *mem_root) throw ()
static void	operator delete (void *ptr, size_t size)
static void	operator delete (void *ptr, MEM_ROOT *mem_root)
static void	operator delete[] (void *ptr, MEM_ROOT *mem_root)
static void	operator delete[] (void *ptr, size_t size)
Public Attributes inherited from handler
handlerton *	ht
uchar *	ref
uchar *	dup_ref
ha_statistics	stats
range_seq_t	mrr_iter
RANGE_SEQ_IF	mrr_funcs
HANDLER_BUFFER *	multi_range_buffer
uint	ranges_in_seq
bool	mrr_is_output_sorted
bool	mrr_have_range
KEY_MULTI_RANGE	mrr_cur_range
key_range *	end_range
uint	errkey
uint	key_used_on_scan
uint	active_index
uint	ref_length
FT_INFO *	ft_handler
enum handler:: { ... }	inited
bool	implicit_emptied
const Item *	pushed_cond
Item *	pushed_idx_cond
uint	pushed_idx_cond_keyno
ulonglong	next_insert_id
ulonglong	insert_id_for_cur_row
Discrete_interval	auto_inc_interval_for_cur_row
uint	auto_inc_intervals_count
PSI_table *	m_psi
Protected Member Functions inherited from handler
void	ha_statistic_increment (ulonglong SSV::*offset) const
void **	ha_data (THD *) const
THD *	ha_thd (void) const
PSI_table_share *	ha_table_share_psi (const TABLE_SHARE *share) const
virtual int	index_read (uchar *buf, const uchar *key, uint key_len, enum ha_rkey_function find_flag)
virtual int	index_read_last (uchar *buf, const uchar *key, uint key_len)
Handler_share *	get_ha_share_ptr ()
void	set_ha_share_ptr (Handler_share *arg_ha_share)
void	lock_shared_ha_data ()
void	unlock_shared_ha_data ()
Protected Attributes inherited from handler
TABLE_SHARE *	table_share
TABLE *	table
Table_flags	cached_table_flags
ha_rows	estimation_rows_to_insert
KEY_PART_INFO *	range_key_part
bool	eq_range
bool	in_range_check_pushed_down

Detailed Description

Definition at line 119 of file ha_partition.h.

Member Function Documentation

virtual uint ha_partition::alter_table_flags ( uint  flags )

virtual

wrapper function for handlerton alter_table_flags, since the ha_partition_hton cannot know all its capabilities

Reimplemented from handler.

virtual const char** ha_partition::bas_ext ( ) const

virtual

If frm_error() is called then we will use this to find out what file extentions exist for the storage engine. This is also used by the default rename_table and delete_table method in handler.cc.

For engines that have two file name extentions (separate meta/index file and data file), the order of elements is relevant. First element of engine file name extentions array should be meta/index file extention. Second element - data file extention. This order is assumed by prepare_for_repair() when REPAIR TABLE ... USE_FRM is issued.

Implements handler.

virtual bool ha_partition::can_switch_engines ( )

virtual

Used in ALTER TABLE to check if changing storage engine is allowed.

Note

Called without holding thr_lock.c lock.

Return values

true	Changing storage engine is allowed.
false	Changing storage engine not allowed.

Reimplemented from handler.

virtual int ha_partition::check_for_upgrade ( HA_CHECK_OPT *  check_opt )

virtual

admin commands - called from mysql_admin_table

Reimplemented from handler.

virtual bool ha_partition::check_if_incompatible_data ( HA_CREATE_INFO *  create_info, uint  table_changes  )

virtual

Part of old, deprecated in-place ALTER API.

Reimplemented from handler.

virtual enum_alter_inplace_result ha_partition::check_if_supported_inplace_alter ( TABLE *  altered_table, Alter_inplace_info *  ha_alter_info  )

virtual

Check if a storage engine supports a particular alter table in-place

Parameters

altered_table	TABLE object for new version of table.
ha_alter_info	Structure describing changes to be done by ALTER TABLE and holding data used during in-place alter.

Return values

HA_ALTER_ERROR	Unexpected error.
HA_ALTER_INPLACE_NOT_SUPPORTED	Not supported, must use copy.
HA_ALTER_INPLACE_EXCLUSIVE_LOCK	Supported, but requires X lock.
HA_ALTER_INPLACE_SHARED_LOCK_AFTER_PREPARE	Supported, but requires SNW lock during main phase. Prepare phase requires X lock.
HA_ALTER_INPLACE_SHARED_LOCK	Supported, but requires SNW lock.
HA_ALTER_INPLACE_NO_LOCK_AFTER_PREPARE	Supported, concurrent reads/writes allowed. However, prepare phase requires X lock.
HA_ALTER_INPLACE_NO_LOCK	Supported, concurrent reads/writes allowed.

Note

The default implementation uses the old in-place ALTER API to determine if the storage engine supports in-place ALTER or not.

Called without holding thr_lock.c lock.

Reimplemented from handler.

virtual bool ha_partition::commit_inplace_alter_table ( TABLE *  altered_table, Alter_inplace_info *  ha_alter_info, bool  commit  )

virtual

Commit or rollback the changes made during prepare_inplace_alter_table() and inplace_alter_table() inside the storage engine. Note that in case of rollback the allowed level of concurrency during this operation will be the same as for inplace_alter_table() and thus might be higher than during prepare_inplace_alter_table(). (For example, concurrent writes were blocked during prepare, but might not be during rollback).

Note

Storage engines are responsible for reporting any errors by calling my_error()/print_error()

If this function with commit= true reports error, it will be called again with commit= false.

In case of partitioning, this function might be called for rollback without prepare_inplace_alter_table() having been called first. Also partitioned tables sets ha_alter_info->group_commit_ctx to a NULL terminated array of the partitions handlers and if all of them are committed as one, then group_commit_ctx should be set to NULL to indicate to the partitioning handler that all partitions handlers are committed.

See Also

prepare_inplace_alter_table().

Parameters

altered_table	TABLE object for new version of table.
ha_alter_info	Structure describing changes to be done by ALTER TABLE and holding data used during in-place alter.
commit	True => Commit, False => Rollback.

Return values

true	Error
false	Success

Reimplemented from handler.

virtual int ha_partition::delete_all_rows ( void  )

virtual

This is called to delete all rows in a table If the handler don't support this, then this function will return HA_ERR_WRONG_COMMAND and MySQL will delete the rows one by one.

Reimplemented from handler.

virtual int ha_partition::delete_table ( const char *  name )

virtual

Delete a table in the engine. Called for base as well as temporary tables.

Delete all files with extension from bas_ext().

Parameters

name	Base name of table

Note

We assume that the handler may return more extensions than was actually used for the file.

Return values

0	If we successfully deleted at least one file from base_ext and didn't get any other errors than ENOENT
!0	Error

Reimplemented from handler.

virtual ha_rows ha_partition::estimate_rows_upper_bound ( void  )

virtual

Return upper bound of current number of records in the table (max. of how many records one will retrieve when doing a full table scan) If upper bound is not known, HA_POS_ERROR should be returned as a max possible upper bound.

Reimplemented from handler.

virtual void ha_partition::get_auto_increment ( ulonglong  offset, ulonglong  increment, ulonglong  nb_desired_values, ulonglong *  first_value, ulonglong *  nb_reserved_values  )

virtual

Reserves an interval of auto_increment values from the handler.

Parameters

	offset	offset (modulus increment)
	increment	increment between calls
	nb_desired_values	how many values we want
[out]	first_value	the first value reserved by the handler
[out]	nb_reserved_values	how many values the handler reserved

offset and increment means that we want values to be of the form offset + N * increment, where N>=0 is integer. If the function sets *first_value to ULONGLONG_MAX it means an error. If the function sets *nb_reserved_values to ULONGLONG_MAX it means it has reserved to "positive infinite".

Reimplemented from handler.

virtual bool ha_partition::get_error_message ( int  error, String *  buf  )

virtual

Return an error message specific to this handler.

Parameters

error	error code previously returned by handler
buf	pointer to String where to add error message

Returns

Returns true if this is a temporary error

Reimplemented from handler.

bool ha_partition::get_no_parts ( const char *  name, uint *  no_parts  )

inlinevirtual

Get number of partitions for table in SE

Parameters

	name	normalized path(same as open) to the table
[out]	no_parts	Number of partitions

Return values

false	for success
true	for failure, for example table didn't exist in engine

Reimplemented from handler.

Definition at line 331 of file ha_partition.h.

virtual enum row_type ha_partition::get_row_type ( ) const

virtual

Get the row type from the storage engine. If this method returns ROW_TYPE_NOT_USED, the information in HA_CREATE_INFO should be used.

Reimplemented from handler.

virtual int ha_partition::index_first ( uchar *  buf )

virtual

Returns

See Also

index_read_map().

Reimplemented from handler.

virtual int ha_partition::index_last ( uchar *  buf )

virtual

Returns

See Also

index_read_map().

Reimplemented from handler.

virtual int ha_partition::index_next ( uchar *  buf )

virtual

Returns

See Also

index_read_map().

Reimplemented from handler.

virtual int ha_partition::index_next_same ( uchar *  buf, const uchar *  key, uint  keylen  )

virtual

Returns

See Also

index_read_map().

Reimplemented from handler.

virtual int ha_partition::index_prev ( uchar *  buf )

virtual

Returns

See Also

index_read_map().

Reimplemented from handler.

virtual int ha_partition::index_read_idx_map ( uchar *  buf, uint  index, const uchar *  key, key_part_map  keypart_map, enum ha_rkey_function  find_flag  )

virtual

Positions an index cursor to the index specified in the hanlde. Fetches the row if available. If the key value is null, begin at first key of the index.

Reimplemented from handler.

virtual int ha_partition::index_read_last_map ( uchar *  buf, const uchar *  key, key_part_map  keypart_map  )

virtual

The following functions works like index_read, but it find the last row with the current key value or prefix.

Returns

See Also

index_read_map().

Reimplemented from handler.

virtual int ha_partition::index_read_map ( uchar *  buf, const uchar *  key, key_part_map  keypart_map, enum ha_rkey_function  find_flag  )

virtual

Positions an index cursor to the index specified in the handle ('active_index'). Fetches the row if available. If the key value is null, begin at the first key of the index.

Returns

0 if success (found a record, and function has set table->status to 0); non-zero if no record (function has set table->status to STATUS_NOT_FOUND).

Reimplemented from handler.

virtual bool ha_partition::inplace_alter_table ( TABLE *  altered_table, Alter_inplace_info *  ha_alter_info  )

virtual

Alter the table structure in-place with operations specified using HA_ALTER_FLAGS and Alter_inplace_info. The level of concurrency allowed during this operation depends on the return value from check_if_supported_inplace_alter().

Note

Storage engines are responsible for reporting any errors by calling my_error()/print_error()

If this function reports error, commit_inplace_alter_table() will be called with commit= false.

Parameters

altered_table	TABLE object for new version of table.
ha_alter_info	Structure describing changes to be done by ALTER TABLE and holding data used during in-place alter.

Return values

true	Error
false	Success

Reimplemented from handler.

virtual bool ha_partition::is_fatal_error ( int  error, uint  flags  )

inlinevirtual

This method is used to analyse the error to see whether the error is ignorable or not, certain handlers can have more error that are ignorable than others. E.g. the partition handler can get inserts into a range where there is no partition and this is an ignorable error. HA_ERR_FOUND_DUP_UNIQUE is a special case in MyISAM that means the same thing as HA_ERR_FOUND_DUP_KEY but can in some cases lead to a slightly different error message.

Reimplemented from handler.

Definition at line 489 of file ha_partition.h.

Here is the call graph for this function:

virtual uint ha_partition::lock_count ( void  ) const

virtual

Note

lock_count() can return > 1 if the table is MERGE or partitioned.

Reimplemented from handler.

virtual void ha_partition::notify_table_changed ( )

virtual

Notify the storage engine that the table structure (.FRM) has been updated.

Note

No errors are allowed during notify_table_changed().

Reimplemented from handler.

virtual bool ha_partition::prepare_inplace_alter_table ( TABLE *  altered_table, Alter_inplace_info *  ha_alter_info  )

virtual

Allows the storage engine to update internal structures with concurrent writes blocked. If check_if_supported_inplace_alter() returns HA_ALTER_INPLACE_NO_LOCK_AFTER_PREPARE or HA_ALTER_INPLACE_SHARED_AFTER_PREPARE, this function is called with exclusive lock otherwise the same level of locking as for inplace_alter_table() will be used.

Note

Storage engines are responsible for reporting any errors by calling my_error()/print_error()

If this function reports error, commit_inplace_alter_table() will be called with commit= false.

For partitioning, failing to prepare one partition, means that commit_inplace_alter_table() will be called to roll back changes for all partitions. This means that commit_inplace_alter_table() might be called without prepare_inplace_alter_table() having been called first for a given partition.

Parameters

altered_table	TABLE object for new version of table.
ha_alter_info	Structure describing changes to be done by ALTER TABLE and holding data used during in-place alter.

Return values

true	Error
false	Success

Reimplemented from handler.

virtual void ha_partition::print_error ( int  error, myf  errflag  )

virtual

Print error that we got from handler function.

Note

In case of delete table it's only safe to use the following parts of the 'table' structure:

• table->s->path
• table->alias

Reimplemented from handler.

virtual int ha_partition::read_range_first ( const key_range *  start_key, const key_range *  end_key, bool  eq_range_arg, bool  sorted  )

virtual

Read first row between two ranges. Store ranges for future calls to read_range_next.

Parameters

start_key	Start key. Is 0 if no min range
end_key	End key. Is 0 if no max range
eq_range_arg	Set to 1 if start_key == end_key
sorted	Set to 1 if result should be sorted per key

Note

Record is read into table->record[0]

Return values

0	Found row
HA_ERR_END_OF_FILE	No rows in range
\::	Error code

Reimplemented from handler.

virtual int ha_partition::read_range_next ( )

virtual

Read next row between two endpoints.

Note

Record is read into table->record[0]

Return values

0	Found row
HA_ERR_END_OF_FILE	No rows in range
\::	Error code

Reimplemented from handler.

virtual double ha_partition::read_time ( uint  index, uint  ranges, ha_rows  rows  )

virtual

The cost of reading a set of ranges from the table using an index to access it.

Parameters

index	The index number.
ranges	The number of ranges to be read.
rows	Total number of rows to be read.

This method can be used to calculate the total cost of scanning a table using an index by calling it using read_time(index, 1, table_size).

Reimplemented from handler.

virtual ha_rows ha_partition::records ( )

virtual

Number of rows in table. It will only be called if (table_flags() & (HA_HAS_RECORDS | HA_STATS_RECORDS_IS_EXACT)) != 0

Reimplemented from handler.

virtual my_bool ha_partition::register_query_cache_table ( THD *  thd, char *  table_key, uint  key_length, qc_engine_callback *  engine_callback, ulonglong *  engine_data  )

inlinevirtual

Register a named table with a call back function to the query cache.

Parameters

	thd	The thread handle
	table_key	A pointer to the table name in the table cache
	key_length	The length of the table name
[out]	engine_callback	The pointer to the storage engine call back function
[out]	engine_data	Storage engine specific data which could be anything

This method offers the storage engine, the possibility to store a reference to a table name which is going to be used with query cache. The method is called each time a statement is written to the cache and can be used to verify if a specific statement is cachable. It also offers the possibility to register a generic (but static) call back function which is called each time a statement is matched against the query cache.

Note

If engine_data supplied with this function is different from engine_data supplied with the callback function, and the callback returns FALSE, a table invalidation on the current table will occur.

Returns

Upon success the engine_callback will point to the storage engine call back function, if any, and engine_data will point to any storage engine data used in the specific implementation.

Return values

TRUE	Success
FALSE	The specified table or current statement should not be cached

Reimplemented from handler.

Definition at line 645 of file ha_partition.h.

virtual int ha_partition::rename_table ( const char *  from, const char *  to  )

virtual

Default rename_table() and delete_table() rename/delete files with a given name and extensions from bas_ext().

These methods can be overridden, but their default implementation provide useful functionality.

Reimplemented from handler.

virtual int ha_partition::repair ( THD *  thd, HA_CHECK_OPT *  check_opt  )

virtual

In this method check_opt can be modified to specify CHECK option to use to call check() upon the table.

Reimplemented from handler.

virtual int ha_partition::reset ( void  )

virtual

Reset state of file to after 'open'. This function is called after every statement for all tables used by that statement.

Reimplemented from handler.

virtual int ha_partition::rnd_init ( bool  scan )

virtual

rnd_init() can be called two times without rnd_end() in between (it only makes sense if scan=1). then the second call should prepare for the new table scan (e.g if rnd_init allocates the cursor, second call should position it to the start of the table, no need to deallocate and allocate it again

Implements handler.

virtual int ha_partition::rnd_next ( uchar *  buf )

virtual

Returns

See Also

index_read_map().

Implements handler.

virtual int ha_partition::rnd_pos ( uchar *  buf, uchar *  pos  )

virtual

Returns

See Also

index_read_map().

Implements handler.

virtual int ha_partition::rnd_pos_by_record ( uchar *  record )

virtual

This function only works for handlers having HA_PRIMARY_KEY_REQUIRED_FOR_POSITION set. It will return the row with the PK given in the record argument.

Reimplemented from handler.

virtual THR_LOCK_DATA** ha_partition::store_lock ( THD *  thd, THR_LOCK_DATA **  to, enum thr_lock_type  lock_type  )

virtual

Is not invoked for non-transactional temporary tables.

Note

store_lock() can return more than one lock if the table is MERGE or partitioned.

that one can NOT rely on table->in_use in store_lock(). It may refer to a different thread if called from mysql_lock_abort_for_thread().

If the table is MERGE, store_lock() can return less locks than lock_count() claimed. This can happen when the MERGE children are not attached when this is called from another thread.

Implements handler.

virtual uint8 ha_partition::table_cache_type ( void  )

virtual

Type of table for caching query

Reimplemented from handler.

virtual const char* ha_partition::table_type ( ) const

virtual

The following can be called without an open handler

Implements handler.

virtual int ha_partition::truncate ( )

virtual

Quickly remove all rows from a table.

Remarks

This method is responsible for implementing MySQL's TRUNCATE TABLE statement, which is a DDL operation. As such, a engine can bypass certain integrity checks and in some cases avoid fine-grained locking (e.g. row locks) which would normally be required for a DELETE statement.

Typically, truncate is not used if it can result in integrity violation. For example, truncate is not used when a foreign key references the table, but it might be used if foreign key checks are disabled.

Engine is responsible for resetting the auto-increment counter.

The table is locked in exclusive mode.

Reimplemented from handler.

virtual void ha_partition::try_semi_consistent_read ( bool  )

virtual

Tell the engine whether it should avoid unnecessary lock waits. If yes, in an UPDATE or DELETE, if the row under the cursor was locked by another transaction, the engine may try an optimistic read of the last committed row value under the cursor.

Reimplemented from handler.

virtual bool ha_partition::was_semi_consistent_read ( void  )

virtual

In an UPDATE or DELETE, if the row under the cursor was locked by another transaction, and the engine used an optimistic read of the last committed row value under the cursor, then the engine returns 1 from this function. MySQL must NOT try to update this optimistic value. If the optimistic value does not match the WHERE condition, MySQL can decide to skip over this row. Currently only works for InnoDB. This can be used to avoid unnecessary lock waits.

If this method returns nonzero, it will also signal the storage engine that the next read will be a locking re-read of the row.

Reimplemented from handler.

---

The documentation for this class was generated from the following file:

• sql/ha_partition.h