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

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.   ha_example is a stubbed storage engine. It does nothing at this point. It
  15.   will let you create/open/delete tables but that is all. You can enable it
  16.   in your buld by doing the following during your build process:
  17.   ./configure --with-example-storage-engine
  18.   Once this is done mysql will let you create tables with:
  19.   CREATE TABLE A (...) ENGINE=EXAMPLE;
  20.   The example is setup to use table locks. It implements an example "SHARE"
  21.   that is inserted into a hash by table name. You can use this to store
  22.   information of state that any example handler object will be able to see
  23.   if it is using the same table.
  24.   Please read the object definition in ha_example.h before reading the rest
  25.   if this file.
  26.   To get an idea of what occurs here is an example select that would do a
  27.   scan of an entire table:
  28.   ha_example::store_lock
  29.   ha_example::external_lock
  30.   ha_example::info
  31.   ha_example::rnd_init
  32.   ha_example::extra
  33.   ENUM HA_EXTRA_CACHE   Cash record in HA_rrnd()
  34.   ha_example::rnd_next
  35.   ha_example::rnd_next
  36.   ha_example::rnd_next
  37.   ha_example::rnd_next
  38.   ha_example::rnd_next
  39.   ha_example::rnd_next
  40.   ha_example::rnd_next
  41.   ha_example::rnd_next
  42.   ha_example::rnd_next
  43.   ha_example::extra
  44.   ENUM HA_EXTRA_NO_CACHE   End cacheing of records (def)
  45.   ha_example::external_lock
  46.   ha_example::extra
  47.   ENUM HA_EXTRA_RESET   Reset database to after open
  48.   In the above example has 9 row called before rnd_next signalled that it was
  49.   at the end of its data. In the above example the table was already opened
  50.   (or you would have seen a call to ha_example::open(). Calls to
  51.   ha_example::extra() are hints as to what will be occuring to the request.
  52.   Happy coding!
  53.     -Brian
  54. */
  55. #ifdef USE_PRAGMA_IMPLEMENTATION
  56. #pragma implementation        // gcc: Class implementation
  57. #endif
  58. #include "../mysql_priv.h"
  59. #ifdef HAVE_EXAMPLE_DB
  60. #include "ha_example.h"
  61. /* Variables for example share methods */
  62. static HASH example_open_tables; // Hash used to track open tables
  63. pthread_mutex_t example_mutex;   // This is the mutex we use to init the hash
  64. static int example_init= 0;      // Variable for checking the init state of hash
  65. /*
  66.   Function we use in the creation of our hash to get key.
  67. */
  68. static byte* example_get_key(EXAMPLE_SHARE *share,uint *length,
  69.                              my_bool not_used __attribute__((unused)))
  70. {
  71.   *length=share->table_name_length;
  72.   return (byte*) share->table_name;
  73. }
  74. /*
  75.   Example of simple lock controls. The "share" it creates is structure we will
  76.   pass to each example handler. Do you have to have one of these? Well, you have
  77.   pieces that are used for locking, and they are needed to function.
  78. */
  79. static EXAMPLE_SHARE *get_share(const char *table_name, TABLE *table)
  80. {
  81.   EXAMPLE_SHARE *share;
  82.   uint length;
  83.   char *tmp_name;
  84.   /*
  85.     So why does this exist? There is no way currently to init a storage engine.
  86.     Innodb and BDB both have modifications to the server to allow them to
  87.     do this. Since you will not want to do this, this is probably the next
  88.     best method.
  89.   */
  90.   if (!example_init)
  91.   {
  92.     /* Hijack a mutex for init'ing the storage engine */
  93.     pthread_mutex_lock(&LOCK_mysql_create_db);
  94.     if (!example_init)
  95.     {
  96.       example_init++;
  97.       VOID(pthread_mutex_init(&example_mutex,MY_MUTEX_INIT_FAST));
  98.       (void) hash_init(&example_open_tables,system_charset_info,32,0,0,
  99.                        (hash_get_key) example_get_key,0,0);
  100.     }
  101.     pthread_mutex_unlock(&LOCK_mysql_create_db);
  102.   }
  103.   pthread_mutex_lock(&example_mutex);
  104.   length=(uint) strlen(table_name);
  105.   if (!(share=(EXAMPLE_SHARE*) hash_search(&example_open_tables,
  106.                                            (byte*) table_name,
  107.                                            length)))
  108.   {
  109.     if (!(share=(EXAMPLE_SHARE *)
  110.           my_multi_malloc(MYF(MY_WME | MY_ZEROFILL),
  111.                           &share, sizeof(*share),
  112.                           &tmp_name, length+1,
  113.                           NullS)))
  114.     {
  115.       pthread_mutex_unlock(&example_mutex);
  116.       return NULL;
  117.     }
  118.     share->use_count=0;
  119.     share->table_name_length=length;
  120.     share->table_name=tmp_name;
  121.     strmov(share->table_name,table_name);
  122.     if (my_hash_insert(&example_open_tables, (byte*) share))
  123.       goto error;
  124.     thr_lock_init(&share->lock);
  125.     pthread_mutex_init(&share->mutex,MY_MUTEX_INIT_FAST);
  126.   }
  127.   share->use_count++;
  128.   pthread_mutex_unlock(&example_mutex);
  129.   return share;
  130. error:
  131.   pthread_mutex_destroy(&share->mutex);
  132.   pthread_mutex_unlock(&example_mutex);
  133.   my_free((gptr) share, MYF(0));
  134.   return NULL;
  135. }
  136. /*
  137.   Free lock controls. We call this whenever we close a table. If the table had
  138.   the last reference to the share then we free memory associated with it.
  139. */
  140. static int free_share(EXAMPLE_SHARE *share)
  141. {
  142.   pthread_mutex_lock(&example_mutex);
  143.   if (!--share->use_count)
  144.   {
  145.     hash_delete(&example_open_tables, (byte*) share);
  146.     thr_lock_delete(&share->lock);
  147.     pthread_mutex_destroy(&share->mutex);
  148.     my_free((gptr) share, MYF(0));
  149.   }
  150.   pthread_mutex_unlock(&example_mutex);
  151.   return 0;
  152. }
  153. /*
  154.   If frm_error() is called then we will use this to to find out what file extentions
  155.   exist for the storage engine. This is also used by the default rename_table and
  156.   delete_table method in handler.cc.
  157. */
  158. const char **ha_example::bas_ext() const
  159. { static const char *ext[]= { NullS }; return ext; }
  160. /*
  161.   Used for opening tables. The name will be the name of the file.
  162.   A table is opened when it needs to be opened. For instance
  163.   when a request comes in for a select on the table (tables are not
  164.   open and closed for each request, they are cached).
  165.   Called from handler.cc by handler::ha_open(). The server opens all tables by
  166.   calling ha_open() which then calls the handler specific open().
  167. */
  168. int ha_example::open(const char *name, int mode, uint test_if_locked)
  169. {
  170.   DBUG_ENTER("ha_example::open");
  171.   if (!(share = get_share(name, table)))
  172.     DBUG_RETURN(1);
  173.   thr_lock_data_init(&share->lock,&lock,NULL);
  174.   DBUG_RETURN(0);
  175. }
  176. /*
  177.   Closes a table. We call the free_share() function to free any resources
  178.   that we have allocated in the "shared" structure.
  179.   Called from sql_base.cc, sql_select.cc, and table.cc.
  180.   In sql_select.cc it is only used to close up temporary tables or during
  181.   the process where a temporary table is converted over to being a
  182.   myisam table.
  183.   For sql_base.cc look at close_data_tables().
  184. */
  185. int ha_example::close(void)
  186. {
  187.   DBUG_ENTER("ha_example::close");
  188.   DBUG_RETURN(free_share(share));
  189. }
  190. /*
  191.   write_row() inserts a row. No extra() hint is given currently if a bulk load
  192.   is happeneding. buf() is a byte array of data. You can use the field
  193.   information to extract the data from the native byte array type.
  194.   Example of this would be:
  195.   for (Field **field=table->field ; *field ; field++)
  196.   {
  197.     ...
  198.   }
  199.   See ha_tina.cc for an example of extracting all of the data as strings.
  200.   ha_berekly.cc has an example of how to store it intact by "packing" it
  201.   for ha_berkeley's own native storage type.
  202.   See the note for update_row() on auto_increments and timestamps. This
  203.   case also applied to write_row().
  204.   Called from item_sum.cc, item_sum.cc, sql_acl.cc, sql_insert.cc,
  205.   sql_insert.cc, sql_select.cc, sql_table.cc, sql_udf.cc, and sql_update.cc.
  206. */
  207. int ha_example::write_row(byte * buf)
  208. {
  209.   DBUG_ENTER("ha_example::write_row");
  210.   DBUG_RETURN(HA_ERR_WRONG_COMMAND);
  211. }
  212. /*
  213.   Yes, update_row() does what you expect, it updates a row. old_data will have
  214.   the previous row record in it, while new_data will have the newest data in
  215.   it.
  216.   Keep in mind that the server can do updates based on ordering if an ORDER BY
  217.   clause was used. Consecutive ordering is not guarenteed.
  218.   Currently new_data will not have an updated auto_increament record, or
  219.   and updated timestamp field. You can do these for example by doing these:
  220.   if (table->timestamp_field_type & TIMESTAMP_AUTO_SET_ON_UPDATE)
  221.     table->timestamp_field->set_time();
  222.   if (table->next_number_field && record == table->record[0])
  223.     update_auto_increment();
  224.   Called from sql_select.cc, sql_acl.cc, sql_update.cc, and sql_insert.cc.
  225. */
  226. int ha_example::update_row(const byte * old_data, byte * new_data)
  227. {
  228.   DBUG_ENTER("ha_example::update_row");
  229.   DBUG_RETURN(HA_ERR_WRONG_COMMAND);
  230. }
  231. /*
  232.   This will delete a row. buf will contain a copy of the row to be deleted.
  233.   The server will call this right after the current row has been called (from
  234.   either a previous rnd_nexT() or index call).
  235.   If you keep a pointer to the last row or can access a primary key it will
  236.   make doing the deletion quite a bit easier.
  237.   Keep in mind that the server does no guarentee consecutive deletions. ORDER BY
  238.   clauses can be used.
  239.   Called in sql_acl.cc and sql_udf.cc to manage internal table information.
  240.   Called in sql_delete.cc, sql_insert.cc, and sql_select.cc. In sql_select it is
  241.   used for removing duplicates while in insert it is used for REPLACE calls.
  242. */
  243. int ha_example::delete_row(const byte * buf)
  244. {
  245.   DBUG_ENTER("ha_example::delete_row");
  246.   DBUG_RETURN(HA_ERR_WRONG_COMMAND);
  247. }
  248. /*
  249.   Positions an index cursor to the index specified in the handle. Fetches the
  250.   row if available. If the key value is null, begin at the first key of the
  251.   index.
  252. */
  253. int ha_example::index_read(byte * buf, const byte * key,
  254.                            uint key_len __attribute__((unused)),
  255.                            enum ha_rkey_function find_flag
  256.                            __attribute__((unused)))
  257. {
  258.   DBUG_ENTER("ha_example::index_read");
  259.   DBUG_RETURN(HA_ERR_WRONG_COMMAND);
  260. }
  261. /*
  262.   Positions an index cursor to the index specified in key. Fetches the
  263.   row if any.  This is only used to read whole keys.
  264. */
  265. int ha_example::index_read_idx(byte * buf, uint index, const byte * key,
  266.                                uint key_len __attribute__((unused)),
  267.                                enum ha_rkey_function find_flag
  268.                                __attribute__((unused)))
  269. {
  270.   DBUG_ENTER("ha_example::index_read_idx");
  271.   DBUG_RETURN(HA_ERR_WRONG_COMMAND);
  272. }
  273. /*
  274.   Used to read forward through the index.
  275. */
  276. int ha_example::index_next(byte * buf)
  277. {
  278.   DBUG_ENTER("ha_example::index_next");
  279.   DBUG_RETURN(HA_ERR_WRONG_COMMAND);
  280. }
  281. /*
  282.   Used to read backwards through the index.
  283. */
  284. int ha_example::index_prev(byte * buf)
  285. {
  286.   DBUG_ENTER("ha_example::index_prev");
  287.   DBUG_RETURN(HA_ERR_WRONG_COMMAND);
  288. }
  289. /*
  290.   index_first() asks for the first key in the index.
  291.   Called from opt_range.cc, opt_sum.cc, sql_handler.cc,
  292.   and sql_select.cc.
  293. */
  294. int ha_example::index_first(byte * buf)
  295. {
  296.   DBUG_ENTER("ha_example::index_first");
  297.   DBUG_RETURN(HA_ERR_WRONG_COMMAND);
  298. }
  299. /*
  300.   index_last() asks for the last key in the index.
  301.   Called from opt_range.cc, opt_sum.cc, sql_handler.cc,
  302.   and sql_select.cc.
  303. */
  304. int ha_example::index_last(byte * buf)
  305. {
  306.   DBUG_ENTER("ha_example::index_last");
  307.   DBUG_RETURN(HA_ERR_WRONG_COMMAND);
  308. }
  309. /*
  310.   rnd_init() is called when the system wants the storage engine to do a table
  311.   scan.
  312.   See the example in the introduction at the top of this file to see when
  313.   rnd_init() is called.
  314.   Called from filesort.cc, records.cc, sql_handler.cc, sql_select.cc, sql_table.cc,
  315.   and sql_update.cc.
  316. */
  317. int ha_example::rnd_init(bool scan)
  318. {
  319.   DBUG_ENTER("ha_example::rnd_init");
  320.   DBUG_RETURN(HA_ERR_WRONG_COMMAND);
  321. }
  322. int ha_example::rnd_end()
  323. {
  324.   DBUG_ENTER("ha_example::rnd_end");
  325.   DBUG_RETURN(0);
  326. }
  327. /*
  328.   This is called for each row of the table scan. When you run out of records
  329.   you should return HA_ERR_END_OF_FILE. Fill buff up with the row information.
  330.   The Field structure for the table is the key to getting data into buf
  331.   in a manner that will allow the server to understand it.
  332.   Called from filesort.cc, records.cc, sql_handler.cc, sql_select.cc, sql_table.cc,
  333.   and sql_update.cc.
  334. */
  335. int ha_example::rnd_next(byte *buf)
  336. {
  337.   DBUG_ENTER("ha_example::rnd_next");
  338.   DBUG_RETURN(HA_ERR_END_OF_FILE);
  339. }
  340. /*
  341.   position() is called after each call to rnd_next() if the data needs
  342.   to be ordered. You can do something like the following to store
  343.   the position:
  344.   ha_store_ptr(ref, ref_length, current_position);
  345.   The server uses ref to store data. ref_length in the above case is
  346.   the size needed to store current_position. ref is just a byte array
  347.   that the server will maintain. If you are using offsets to mark rows, then
  348.   current_position should be the offset. If it is a primary key like in
  349.   BDB, then it needs to be a primary key.
  350.   Called from filesort.cc, sql_select.cc, sql_delete.cc and sql_update.cc.
  351. */
  352. void ha_example::position(const byte *record)
  353. {
  354.   DBUG_ENTER("ha_example::position");
  355.   DBUG_VOID_RETURN;
  356. }
  357. /*
  358.   This is like rnd_next, but you are given a position to use
  359.   to determine the row. The position will be of the type that you stored in
  360.   ref. You can use ha_get_ptr(pos,ref_length) to retrieve whatever key
  361.   or position you saved when position() was called.
  362.   Called from filesort.cc records.cc sql_insert.cc sql_select.cc sql_update.cc.
  363. */
  364. int ha_example::rnd_pos(byte * buf, byte *pos)
  365. {
  366.   DBUG_ENTER("ha_example::rnd_pos");
  367.   DBUG_RETURN(HA_ERR_WRONG_COMMAND);
  368. }
  369. /*
  370.   ::info() is used to return information to the optimizer.
  371.   Currently this table handler doesn't implement most of the fields
  372.   really needed. SHOW also makes use of this data
  373.   Another note, you will probably want to have the following in your
  374.   code:
  375.   if (records < 2)
  376.     records = 2;
  377.   The reason is that the server will optimize for cases of only a single
  378.   record. If in a table scan you don't know the number of records
  379.   it will probably be better to set records to two so you can return
  380.   as many records as you need.
  381.   Along with records a few more variables you may wish to set are:
  382.     records
  383.     deleted
  384.     data_file_length
  385.     index_file_length
  386.     delete_length
  387.     check_time
  388.   Take a look at the public variables in handler.h for more information.
  389.   Called in:
  390.     filesort.cc
  391.     ha_heap.cc
  392.     item_sum.cc
  393.     opt_sum.cc
  394.     sql_delete.cc
  395.     sql_delete.cc
  396.     sql_derived.cc
  397.     sql_select.cc
  398.     sql_select.cc
  399.     sql_select.cc
  400.     sql_select.cc
  401.     sql_select.cc
  402.     sql_show.cc
  403.     sql_show.cc
  404.     sql_show.cc
  405.     sql_show.cc
  406.     sql_table.cc
  407.     sql_union.cc
  408.     sql_update.cc
  409. */
  410. void ha_example::info(uint flag)
  411. {
  412.   DBUG_ENTER("ha_example::info");
  413.   DBUG_VOID_RETURN;
  414. }
  415. /*
  416.   extra() is called whenever the server wishes to send a hint to
  417.   the storage engine. The myisam engine implements the most hints.
  418.   ha_innodb.cc has the most exhaustive list of these hints.
  419. */
  420. int ha_example::extra(enum ha_extra_function operation)
  421. {
  422.   DBUG_ENTER("ha_example::extra");
  423.   DBUG_RETURN(0);
  424. }
  425. /*
  426.   Deprecated and likely to be removed in the future. Storage engines normally
  427.   just make a call like:
  428.   ha_example::extra(HA_EXTRA_RESET);
  429.   to handle it.
  430. */
  431. int ha_example::reset(void)
  432. {
  433.   DBUG_ENTER("ha_example::reset");
  434.   DBUG_RETURN(0);
  435. }
  436. /*
  437.   Used to delete all rows in a table. Both for cases of truncate and
  438.   for cases where the optimizer realizes that all rows will be
  439.   removed as a result of a SQL statement.
  440.   Called from item_sum.cc by Item_func_group_concat::clear(),
  441.   Item_sum_count_distinct::clear(), and Item_func_group_concat::clear().
  442.   Called from sql_delete.cc by mysql_delete().
  443.   Called from sql_select.cc by JOIN::reinit().
  444.   Called from sql_union.cc by st_select_lex_unit::exec().
  445. */
  446. int ha_example::delete_all_rows()
  447. {
  448.   DBUG_ENTER("ha_example::delete_all_rows");
  449.   DBUG_RETURN(HA_ERR_WRONG_COMMAND);
  450. }
  451. /*
  452.   First you should go read the section "locking functions for mysql" in
  453.   lock.cc to understand this.
  454.   This create a lock on the table. If you are implementing a storage engine
  455.   that can handle transacations look at ha_berkely.cc to see how you will
  456.   want to goo about doing this. Otherwise you should consider calling flock()
  457.   here.
  458.   Called from lock.cc by lock_external() and unlock_external(). Also called
  459.   from sql_table.cc by copy_data_between_tables().
  460. */
  461. int ha_example::external_lock(THD *thd, int lock_type)
  462. {
  463.   DBUG_ENTER("ha_example::external_lock");
  464.   DBUG_RETURN(0);
  465. }
  466. /*
  467.   The idea with handler::store_lock() is the following:
  468.   The statement decided which locks we should need for the table
  469.   for updates/deletes/inserts we get WRITE locks, for SELECT... we get
  470.   read locks.
  471.   Before adding the lock into the table lock handler (see thr_lock.c)
  472.   mysqld calls store lock with the requested locks.  Store lock can now
  473.   modify a write lock to a read lock (or some other lock), ignore the
  474.   lock (if we don't want to use MySQL table locks at all) or add locks
  475.   for many tables (like we do when we are using a MERGE handler).
  476.   Berkeley DB for example  changes all WRITE locks to TL_WRITE_ALLOW_WRITE
  477.   (which signals that we are doing WRITES, but we are still allowing other
  478.   reader's and writer's.
  479.   When releasing locks, store_lock() are also called. In this case one
  480.   usually doesn't have to do anything.
  481.   In some exceptional cases MySQL may send a request for a TL_IGNORE;
  482.   This means that we are requesting the same lock as last time and this
  483.   should also be ignored. (This may happen when someone does a flush
  484.   table when we have opened a part of the tables, in which case mysqld
  485.   closes and reopens the tables and tries to get the same locks at last
  486.   time).  In the future we will probably try to remove this.
  487.   Called from lock.cc by get_lock_data().
  488. */
  489. THR_LOCK_DATA **ha_example::store_lock(THD *thd,
  490.                                        THR_LOCK_DATA **to,
  491.                                        enum thr_lock_type lock_type)
  492. {
  493.   if (lock_type != TL_IGNORE && lock.type == TL_UNLOCK)
  494.     lock.type=lock_type;
  495.   *to++= &lock;
  496.   return to;
  497. }
  498. /*
  499.   Used to delete a table. By the time delete_table() has been called all
  500.   opened references to this table will have been closed (and your globally
  501.   shared references released. The variable name will just be the name of
  502.   the table. You will need to remove any files you have created at this point.
  503.   If you do not implement this, the default delete_table() is called from
  504.   handler.cc and it will delete all files with the file extentions returned
  505.   by bas_ext().
  506.   Called from handler.cc by delete_table and  ha_create_table(). Only used
  507.   during create if the table_flag HA_DROP_BEFORE_CREATE was specified for
  508.   the storage engine.
  509. */
  510. int ha_example::delete_table(const char *name)
  511. {
  512.   DBUG_ENTER("ha_example::delete_table");
  513.   /* This is not implemented but we want someone to be able that it works. */
  514.   DBUG_RETURN(0);
  515. }
  516. /*
  517.   Renames a table from one name to another from alter table call.
  518.   If you do not implement this, the default rename_table() is called from
  519.   handler.cc and it will delete all files with the file extentions returned
  520.   by bas_ext().
  521.   Called from sql_table.cc by mysql_rename_table().
  522. */
  523. int ha_example::rename_table(const char * from, const char * to)
  524. {
  525.   DBUG_ENTER("ha_example::rename_table ");
  526.   DBUG_RETURN(HA_ERR_WRONG_COMMAND);
  527. }
  528. /*
  529.   Given a starting key, and an ending key estimate the number of rows that
  530.   will exist between the two. end_key may be empty which in case determine
  531.   if start_key matches any rows.
  532.   Called from opt_range.cc by check_quick_keys().
  533. */
  534. ha_rows ha_example::records_in_range(uint inx, key_range *min_key,
  535.                                      key_range *max_key)
  536. {
  537.   DBUG_ENTER("ha_example::records_in_range");
  538.   DBUG_RETURN(10);                         // low number to force index usage
  539. }
  540. /*
  541.   create() is called to create a database. The variable name will have the name
  542.   of the table. When create() is called you do not need to worry about opening
  543.   the table. Also, the FRM file will have already been created so adjusting
  544.   create_info will not do you any good. You can overwrite the frm file at this
  545.   point if you wish to change the table definition, but there are no methods
  546.   currently provided for doing that.
  547.   Called from handle.cc by ha_create_table().
  548. */
  549. int ha_example::create(const char *name, TABLE *table_arg,
  550.                        HA_CREATE_INFO *create_info)
  551. {
  552.   DBUG_ENTER("ha_example::create");
  553.   /* This is not implemented but we want someone to be able that it works. */
  554.   DBUG_RETURN(0);
  555. }
  556. #endif /* HAVE_EXAMPLE_DB */