Statement.h

Go to the documentation of this file.

/******************************************************************************
*
* Copyright Saab AB, 2005-2013 (http://safir.sourceforge.net)
*
* Created by: Jörgen Johansson / stjrjo
*
*******************************************************************************
*
* This file is part of Safir SDK Core.
*
* Safir SDK Core is free software: you can redistribute it and/or modify
* it under the terms of version 3 of the GNU General Public License as
* published by the Free Software Foundation.
*
* Safir SDK Core is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Safir SDK Core.  If not, see <http://www.gnu.org/licenses/>.
*
******************************************************************************/
#ifndef Safir_Databases_Statement_h
#define Safir_Databases_Statement_h

#include "Safir/Databases/Odbc/Defs.h"
#include "Safir/Databases/Odbc/Internal/InternalDefs.h"
#include "Safir/Databases/Odbc/Internal/Parameter.h"
#include "Safir/Databases/Odbc/Internal/Column.h"
#include "Safir/Databases/Odbc/Internal/BufferedWideStringParameter.h"
#include "Safir/Databases/Odbc/Internal/NonBufferedWideStringParameter.h"
#include "Safir/Databases/Odbc/Internal/BufferedBinaryParameter.h"
#include "Safir/Databases/Odbc/Internal/NonBufferedBinaryParameter.h"
#include "Safir/Databases/Odbc/Internal/BinaryColumn.h"
#include "Safir/Databases/Odbc/Internal/WideStringColumn.h"

#include <boost/noncopyable.hpp>
#include <Safir/Dob/Typesystem/Exceptions.h>

namespace Safir
{
namespace Databases
{
namespace Odbc
{
    class Connection;

#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable: 4275)
#endif

class OLIB_API Statement : private boost::noncopyable
{
public:
    Statement();

    ~Statement();

    void Alloc(Connection & pConnection);

    void Free();

    void CloseCursor();

    void Execute();

    void Prepare(const std::wstring & wszSqlCommand);

    void ExecDirect(const std::wstring & wszSqlCommand);

    bool Fetch();

    bool MoreResults();

   int GetNumberOfColumns() const;

    void SetStmtAttr(long lAttribute, long lValue);

    void SetStmtAttr(long lAttribute, const std::wstring & wszValue);

    void GetStmtAttr(long lAttribute, long & lValue) const;

    void GetStmtAttr(long lAttribute, wchar_t * wszValue, unsigned long ulLength) const;

    bool ParamData(unsigned short & lParameter) const;

    template<short sCType, short sSqlType, class Type, short sInputOutputType, unsigned long lColumnSize>
    void BindParameter( unsigned short usParameterNumber,
                        Internal::Parameter<sCType, sSqlType, Type, sInputOutputType,lColumnSize> & param );
    template<short sSqlType, short sInputOutputType>
    void BindParameter( unsigned short usParameterNumber,
                        Internal::NonBufferedWideStringParameter<sSqlType, sInputOutputType> & param );


    template<short sCType, short sSqlType, class Type, short sInputOutputType, unsigned long lColumnSize>
    void BindLongParameter( unsigned short usParameterNumber,
                            Internal::Parameter<sCType, sSqlType, Type, sInputOutputType,lColumnSize> & param );

    template<short sValueType, class Type>
    void BindColumn(unsigned short usColumnNumber,
                    Internal::Column<sValueType, Type> & column );

    template<short sValueType, class Type>
    bool GetData(   unsigned short usColumnNumber,
                    Internal::Column<sValueType, Type> & column );

    template<short sCType, short sSqlType, class Type, short sInputOutputType, unsigned long lColumnSize>
    void PutData(Internal::Parameter<sCType, sSqlType, Type, sInputOutputType,lColumnSize> & param );

    bool GetDiagRec(short sRecNumber,
                    std::wstring & SqlState,
                    boost::int32_t & NativeError,
                    std::wstring & MessageText,
                    bool & bDataRead) const;

    bool IsValid() const;

    SQLHDBC Handle() const;
private:
    SQLHSTMT m_hStatement;
    Connection * m_pConnection;

    void SetNotValid();
    void ThrowException(const std::wstring & fileName,
                        const Safir::Dob::Typesystem::Int64 lineNumber,
                        SQLRETURN original_returncode) const;
    void ThrowException(SQLSMALLINT HandleType,
                        SQLHANDLE Handle,
                        const std::wstring & fileName,
                        const Safir::Dob::Typesystem::Int64 lineNumber,
                        SQLRETURN original_returncode) const;

    friend class Safir::Databases::Odbc::Connection;
};

#ifdef _MSC_VER
#pragma warning(pop)
#endif

inline
SQLHDBC Statement::Handle() const
{
    return m_hStatement;
}

inline
bool Statement::IsValid() const
{
    return m_hStatement != SQL_NULL_HSTMT;
}

inline
void Statement::SetNotValid()
{
    m_hStatement = SQL_NULL_HSTMT;
}

template<short sValueType, class Type>
bool Statement::GetData(unsigned short usColumnNumber,
                        Internal::Column<sValueType, Type> & column )
{
    SQLRETURN ret;
    bool bDataFound = true;

    if (!IsValid())
        throw Safir::Dob::Typesystem::SoftwareViolationException(L"Using an invalid statement",__WFILE__,__LINE__);

    ret = ::SQLGetData( m_hStatement,                   // StatementHandle
                        usColumnNumber,                 // ColumnNumber,
                        column.m_csValueType,           // TargetType,
                        column.GetValuePtr(),           // TargetValuePtr,
                        column.GetSize(),               // BufferLength,
                        column.GetLengthOrIndPtr());    // StrLen_or_Ind
    if (ret==SQL_NO_DATA_FOUND)
        bDataFound = false;
    else if (!SQL_SUCCEEDED(ret))
    {
        ThrowException(__WFILE__,__LINE__, ret);
    }

    return bDataFound;
}

template<short sValueType, class Type>
void Statement::BindColumn( unsigned short usColumnNumber,
                            Internal::Column<sValueType, Type> & column )
{
    SQLRETURN ret;

    if (!IsValid())
        throw Safir::Dob::Typesystem::SoftwareViolationException(L"Using an invalid statement",__WFILE__,__LINE__);

    ret = ::SQLBindCol( m_hStatement,                   // StatementHandle
                        usColumnNumber,                 // ColumnNumber,
                        column.m_csValueType,           // TargetType,
                        column.GetValuePtr(),           // TargetValuePtr,
                        column.GetSize(),               // BufferLength,
                        column.GetLengthOrIndPtr());    // StrLen_or_Ind
    if (!SQL_SUCCEEDED(ret))
    {
        ThrowException(__WFILE__,__LINE__, ret);
    }
}

template<short sCType, short sSqlType, class Type, short sInputOutputType, unsigned long lColumnSize>
void Statement::BindParameter(  unsigned short usParameterNumber,
                                Internal::Parameter<sCType, sSqlType, Type, sInputOutputType,lColumnSize> & param )
{
    SQLRETURN ret;

    if (!IsValid())
        throw Safir::Dob::Typesystem::SoftwareViolationException(L"Using an invalid statement",__WFILE__,__LINE__);

    ret = ::SQLBindParameter(   m_hStatement,                   // StatementHandle
                                usParameterNumber,              // ParameterNumber,
                                param.m_csInputOutputType,      // InputOutputType
                                param.m_csCType,                // ValueType
                                param.m_csSqlType,              // ParameterType
                                param.GetColumnSize(),          // ColumnSize
                                param.GetDecimal(),             // DecimalDigits
                                param.GetValuePtr(),            // ParameterValuePtr
                                param.GetSize(),                // BufferLength
                                param.GetLengthOrIndPtr() );    // StrLen_or_Ind
    if (!SQL_SUCCEEDED(ret))
    {
        ThrowException(__WFILE__,__LINE__, ret);
    }
}

template<short sSqlType, short sInputOutputType>
void Statement::BindParameter(  unsigned short /*usParameterNumber*/,
                                Internal::NonBufferedWideStringParameter<sSqlType, sInputOutputType> & /*param*/ )
{
    throw Safir::Dob::Typesystem::SoftwareViolationException(L"This parameter can only be used with PutData",__WFILE__,__LINE__);
}


template<short sCType, short sSqlType, class Type, short sInputOutputType, unsigned long lColumnSize>
void Statement::BindLongParameter(  unsigned short usParameterNumber,
                                    Internal::Parameter<sCType, sSqlType, Type, sInputOutputType,lColumnSize> & param )
{
    SQLRETURN ret;

    if (!IsValid())
        throw Safir::Dob::Typesystem::SoftwareViolationException(L"Using an invalid statement",__WFILE__,__LINE__);

    ret = ::SQLBindParameter(   m_hStatement,                   // StatementHandle
                                usParameterNumber,              // ParameterNumber,
                                param.m_csInputOutputType,      // InputOutputType
                                param.m_csCType,                // ValueType
                                param.m_csSqlType,              // ParameterType
                                param.GetColumnSize(),          // ColumnSize
                                param.GetDecimal(),             // DecimalDigits
                                reinterpret_cast<SQLPOINTER>(usParameterNumber),    // ParameterValuePtr
                                param.GetSize(),                // BufferLength
                                param.GetLengthOrIndPtr() );    // StrLen_or_Ind
    if (!SQL_SUCCEEDED(ret))
    {
        ThrowException(__WFILE__,__LINE__, ret);
    }
}

template<short sCType, short sSqlType, class Type, short sInputOutputType, unsigned long lColumnSize>
void Statement::PutData(Internal::Parameter<sCType, sSqlType, Type, sInputOutputType,lColumnSize> & param )
{
    SQLRETURN ret;

    if (!IsValid())
        throw Safir::Dob::Typesystem::SoftwareViolationException(L"Using an invalid statement",__WFILE__,__LINE__);

    ret = ::SQLPutData( m_hStatement,                   // StatementHandle
                        param.GetValuePtr(),            // ParameterValuePtr
                        param.GetSize() );       // StrLen_or_Ind

    if (!SQL_SUCCEEDED(ret))
    {
        ThrowException(__WFILE__,__LINE__, ret);
    }
}

} // End namespace Odbc

} // End namespace Databases

} // End namespace Safir

#endif // Safir_Databases_Statement_h