dba.h

/*
   Copyright (C) 2003-2006 MySQL AB
    All rights reserved. Use is subject to license terms.

   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 St, Fifth Floor, Boston, MA 02110-1301  USA
*/

/****** THIS LINE IS 80 CHARACTERS WIDE - DO *NOT* EXCEED 80 CHARACTERS! ****/

#ifndef DBA_H
#define DBA_H

/* --- Include files ---- */

#include <ndb_global.h>
#include <defs/pcn_types.h>

/* --- Types and definitions --- */

typedef enum {
  DBA_NO_ERROR = 0,         
  DBA_NOT_IMPLEMENTED = -1, 
  DBA_NDB_ERROR = -2,       
  DBA_ERROR = -3,           
  DBA_APPLICATION_ERROR = 1,    
  DBA_NO_DATA = 2,              
  DBA_CONSTRAINT_VIOLATION = 3, 
  DBA_SCHEMA_ERROR = 4,        
  DBA_INSUFFICIENT_SPACE = 5,  
  DBA_TEMPORARY_ERROR = 6,     
  DBA_TIMEOUT = 7,             
  DBA_OVERLOAD = 8,            
  DBA_UNKNOWN_RESULT = 9       
} DBA_Error_t;

typedef int DBA_ErrorCode_t;

typedef enum {
  DBA_CHAR,                      
  DBA_INT                        
} DBA_DataTypes_t;


typedef struct DBA_ColumnDesc {
  
    const char*      Name;       
    DBA_DataTypes_t  DataType;   
    Size_t           Size;       
    Boolean_t        IsKey;      
} DBA_ColumnDesc_t;

#define DBA_BINDING( ColName, Type, Struct, Field ) \
   { ColName, Type, PCN_SIZE_OF( Struct, Field ), \
     PCN_OFFSET_OF( Struct, Field ), 0, 0 }

#define DBA_BINDING_PTR(Struct, Field, ColBindings, NbCBindings) \
   { 0, DBA_CHAR, NbCBindings, PCN_OFFSET_OF( Struct, Field ), \
     1, ColBindings }

struct DBA_ColumnBinding {
  const char*                Name;      
  DBA_DataTypes_t            DataType;  
  Size_t                     Size;      
  Size_t                     Offset;    
  Boolean_t                  Ptr;       
  const struct DBA_ColumnBinding * SubBinding;  
};

typedef struct DBA_ColumnBinding DBA_ColumnBinding_t;

typedef struct DBA_Binding DBA_Binding_t;

/* --- Exported functions --- */

DBA_Error_t DBA_SetParameter(int ParameterId, int Value);

DBA_Error_t DBA_GetParameter(int ParameterId, int * Value);

DBA_Error_t DBA_Open( ); 

DBA_Error_t DBA_Close(void); 

DBA_Error_t DBA_GetLatestError();

DBA_ErrorCode_t DBA_GetLatestNdbError();

const char * DBA_GetLatestErrorMsg();

const char * DBA_GetErrorMsg(DBA_Error_t);

const char * DBA_GetNdbErrorMsg(DBA_ErrorCode_t);

DBA_Error_t 
DBA_CreateTable( const char* TableName, int NbColumns, 
                 const DBA_ColumnDesc_t Columns[] );

DBA_Error_t 
DBA_DropTable( const char* TableName );


Boolean_t 
DBA_TableExists( const char* TableName );

DBA_Binding_t*
DBA_CreateBinding( const char* TableName, 
                    int NbCol, const DBA_ColumnBinding_t ColsBinding[], 
                    Size_t StructSz );

DBA_Error_t 
DBA_DestroyBinding( DBA_Binding_t* Binding );

typedef long DBA_ReqId_t;

#define DBA_INVALID_REQID 0

typedef void (*DBA_AsyncCallbackFn_t)( DBA_ReqId_t ReqId,
                                       DBA_Error_t Status,
                                       DBA_ErrorCode_t ErrorCode );
DBA_ReqId_t
DBA_InsertRows( const DBA_Binding_t* pBinding, const void * const pData[],
                int NbRows,
                DBA_AsyncCallbackFn_t CbFunc );

DBA_ReqId_t
DBA_ArrayInsertRows( const DBA_Binding_t* pBinding, const void * pData,
                     int NbRows,
                     DBA_AsyncCallbackFn_t CbFunc );

DBA_ReqId_t
DBA_UpdateRows( const DBA_Binding_t* pBinding, const void * const pData[],
                int NbRows,
                DBA_AsyncCallbackFn_t CbFunc );

DBA_ReqId_t
DBA_ArrayUpdateRows( const DBA_Binding_t* pBinding, const void * pData,
                     int NbRows,
                     DBA_AsyncCallbackFn_t CbFunc );

DBA_ReqId_t
DBA_DeleteRows( const DBA_Binding_t* pBinding, const void * const pData[],
                int NbRows,
                DBA_AsyncCallbackFn_t CbFunc );


DBA_ReqId_t
DBA_ArrayDeleteRows( const DBA_Binding_t* pBinding, const void * pData,
                     int NbRows,
                     DBA_AsyncCallbackFn_t CbFunc );

DBA_ReqId_t
DBA_WriteRows( const DBA_Binding_t* pBinding, const void * const pData[],
               int NbRows,
               DBA_AsyncCallbackFn_t CbFunc );

DBA_ReqId_t
DBA_ArrayWriteRows( const DBA_Binding_t* pBinding, const void * pData,
                    int NbRows,
                    DBA_AsyncCallbackFn_t CbFunc );

DBA_ReqId_t
DBA_ReadRows( const DBA_Binding_t* pBinding, void * const pData[],
              int NbRows,
              DBA_AsyncCallbackFn_t CbFunc );

DBA_ReqId_t
DBA_ArrayReadRows( const DBA_Binding_t* pBinding, void * pData,
                   int NbRows,
                   DBA_AsyncCallbackFn_t CbFunc );

/****** THIS LINE IS 80 CHARACTERS WIDE - DO *NOT* EXCEED 80 CHARACTERS! ****/

DBA_ReqId_t
DBA_MultiInsertRow(const DBA_Binding_t * const pBindings[],
                   const void * const pData[],
                   int NbBindings,
                   DBA_AsyncCallbackFn_t CbFunc );

DBA_ReqId_t
DBA_MultiUpdateRow(const DBA_Binding_t * const pBindings[],
                   const void * const pData[],
                   int NbBindings,
                   DBA_AsyncCallbackFn_t CbFunc );

DBA_ReqId_t
DBA_MultiWriteRow(const DBA_Binding_t * const pBindings[],
                  const void * const pData[],
                  int NbBindings,
                  DBA_AsyncCallbackFn_t CbFunc );

DBA_ReqId_t
DBA_MultiDeleteRow(const DBA_Binding_t * const pBindings[],
                   const void * const pData[],
                   int NbBindings,
                   DBA_AsyncCallbackFn_t CbFunc );

DBA_ReqId_t
DBA_MultiReadRow(const DBA_Binding_t * const pBindings[],
                 void * const pData[],
                 int NbBindings,
                 DBA_AsyncCallbackFn_t CbFunc );

/****** THIS LINE IS 80 CHARACTERS WIDE - DO *NOT* EXCEED 80 CHARACTERS! ****/

typedef struct DBA_BulkReadResultSet {
  void * DataPtr;               
  Boolean_t RowFoundIndicator;  
} DBA_BulkReadResultSet_t;

DBA_ReqId_t
DBA_BulkReadRows(const DBA_Binding_t * pBinding,
                 DBA_BulkReadResultSet_t pData[],
                 int NbRows,
                 DBA_AsyncCallbackFn_t CbFunc );

DBA_ReqId_t
DBA_BulkMultiReadRows(const DBA_Binding_t * const pBindings[],
                      DBA_BulkReadResultSet_t pData[],
                      int NbBindings,
                      int NbRows,
                      DBA_AsyncCallbackFn_t CbFunc );

#endif