handler_api.h

Go to the documentation of this file.

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

Copyright (c) 2013, 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 HANDLER_API_H
#define HANDLER_API_H

#define MYSQL_SERVER 1

#define HDL_READ        0x1
#define HDL_WRITE       0x2

typedef enum hdl_op_type {
        HDL_UPDATE,
        HDL_INSERT,
        HDL_DELETE
} hdl_op_type_t;

#ifdef __cplusplus
extern "C" {
#endif
/**********************************************************************/
void*
handler_create_thd(
/*===============*/
        bool    enable_binlog);         
/**********************************************************************/
void*
handler_open_table(
/*===============*/
        void*           my_thd,         
        const char*     db_name,        
        const char*     table_name,     
        int             lock_mode);     
/**********************************************************************/
void
handler_binlog_row(
/*===============*/
        void*           my_thd,         
        void*           my_table,       
        int             mode);          
/**********************************************************************/
void
handler_thd_attach(
/*===============*/
        void*   my_thd,                 
        void**  original_thd);          
/**********************************************************************/
void
handler_binlog_commit(
/*==================*/
        void*           my_thd,         
        void*           my_table);      
/**********************************************************************/
void
handler_binlog_rollback(
/*====================*/
        void*           my_thd,         
        void*           my_table);      
/**********************************************************************/
void
handler_rec_init(
/*=============*/
        void*           my_table);      
/**********************************************************************/
void
handler_rec_setup_str(
/*==================*/
        void*           my_table,       
        int             field_id,       
        const char*     str,            
        int             len);           
/**********************************************************************/
void
handler_rec_setup_int(
/*==================*/
        void*           my_table,       
        int             field_id,       
        int             value,          
        bool            unsigned_flag,  
        bool            is_null);       
/**********************************************************************/
void
handler_rec_setup_uint64(
/*=====================*/
        void*           my_table,       
        int             field_id,       
        unsigned long long
                        value,          
        bool            unsigned_flag,  
        bool            is_null);       
/**********************************************************************/
int
handler_unlock_table(
/*=================*/
        void*           my_thd,         
        void*           my_table,       
        int             mode);          
/**********************************************************************/
void
handler_close_thd(
/*==============*/
        void*           my_thd);                
/**********************************************************************/
void
handler_store_record(
/*=================*/
        void*           my_table);              
/**********************************************************************/
void
handler_binlog_truncate(
/*====================*/
        void*           my_thd,         
        char*           table_name);    
#ifdef __cplusplus
}
#endif

/**********************************************************************
Following APIs  can perform DMLs through MySQL handler interface. They
are currently disabled and under HANDLER_API_MEMCACHED define
**********************************************************************/

#ifdef HANDLER_API_MEMCACHED

typedef struct field_arg {
        unsigned int    num_arg;        
        int*            len;            
        char**          value;          
} field_arg_t;

#define MCI_FIELD_ADD(M_ARGS, M_FLD, M_VALUE, M_LEN)                    \
        do {                                                            \
                (M_ARGS)->len[M_FLD] = M_LEN;                           \
                (M_ARGS)->value[M_FLD] = (char*)(M_VALUE);              \
        } while(0)

#define MCI_FIELD_ALLOC(FIELD, NUM_FLD)                                 \
        do {                                                            \
                FIELD->len = (int*)malloc((NUM_FLD) * sizeof(*(FIELD->len)));\
                memset(FIELD->len, 0, (NUM_FLD) * sizeof(*(FIELD->len)));\
                FIELD->value = (char**)malloc((NUM_FLD)                 \
                                              * sizeof(*(FIELD->value)));\
                FIELD->num_arg = NUM_FLD;                               \
        } while(0)

#define MCI_FIELD_FREE(FIELD)                                           \
        do {                                                            \
                free(FIELD->len);                                       \
                free(FIELD->value);                                     \
                FIELD->num_arg = 0;                                     \
        } while(0)

/**********************************************************************/
uchar*
handler_select_rec(
/*===============*/
        TABLE*          my_table,       
        field_arg_t*    srch_args,      
        int             idx_to_use);    
/**********************************************************************/
int
handler_insert_rec(
/*===============*/
        TABLE*          my_table,       
        field_arg_t*    store_args);    
/**********************************************************************/
int
handler_update_rec(
/*===============*/
        TABLE*          my_table,       
        field_arg_t*    store_args);    
/**********************************************************************/
int
handler_delete_rec(
/*===============*/
        TABLE*          my_table);      
/**********************************************************************/
MYSQL_LOCK *
handler_lock_table(
/*===============*/
        THD*                    my_thd,         
        TABLE*                  my_table,       
        enum thr_lock_type      lock_mode);     
#endif /* HANDLER_API_MEMCACHED */

#endif /* HANDLER_API_H */