row0sel.h

Go to the documentation of this file.

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

Copyright (c) 1997, 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 row0sel_h
#define row0sel_h

#include "univ.i"
#include "data0data.h"
#include "que0types.h"
#include "dict0types.h"
#include "trx0types.h"
#include "row0types.h"
#include "que0types.h"
#include "pars0sym.h"
#include "btr0pcur.h"
#include "read0read.h"
#include "row0mysql.h"

/*********************************************************************/
UNIV_INTERN
sel_node_t*
sel_node_create(
/*============*/
        mem_heap_t*     heap);  
/*********************************************************************/
UNIV_INTERN
void
sel_node_free_private(
/*==================*/
        sel_node_t*     node);  
/*********************************************************************/
UNIV_INTERN
void
sel_col_prefetch_buf_free(
/*======================*/
        sel_buf_t*      prefetch_buf);  
/*********************************************************************/
UNIV_INLINE
plan_t*
sel_node_get_nth_plan(
/*==================*/
        sel_node_t*     node,   
        ulint           i);     
/**********************************************************************/
UNIV_INTERN
que_thr_t*
row_sel_step(
/*=========*/
        que_thr_t*      thr);   
/**********************************************************************/
UNIV_INLINE
que_thr_t*
open_step(
/*======*/
        que_thr_t*      thr);   
/**********************************************************************/
UNIV_INTERN
que_thr_t*
fetch_step(
/*=======*/
        que_thr_t*      thr);   
/****************************************************************/
UNIV_INTERN
void*
row_fetch_print(
/*============*/
        void*   row,            
        void*   user_arg);      
/***********************************************************/
UNIV_INTERN
que_thr_t*
row_printf_step(
/*============*/
        que_thr_t*      thr);   
/****************************************************************/
UNIV_INTERN
void
row_sel_convert_mysql_key_to_innobase(
/*==================================*/
        dtuple_t*       tuple,          
        byte*           buf,            
        ulint           buf_len,        
        dict_index_t*   index,          
        const byte*     key_ptr,        
        ulint           key_len,        
        trx_t*          trx);           
/********************************************************************/
UNIV_INTERN
dberr_t
row_search_for_mysql(
/*=================*/
        byte*           buf,            
        ulint           mode,           
        row_prebuilt_t* prebuilt,       
        ulint           match_mode,     
        ulint           direction)      
        __attribute__((nonnull, warn_unused_result));
/*******************************************************************/
UNIV_INTERN
ibool
row_search_check_if_query_cache_permitted(
/*======================================*/
        trx_t*          trx,            
        const char*     norm_name);     
/*******************************************************************/
UNIV_INTERN
dberr_t
row_search_max_autoinc(
/*===================*/
        dict_index_t*   index,          
        const char*     col_name,       
        ib_uint64_t*    value)          
        __attribute__((nonnull, warn_unused_result));

struct sel_buf_t{
        byte*           data;   
        ulint           len;    
        ulint           val_buf_size;
};

struct plan_t{
        dict_table_t*   table;          
        dict_index_t*   index;          
        btr_pcur_t      pcur;           
        ibool           asc;            
        ibool           pcur_is_open;   
        ibool           cursor_at_end;  
        ibool           stored_cursor_rec_processed;
        que_node_t**    tuple_exps;     
        dtuple_t*       tuple;          
        ulint           mode;           
        ulint           n_exact_match;  
        ibool           unique_search;  
        ulint           n_rows_fetched; 
        ulint           n_rows_prefetched;
        ulint           first_prefetched;
        ibool           no_prefetch;    
        sym_node_list_t columns;        
        UT_LIST_BASE_NODE_T(func_node_t)
                        end_conds;      
        UT_LIST_BASE_NODE_T(func_node_t)
                        other_conds;    
        ibool           must_get_clust; 
        ulint*          clust_map;      
        dtuple_t*       clust_ref;      
        btr_pcur_t      clust_pcur;     
        mem_heap_t*     old_vers_heap;  
};

enum sel_node_state {
        SEL_NODE_CLOSED,        
        SEL_NODE_OPEN,          
        SEL_NODE_FETCH,         
        SEL_NODE_NO_MORE_ROWS   
};

struct sel_node_t{
        que_common_t    common;         
        enum sel_node_state
                        state;  
        que_node_t*     select_list;    
        sym_node_t*     into_list;      
        sym_node_t*     table_list;     
        ibool           asc;            
        ibool           set_x_locks;    
        ulint           row_lock_mode;  
        ulint           n_tables;       
        ulint           fetch_table;    
        plan_t*         plans;          
        que_node_t*     search_cond;    
        read_view_t*    read_view;      
        ibool           consistent_read;
        order_node_t*   order_by;       
        ibool           is_aggregate;   
        ibool           aggregate_already_fetched;
        ibool           can_get_updated;
        sym_node_t*     explicit_cursor;
        UT_LIST_BASE_NODE_T(sym_node_t)
                        copy_variables; 
};

struct fetch_node_t{
        que_common_t    common;         
        sel_node_t*     cursor_def;     
        sym_node_t*     into_list;      
        pars_user_func_t*
                        func;           
};

enum open_node_op {
        ROW_SEL_OPEN_CURSOR,    
        ROW_SEL_CLOSE_CURSOR    
};

struct open_node_t{
        que_common_t    common;         
        enum open_node_op
                        op_type;        
        sel_node_t*     cursor_def;     
};

struct row_printf_node_t{
        que_common_t    common;         
        sel_node_t*     sel_node;       
};

enum row_sel_direction {
        ROW_SEL_NEXT = 1,       
        ROW_SEL_PREV = 2        
};

enum row_sel_match_mode {
        ROW_SEL_EXACT = 1,      
        ROW_SEL_EXACT_PREFIX    
};

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

#endif