IDBDriver.h

Go to the documentation of this file.

#ifndef _INCLUDE_SOURCEMOD_INTERFACE_DBDRIVER_H_
#define _INCLUDE_SOURCEMOD_INTERFACE_DBDRIVER_H_

#include <IShareSys.h>
#include <IHandleSys.h>
#include <string.h>

#define SMINTERFACE_DBI_NAME            "IDBI"
#define SMINTERFACE_DBI_VERSION         9

namespace SourceMod
{
        enum DBResult
        {
                DBVal_Error = 0,                
                DBVal_TypeMismatch = 1, 
                DBVal_Null = 2,                 
                DBVal_Data = 3,                 
        };

        enum DBType
        {
                DBType_Unknown = 0,             
                DBType_String,                  
                DBType_Blob,                    
                DBType_Integer,                 
                DBType_Float,                   
                DBType_NULL,                    
                /* --------- */
                DBTypes_TOTAL,                  
        };

        class IResultRow
        {
        public:
                virtual DBResult GetString(unsigned int columnId, const char **pString, size_t *length) =0;

                virtual DBResult CopyString(unsigned int columnId, 
                                                                        char *buffer, 
                                                                        size_t maxlength, 
                                                                        size_t *written) =0;
                
                virtual DBResult GetFloat(unsigned int columnId, float *pFloat) =0;

                virtual DBResult GetInt(unsigned int columnId, int *pInt) =0;

                virtual bool IsNull(unsigned int columnId) =0;

                virtual size_t GetDataSize(unsigned int columnId) =0;

                virtual DBResult GetBlob(unsigned int columnId, const void **pData, size_t *length) =0;

                virtual DBResult CopyBlob(unsigned int columnId, void *buffer, size_t maxlength, size_t *written) =0;
        };

        class IResultSet
        {
        public:
                virtual unsigned int GetRowCount() =0;

                virtual unsigned int GetFieldCount() =0;

                virtual const char *FieldNumToName(unsigned int columnId) =0;

                virtual bool FieldNameToNum(const char *name, unsigned int *columnId) =0;

                virtual bool MoreRows() =0;

                virtual IResultRow *FetchRow() =0;

                virtual IResultRow *CurrentRow() =0;

                virtual bool Rewind() =0;

                virtual DBType GetFieldType(unsigned int field) =0;

                virtual DBType GetFieldDataType(unsigned int field) =0;
        };

        class IDBDriver;

        class IQuery
        {
        public:
                virtual IResultSet *GetResultSet() =0;

                virtual bool FetchMoreResults() =0;

                virtual void Destroy() =0;
        };

        class IPreparedQuery : public IQuery
        {
        public:
                virtual bool BindParamInt(unsigned int param, int num, bool signd=true) =0;

                virtual bool BindParamFloat(unsigned int param, float f) =0;

                virtual bool BindParamNull(unsigned int param) =0;

                virtual bool BindParamString(unsigned int param, const char *text, bool copy) =0;

                virtual bool BindParamBlob(unsigned int param, 
                                                                        const void *data, 
                                                                        size_t length, 
                                                                        bool copy) =0;

                virtual bool Execute() =0;

                virtual const char *GetError(int *errCode=NULL) =0;

                virtual unsigned int GetAffectedRows() =0;

                virtual unsigned int GetInsertID() =0;
        };

        class IDBDriver;

        class IDatabase
        {
        public:
                virtual bool Close() =0;

                virtual const char *GetError(int *errorCode=NULL) =0;

                virtual bool DoSimpleQuery(const char *query) =0;

                virtual IQuery *DoQuery(const char *query) =0;

                virtual IPreparedQuery *PrepareQuery(const char *query, char *error, size_t maxlength, int *errCode=NULL) =0;

                virtual bool QuoteString(const char *str, char buffer[], size_t maxlen, size_t *newSize) =0;

                virtual unsigned int GetAffectedRows() =0;

                virtual unsigned int GetInsertID() =0;

                virtual bool LockForFullAtomicOperation() =0;

                virtual void UnlockFromFullAtomicOperation() =0;

                virtual void IncReferenceCount() =0;

                virtual IDBDriver *GetDriver() =0;

                virtual bool DoSimpleQueryEx(const char *query, size_t len) =0;

                virtual IQuery *DoQueryEx(const char *query, size_t len) =0;
                
                virtual unsigned int GetAffectedRowsForQuery(IQuery *query) =0;
                
                virtual unsigned int GetInsertIDForQuery(IQuery *query) =0;

                virtual bool SetCharacterSet(const char *characterset) =0;

#if !defined(SOURCEMOD_SQL_DRIVER_CODE)

                void AddRef() {
                        IncReferenceCount();
                }

                void Release() {
                        Close();
                }
#endif
        };

        struct DatabaseInfo
        {
                DatabaseInfo()
                {
                        dbiVersion = SMINTERFACE_DBI_VERSION;
                        port = 0;
                        maxTimeout = 0;
                }
                unsigned int dbiVersion;                
                const char *host;                               
                const char *database;                   
                const char *user;                               
                const char *pass;                               
                const char *driver;                             
                unsigned int port;                              
                unsigned int maxTimeout;                
        };

        class IDBDriver
        {
        public:
                virtual unsigned int GetDBIVersion()
                {
                        return SMINTERFACE_DBI_VERSION;
                }
        public:
                virtual IDatabase *Connect(const DatabaseInfo *info, bool persistent, char *error, size_t maxlength) =0;

                virtual const char *GetIdentifier() =0;

                virtual const char *GetProductName() =0;

                virtual Handle_t GetHandle() =0;

                virtual IdentityToken_t *GetIdentity() =0;

                virtual bool IsThreadSafe() =0;

                virtual bool InitializeThreadSafety() =0;

                virtual void ShutdownThreadSafety() =0;
        };

        enum PrioQueueLevel
        {
                PrioQueue_High,                 
                PrioQueue_Normal,               
                PrioQueue_Low                   
        };

        class IDBThreadOperation
        {
        public:
                virtual IDBDriver *GetDriver() =0;

                virtual IdentityToken_t *GetOwner() =0;

                virtual void RunThreadPart() =0;

                virtual void RunThinkPart() =0;

                virtual void CancelThinkPart() =0;

                virtual void Destroy() =0;
        };

        enum DBHandleType
        {
                DBHandle_Driver = 0,            
                DBHandle_Database = 1,          
        };

        class IDBManager : public SMInterface
        {
        public:
                virtual const char *GetInterfaceName() =0;
                virtual unsigned int GetInterfaceVersion() =0;
        public:
                virtual void AddDriver(IDBDriver *pDriver) =0;

                virtual void RemoveDriver(IDBDriver *pDriver) =0;

                virtual const DatabaseInfo *FindDatabaseConf(const char *name) =0;

                virtual bool Connect(const char *name, 
                                                        IDBDriver **pdr, 
                                                        IDatabase **pdb, 
                                                        bool persistent, 
                                                        char *error, 
                                                        size_t maxlength) =0;

                virtual unsigned int GetDriverCount() =0;

                virtual IDBDriver *GetDriver(unsigned int index) =0;

                virtual Handle_t CreateHandle(DBHandleType type, void *ptr, IdentityToken_t *pToken) =0;

                virtual HandleError ReadHandle(Handle_t hndl, DBHandleType type, void **ptr) =0;

                virtual HandleError ReleaseHandle(Handle_t hndl, DBHandleType type, IdentityToken_t *token) =0;

                virtual IDBDriver *FindOrLoadDriver(const char *driver) =0;

                virtual IDBDriver *GetDefaultDriver() =0;

                virtual bool AddToThreadQueue(IDBThreadOperation *op, PrioQueueLevel prio) =0;

                virtual void AddDependency(IExtension *myself, IDBDriver *driver) =0;
        };
}

#endif //_INCLUDE_SOURCEMOD_INTERFACE_DBDRIVER_H_