fbcpp::AttachmentOptions Class Reference

Represents options used when creating an Attachment object. More...

#include <Attachment.h>

Public Member Functions
const std::optional< std::string > &	getConnectionCharSet () const
	Returns the character set which will be used for the connection.
AttachmentOptions &	setConnectionCharSet (const std::string &value)
	Sets the character set which will be used for the connection.
const std::optional< std::string > &	getUserName () const
	Returns the user name which will be used to connect to the database.
AttachmentOptions &	setUserName (const std::string &value)
	Sets the user name which will be used to connect to the database.
const std::optional< std::string > &	getPassword () const
	Returns the password which will be used to connect to the database.
AttachmentOptions &	setPassword (const std::string &value)
	Sets the password which will be used to connect to the database.
const std::optional< std::string > &	getRole () const
	Returns the role which will be used to connect to the database.
AttachmentOptions &	setRole (const std::string &value)
	Sets the role which will be used to connect to the database.
const std::optional< std::uint32_t > &	getSqlDialect () const
	Returns the SQL dialect which will be used to connect to the database.
AttachmentOptions &	setSqlDialect (std::uint32_t value)
	Sets the SQL dialect which will be used to connect to the database.
const std::vector< std::uint8_t > &	getDpb () const
	Returns the DPB (Database Parameter Block) which will be used to connect to the database.
AttachmentOptions &	setDpb (const std::vector< std::uint8_t > &value)
	Sets the DPB (Database Parameter Block) which will be used to connect to the database.
AttachmentOptions &	setDpb (std::vector< std::uint8_t > &&value)
	Sets the DPB (Database Parameter Block) which will be used to connect to the database.
bool	getCreateDatabase () const
	Returns whether the database should be created instead of connected to.
AttachmentOptions &	setCreateDatabase (bool value)
	Sets whether the database should be created instead of connected to.
const std::optional< bool > &	getForcedWrites () const
	Returns whether forced writes should be enabled when creating the database.
AttachmentOptions &	setForcedWrites (bool value)
	Sets whether forced writes should be enabled when creating the database.

Detailed Description

Represents options used when creating an Attachment object.

Definition at line 48 of file Attachment.h.

Member Function Documentation

getConnectionCharSet()

const std::optional< std::string > & fbcpp::AttachmentOptions::getConnectionCharSet ( ) const

inline

Returns the character set which will be used for the connection.

Definition at line 54 of file Attachment.h.

getCreateDatabase()

bool fbcpp::AttachmentOptions::getCreateDatabase ( ) const

inline

Returns whether the database should be created instead of connected to.

Definition at line 165 of file Attachment.h.

getDpb()

const std::vector< std::uint8_t > & fbcpp::AttachmentOptions::getDpb ( ) const

inline

Returns the DPB (Database Parameter Block) which will be used to connect to the database.

Definition at line 139 of file Attachment.h.

getForcedWrites()

const std::optional< bool > & fbcpp::AttachmentOptions::getForcedWrites ( ) const

inline

Returns whether forced writes should be enabled when creating the database.

Definition at line 182 of file Attachment.h.

getPassword()

const std::optional< std::string > & fbcpp::AttachmentOptions::getPassword ( ) const

inline

Returns the password which will be used to connect to the database.

Definition at line 88 of file Attachment.h.

getRole()

const std::optional< std::string > & fbcpp::AttachmentOptions::getRole ( ) const

inline

Returns the role which will be used to connect to the database.

Definition at line 105 of file Attachment.h.

getSqlDialect()

const std::optional< std::uint32_t > & fbcpp::AttachmentOptions::getSqlDialect ( ) const

inline

Returns the SQL dialect which will be used to connect to the database.

Definition at line 122 of file Attachment.h.

getUserName()

const std::optional< std::string > & fbcpp::AttachmentOptions::getUserName ( ) const

inline

Returns the user name which will be used to connect to the database.

Definition at line 71 of file Attachment.h.

setConnectionCharSet()

AttachmentOptions & fbcpp::AttachmentOptions::setConnectionCharSet ( const std::string &  value )

inline

Sets the character set which will be used for the connection.

Definition at line 62 of file Attachment.h.

setCreateDatabase()

AttachmentOptions & fbcpp::AttachmentOptions::setCreateDatabase ( bool  value )

inline

Sets whether the database should be created instead of connected to.

Definition at line 173 of file Attachment.h.

setDpb() [1/2]

AttachmentOptions & fbcpp::AttachmentOptions::setDpb ( const std::vector< std::uint8_t > &  value )

inline

Sets the DPB (Database Parameter Block) which will be used to connect to the database.

Definition at line 147 of file Attachment.h.

setDpb() [2/2]

AttachmentOptions & fbcpp::AttachmentOptions::setDpb ( std::vector< std::uint8_t > &&  value )

inline

Sets the DPB (Database Parameter Block) which will be used to connect to the database.

Definition at line 156 of file Attachment.h.

setForcedWrites()

AttachmentOptions & fbcpp::AttachmentOptions::setForcedWrites ( bool  value )

inline

Sets whether forced writes should be enabled when creating the database.

Definition at line 190 of file Attachment.h.

setPassword()

AttachmentOptions & fbcpp::AttachmentOptions::setPassword ( const std::string &  value )

inline

Sets the password which will be used to connect to the database.

Definition at line 96 of file Attachment.h.

setRole()

AttachmentOptions & fbcpp::AttachmentOptions::setRole ( const std::string &  value )

inline

Sets the role which will be used to connect to the database.

Definition at line 113 of file Attachment.h.

setSqlDialect()

AttachmentOptions & fbcpp::AttachmentOptions::setSqlDialect ( std::uint32_t  value )

inline

Sets the SQL dialect which will be used to connect to the database.

Definition at line 130 of file Attachment.h.

setUserName()

AttachmentOptions & fbcpp::AttachmentOptions::setUserName ( const std::string &  value )

inline

Sets the user name which will be used to connect to the database.

Definition at line 79 of file Attachment.h.

---

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

• src/fb-cpp/Attachment.h