#pragma once

#include <cpporm/util/macros.h>

CPPORM_BEGIN_SUB_NAMESPACE(db)

/*!
 * \brief Abstract class that represents a database prepared statement
 *
 * Prepared statements are used to execute dynamically bound SQL queries. The text of the query
 * should contain parameters whose values are taken from external variables.
 *
 * A statement should first be prepared, then its parameters should be bound to variables according
 * to the parameter indices. Batch execution can be activated, which allows successive bindings
 * for the same parameter.
 */
class CPPORM_EXPORT Statement
{
public:
    /*!
     * \brief Destructor
     */
    virtual ~Statement()
    {
    }

    /*!
     * \brief Prepare
     * \param[in] sql The SQL text
     */
    virtual void Prepare(const std::string &sql) = 0;

    /*!
     * \brief Bind
     * \param[in] param The parameter index
     * \param[in] value The parameter value
     */
    virtual void Bind(short param, const std::string &value) = 0;

    /*!
     * \brief Bind null
     * \param[in] param The parameter index
     */
    virtual void BindNull(short param) = 0;

    /*!
     * \brief Start batch
     */
    virtual void StartBatch() = 0;

    /*!
     * \brief End batch
     */
    virtual void EndBatch() = 0;

    /*!
     * \brief Is batch active
     */
    virtual bool IsBatchActive() = 0;
};

CPPORM_END_SUB_NAMESPACE