ha_example.h
上传用户:romrleung
上传日期:2022-05-23
资源大小:18897k
文件大小:6k
源码类别:

MySQL数据库

开发平台:

Visual C++

  1. /* Copyright (C) 2003 MySQL AB
  2.   This program is free software; you can redistribute it and/or modify
  3.   it under the terms of the GNU General Public License as published by
  4.   the Free Software Foundation; either version 2 of the License, or
  5.   (at your option) any later version.
  6.   This program is distributed in the hope that it will be useful,
  7.   but WITHOUT ANY WARRANTY; without even the implied warranty of
  8.   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  9.   GNU General Public License for more details.
  10.   You should have received a copy of the GNU General Public License
  11.   along with this program; if not, write to the Free Software
  12.   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
  13. /*
  14.   Please read ha_exmple.cc before reading this file.
  15.   Please keep in mind that the example storage engine implements all methods
  16.   that are required to be implemented. handler.h has a full list of methods
  17.   that you can implement.
  18. */
  19. #ifdef USE_PRAGMA_INTERFACE
  20. #pragma interface /* gcc class implementation */
  21. #endif
  22. /*
  23.   EXAMPLE_SHARE is a structure that will be shared amoung all open handlers
  24.   The example implements the minimum of what you will probably need.
  25. */
  26. typedef struct st_example_share {
  27.   char *table_name;
  28.   uint table_name_length,use_count;
  29.   pthread_mutex_t mutex;
  30.   THR_LOCK lock;
  31. } EXAMPLE_SHARE;
  32. /*
  33.   Class definition for the storage engine
  34. */
  35. class ha_example: public handler
  36. {
  37.   THR_LOCK_DATA lock;      /* MySQL lock */
  38.   EXAMPLE_SHARE *share;    /* Shared lock info */
  39. public:
  40.   ha_example(TABLE *table): handler(table)
  41.   {
  42.   }
  43.   ~ha_example()
  44.   {
  45.   }
  46.   /* The name that will be used for display purposes */
  47.   const char *table_type() const { return "EXAMPLE"; }
  48.   /*
  49.     The name of the index type that will be used for display
  50.     don't implement this method unless you really have indexes
  51.    */
  52.   const char *index_type(uint inx) { return "HASH"; }
  53.   const char **bas_ext() const;
  54.   /*
  55.     This is a list of flags that says what the storage engine
  56.     implements. The current table flags are documented in
  57.     handler.h
  58.   */
  59.   ulong table_flags() const
  60.   {
  61.     return 0;
  62.   }
  63.   /*
  64.     This is a bitmap of flags that says how the storage engine
  65.     implements indexes. The current index flags are documented in
  66.     handler.h. If you do not implement indexes, just return zero
  67.     here.
  68.     part is the key part to check. First key part is 0
  69.     If all_parts it's set, MySQL want to know the flags for the combined
  70.     index up to and including 'part'.
  71.   */
  72.   ulong index_flags(uint inx, uint part, bool all_parts) const
  73.   {
  74.     return 0;
  75.   }
  76.   /*
  77.     unireg.cc will call the following to make sure that the storage engine can
  78.     handle the data it is about to send.
  79.     Return *real* limits of your storage engine here. MySQL will do
  80.     min(your_limits, MySQL_limits) automatically
  81.     There is no need to implement ..._key_... methods if you don't suport
  82.     indexes.
  83.   */
  84.   uint max_supported_record_length() const { return HA_MAX_REC_LENGTH; }
  85.   uint max_supported_keys()          const { return 0; }
  86.   uint max_supported_key_parts()     const { return 0; }
  87.   uint max_supported_key_length()    const { return 0; }
  88.   /*
  89.     Called in test_quick_select to determine if indexes should be used.
  90.   */
  91.   virtual double scan_time() { return (double) (records+deleted) / 20.0+10; }
  92.   /*
  93.     The next method will never be called if you do not implement indexes.
  94.   */
  95.   virtual double read_time(ha_rows rows) { return (double) rows /  20.0+1; }
  96.   /*
  97.     Everything below are methods that we implment in ha_example.cc.
  98.     Most of these methods are not obligatory, skip them and
  99.     MySQL will treat them as not implemented
  100.   */
  101.   int open(const char *name, int mode, uint test_if_locked);    // required
  102.   int close(void);                                              // required
  103.   int write_row(byte * buf);
  104.   int update_row(const byte * old_data, byte * new_data);
  105.   int delete_row(const byte * buf);
  106.   int index_read(byte * buf, const byte * key,
  107.                  uint key_len, enum ha_rkey_function find_flag);
  108.   int index_read_idx(byte * buf, uint idx, const byte * key,
  109.                      uint key_len, enum ha_rkey_function find_flag);
  110.   int index_next(byte * buf);
  111.   int index_prev(byte * buf);
  112.   int index_first(byte * buf);
  113.   int index_last(byte * buf);
  114.   /*
  115.     unlike index_init(), rnd_init() can be called two times
  116.     without rnd_end() in between (it only makes sense if scan=1).
  117.     then the second call should prepare for the new table scan
  118.     (e.g if rnd_init allocates the cursor, second call should
  119.     position it to the start of the table, no need to deallocate
  120.     and allocate it again
  121.   */
  122.   int rnd_init(bool scan);                                      //required
  123.   int rnd_end();
  124.   int rnd_next(byte *buf);                                      //required
  125.   int rnd_pos(byte * buf, byte *pos);                           //required
  126.   void position(const byte *record);                            //required
  127.   void info(uint);                                              //required
  128.   int extra(enum ha_extra_function operation);
  129.   int reset(void);
  130.   int external_lock(THD *thd, int lock_type);                   //required
  131.   int delete_all_rows(void);
  132.   ha_rows records_in_range(uint inx, key_range *min_key,
  133.                            key_range *max_key);
  134.   int delete_table(const char *from);
  135.   int rename_table(const char * from, const char * to);
  136.   int create(const char *name, TABLE *form,
  137.              HA_CREATE_INFO *create_info);                      //required
  138.   THR_LOCK_DATA **store_lock(THD *thd, THR_LOCK_DATA **to,
  139.                              enum thr_lock_type lock_type);     //required
  140. };