tablewriter.hxx 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
  1. /** Definition of the pqxx::tablewriter class.
  2. *
  3. * pqxx::tablewriter enables optimized batch updates to a database table.
  4. *
  5. * DO NOT INCLUDE THIS FILE DIRECTLY; include pqxx/tablewriter.hxx instead.
  6. *
  7. * Copyright (c) 2000-2019, Jeroen T. Vermeulen.
  8. *
  9. * See COPYING for copyright license. If you did not receive a file called
  10. * COPYING with this source code, please notify the distributor of this mistake,
  11. * or contact the author.
  12. */
  13. #ifndef PQXX_H_TABLEWRITER
  14. #define PQXX_H_TABLEWRITER
  15. #include <iterator>
  16. #include "pqxx/compiler-public.hxx"
  17. #include "pqxx/compiler-internal-pre.hxx"
  18. #include "pqxx/tablestream.hxx"
  19. namespace pqxx
  20. {
  21. /// @deprecated Use stream_to instead.
  22. /** Efficiently write data directly to a database table.
  23. * @warning This class does not work reliably with multibyte encodings. Using
  24. * it with some multi-byte encodings may pose a security risk.
  25. */
  26. class PQXX_LIBEXPORT tablewriter : public tablestream
  27. {
  28. public:
  29. PQXX_DEPRECATED tablewriter(
  30. transaction_base &,
  31. const std::string &WName,
  32. const std::string &Null=std::string{});
  33. template<typename ITER>
  34. PQXX_DEPRECATED tablewriter(
  35. transaction_base &,
  36. const std::string &WName,
  37. ITER begincolumns,
  38. ITER endcolumns);
  39. template<typename ITER>
  40. PQXX_DEPRECATED tablewriter(
  41. transaction_base &T,
  42. const std::string &WName,
  43. ITER begincolumns,
  44. ITER endcolumns,
  45. const std::string &Null);
  46. ~tablewriter() noexcept;
  47. template<typename IT> void insert(IT Begin, IT End);
  48. template<typename TUPLE> void insert(const TUPLE &);
  49. template<typename IT> void push_back(IT Begin, IT End);
  50. template<typename TUPLE> void push_back(const TUPLE &);
  51. template<typename SIZE> void reserve(SIZE) {}
  52. template<typename TUPLE> tablewriter &operator<<(const TUPLE &);
  53. tablewriter &operator<<(tablereader &);
  54. template<typename IT> std::string generate(IT Begin, IT End) const;
  55. template<typename TUPLE> std::string generate(const TUPLE &) const;
  56. virtual void complete() override;
  57. void write_raw_line(const std::string &);
  58. private:
  59. void set_up(
  60. transaction_base &,
  61. const std::string &WName,
  62. const std::string &Columns = std::string{});
  63. PQXX_PRIVATE void writer_close();
  64. };
  65. } // namespace pqxx
  66. namespace std
  67. {
  68. template<>
  69. class back_insert_iterator<pqxx::tablewriter>
  70. {
  71. public:
  72. using iterator_category = output_iterator_tag;
  73. explicit back_insert_iterator(pqxx::tablewriter &W) noexcept :
  74. m_writer{&W} {}
  75. back_insert_iterator &
  76. operator=(const back_insert_iterator &rhs) noexcept
  77. {
  78. m_writer = rhs.m_writer;
  79. return *this;
  80. }
  81. template<typename TUPLE>
  82. back_insert_iterator &operator=(const TUPLE &T)
  83. {
  84. m_writer->insert(T);
  85. return *this;
  86. }
  87. back_insert_iterator &operator++() { return *this; }
  88. back_insert_iterator &operator++(int) { return *this; }
  89. back_insert_iterator &operator*() { return *this; }
  90. private:
  91. pqxx::tablewriter *m_writer;
  92. };
  93. } // namespace std
  94. namespace pqxx
  95. {
  96. template<typename ITER> inline tablewriter::tablewriter(
  97. transaction_base &T,
  98. const std::string &WName,
  99. ITER begincolumns,
  100. ITER endcolumns) :
  101. namedclass{"tablewriter", WName},
  102. tablestream{T, std::string{}}
  103. {
  104. set_up(T, WName, columnlist(begincolumns, endcolumns));
  105. }
  106. template<typename ITER> inline tablewriter::tablewriter(
  107. transaction_base &T,
  108. const std::string &WName,
  109. ITER begincolumns,
  110. ITER endcolumns,
  111. const std::string &Null) :
  112. namedclass{"tablewriter", WName},
  113. tablestream{T, Null}
  114. {
  115. set_up(T, WName, columnlist(begincolumns, endcolumns));
  116. }
  117. namespace internal
  118. {
  119. PQXX_LIBEXPORT std::string escape(
  120. const std::string &s,
  121. const std::string &null);
  122. inline std::string escape_any(
  123. const std::string &s,
  124. const std::string &null)
  125. { return escape(s, null); }
  126. inline std::string escape_any(
  127. const char s[],
  128. const std::string &null)
  129. { return s ? escape(std::string{s}, null) : "\\N"; }
  130. template<typename T> inline std::string escape_any(
  131. const T &t,
  132. const std::string &null)
  133. { return escape(to_string(t), null); }
  134. template<typename IT> class Escaper
  135. {
  136. const std::string &m_null;
  137. public:
  138. explicit Escaper(const std::string &null) : m_null{null} {}
  139. std::string operator()(IT i) const { return escape_any(*i, m_null); }
  140. };
  141. }
  142. template<typename IT>
  143. inline std::string tablewriter::generate(IT Begin, IT End) const
  144. {
  145. return separated_list("\t", Begin, End, internal::Escaper<IT>{NullStr()});
  146. }
  147. template<typename TUPLE>
  148. inline std::string tablewriter::generate(const TUPLE &T) const
  149. {
  150. return generate(std::begin(T), std::end(T));
  151. }
  152. template<typename IT> inline void tablewriter::insert(IT Begin, IT End)
  153. {
  154. write_raw_line(generate(Begin, End));
  155. }
  156. template<typename TUPLE> inline void tablewriter::insert(const TUPLE &T)
  157. {
  158. insert(std::begin(T), std::end(T));
  159. }
  160. template<typename IT>
  161. inline void tablewriter::push_back(IT Begin, IT End)
  162. {
  163. insert(Begin, End);
  164. }
  165. template<typename TUPLE>
  166. inline void tablewriter::push_back(const TUPLE &T)
  167. {
  168. insert(std::begin(T), std::end(T));
  169. }
  170. template<typename TUPLE>
  171. inline tablewriter &tablewriter::operator<<(const TUPLE &T)
  172. {
  173. insert(T);
  174. return *this;
  175. }
  176. } // namespace pqxx
  177. #include "pqxx/compiler-internal-post.hxx"
  178. #endif