databaseClientInterface.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_CLIENT_INTERFACE_HPP_INCLUDED
#define _STRUS_DATABASE_CLIENT_INTERFACE_HPP_INCLUDED
#include <string>

namespace strus
{

class DatabaseTransactionInterface;
class DatabaseCursorInterface;
class DatabaseBackupCursorInterface;
class DatabaseOptions;

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

        virtual DatabaseTransactionInterface* createTransaction()=0;

        virtual DatabaseCursorInterface* createCursor( const DatabaseOptions& options) const=0;

        virtual DatabaseBackupCursorInterface* createBackupCursor() const=0;

        virtual void writeImm(
                        const char* key,
                        std::size_t keysize,
                        const char* value,
                        std::size_t valuesize)=0;

        virtual void removeImm(
                        const char* key,
                        std::size_t keysize)=0;

        virtual bool readValue(
                        const char* key,
                        std::size_t keysize,
                        std::string& value,
                        const DatabaseOptions& options) const=0;

        virtual std::string config() const=0;

        virtual bool compactDatabase()=0;

        virtual void close()=0;
};

}//namespace
#endif