pqxx::params Class Reference

Build a parameter list for a parameterised or prepared statement. More...

#include <params.hxx>

Public Member Functions
	params ()=default
template<typename... Args>
constexpr	params (Args &&...args)
	Pre-populate a params with args. Feel free to add more later. More...
void	reserve (std::size_t n)&
	Pre-allocate room for at least n parameters. More...
auto	size () const noexcept
	Get the number of parameters currently in this params. More...
auto	ssize () const
	Get the number of parameters (signed). More...
void	append ()&
	Append a null value. More...
void	append (zview)&
	Append a non-null zview parameter. More...
void	append (std::string const &)&
	Append a non-null string parameter. More...
void	append (std::string &&)&
	Append a non-null string parameter. More...
void	append (bytes_view)&
	Append a non-null binary parameter. More...
void	append (bytes const &)&
	Append a non-null binary parameter. More...
void	append (bytes &&)&
	Append a non-null binary parameter. More...
void	append (binarystring const &value)&
template<typename IT , typename ACCESSOR >
void	append (pqxx::internal::dynamic_params< IT, ACCESSOR > const &value)&
	Append all parameters from value. More...
void	append (params const &value)&
void	append (params &&value)&
template<typename TYPE >
void	append (TYPE const &value)&
template<typename RANGE >
void	append_multi (RANGE const &range)&
	Append all elements of range as parameters. More...
pqxx::internal::c_params	make_c_params () const
	For internal use: Generate a params object for use in calls. More...

Detailed Description

Build a parameter list for a parameterised or prepared statement.

When calling a parameterised statement or a prepared statement, in many cases you can pass parameters into the statement in the form of a pqxx::params object.

Constructor & Destructor Documentation

pqxx::params::params ( )

default

template<typename... Args>

constexpr pqxx::params::params ( Args &&...  args )

inline

Pre-populate a params with args. Feel free to add more later.

Member Function Documentation

void pqxx::params::append

(

)

Append a null value.

void pqxx::params::append

(

zview

value

)

Append a non-null zview parameter.

The underlying data must stay valid for as long as the params remains active.

void pqxx::params::append

(

std::string const &

value

)

Append a non-null string parameter.

Copies the underlying data into internal storage. For best efficiency, use the zview variant if you can, or std::move()

void pqxx::params::append

(

std::string &&

value

)

Append a non-null string parameter.

void pqxx::params::append

(

bytes_view

value

)

Append a non-null binary parameter.

The underlying data must stay valid for as long as the params remains active.

void pqxx::params::append

(

bytes const &

value

)

Append a non-null binary parameter.

Copies the underlying data into internal storage. For best efficiency, use the pqxx::bytes_view variant if you can, or std::move().

void pqxx::params::append

(

bytes &&

value

)

Append a non-null binary parameter.

void pqxx::params::append

(

binarystring const &

value

)

Deprecated:

Append binarystring parameter.

The binarystring must stay valid for as long as the params remains active.

template<typename IT , typename ACCESSOR >

void pqxx::params::append ( pqxx::internal::dynamic_params< IT, ACCESSOR > const &  value )

inline

Append all parameters from value.

void pqxx::params::append

(

params const &

value

)

void pqxx::params::append

(

params &&

value

)

template<typename TYPE >

void pqxx::params::append ( TYPE const &  value )

inline

Append a non-null parameter, converting it to its string representation.

template<typename RANGE >

void pqxx::params::append_multi ( RANGE const &  range )

inline

Append all elements of range as parameters.

pqxx::internal::c_params pqxx::params::make_c_params

(

)

const

For internal use: Generate a params object for use in calls.

The params object encapsulates the pointers which we will need to pass to libpq when calling a parameterised or prepared statement.

The pointers in the params will refer to storage owned by either the params object, or the caller. This is not a problem because a c_params object is guaranteed to live only while the call is going on. As soon as we climb back out of that call tree, we're done with that data.

void pqxx::params::reserve

(

std::size_t

n

)

Pre-allocate room for at least n parameters.

This is not needed, but it may improve efficiency.

Reserve space if you're going to add parameters individually, and you've got some idea of how many there are going to be. It may save some memory re-allocations.

auto pqxx::params::size ( ) const

inlinenoexcept

Get the number of parameters currently in this params.

auto pqxx::params::ssize ( ) const

inline

Get the number of parameters (signed).

Unlike size(), this is not yet noexcept. That's because C++17's std::vector does not have a ssize() member function. These member functions are noexcept, but std::size() and std::ssize() are not.

---

The documentation for this class was generated from the following files:

• /tmp/B.ciyvkay4/BUILD/libpqxx-7.10.7-build/libpqxx-7.10.7/include/pqxx/params.hxx
• /tmp/B.ciyvkay4/BUILD/libpqxx-7.10.7-build/libpqxx-7.10.7/src/params.cxx