MySQL 8.0.31
Source Code Documentation
QUICK_RANGE Class Reference

#include <range_optimizer.h>

Public Member Functions

 QUICK_RANGE ()
 
 QUICK_RANGE (MEM_ROOT *mem_root, const uchar *min_key_arg, uint min_length_arg, key_part_map min_keypart_map_arg, const uchar *max_key_arg, uint max_length_arg, key_part_map max_keypart_map_arg, uint flag_arg, enum ha_rkey_function rkey_func)
 
void make_min_endpoint (key_range *kr, uint prefix_length, key_part_map keypart_map)
 Initializes a key_range object for communication with storage engine. More...
 
void make_min_endpoint (key_range *kr)
 Initializes a key_range object for communication with storage engine. More...
 
void make_max_endpoint (key_range *kr, uint prefix_length, key_part_map keypart_map)
 Initializes a key_range object for communication with storage engine. More...
 
void make_max_endpoint (key_range *kr)
 Initializes a key_range object for communication with storage engine. More...
 

Public Attributes

ucharmin_key
 
ucharmax_key
 
uint16 min_length
 
uint16 max_length
 
uint16 flag
 Stores bitwise-or'ed bits defined in enum key_range_flags. More...
 
enum ha_rkey_function rkey_func_flag
 Stores one of the HA_READ_MBR_XXX items in enum ha_rkey_function, only effective when flag has a GEOM_FLAG bit. More...
 
key_part_map min_keypart_map
 
key_part_map max_keypart_map
 

Constructor & Destructor Documentation

◆ QUICK_RANGE() [1/2]

QUICK_RANGE::QUICK_RANGE ( )

◆ QUICK_RANGE() [2/2]

QUICK_RANGE::QUICK_RANGE ( MEM_ROOT mem_root,
const uchar min_key_arg,
uint  min_length_arg,
key_part_map  min_keypart_map_arg,
const uchar max_key_arg,
uint  max_length_arg,
key_part_map  max_keypart_map_arg,
uint  flag_arg,
enum ha_rkey_function  rkey_func 
)

Member Function Documentation

◆ make_max_endpoint() [1/2]

void QUICK_RANGE::make_max_endpoint ( key_range kr)
inline

Initializes a key_range object for communication with storage engine.

This function facilitates communication with the Storage Engine API by translating the maximum endpoint of the interval represented by this QUICK_RANGE into an index range endpoint specifier for the engine.

Parameters
krPointer to an uninitialized key_range C struct.

◆ make_max_endpoint() [2/2]

void QUICK_RANGE::make_max_endpoint ( key_range kr,
uint  prefix_length,
key_part_map  keypart_map 
)
inline

Initializes a key_range object for communication with storage engine.

This function facilitates communication with the Storage Engine API by translating the maximum endpoint of the interval represented by this QUICK_RANGE into an index range endpoint specifier for the engine.

Parameters
krPointer to an uninitialized key_range C struct.
prefix_lengthThe length of the search key prefix to be used for lookup.
keypart_mapA set (bitmap) of keyparts to be used.

◆ make_min_endpoint() [1/2]

void QUICK_RANGE::make_min_endpoint ( key_range kr)
inline

Initializes a key_range object for communication with storage engine.

This function facilitates communication with the Storage Engine API by translating the minimum endpoint of the interval represented by this QUICK_RANGE into an index range endpoint specifier for the engine.

Parameters
krPointer to an uninitialized key_range C struct.

◆ make_min_endpoint() [2/2]

void QUICK_RANGE::make_min_endpoint ( key_range kr,
uint  prefix_length,
key_part_map  keypart_map 
)
inline

Initializes a key_range object for communication with storage engine.

This function facilitates communication with the Storage Engine API by translating the minimum endpoint of the interval represented by this QUICK_RANGE into an index range endpoint specifier for the engine.

Parameters
krPointer to an uninitialized key_range C struct.
prefix_lengthThe length of the search key prefix to be used for lookup.
keypart_mapA set (bitmap) of keyparts to be used.

Member Data Documentation

◆ flag

uint16 QUICK_RANGE::flag

Stores bitwise-or'ed bits defined in enum key_range_flags.

◆ max_key

uchar * QUICK_RANGE::max_key

◆ max_keypart_map

key_part_map QUICK_RANGE::max_keypart_map

◆ max_length

uint16 QUICK_RANGE::max_length

◆ min_key

uchar* QUICK_RANGE::min_key

◆ min_keypart_map

key_part_map QUICK_RANGE::min_keypart_map

◆ min_length

uint16 QUICK_RANGE::min_length

◆ rkey_func_flag

enum ha_rkey_function QUICK_RANGE::rkey_func_flag

Stores one of the HA_READ_MBR_XXX items in enum ha_rkey_function, only effective when flag has a GEOM_FLAG bit.


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