Logo ROOT  
Reference Guide
TBasketSQL Class Reference

Implement TBasket for a SQL backend.

Definition at line 30 of file TBasketSQL.h.

Public Member Functions

 TBasketSQL ()
 Default constructor. More...
 
 TBasketSQL (const char *name, const char *title, TBranch *branch, TSQLResult **rs, TString *insert_query, std::vector< Int_t > *vc, TSQLRow **row)
 Regular constructor. More...
 
 ~TBasketSQL ()
 Destructor. More...
 
void CreateBuffer (const char *name, TString title, std::vector< Int_t > *vc, TBranch *branch, TSQLResult **rs)
 Create a TSQLBuffer for this basket. More...
 
TSQLResultGetResultSet ()
 
void PrepareBasket (Long64_t entry)
 Prepare the basket for the next entry. More...
 
virtual Int_t ReadBasketBuffers (Long64_t pos, Int_t len, TFile *file)
 See TBasket::ReadBasketBuffers. This is not implemented in TBasketSQL. More...
 
virtual Int_t ReadBasketBytes (Long64_t pos, TFile *file)
 See TBasket::ReadBasketBytes. This is not implemented in TBasketSQL. More...
 
virtual void Reset ()
 See TBasket::Reset. More...
 
void Update (Int_t offset, Int_t skipped)
 See TBasket::Update. More...
 
- Public Member Functions inherited from TBasket
 TBasket ()
 Default contructor. More...
 
 TBasket (const char *name, const char *title, TBranch *branch)
 Basket normal constructor, used during writing. More...
 
 TBasket (TDirectory *motherDir)
 Constructor used during reading. More...
 
virtual ~TBasket ()
 Basket destructor. More...
 
virtual void AdjustSize (Int_t newsize)
 Increase the size of the current fBuffer up to newsize. More...
 
Long64_t CopyTo (TFile *to)
 Copy the basket of this branch onto the file to. More...
 
virtual void DeleteEntryOffset ()
 Delete fEntryOffset array. More...
 
virtual Int_t DropBuffers ()
 Drop buffers of this basket if it is not the current basket. More...
 
TBranchGetBranch () const
 
Int_t GetBufferSize () const
 
Int_tGetDisplacement () const
 
Int_tGetEntryOffset ()
 
Int_t GetEntryPointer (Int_t Entry)
 Get pointer to buffer for internal entry. More...
 
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. More...
 
virtual void MoveEntries (Int_t dentries)
 Remove the first dentries of this basket, moving entries at dentries to the start of the buffer. More...
 
Int_t ReadBasketBuffers (Long64_t pos, Int_t len, TFile *file)
 Read basket buffers in memory and cleanup. More...
 
Int_t ReadBasketBytes (Long64_t pos, TFile *file)
 Read basket buffers in memory and cleanup. More...
 
void SetBranch (TBranch *branch)
 
void SetNevBufSize (Int_t n)
 
virtual void SetReadMode ()
 Set read mode of basket. More...
 
virtual void SetWriteMode ()
 Set write mode of basket. More...
 
void Update (Int_t newlast)
 
virtual Int_t WriteBuffer ()
 Write buffer of this basket on the current file. More...
 
- Public Member Functions inherited from TKey
 TKey ()
 TKey default constructor. More...
 
 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. More...
 
 TKey (const TObject *obj, const char *name, Int_t bufsize, TDirectory *motherDir)
 Create a TKey object for a TObject* and fill output buffer. More...
 
 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. More...
 
 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. More...
 
 TKey (Long64_t pointer, Int_t nbytes, TDirectory *motherDir=0)
 Create a TKey object to read keys. More...
 
 TKey (TDirectory *motherDir)
 TKey default constructor. More...
 
 TKey (TDirectory *motherDir, const TKey &orig, UShort_t pidOffset)
 Copy a TKey from its original directory to the new 'motherDir'. More...
 
virtual ~TKey ()
 TKey default destructor. More...
 
virtual void Browse (TBrowser *b)
 Read object from disk and call its Browse() method. More...
 
virtual void Delete (Option_t *option="")
 Delete an object from the file. More...
 
virtual void DeleteBuffer ()
 Delete key buffer(s). More...
 
virtual void FillBuffer (char *&buffer)
 Encode key header into output buffer. More...
 
virtual char * GetBuffer () const
 
TBufferGetBufferRef () const
 
virtual const char * GetClassName () const
 
Short_t GetCycle () const
 Return cycle number associated to this key. More...
 
const TDatimeGetDatime () const
 
TFileGetFile () const
 Returns file to which key belong. More...
 
virtual const char * GetIconName () const
 Title can keep 32x32 xpm thumbnail/icon of the parent object. More...
 
Short_t GetKeep () const
 Returns the "KEEP" status. More...
 
Int_t GetKeylen () const
 
TDirectoryGetMotherDir () 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). More...
 
Int_t GetVersion () const
 
virtual void IncrementPidOffset (UShort_t offset)
 Increment fPidOffset by 'offset'. More...
 
Bool_t IsFolder () const
 Check if object referenced by the key is a folder. More...
 
virtual void Keep ()
 Set the "KEEP" status. More...
 
virtual void ls (Bool_t current) const
 List Key contents. More...
 
virtual void ls (Option_t *option="") const
 List Key contents. More...
 
virtual void Print (Option_t *option="") const
 Print key contents. More...
 
virtual Int_t Read (TObject *obj)
 To read an object from the file. More...
 
virtual void ReadBuffer (char *&buffer)
 Decode input buffer. More...
 
virtual Bool_t ReadFile ()
 Read the key structure from the file. More...
 
void ReadKeyBuffer (char *&buffer)
 Decode input buffer. More...
 
virtual TObjectReadObj ()
 To read a TObject* from the file. More...
 
template<typename T >
T * ReadObject ()
 To read an object (non deriving from TObject) from the file. More...
 
virtual voidReadObjectAny (const TClass *expectedClass)
 To read an object (non deriving from TObject) from the file. More...
 
virtual TObjectReadObjWithBuffer (char *bufferRead)
 To read a TObject* from bufferRead. More...
 
virtual void SetBuffer ()
 
void SetMotherDir (TDirectory *dir)
 
virtual void SetParent (const TObject *parent)
 Set parent in key buffer. More...
 
virtual Int_t Sizeof () const
 Return the size in bytes of the key header structure. More...
 
virtual Int_t WriteFile (Int_t cycle=1, TFile *f=0)
 Write the encoded object supported by this key. More...
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
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. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
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). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Protected Attributes

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

Private Member Functions

 TBasketSQL (const TBasketSQL &)
 
TBasketSQLoperator= (const TBasketSQL &)
 

Additional Inherited Members

- Public Types inherited from TBasket
enum  EIOBits : Char_t { EIOBits::kGenerateOffsetMap = BIT(0), EIOBits::kSupported = kGenerateOffsetMap }
 
enum  EUnsupportedIOBits : Char_t { EUnsupportedIOBits::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 Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Static Public Attributes inherited from TBasket
static constexpr int kIOBitCount = 1
 
- 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. More...
 
virtual void Create (Int_t nbytes, TFile *f=0)
 Create a TKey object of specified size. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual Int_t WriteFileKeepBuffer (TFile *f=0)
 Write the encoded object supported by this key. More...
 
- 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). More...
 
void MakeZombie ()
 

#include <TBasketSQL.h>

Inheritance diagram for TBasketSQL:
[legend]

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.

◆ Reset()

void TBasketSQL::Reset ( )
virtual

See TBasket::Reset.

Reimplemented from TBasket.

Definition at line 143 of file TBasketSQL.cxx.

◆ Update()

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

See TBasket::Update.

Reimplemented from TBasket.

Definition at line 150 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:
[legend]

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