row0mysql.h
上传用户:tsgydb
上传日期:2007-04-14
资源大小:10674k
文件大小:13k
源码类别:

MySQL数据库

开发平台:

Visual C++

  1. /******************************************************
  2. Interface between Innobase row operations and MySQL.
  3. Contains also create table and other data dictionary operations.
  4. (c) 2000 Innobase Oy
  5. Created 9/17/2000 Heikki Tuuri
  6. *******************************************************/
  7. #ifndef row0mysql_h
  8. #define row0mysql_h
  9. #include "univ.i"
  10. #include "data0data.h"
  11. #include "que0types.h"
  12. #include "dict0types.h"
  13. #include "trx0types.h"
  14. #include "row0types.h"
  15. #include "btr0pcur.h"
  16. #include "trx0types.h"
  17. typedef struct row_prebuilt_struct row_prebuilt_t;
  18. /***********************************************************************
  19. Stores a variable-length field (like VARCHAR) length to dest, in the
  20. MySQL format. */
  21. UNIV_INLINE
  22. byte*
  23. row_mysql_store_var_len(
  24. /*====================*/
  25. /* out: dest + 2 */
  26. byte* dest, /* in: where to store */
  27. ulint len); /* in: length, must fit in two bytes */
  28. /***********************************************************************
  29. Reads a MySQL format variable-length field (like VARCHAR) length and
  30. returns pointer to the field data. */
  31. UNIV_INLINE
  32. byte*
  33. row_mysql_read_var_ref(
  34. /*===================*/
  35. /* out: field + 2 */
  36. ulint* len, /* out: variable-length field length */
  37. byte* field); /* in: field */
  38. /***********************************************************************
  39. Reads a MySQL format variable-length field (like VARCHAR) length and
  40. returns pointer to the field data. */
  41. byte*
  42. row_mysql_read_var_ref_noninline(
  43. /*=============================*/
  44. /* out: field + 2 */
  45. ulint* len, /* out: variable-length field length */
  46. byte* field); /* in: field */
  47. /***********************************************************************
  48. Stores a reference to a BLOB in the MySQL format. */
  49. void
  50. row_mysql_store_blob_ref(
  51. /*=====================*/
  52. byte* dest, /* in: where to store */
  53. ulint col_len, /* in: dest buffer size: determines into
  54. how many bytes the BLOB length is stored,
  55. this may vary from 1 to 4 bytes */
  56. byte* data, /* in: BLOB data */
  57. ulint len); /* in: BLOB length */
  58. /***********************************************************************
  59. Reads a reference to a BLOB in the MySQL format. */
  60. byte*
  61. row_mysql_read_blob_ref(
  62. /*====================*/
  63. /* out: pointer to BLOB data */
  64. ulint* len, /* out: BLOB length */
  65. byte* ref, /* in: BLOB reference in the MySQL format */
  66. ulint col_len); /* in: BLOB reference length (not BLOB
  67. length) */
  68. /******************************************************************
  69. Stores a non-SQL-NULL field given in the MySQL format in the Innobase
  70. format. */
  71. UNIV_INLINE
  72. void
  73. row_mysql_store_col_in_innobase_format(
  74. /*===================================*/
  75. dfield_t* dfield, /* in/out: dfield */
  76. byte* buf, /* in/out: buffer for the converted
  77. value */
  78. byte* mysql_data, /* in: MySQL column value, not
  79. SQL NULL; NOTE that dfield may also
  80. get a pointer to mysql_data,
  81. therefore do not discard this as long
  82. as dfield is used! */
  83. ulint col_len, /* in: MySQL column length */
  84. ulint type, /* in: data type */
  85. ulint is_unsigned); /* in: != 0 if unsigned integer type */
  86. /********************************************************************
  87. Handles user errors and lock waits detected by the database engine. */
  88. ibool
  89. row_mysql_handle_errors(
  90. /*====================*/
  91. /* out: TRUE if it was a lock wait and
  92. we should continue running the query thread */
  93. ulint* new_err,/* out: possible new error encountered in
  94. rollback, or the old error which was
  95. during the function entry */
  96. trx_t* trx, /* in: transaction */
  97. que_thr_t* thr, /* in: query thread */
  98. trx_savept_t* savept);/* in: savepoint */
  99. /************************************************************************
  100. Create a prebuilt struct for a MySQL table handle. */
  101. row_prebuilt_t*
  102. row_create_prebuilt(
  103. /*================*/
  104. /* out, own: a prebuilt struct */
  105. dict_table_t* table); /* in: Innobase table handle */
  106. /************************************************************************
  107. Free a prebuilt struct for a MySQL table handle. */
  108. void
  109. row_prebuilt_free(
  110. /*==============*/
  111. row_prebuilt_t* prebuilt); /* in, own: prebuilt struct */
  112. /*************************************************************************
  113. Updates the transaction pointers in query graphs stored in the prebuilt
  114. struct. */
  115. void
  116. row_update_prebuilt_trx(
  117. /*====================*/
  118. /* out: prebuilt dtuple */
  119. row_prebuilt_t* prebuilt, /* in: prebuilt struct in MySQL
  120. handle */
  121. trx_t* trx); /* in: transaction handle */
  122. /*************************************************************************
  123. Does an insert for MySQL. */
  124. int
  125. row_insert_for_mysql(
  126. /*=================*/
  127. /* out: error code or DB_SUCCESS */
  128. byte* mysql_rec, /* in: row in the MySQL format */
  129. row_prebuilt_t* prebuilt); /* in: prebuilt struct in MySQL
  130. handle */
  131. /*************************************************************************
  132. Builds a dummy query graph used in selects. */
  133. void
  134. row_prebuild_sel_graph(
  135. /*===================*/
  136. row_prebuilt_t* prebuilt); /* in: prebuilt struct in MySQL
  137. handle */
  138. /*************************************************************************
  139. Gets pointer to a prebuilt update vector used in updates. If the update
  140. graph has not yet been built in the prebuilt struct, then this function
  141. first builds it. */
  142. upd_t*
  143. row_get_prebuilt_update_vector(
  144. /*===========================*/
  145. /* out: prebuilt update vector */
  146. row_prebuilt_t* prebuilt); /* in: prebuilt struct in MySQL
  147. handle */
  148. /*************************************************************************
  149. Checks if a table is such that we automatically created a clustered
  150. index on it (on row id). */
  151. ibool
  152. row_table_got_default_clust_index(
  153. /*==============================*/
  154. dict_table_t* table);
  155. /*************************************************************************
  156. Calculates the key number used inside MySQL for an Innobase index. We have
  157. to take into account if we generated a default clustered index for the table */
  158. ulint
  159. row_get_mysql_key_number_for_index(
  160. /*===============================*/
  161. dict_index_t* index);
  162. /*************************************************************************
  163. Does an update or delete of a row for MySQL. */
  164. int
  165. row_update_for_mysql(
  166. /*=================*/
  167. /* out: error code or DB_SUCCESS */
  168. byte* mysql_rec, /* in: the row to be updated, in
  169. the MySQL format */
  170. row_prebuilt_t* prebuilt); /* in: prebuilt struct in MySQL
  171. handle */
  172. /*************************************************************************
  173. Does a table creation operation for MySQL. */
  174. int
  175. row_create_table_for_mysql(
  176. /*=======================*/
  177. /* out: error code or DB_SUCCESS */
  178. dict_table_t* table, /* in: table definition */
  179. trx_t* trx); /* in: transaction handle */
  180. /*************************************************************************
  181. Does an index creation operation for MySQL. TODO: currently failure
  182. to create an index results in dropping the whole table! This is no problem
  183. currently as all indexes must be created at the same time as the table. */
  184. int
  185. row_create_index_for_mysql(
  186. /*=======================*/
  187. /* out: error number or DB_SUCCESS */
  188. dict_index_t* index, /* in: index defintion */
  189. trx_t* trx); /* in: transaction handle */
  190. /*************************************************************************
  191. Drops a table for MySQL. */
  192. int
  193. row_drop_table_for_mysql(
  194. /*=====================*/
  195. /* out: error code or DB_SUCCESS */
  196. char* name, /* in: table name */
  197. trx_t* trx, /* in: transaction handle */
  198. ibool has_dict_mutex);/* in: TRUE if the caller already owns the
  199. dictionary system mutex */
  200. /*************************************************************************
  201. Renames a table for MySQL. */
  202. int
  203. row_rename_table_for_mysql(
  204. /*=======================*/
  205. /* out: error code or DB_SUCCESS */
  206. char* old_name, /* in: old table name */
  207. char* new_name, /* in: new table name */
  208. trx_t* trx); /* in: transaction handle */
  209. /* A struct describing a place for an individual column in the MySQL
  210. row format which is presented to the table handler in ha_innobase.
  211. This template struct is used to speed up row transformations between
  212. Innobase and MySQL. */
  213. typedef struct mysql_row_templ_struct mysql_row_templ_t;
  214. struct mysql_row_templ_struct {
  215. ulint col_no; /* column number of the column */
  216. ulint rec_field_no; /* field number of the column in an
  217. Innobase record in the current index;
  218. not defined if template_type is
  219. ROW_MYSQL_WHOLE_ROW */
  220. ulint mysql_col_offset; /* offset of the column in the MySQL
  221. row format */
  222. ulint mysql_col_len; /* length of the column in the MySQL
  223. row format */
  224. ulint mysql_null_byte_offset; /* MySQL NULL bit byte offset in a
  225. MySQL record */
  226. ulint mysql_null_bit_mask; /* bit mask to get the NULL bit,
  227. zero if column cannot be NULL */
  228. ulint type; /* column type in Innobase mtype
  229. numbers DATA_CHAR... */
  230. ulint is_unsigned; /* if a column type is an integer
  231. type and this field is != 0, then
  232. it is an unsigned integer type */
  233. };
  234. #define MYSQL_FETCH_CACHE_SIZE 8
  235. /* After fetching this many rows, we start caching them in fetch_cache */
  236. #define MYSQL_FETCH_CACHE_THRESHOLD 4
  237. /* A struct for (sometimes lazily) prebuilt structures in an Innobase table
  238. handle used within MySQL; these are used to save CPU time. */
  239. struct row_prebuilt_struct {
  240. dict_table_t* table; /* Innobase table handle */
  241. trx_t* trx; /* current transaction handle */
  242. ibool sql_stat_start; /* TRUE when we start processing of
  243. an SQL statement: we may have to set
  244. an intention lock on the table,
  245. create a consistent read view etc. */
  246. ibool clust_index_was_generated;
  247. /* if the user did not define a
  248. primary key in MySQL, then Innobase
  249. automatically generated a clustered
  250. index where the ordering column is
  251. the row id: in this case this flag
  252. is set to TRUE */
  253. dict_index_t* index; /* current index for a search, if any */
  254. ulint template_type; /* ROW_MYSQL_WHOLE_ROW, 
  255. ROW_MYSQL_REC_FIELDS or
  256. ROW_MYSQL_NO_TEMPLATE */
  257. ulint n_template; /* number of elements in the
  258. template */
  259. ulint null_bitmap_len;/* number of bytes in the SQL NULL
  260. bitmap at the start of a row in the
  261. MySQL format */
  262. ibool need_to_access_clustered; /* if we are fetching
  263. columns through a secondary index
  264. and at least one column is not in
  265. the secondary index, then this is
  266. set to TRUE */
  267. ibool templ_contains_blob;/* TRUE if the template contains
  268. BLOB column(s) */
  269. mysql_row_templ_t* mysql_template;/* template used to transform
  270. rows fast between MySQL and Innobase
  271. formats; memory for this template
  272. is not allocated from 'heap' */
  273. mem_heap_t* heap; /* memory heap from which
  274. these auxiliary structures are
  275. allocated when needed */
  276. ins_node_t* ins_node; /* Innobase SQL insert node
  277. used to perform inserts
  278. to the table */
  279. byte* ins_upd_rec_buff;/* buffer for storing data converted
  280. to the Innobase format from the MySQL
  281. format */
  282. ibool in_update_remember_pos;
  283. /* if an update is processed, then if
  284. this flag is set to TRUE, it means
  285. that the stored cursor position in
  286. SELECT is the right position also
  287. for the update: we can just restore
  288. the cursor and save CPU time */
  289. upd_node_t* upd_node; /* Innobase SQL update node used
  290. to perform updates and deletes */
  291. que_fork_t* ins_graph; /* Innobase SQL query graph used
  292. in inserts */
  293. que_fork_t* upd_graph; /* Innobase SQL query graph used
  294. in updates or deletes */
  295. btr_pcur_t* pcur; /* persistent cursor used in selects
  296. and updates */
  297. btr_pcur_t* clust_pcur; /* persistent cursor used in
  298. some selects and updates */
  299. que_fork_t* sel_graph; /* dummy query graph used in
  300. selects */
  301. dtuple_t* search_tuple; /* prebuilt dtuple used in selects */
  302. byte row_id[DATA_ROW_ID_LEN];
  303. /* if the clustered index was generated,
  304. the row id of the last row fetched is
  305. stored here */
  306. dtuple_t* clust_ref; /* prebuilt dtuple used in
  307. sel/upd/del */
  308. ulint select_lock_type;/* LOCK_NONE, LOCK_S, or LOCK_X */
  309. ulint mysql_row_len; /* length in bytes of a row in the
  310. MySQL format */
  311. ulint n_rows_fetched; /* number of rows fetched after
  312. positioning the current cursor */
  313. ulint fetch_direction;/* ROW_SEL_NEXT or ROW_SEL_PREV */
  314. byte* fetch_cache[MYSQL_FETCH_CACHE_SIZE];
  315. /* a cache for fetched rows if we
  316. fetch many rows from the same cursor:
  317. it saves CPU time to fetch them in a
  318. batch; we reserve mysql_row_len
  319. bytes for each such row */
  320. ulint fetch_cache_first;/* position of the first not yet
  321. fetched row in fetch_cache */
  322. ulint n_fetch_cached; /* number of not yet fetched rows
  323. in fetch_cache */
  324. mem_heap_t* blob_heap; /* in SELECTS BLOB fields are copied
  325. to this heap */
  326. mem_heap_t* old_vers_heap; /* memory heap where a previous
  327. version is built in consistent read */
  328. };
  329. #define ROW_MYSQL_WHOLE_ROW 0
  330. #define ROW_MYSQL_REC_FIELDS 1
  331. #define ROW_MYSQL_NO_TEMPLATE 2
  332. #ifndef UNIV_NONINL
  333. #include "row0mysql.ic"
  334. #endif
  335. #endif