home *** CD-ROM | disk | FTP | other *** search
/ Chip 2001 January / Chip_2001-01_cd1.bin / tema / mysql / mysql-3.23.28g-win-source.exe / sql / handler.h < prev    next >
C/C++ Source or Header  |  2000-11-16  |  12KB  |  312 lines
  1. /* Copyright (C) 2000 MySQL AB & MySQL Finland AB & TCX DataKonsult AB
  2.  
  3.    This program is free software; you can redistribute it and/or modify
  4.    it under the terms of the GNU General Public License as published by
  5.    the Free Software Foundation; either version 2 of the License, or
  6.    (at your option) any later version.
  7.  
  8.    This program is distributed in the hope that it will be useful,
  9.    but WITHOUT ANY WARRANTY; without even the implied warranty of
  10.    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11.    GNU General Public License for more details.
  12.  
  13.    You should have received a copy of the GNU General Public License
  14.    along with this program; if not, write to the Free Software
  15.    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
  16.  
  17.  
  18. /* Definitions for parameters to do with handler-routines */
  19.  
  20. #ifdef __GNUC__
  21. #pragma interface            /* gcc class implementation */
  22. #endif
  23.  
  24. #ifndef NO_HASH
  25. #define NO_HASH                /* Not yet implemented */
  26. #endif
  27.  
  28. // the following is for checking tables
  29.  
  30. #define HA_ADMIN_ALREADY_DONE      1
  31. #define HA_ADMIN_OK               0
  32. #define HA_ADMIN_NOT_IMPLEMENTED -1
  33. #define HA_ADMIN_FAILED         -2
  34. #define HA_ADMIN_CORRUPT         -3
  35. #define HA_ADMIN_INTERNAL_ERROR  -4
  36. #define HA_ADMIN_INVALID         -5
  37.  
  38. /* Bits in bas_flag to show what database can do */
  39.  
  40. #define HA_READ_NEXT        1    /* Read next record with same key */
  41. #define HA_READ_PREV        2    /* Read prev. record with same key */
  42. #define HA_READ_ORDER        4    /* Read through record-keys in order */
  43. #define HA_READ_RND_SAME    8    /* Read RND-record to KEY-record
  44.                        (To update with RND-read)       */
  45. #define HA_KEYPOS_TO_RNDPOS    16    /* ha_info gives pos to record */
  46. #define HA_LASTKEY_ORDER    32    /* Next record gives next record
  47.                       according last record read (even
  48.                       if database is updated after read) */
  49. #define HA_REC_NOT_IN_SEQ    64    /* ha_info don't return recnumber;
  50.                        It returns a position to ha_r_rnd */
  51. #define HA_ONLY_WHOLE_INDEX    128    /* Can't use part key searches */
  52. #define HA_RSAME_NO_INDEX    256    /* RSAME can't restore index */
  53. #define HA_WRONG_ASCII_ORDER    512    /* Can't use sorting through key */
  54. #define HA_HAVE_KEY_READ_ONLY    1024    /* Can read only keys (no record) */
  55. #define HA_READ_NOT_EXACT_KEY    2048    /* Can read record after/before key */
  56. #define HA_NO_INDEX        4096    /* No index needed for next/prev */
  57. #define HA_LONGLONG_KEYS    8192    /* Can have longlong as key */
  58. #define HA_KEY_READ_WRONG_STR    16384    /* keyread returns converted strings */
  59. #define HA_NULL_KEY        32768    /* One can have keys with NULL */
  60. #define HA_DUPP_POS        65536    /* ha_position() gives dupp row */
  61. #define HA_NO_BLOBS        131072    /* Doesn't support blobs */
  62. #define HA_BLOB_KEY        (HA_NO_BLOBS*2) /* key on blob */
  63. #define HA_AUTO_PART_KEY    (HA_BLOB_KEY*2)
  64. #define HA_REQUIRE_PRIMARY_KEY    (HA_AUTO_PART_KEY*2)
  65. #define HA_NOT_EXACT_COUNT    (HA_REQUIRE_PRIMARY_KEY*2)
  66. #define HA_NO_WRITE_DELAYED    (HA_NOT_EXACT_COUNT*2)
  67. #define HA_PRIMARY_KEY_IN_READ_INDEX (HA_NO_WRITE_DELAYED*2)
  68. #define HA_DROP_BEFORE_CREATE    (HA_PRIMARY_KEY_IN_READ_INDEX*2)
  69.  
  70.     /* Parameters for open() (in register form->filestat) */
  71.     /* HA_GET_INFO does a implicit HA_ABORT_IF_LOCKED */
  72.  
  73. #define HA_OPEN_KEYFILE        1
  74. #define HA_OPEN_RNDFILE        2
  75. #define HA_GET_INDEX        4
  76. #define HA_GET_INFO        8    /* do a ha_info() after open */
  77. #define HA_READ_ONLY        16    /* File opened as readonly */
  78. #define HA_TRY_READ_ONLY    32    /* Try readonly if can't */
  79.                     /* open with read and write */
  80. #define HA_WAIT_IF_LOCKED    64    /* Wait if locked on open */
  81. #define HA_ABORT_IF_LOCKED    128    /* skip if locked on open.*/
  82. #define HA_BLOCK_LOCK        256    /* unlock when reading some records */
  83. #define HA_OPEN_TEMPORARY    512
  84.  
  85.     /* Error on write which is recoverable  (Key exist) */
  86.  
  87. #define HA_WRITE_SKIPP 121        /* Duplicate key on write */
  88. #define HA_READ_CHECK 123        /* Update with is recoverable */
  89. #define HA_CANT_DO_THAT 131        /* Databasehandler can't do it */
  90.  
  91.     /* Some key definitions */
  92. #define HA_KEY_NULL_LENGTH    1
  93. #define HA_KEY_BLOB_LENGTH    2
  94.  
  95. #define HA_LEX_CREATE_TMP_TABLE    1
  96. #define HA_LEX_CREATE_IF_NOT_EXISTS 2
  97. #define HA_OPTION_NO_CHECKSUM    (1L << 17)
  98. #define HA_OPTION_NO_DELAY_KEY_WRITE (1L << 18)
  99. #define HA_MAX_REC_LENGTH    65535
  100.  
  101. enum db_type { DB_TYPE_UNKNOWN=0,DB_TYPE_DIAB_ISAM=1,
  102.            DB_TYPE_HASH,DB_TYPE_MISAM,DB_TYPE_PISAM,
  103.            DB_TYPE_RMS_ISAM, DB_TYPE_HEAP, DB_TYPE_ISAM,
  104.            DB_TYPE_MRG_ISAM, DB_TYPE_MYISAM, DB_TYPE_MRG_MYISAM,
  105.            DB_TYPE_BERKELEY_DB, DB_TYPE_INNOBASE,
  106.            DB_TYPE_DEFAULT };
  107.  
  108. enum row_type { ROW_TYPE_DEFAULT, ROW_TYPE_FIXED, ROW_TYPE_DYNAMIC,
  109.             ROW_TYPE_COMPRESSED };
  110.  
  111. /* struct to hold information about the table that should be created */
  112.  
  113. /* Bits in used_fields */
  114. #define HA_CREATE_USED_AUTO 1
  115. #define HA_CREATE_USED_RAID 2
  116.  
  117. typedef struct st_ha_create_information
  118. {
  119.   ulong table_options;
  120.   enum db_type db_type;
  121.   enum row_type row_type;
  122.   ulong avg_row_length;
  123.   ulonglong max_rows,min_rows;
  124.   ulonglong auto_increment_value;
  125.   char *comment,*password;
  126.   uint options;                    /* OR of HA_CREATE_ options */
  127.   uint raid_type,raid_chunks;
  128.   ulong raid_chunksize;
  129.   bool if_not_exists;
  130.   ulong used_fields;
  131.   SQL_LIST merge_list;
  132. } HA_CREATE_INFO;
  133.  
  134.  
  135. /* The handler for a table type.  Will be included in the TABLE structure */
  136.  
  137. struct st_table;
  138. typedef struct st_table TABLE;
  139. extern ulong myisam_sort_buffer_size;
  140.  
  141. typedef struct st_ha_check_opt
  142. {
  143.   ulong sort_buffer_size;
  144.   uint flags;
  145.   bool quick;
  146.   bool changed_files;
  147.   bool optimize;
  148.   bool retry_without_quick;
  149.   inline void init()
  150.   {
  151.     flags= 0; quick= optimize= retry_without_quick=0;
  152.     sort_buffer_size = myisam_sort_buffer_size;
  153.   }
  154. } HA_CHECK_OPT;
  155.  
  156. class handler :public Sql_alloc
  157. {
  158.  protected:
  159.   struct st_table *table;        /* The table definition */
  160.   uint  active_index;
  161.  
  162. public:
  163.   byte *ref;                /* Pointer to current row */
  164.   byte *dupp_ref;            /* Pointer to dupp row */
  165.   uint ref_length;            /* Length of ref (1-8) */
  166.   uint block_size;            /* index block size */
  167.   ha_rows records;            /* Records i datafilen */
  168.   ha_rows deleted;            /* Deleted records */
  169.   ulonglong data_file_length;        /* Length off data file */
  170.   ulonglong max_data_file_length;    /* Length off data file */
  171.   ulonglong index_file_length;
  172.   ulonglong max_index_file_length;
  173.   ulonglong delete_length;        /* Free bytes */
  174.   ulonglong auto_increment_value;
  175.   uint raid_type,raid_chunks;
  176.   ulong raid_chunksize;
  177.   uint errkey;                /* Last dup key */
  178.   uint sortkey, key_used_on_scan;
  179.   time_t create_time;            /* When table was created */
  180.   time_t check_time;
  181.   time_t update_time;
  182.   ulong mean_rec_length;        /* physical reclength */
  183.   void  *ft_handler;
  184.  
  185.   handler(TABLE *table_arg) : table(table_arg),active_index(MAX_REF_PARTS),
  186.     ref(0),ref_length(sizeof(my_off_t)), block_size(0),records(0),deleted(0),
  187.     data_file_length(0), max_data_file_length(0), index_file_length(0),
  188.     delete_length(0), auto_increment_value(0), raid_type(0),
  189.     key_used_on_scan(MAX_KEY),
  190.     create_time(0), check_time(0), update_time(0), mean_rec_length(0),
  191.     ft_handler(0)
  192.     {}
  193.   virtual ~handler(void) {}
  194.   int ha_open(const char *name, int mode, int test_if_locked);
  195.   void update_timestamp(byte *record);
  196.   void update_auto_increment();
  197.   void print_error(int error, myf errflag);
  198.   uint get_dup_key(int error);
  199.   void change_table_ptr(TABLE *table_arg) { table=table_arg; }
  200.   virtual double scan_time()
  201.     { return ulonglong2double(data_file_length) / IO_SIZE + 1; }
  202.   virtual double read_time(ha_rows rows) { return rows; }
  203.   virtual bool fast_key_read() { return 0;}
  204.   virtual bool has_transactions(){ return 0;}
  205.   virtual uint extra_rec_buf_length() { return 0; }
  206.   virtual ha_rows estimate_number_of_rows() { return records+EXTRA_RECORDS; }
  207.  
  208.   virtual int index_init(uint idx) { active_index=idx; return 0;}
  209.   virtual int index_end() {return 0; }
  210.   uint get_index(void) const { return active_index; }
  211.   virtual int open(const char *name, int mode, uint test_if_locked)=0;
  212.   virtual void initialize(void) {}
  213.   virtual int close(void)=0;
  214.   virtual int write_row(byte * buf)=0;
  215.   virtual int update_row(const byte * old_data, byte * new_data)=0;
  216.   virtual int delete_row(const byte * buf)=0;
  217.   virtual int index_read(byte * buf, const byte * key,
  218.                  uint key_len, enum ha_rkey_function find_flag)=0;
  219.   virtual int index_read_idx(byte * buf, uint index, const byte * key,
  220.                  uint key_len, enum ha_rkey_function find_flag)=0;
  221.   virtual int index_next(byte * buf)=0;
  222.   virtual int index_prev(byte * buf)=0;
  223.   virtual int index_first(byte * buf)=0;
  224.   virtual int index_last(byte * buf)=0;
  225.   virtual int index_next_same(byte *buf, const byte *key, uint keylen);
  226.   virtual int ft_init()
  227.                                  { return -1; }
  228.   virtual void *ft_init_ext(uint inx,const byte *key, uint keylen, bool presort)
  229.                                  { return (void *)NULL; }
  230.   virtual int ft_read(byte *buf) { return -1; }
  231.   virtual int rnd_init(bool scan=1)=0;
  232.   virtual int rnd_end() { return 0; }
  233.   virtual int rnd_next(byte *buf)=0;
  234.   virtual int rnd_pos(byte * buf, byte *pos)=0;
  235.   virtual int rnd_first(byte *buf);
  236.   virtual int restart_rnd_next(byte *buf, byte *pos);
  237.   virtual ha_rows records_in_range(int inx,
  238.                        const byte *start_key,uint start_key_len,
  239.                        enum ha_rkey_function start_search_flag,
  240.                        const byte *end_key,uint end_key_len,
  241.                        enum ha_rkey_function end_search_flag)
  242.     { return (ha_rows) 10; }
  243.   virtual void position(const byte *record)=0;
  244.   virtual my_off_t row_position() { return HA_OFFSET_ERROR; }
  245.   virtual void info(uint)=0;
  246.   virtual int extra(enum ha_extra_function operation)=0;
  247.   virtual int reset()=0;
  248.   virtual int external_lock(THD *thd, int lock_type)=0;
  249.   virtual int delete_all_rows();
  250.   virtual longlong get_auto_increment();
  251.   virtual void update_create_info(HA_CREATE_INFO *create_info) {}
  252.   virtual int check(THD* thd,   HA_CHECK_OPT* check_opt );
  253.   virtual int repair(THD* thd,  HA_CHECK_OPT* check_opt);
  254.   virtual bool check_and_repair(THD *thd) {return 1;}
  255.   virtual int optimize(THD* thd,HA_CHECK_OPT* check_opt);
  256.   virtual int analyze(THD* thd, HA_CHECK_OPT* check_opt);
  257.   virtual int backup(THD* thd, HA_CHECK_OPT* check_opt);
  258.   virtual int restore(THD* thd, HA_CHECK_OPT* check_opt);
  259.   // assumes .frm file must exist, and you must have already called
  260.   // generate_table() - it will just copy the data file and run repair
  261.  
  262.   virtual int dump(THD* thd, int fd = -1) { return ER_DUMP_NOT_IMPLEMENTED; }
  263.   virtual void deactivate_non_unique_index(ha_rows rows) {}
  264.   virtual bool activate_all_index(THD *thd) {return 0;}
  265.   // not implemented by default
  266.   virtual int net_read_dump(NET* net)
  267.   { return ER_DUMP_NOT_IMPLEMENTED; }
  268.  
  269.   /* The following can be called without an open handler */
  270.   virtual const char *table_type() const =0;
  271.   virtual const char **bas_ext() const =0;
  272.   virtual ulong option_flag() const =0;
  273.   virtual uint max_record_length() const =0;
  274.   virtual uint max_keys() const =0;
  275.   virtual uint max_key_parts() const =0;
  276.   virtual uint max_key_length()const =0;
  277.   virtual uint max_key_part_length() { return 255; }
  278.   virtual uint min_record_length(uint options) const { return 1; }
  279.   virtual bool low_byte_first() const { return 1; }
  280.   virtual bool is_crashed() const  { return 0; }
  281.   virtual bool auto_repair() const { return 0; }
  282.  
  283.   virtual int rename_table(const char *from, const char *to);
  284.   virtual int delete_table(const char *name);
  285.   virtual int create(const char *name, TABLE *form, HA_CREATE_INFO *info)=0;
  286.   virtual uint lock_count(void) const { return 1; }
  287.   virtual THR_LOCK_DATA **store_lock(THD *thd,
  288.                      THR_LOCK_DATA **to,
  289.                      enum thr_lock_type lock_type)=0;
  290. };
  291.  
  292.     /* Some extern variables used with handlers */
  293.  
  294. extern const char *ha_row_type[];
  295. extern TYPELIB ha_table_typelib;
  296.  
  297. handler *get_new_handler(TABLE *table, enum db_type db_type);
  298. my_off_t ha_get_ptr(byte *ptr, uint pack_length);
  299. void ha_store_ptr(byte *buff, uint pack_length, my_off_t pos);
  300. int ha_init(void);
  301. int ha_panic(enum ha_panic_function flag);
  302. enum db_type ha_checktype(enum db_type database_type);
  303. int ha_create_table(const char *name, HA_CREATE_INFO *create_info,
  304.             bool update_create_info);
  305. int ha_delete_table(enum db_type db_type, const char *path);
  306. void ha_key_cache(void);
  307. int ha_commit(THD *thd);
  308. int ha_rollback(THD *thd);
  309. int ha_autocommit_or_rollback(THD *thd, int error);
  310. bool ha_flush_logs(void);
  311.  
  312.