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;
61 [[deprecated(
"Use blob instead.")]] largeobject(
62 dbtransaction &t, std::string_view file);
69 [[deprecated(
"Use blob instead.")]] largeobject(
70 largeobjectaccess
const &o) noexcept;
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);
266 size_type seek(size_type dest, seekdir dir);
272 [[nodiscard]] size_type tell()
const;
296 pos_type cseek(off_type dest, seekdir dir) noexcept;
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;
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;
355 dbtransaction &m_trans;
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};
390 #include "pqxx/internal/ignore-deprecated-pre.hxx"
393 size_type buf_size = 512) :
394 m_bufsize{buf_size}, m_obj{t, o, mode}, m_g{
nullptr}, m_p{
nullptr}
398 #include "pqxx/internal/ignore-deprecated-post.hxx"
402 size_type buf_size = 512) :
403 m_bufsize{buf_size}, m_obj{t, o, mode}, m_g{
nullptr}, m_p{
nullptr}
421 this->setg(this->eback(), this->eback(), this->egptr());
422 return overflow(eof());
434 return adjust_eof(newpos);
439 auto *
const pp{this->pptr()};
442 auto *
const pb{this->pbase()};
447 auto const write_sz{pp - pb};
448 auto const written_sz{
449 m_obj.cwrite(pb, static_cast<std::size_t>(pp - pb))};
452 "pqxx::largeobject: write failed "
453 "(is transaction still valid on write or flush?), "
454 "libpq reports error"};
455 else if (write_sz != written_sz)
457 "pqxx::largeobject: write failed "
458 "(is transaction still valid on write or flush?), " +
461 auto const out{adjust_eof(written_sz)};
463 if constexpr (std::is_arithmetic_v<decltype(out)>)
468 this->setp(m_p, m_p + m_bufsize);
473 *this->pptr() =
static_cast<char_type>(ch);
483 if (this->gptr() ==
nullptr)
485 auto *
const eb{this->eback()};
486 auto const res{adjust_eof(
487 m_obj.cread(this->eback(),
static_cast<std::size_t
>(m_bufsize)))};
489 eb, eb, eb + (res == eof() ? 0 : static_cast<std::size_t>(res)));
490 return (res == eof() or res == 0) ? eof() : traits_type::to_int_type(*eb);
495 static int_type eof() {
return traits_type::eof(); }
498 template<
typename INTYPE>
static std::streampos adjust_eof(INTYPE pos)
500 bool const at_eof{pos == -1};
501 if constexpr (std::is_arithmetic_v<std::streampos>)
504 (at_eof ? eof() : pos),
"large object seek"sv);
508 return std::streampos(at_eof ? eof() : pos);
514 if ((mode & std::ios::in) != 0)
516 m_g =
new char_type[unsigned(m_bufsize)];
517 this->setg(m_g, m_g, m_g);
519 if ((mode & std::ios::out) != 0)
521 m_p =
new char_type[unsigned(m_bufsize)];
522 this->setp(m_p, m_p + m_bufsize);
526 size_type
const m_bufsize;
544 template<
typename CHAR =
char,
typename TRAITS = std::
char_traits<CHAR>>
547 using super = std::basic_istream<CHAR, TRAITS>;
556 #include "pqxx/internal/ignore-deprecated-pre.hxx"
566 m_buf{t, o, std::ios::in | std::ios::binary, buf_size}
570 #include "pqxx/internal/ignore-deprecated-post.hxx"
581 m_buf{t, o, std::ios::in | std::ios::binary, buf_size}
587 largeobject_streambuf<CHAR, TRAITS> m_buf;
602 template<
typename CHAR =
char,
typename TRAITS = std::
char_traits<CHAR>>
605 using super = std::basic_ostream<CHAR, TRAITS>;
614 #include "pqxx/internal/ignore-deprecated-pre.hxx"
624 m_buf{t, o, std::ios::out | std::ios::binary, buf_size}
628 #include "pqxx/internal/ignore-deprecated-post.hxx"
639 m_buf{t, o, std::ios::out | std::ios::binary, buf_size}
651 catch (std::exception
const &e)
653 m_buf.process_notice(e.what());
674 template<
typename CHAR =
char,
typename TRAITS = std::
char_traits<CHAR>>
677 using super = std::basic_iostream<CHAR, TRAITS>;
696 t, o, std::ios::in | std::ios::out | std::ios::binary, buf_size}
711 t, o, std::ios::in | std::ios::out | std::ios::binary, buf_size}
723 catch (std::exception
const &e)
725 m_buf.process_notice(e.what());
~largeobjectaccess() noexcept
Definition: largeobject.hxx:216
void write(std::string_view buf)
Write string to large object.
Definition: largeobject.hxx:251
basic_ilostream(dbtransaction &t, largeobject o, largeobject::size_type buf_size=512)
Create a basic_ilostream.
Definition: largeobject.hxx:563
virtual int_type underflow() override
Definition: largeobject.hxx:481
Streambuf to use large objects in standard I/O streams.
Definition: largeobject.hxx:373
typename traits_type::pos_type pos_type
Definition: largeobject.hxx:683
bool operator>(largeobject const &other) const
Compare object identities.
Definition: largeobject.hxx:119
Output stream that writes data back to a large object.
Definition: largeobject.hxx:603
~basic_olostream()
Definition: largeobject.hxx:644
Abstract transaction base class: bracket transactions on the database.
Definition: dbtransaction.hxx:53
largeobject_streambuf(dbtransaction &t, largeobject o, openmode mode=default_mode, size_type buf_size=512)
Definition: largeobject.hxx:391
TRAITS traits_type
Definition: largeobject.hxx:609
constexpr oid oid_none
The "null" oid.
Definition: util.hxx:342
virtual int_type overflow()
Definition: largeobject.hxx:479
largeobjectaccess::openmode openmode
Definition: largeobject.hxx:383
Connection to a database.
Definition: connection.hxx:252
typename traits_type::int_type int_type
Definition: largeobject.hxx:380
TRAITS traits_type
Definition: largeobject.hxx:551
bool operator<(largeobject const &other) const
Compare object identities.
Definition: largeobject.hxx:113
TRAITS traits_type
Definition: largeobject.hxx:681
int64_t large_object_size_type
Number of bytes in a large object.
Definition: types.hxx:43
Identity of a large object.
Definition: largeobject.hxx:33
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(dbtransaction &t, largeobject o, largeobject::size_type buf_size=512)
Create a basic_olostream.
Definition: largeobject.hxx:621
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:151
std::ios::seekdir seekdir
Seek direction: beg, cur, end.
Definition: largeobject.hxx:175
typename traits_type::int_type int_type
Definition: largeobject.hxx:610
The home of all libpqxx classes, functions, templates, etc.
Definition: array.hxx:32
CHAR char_type
Definition: largeobject.hxx:378
virtual pos_type seekoff(off_type offset, seekdir dir, openmode) override
Definition: largeobject.hxx:425
basic_olostream(dbtransaction &t, oid o, largeobject::size_type buf_size=512)
End a code block started by "ignore-deprecated-pre.hxx".
Definition: largeobject.hxx:636
basic_lostream(dbtransaction &t, largeobject o, largeobject::size_type buf_size=512)
Create a basic_lostream.
Definition: largeobject.hxx:692
typename traits_type::off_type off_type
Definition: largeobject.hxx:684
CHAR char_type
Definition: largeobject.hxx:680
Internal error in libpqxx library.
Definition: except.hxx:241
Stream that reads and writes a large object.
Definition: largeobject.hxx:675
static PQXX_PURE internal::pq::PGconn * raw_connection(dbtransaction const &T)
Definition: largeobject.cxx:139
Marker-type wrapper: zero-terminated std::string_view.
Definition: zview.hxx:37
~basic_lostream()
Definition: largeobject.hxx:716
virtual int sync() override
Definition: largeobject.hxx:418
bool operator!=(largeobject const &other) const
Compare object identities.
Definition: largeobject.hxx:95
virtual pos_type seekpos(pos_type pos, openmode) override
Definition: largeobject.hxx:430
virtual int_type overflow(int_type ch) override
Definition: largeobject.hxx:437
basic_lostream(dbtransaction &t, oid o, largeobject::size_type buf_size=512)
Create a basic_lostream.
Definition: largeobject.hxx:707
void to_file(std::string_view file) const
Export large object's contents to a local file.
Definition: largeobject.hxx:228
size_type off_type
Definition: largeobject.hxx:157
CHAR char_type
Definition: largeobject.hxx:608
basic_ilostream(dbtransaction &t, oid o, largeobject::size_type buf_size=512)
End a code block started by "ignore-deprecated-pre.hxx".
Definition: largeobject.hxx:578
typename traits_type::int_type int_type
Definition: largeobject.hxx:682
typename traits_type::pos_type pos_type
Definition: largeobject.hxx:611
Input stream that gets its data from a large object.
Definition: largeobject.hxx:545
Accessor for large object's contents.
Definition: largeobject.hxx:153
typename traits_type::pos_type pos_type
Definition: largeobject.hxx:381
large_object_size_type size_type
Definition: largeobject.hxx:36
TRAITS traits_type
Definition: largeobject.hxx:379
typename traits_type::pos_type pos_type
Definition: largeobject.hxx:553
largeobjectaccess::seekdir seekdir
Definition: largeobject.hxx:384
bool operator==(largeobject const &other) const
Compare object identities.
Definition: largeobject.hxx:89
typename traits_type::off_type off_type
Definition: largeobject.hxx:382
bool operator<=(largeobject const &other) const
Compare object identities.
Definition: largeobject.hxx:101
CHAR char_type
Definition: largeobject.hxx:550
void process_notice(zview const &s)
For use by large object stream classes.
Definition: largeobject.hxx:415
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:552
largeobject_streambuf(dbtransaction &t, oid o, openmode mode=default_mode, size_type buf_size=512)
End a code block started by "ignore-deprecated-pre.hxx".
Definition: largeobject.hxx:400
constexpr bool cmp_less_equal(LEFT lhs, RIGHT rhs) noexcept
C++20 std::cmp_less_equal, or workaround if not available.
Definition: util.hxx:98
typename traits_type::off_type off_type
Definition: largeobject.hxx:554
size_type pos_type
Definition: largeobject.hxx:158
std::ios::openmode openmode
Open mode: in, out (can be combined using "bitwise or").
Definition: largeobject.hxx:168
bool operator>=(largeobject const &other) const
Compare object identities.
Definition: largeobject.hxx:107
typename traits_type::off_type off_type
Definition: largeobject.hxx:612
oid id() const noexcept
Object identifier.
Definition: largeobject.hxx:77
virtual ~largeobject_streambuf() noexcept
Definition: largeobject.hxx:408