databaseInterface.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2014 Patrick P. Frey
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
#ifndef _STRUS_DATABASE_INTERFACE_HPP_INCLUDED
#define _STRUS_DATABASE_INTERFACE_HPP_INCLUDED
#include <string>

namespace strus {

class DatabaseClientInterface;
class DatabaseBackupCursorInterface;

class DatabaseInterface
{
public:
        virtual ~DatabaseInterface(){}

        virtual bool exists( const std::string& configsource) const=0;

        virtual DatabaseClientInterface* createClient( const std::string& configsource) const=0;

        virtual bool createDatabase( const std::string& configsource) const=0;

        virtual bool restoreDatabase( const std::string& configsource, DatabaseBackupCursorInterface* backup) const=0;

        virtual bool destroyDatabase( const std::string& configsource) const=0;

        enum ConfigType
        {
                CmdCreateClient,                
                CmdCreate,                      
                CmdDestroy                      
        };

        virtual const char* getConfigDescription( const ConfigType& type) const=0;

        virtual const char** getConfigParameters( const ConfigType& type) const=0;
};

}//namespace
#endif