rooFDObj
class description - source file - inheritance tree
public:
rooFDObj rooFDObj()
rooFDObj rooFDObj(void* imp)
rooFDObj rooFDObj(const rooFDObj&)
virtual void ~rooFDObj()
virtual void Browse(TBrowser* b)
Bool_t change(const TString& bootFile, const TString& lockServer, Int_t fdNumber = 0, FILE* fp = stdout) const
TClass* Class()
Bool_t close()
Bool_t contains(rooDBItr& itr, Int_t openMode = kooNoOpen) const
Bool_t convertObjects()
Bool_t decodeSchema(const TString& pswd) const
Bool_t dumpCatalog(FILE* fp = stdout, Int_t fileNameFormat = kooHostLocal, Bool_t printLabels = kTRUE) const
Bool_t encodeSchema(const TString& pswd) const
Bool_t exist(const TString& bootFile, Int_t openMode = kooNoOpen)
virtual const char* GetName() const
virtual TClass* IsA() const
virtual Bool_t IsFolder()
Bool_t isValid() const
Bool_t lock(Int_t lockMode) const
TString lockServerName() const
TString name() const
ULong_t number() const
Bool_t open(const TString& bootFile, Int_t openMode = kooRead, Bool_t recover = kFALSE) const
Int_t openMode() const
rooFDObj& operator=(const rooFDObj&)
UInt_t pageSize() const
virtual void Print(Option_t* option)
virtual void ShowMembers(TMemberInspector& insp, char* parent)
virtual void Streamer(TBuffer& b)
Bool_t tidy(FILE* fp = stdout, const TString& hostName, const TString& pathName) const
virtual Int_t typeN() const
virtual TString typeName() const
Bool_t update() const
Bool_t upgradeObjects()
rooFDObj corresponds to ooHandle(ooFDObj) class
Handle class for fedrated databases
rooFDObj()
default ctor.
rooFDObj(const rooFDObj& fd)
copy ctor.
Bool_t change(const TString& bootFile,
const TString& lockServer,
Int_t fdNumber,
FILE* fp) const
bootFile - path to the boot file of the federated database.
The default value is "".
lockServer - name of the new host running the lock server
process for this federated database. The default
value is "".
fdNumber - new identifier of the federated database
fp - pointer to the transcript file to which the
system name of the federated database, the
lock server host name, and the identifier of the
federated database are echoed before and after
the change member function is invoked. The
default value is stdout.
Change federated database attributes. If any of the
first three arguments has a value other than zero, then the catalog
information corresponding to that argument is set to the specified
value. Catalog information corresponding to arguments with zero
values is not modified. After calling change, the old boot file remains.
You must delete this file manually.
When using the rooFDObj::change member function
to modify the attributes of a federated database, you must strictly
follow these steps:
1. Shut down the lock server.
2. Run in single-user mode (call ooNoLock in your program).
3. Start a transaction.
4. Open the federated database for update.
5. Invoke the rooFDObj::change member function.
6. Commit the transaction.
7. Exit from the process.
8. Restart the lock server.
The federated database attributes are in a new and different state after
the rooFDObj::change member function has been run. For this reason, it
is mandatory to exit from the process immediately after changing
attributes.
Bool_t close()
Closes the referenced federated database
Bool_t contains(rooDBItr& itr,Int_t openMode) const
Initializes the iterator itr to traverse all databases in the referenced
federated database. Objects of the iteration are automatically opened in
the mode specified by openMode. The default is kooNoOpen (do not
open the federated database automatically).
Bool_t convertObjects()
Convert all objects affected by schema evolution operations within a
federated database to their current class representations. Schema
information used for object conversion will be purged as a side-effect of
this operation.
Bool_t decodeSchema(const TString& pswd) const
OBSOLETE ???
Bool_t dumpCatalog(FILE* fp,
Int_t fileNameFormat,
Bool_t printLabels) const
fp - pointer to the output file that stores the
federated database attribute information
normally printed in the standard output by the
oodumpcatalog tool. The default value is stdout.
fileNameFormat - flag indicating the format of the printed file
name. The default value is kooHostLocal,
which formats the file name as host:localPath. The
other allowable value is kooNative, which
formats the file name as a full path name or
just a local name (for example, /net/object/usr/mnt/ed/dsgn/up.FDB).
printLabels - specifies whether or not to label the file in the
output. The default is oocTrue, which specifies
that each file name in the output is labeled.
Bool_t encodeSchema(const TString& pswd) const
OBSOLETE ???
Bool_t exist(const TString& bootFile,Int_t openMode)
Tests for the existence of the federated database specified by boot file
bootFile. If the federated database exists and openMode is
kooRead or kooUpdate, the federated database is opened and its object
reference or handle is initialized. If openMode is not kooNoOpen, and
exist returns kFALSE, the object either does not exist or the object
exists but is not accessible.
Bool_t isValid() const
Checks the validity of an object reference or handle.
Bool_t lock(Int_t lockMode) const
Explicitly locks the federated database and propagates the lock to any
objects associated through links that have lock propagation enabled.
TString lockServerName() const
Retrieves the name of the host running the lock
server process for the federated database.
TString name() const
Returns the system name of the referenced federated database. The
string is statically allocated by the member function and is overwritten
with each invocation (you may wish to copy the string to locally
allocated storage rather than storing the pointer).
ULong_t number() const
Retrieves the identifier of the federated database.
Bool_t open(const TString& bootFile,
Int_t openMode,
Bool_t recover) const
bootFile - path to the boot file of the federated database.
The default value is "". You can specify this
path with or without a host name. If you specify
it as a host path, use the format host::path.
openMode - specifies the open mode for the federated database.
Valid values for openMode are the constants kooRead
and kooUpdate. The default open mode is kooRead.
recover - specifies whether automatic recovery on the local
host should be performed on application startup.
Initializes object reference or handle to reference the federated
database specified by bootFilePath. The federated database is
opened in the mode specified by openMode.
Any number of processes may open the same federated database for
either read or update access as long as no other process has obtained
an explicit lock on it using the lock member function. If a process has
obtained an explicit read lock, any other process may open the
federated database for read access. If a process has obtained an explicit
update lock, no other process may open it.
If you intend to alter the contents (any objects it contains) of a
federated database, you must open it for update access, or any changes
made will be lost.
Int_t openMode() const
Returns the mode in which the currently referenced federated database
has been opened.
UInt_t pageSize() const
Obtains the page size of the federated database.
Bool_t tidy(FILE* fp,
const TString& hostName,
const TString& pathName) const
fp - pointer to the file in which to store the audit
report generated by running the member function
hostName - specifies the name of the host machine on
which to create the scratch file.
pathName - specifies the path for the scratch file.
Tidies all of the databases in a federated database.
Int_t typeN() const
Type number of the federated database.
TString typeName() const
Returns the string "ooFDObj"
Bool_t update() const
Opens the referenced federated database in update access mode.
Bool_t upgradeObjects()
Convert objects using stored schema evolution information and
user-defined functions (if any).
After object conversion is complete, the evolved classes are marked so
that applications created using the evolved schema can access the
federated database. Also, unneeded stored schema evolution
information is deleted upon successful completion.
void Browse(TBrowser *b)
browse databases in this federated database
Inline Functions
rooFDObj rooFDObj(const rooFDObj&)
rooFDObj& operator=(const rooFDObj&)
void Print(Option_t* option)
const char* GetName() const
Bool_t IsFolder()
TClass* Class()
TClass* IsA() const
void ShowMembers(TMemberInspector& insp, char* parent)
void Streamer(TBuffer& b)
void ~rooFDObj()
Author: Valeriy Onuchin 11/09/2000
ROOT page - Class index - Top of the page
This page has been automatically generated. If you have any comments or suggestions about the page layout send a mail to ROOT support, or contact the developers with any questions or problems regarding ROOT.