13 #ifndef PQXX_H_LARGEOBJECT 14 #define PQXX_H_LARGEOBJECT 16 #include "pqxx/compiler-public.hxx" 17 #include "pqxx/internal/compiler-internal-pre.hxx" 21 #include "pqxx/dbtransaction.hxx" 60 largeobject(dbtransaction &t, std::string_view file);
67 largeobject(largeobjectaccess
const &o) noexcept;
74 [[nodiscard]] oid
id() const noexcept {
return m_id; }
88 return m_id == other.m_id;
94 return m_id != other.m_id;
100 return m_id <= other.m_id;
106 return m_id >= other.m_id;
112 return m_id < other.m_id;
118 return m_id > other.m_id;
137 PQXX_PURE
static internal::pq::PGconn *
140 PQXX_PRIVATE std::string reason(
connection const &,
int err)
const;
166 static constexpr
auto default_mode{
167 std::ios::in | std::ios::out | std::ios::binary};
238 void write(
char const buf[], std::size_t len);
244 void write(std::string_view buf) {
write(buf.data(), std::size(buf)); }
253 size_type read(
char buf[], std::size_t len);
259 size_type seek(size_type dest, seekdir dir);
265 [[nodiscard]] size_type tell()
const;
289 pos_type cseek(off_type dest, seekdir dir) noexcept;
298 off_type cwrite(
char const buf[], std::size_t len) noexcept;
307 off_type cread(
char buf[], std::size_t len) noexcept;
314 [[nodiscard]] pos_type ctell() const noexcept;
321 void process_notice(
std::
string const &) noexcept;
339 PQXX_PRIVATE
std::
string reason(
int err) const;
340 internal::pq::PGconn *raw_connection()
const 345 PQXX_PRIVATE
void open(openmode mode);
346 void close() noexcept;
348 dbtransaction &m_trans;
362 template<typename CHAR =
char, typename TRAITS =
std::char_traits<CHAR>>
377 static constexpr
auto default_mode{
378 std::ios::in | std::ios::out | std::ios::binary};
382 size_type buf_size = 512) :
383 m_bufsize{buf_size}, m_obj{t, o, mode}, m_g{
nullptr}, m_p{
nullptr}
390 size_type buf_size = 512) :
391 m_bufsize{buf_size}, m_obj{t, o, mode}, m_g{
nullptr}, m_p{
nullptr}
409 this->setg(this->eback(), this->eback(), this->egptr());
410 return overflow(eof());
422 return adjust_eof(newpos);
427 auto *
const pp{this->pptr()};
430 auto *
const pb{this->pbase()};
436 adjust_eof(m_obj.cwrite(pb, static_cast<std::size_t>(pp - pb)))};
437 if constexpr (std::is_arithmetic_v<decltype(out)>)
442 this->setp(m_p, m_p + m_bufsize);
447 *this->pptr() =
static_cast<char_type>(ch);
457 if (this->gptr() ==
nullptr)
459 auto *
const eb{this->eback()};
460 auto const res{adjust_eof(
461 m_obj.cread(this->eback(),
static_cast<std::size_t
>(m_bufsize)))};
463 eb, eb, eb + (res == eof() ? 0 : static_cast<std::size_t>(res)));
464 return (res == eof() or res == 0) ? eof() : traits_type::to_int_type(*eb);
469 static int_type eof() {
return traits_type::eof(); }
472 template<
typename INTYPE>
static std::streampos adjust_eof(INTYPE pos)
474 bool const at_eof{pos == -1};
475 if constexpr (std::is_arithmetic_v<std::streampos>)
478 (at_eof ? eof() : pos),
"large object seek");
482 return std::streampos(at_eof ? eof() : pos);
486 void initialize(openmode mode)
488 if ((mode & std::ios::in) != 0)
490 m_g =
new char_type[unsigned(m_bufsize)];
491 this->setg(m_g, m_g, m_g);
493 if ((mode & std::ios::out) != 0)
495 m_p =
new char_type[unsigned(m_bufsize)];
496 this->setp(m_p, m_p + m_bufsize);
500 size_type
const m_bufsize;
501 largeobjectaccess m_obj;
504 char_type *m_g, *m_p;
517 template<
typename CHAR =
char,
typename TRAITS = std::
char_traits<CHAR>>
520 using super = std::basic_istream<CHAR, TRAITS>;
538 m_buf{t, o, std::ios::in | std::ios::binary, buf_size}
552 m_buf{t, o, std::ios::in | std::ios::binary, buf_size}
558 largeobject_streambuf<CHAR, TRAITS> m_buf;
573 template<
typename CHAR =
char,
typename TRAITS = std::
char_traits<CHAR>>
576 using super = std::basic_ostream<CHAR, TRAITS>;
594 m_buf{t, o, std::ios::out | std::ios::binary, buf_size}
608 m_buf{t, o, std::ios::out | std::ios::binary, buf_size}
620 catch (std::exception
const &e)
622 m_buf.process_notice(e.what());
642 template<
typename CHAR =
char,
typename TRAITS = std::
char_traits<CHAR>>
645 using super = std::basic_iostream<CHAR, TRAITS>;
664 t, o, std::ios::in | std::ios::out | std::ios::binary, buf_size}
679 t, o, std::ios::in | std::ios::out | std::ios::binary, buf_size}
691 catch (std::exception
const &e)
693 m_buf.process_notice(e.what());
704 #include "pqxx/internal/compiler-internal-post.hxx" TRAITS traits_type
Definition: largeobject.hxx:580
TRAITS traits_type
Definition: largeobject.hxx:524
Output stream that writes data back to a large object.
Definition: largeobject.hxx:574
bool operator<(largeobject const &other) const
Compare object identities.
Definition: largeobject.hxx:110
virtual int sync() override
Definition: largeobject.hxx:406
basic_ilostream(dbtransaction &t, oid o, largeobject::size_type buf_size=512)
Create a basic_ilostream.
Definition: largeobject.hxx:549
TRAITS traits_type
Definition: largeobject.hxx:369
bool operator>(largeobject const &other) const
Compare object identities.
Definition: largeobject.hxx:116
basic_olostream(dbtransaction &t, oid o, largeobject::size_type buf_size=512)
Create a basic_olostream.
Definition: largeobject.hxx:605
virtual ~largeobject_streambuf() noexcept
Definition: largeobject.hxx:396
Connection to a database.
Definition: connection.hxx:164
CHAR char_type
Definition: largeobject.hxx:579
Identity of a large object.
Definition: largeobject.hxx:34
typename traits_type::int_type int_type
Definition: largeobject.hxx:370
static PQXX_PURE internal::pq::PGconn * raw_connection(dbtransaction const &T)
Definition: largeobject.cxx:133
basic_lostream(dbtransaction &t, oid o, largeobject::size_type buf_size=512)
Create a basic_lostream.
Definition: largeobject.hxx:675
virtual pos_type seekpos(pos_type pos, openmode) override
Definition: largeobject.hxx:418
virtual pos_type seekoff(off_type offset, seekdir dir, openmode) override
Definition: largeobject.hxx:413
Streambuf to use large objects in standard I/O streams.
Definition: largeobject.hxx:363
void to_file(dbtransaction &t, std::string_view file) const
Export large object's contents to a local file.
Definition: largeobject.cxx:98
large_object_size_type size_type
Definition: largeobject.hxx:37
void process_notice(std::string const &s)
For use by large object stream classes.
Definition: largeobject.hxx:403
typename traits_type::off_type off_type
Definition: largeobject.hxx:527
virtual int_type underflow() override
Definition: largeobject.hxx:455
basic_ilostream(dbtransaction &t, largeobject o, largeobject::size_type buf_size=512)
Create a basic_ilostream.
Definition: largeobject.hxx:535
std::ios::seekdir seekdir
Seek direction: beg, cur, end.
Definition: largeobject.hxx:170
TRAITS traits_type
Definition: largeobject.hxx:649
largeobjectaccess::openmode openmode
Definition: largeobject.hxx:373
bool operator==(largeobject const &other) const
Compare object identities.
Definition: largeobject.hxx:86
void to_file(std::string_view file) const
Export large object's contents to a local file.
Definition: largeobject.hxx:221
typename traits_type::int_type int_type
Definition: largeobject.hxx:650
typename traits_type::pos_type pos_type
Definition: largeobject.hxx:582
TO check_cast(FROM value, char const description[])
Cast a numeric value to another type, or throw if it underflows/overflows.
Definition: util.hxx:53
basic_olostream(dbtransaction &t, largeobject o, largeobject::size_type buf_size=512)
Create a basic_olostream.
Definition: largeobject.hxx:591
largeobject_streambuf(dbtransaction &t, largeobject o, openmode mode=default_mode, size_type buf_size=512)
Definition: largeobject.hxx:380
typename traits_type::off_type off_type
Definition: largeobject.hxx:652
bool operator<=(largeobject const &other) const
Compare object identities.
Definition: largeobject.hxx:98
virtual int_type overflow()
Definition: largeobject.hxx:453
typename traits_type::pos_type pos_type
Definition: largeobject.hxx:526
typename traits_type::pos_type pos_type
Definition: largeobject.hxx:371
constexpr oid oid_none
The "null" oid.
Definition: util.hxx:188
Input stream that gets its data from a large object.
Definition: largeobject.hxx:518
CHAR char_type
Definition: largeobject.hxx:648
bool operator>=(largeobject const &other) const
Compare object identities.
Definition: largeobject.hxx:104
size_type off_type
Definition: largeobject.hxx:152
typename traits_type::off_type off_type
Definition: largeobject.hxx:583
size_type pos_type
Definition: largeobject.hxx:153
std::ios::openmode openmode
Open mode: in, out (can be combined using "bitwise or").
Definition: largeobject.hxx:163
oid id() const noexcept
Object identifier.
Definition: largeobject.hxx:74
The home of all libpqxx classes, functions, templates, etc.
Definition: array.hxx:25
Abstract transaction base class: bracket transactions on the database.
Definition: dbtransaction.hxx:52
typename traits_type::int_type int_type
Definition: largeobject.hxx:525
bool operator!=(largeobject const &other) const
Compare object identities.
Definition: largeobject.hxx:92
typename traits_type::pos_type pos_type
Definition: largeobject.hxx:651
~basic_olostream()
Definition: largeobject.hxx:613
~basic_lostream()
Definition: largeobject.hxx:684
~largeobjectaccess() noexcept
Definition: largeobject.hxx:209
void write(std::string_view buf)
Write string to large object.
Definition: largeobject.hxx:244
virtual int_type overflow(int_type ch) override
Definition: largeobject.hxx:425
typename traits_type::off_type off_type
Definition: largeobject.hxx:372
Accessor for large object's contents.
Definition: largeobject.hxx:148
int64_t large_object_size_type
Number of bytes in a large object.
Definition: types.hxx:33
Stream that reads and writes a large object.
Definition: largeobject.hxx:643
CHAR char_type
Definition: largeobject.hxx:368
largeobjectaccess::seekdir seekdir
Definition: largeobject.hxx:374
basic_lostream(dbtransaction &t, largeobject o, largeobject::size_type buf_size=512)
Create a basic_lostream.
Definition: largeobject.hxx:660
largeobject_streambuf(dbtransaction &t, oid o, openmode mode=default_mode, size_type buf_size=512)
Definition: largeobject.hxx:388
typename traits_type::int_type int_type
Definition: largeobject.hxx:581
CHAR char_type
Definition: largeobject.hxx:523