fbcpp::BatchOptions Class Reference

Configuration options for creating a Batch. More...

#include <Batch.h>

Public Member Functions
bool	getMultiError () const
	Returns whether multiple errors are collected per execution.
BatchOptions &	setMultiError (bool value)
	Enables or disables collection of multiple errors per execution.
bool	getRecordCounts () const
	Returns whether per-message affected row counts are reported.
BatchOptions &	setRecordCounts (bool value)
	Enables or disables per-message affected row counts.
std::optional< unsigned >	getBufferBytesSize () const
	Returns the batch buffer size in bytes, or nullopt for the server default.
BatchOptions &	setBufferBytesSize (unsigned value)
	Sets the batch buffer size in bytes.
BlobPolicy	getBlobPolicy () const
	Returns the blob handling policy.
BatchOptions &	setBlobPolicy (BlobPolicy value)
	Sets the blob handling policy.
unsigned	getDetailedErrors () const
	Returns the maximum number of detailed error statuses to collect.
BatchOptions &	setDetailedErrors (unsigned value)
	Sets the maximum number of detailed error statuses to collect.

Detailed Description

Configuration options for creating a Batch.

These options map to IXpbBuilder parameters for the IBatch interface. All setters return *this for fluent configuration.

Definition at line 85 of file Batch.h.

Member Function Documentation

getBlobPolicy()

BlobPolicy fbcpp::BatchOptions::getBlobPolicy ( ) const

inline

Returns the blob handling policy.

Definition at line 142 of file Batch.h.

getBufferBytesSize()

std::optional< unsigned > fbcpp::BatchOptions::getBufferBytesSize ( ) const

inline

Returns the batch buffer size in bytes, or nullopt for the server default.

Definition at line 125 of file Batch.h.

getDetailedErrors()

unsigned fbcpp::BatchOptions::getDetailedErrors ( ) const

inline

Returns the maximum number of detailed error statuses to collect.

Definition at line 159 of file Batch.h.

getMultiError()

bool fbcpp::BatchOptions::getMultiError ( ) const

inline

Returns whether multiple errors are collected per execution.

Definition at line 91 of file Batch.h.

getRecordCounts()

bool fbcpp::BatchOptions::getRecordCounts ( ) const

inline

Returns whether per-message affected row counts are reported.

Definition at line 108 of file Batch.h.

setBlobPolicy()

BatchOptions & fbcpp::BatchOptions::setBlobPolicy ( BlobPolicy  value )

inline

Sets the blob handling policy.

Definition at line 150 of file Batch.h.

setBufferBytesSize()

BatchOptions & fbcpp::BatchOptions::setBufferBytesSize ( unsigned  value )

inline

Sets the batch buffer size in bytes.

Definition at line 133 of file Batch.h.

setDetailedErrors()

BatchOptions & fbcpp::BatchOptions::setDetailedErrors ( unsigned  value )

inline

Sets the maximum number of detailed error statuses to collect.

Definition at line 167 of file Batch.h.

setMultiError()

BatchOptions & fbcpp::BatchOptions::setMultiError ( bool  value )

inline

Enables or disables collection of multiple errors per execution.

Definition at line 99 of file Batch.h.

setRecordCounts()

BatchOptions & fbcpp::BatchOptions::setRecordCounts ( bool  value )

inline

Enables or disables per-message affected row counts.

Definition at line 116 of file Batch.h.

---

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

• src/fb-cpp/Batch.h