Object used to store bookmarks to blobs to be changed later. More...

#include <dbapi/simple/sdbapi.hpp>

Collaboration diagram for CBlobBookmark:

Public Types
enum	EBlobType { eUnknown , eText , eBinary }
	Blob type (if known). More...

Public Member Functions
CNcbiOstream &	GetOStream (size_t blob_size, TBlobOStreamFlags flags=0) const
	Get Blob output stream. More...

CNcbiOstream &	GetOStream (size_t blob_size, CQuery::EAllowLog log_it) const

	CBlobBookmark (void)
	Empty constructor of bookmark object. More...

	~CBlobBookmark (void)

	CBlobBookmark (const CBlobBookmark &bm)
	Copy of bookmark object. More...

CBlobBookmark &	operator= (const CBlobBookmark &bm)

Private Member Functions
	CBlobBookmark (CBlobBookmarkImpl *bm_impl)
	Create bookmark with the given implementation. More...

Private Attributes
CRef< CBlobBookmarkImpl >	m_Impl
	Bookmark implementation object. More...

Friends
class	CDatabase

class	CRemoteQFB

Detailed Description

Object used to store bookmarks to blobs to be changed later.

See also: CQuery::CField::GetBookmark, CDatabase::NewBookmark

Definition at line 765 of file sdbapi.hpp.

Member Enumeration Documentation

◆ EBlobType

enum CBlobBookmark::EBlobType

Blob type (if known).

Enumerator
eUnknown
eText
eBinary

Definition at line 769 of file sdbapi.hpp.

Constructor & Destructor Documentation

◆ CBlobBookmark() [1/3]

CBlobBookmark::CBlobBookmark ( void )

Empty constructor of bookmark object.

Object created this way cannot be used for anything except assigning from the other bookmark object.

Definition at line 3503 of file sdbapi.cpp.

◆ ~CBlobBookmark()

CBlobBookmark::~CBlobBookmark ( void )

Definition at line 3521 of file sdbapi.cpp.

◆ CBlobBookmark() [2/3]

CBlobBookmark::CBlobBookmark ( const CBlobBookmark & bm )

Copy of bookmark object.

Definition at line 3510 of file sdbapi.cpp.

◆ CBlobBookmark() [3/3]

CBlobBookmark::CBlobBookmark ( CBlobBookmarkImpl * bm_impl )

private

Create bookmark with the given implementation.

Definition at line 3506 of file sdbapi.cpp.

Member Function Documentation

◆ GetOStream() [1/2]

CNcbiOstream & CBlobBookmark::GetOStream	(	size_t	blob_size,
		CQuery::EAllowLog	log_it
	)		const

Definition at line 3531 of file sdbapi.cpp.

References CQuery::eDisableLog, fBOS_SkipLogging, and GetOStream().

◆ GetOStream() [2/2]

CNcbiOstream & CBlobBookmark::GetOStream	(	size_t	blob_size,
		TBlobOStreamFlags	flags = `0`
	)		const

Get Blob output stream.

Blob will be updated using the same database connection which this bookmark was create on. Thus it shouldn't have any active queries or bulk inserts by the time this method is called and until the stream is not used anymore.

Parameters

blob_size	blob_size is the size of the BLOB to be written.
flags

See also: EBlobOStreamFlags.

Parameters

log_it Enables transaction log for BLOB (enabled by default). Make sure you have enough log segment space, or disable it.

Definition at line 3525 of file sdbapi.cpp.

References flags, CRef< C, Locker >::GetNCPointer(), CBlobBookmarkImpl::GetOStream(), and m_Impl.

Referenced by GetOStream().

◆ operator=()

CBlobBookmark & CBlobBookmark::operator= ( const CBlobBookmark & bm )

Definition at line 3515 of file sdbapi.cpp.

References m_Impl.

Friends And Related Function Documentation

◆ CDatabase

friend class CDatabase

friend

Definition at line 802 of file sdbapi.hpp.

◆ CRemoteQFB

friend class CRemoteQFB

friend

Definition at line 803 of file sdbapi.hpp.

Member Data Documentation

◆ m_Impl

CRef<CBlobBookmarkImpl> CBlobBookmark::m_Impl

private

Bookmark implementation object.

Definition at line 810 of file sdbapi.hpp.

Referenced by GetOStream(), and operator=().

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

include/dbapi/simple/sdbapi.hpp
src/dbapi/simple/sdbapi.cpp

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends