extensions/sqlite/driver/SqQuery.h
author David Anderson <dvander@alliedmods.net>
Wed Aug 01 01:54:53 2007 +0000 (2007-08-01)
changeset 1226 478550a4d5ec
parent 1210 18e60c8737a2
child 1330 ab94316bb52b
permissions -rw-r--r--
updated license headers for most extensions
updated sdk bases for most extensions
     1 /**
     2  * vim: set ts=4 :
     3  * ================================================================
     4  * SourceMod SQLite Extension
     5  * Copyright (C) 2004-2007 AlliedModders LLC.  All rights reserved.
     6  * ================================================================
     7  *
     8  * This program is free software; you can redistribute it and/or 
     9  * modify it under the terms of the GNU General Public License, 
    10  * version 3.0, as published by the Free Software Foundation.
    11  * 
    12  * This program is distributed in the hope that it will be useful,
    13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    15  * GNU General Public License for more details.
    16  *
    17  * You should have received a copy of the GNU General Public License
    18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
    19  *
    20  * As a special exception, AlliedModders LLC gives you permission to 
    21  * link the code of this program (as well as its derivative works) to 
    22  * "Half-Life 2," the "Source Engine," the "SourcePawn JIT," and any 
    23  * Game MODs that run on software by the Valve Corporation.  You must 
    24  * obey the GNU General Public License in all respects for all other 
    25  * code used. Additionally, AlliedModders LLC grants this exception 
    26  * to all derivative works. AlliedModders LLC defines further 
    27  * exceptions, found in LICENSE.txt (as of this writing, version 
    28  * JULY-31-2007), or <http://www.sourcemod.net/license.php>.
    29  *
    30  * Version: $Id$
    31  */
    32 
    33 #ifndef _INCLUDE_SQLITE_SOURCEMOD_QUERY_H_
    34 #define _INCLUDE_SQLITE_SOURCEMOD_QUERY_H_
    35 
    36 #include "SqDatabase.h"
    37 #include "SqResults.h"
    38 
    39 class SqQuery : 
    40 	public IPreparedQuery
    41 {
    42 public:
    43 	SqQuery(SqDatabase *parent, sqlite3_stmt *stmt);
    44 	~SqQuery();
    45 public: //IQuery
    46 	IResultSet *GetResultSet();
    47 	bool FetchMoreResults();
    48 	void Destroy();
    49 public: //IPreparedQuery
    50 	bool BindParamInt(unsigned int param, int num, bool signd=true);
    51 	bool BindParamFloat(unsigned int param, float f);
    52 	bool BindParamNull(unsigned int param);
    53 	bool BindParamString(unsigned int param, const char *text, bool copy);
    54 	bool BindParamBlob(unsigned int param, const void *data, size_t length, bool copy);
    55 	bool Execute();
    56 	const char *GetError(int *errCode=NULL);
    57 	unsigned int GetAffectedRows();
    58 	unsigned int GetInsertID();
    59 public: //IResultSet
    60 	unsigned int GetRowCount();
    61 	unsigned int GetFieldCount();
    62 	const char *FieldNumToName(unsigned int columnId);
    63 	bool FieldNameToNum(const char *name, unsigned int *columnId);
    64 	bool MoreRows();
    65 	IResultRow *FetchRow();
    66 	IResultRow *CurrentRow();
    67 	bool Rewind();
    68 	DBType GetFieldType(unsigned int field);
    69 	DBType GetFieldDataType(unsigned int field);
    70 public: //IResultRow
    71 	DBResult GetString(unsigned int columnId, const char **pString, size_t *length);
    72 	DBResult CopyString(unsigned int columnId, 
    73 		char *buffer, 
    74 		size_t maxlength, 
    75 		size_t *written);
    76 	DBResult GetFloat(unsigned int columnId, float *pFloat);
    77 	DBResult GetInt(unsigned int columnId, int *pInt);
    78 	bool IsNull(unsigned int columnId);
    79 	size_t GetDataSize(unsigned int columnId);
    80 	DBResult GetBlob(unsigned int columnId, const void **pData, size_t *length);
    81 	DBResult CopyBlob(unsigned int columnId, void *buffer, size_t maxlength, size_t *written);
    82 public:
    83 	sqlite3_stmt *GetStmt();
    84 private:
    85 	SqDatabase *m_pParent;
    86 	sqlite3_stmt *m_pStmt;
    87 	SqResults *m_pResults;
    88 	unsigned int m_ParamCount;
    89 	String m_LastError;
    90 	int m_LastErrorCode;
    91 	unsigned int m_AffectedRows;
    92 	unsigned int m_InsertID;
    93 	unsigned int m_ColCount;
    94 };
    95 
    96 #endif //_INCLUDE_SQLITE_SOURCEMOD_QUERY_H_