DbStorageImpl.h

Go to the documentation of this file.

// -*- lsst-c++ -*-

/* 
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 LSST Corporation.
 * 
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program 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 LSST License Statement and 
 * the GNU General Public License along with this program.  If not, 
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */
 
#ifndef LSST_MWI_PERSISTENCE_DBSTORAGEIMPL_H
#define LSST_MWI_PERSISTENCE_DBSTORAGEIMPL_H

#include <boost/shared_array.hpp>
#include <mysql/mysql.h>
#include <string>
#include <vector>


#include "lsst/tr1/unordered_map.h"
#include "lsst/daf/base/Citizen.h"
#include "lsst/daf/base/DateTime.h"
#include "lsst/pex/policy.h"

namespace lsst {
namespace daf {
namespace persistence {

namespace dafBase = lsst::daf::base;
namespace pexPolicy = lsst::pex::policy;

class LogicalLocation;

class BoundVar : public dafBase::Citizen {
public:
    BoundVar(void);
    explicit BoundVar(void* location);
    BoundVar(BoundVar const& src);

    enum_field_types _type;
    bool _isNull;
    bool _isUnsigned;
    unsigned long _length;
    void* _data;
};

class DbStorageImpl : public dafBase::Citizen {
public:
    virtual ~DbStorageImpl(void);


private:
    friend class DbStorage;

    DbStorageImpl(void);

    virtual void setPolicy(pexPolicy::Policy::Ptr policy);
    virtual void setPersistLocation(LogicalLocation const& location);
    virtual void setRetrieveLocation(LogicalLocation const& location);

    virtual void startTransaction(void);
    virtual void endTransaction(void);

    virtual void startSession(std::string const& location);

    virtual void createTableFromTemplate(std::string const& tableName,
                                         std::string const& templateName,
                                         bool mayAlreadyExist);
    virtual void dropTable(std::string const& tableName);
    virtual void truncateTable(std::string const& tableName);

    virtual void executeSql(std::string const& sqlStatement);

    virtual void setTableForInsert(std::string const& tableName);
    template <typename T>
    void setColumn(std::string const& columnName, T const& value);
    virtual void setColumnToNull(std::string const& columnName);
    virtual void insertRow(void);

    virtual void setTableForQuery(std::string const& tableName, bool isExpr);
    virtual void setTableListForQuery(
        std::vector<std::string> const& tableNameList);
    virtual void outColumn(std::string const& columnName, bool isExpr);
    template <typename T> void outParam(std::string const& columnName,
                                        T* location, bool isExpr);
    template <typename T> void condParam(std::string const& paramName,
                                         T const& value);
    virtual void orderBy(std::string const& expression);
    virtual void groupBy(std::string const& expression);
    virtual void setQueryWhere(std::string const& whereClause);
    virtual void query(void);
    virtual bool next(void);
    template <typename T> T const& getColumnByPos(int pos);
    bool columnIsNull(int pos);
    virtual void finishQuery(void);

    // MySQL-specific functions for implementation.
    void executeQuery(std::string const& query);
    std::string quote(std::string const& name);
    void stError(std::string const& text);
    void error(std::string const& text, bool mysqlCaused = true);

    void* allocateMemory(size_t size);

    bool _readonly;
    std::string _location;
    MYSQL* _db;

    std::string _insertTable;
    std::vector<std::string> _queryTables;

    typedef std::tr1::unordered_map<std::string, BoundVar> BoundVarMap;
    BoundVarMap _inputVars;
    BoundVarMap _outputVars;
    std::vector< boost::shared_array<char> > _bindingMemory;

    // Parts of SQL statement.
    std::vector<std::string> _outColumns;
    std::string _whereClause;
    std::string _groupBy;
    std::string _orderBy;

    MYSQL_STMT* _statement;
    MYSQL_FIELD* _resultFields;
    int _numResultFields;
    boost::shared_array<unsigned long> _fieldLengths;
    boost::shared_array<my_bool> _fieldNulls;
};

template <>
void DbStorageImpl::setColumn<std::string>(std::string const& columnName,
                                           std::string const& value);
template <>
void DbStorageImpl::setColumn<dafBase::DateTime>(std::string const& columnName,
                                           dafBase::DateTime const& value);

template <>
void DbStorageImpl::outParam<std::string>(std::string const& columnName,
                                          std::string* location, bool isExpr);
template <>
void DbStorageImpl::outParam<dafBase::DateTime>(std::string const& columnName,
                                                dafBase::DateTime* location,
                                                bool isExpr);

template <>
std::string const& DbStorageImpl::getColumnByPos<std::string>(int pos);
template <>
dafBase::DateTime const&
DbStorageImpl::getColumnByPos<dafBase::DateTime>(int pos);

}}} // namespace lsst::daf::persistence

#endif