row0row.h

Go to the documentation of this file.

/*****************************************************************************

Copyright (c) 1996, 2012, Oracle and/or its affiliates. All Rights Reserved.

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; version 2 of the License.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Suite 500, Boston, MA 02110-1335 USA

*****************************************************************************/

/**************************************************/
#ifndef row0row_h
#define row0row_h

#include "univ.i"
#include "data0data.h"
#include "dict0types.h"
#include "trx0types.h"
#include "que0types.h"
#include "mtr0mtr.h"
#include "rem0types.h"
#include "read0types.h"
#include "row0types.h"
#include "btr0types.h"

/*********************************************************************/
UNIV_INLINE
ulint
row_get_trx_id_offset(
/*==================*/
        const dict_index_t*     index,  
        const ulint*            offsets)
        __attribute__((nonnull, warn_unused_result));
/*********************************************************************/
UNIV_INLINE
trx_id_t
row_get_rec_trx_id(
/*===============*/
        const rec_t*            rec,    
        const dict_index_t*     index,  
        const ulint*            offsets)
        __attribute__((nonnull, warn_unused_result));
/*********************************************************************/
UNIV_INLINE
roll_ptr_t
row_get_rec_roll_ptr(
/*=================*/
        const rec_t*            rec,    
        const dict_index_t*     index,  
        const ulint*            offsets)
        __attribute__((nonnull, warn_unused_result));
/*****************************************************************/
UNIV_INTERN
dtuple_t*
row_build_index_entry_low(
/*======================*/
        const dtuple_t*         row,    
        const row_ext_t*        ext,    
        dict_index_t*           index,  
        mem_heap_t*             heap)   
        __attribute__((warn_unused_result, nonnull(1,3,4)));
/*****************************************************************/
UNIV_INLINE
dtuple_t*
row_build_index_entry(
/*==================*/
        const dtuple_t*         row,    
        const row_ext_t*        ext,    
        dict_index_t*           index,  
        mem_heap_t*             heap)   
        __attribute__((warn_unused_result, nonnull(1,3,4)));
/*******************************************************************/
UNIV_INTERN
dtuple_t*
row_build(
/*======*/
        ulint                   type,   
        const dict_index_t*     index,  
        const rec_t*            rec,    
        const ulint*            offsets,
        const dict_table_t*     col_table,
        const dtuple_t*         add_cols,
        const ulint*            col_map,
        row_ext_t**             ext,    
        mem_heap_t*             heap)   
        __attribute__((nonnull(2,3,9)));
/*******************************************************************/
UNIV_INTERN
dtuple_t*
row_rec_to_index_entry_low(
/*=======================*/
        const rec_t*            rec,    
        const dict_index_t*     index,  
        const ulint*            offsets,
        ulint*                  n_ext,  
        mem_heap_t*             heap)   
        __attribute__((nonnull, warn_unused_result));
/*******************************************************************/
UNIV_INTERN
dtuple_t*
row_rec_to_index_entry(
/*===================*/
        const rec_t*            rec,    
        const dict_index_t*     index,  
        const ulint*            offsets,
        ulint*                  n_ext,  
        mem_heap_t*             heap)   
        __attribute__((nonnull, warn_unused_result));
/*******************************************************************/
UNIV_INTERN
dtuple_t*
row_build_row_ref(
/*==============*/
        ulint           type,   
        dict_index_t*   index,  
        const rec_t*    rec,    
        mem_heap_t*     heap)   
        __attribute__((nonnull, warn_unused_result));
/*******************************************************************/
UNIV_INTERN
void
row_build_row_ref_in_tuple(
/*=======================*/
        dtuple_t*               ref,    
        const rec_t*            rec,    
        const dict_index_t*     index,  
        ulint*                  offsets,
        trx_t*                  trx)    
        __attribute__((nonnull(1,2,3)));
/*******************************************************************/
UNIV_INLINE
void
row_build_row_ref_fast(
/*===================*/
        dtuple_t*       ref,    
        const ulint*    map,    
        const rec_t*    rec,    
        const ulint*    offsets);
/***************************************************************/
UNIV_INTERN
ibool
row_search_on_row_ref(
/*==================*/
        btr_pcur_t*             pcur,   
        ulint                   mode,   
        const dict_table_t*     table,  
        const dtuple_t*         ref,    
        mtr_t*                  mtr)    
        __attribute__((nonnull, warn_unused_result));
/*********************************************************************/
UNIV_INTERN
rec_t*
row_get_clust_rec(
/*==============*/
        ulint           mode,   
        const rec_t*    rec,    
        dict_index_t*   index,  
        dict_index_t**  clust_index,
        mtr_t*          mtr)    
        __attribute__((nonnull, warn_unused_result));

enum row_search_result {
        ROW_FOUND = 0,          
        ROW_NOT_FOUND,          
        ROW_BUFFERED,           
        ROW_NOT_DELETED_REF     
};

/***************************************************************/
UNIV_INTERN
enum row_search_result
row_search_index_entry(
/*===================*/
        dict_index_t*   index,  
        const dtuple_t* entry,  
        ulint           mode,   
        btr_pcur_t*     pcur,   
        mtr_t*          mtr)    
        __attribute__((nonnull, warn_unused_result));

#define ROW_COPY_DATA           1
#define ROW_COPY_POINTERS       2

/* The allowed latching order of index records is the following:
(1) a secondary index record ->
(2) the clustered index record ->
(3) rollback segment data for the clustered index record. */

/*******************************************************************/
UNIV_INTERN
ulint
row_raw_format(
/*===========*/
        const char*             data,           
        ulint                   data_len,       
        const dict_field_t*     dict_field,     
        char*                   buf,            
        ulint                   buf_size)       
        __attribute__((nonnull, warn_unused_result));

#ifndef UNIV_NONINL
#include "row0row.ic"
#endif

#endif