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