extensions/sqlite/driver/SqQuery.h
author David Anderson <dvander@alliedmods.net>
Sun Jul 29 01:15:31 2007 +0000 (2007-07-29)
changeset 1203 633c25ce6405
child 1210 18e60c8737a2
permissions -rw-r--r--
initial import of sqlite extension
dvander@1203
     1
/**
dvander@1203
     2
 * vim: set ts=4 :
dvander@1203
     3
 * ===============================================================
dvander@1203
     4
 * SourceMod SQLite Driver Extension
dvander@1203
     5
 * Copyright (C) 2004-2007 AlliedModders LLC. All rights reserved.
dvander@1203
     6
 * ===============================================================
dvander@1203
     7
 *
dvander@1203
     8
 * This program is free software; you can redistribute it and/or
dvander@1203
     9
 * modify it under the terms of the GNU General Public License
dvander@1203
    10
 * as published by the Free Software Foundation; either version 2
dvander@1203
    11
 * of the License, or (at your option) any later version.
dvander@1203
    12
 * This program is distributed in the hope that it will be useful,
dvander@1203
    13
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
dvander@1203
    14
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
dvander@1203
    15
 * GNU General Public License for more details.
dvander@1203
    16
 * 
dvander@1203
    17
 * You should have received a copy of the GNU General Public License
dvander@1203
    18
 * along with this program; if not, write to the Free Software
dvander@1203
    19
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
dvander@1203
    20
 *
dvander@1203
    21
 * Version: $Id$
dvander@1203
    22
 */
dvander@1203
    23
dvander@1203
    24
#ifndef _INCLUDE_SQLITE_SOURCEMOD_QUERY_H_
dvander@1203
    25
#define _INCLUDE_SQLITE_SOURCEMOD_QUERY_H_
dvander@1203
    26
dvander@1203
    27
#include "SqDatabase.h"
dvander@1203
    28
#include "SqResults.h"
dvander@1203
    29
dvander@1203
    30
class SqQuery : 
dvander@1203
    31
	public IPreparedQuery
dvander@1203
    32
{
dvander@1203
    33
public:
dvander@1203
    34
	SqQuery(SqDatabase *parent, sqlite3_stmt *stmt);
dvander@1203
    35
	~SqQuery();
dvander@1203
    36
public: //IQuery
dvander@1203
    37
	IResultSet *GetResultSet();
dvander@1203
    38
	bool FetchMoreResults();
dvander@1203
    39
	void Destroy();
dvander@1203
    40
public: //IPreparedQuery
dvander@1203
    41
	bool BindParamInt(unsigned int param, int num, bool signd=true);
dvander@1203
    42
	bool BindParamFloat(unsigned int param, float f);
dvander@1203
    43
	bool BindParamNull(unsigned int param);
dvander@1203
    44
	bool BindParamString(unsigned int param, const char *text, bool copy);
dvander@1203
    45
	bool BindParamBlob(unsigned int param, const void *data, size_t length, bool copy);
dvander@1203
    46
	bool Execute();
dvander@1203
    47
	const char *GetError(int *errCode=NULL);
dvander@1203
    48
	unsigned int GetAffectedRows();
dvander@1203
    49
	unsigned int GetInsertID();
dvander@1203
    50
public: //IResultSet
dvander@1203
    51
	unsigned int GetRowCount();
dvander@1203
    52
	unsigned int GetFieldCount();
dvander@1203
    53
	const char *FieldNumToName(unsigned int columnId);
dvander@1203
    54
	bool FieldNameToNum(const char *name, unsigned int *columnId);
dvander@1203
    55
	bool MoreRows();
dvander@1203
    56
	IResultRow *FetchRow();
dvander@1203
    57
	IResultRow *CurrentRow();
dvander@1203
    58
	bool Rewind();
dvander@1203
    59
	DBType GetFieldType(unsigned int field);
dvander@1203
    60
	DBType GetFieldDataType(unsigned int field);
dvander@1203
    61
public: //IResultRow
dvander@1203
    62
	DBResult GetString(unsigned int columnId, const char **pString, size_t *length);
dvander@1203
    63
	DBResult CopyString(unsigned int columnId, 
dvander@1203
    64
		char *buffer, 
dvander@1203
    65
		size_t maxlength, 
dvander@1203
    66
		size_t *written);
dvander@1203
    67
	DBResult GetFloat(unsigned int columnId, float *pFloat);
dvander@1203
    68
	DBResult GetInt(unsigned int columnId, int *pInt);
dvander@1203
    69
	bool IsNull(unsigned int columnId);
dvander@1203
    70
	size_t GetDataSize(unsigned int columnId);
dvander@1203
    71
	DBResult GetBlob(unsigned int columnId, const void **pData, size_t *length);
dvander@1203
    72
	DBResult CopyBlob(unsigned int columnId, void *buffer, size_t maxlength, size_t *written);
dvander@1203
    73
public:
dvander@1203
    74
	sqlite3_stmt *GetStmt();
dvander@1203
    75
private:
dvander@1203
    76
	SqDatabase *m_pParent;
dvander@1203
    77
	sqlite3_stmt *m_pStmt;
dvander@1203
    78
	SqResults *m_pResults;
dvander@1203
    79
	unsigned int m_ParamCount;
dvander@1203
    80
	String m_LastError;
dvander@1203
    81
	int m_LastErrorCode;
dvander@1203
    82
	unsigned int m_AffectedRows;
dvander@1203
    83
	unsigned int m_InsertID;
dvander@1203
    84
};
dvander@1203
    85
dvander@1203
    86
#endif //_INCLUDE_SQLITE_SOURCEMOD_QUERY_H_