diff options
Diffstat (limited to 'storage/xtradb/include/row0purge.h')
| -rw-r--r-- | storage/xtradb/include/row0purge.h | 41 |
1 files changed, 21 insertions, 20 deletions
diff --git a/storage/xtradb/include/row0purge.h b/storage/xtradb/include/row0purge.h index fbc12f8d389..89ec54fb54a 100644 --- a/storage/xtradb/include/row0purge.h +++ b/storage/xtradb/include/row0purge.h @@ -16,7 +16,8 @@ Place, Suite 330, Boston, MA 02111-1307 USA *****************************************************************************/ -/****************************************************** +/**************************************************//** +@file include/row0purge.h Purge obsolete records Created 3/14/1997 Heikki Tuuri @@ -34,56 +35,56 @@ Created 3/14/1997 Heikki Tuuri #include "que0types.h" #include "row0types.h" -/************************************************************************ -Creates a purge node to a query graph. */ +/********************************************************************//** +Creates a purge node to a query graph. +@return own: purge node */ UNIV_INTERN purge_node_t* row_purge_node_create( /*==================*/ - /* out, own: purge node */ - que_thr_t* parent, /* in: parent node, i.e., a thr node */ - mem_heap_t* heap); /* in: memory heap where created */ -/*************************************************************** + que_thr_t* parent, /*!< in: parent node, i.e., a thr node */ + mem_heap_t* heap); /*!< in: memory heap where created */ +/***********************************************************//** Does the purge operation for a single undo log record. This is a high-level -function used in an SQL execution graph. */ +function used in an SQL execution graph. +@return query thread to run next or NULL */ UNIV_INTERN que_thr_t* row_purge_step( /*===========*/ - /* out: query thread to run next or NULL */ - que_thr_t* thr); /* in: query thread */ + que_thr_t* thr); /*!< in: query thread */ /* Purge node structure */ struct purge_node_struct{ - que_common_t common; /* node type: QUE_NODE_PURGE */ + que_common_t common; /*!< node type: QUE_NODE_PURGE */ /*----------------------*/ /* Local storage for this graph node */ - dulint roll_ptr;/* roll pointer to undo log record */ + roll_ptr_t roll_ptr;/* roll pointer to undo log record */ trx_undo_rec_t* undo_rec;/* undo log record */ trx_undo_inf_t* reservation;/* reservation for the undo log record in the purge array */ - dulint undo_no;/* undo number of the record */ + undo_no_t undo_no;/* undo number of the record */ ulint rec_type;/* undo log record type: TRX_UNDO_INSERT_REC, ... */ - btr_pcur_t pcur; /* persistent cursor used in searching the + btr_pcur_t pcur; /*!< persistent cursor used in searching the clustered index record */ ibool found_clust;/* TRUE if the clustered index record determined by ref was found in the clustered index, and we were able to position pcur on it */ - dict_table_t* table; /* table where purge is done */ + dict_table_t* table; /*!< table where purge is done */ ulint cmpl_info;/* compiler analysis info of an update */ - upd_t* update; /* update vector for a clustered index + upd_t* update; /*!< update vector for a clustered index record */ - dtuple_t* ref; /* NULL, or row reference to the next row to + dtuple_t* ref; /*!< NULL, or row reference to the next row to handle */ - dtuple_t* row; /* NULL, or a copy (also fields copied to + dtuple_t* row; /*!< NULL, or a copy (also fields copied to heap) of the indexed fields of the row to handle */ - dict_index_t* index; /* NULL, or the next index whose record should + dict_index_t* index; /*!< NULL, or the next index whose record should be handled */ - mem_heap_t* heap; /* memory heap used as auxiliary storage for + mem_heap_t* heap; /*!< memory heap used as auxiliary storage for row; this must be emptied after a successful purge of a row */ }; |