drizzle
C++ MySQL-protocol-compatible database server
Loading...
Searching...
No Matches
FunctionCursor Class Reference
Inheritance diagram for FunctionCursor:
[legend]
Collaboration diagram for FunctionCursor:
[legend]

Public Member Functions

 FunctionCursor (drizzled::plugin::StorageEngine &engine, drizzled::Table &table_arg)
int open (const char *name, int mode, uint32_t test_if_locked)
int close (void)
int reset ()
int doStartTableScan (bool scan)
int rnd_next (unsigned char *buf)
int rnd_pos (unsigned char *buf, unsigned char *pos)
int doEndTableScan ()
int extra (enum drizzled::ha_extra_function)
void position (const unsigned char *record)
int info (uint32_t flag)
drizzled::ha_rows estimate_rows_upper_bound ()
void get_auto_increment (uint64_t, uint64_t, uint64_t, uint64_t *, uint64_t *)
Public Member Functions inherited from drizzled::Cursor
plugin::StorageEngine * getEngine () const
TableShare * getShare ()
Table * getTable () const
uint64_t getNextInsertId () const
uint64_t getAutoIncrement () const
 Cursor (plugin::StorageEngine &engine_arg, Table &share_arg)
virtual Cursor * clone (memory::Root *mem_root)
int ha_open (const identifier::Table &identifier, int mode, int test_if_locked)
int startIndexScan (uint32_t idx, bool sorted) __attribute__((warn_unused_result))
int endIndexScan ()
int startTableScan (bool scan) __attribute__((warn_unused_result))
int endTableScan ()
int ha_reset ()
int ha_index_or_rnd_end ()
int ha_external_lock (Session *session, int lock_type)
int insertRecord (unsigned char *buf) __attribute__((warn_unused_result))
int updateRecord (const unsigned char *old_data, unsigned char *new_data) __attribute__((warn_unused_result))
int deleteRecord (const unsigned char *buf) __attribute__((warn_unused_result))
void ha_release_auto_increment ()
int ha_check (Session *)
void ha_start_bulk_insert (ha_rows rows)
int ha_end_bulk_insert ()
int ha_delete_all_rows ()
int ha_reset_auto_increment (uint64_t value)
int ha_analyze (Session *)
int ha_disable_indexes (uint32_t mode)
int ha_enable_indexes (uint32_t mode)
int ha_discard_or_import_tablespace (bool discard)
void closeMarkForDelete ()
void adjust_next_insert_id_after_explicit_value (uint64_t nr)
int update_auto_increment ()
virtual double scan_time (void)
virtual double read_time (uint32_t, uint32_t ranges, ha_rows rows)
virtual double index_only_read_time (uint32_t keynr, double records)
virtual ha_rows multi_range_read_info_const (uint32_t keyno, RANGE_SEQ_IF *seq, void *seq_init_param, uint32_t n_ranges, uint32_t *bufsz, uint32_t *flags, optimizer::CostVector *cost)
virtual int multi_range_read_info (uint32_t keyno, uint32_t n_ranges, uint32_t keys, uint32_t *bufsz, uint32_t *flags, optimizer::CostVector *cost)
virtual int multi_range_read_init (RANGE_SEQ_IF *seq, void *seq_init_param, uint32_t n_ranges, uint32_t mode)
virtual int multi_range_read_next (char **range_info)
virtual const key_map * keys_to_use_for_scanning ()
bool has_transactions ()
virtual bool is_fatal_error (int error, uint32_t flags)
virtual ha_rows records ()
virtual uint64_t tableSize ()
virtual uint64_t rowSize ()
virtual const char * index_type (uint32_t)
uint32_t get_index (void) const
virtual int index_read_map (unsigned char *buf, const unsigned char *key, key_part_map keypart_map, enum ha_rkey_function find_flag)
 Positions an index cursor to the index specified in the handle. Fetches the row if available. If the key value is null, begin at the first key of the index.
virtual int index_read_idx_map (unsigned char *buf, uint32_t index, const unsigned char *key, key_part_map keypart_map, enum ha_rkey_function find_flag)
 Positions an index cursor to the index specified in the handle. Fetches the row if available. If the key value is null, begin at the first key of the index.
virtual int index_next (unsigned char *) __attribute__((warn_unused_result))
virtual int index_prev (unsigned char *)
virtual int index_first (unsigned char *)
virtual int index_last (unsigned char *)
virtual int index_next_same (unsigned char *, const unsigned char *, uint32_t)
virtual int index_read_last_map (unsigned char *buf, const unsigned char *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)
virtual int read_range_next ()
int compare_key (key_range *range)
virtual int read_first_row (unsigned char *buf, uint32_t primary_key)
virtual int rnd_same (unsigned char *, uint32_t)
virtual ha_rows records_in_range (uint32_t, key_range *, key_range *)
virtual uint32_t calculate_key_hash_value (Field **)
virtual int extra (enum ha_extra_function)
virtual int extra_opt (enum ha_extra_function operation, uint32_t)
virtual bool was_semi_consistent_read ()
virtual void try_semi_consistent_read (bool)
virtual void unlock_row (void)
void set_next_insert_id (uint64_t id)
void restore_auto_increment (uint64_t prev_insert_id)
virtual int indexes_are_disabled (void)
virtual void append_create_info (String *)
virtual char * get_foreign_key_create_info (void)
virtual bool can_switch_engines (void)
virtual int get_foreign_key_list (Session *, List< ForeignKeyInfo > *)
virtual uint32_t referenced_by_foreign_key ()
virtual void free_foreign_key_create_info (char *)
virtual THR_LOCK_DATA ** store_lock (Session *, THR_LOCK_DATA **to, enum thr_lock_type)
virtual bool primary_key_is_clustered ()
virtual int cmp_ref (const unsigned char *ref1, const unsigned char *ref2)
virtual bool isOrdered (void)

Private Member Functions

void wipeCache ()
uint32_t max_row_length ()
unsigned int pack_row (const unsigned char *record)

Private Attributes

drizzled::plugin::TableFunction * tool
drizzled::plugin::TableFunction::Generator * generator
size_t row_cache_position
std::vector< unsigned char > row_cache
drizzled::ha_rows estimate_of_rows
drizzled::ha_rows rows_returned
std::vector< unsigned char > record_buffer

Additional Inherited Members

Public Types inherited from drizzled::Cursor
enum  { NONE =0 , INDEX , RND }
Public Attributes inherited from drizzled::Cursor
unsigned char * ref
unsigned char * dup_ref
ha_statistics stats
range_seq_t mrr_iter
RANGE_SEQ_IF mrr_funcs
uint32_t ranges_in_seq
bool mrr_is_output_sorted
bool mrr_have_range
bool eq_range
KEY_MULTI_RANGE mrr_cur_range
key_range save_end_range
key_range * end_range
KeyPartInfo * range_key_part
int key_compare_result_on_equal
uint32_t errkey
uint32_t key_used_on_scan
uint32_t active_index
uint32_t ref_length
enum drizzled::Cursor:: { ... }  inited
bool locked
uint64_t next_insert_id
uint64_t insert_id_for_cur_row
Discrete_interval auto_inc_interval_for_cur_row
Protected Member Functions inherited from drizzled::Cursor
void ha_statistic_increment (uint64_t system_status_var::*offset) const
void ** ha_data (Session *) const
Protected Attributes inherited from drizzled::Cursor
ha_rows estimation_rows_to_insert

Detailed Description

Definition at line 28 of file plugin/function_engine/cursor.h.

Constructor & Destructor Documentation

◆ FunctionCursor()

FunctionCursor::FunctionCursor ( drizzled::plugin::StorageEngine & engine,
drizzled::Table & table_arg )

Definition at line 42 of file plugin/function_engine/cursor.cc.

◆ ~FunctionCursor()

FunctionCursor::~FunctionCursor ( )
inline

Definition at line 46 of file plugin/function_engine/cursor.h.

Member Function Documentation

◆ close()

int FunctionCursor::close ( void )
virtual

Implements drizzled::Cursor.

Definition at line 62 of file plugin/function_engine/cursor.cc.

◆ doEndTableScan()

int FunctionCursor::doEndTableScan ( void )
virtual

Reimplemented from drizzled::Cursor.

Definition at line 185 of file plugin/function_engine/cursor.cc.

◆ doStartTableScan()

int FunctionCursor::doStartTableScan ( bool scan)
virtual

doStartTableScan() can be called two times without doEndTableScan() 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 drizzled::Cursor.

Definition at line 70 of file plugin/function_engine/cursor.cc.

◆ estimate_rows_upper_bound()

drizzled::ha_rows FunctionCursor::estimate_rows_upper_bound ( void )
inlinevirtual
Returns
an upper bound estimate for the number of rows in the table

Reimplemented from drizzled::Cursor.

Definition at line 77 of file plugin/function_engine/cursor.h.

◆ extra()

int FunctionCursor::extra ( enum drizzled::ha_extra_function operation)

Definition at line 167 of file plugin/function_engine/cursor.cc.

◆ get_auto_increment()

void FunctionCursor::get_auto_increment ( uint64_t ,
uint64_t ,
uint64_t ,
uint64_t * ,
uint64_t *  )
inlinevirtual

Implements drizzled::Cursor.

Definition at line 82 of file plugin/function_engine/cursor.h.

◆ info()

int FunctionCursor::info ( uint32_t flag)
virtual

Implements drizzled::Cursor.

Definition at line 216 of file plugin/function_engine/cursor.cc.

◆ max_row_length()

uint32_t FunctionCursor::max_row_length ( )
private

Definition at line 106 of file plugin/function_engine/cursor.cc.

◆ open()

int FunctionCursor::open ( const char * name,
int mode,
uint32_t test_if_locked )
virtual

Reimplemented from drizzled::Cursor.

Definition at line 49 of file plugin/function_engine/cursor.cc.

◆ pack_row()

unsigned int FunctionCursor::pack_row ( const unsigned char * record)
private

Definition at line 121 of file plugin/function_engine/cursor.cc.

◆ position()

void FunctionCursor::position ( const unsigned char * record)
virtual

Implements drizzled::Cursor.

Definition at line 140 of file plugin/function_engine/cursor.cc.

◆ reset()

int FunctionCursor::reset ( void )
inlinevirtual

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

Reimplemented from drizzled::Cursor.

Definition at line 52 of file plugin/function_engine/cursor.h.

◆ rnd_next()

int FunctionCursor::rnd_next ( unsigned char * buf)
virtual

Implements drizzled::Cursor.

Definition at line 79 of file plugin/function_engine/cursor.cc.

◆ rnd_pos()

int FunctionCursor::rnd_pos ( unsigned char * buf,
unsigned char * pos )
virtual

Implements drizzled::Cursor.

Definition at line 192 of file plugin/function_engine/cursor.cc.

◆ wipeCache()

void FunctionCursor::wipeCache ( )
private

Definition at line 158 of file plugin/function_engine/cursor.cc.

Member Data Documentation

◆ estimate_of_rows

drizzled::ha_rows FunctionCursor::estimate_of_rows
private

Definition at line 34 of file plugin/function_engine/cursor.h.

◆ generator

drizzled::plugin::TableFunction::Generator* FunctionCursor::generator
private

Definition at line 31 of file plugin/function_engine/cursor.h.

◆ record_buffer

std::vector<unsigned char> FunctionCursor::record_buffer
private

Definition at line 39 of file plugin/function_engine/cursor.h.

◆ row_cache

std::vector<unsigned char> FunctionCursor::row_cache
private

Definition at line 33 of file plugin/function_engine/cursor.h.

◆ row_cache_position

size_t FunctionCursor::row_cache_position
private

Definition at line 32 of file plugin/function_engine/cursor.h.

◆ rows_returned

drizzled::ha_rows FunctionCursor::rows_returned
private

Definition at line 35 of file plugin/function_engine/cursor.h.

◆ tool

drizzled::plugin::TableFunction* FunctionCursor::tool
private

Definition at line 30 of file plugin/function_engine/cursor.h.


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