11 #ifndef PQXX_H_LARGEOBJECT 12 #define PQXX_H_LARGEOBJECT 14 #if !defined(PQXX_HEADER_PRE) 15 # error "Include libpqxx headers as <pqxx/header>, not <pqxx/header.hxx>." 20 #include "pqxx/dbtransaction.hxx" 40 [[deprecated(
"Use blob instead.")]]
largeobject() noexcept = default;
77 [[nodiscard]] oid
id() const noexcept {
return m_id; }
91 return m_id == other.m_id;
97 return m_id != other.m_id;
103 return m_id <= other.m_id;
109 return m_id >= other.m_id;
115 return m_id < other.m_id;
121 return m_id > other.m_id;
140 PQXX_PURE
static internal::pq::PGconn *
143 PQXX_PRIVATE std::string reason(
connection const &,
int err)
const;
171 static constexpr
auto default_mode{
172 std::ios::in | std::ios::out | std::ios::binary};
245 void write(
char const buf[], std::size_t len);
251 void write(std::string_view buf) {
write(std::data(buf), std::size(buf)); }
260 size_type read(
char buf[], std::size_t len);
305 off_type cwrite(
char const buf[], std::size_t len) noexcept;
314 off_type cread(
char buf[], std::size_t len) noexcept;
321 [[nodiscard]]
pos_type ctell()
const noexcept;
328 void process_notice(
zview) noexcept;
334 using largeobject::operator==;
335 using largeobject::operator!=;
336 using largeobject::operator<;
337 using largeobject::operator<=;
338 using largeobject::operator>;
339 using largeobject::operator>=;
346 PQXX_PRIVATE std::string reason(
int err)
const;
347 internal::pq::PGconn *raw_connection()
const 352 PQXX_PRIVATE
void open(
openmode mode);
353 void close() noexcept;
372 template<
typename CHAR =
char,
typename TRAITS = std::
char_traits<CHAR>>
387 static constexpr
auto default_mode{
388 std::ios::in | std::ios::out | std::ios::binary};
392 size_type buf_size = 512) :
393 m_bufsize{buf_size}, m_obj{t, o, mode}, m_g{
nullptr}, m_p{
nullptr}
400 size_type buf_size = 512) :
401 m_bufsize{buf_size}, m_obj{t, o, mode}, m_g{
nullptr}, m_p{
nullptr}
419 this->setg(this->eback(), this->eback(), this->egptr());
420 return overflow(eof());
432 return adjust_eof(newpos);
437 auto *
const pp{this->pptr()};
440 auto *
const pb{this->pbase()};
445 auto const write_sz{pp - pb};
446 auto const written_sz{
447 m_obj.cwrite(pb, static_cast<std::size_t>(pp - pb))};
450 "pqxx::largeobject: write failed " 451 "(is transaction still valid on write or flush?), " 452 "libpq reports error"};
453 else if (write_sz != written_sz)
455 "pqxx::largeobject: write failed " 456 "(is transaction still valid on write or flush?), " +
459 auto const out{adjust_eof(written_sz)};
461 if constexpr (std::is_arithmetic_v<decltype(out)>)
466 this->setp(m_p, m_p + m_bufsize);
471 *this->pptr() =
static_cast<char_type>(ch);
481 if (this->gptr() ==
nullptr)
483 auto *
const eb{this->eback()};
484 auto const res{adjust_eof(
485 m_obj.cread(this->eback(),
static_cast<std::size_t
>(m_bufsize)))};
487 eb, eb, eb + (res == eof() ? 0 : static_cast<std::size_t>(res)));
488 return (res == eof() or res == 0) ? eof() : traits_type::to_int_type(*eb);
493 static int_type eof() {
return traits_type::eof(); }
496 template<
typename INTYPE>
static std::streampos adjust_eof(INTYPE pos)
498 bool const at_eof{pos == -1};
499 if constexpr (std::is_arithmetic_v<std::streampos>)
502 (at_eof ? eof() : pos),
"large object seek"sv);
506 return std::streampos(at_eof ? eof() : pos);
512 if ((mode & std::ios::in) != 0)
514 m_g =
new char_type[unsigned(m_bufsize)];
515 this->setg(m_g, m_g, m_g);
517 if ((mode & std::ios::out) != 0)
519 m_p =
new char_type[unsigned(m_bufsize)];
520 this->setp(m_p, m_p + m_bufsize);
524 size_type
const m_bufsize;
542 template<
typename CHAR =
char,
typename TRAITS = std::
char_traits<CHAR>>
545 using super = std::basic_istream<CHAR, TRAITS>;
563 m_buf{t, o, std::ios::in | std::ios::binary, buf_size}
577 m_buf{t, o, std::ios::in | std::ios::binary, buf_size}
598 template<
typename CHAR =
char,
typename TRAITS = std::
char_traits<CHAR>>
601 using super = std::basic_ostream<CHAR, TRAITS>;
619 m_buf{t, o, std::ios::out | std::ios::binary, buf_size}
633 m_buf{t, o, std::ios::out | std::ios::binary, buf_size}
645 catch (std::exception
const &e)
647 m_buf.process_notice(e.what());
668 template<
typename CHAR =
char,
typename TRAITS = std::
char_traits<CHAR>>
671 using super = std::basic_iostream<CHAR, TRAITS>;
690 t, o, std::ios::in | std::ios::out | std::ios::binary, buf_size}
705 t, o, std::ios::in | std::ios::out | std::ios::binary, buf_size}
717 catch (std::exception
const &e)
719 m_buf.process_notice(e.what());
basic_olostream(dbtransaction &t, largeobject o, largeobject::size_type buf_size=512)
Create a basic_olostream.
Definition: largeobject.hxx:616
virtual int_type underflow() override
Definition: largeobject.hxx:479
Abstract transaction base class: bracket transactions on the database.
Definition: dbtransaction.hxx:53
The home of all libpqxx classes, functions, templates, etc.
Definition: array.hxx:26
largeobjectaccess::seekdir seekdir
Definition: largeobject.hxx:384
std::ios::seekdir seekdir
Seek direction: beg, cur, end.
Definition: largeobject.hxx:175
typename traits_type::int_type int_type
Definition: largeobject.hxx:606
basic_ilostream(dbtransaction &t, oid o, largeobject::size_type buf_size=512)
Create a basic_ilostream.
Definition: largeobject.hxx:574
Connection to a database.
Definition: connection.hxx:185
largeobject_streambuf(dbtransaction &t, largeobject o, openmode mode=default_mode, size_type buf_size=512)
Definition: largeobject.hxx:390
virtual pos_type seekpos(pos_type pos, openmode) override
Definition: largeobject.hxx:428
largeobject_streambuf(dbtransaction &t, oid o, openmode mode=default_mode, size_type buf_size=512)
Definition: largeobject.hxx:398
~basic_lostream()
Definition: largeobject.hxx:710
typename traits_type::pos_type pos_type
Definition: largeobject.hxx:677
std::ios::openmode openmode
Open mode: in, out (can be combined using "bitwise or").
Definition: largeobject.hxx:168
Input stream that gets its data from a large object.
Definition: largeobject.hxx:543
void to_file(std::string_view file) const
Export large object's contents to a local file.
Definition: largeobject.hxx:228
void process_notice(zview const &s)
For use by large object stream classes.
Definition: largeobject.hxx:413
Identity of a large object.
Definition: largeobject.hxx:33
static PQXX_PURE internal::pq::PGconn * raw_connection(dbtransaction const &T)
Definition: largeobject.cxx:139
int64_t large_object_size_type
Number of bytes in a large object.
Definition: types.hxx:43
virtual pos_type seekoff(off_type offset, seekdir dir, openmode) override
Definition: largeobject.hxx:423
CHAR char_type
Definition: largeobject.hxx:604
virtual ~largeobject_streambuf() noexcept
Definition: largeobject.hxx:406
virtual int sync() override
Definition: largeobject.hxx:416
Stream that reads and writes a large object.
Definition: largeobject.hxx:669
typename traits_type::off_type off_type
Definition: largeobject.hxx:552
Streambuf to use large objects in standard I/O streams.
Definition: largeobject.hxx:373
typename traits_type::off_type off_type
Definition: largeobject.hxx:608
constexpr bool cmp_less_equal(LEFT lhs, RIGHT rhs) noexcept
C++20 std::cmp_less_equal, or workaround if not available.
Definition: util.hxx:92
constexpr oid oid_none
The "null" oid.
Definition: util.hxx:335
size_type off_type
Definition: largeobject.hxx:157
TRAITS traits_type
Definition: largeobject.hxx:379
basic_olostream(dbtransaction &t, oid o, largeobject::size_type buf_size=512)
Create a basic_olostream.
Definition: largeobject.hxx:630
virtual int_type overflow()
Definition: largeobject.hxx:477
void to_file(dbtransaction &t, std::string_view file) const
Export large object's contents to a local file.
Definition: largeobject.cxx:107
~basic_olostream()
Definition: largeobject.hxx:638
bool operator!=(largeobject const &other) const
Compare object identities.
Definition: largeobject.hxx:95
void remove(dbtransaction &t) const
Delete large object from database.
Definition: largeobject.cxx:123
CHAR char_type
Definition: largeobject.hxx:548
basic_ilostream(dbtransaction &t, largeobject o, largeobject::size_type buf_size=512)
Create a basic_ilostream.
Definition: largeobject.hxx:560
large_object_size_type size_type
Definition: largeobject.hxx:36
typename traits_type::pos_type pos_type
Definition: largeobject.hxx:551
largeobjectaccess::openmode openmode
Definition: largeobject.hxx:383
bool operator==(largeobject const &other) const
Compare object identities.
Definition: largeobject.hxx:89
size_type pos_type
Definition: largeobject.hxx:158
bool operator>=(largeobject const &other) const
Compare object identities.
Definition: largeobject.hxx:107
typename traits_type::pos_type pos_type
Definition: largeobject.hxx:607
typename traits_type::pos_type pos_type
Definition: largeobject.hxx:381
bool operator<(largeobject const &other) const
Compare object identities.
Definition: largeobject.hxx:113
TRAITS traits_type
Definition: largeobject.hxx:605
Marker-type wrapper: zero-terminated std::string_view.
Definition: zview.hxx:37
TRAITS traits_type
Definition: largeobject.hxx:675
TO check_cast(FROM value, std::string_view description)
Cast a numeric value to another type, or throw if it underflows/overflows.
Definition: util.hxx:145
typename traits_type::off_type off_type
Definition: largeobject.hxx:678
typename traits_type::int_type int_type
Definition: largeobject.hxx:550
TRAITS traits_type
Definition: largeobject.hxx:549
oid id() const noexcept
Object identifier.
Definition: largeobject.hxx:77
virtual int_type overflow(int_type ch) override
Definition: largeobject.hxx:435
CHAR char_type
Definition: largeobject.hxx:674
basic_lostream(dbtransaction &t, oid o, largeobject::size_type buf_size=512)
Create a basic_lostream.
Definition: largeobject.hxx:701
basic_lostream(dbtransaction &t, largeobject o, largeobject::size_type buf_size=512)
Create a basic_lostream.
Definition: largeobject.hxx:686
bool operator>(largeobject const &other) const
Compare object identities.
Definition: largeobject.hxx:119
bool operator<=(largeobject const &other) const
Compare object identities.
Definition: largeobject.hxx:101
typename traits_type::off_type off_type
Definition: largeobject.hxx:382
Output stream that writes data back to a large object.
Definition: largeobject.hxx:599
typename traits_type::int_type int_type
Definition: largeobject.hxx:676
Internal error in libpqxx library.
Definition: except.hxx:166
Accessor for large object's contents.
Definition: largeobject.hxx:153
CHAR char_type
Definition: largeobject.hxx:378
std::string to_string(TYPE const &value)
Convert a value to a readable string that PostgreSQL will understand.
typename traits_type::int_type int_type
Definition: largeobject.hxx:380
~largeobjectaccess() noexcept
Definition: largeobject.hxx:216
void write(std::string_view buf)
Write string to large object.
Definition: largeobject.hxx:251