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