sqlpp11/database_api/api.h

/*
 * Copyright (c) 2013, Roland Bock
 * 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.
 * 
 * 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 HOLDER 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.
 */

#ifndef SQLPP_DATABASE_API_H
#define SQLPP_DATABASE_API_H

#include <string>
#include <sqlpp11/connection.h>
#include <sqlpp11/raw_result_row.h>

namespace sqlpp
{
	namespace connector_name
	{
		class result
		{
		public:
			result() = default;
			result(const result&) = delete;
			result(result&& rhs) = default;
			result& operator=(const result&) = delete;
			result& operator=(result&&) = default;
			~result() = default;

			bool operator==(const result& rhs) const;

			//! return the next row from the result or a "false" row, if there is no next row
			sqlpp::raw_result_row_t next();
			size_t num_cols() const;
		};

		class connection: public sqlpp::connection
		{
		public:
			// A bunch of flags telling sqlpp11 which feature is support and which isn't

			// join types
			static constexpr bool _supports_inner_join = true;
			static constexpr bool _supports_outer_join = true;
			static constexpr bool _supports_left_outer_join = true;
			static constexpr bool _supports_right_outer_join = true;

			// functions
			static constexpr bool _supports_avg = true;
			static constexpr bool _supports_count = true;
			static constexpr bool _supports_exists = true;
			static constexpr bool _supports_like = true;
			static constexpr bool _supports_in = true;
			static constexpr bool _supports_is_null = true;
			static constexpr bool _supports_is_not_null = true;
			static constexpr bool _supports_max = true;
			static constexpr bool _supports_min = true;
			static constexpr bool _supports_not_in = true;
			static constexpr bool _supports_sum = true;

			// select
			static constexpr bool _supports_group_by = true;
			static constexpr bool _supports_having = true;
			static constexpr bool _supports_limit = true;
			static constexpr bool _supports_order_by = true;
			static constexpr bool _supports_select_as_table = true;

			static constexpr bool _supports_some = true;
			static constexpr bool _supports_any = true;
			static constexpr bool _use_concat_operator = false;
			static constexpr bool _use_concat_function = true;

			connection(/*whatever arguments you need*/);
			connection(const connection&) = delete;
			connection(connection&&) = delete;
			connection& operator=(const connection&) = delete;
			connection& operator=(connection&&) = delete;
			~connection();

			//! select returns a result (which can be iterated row by row)
			result select(const std::string& query);

			//! insert returns the last auto_incremented id (or zero, if there is none)
			size_t insert(const std::string& query);

			//! update returns the number of affected rows
			size_t update(const std::string& query);

			//! remove returns the number of removed rows
			size_t remove(const std::string& query);

			//! execute arbitrary command (e.g. create a table)
			void execute(const std::string& command);

			//! escape given string
			std::string escape(const std::string& s) const;

			//! call run on the argument
			template<typename T>
				auto run(const T& t) -> decltype(t.run(*this))
				{
					return t.run(*this);
				}

			//! start transaction
			void start_transaction();

			//! commit transaction (or throw transaction if the transaction has been finished already)
			void commit_transaction();

			//! rollback transaction with or without reporting the rollback (or throw if the transaction has been finished already)
			void rollback_transaction(bool report);

			//! report a rollback failure (will be called by transactions in case of a rollback failure in the destructor)
			void report_rollback_failure(const std::string message) noexcept;
		};
	}
}
#endif