stream_query_impl.hxx

Go to the documentation of this file.

/* Code for parts of pqxx::internal::stream_query.
 *
 * These definitions needs to be in a separate file in order to iron out
 * circular dependencies between headers.
 */
#if !defined(PQXX_H_STREAM_QUERY_IMPL)
#  define PQXX_H_STREAM_QUERY_IMPL
 
namespace pqxx::internal
{
template<typename... TYPE>
inline stream_query<TYPE...>::stream_query(
  transaction_base &tx, std::string_view query) :
        transaction_focus{tx, "stream_query"}, m_char_finder{get_finder(tx)}
{
  auto const r{tx.exec(internal::concat("COPY (", query, ") TO STDOUT"))};
  r.expect_columns(sizeof...(TYPE));
  r.expect_rows(0);
  register_me();
}
 
 
template<typename... TYPE>
inline char_finder_func *
stream_query<TYPE...>::get_finder(transaction_base const &tx)
{
  auto const group{enc_group(tx.conn().encoding_id())};
  return get_s_char_finder<'\t', '\\'>(group);
}
 
 
// C++20: Replace with generator?  Could be faster (local vars vs. members).

template<typename... TYPE> class stream_query_input_iterator
{
  using stream_t = stream_query<TYPE...>;
 
public:
  using value_type = std::tuple<TYPE...>;
  using difference_type = long;
 
  explicit stream_query_input_iterator(stream_t &home) :
          m_home(&home),
          m_line{typename stream_query<TYPE...>::line_handle(
            nullptr, pqxx::internal::pq::pqfreemem)}
  {
    consume_line();
  }
  stream_query_input_iterator(stream_query_input_iterator const &) = default;
  stream_query_input_iterator(stream_query_input_iterator &&) = default;

  stream_query_input_iterator &operator++() &
  {
    assert(not done());
    consume_line();
    return *this;
  }


  stream_query_input_iterator operator++(int)
  {
    ++*this;
    return {};
  }

  value_type operator*() const
  {
    return m_home->parse_line(zview{m_line.get(), m_line_size});
  }

  bool operator==(stream_query_end_iterator) const noexcept { return done(); }
  bool operator!=(stream_query_end_iterator) const noexcept
  {
    return not done();
  }
 
  stream_query_input_iterator &
  operator=(stream_query_input_iterator &&rhs) noexcept
  {
    if (&rhs != this)
    {
      m_line = std::move(rhs.m_line);
      m_home = rhs.m_home;
      m_line_size = rhs.m_line_size;
    }
    return *this;
  }
 
private:
  stream_query_input_iterator() {}

  bool done() const noexcept { return m_home->done(); }


  void consume_line() &
  {
    auto [line, size]{m_home->read_line()};
    m_line = std::move(line);
    m_line_size = size;
    if (m_line)
    {
      // We know how many fields to expect.  Replace the newline at the end
      // with the field separator, so the parsing loop only needs to scan for a
      // tab, not a tab or a newline.
      char *const ptr{m_line.get()};
      assert(ptr[size] == '\n');
      ptr[size] = '\t';
    }
  }
 
  stream_t *m_home;

  typename stream_t::line_handle m_line;

  std::size_t m_line_size;
};
 
 
template<typename... TYPE>
inline bool operator==(
  stream_query_end_iterator, stream_query_input_iterator<TYPE...> const &i)
{
  return i.done();
}
 
 
template<typename... TYPE>
inline bool operator!=(
  stream_query_end_iterator, stream_query_input_iterator<TYPE...> const &i)
{
  return not i.done();
}
 
 
template<typename... TYPE> inline auto stream_query<TYPE...>::begin() &
{
  return stream_query_input_iterator<TYPE...>{*this};
}
 
 
template<typename... TYPE>
inline std::pair<typename stream_query<TYPE...>::line_handle, std::size_t>
stream_query<TYPE...>::read_line() &
{
  assert(not done());
 
  internal::gate::connection_stream_from gate{m_trans->conn()};
  try
  {
    auto line{gate.read_copy_line()};
    // Check for completion.
    if (not line.first)
      PQXX_UNLIKELY close();
    return line;
  }
  catch (std::exception const &)
  {
    close();
    throw;
  }
}
} // namespace pqxx::internal
#endif