python.AtlCoolTool Namespace Reference

Classes
class	AtlCoolTool
class	Info
class	InfoList

Functions
	expandConnectString (connectString)
	connect (connectString, verbose=False)
	byteSize (spec)

Variables
dict	typeSizes

Function Documentation

byteSize()

python.AtlCoolTool.byteSize

(

spec

)

Determines the (effective) byte size of an AttributeListSpecification.
This does not account for any extra size for the specification's own
structure but just the byte sizes of the attributes. In other words an
AttributeListSpecification with a single 'int' fields will report a byte
size of 4.

Definition at line 112 of file AtlCoolTool.py.

def byteSize( spec ):
    """
    Determines the (effective) byte size of an AttributeListSpecification.
    This does not account for any extra size for the specification's own
    structure but just the byte sizes of the attributes. In other words an
    AttributeListSpecification with a single 'int' fields will report a byte
    size of 4.
    """
    size = 0
    for i in spec:
        size += typeSizes[i.storageType().id()]
    return size
 
 
 

connect()

python.AtlCoolTool.connect	(		connectString,
			verbose = False )

Connects to the given database and returns a tuple
   database, connectString
where 'database' is a cool.IDatabase object and 'connectString' is the
possibly expanded connectString that 'database' is based on.

This expansion can occur when a connect string without a containing
'://' is specified. In this case the string is interpreted as a sqlite
file name and rewritten to a RAL compliant format:

    TEST.db  --> 'sqlite://;schema=TEST.db;dbname=TEST'
    TEST     --> 'sqlite://;schema=TEST;dbname=TEST'

The filename can have a '.db' suffix which will be stripped for the
'dbname' part of the connect string. Other suffixes will not be recognized.

Note that the COOL database inside the file must have the same name as the
base of the filename for this shortcut to work. Storing a COOL database
MYTEST in a file mytest.db will not work.

Set verbose to True to obtain an error print out.

Definition at line 45 of file AtlCoolTool.py.

def connect( connectString, verbose = False):
    """
    Connects to the given database and returns a tuple
       database, connectString
    where 'database' is a cool.IDatabase object and 'connectString' is the
    possibly expanded connectString that 'database' is based on.
    
    This expansion can occur when a connect string without a containing
    '://' is specified. In this case the string is interpreted as a sqlite
    file name and rewritten to a RAL compliant format:
    
        TEST.db  --> 'sqlite://;schema=TEST.db;dbname=TEST'
        TEST     --> 'sqlite://;schema=TEST;dbname=TEST'
    
    The filename can have a '.db' suffix which will be stripped for the
    'dbname' part of the connect string. Other suffixes will not be recognized.
    
    Note that the COOL database inside the file must have the same name as the
    base of the filename for this shortcut to work. Storing a COOL database
    MYTEST in a file mytest.db will not work.
    
    Set verbose to True to obtain an error print out.
    """
    connectString = expandConnectString( connectString )
    debug=False
    if (';readoracle' in connectString):
        # new default is forceOracle - but giving keyword explicitly
        # forces debug printout
        connectString=connectString.replace(';readoracle','')
        debug=True
    if (';readsqlite' in connectString):
        connectString=connectString.replace(';readsqlite','')
        debug=True
    try:
        dbSvc = cool.DatabaseSvcFactory.databaseService()
        readonly=True
        # frontier/logical cannot do update connections - only real dbs
        if ('oracle' in connectString or 'mysql' in connectString or 'sqlite' in connectString): readonly=False
        db=AtlCoolLib.indirectOpen(connectString,readonly,debug)
    except Exception as e:
        if 'The database does not exist' in str(e):
            print ("Creating new database")
            db = dbSvc.createDatabase( connectString )
        else:
            if verbose: print ('Error while connecting:', str(e))
            db = None
    return db, connectString
 
 

expandConnectString()

python.AtlCoolTool.expandConnectString

(

connectString

)

Expands a connect string.

This expansion can occur when a connect string without a containing
'://' or not in the format 'alias/DBNAME' is specified. In this case
the string is interpreted as a sqlite file name and rewritten to a
COOL compliant format:

    TEST.db  --> 'sqlite://;schema=TEST.db;dbname=TEST'
    TEST     --> 'sqlite://;schema=TEST;dbname=TEST'

The filename can have a '.db' suffix which will be stripped for the
'dbname' part of the connect string. Other suffixes will not be recognized.

Actually for ATLAS, a simple string without / is interpreted as a database
instance name within the SQLite file mycool.db, for consistency with
AtlCoolLib behavior

Definition at line 12 of file AtlCoolTool.py.

def expandConnectString( connectString ):
    """
    Expands a connect string.
    
    This expansion can occur when a connect string without a containing
    '://' or not in the format 'alias/DBNAME' is specified. In this case
    the string is interpreted as a sqlite file name and rewritten to a
    COOL compliant format:
    
        TEST.db  --> 'sqlite://;schema=TEST.db;dbname=TEST'
        TEST     --> 'sqlite://;schema=TEST;dbname=TEST'
    
    The filename can have a '.db' suffix which will be stripped for the
    'dbname' part of the connect string. Other suffixes will not be recognized.
 
    Actually for ATLAS, a simple string without / is interpreted as a database
    instance name within the SQLite file mycool.db, for consistency with
    AtlCoolLib behavior
    """
    if connectString.find( '://' ) == -1:
        if connectString.endswith( '.db' ):
            base = connectString[:-3]
        elif match("[a-zA-Z0-9_-]+/[A-Z0-9_-]{1,8}",connectString):
            # it is an alias/DBNAME
            return connectString
        else:
            base = connectString
        #return ( 'sqlite://;schema=%s;dbname=%s' ) % ( connectString, base )
        return ('sqlite://;schema=mycool.db;dbname=%s' % base)
    else:
        return connectString
 
 

Variable Documentation

typeSizes

dict python.AtlCoolTool.typeSizes

Initial value:

=  { cool.StorageType.Bool : 1,
              cool.StorageType.UChar : 1,
              cool.StorageType.Int16 : 2,
              cool.StorageType.UInt16 : 2,
              cool.StorageType.Int32 : 4,
              cool.StorageType.UInt32 : 4,
              cool.StorageType.UInt63 : 8,
              cool.StorageType.Int64 : 8,
              cool.StorageType.Float : 4,
              cool.StorageType.Double : 8,
              cool.StorageType.String255 : 255,
              cool.StorageType.String4k : 4000,
              cool.StorageType.String64k : 65535,
              cool.StorageType.String16M : 16777215,
              cool.StorageType.Blob64k : 65535,
              cool.StorageType.Blob16M : 16777215,
            }

Definition at line 94 of file AtlCoolTool.py.