~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to storage/innobase/include/row0purge.h

  • Committer: Monty Taylor
  • Date: 2009-04-14 19:16:51 UTC
  • mto: (997.2.5 mordred)
  • mto: This revision was merged to the branch mainline in revision 994.
  • Revision ID: mordred@inaugust.com-20090414191651-ltbww6hpqks8k7qk
Clarified instructions in README.

Show diffs side-by-side

added added

removed removed

Lines of Context:
16
16
 
17
17
*****************************************************************************/
18
18
 
19
 
/**************************************************//**
20
 
@file include/row0purge.h
 
19
/******************************************************
21
20
Purge obsolete records
22
21
 
23
22
Created 3/14/1997 Heikki Tuuri
35
34
#include "que0types.h"
36
35
#include "row0types.h"
37
36
 
38
 
/********************************************************************//**
39
 
Creates a purge node to a query graph.
40
 
@return own: purge node */
 
37
/************************************************************************
 
38
Creates a purge node to a query graph. */
41
39
UNIV_INTERN
42
40
purge_node_t*
43
41
row_purge_node_create(
44
42
/*==================*/
45
 
        que_thr_t*      parent, /*!< in: parent node, i.e., a thr node */
46
 
        mem_heap_t*     heap);  /*!< in: memory heap where created */
47
 
/***********************************************************//**
 
43
                                /* out, own: purge node */
 
44
        que_thr_t*      parent, /* in: parent node, i.e., a thr node */
 
45
        mem_heap_t*     heap);  /* in: memory heap where created */
 
46
/***************************************************************
48
47
Does the purge operation for a single undo log record. This is a high-level
49
 
function used in an SQL execution graph.
50
 
@return query thread to run next or NULL */
 
48
function used in an SQL execution graph. */
51
49
UNIV_INTERN
52
50
que_thr_t*
53
51
row_purge_step(
54
52
/*===========*/
55
 
        que_thr_t*      thr);   /*!< in: query thread */
 
53
                                /* out: query thread to run next or NULL */
 
54
        que_thr_t*      thr);   /* in: query thread */
56
55
 
57
56
/* Purge node structure */
58
57
 
59
58
struct purge_node_struct{
60
 
        que_common_t    common; /*!< node type: QUE_NODE_PURGE */
 
59
        que_common_t    common; /* node type: QUE_NODE_PURGE */
61
60
        /*----------------------*/
62
61
        /* Local storage for this graph node */
63
 
        roll_ptr_t      roll_ptr;/* roll pointer to undo log record */
 
62
        dulint          roll_ptr;/* roll pointer to undo log record */
64
63
        trx_undo_rec_t* undo_rec;/* undo log record */
65
64
        trx_undo_inf_t* reservation;/* reservation for the undo log record in
66
65
                                the purge array */
67
 
        undo_no_t       undo_no;/* undo number of the record */
 
66
        dulint          undo_no;/* undo number of the record */
68
67
        ulint           rec_type;/* undo log record type: TRX_UNDO_INSERT_REC,
69
68
                                ... */
70
 
        btr_pcur_t      pcur;   /*!< persistent cursor used in searching the
 
69
        btr_pcur_t      pcur;   /* persistent cursor used in searching the
71
70
                                clustered index record */
72
71
        ibool           found_clust;/* TRUE if the clustered index record
73
72
                                determined by ref was found in the clustered
74
73
                                index, and we were able to position pcur on
75
74
                                it */
76
 
        dict_table_t*   table;  /*!< table where purge is done */
 
75
        dict_table_t*   table;  /* table where purge is done */
77
76
        ulint           cmpl_info;/* compiler analysis info of an update */
78
 
        upd_t*          update; /*!< update vector for a clustered index
 
77
        upd_t*          update; /* update vector for a clustered index
79
78
                                record */
80
 
        dtuple_t*       ref;    /*!< NULL, or row reference to the next row to
 
79
        dtuple_t*       ref;    /* NULL, or row reference to the next row to
81
80
                                handle */
82
 
        dtuple_t*       row;    /*!< NULL, or a copy (also fields copied to
 
81
        dtuple_t*       row;    /* NULL, or a copy (also fields copied to
83
82
                                heap) of the indexed fields of the row to
84
83
                                handle */
85
 
        dict_index_t*   index;  /*!< NULL, or the next index whose record should
 
84
        dict_index_t*   index;  /* NULL, or the next index whose record should
86
85
                                be handled */
87
 
        mem_heap_t*     heap;   /*!< memory heap used as auxiliary storage for
 
86
        mem_heap_t*     heap;   /* memory heap used as auxiliary storage for
88
87
                                row; this must be emptied after a successful
89
88
                                purge of a row */
90
89
};