TBasketSQL Class Reference

Implement TBasket for a SQL backend.

Definition at line 30 of file TBasketSQL.h.

Public Member Functions
	TBasketSQL ()
	Default constructor.
	TBasketSQL (const char *name, const char *title, TBranch *branch, TSQLResult **rs, TString *insert_query, std::vector< Int_t > *vc, TSQLRow **row)
	Regular constructor.
	~TBasketSQL ()
	Destructor.
void	CreateBuffer (const char *name, TString title, std::vector< Int_t > *vc, TBranch *branch, TSQLResult **rs)
	Create a TSQLBuffer for this basket.
TSQLResult *	GetResultSet ()
void	PrepareBasket (Long64_t entry)
	Prepare the basket for the next entry.
virtual Int_t	ReadBasketBuffers (Long64_t pos, Int_t len, TFile *file)
	See TBasket::ReadBasketBuffers. This is not implemented in TBasketSQL.
virtual Int_t	ReadBasketBytes (Long64_t pos, TFile *file)
	See TBasket::ReadBasketBytes. This is not implemented in TBasketSQL.
void	Update (Int_t offset, Int_t skipped)
	See TBasket::Update.
Public Member Functions inherited from TBasket
	TBasket ()
	Default constructor.
	TBasket (const char *name, const char *title, TBranch *branch)
	Basket normal constructor, used during writing.
	TBasket (TDirectory *motherDir)
	Constructor used during reading.
virtual	~TBasket ()
	Basket destructor.
virtual void	AdjustSize (Int_t newsize)
	Increase the size of the current fBuffer up to newsize.
Long64_t	CopyTo (TFile *to)
	Copy the basket of this branch onto the file to.
virtual void	DeleteEntryOffset ()
	Delete fEntryOffset array.
virtual Int_t	DropBuffers ()
	Drop buffers of this basket if it is not the current basket.
TBranch *	GetBranch () const
Int_t	GetBufferSize () const
Int_t *	GetDisplacement () const
Int_t *	GetEntryOffset ()
Int_t	GetEntryPointer (Int_t Entry)
	Get pointer to buffer for internal entry.
Int_t	GetLast () const
Int_t	GetNevBuf () const
Int_t	GetNevBufSize () const
Bool_t	GetResetAllocationCount () const
Int_t	LoadBasketBuffers (Long64_t pos, Int_t len, TFile *file, TTree *tree=0)
	Load basket buffers in memory without unziping.
virtual void	MoveEntries (Int_t dentries)
	Remove the first dentries of this basket, moving entries at dentries to the start of the buffer.
Int_t	ReadBasketBuffers (Long64_t pos, Int_t len, TFile *file)
	Read basket buffers in memory and cleanup.
Int_t	ReadBasketBytes (Long64_t pos, TFile *file)
	Read basket buffers in memory and cleanup.
void	SetBranch (TBranch *branch)
void	SetNevBufSize (Int_t n)
virtual void	SetReadMode ()
	Set read mode of basket.
virtual void	SetWriteMode ()
	Set write mode of basket.
void	Update (Int_t newlast)
virtual Int_t	WriteBuffer ()
	Write buffer of this basket on the current file.
virtual void	WriteReset ()
	Reset the write basket to the starting state.
Public Member Functions inherited from TKey
	TKey ()
	TKey default constructor.
	TKey (const char *name, const char *title, const TClass *cl, Int_t nbytes, TDirectory *motherDir)
	Create a TKey object with the specified name, title for the given class.
	TKey (const TObject *obj, const char *name, Int_t bufsize, TDirectory *motherDir)
	Create a TKey object for a TObject* and fill output buffer.
	TKey (const TString &name, const TString &title, const TClass *cl, Int_t nbytes, TDirectory *motherDir)
	Create a TKey object with the specified name, title for the given class.
	TKey (const void *obj, const TClass *cl, const char *name, Int_t bufsize, TDirectory *motherDir)
	Create a TKey object for any object obj of class cl d and fill output buffer.
	TKey (Long64_t pointer, Int_t nbytes, TDirectory *motherDir=0)
	Create a TKey object to read keys.
	TKey (TDirectory *motherDir)
	TKey default constructor.
	TKey (TDirectory *motherDir, const TKey &orig, UShort_t pidOffset)
	Copy a TKey from its original directory to the new 'motherDir'.
virtual	~TKey ()
	TKey default destructor.
virtual void	Browse (TBrowser *b)
	Read object from disk and call its Browse() method.
virtual void	Delete (Option_t *option="")
	Delete an object from the file.
virtual void	DeleteBuffer ()
	Delete key buffer(s).
virtual void	FillBuffer (char *&buffer)
	Encode key header into output buffer.
virtual char *	GetBuffer () const
TBuffer *	GetBufferRef () const
virtual const char *	GetClassName () const
Short_t	GetCycle () const
	Return cycle number associated to this key.
const TDatime &	GetDatime () const
TFile *	GetFile () const
	Returns file to which key belong.
virtual const char *	GetIconName () const
	Title can keep 32x32 xpm thumbnail/icon of the parent object.
Short_t	GetKeep () const
	Returns the "KEEP" status.
Int_t	GetKeylen () const
TDirectory *	GetMotherDir () const
Int_t	GetNbytes () const
Int_t	GetObjlen () const
virtual Long64_t	GetSeekKey () const
virtual Long64_t	GetSeekPdir () const
virtual const char *	GetTitle () const
	Returns title (title can contain 32x32 xpm thumbnail/icon).
Int_t	GetVersion () const
virtual void	IncrementPidOffset (UShort_t offset)
	Increment fPidOffset by 'offset'.
Bool_t	IsFolder () const
	Check if object referenced by the key is a folder.
virtual void	Keep ()
	Set the "KEEP" status.
virtual void	ls (Bool_t current) const
	List Key contents.
virtual void	ls (Option_t *option="") const
	List Key contents.
virtual void	Print (Option_t *option="") const
	Print key contents.
virtual Int_t	Read (TObject *obj)
	To read an object from the file.
virtual void	ReadBuffer (char *&buffer)
	Decode input buffer.
virtual Bool_t	ReadFile ()
	Read the key structure from the file.
void	ReadKeyBuffer (char *&buffer)
	Decode input buffer.
virtual TObject *	ReadObj ()
	To read a TObject* from the file.
template<typename T >
T *	ReadObject ()
	To read an object (non deriving from TObject) from the file.
virtual void *	ReadObjectAny (const TClass *expectedClass)
	To read an object (non deriving from TObject) from the file.
virtual TObject *	ReadObjWithBuffer (char *bufferRead)
	To read a TObject* from bufferRead.
virtual void	SetBuffer ()
void	SetMotherDir (TDirectory *dir)
virtual void	SetParent (const TObject *parent)
	Set parent in key buffer.
virtual Int_t	Sizeof () const
	Return the size in bytes of the key header structure.
virtual Int_t	WriteFile (Int_t cycle=1, TFile *f=0)
	Write the encoded object supported by this key.
Public Member Functions inherited from TNamed
	TNamed ()
	TNamed (const char *name, const char *title)
	TNamed (const TNamed &named)
	TNamed copy ctor.
	TNamed (const TString &name, const TString &title)
virtual	~TNamed ()
	TNamed destructor.
virtual void	Clear (Option_t *option="")
	Set name and title to empty strings ("").
virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.
virtual Int_t	Compare (const TObject *obj) const
	Compare two TNamed objects.
virtual void	Copy (TObject &named) const
	Copy this to obj.
virtual const char *	GetName () const
	Returns name of object.
virtual ULong_t	Hash () const
	Return hash value for this object.
virtual Bool_t	IsSortable () const
TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator.
virtual void	SetName (const char *name)
	Set the name of the TNamed.
virtual void	SetNameTitle (const char *name, const char *title)
	Set all the TNamed parameters (name and title).
virtual void	SetTitle (const char *title="")
	Set the title of the TNamed.
Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.
	TObject (const TObject &object)
	TObject copy ctor.
virtual	~TObject ()
	TObject destructor.
void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.
virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.
ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
virtual const char *	ClassName () const
	Returns name of class to which the object belongs.
virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.
virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.
virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.
virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad).
virtual void	Dump () const
	Dump contents of object on stdout.
virtual void	Error (const char *method, const char *msgfmt,...) const
	Issue error message.
virtual void	Execute (const char *method, const char *params, Int_t *error=0)
	Execute method on this object with the given parameter string, e.g.
virtual void	Execute (TMethod *method, TObjArray *params, Int_t *error=0)
	Execute method on this object with parameters stored in the TObjArray.
virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).
virtual void	Fatal (const char *method, const char *msgfmt,...) const
	Issue fatal error message.
virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.
virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.
virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.
virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).
virtual Option_t *	GetOption () const
virtual UInt_t	GetUniqueID () const
	Return the unique object id.
virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.
Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
virtual void	Info (const char *method, const char *msgfmt,...) const
	Issue info message.
virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".
virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.
virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.
void	InvertBit (UInt_t f)
Bool_t	IsDestructed () const
	IsDestructed.
virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).
R__ALWAYS_INLINE Bool_t	IsOnHeap () const
R__ALWAYS_INLINE Bool_t	IsZombie () const
void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).
virtual Bool_t	Notify ()
	This method must be overridden to handle object notification.
void	Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.
void	operator delete (void *ptr)
	Operator delete.
void	operator delete[] (void *ptr)
	Operator delete [].
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *vp)
void *	operator new[] (size_t sz)
void *	operator new[] (size_t sz, void *vp)
TObject &	operator= (const TObject &rhs)
	TObject assignment operator.
virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.
virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.
virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.
void	ResetBit (UInt_t f)
virtual void	SaveAs (const char *filename="", Option_t *option="") const
	Save this object in the file specified by filename.
virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".
void	SetBit (UInt_t f)
void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.
virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.
virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.
virtual void	SysError (const char *method, const char *msgfmt,...) const
	Issue system error message.
R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const
Int_t	TestBits (UInt_t f) const
virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
virtual void	Warning (const char *method, const char *msgfmt,...) const
	Issue warning message.
virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.
virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Protected Attributes
TString *	fInsertQuery
TSQLResult **	fResultPtr
TSQLRow **	fRowPtr
Protected Attributes inherited from TBasket
TBranch *	fBranch {nullptr}
	Pointer to the basket support branch.
Int_t	fBufferSize {0}
	fBuffer length in bytes
TBuffer *	fCompressedBufferRef {nullptr}
	! Compressed buffer.
Int_t *	fDisplacement {nullptr}
	![fNevBuf] Displacement of entries in fBuffer(TKey)
Int_t *	fEntryOffset {nullptr}
	[fNevBuf] Offset of entries in fBuffer(TKey); generated at runtime.
Bool_t	fHeaderOnly {kFALSE}
	True when only the basket header must be read/written.
UChar_t	fIOBits {0}
	!IO feature flags. Serialized in custom portion of streamer to avoid forward compat issues unless needed.
Int_t	fLast {0}
	Pointer to last used byte in basket.
Int_t	fLastWriteBufferSize [3] = {0,0,0}
	! Size of the buffer last three buffers we wrote it to disk
Int_t	fNevBuf {0}
	Number of entries in basket.
Int_t	fNevBufSize {0}
	Length in Int_t of fEntryOffset OR fixed length of each entry if fEntryOffset is null!
UChar_t	fNextBufferSizeRecord {0}
	! Index into fLastWriteBufferSize of the last buffer written to disk
Bool_t	fOwnsCompressedBuffer {kFALSE}
	! Whether or not we own the compressed buffer.
Bool_t	fReadEntryOffset {kFALSE}
	!Set to true if offset array was read from a file.
Bool_t	fResetAllocation {false}
	! True if last reset re-allocated the memory
Protected Attributes inherited from TKey
char *	fBuffer
	Object buffer.
TBuffer *	fBufferRef
	Pointer to the TBuffer object.
TString	fClassName
	Object Class name.
Short_t	fCycle
	Cycle number.
TDatime	fDatime
	Date/Time of insertion in file.
Short_t	fKeylen
	Number of bytes for the key itself.
Int_t	fLeft
	Number of bytes left in current segment.
TDirectory *	fMotherDir
	!pointer to mother directory
Int_t	fNbytes
	Number of bytes for the object on file.
Int_t	fObjlen
	Length of uncompressed object in bytes.
UShort_t	fPidOffset
	!Offset to be added to the pid index in this key/buffer. This is actually saved in the high bits of fSeekPdir
Long64_t	fSeekKey
	Location of object on file.
Long64_t	fSeekPdir
	Location of parent directory on file.
Int_t	fVersion
	Key version identifier.
Protected Attributes inherited from TNamed
TString	fName
TString	fTitle

Private Member Functions
	TBasketSQL (const TBasketSQL &)
TBasketSQL &	operator= (const TBasketSQL &)

Additional Inherited Members
Public Types inherited from TBasket
enum class	EIOBits : Char_t { kGenerateOffsetMap = BIT(0) , kSupported = kGenerateOffsetMap }
enum class	EUnsupportedIOBits : Char_t { kUnsupported = 0 }
Public Types inherited from TObject
enum	{   kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,   kBitMask = 0x00ffffff }
enum	{ kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }
enum	EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
enum	EStatusBits {   kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) ,   kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) }
Static Public Member Functions inherited from TObject
static Longptr_t	GetDtorOnly ()
	Return destructor only flag.
static Bool_t	GetObjectStat ()
	Get status of object stat flag.
static void	SetDtorOnly (void *obj)
	Set destructor only flag.
static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.
Static Public Attributes inherited from TBasket
static constexpr int	kIOBitCount = 1
Protected Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(3) }
Protected Member Functions inherited from TBasket
virtual void	ReadResetBuffer (Int_t basketnumber)
	Reset the read basket TBuffer memory allocation if needed.
Protected Member Functions inherited from TKey
void	Build (TDirectory *motherDir, const char *classname, Long64_t filepos)
	Method used in all TKey constructor to initialize basic data fields.
virtual void	Create (Int_t nbytes, TFile *f=0)
	Create a TKey object of specified size.
virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.
void	Reset ()
	Reset the key as it had not been 'filled' yet.
virtual Int_t	WriteFileKeepBuffer (TFile *f=0)
	Write the encoded object supported by this key.
Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char *location, const char *fmt, va_list va) const
	Interface to ErrorHandler (protected).
void	MakeZombie ()

#include <TBasketSQL.h>

Inheritance diagram for TBasketSQL:

Constructor & Destructor Documentation

TBasketSQL() [1/3]

TBasketSQL::TBasketSQL ( const TBasketSQL &  )

private

TBasketSQL() [2/3]

TBasketSQL::TBasketSQL

(

)

Default constructor.

Definition at line 34 of file TBasketSQL.cxx.

TBasketSQL() [3/3]

TBasketSQL::TBasketSQL	(	const char *	name,
		const char *	title,
		TBranch *	branch,
		TSQLResult **	rs,
		TString *	insert_query,
		std::vector< Int_t > *	vc,
		TSQLRow **	row
	)

Regular constructor.

Definition at line 41 of file TBasketSQL.cxx.

~TBasketSQL()

TBasketSQL::~TBasketSQL

(

)

Destructor.

Definition at line 75 of file TBasketSQL.cxx.

Member Function Documentation

CreateBuffer()

void TBasketSQL::CreateBuffer	(	const char *	name,
		TString	title,
		std::vector< Int_t > *	vc,
		TBranch *	branch,
		TSQLResult **	rs
	)

Create a TSQLBuffer for this basket.

Definition at line 82 of file TBasketSQL.cxx.

GetResultSet()

TSQLResult * TBasketSQL::GetResultSet ( )

inline

Definition at line 52 of file TBasketSQL.h.

operator=()

TBasketSQL & TBasketSQL::operator= ( const TBasketSQL &  )

private

PrepareBasket()

void TBasketSQL::PrepareBasket ( Long64_t  entry )

virtual

Prepare the basket for the next entry.

Reimplemented from TBasket.

Definition at line 115 of file TBasketSQL.cxx.

ReadBasketBuffers()

Int_t TBasketSQL::ReadBasketBuffers ( Long64_t  pos, Int_t  len, TFile *  file  )

virtual

See TBasket::ReadBasketBuffers. This is not implemented in TBasketSQL.

Definition at line 134 of file TBasketSQL.cxx.

ReadBasketBytes()

Int_t TBasketSQL::ReadBasketBytes ( Long64_t  pos, TFile *  file  )

virtual

See TBasket::ReadBasketBytes. This is not implemented in TBasketSQL.

Definition at line 125 of file TBasketSQL.cxx.

Update()

void TBasketSQL::Update ( Int_t  offset, Int_t  skipped  )

virtual

See TBasket::Update.

Reimplemented from TBasket.

Definition at line 143 of file TBasketSQL.cxx.

Member Data Documentation

fInsertQuery

TString* TBasketSQL::fInsertQuery

protected

Definition at line 40 of file TBasketSQL.h.

fResultPtr

TSQLResult** TBasketSQL::fResultPtr

protected

Definition at line 38 of file TBasketSQL.h.

fRowPtr

TSQLRow** TBasketSQL::fRowPtr

protected

Definition at line 39 of file TBasketSQL.h.

Libraries for TBasketSQL:

---

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

• tree/tree/inc/TBasketSQL.h
• tree/tree/src/TBasketSQL.cxx