DBUpdater.h

Go to the documentation of this file.

/*
 * This file is part of the TrinityCore Project. See AUTHORS file for Copyright information
 *
 * 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 2 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 GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef DBUpdater_h__
#define DBUpdater_h__
 
#include "Define.h"
#include "DatabaseEnvFwd.h"
#include <stdexcept>
#include <string>
 
template <class T>
class DatabaseWorkerPool;
 
namespace boost
{
    namespace filesystem
    {
        class path;
    }
}
 
class TC_DATABASE_API UpdateException : public std::runtime_error
{
public:
    using std::runtime_error::runtime_error;
};
 
enum BaseLocation
{
    LOCATION_REPOSITORY,
    LOCATION_DOWNLOAD
};
 
class DBUpdaterUtil
{
public:
    static std::string GetCorrectedMySQLExecutable();
 
    static bool CheckExecutable();
 
private:
    static std::string& corrected_path();
};
 
template <class T>
class TC_DATABASE_API DBUpdater
{
public:
    using Path = boost::filesystem::path;
 
    static inline std::string GetConfigEntry();
 
    static inline std::string GetTableName();
 
    static std::string GetBaseFile();
 
    static bool IsEnabled(uint32 const updateMask);
 
    static BaseLocation GetBaseLocationType();
 
    static bool Create(DatabaseWorkerPool<T>& pool);
 
    static bool Update(DatabaseWorkerPool<T>& pool);
 
    static bool Populate(DatabaseWorkerPool<T>& pool);
 
private:
    static QueryResult Retrieve(DatabaseWorkerPool<T>& pool, std::string const& query);
    static void Apply(DatabaseWorkerPool<T>& pool, std::string const& query);
    static void ApplyFile(DatabaseWorkerPool<T>& pool, Path const& path);
    static void ApplyFile(DatabaseWorkerPool<T>& pool, std::string const& host, std::string const& user,
        std::string const& password, std::string const& port_or_socket, std::string const& database, std::string const& ssl,
        Path const& path);
};
 
#endif // DBUpdater_h__