minix/external/bsd/kyua-cli/dist/store/backend.hpp

98 lines
2.7 KiB
C++
Raw Normal View History

// Copyright 2011 Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// * Neither the name of Google Inc. nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
/// \file store/backend.hpp
/// Interface to the backend database.
#if !defined(STORE_BACKEND_HPP)
#define STORE_BACKEND_HPP
#include "utils/shared_ptr.hpp"
namespace utils {
namespace fs {
class path;
} // namespace fs
namespace sqlite {
class database;
} // namespace sqlite
} // namespace utils
namespace store {
class metadata;
namespace detail {
extern int current_schema_version;
utils::fs::path migration_file(const int, const int);
utils::fs::path schema_file(void);
metadata initialize(utils::sqlite::database&);
void backup_database(const utils::fs::path&, const int);
} // anonymous namespace
class transaction;
/// Public interface to the database store.
class backend {
struct impl;
/// Pointer to the shared internal implementation.
std::shared_ptr< impl > _pimpl;
friend class metadata;
backend(impl*);
public:
~backend(void);
static backend open_ro(const utils::fs::path&);
static backend open_rw(const utils::fs::path&);
utils::sqlite::database& database(void);
transaction start(void);
};
void migrate_schema(const utils::fs::path&);
} // namespace store
#endif // !defined(STORE_BACKEND_HPP)