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

MySQL数据库

开发平台:

Visual C++

  1. /******************************************************
  2. Update of a row
  3. (c) 1996 Innobase Oy
  4. Created 12/27/1996 Heikki Tuuri
  5. *******************************************************/
  6. #ifndef row0upd_h
  7. #define row0upd_h
  8. #include "univ.i"
  9. #include "data0data.h"
  10. #include "btr0types.h"
  11. #include "btr0pcur.h"
  12. #include "dict0types.h"
  13. #include "trx0types.h"
  14. #include "que0types.h"
  15. #include "row0types.h"
  16. #include "pars0types.h"
  17. /*************************************************************************
  18. Creates an update vector object. */
  19. UNIV_INLINE
  20. upd_t*
  21. upd_create(
  22. /*=======*/
  23. /* out, own: update vector object */
  24. ulint n, /* in: number of fields */
  25. mem_heap_t* heap); /* in: heap from which memory allocated */
  26. /*************************************************************************
  27. Returns the number of fields in the update vector == number of columns
  28. to be updated by an update vector. */
  29. UNIV_INLINE
  30. ulint
  31. upd_get_n_fields(
  32. /*=============*/
  33. /* out: number of fields */
  34. upd_t* update); /* in: update vector */
  35. /*************************************************************************
  36. Returns the nth field of an update vector. */
  37. UNIV_INLINE
  38. upd_field_t*
  39. upd_get_nth_field(
  40. /*==============*/
  41. /* out: update vector field */
  42. upd_t* update, /* in: update vector */
  43. ulint n); /* in: field position in update vector */
  44. /*************************************************************************
  45. Sets an index field number to be updated by an update vector field. */
  46. UNIV_INLINE
  47. void
  48. upd_field_set_field_no(
  49. /*===================*/
  50. upd_field_t* upd_field, /* in: update vector field */
  51. ulint field_no, /* in: field number in a clustered
  52. index */
  53. dict_index_t* index, /* in: index */
  54. trx_t* trx); /* in: transaction */
  55. /*************************************************************************
  56. Writes into the redo log the values of trx id and roll ptr and enough info
  57. to determine their positions within a clustered index record. */
  58. byte*
  59. row_upd_write_sys_vals_to_log(
  60. /*==========================*/
  61. /* out: new pointer to mlog */
  62. dict_index_t* index, /* in: clustered index */
  63. trx_t* trx, /* in: transaction */
  64. dulint roll_ptr,/* in: roll ptr of the undo log record */
  65. byte* log_ptr,/* pointer to a buffer of size > 20 opened
  66. in mlog */
  67. mtr_t* mtr); /* in: mtr */
  68. /*************************************************************************
  69. Updates the trx id and roll ptr field in a clustered index record when
  70. a row is updated or marked deleted. */
  71. UNIV_INLINE
  72. void
  73. row_upd_rec_sys_fields(
  74. /*===================*/
  75. rec_t* rec, /* in: record */
  76. dict_index_t* index, /* in: clustered index */
  77. trx_t* trx, /* in: transaction */
  78. dulint roll_ptr);/* in: roll ptr of the undo log record */
  79. /*************************************************************************
  80. Sets the trx id or roll ptr field of a clustered index entry. */
  81. void
  82. row_upd_index_entry_sys_field(
  83. /*==========================*/
  84. dtuple_t* entry, /* in: index entry, where the memory buffers
  85. for sys fields are already allocated:
  86. the function just copies the new values to
  87. them */
  88. dict_index_t* index, /* in: clustered index */
  89. ulint type, /* in: DATA_TRX_ID or DATA_ROLL_PTR */
  90. dulint val); /* in: value to write */
  91. /*************************************************************************
  92. Creates an update node for a query graph. */
  93. upd_node_t*
  94. upd_node_create(
  95. /*============*/
  96. /* out, own: update node */
  97. mem_heap_t* heap); /* in: mem heap where created */
  98. /***************************************************************
  99. Writes to the redo log the new values of the fields occurring in the index. */
  100. void
  101. row_upd_index_write_log(
  102. /*====================*/
  103. upd_t* update, /* in: update vector */
  104. byte* log_ptr,/* in: pointer to mlog buffer: must contain at least
  105. MLOG_BUF_MARGIN bytes of free space; the buffer is
  106. closed within this function */
  107. mtr_t* mtr); /* in: mtr into whose log to write */
  108. /***************************************************************
  109. Returns TRUE if row update changes size of some field in index or if some
  110. field to be updated is stored externally in rec or update. */
  111. ibool
  112. row_upd_changes_field_size_or_external(
  113. /*===================================*/
  114. /* out: TRUE if the update changes the size of
  115. some field in index or the field is external
  116. in rec or update */
  117. rec_t* rec, /* in: record in index */
  118. dict_index_t* index, /* in: index */
  119. upd_t* update);/* in: update vector */
  120. /***************************************************************
  121. Replaces the new column values stored in the update vector to the record
  122. given. No field size changes are allowed. This function is used only for
  123. a clustered index */
  124. void
  125. row_upd_rec_in_place(
  126. /*=================*/
  127. rec_t* rec, /* in/out: record where replaced */
  128. upd_t* update);/* in: update vector */
  129. /*******************************************************************
  130. Builds an update vector from those fields which in a secondary index entry
  131. differ from a record that has the equal ordering fields. NOTE: we compare
  132. the fields as binary strings! */
  133. upd_t*
  134. row_upd_build_sec_rec_difference_binary(
  135. /*====================================*/
  136. /* out, own: update vector of differing
  137. fields */
  138. dict_index_t* index, /* in: index */
  139. dtuple_t* entry, /* in: entry to insert */
  140. rec_t* rec, /* in: secondary index record */
  141. trx_t* trx, /* in: transaction */
  142. mem_heap_t* heap); /* in: memory heap from which allocated */
  143. /*******************************************************************
  144. Builds an update vector from those fields, excluding the roll ptr and
  145. trx id fields, which in an index entry differ from a record that has
  146. the equal ordering fields. NOTE: we compare the fields as binary strings! */
  147. upd_t*
  148. row_upd_build_difference_binary(
  149. /*============================*/
  150. /* out, own: update vector of differing
  151. fields, excluding roll ptr and trx id */
  152. dict_index_t* index, /* in: clustered index */
  153. dtuple_t* entry, /* in: entry to insert */
  154. ulint* ext_vec,/* in: array containing field numbers of
  155. externally stored fields in entry, or NULL */
  156. ulint n_ext_vec,/* in: number of fields in ext_vec */
  157. rec_t* rec, /* in: clustered index record */
  158. trx_t* trx, /* in: transaction */
  159. mem_heap_t* heap); /* in: memory heap from which allocated */
  160. /***************************************************************
  161. Replaces the new column values stored in the update vector to the index entry
  162. given. */
  163. void
  164. row_upd_index_replace_new_col_vals_index_pos(
  165. /*=========================================*/
  166. dtuple_t* entry, /* in/out: index entry where replaced */
  167. dict_index_t* index, /* in: index; NOTE that this may also be a
  168. non-clustered index */
  169. upd_t* update, /* in: an update vector built for the index so
  170. that the field number in an upd_field is the
  171. index position */
  172. mem_heap_t* heap); /* in: memory heap to which we allocate and
  173. copy the new values, set this as NULL if you
  174. do not want allocation */
  175. /***************************************************************
  176. Replaces the new column values stored in the update vector to the index entry
  177. given. */
  178. void
  179. row_upd_index_replace_new_col_vals(
  180. /*===============================*/
  181. dtuple_t* entry, /* in/out: index entry where replaced */
  182. dict_index_t* index, /* in: index; NOTE that this may also be a
  183. non-clustered index */
  184. upd_t* update, /* in: an update vector built for the
  185. CLUSTERED index so that the field number in
  186. an upd_field is the clustered index position */
  187. mem_heap_t* heap); /* in: memory heap to which we allocate and
  188. copy the new values, set this as NULL if you
  189. do not want allocation */
  190. /***************************************************************
  191. Checks if an update vector changes an ordering field of an index record.
  192. This function is fast if the update vector is short or the number of ordering
  193. fields in the index is small. Otherwise, this can be quadratic.
  194. NOTE: we compare the fields as binary strings! */
  195.  
  196. ibool
  197. row_upd_changes_ord_field_binary(
  198. /*=============================*/
  199. /* out: TRUE if update vector changes
  200. an ordering field in the index record;
  201. NOTE: the fields are compared as binary
  202. strings */
  203. dtuple_t* row, /* in: old value of row, or NULL if the
  204. row and the data values in update are not
  205. known when this function is called, e.g., at
  206. compile time */
  207. dict_index_t* index, /* in: index of the record */
  208. upd_t* update);/* in: update vector for the row; NOTE: the
  209. field numbers in this MUST be clustered index
  210. positions! */
  211. /***************************************************************
  212. Checks if an update vector changes an ordering field of an index record.
  213. This function is fast if the update vector is short or the number of ordering
  214. fields in the index is small. Otherwise, this can be quadratic.
  215. NOTE: we compare the fields as binary strings! */
  216. ibool
  217. row_upd_changes_some_index_ord_field_binary(
  218. /*========================================*/
  219. /* out: TRUE if update vector may change
  220. an ordering field in an index record */
  221. dict_table_t* table, /* in: table */
  222. upd_t* update);/* in: update vector for the row */
  223. /***************************************************************
  224. Updates a row in a table. This is a high-level function used
  225. in SQL execution graphs. */
  226. que_thr_t*
  227. row_upd_step(
  228. /*=========*/
  229. /* out: query thread to run next or NULL */
  230. que_thr_t* thr); /* in: query thread */
  231. /*************************************************************************
  232. Performs an in-place update for the current clustered index record in
  233. select. */
  234. void
  235. row_upd_in_place_in_select(
  236. /*=======================*/
  237. sel_node_t* sel_node, /* in: select node */
  238. que_thr_t* thr, /* in: query thread */
  239. mtr_t* mtr); /* in: mtr */
  240. /*************************************************************************
  241. Parses the log data of system field values. */
  242. byte*
  243. row_upd_parse_sys_vals(
  244. /*===================*/
  245. /* out: log data end or NULL */
  246. byte* ptr, /* in: buffer */
  247. byte* end_ptr,/* in: buffer end */
  248. ulint* pos, /* out: TRX_ID position in record */
  249. dulint* trx_id, /* out: trx id */
  250. dulint* roll_ptr);/* out: roll ptr */
  251. /*************************************************************************
  252. Updates the trx id and roll ptr field in a clustered index record in database
  253. recovery. */
  254. void
  255. row_upd_rec_sys_fields_in_recovery(
  256. /*===============================*/
  257. rec_t* rec, /* in: record */
  258. ulint pos, /* in: TRX_ID position in rec */
  259. dulint trx_id, /* in: transaction id */
  260. dulint roll_ptr);/* in: roll ptr of the undo log record */
  261. /*************************************************************************
  262. Parses the log data written by row_upd_index_write_log. */
  263. byte*
  264. row_upd_index_parse(
  265. /*================*/
  266. /* out: log data end or NULL */
  267. byte* ptr, /* in: buffer */
  268. byte* end_ptr,/* in: buffer end */
  269. mem_heap_t* heap, /* in: memory heap where update vector is
  270. built */
  271. upd_t** update_out);/* out: update vector */
  272. /* Update vector field */
  273. struct upd_field_struct{
  274. ulint field_no; /* field number in an index, usually
  275. the clustered index, but in updating
  276. a secondary index record in btr0cur.c
  277. this is the position in the secondary
  278. index */
  279. que_node_t* exp; /* expression for calculating a new
  280. value: it refers to column values and
  281. constants in the symbol table of the
  282. query graph */
  283. dfield_t new_val; /* new value for the column */
  284. ibool extern_storage; /* this is set to TRUE if dfield
  285. actually contains a reference to
  286. an externally stored field */
  287. };
  288. /* Update vector structure */
  289. struct upd_struct{
  290. ulint info_bits; /* new value of info bits to record;
  291. default is 0 */
  292. ulint n_fields; /* number of update fields */
  293. upd_field_t* fields; /* array of update fields */
  294. };
  295. /* Update node structure which also implements the delete operation
  296. of a row */
  297. struct upd_node_struct{
  298. que_common_t common; /* node type: QUE_NODE_UPDATE */
  299. ibool is_delete;/* TRUE if delete, FALSE if update */
  300. ibool searched_update;
  301. /* TRUE if searched update, FALSE if
  302. positioned */
  303. ibool select_will_do_update;
  304. /* TRUE if a searched update where ordering
  305. fields will not be updated, and the size of
  306. the fields will not change: in this case the
  307. select node will take care of the update */
  308. ibool in_mysql_interface;
  309. /* TRUE if the update node was created
  310. for the MySQL interface */
  311. dict_foreign_t* foreign;/* NULL or pointer to a foreign key
  312. constraint if this update node is used in
  313. doing an ON DELETE or ON UPDATE operation */
  314. upd_node_t* cascade_node;/* NULL or an update node template which
  315. is used to implement ON DELETE/UPDATE CASCADE
  316. or ... SET NULL for foreign keys */
  317. mem_heap_t* cascade_heap;/* NULL or a mem heap where the cascade
  318. node is created */
  319. sel_node_t* select; /* query graph subtree implementing a base
  320. table cursor: the rows returned will be
  321. updated */
  322. btr_pcur_t* pcur; /* persistent cursor placed on the clustered
  323. index record which should be updated or
  324. deleted; the cursor is stored in the graph
  325. of 'select' field above, except in the case
  326. of the MySQL interface */
  327. dict_table_t* table; /* table where updated */
  328. upd_t* update; /* update vector for the row */
  329. ulint update_n_fields;
  330. /* when this struct is used to implement
  331. a cascade operation for foreign keys, we store
  332. here the size of the buffer allocated for use
  333. as the update vector */
  334. sym_node_list_t columns;/* symbol table nodes for the columns
  335. to retrieve from the table */
  336. ibool has_clust_rec_x_lock;
  337. /* TRUE if the select which retrieves the
  338. records to update already sets an x-lock on
  339. the clustered record; note that it must always
  340. set at least an s-lock */
  341. ulint cmpl_info;/* information extracted during query
  342. compilation; speeds up execution:
  343. UPD_NODE_NO_ORD_CHANGE and
  344. UPD_NODE_NO_SIZE_CHANGE, ORed */
  345. /*----------------------*/
  346. /* Local storage for this graph node */
  347. ulint state; /* node execution state */
  348. dict_index_t* index; /* NULL, or the next index whose record should
  349. be updated */
  350. dtuple_t* row; /* NULL, or a copy (also fields copied to
  351. heap) of the row to update; this must be reset
  352. to NULL after a successful update */
  353. ulint* ext_vec;/* array describing which fields are stored
  354. externally in the clustered index record of
  355. row */
  356. ulint n_ext_vec;/* number of fields in ext_vec */
  357. mem_heap_t* heap; /* memory heap used as auxiliary storage;
  358. this must be emptied after a successful
  359. update */
  360. /*----------------------*/
  361. sym_node_t* table_sym;/* table node in symbol table */
  362. que_node_t* col_assign_list;
  363. /* column assignment list */
  364. ulint magic_n;
  365. };
  366. #define UPD_NODE_MAGIC_N 1579975
  367. /* Node execution states */
  368. #define UPD_NODE_SET_IX_LOCK    1 /* execution came to the node from
  369. a node above and if the field
  370. has_clust_rec_x_lock is FALSE, we
  371. should set an intention x-lock on
  372. the table */
  373. #define UPD_NODE_UPDATE_CLUSTERED  2 /* clustered index record should be
  374. updated */
  375. #define UPD_NODE_INSERT_CLUSTERED  3 /* clustered index record should be
  376. inserted, old record is already delete
  377. marked */
  378. #define UPD_NODE_UPDATE_ALL_SEC    4 /* an ordering field of the clustered
  379. index record was changed, or this is
  380. a delete operation: should update
  381. all the secondary index records */
  382. #define UPD_NODE_UPDATE_SOME_SEC   5  /* secondary index entries should be
  383. looked at and updated if an ordering
  384. field changed */
  385. /* Compilation info flags: these must fit within 3 bits; see trx0rec.h */
  386. #define UPD_NODE_NO_ORD_CHANGE 1 /* no secondary index record will be
  387. changed in the update and no ordering
  388. field of the clustered index */
  389. #define UPD_NODE_NO_SIZE_CHANGE 2 /* no record field size will be
  390. changed in the update */
  391. #ifndef UNIV_NONINL
  392. #include "row0upd.ic"
  393. #endif
  394. #endif