2008-03-13 17:37:20 +01:00
|
|
|
/*
|
|
|
|
* The contents of this file are subject to the Initial
|
|
|
|
* Developer's Public License Version 1.0 (the "License");
|
|
|
|
* you may not use this file except in compliance with the
|
|
|
|
* License. You may obtain a copy of the License at
|
|
|
|
* http://www.ibphoenix.com/main.nfs?a=ibphoenix&page=ibp_idpl.
|
|
|
|
*
|
|
|
|
* Software distributed under the License is distributed AS IS,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied.
|
|
|
|
* See the License for the specific language governing rights
|
|
|
|
* and limitations under the License.
|
|
|
|
*
|
|
|
|
* The Original Code was created by Adriano dos Santos Fernandes
|
|
|
|
* for the Firebird Open Source RDBMS project.
|
|
|
|
*
|
|
|
|
* Copyright (c) 2008 Adriano dos Santos Fernandes <adrianosf@uol.com.br>
|
|
|
|
* and all contributors signed below.
|
|
|
|
*
|
|
|
|
* All Rights Reserved.
|
|
|
|
* Contributor(s): ______________________________________.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef JRD_PREPARED_STATEMENT_H
|
|
|
|
#define JRD_PREPARED_STATEMENT_H
|
|
|
|
|
2009-10-21 02:42:38 +02:00
|
|
|
#include "firebird.h"
|
|
|
|
#include "../jrd/common.h"
|
|
|
|
#include "../jrd/dsc.h"
|
2008-04-01 17:41:09 +02:00
|
|
|
#include "../common/classes/alloc.h"
|
2008-03-13 17:37:20 +01:00
|
|
|
#include "../common/classes/array.h"
|
2008-04-01 17:41:09 +02:00
|
|
|
#include "../common/classes/fb_string.h"
|
2009-10-21 02:42:38 +02:00
|
|
|
#include "../common/classes/MetaName.h"
|
2009-12-31 18:08:07 +01:00
|
|
|
#include "../common/classes/TriState.h"
|
2008-03-13 17:37:20 +01:00
|
|
|
|
|
|
|
namespace Jrd {
|
|
|
|
|
|
|
|
class thread_db;
|
|
|
|
class jrd_tra;
|
|
|
|
class Attachment;
|
|
|
|
class dsql_req;
|
2008-04-09 17:56:49 +02:00
|
|
|
class dsql_msg;
|
2008-03-13 17:37:20 +01:00
|
|
|
class ResultSet;
|
|
|
|
|
|
|
|
|
2008-04-01 17:41:09 +02:00
|
|
|
class PreparedStatement : public Firebird::PermanentStorage
|
2008-03-13 17:37:20 +01:00
|
|
|
{
|
|
|
|
friend class ResultSet;
|
|
|
|
|
2009-12-31 18:08:07 +01:00
|
|
|
public:
|
2009-12-28 23:18:40 +01:00
|
|
|
class Builder
|
|
|
|
{
|
2009-12-31 18:08:07 +01:00
|
|
|
private:
|
|
|
|
enum Type
|
|
|
|
{
|
|
|
|
TYPE_SLONG,
|
|
|
|
TYPE_METANAME,
|
|
|
|
TYPE_STRING,
|
|
|
|
};
|
|
|
|
|
2009-12-28 23:18:40 +01:00
|
|
|
public:
|
|
|
|
Builder(const Firebird::string& aText)
|
|
|
|
: text(aText),
|
|
|
|
params(0)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
2009-12-31 18:08:07 +01:00
|
|
|
public:
|
2009-12-28 23:18:40 +01:00
|
|
|
Builder& operator <<(const char* chunk)
|
|
|
|
{
|
|
|
|
text += chunk;
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
2009-12-31 18:08:07 +01:00
|
|
|
Builder& operator <<(SLONG& param)
|
|
|
|
{
|
|
|
|
types.add(TYPE_SLONG);
|
|
|
|
addresses.add(¶m);
|
|
|
|
specifiedAddresses.add(NULL);
|
|
|
|
|
|
|
|
text += "?";
|
|
|
|
++params;
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
Builder& operator <<(Firebird::string& param)
|
|
|
|
{
|
|
|
|
types.add(TYPE_STRING);
|
|
|
|
addresses.add(¶m);
|
|
|
|
specifiedAddresses.add(NULL);
|
|
|
|
|
|
|
|
text += "?";
|
|
|
|
++params;
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
Builder& operator <<(Firebird::MetaName& param)
|
|
|
|
{
|
|
|
|
types.add(TYPE_METANAME);
|
|
|
|
addresses.add(¶m);
|
|
|
|
specifiedAddresses.add(NULL);
|
|
|
|
|
|
|
|
text += "?";
|
|
|
|
++params;
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
template <typename T> Builder& operator <<(TriStateType<T>& param)
|
|
|
|
{
|
|
|
|
*this << param.value;
|
|
|
|
specifiedAddresses[specifiedAddresses.getCount() - 1] = ¶m.specified;
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
public:
|
|
|
|
const Firebird::string& getText() const
|
|
|
|
{
|
|
|
|
return text;
|
|
|
|
}
|
|
|
|
|
|
|
|
void moveToStatement(thread_db* tdbb, PreparedStatement* stmt) const;
|
|
|
|
|
|
|
|
private:
|
|
|
|
Firebird::string text;
|
|
|
|
Firebird::Array<Type> types;
|
|
|
|
Firebird::Array<void*> addresses;
|
|
|
|
Firebird::Array<bool*> specifiedAddresses;
|
|
|
|
unsigned params;
|
|
|
|
};
|
|
|
|
|
|
|
|
private:
|
|
|
|
// Auxiliary class to use positional parameters with C++ variables.
|
|
|
|
class PosBuilder
|
|
|
|
{
|
|
|
|
public:
|
2010-01-02 07:16:06 +01:00
|
|
|
explicit PosBuilder(const Firebird::string& aText)
|
2009-12-31 18:08:07 +01:00
|
|
|
: text(aText),
|
|
|
|
params(0)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
PosBuilder& operator <<(const char* chunk)
|
|
|
|
{
|
|
|
|
text += chunk;
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
PosBuilder& operator <<(unsigned& param)
|
2009-12-28 23:18:40 +01:00
|
|
|
{
|
|
|
|
text += "?";
|
|
|
|
param = ++params;
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
operator const Firebird::string& ()
|
|
|
|
{
|
|
|
|
return text;
|
|
|
|
}
|
|
|
|
|
|
|
|
private:
|
|
|
|
Firebird::string text;
|
|
|
|
unsigned params;
|
|
|
|
};
|
|
|
|
|
|
|
|
public:
|
2009-12-31 18:08:07 +01:00
|
|
|
// Create a PreparedStatement builder to use positional parameters with C++ variables.
|
|
|
|
static PosBuilder build(const Firebird::string& text)
|
2009-12-28 23:18:40 +01:00
|
|
|
{
|
2009-12-31 18:08:07 +01:00
|
|
|
return PosBuilder(text);
|
2009-12-28 23:18:40 +01:00
|
|
|
}
|
|
|
|
|
2009-12-20 22:01:10 +01:00
|
|
|
// Escape a metadata name accordingly to SQL rules.
|
|
|
|
static Firebird::string escapeName(const Firebird::MetaName& s)
|
|
|
|
{
|
|
|
|
Firebird::string ret;
|
|
|
|
|
|
|
|
for (const char* p = s.begin(); p != s.end(); ++p)
|
|
|
|
{
|
|
|
|
ret += *p;
|
|
|
|
if (*p == '\"')
|
|
|
|
ret += '\"';
|
|
|
|
}
|
|
|
|
|
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Escape a string accordingly to SQL rules.
|
|
|
|
template <typename T> static Firebird::string escapeString(const T& s)
|
|
|
|
{
|
|
|
|
Firebird::string ret;
|
|
|
|
|
|
|
|
for (const char* p = s.begin(); p != s.end(); ++p)
|
|
|
|
{
|
|
|
|
ret += *p;
|
|
|
|
if (*p == '\'')
|
|
|
|
ret += '\'';
|
|
|
|
}
|
|
|
|
|
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
2009-12-31 18:08:07 +01:00
|
|
|
public:
|
|
|
|
PreparedStatement(thread_db* tdbb, Firebird::MemoryPool& aPool, Attachment* attachment,
|
|
|
|
jrd_tra* transaction, const Firebird::string& text, bool isInternalRequest);
|
|
|
|
PreparedStatement(thread_db* tdbb, Firebird::MemoryPool& aPool, Attachment* attachment,
|
|
|
|
jrd_tra* transaction, const Builder& aBuilder, bool isInternalRequest);
|
|
|
|
~PreparedStatement();
|
|
|
|
|
|
|
|
private:
|
|
|
|
void init(thread_db* tdbb, Attachment* attachment, jrd_tra* transaction,
|
|
|
|
const Firebird::string& text, bool isInternalRequest);
|
|
|
|
|
2008-03-13 17:37:20 +01:00
|
|
|
public:
|
2009-12-19 16:00:18 +01:00
|
|
|
void setDesc(thread_db* tdbb, unsigned param, const dsc& value);
|
2009-10-21 02:42:38 +02:00
|
|
|
|
2009-12-19 16:00:18 +01:00
|
|
|
void setNull(unsigned param)
|
2009-10-21 02:42:38 +02:00
|
|
|
{
|
2009-12-19 16:00:18 +01:00
|
|
|
fb_assert(param > 0);
|
|
|
|
|
2009-10-21 02:42:38 +02:00
|
|
|
const dsc* desc = &inValues[(param - 1) * 2 + 1];
|
|
|
|
fb_assert(desc->dsc_dtype == dtype_short);
|
|
|
|
*reinterpret_cast<SSHORT*>(desc->dsc_address) = -1;
|
|
|
|
}
|
|
|
|
|
2009-12-28 11:21:51 +01:00
|
|
|
void setInt(thread_db* tdbb, unsigned param, SLONG value)
|
2009-12-26 23:06:24 +01:00
|
|
|
{
|
|
|
|
fb_assert(param > 0);
|
|
|
|
|
|
|
|
dsc desc;
|
2009-12-28 11:21:51 +01:00
|
|
|
desc.makeLong(0, &value);
|
2009-12-26 23:06:24 +01:00
|
|
|
|
|
|
|
setDesc(tdbb, param, desc);
|
|
|
|
}
|
|
|
|
|
2009-12-19 16:00:18 +01:00
|
|
|
void setString(thread_db* tdbb, unsigned param, const Firebird::AbstractString& value)
|
2009-10-21 02:42:38 +02:00
|
|
|
{
|
2009-12-19 16:00:18 +01:00
|
|
|
fb_assert(param > 0);
|
|
|
|
|
2009-10-21 02:42:38 +02:00
|
|
|
dsc desc;
|
|
|
|
desc.makeText((USHORT) value.length(), inValues[(param - 1) * 2].getTextType(),
|
|
|
|
(UCHAR*) value.c_str());
|
|
|
|
|
|
|
|
setDesc(tdbb, param, desc);
|
|
|
|
}
|
|
|
|
|
2009-12-19 16:00:18 +01:00
|
|
|
void setString(thread_db* tdbb, unsigned param, const Firebird::MetaName& value)
|
2009-10-21 02:42:38 +02:00
|
|
|
{
|
2009-12-19 16:00:18 +01:00
|
|
|
fb_assert(param > 0);
|
|
|
|
|
2009-10-21 02:42:38 +02:00
|
|
|
dsc desc;
|
|
|
|
desc.makeText((USHORT) value.length(), inValues[(param - 1) * 2].getTextType(),
|
|
|
|
(UCHAR*) value.c_str());
|
|
|
|
|
|
|
|
setDesc(tdbb, param, desc);
|
|
|
|
}
|
|
|
|
|
2008-03-13 17:37:20 +01:00
|
|
|
void execute(thread_db* tdbb, jrd_tra* transaction);
|
|
|
|
ResultSet* executeQuery(thread_db* tdbb, jrd_tra* transaction);
|
2009-12-19 16:00:18 +01:00
|
|
|
unsigned executeUpdate(thread_db* tdbb, jrd_tra* transaction);
|
2008-03-13 17:37:20 +01:00
|
|
|
|
2008-03-15 11:25:30 +01:00
|
|
|
int getResultCount() const;
|
2008-03-13 17:37:20 +01:00
|
|
|
|
|
|
|
dsql_req* getRequest()
|
|
|
|
{
|
|
|
|
return request;
|
|
|
|
}
|
|
|
|
|
2009-12-22 16:36:10 +01:00
|
|
|
static void parseDsqlMessage(const dsql_msg* dsqlMsg, Firebird::Array<dsc>& values,
|
2009-10-31 23:35:48 +01:00
|
|
|
Firebird::UCharBuffer& blr, Firebird::UCharBuffer& msg);
|
2008-04-10 04:35:30 +02:00
|
|
|
static void generateBlr(const dsc* desc, Firebird::UCharBuffer& blr);
|
2008-03-13 17:37:20 +01:00
|
|
|
|
|
|
|
private:
|
2009-12-31 18:08:07 +01:00
|
|
|
const Builder* builder;
|
2008-03-13 17:37:20 +01:00
|
|
|
dsql_req* request;
|
2009-10-21 02:42:38 +02:00
|
|
|
Firebird::Array<dsc> inValues, outValues;
|
|
|
|
Firebird::UCharBuffer inBlr, outBlr;
|
|
|
|
Firebird::UCharBuffer inMessage, outMessage;
|
2008-03-13 17:37:20 +01:00
|
|
|
ResultSet* resultSet;
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
} // namespace
|
|
|
|
|
|
|
|
#endif // JRD_PREPARED_STATEMENT_H
|