File: //usr/include/pqxx/tablewriter.hxx
/*-------------------------------------------------------------------------
*
* FILE
* pqxx/tablewriter.hxx
*
* DESCRIPTION
* definition of the pqxx::tablewriter class.
* pqxx::tablewriter enables optimized batch updates to a database table
* DO NOT INCLUDE THIS FILE DIRECTLY; include pqxx/tablewriter.hxx instead.
*
* Copyright (c) 2001-2016, Jeroen T. Vermeulen <jtv@xs4all.nl>
*
* See COPYING for copyright license. If you did not receive a file called
* COPYING with this source code, please notify the distributor of this mistake,
* or contact the author.
*
*-------------------------------------------------------------------------
*/
#ifndef PQXX_H_TABLEWRITER
#define PQXX_H_TABLEWRITER
#include <iterator>
#include "pqxx/compiler-public.hxx"
#include "pqxx/compiler-internal-pre.hxx"
#include "pqxx/tablestream"
namespace pqxx
{
class tablereader;
/// @deprecated Efficiently write data directly to a database table.
/** @warning This class does not work reliably with multibyte encodings. Using
* it with some multi-byte encodings may pose a security risk.
*/
class PQXX_LIBEXPORT tablewriter : public tablestream
{
public:
typedef unsigned size_type;
tablewriter(transaction_base &,
const std::string &WName,
const std::string &Null=std::string());
template<typename ITER> tablewriter(transaction_base &,
const std::string &WName,
ITER begincolumns,
ITER endcolumns);
template<typename ITER> tablewriter(transaction_base &T,
const std::string &WName,
ITER begincolumns,
ITER endcolumns,
const std::string &Null);
~tablewriter() PQXX_NOEXCEPT;
template<typename IT> void insert(IT Begin, IT End);
template<typename TUPLE> void insert(const TUPLE &);
template<typename IT> void push_back(IT Begin, IT End);
template<typename TUPLE> void push_back(const TUPLE &);
void reserve(size_type) {}
template<typename TUPLE> tablewriter &operator<<(const TUPLE &);
tablewriter &operator<<(tablereader &);
template<typename IT> std::string generate(IT Begin, IT End) const;
template<typename TUPLE> std::string generate(const TUPLE &) const;
virtual void complete() PQXX_OVERRIDE;
void write_raw_line(const std::string &);
private:
void setup(transaction_base &,
const std::string &WName,
const std::string &Columns = std::string());
PQXX_PRIVATE void writer_close();
};
} // namespace pqxx
namespace std
{
template<>
class back_insert_iterator<pqxx::tablewriter> :
public iterator<output_iterator_tag, void,void,void,void>
{
public:
explicit back_insert_iterator(pqxx::tablewriter &W) PQXX_NOEXCEPT :
m_Writer(&W) {}
back_insert_iterator &
operator=(const back_insert_iterator &rhs) PQXX_NOEXCEPT
{
m_Writer = rhs.m_Writer;
return *this;
}
template<typename TUPLE>
back_insert_iterator &operator=(const TUPLE &T)
{
m_Writer->insert(T);
return *this;
}
back_insert_iterator &operator++() { return *this; }
back_insert_iterator &operator++(int) { return *this; }
back_insert_iterator &operator*() { return *this; }
private:
pqxx::tablewriter *m_Writer;
};
} // namespace std
namespace pqxx
{
template<typename ITER> inline tablewriter::tablewriter(transaction_base &T,
const std::string &WName,
ITER begincolumns,
ITER endcolumns) :
namedclass("tablewriter", WName),
tablestream(T, std::string())
{
setup(T, WName, columnlist(begincolumns, endcolumns));
}
template<typename ITER> inline tablewriter::tablewriter(transaction_base &T,
const std::string &WName,
ITER begincolumns,
ITER endcolumns,
const std::string &Null) :
namedclass("tablewriter", WName),
tablestream(T, Null)
{
setup(T, WName, columnlist(begincolumns, endcolumns));
}
namespace internal
{
PQXX_LIBEXPORT std::string Escape(
const std::string &s,
const std::string &null);
inline std::string EscapeAny(
const std::string &s,
const std::string &null)
{ return Escape(s, null); }
inline std::string EscapeAny(
const char s[],
const std::string &null)
{ return s ? Escape(std::string(s), null) : "\\N"; }
template<typename T> inline std::string EscapeAny(
const T &t,
const std::string &null)
{ return Escape(to_string(t), null); }
template<typename IT> class Escaper
{
const std::string &m_null;
public:
explicit Escaper(const std::string &null) : m_null(null) {}
std::string operator()(IT i) const { return EscapeAny(*i, m_null); }
};
}
template<typename IT>
inline std::string tablewriter::generate(IT Begin, IT End) const
{
return separated_list("\t", Begin, End, internal::Escaper<IT>(NullStr()));
}
template<typename TUPLE>
inline std::string tablewriter::generate(const TUPLE &T) const
{
return generate(T.begin(), T.end());
}
template<typename IT> inline void tablewriter::insert(IT Begin, IT End)
{
write_raw_line(generate(Begin, End));
}
template<typename TUPLE> inline void tablewriter::insert(const TUPLE &T)
{
insert(T.begin(), T.end());
}
template<typename IT>
inline void tablewriter::push_back(IT Begin, IT End)
{
insert(Begin, End);
}
template<typename TUPLE>
inline void tablewriter::push_back(const TUPLE &T)
{
insert(T.begin(), T.end());
}
template<typename TUPLE>
inline tablewriter &tablewriter::operator<<(const TUPLE &T)
{
insert(T);
return *this;
}
} // namespace pqxx
#include "pqxx/compiler-internal-post.hxx"
#endif