SimpleArrayBind, template for binding an array of a basic data type. More...

#include <HOCI.h>

Inheritance diagram for Harlinn::OCI::SimpleArrayBind< BT, externalType, IT >:

Collaboration diagram for Harlinn::OCI::SimpleArrayBind< BT, externalType, IT >:

Public Types
using	Base = ArrayBind

using	BoundType = BT

using	IntermediateType = IT

using	ArrayType = std::vector<IntermediateType>

using	iterator = typename ArrayType::iterator

using	const_iterator = typename ArrayType::const_iterator

using	size_type = typename ArrayType::size_type

Public Member Functions
constexpr	SimpleArrayBind () noexcept

	SimpleArrayBind (const OCI::Statement &statement)

	SimpleArrayBind (const OCI::Statement &statement, UInt32 position)

	SimpleArrayBind (const OCI::Statement &statement, const WideString &name)

void	Assign (const ArrayType &data)

void	Assign (ArrayType &&data)

void	Assign (const std::initializer_list< BoundType > &data)

void	AssignNull (size_t size)

iterator	begin () noexcept

const_iterator	begin () const noexcept

iterator	end () noexcept

const_iterator	end () const noexcept

size_type	size () const noexcept

void	resize (size_type count)

virtual void *	Data (size_t index) const override

virtual bool	AsBoolean (size_t index) const override

virtual void	Assign (size_t index, bool newValue) override

virtual Byte	AsByte (size_t index) const override

virtual void	Assign (size_t index, Byte newValue) override

virtual SByte	AsSByte (size_t index) const override

virtual void	Assign (size_t index, SByte newValue) override

virtual Int16	AsInt16 (size_t index) const override

virtual void	Assign (size_t index, Int16 newValue) override

virtual UInt16	AsUInt16 (size_t index) const override

virtual void	Assign (size_t index, UInt16 newValue) override

virtual Int32	AsInt32 (size_t index) const override

virtual void	Assign (size_t index, Int32 newValue) override

virtual UInt32	AsUInt32 (size_t index) const override

virtual void	Assign (size_t index, UInt32 newValue) override

virtual Int64	AsInt64 (size_t index) const override

virtual void	Assign (size_t index, Int64 newValue) override

virtual UInt64	AsUInt64 (size_t index) const override

virtual void	Assign (size_t index, UInt64 newValue) override

virtual float	AsSingle (size_t index) const override

virtual void	Assign (size_t index, float newValue) override

virtual double	AsDouble (size_t index) const override

virtual void	Assign (size_t index, double newValue) override

Public Member Functions inherited from Harlinn::OCI::ArrayBind
	ArrayBind () noexcept

	ArrayBind (const OCI::Statement &statement)

	ArrayBind (const OCI::Statement &statement, UInt32 position)

	ArrayBind (const OCI::Statement &statement, const WideString &name)

Int16	Indicator (size_t index) const

void	SetIndicator (size_t index, Int16 value)

void	SetDBNull (size_t index)

void	SetDBNotNull (size_t index)

virtual std::vector< Byte >	AsBytes (size_t index) const

virtual void	Assign (size_t index, const std::vector< Byte > &newValue)

virtual DateTime	AsDateTime (size_t index) const

virtual void	Assign (size_t index, const DateTime &newValue)

virtual TimeSpan	AsTimeSpan (size_t index) const

virtual void	Assign (size_t index, const TimeSpan &newValue)

virtual WideString	AsString (size_t index) const

virtual void	Assign (size_t index, const WideString &newValue)

virtual Guid	AsGuid (size_t index) const

virtual void	Assign (size_t index, const Guid &newValue)

Public Member Functions inherited from Harlinn::OCI::BindBase
	BindBase (const OCI::Statement &statement)

	BindBase (const OCI::Statement &statement, UInt32 position)

	BindBase (const OCI::Statement &statement, const WideString &name)

const OCI::Environment &	Environment () const

const OCI::ErrorHandle &	Error () const noexcept final override
	Provides access to the OCIError that will be used for OCI calls for this object.

HO_EXPORT void	BindByPos (UInt32 positon, OraType dataType, void dataAddress, Int64 dataSize, Int16 indicators, UInt32 actualLengths=nullptr, UInt16 returnCodes=nullptr, UInt32 plsqlMaxArrayLength=0, UInt32 *plsqlArrayLength=nullptr, UInt32 mode=0)

HO_EXPORT void	BindByName (const WideString &name, OraType dataType, void dataAddress, Int64 dataSize, Int16 indicators, UInt32 actualLengths=nullptr, UInt16 returnCodes=nullptr, UInt32 plsqlMaxArrayLength=0, UInt32 *plsqlArrayLength=nullptr, UInt32 mode=0)

void	OnExecute (UInt32 iters)

constexpr const OCI::Statement &	Statement () const

const OCI::ServiceContext &	ServiceContext () const

UInt32	Position () const

void	SetPosition (UInt32 position)

bool	IsBindByPosition () const

const WideString &	Name () const

WideString	Name ()

void	SetName (const WideString &name)

void	SetCharCount (UInt32 charCount)
	Sets the number of characters in character type data. (OCI_ATTR_CHAR_COUNT)

void	SetMaxCharSize (Int32 maxCharSize)
	Sets the number of characters that an application reserves on the server to store the data being bound.

void	SetMaxDataSize (Int32 maxDataSize)
	Sets the maximum number of bytes allowed in the buffer on the server side to accommodate client-side bind data after character set conversions.

UInt32	CollationId () const
	Retrieves the derived collation of a placeholder expression corresponding to this bind handle in a SQL statement. The value is relevant only for bind variables with character data types.

void	SetCollationId (UInt32 collationId) const
	Sets the derived collation of a placeholder expression corresponding to this bind handle in a SQL statement.The attribute is relevant only for bind variables with character data types.

UInt16	CharacterSet () const
	Retrives the character set ID of the bind handle.

void	SetCharacterSet (UInt16 characterSetId) const
	Sets the character set ID of the bind handle.

OCI::CharacterSetForm	CharacterSetForm () const
	Character set form of the bind handle.The default form is OCI::CharacterSetForm::Implicit.Setting this attribute causes the bind handle to use the database or national character set on the client side.Set this attribute to OCI::CharacterSetForm::NChar for the national character set or OCI::CharacterSetForm::Implicit for the database character set.

void	SetCharacterSetForm (OCI::CharacterSetForm charsetForm)

UInt32	RowsReturned () const
	Returns the number of rows that will be returned in the current iteration when you are in the OUT callback function for binding a DML statement with a RETURNING clause. (OCI_ATTR_ROWS_RETURNED)

Public Member Functions inherited from Harlinn::OCI::HandleBase
constexpr void *	Handle () const noexcept
	Provides access to the value of the handle object.

constexpr	operator bool () const noexcept
	Test if the handle value is assigned.

constexpr bool	IsValid () const noexcept
	Test if the handle value is assigned.

constexpr OCI::HandleType	HandleType () const noexcept
	Returns a value identifying the type of the wrapped handle object.

Static Public Attributes
static constexpr OCI::OraType	ExternalType = externalType

Protected Member Functions
virtual void	Bind (UInt32 positon, UInt32 iters) override

virtual void	Bind (const WideString &name, UInt32 iters)

Protected Member Functions inherited from Harlinn::OCI::ArrayBind
void	SimpleBindByPos (UInt32 positon, OraType dataType, void dataAddress, Int32 dataSize, UInt32 maximumNumberOfElements, UInt32 currentNumberOfElements)

void	SimpleBindByName (const WideString &name, OraType dataType, void dataAddress, Int32 dataSize, UInt32 maximumNumberOfElements, UInt32 currentNumberOfElements)

void	resize (size_t newSize)

Protected Member Functions inherited from Harlinn::OCI::BindBase
	BindBase () noexcept

bool	IsPlSQL () const

Protected Member Functions inherited from Harlinn::OCI::HandleBase
constexpr	HandleBase () noexcept
	Default constructor.

constexpr	HandleBase (OCI::HandleType handleType, void *handle, bool ownsHandle) noexcept
	Constructs a new HandleBase object.

	HandleBase (const HandleBase &other)=delete

constexpr	HandleBase (HandleBase &&other) noexcept
	Move constructor.

virtual	~HandleBase ()
	Destructor.

constexpr void	SetHandle (void *newHandleValue, bool ownsHandle) noexcept
	Assigns the handle value and ownership to this object.

constexpr bool	OwnsHandle () const noexcept
	Returns true if this object is the owner of the handle value.

void *	DetachHandle ()
	If this object is the owner of a handle this function rescinds that ownership, and returns the handle value without closing the handle.

void	DestroyHandle ()
	Destroys the handle if it is owned by this object.

HandleBase &	operator= (const HandleBase &other)=delete

constexpr HandleBase &	operator= (HandleBase &&other) noexcept

constexpr void	swap (HandleBase &other) noexcept

template<typename Derived >
constexpr void	Take (Derived &&derived) noexcept
	Template function used to implement move assignement in derived classes.

void	InitializeHandle (void *handle, bool ownsHandle)
	Provides a "safe" mechanism for assigning a handle value. This functions throws if a handle value is already assigned to this object.

HO_EXPORT Int32	GetAttribute (void buffer, UInt32 size, Attribute attribute) const
	Gets the value of an attribute from the handle.

HO_EXPORT Int32	SetAttribute (void *buffer, UInt32 size, Attribute attribute) const
	Sets the value of an attribute on the handle.

DateTime	GetDateTimeAttribute (Attribute attribute) const
	Gets the value of an attribute from the handle as a DateTime.

void	SetDateTimeAttribute (Attribute attribute, const DateTime &value) const
	Sets the value of an attribute on the handle as a DateTime.

template<WideStringLike StringT = WideString>
StringT	GetStringAttribute (Attribute attribute) const
	Gets the value of an attribute from the handle as a WideString.

template<WideStringLike StringT = WideString>
StringT	GetStringAttributeFromByteString (Attribute attribute) const
	Gets the value of an attribute from the handle as a WideString For use with attributes that are not returned as UTF-16.

template<WideStringLike StringT>
void	SetStringAttribute (Attribute attribute, const StringT &value) const
	Sets the value of an attribute on the handle as a WideString.

void	SetStringAttribute (Attribute attribute, const wchar_t *value, size_t valueLength) const

bool	GetBooleanAttribute (Attribute attribute) const
	Gets the value of an attribute from the handle as a bool.

void	SetBooleanAttribute (Attribute attribute, bool value) const
	Sets the value of an attribute on the handle as a bool.

Byte	GetByteAttribute (Attribute attribute) const
	Gets the value of an attribute from the handle as a Byte.

void	SetByteAttribute (Attribute attribute, Byte value) const
	Sets the value of an attribute on the handle as a Byte.

SByte	GetSByteAttribute (Attribute attribute) const
	Gets the value of an attribute from the handle as a SByte.

void	SetSByteAttribute (Attribute attribute, SByte value) const
	Sets the value of an attribute on the handle as a Byte.

Int16	GetInt16Attribute (Attribute attribute) const
	Gets the value of an attribute from the handle as an Int16.

void	SetInt16Attribute (Attribute attribute, Int16 value) const
	Sets the value of an attribute on the handle as an Int16.

UInt16	GetUInt16Attribute (Attribute attribute) const
	Gets the value of an attribute from the handle as an UInt16.

void	SetUInt16Attribute (Attribute attribute, UInt16 value) const
	Sets the value of an attribute on the handle as an UInt16.

Int32	GetInt32Attribute (Attribute attribute) const
	Gets the value of an attribute from the handle as an Int32.

void	SetInt32Attribute (Attribute attribute, Int32 value) const
	Sets the value of an attribute on the handle as an Int32.

UInt32	GetUInt32Attribute (Attribute attribute) const
	Gets the value of an attribute from the handle as an UInt32.

void	SetUInt32Attribute (Attribute attribute, UInt32 value) const
	Sets the value of an attribute on the handle as an UInt32.

Int64	GetInt64Attribute (Attribute attribute) const
	Gets the value of an attribute from the handle as an Int64.

void	SetInt64Attribute (Attribute attribute, Int64 value) const
	Sets the value of an attribute on the handle as an Int64.

UInt64	GetUInt64Attribute (Attribute attribute) const
	Gets the value of an attribute from the handle as an UInt64.

void	SetUInt64Attribute (Attribute attribute, UInt64 value) const
	Sets the value of an attribute on the handle as an UInt64.

void *	GetPointerAttribute (Attribute attribute) const
	Gets the value of an attribute from the handle as a pointer.

void	SetPointerAttribute (Attribute attribute, void *value) const
	Sets the value of an attribute on the handle as a pointer.

OCI::Number *	GetNumberAttribute (Attribute attribute) const
	Gets the value of an attribute from the handle as a pointer to an OCI::Number.

Private Attributes
ArrayType	data_

UInt32	actualSize_

Additional Inherited Members
Static Protected Member Functions inherited from Harlinn::OCI::HandleBase
static HO_EXPORT void	HandleFree (void *handle, OCI::HandleType handleType) noexcept
	Calls OCIHandleFree to release the handle.

Protected Attributes inherited from Harlinn::OCI::ArrayBind
std::vector< Int16 >	indicator_

Detailed Description

template<typename BT, OCI::OraType externalType, typename IT = BT>
class Harlinn::OCI::SimpleArrayBind< BT, externalType, IT >

SimpleArrayBind, template for binding an array of a basic data type.