Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • DM/dm-docs
  • hammonds/dm-docs
  • hparraga/dm-docs
3 results
Show changes
Showing
with 844 additions and 0 deletions
#!/usr/bin/env python
from dm.common.constants import dmStatus
DM_EXCEPTION_MAP = {
dmStatus.DM_ERROR : 'dmException.DmException',
dmStatus.DM_INTERNAL_ERROR : 'internalError.InternalError',
dmStatus.DM_COMMUNICATION_ERROR : 'communicationError.CommunicationError',
dmStatus.DM_CONFIGURATION_ERROR : 'configurationError.ConfigurationError',
dmStatus.DM_AUTHORIZATION_ERROR : 'authorizationError.AuthorizationError',
dmStatus.DM_AUTHENTICATION_ERROR : 'authenticationError.AuthenticationError',
dmStatus.DM_DB_ERROR : 'dbError.DbError',
dmStatus.DM_URL_ERROR : 'urlError.UrlError',
dmStatus.DM_INVALID_ARGUMENT : 'invalidArgument.InvalidArgument',
dmStatus.DM_INVALID_REQUEST : 'invalidRequest.InvalidRequest',
dmStatus.DM_INVALID_SESSION : 'invalidSession.InvalidSession',
dmStatus.DM_COMMAND_FAILED : 'commandFailed.CommandFailed',
dmStatus.DM_OBJECT_NOT_FOUND : 'objectNotFound.ObjectNotFound',
dmStatus.DM_OBJECT_ALREADY_EXISTS : 'objectAlreadyExists.ObjectAlreadyExists',
dmStatus.DM_INVALID_OBJECT_STATE : 'invalidObjectState.InvalidObjectState',
dmStatus.DM_FILE_PROCESSING_ERROR : 'fileProcessingError.FileProcessingError',
}
#!/usr/bin/env python
import cherrypy
from cherrypy import HTTPError
class DmHttpError(HTTPError):
def __init__ (self, httpCode, httpError, dmEx):
HTTPError.__init__(self, httpCode, httpError)
self.dmException = dmEx
def set_response(self):
HTTPError.set_response(self)
cherrypy.response.headers['Dm-Status-Code'] = self.dmException.getErrorCode()
cherrypy.response.headers['Dm-Status-Message'] = self.dmException.getErrorMessage()
cherrypy.response.headers['Dm-Exception-Type'] = self.dmException.getExceptionType()
#!/usr/bin/env python
#
# File processing error class.
#
#######################################################################
from dm.common.constants import dmStatus
from dm.common.exceptions.dmException import DmException
#######################################################################
class FileProcessingError(DmException):
def __init__ (self, error='', **kwargs):
DmException.__init__(self, error, dmStatus.DM_FILE_PROCESSING_ERROR, **kwargs)
#!/usr/bin/env python
#
# Internal error class.
#
#######################################################################
from dm.common.constants import dmStatus
from dm.common.exceptions.dmException import DmException
#######################################################################
class InternalError(DmException):
def __init__ (self, error='', **kwargs):
DmException.__init__(self, error, dmStatus.DM_INTERNAL_ERROR, **kwargs)
#!/usr/bin/env python
#
# Invalid argument error class.
#
#######################################################################
from dm.common.constants import dmStatus
from dm.common.exceptions.dmException import DmException
#######################################################################
class InvalidArgument(DmException):
def __init__ (self, error='', **kwargs):
DmException.__init__(self, error, dmStatus.DM_INVALID_ARGUMENT, **kwargs)
#!/usr/bin/env python
#
# Object not found error class.
#
#######################################################################
from dm.common.constants import dmStatus
from dm.common.exceptions.dmException import DmException
#######################################################################
class ObjectNotFound(DmException):
def __init__ (self, error='', **kwargs):
DmException.__init__(self, error, dmStatus.DM_INVALID_OBJECT_STATE, **kwargs)
#!/usr/bin/env python
#
# Invalid request error class.
#
#######################################################################
from dm.common.constants import dmStatus
from dm.common.exceptions.dmException import DmException
#######################################################################
class InvalidRequest(DmException):
def __init__ (self, error='', **kwargs):
DmException.__init__(self, error, dmStatus.DM_INVALID_REQUEST, **kwargs)
#!/usr/bin/env python
#
# Invalid session error class.
#
#######################################################################
from dm.common.constants import dmStatus
from dm.common.exceptions.dmException import DmException
#######################################################################
class InvalidSession(DmException):
def __init__ (self, error='', **kwargs):
DmException.__init__(self, error, dmStatus.DM_INVALID_SESSION, **kwargs)
#!/usr/bin/env python
#
# Object already exists error class.
#
#######################################################################
from dm.common.constants import dmStatus
from dm.common.exceptions.dmException import DmException
#######################################################################
class ObjectAlreadyExists(DmException):
def __init__ (self, error='', **kwargs):
DmException.__init__(self, error, dmStatus.DM_OBJECT_ALREADY_EXISTS, **kwargs)
#!/usr/bin/env python
#
# Object not found error class.
#
#######################################################################
from dm.common.constants import dmStatus
from dm.common.exceptions.dmException import DmException
#######################################################################
class ObjectNotFound(DmException):
def __init__ (self, error='', **kwargs):
DmException.__init__(self, error, dmStatus.DM_OBJECT_NOT_FOUND, **kwargs)
#!/usr/bin/env python
#
# Url error class.
#
#######################################################################
from dm.common.constants import dmStatus
from dm.common.exceptions.dmException import DmException
#######################################################################
class UrlError(DmException):
def __init__ (self, error='', **kwargs):
DmException.__init__(self, error, dmStatus.DM_URL_ERROR, **kwargs)
#!/usr/bin/env python
import copy
import types
import re
from dm.common.objects.dmObject import DmObject
from dm.common.exceptions.dmException import DmException
from dm.common.mongodb.api.dmMongoDbApi import DmMongoDbApi
from dm.common.mongodb.impl.datasetCollection import DatasetCollection
from dm.common.mongodb.api.fileMongoDbApi import FileMongoDbApi
from dm.common.mongodb.api.dmMongoDbApi import DmMongoDbApi
from dm.common.objects.datasetMetadata import DatasetMetadata
class DatasetMongoDbApi(DmMongoDbApi):
SYSTEM_KEY_LIST = ['_id', 'datasetName', 'experimentName']
USE_DATASET_NAME_KEY = '_useDatasetName'
USE_EXPERIMENT_NAME_KEY = '_useDatasetName'
def __init__(self):
DmMongoDbApi.__init__(self)
self.datasetCollection = DatasetCollection(self.dbClient)
self.fileMongoDbApi = FileMongoDbApi()
@DmMongoDbApi.executeDbCall
def addExperimentDataset(self, datasetInfo, **kwargs):
datasetInfo2 = self.getMongoDict(datasetInfo)
dbDatasetMetadata = self.datasetCollection.addByUniqueKeys(datasetInfo2)
return self.toDmObject(dbDatasetMetadata, DatasetMetadata)
@DmMongoDbApi.executeDbCall
def getDatasets(self, queryDict={}, returnFieldDict=DatasetCollection.ALL_FIELDS_DICT, **kwargs):
queryDict2 = self.getMongoDict(queryDict)
return self.listToDmObjects(self.datasetCollection.findByQueryDict(queryDict2, returnFieldDict), DatasetMetadata)
@DmMongoDbApi.executeDbCall
def getDatasetById(self, id, **kwargs):
dbDatasetMetadata = self.datasetCollection.findById(id)
return self.toDmObject(dbDatasetMetadata, DatasetMetadata)
@DmMongoDbApi.executeDbCall
def getExperimentDataset(self, experimentName, datasetName, **kwargs):
queryDict = { 'datasetName' : datasetName, 'experimentName' : experimentName }
dbDatasetMetadata = self.datasetCollection.findByUniqueKeys(queryDict)
return self.toDmObject(dbDatasetMetadata, DatasetMetadata)
@DmMongoDbApi.executeDbCall
def getExperimentDatasets(self, experimentName, queryDict={}, returnFieldDict=DatasetCollection.ALL_FIELDS_DICT, **kwargs):
queryDict2 = copy.copy(queryDict)
queryDict2['experimentName'] = experimentName
return self.getDatasets(queryDict2, returnFieldDict)
@DmMongoDbApi.executeDbCall
def updateDatasetById(self, datasetInfo, **kwargs):
datasetInfo2 = self.getMongoDict(datasetInfo)
dbDatasetMetadata = self.datasetCollection.updateById(datasetInfo2)
return self.toDmObject(dbDatasetMetadata, DatasetMetadata)
@DmMongoDbApi.executeDbCall
def updateExperimentDataset(self, datasetInfo, **kwargs):
datasetInfo2 = self.getMongoDict(datasetInfo)
dbDatasetMetadata = self.datasetCollection.updateByUniqueKeys(datasetInfo2)
return self.toDmObject(dbDatasetMetadata, DatasetMetadata)
@DmMongoDbApi.executeDbCall
def updateOrAddExperimentDataset(self, datasetInfo, **kwargs):
datasetInfo2 = self.getMongoDict(datasetInfo)
dbDatasetMetadata = self.datasetCollection.updateOrAddByUniqueKeys(datasetInfo2)
return self.toDmObject(dbDatasetMetadata, DatasetMetadata)
@DmMongoDbApi.executeDbCall
def getExperimentDatasetFiles(self, experimentName, datasetName, returnFieldDict=DatasetCollection.ALL_FIELDS_DICT, **kwargs):
self.getLogger().debug('Looking for dataset %s (experiment %s)' % (datasetName, experimentName))
datasetDict = self.getExperimentDataset(experimentName, datasetName).getDictRep(DmObject.ALL_KEYS)
del datasetDict['id']
useDatasetName = kwargs.get(self.USE_DATASET_NAME_KEY, False)
if not useDatasetName:
del datasetDict['datasetName']
useExperimentName = kwargs.get(self.USE_EXPERIMENT_NAME_KEY, False)
if not useExperimentName:
del datasetDict['experimentName']
self.getLogger().debug('Converting dataset dict to regex patterns')
ignoreCase = kwargs.get(self.REGEX_IGNORE_CASE_KEY, True)
queryDict = self.convertStringsToRegex(datasetDict, ignoreCase)
return self.fileMongoDbApi.getExperimentFiles(experimentName, queryDict, returnFieldDict)
#######################################################################
# Testing.
if __name__ == '__main__':
api = DatasetMongoDbApi()
import time
t = long(time.time())
datasetName = 'd-%s' % t
experimentName = 'exp-01'
datasetInfo = {'datasetName' : datasetName, 'intKey' : 1, 'doubleKey' : 2.0, 'stringKey' : 'myString' , 'experimentName' : experimentName}
dataset = api.updateOrAddExperimentDataset(datasetInfo)
print '\nADDED DATASET\n', dataset
datasets = api.getDatasets()
print '\nDATASETS: \n', api.getDatasets()
for dataset in datasets:
print dataset.getDictRep()
#import re
#regex = re.compile("file0.*", re.IGNORECASE)
datasetName = 'dataset1'
datasetInfo = {'datasetName' : datasetName, 'experimentName' : experimentName, 'fileName' : 'file0.*'}
dataset = api.updateOrAddExperimentDataset(datasetInfo)
print '\nUPDATED DATASET\n', dataset
print '\nDATASET FILES\n', api.getExperimentDatasetFiles(experimentName, datasetName)
#!/usr/bin/env python
import copy
import types
import re
from dm.common.exceptions.dmException import DmException
from dm.common.utility.loggingManager import LoggingManager
from dm.common.mongodb.impl.mongoDbManager import MongoDbManager
class DmMongoDbApi:
""" Base Mongo DB API class. """
SYSTEM_KEY_LIST = ['_id']
REGEX_IGNORE_KEY_LIST = ['_id']
REGEX_IGNORE_CASE_KEY = '_ignoreCase'
def __init__(self):
self.logger = LoggingManager.getInstance().getLogger(self.__class__.__name__)
self.dbClient = MongoDbManager.getInstance().getDbClient()
# Decorator for all DB methods
@classmethod
def executeDbCall(cls, func):
def dbCall(*args, **kwargs):
try:
try:
return func(*args, **kwargs)
except DmException, ex:
raise
except Exception, ex:
cls.getLogger().exception('%s' % ex)
raise DmException(exception=ex)
finally:
# For now, do nothing
pass
return dbCall
@classmethod
def getLogger(cls):
logger = LoggingManager.getInstance().getLogger(cls.__name__)
return logger
@classmethod
def listToDmObjects(cls, mongoDbObjectList, dmObjectClass):
dmObjectList = []
for o in mongoDbObjectList:
dmObjectList.append(cls.toDmObject(o, dmObjectClass))
return dmObjectList
@classmethod
def toDmObject(cls, mongoDbObject, dmObjectClass):
cls.scrubMongoDbObject(mongoDbObject)
return dmObjectClass(mongoDbObject)
@classmethod
def scrubMongoDbObject(cls, mongoDbObject):
for key in cls.SYSTEM_KEY_LIST:
if mongoDbObject.has_key(key):
# Remove leading underscore
if key.startswith('_'):
newKey = key[1:]
mongoDbObject[newKey] = str(mongoDbObject[key])
del mongoDbObject[key]
@classmethod
def getMongoDict(cls, dict):
mongoDict = copy.copy(dict)
for key in cls.SYSTEM_KEY_LIST:
# if dictionary has system key, do not modify it
if mongoDict.has_key(key):
continue
# If provided dict has system key without leading underscore
# modify it
key2 = key[1:]
if mongoDict.has_key(key2):
mongoDict[key] = mongoDict[key2]
del mongoDict[key2]
return mongoDict
@classmethod
def convertStringsToRegex(cls, dict, ignoreCase=True):
dict2 = copy.copy(dict)
for (key,value) in dict2.items():
if key in cls.REGEX_IGNORE_KEY_LIST:
continue
elif type(value) == types.StringType or type(value) == types.UnicodeType:
cls.getLogger().debug('Converting to regex: %s for key %s' % (value,key))
if ignoreCase:
regex = re.compile(value, re.IGNORECASE)
else:
regex = re.compile(value)
dict2[key] = regex
return dict2
#######################################################################
# Testing.
if __name__ == '__main__':
api = DmMongoDbApi()
#!/usr/bin/env python
import copy
import types
import re
from dm.common.exceptions.dmException import DmException
from dm.common.mongodb.api.dmMongoDbApi import DmMongoDbApi
from dm.common.mongodb.impl.fileCollection import FileCollection
from dm.common.mongodb.api.dmMongoDbApi import DmMongoDbApi
from dm.common.objects.fileMetadata import FileMetadata
from dm.common.exceptions.invalidRequest import InvalidRequest
class FileMongoDbApi(DmMongoDbApi):
SYSTEM_KEY_LIST = ['_id', 'experimentFilePath', 'experimentName']
def __init__(self):
DmMongoDbApi.__init__(self)
self.fileCollectionDict = {}
def getFileCollection(self, experimentName):
fileCollection = self.fileCollectionDict.get(experimentName)
if not fileCollection:
fileCollection = FileCollection(self.dbClient, experimentName)
self.fileCollectionDict[experimentName] = fileCollection
return fileCollection
@classmethod
def getAndCheckExperimentName(cls, dictObject):
experimentName = dictObject.get('experimentName')
cls.checkExperimentName(experimentName)
return experimentName
@classmethod
def checkExperimentName(cls, experimentName):
if not experimentName:
raise InvalidRequest('Experiment name has not been provided.')
@DmMongoDbApi.executeDbCall
def addExperimentFile(self, fileInfo, **kwargs):
experimentName = self.getAndCheckExperimentName(fileInfo)
fileInfo2 = self.getMongoDict(fileInfo)
dbFileMetadata = self.getFileCollection(experimentName).addByUniqueKeys(fileInfo2)
return self.toDmObject(dbFileMetadata, FileMetadata)
@DmMongoDbApi.executeDbCall
def getExperimentFiles(self, experimentName, queryDict={}, returnFieldDict=FileCollection.ALL_FIELDS_DICT, **kwargs):
self.checkExperimentName(experimentName)
queryDict2 = self.getMongoDict(queryDict)
self.getLogger().debug('Converting query dict to regex patterns')
ignoreCase = kwargs.get(self.REGEX_IGNORE_CASE_KEY, True)
queryDict2 = self.convertStringsToRegex(queryDict2, ignoreCase)
return self.listToDmObjects(self.getFileCollection(experimentName).findByQueryDict(queryDict2, returnFieldDict), FileMetadata)
@DmMongoDbApi.executeDbCall
def getExperimentFileById(self, experimentName, id, **kwargs):
self.checkExperimentName(experimentName)
dbFileMetadata = self.getFileCollection(experimentName).findById(id)
return self.toDmObject(dbFileMetadata, FileMetadata)
@DmMongoDbApi.executeDbCall
def getExperimentFile(self, experimentName, experimentFilePath, **kwargs):
self.checkExperimentName(experimentName)
queryDict = { 'experimentFilePath' : experimentFilePath, 'experimentName' : experimentName }
dbFileMetadata = self.getFileCollection(experimentName).findByUniqueKeys(queryDict)
return self.toDmObject(dbFileMetadata, FileMetadata)
@DmMongoDbApi.executeDbCall
def updateExperimentFileById(self, fileInfo, **kwargs):
experimentName = self.getAndCheckExperimentName(fileInfo)
fileInfo2 = self.getMongoDict(fileInfo)
dbFileMetadata = self.getFileCollection(experimentName).updateById(fileInfo2)
return self.toDmObject(dbFileMetadata, FileMetadata)
@DmMongoDbApi.executeDbCall
def updateExperimentFile(self, fileInfo, **kwargs):
experimentName = self.getAndCheckExperimentName(fileInfo)
fileInfo2 = self.getMongoDict(fileInfo)
dbFileMetadata = self.getFileCollection(experimentName).updateByUniqueKeys(fileInfo2)
return self.toDmObject(dbFileMetadata, FileMetadata)
@DmMongoDbApi.executeDbCall
def updateOrAddExperimentFile(self, fileInfo, **kwargs):
experimentName = self.getAndCheckExperimentName(fileInfo)
fileInfo2 = self.getMongoDict(fileInfo)
dbFileMetadata = self.getFileCollection(experimentName).updateOrAddByUniqueKeys(fileInfo2)
return self.toDmObject(dbFileMetadata, FileMetadata)
#######################################################################
# Testing.
if __name__ == '__main__':
from dm.common.mongodb.impl.mongoDbManager import MongoDbManager
mgr = MongoDbManager.getInstance()
mgr.dbName = 'dm'
api = FileMongoDbApi()
experimentFilePath = 'file02'
experimentName = 'exp-01'
fileInfo = {'experimentFilePath' : experimentFilePath, 'intKey' : 1, 'doubleKey' : 2.0, 'stringKey' : 'myString' , 'experimentName' : experimentName}
file = api.updateOrAddExperimentFile(fileInfo)
print '\nADDED FILE\n', file
import time
t = long(time.time())
experimentFilePath = 'f-%s' % t
experimentName = 'exp-01'
fileInfo = {'experimentFilePath' : experimentFilePath, 'intKey' : 1, 'doubleKey' : 2.0, 'stringKey' : 'myString' , 'dictKey' : {'a' : 'A', 'b' : 'B', 'c' : 3}, 'experimentName' : experimentName}
file = api.updateOrAddExperimentFile(fileInfo)
print '\nADDED FILE\n', file
files = api.getFiles()
for file in files:
print 'FILE: %s\n' % file.getDictRep()
fileInfo = {'experimentFilePath' : experimentFilePath, 'experimentName' : experimentName, 'intKey' : 101}
file = api.updateExperimentFile(fileInfo)
print '\nUPDATED FILE\n', file
print '\nFILES FOR EXPERIMENT exp1: \n', api.getExperimentFiles(experimentName)
print '\nFILES FOR EXPERIMENT exp1 with experimentFilePath=file01: \n', api.getExperimentFiles(experimentName, queryDict={'experimentFilePath':'file02'})
#!/usr/bin/env python
from dm.common.utility.loggingManager import LoggingManager
from dm.common.exceptions.invalidArgument import InvalidArgument
from dm.common.exceptions.objectAlreadyExists import ObjectAlreadyExists
from dm.common.exceptions.objectNotFound import ObjectNotFound
from dm.common.exceptions.dbError import DbError
from dmMongoCollection import DmMongoCollection
class DatasetCollection(DmMongoCollection):
"""Class responsible for updating dataset collection in mongo db."""
UNIQUE_KEYS_LIST = [ '_id', 'datasetName', 'experimentName' ]
ITEM_TYPE = 'dataset'
def __init__(self, dbClient):
DmMongoCollection.__init__(self, 'datasets', dbClient)
#######################################################################
# Testing
if __name__ == '__main__':
from dmMongoClient import DmMongoClient
mongo = DmMongoClient('dm')
datasetCollection = DatasetCollection(mongo)
datasetInfo = {'name' : 'ds-001',
'owner' : 'sv',
'experimentName' : 'exp-001',
'voltage' : { 'gt' : 400},
'current' : { 'lt' : 100},
}
#print datasetCollection.add(datasetInfo)
print datasetCollection.updateByName(datasetInfo)
print datasetCollection.findByName('ds-001')
print datasetCollection.findByQueryDict({'dataset' : 'ds-001'}, {'owner' : 1})
#!/usr/bin/env python
from pymongo import MongoClient
from dm.common.utility.loggingManager import LoggingManager
from dm.common.exceptions.dbError import DbError
class DmMongoClient(object):
""" DM MongoDB client."""
def __init__(self, dbName, dbUri='mongodb://localhost:27017/'):
self.logger = LoggingManager.getInstance().getLogger(self.__class__.__name__)
try:
self.client = MongoClient(dbUri)
self.db = self.client[dbName]
self.dbName = dbName
except Exception, ex:
self.logger.error('Cannot connect to Mongo DB: %s' % ex)
raise DbError(exception=ex)
def drop(self, collection):
return self.db[collection].drop()
def insert(self, collection, dict, **kwargs):
return self.db[collection].insert(dict, **kwargs)
def update(self, collection, query, update, **kwargs):
key = '.'.join((collection, str(update['$set'].keys()[0])))
return self.db[collection].update(query, update, **kwargs)
def findOne(self, collection, criteria={}):
return self.db[collection].find_one(criteria)
def find(self, collection, criteria={}, projections={}):
return self.db[collection].find(criteria, projections)
def findAsList(self, collection, criteria={}, projections={}):
return list(self.db[collection].find(criteria, projections))
def getCollectionNames(self):
return self.db.collection_names()
#######################################################################
# Testing
if __name__ == '__main__':
mongo = DmMongoClient('dm')
mongo.drop('students')
id = mongo.insert('students', { '_id' : 1, 'semester' : 1, 'grades' : [ 70, 87, 90 ] })
print 'Student #1 id: ', id
id = mongo.insert('students', { '_id' : 2, 'semester' : 1, 'grades' : [ 90, 88, 92 ] } )
print 'Student #2 id: ', id
print mongo.findAsList('students', criteria={ 'semester' : 1, 'grades': { '$gte' : 85 } }, projections={ 'grades.$' : 1 } )
result = mongo.update('files', {'_id' : 2}, {'$set' : {'experimentId' : 2}}, upsert=True)
print result
doc = mongo.findOne('files', {'experimentId' : 1})
print doc
docs = mongo.find('files', projections={'experimentId' : 1})
print docs.count()
docs = mongo.findAsList('files', projections={'experimentId' : 1})
print docs
print 'Collection names: ', mongo.getCollectionNames()
mongo.drop('students')
print 'Collection names (after drop): ', mongo.getCollectionNames()
#!/usr/bin/env python
from bson.objectid import ObjectId
from dm.common.utility.loggingManager import LoggingManager
from dm.common.exceptions.invalidArgument import InvalidArgument
from dm.common.exceptions.objectAlreadyExists import ObjectAlreadyExists
from dm.common.exceptions.objectNotFound import ObjectNotFound
from dm.common.exceptions.dbError import DbError
class DmMongoCollection(object):
"""Base collection in mongo db."""
ALL_FIELDS_DICT = {'__return_only_id__' : False}
UNIQUE_KEYS_LIST = []
ITEM_TYPE = 'item'
def __init__(self, collectionName, dbClient):
self.logger = LoggingManager.getInstance().getLogger(self.__class__.__name__)
self.dbClient = dbClient
# Collection consists of items: [item]
self.collectionName = collectionName
# items => item
self.itemName = self.ITEM_TYPE
# item => Item
self.capitalizedItemName = self.itemName.capitalize()
@classmethod
def getUniqueKeys(cls):
return cls.UNIQUE_KEYS_LIST
def findByKey(self, key, value):
dbObjectDict = self.dbClient.findOne(self.collectionName, {key : value})
if dbObjectDict is None:
raise ObjectNotFound('%s with %s=%s not found.' % (self.capitalizedItemName, key, value))
return dbObjectDict
def findByKeys(self, keyList, queryDict):
for key in keyList:
if not queryDict.has_key(key):
raise InvalidArgument('%s query dictionary does not specify key %s.' % (self.capitalizedItemName, key))
dbObjectDict = self.dbClient.findOne(self.collectionName, queryDict)
if dbObjectDict is None:
raise ObjectNotFound('%s with properties %s not found.' % (self.capitalizedItemName, queryDict))
return dbObjectDict
def findByUniqueKeys(self, queryDict):
return self.findByKeys(self.UNIQUE_KEYS_LIST, queryDict)
def findById(self, id):
return self.findByKey('_id', ObjectId(id))
def findByName(self, name):
return self.findByKey(self.NAME_KEY, name)
def findByQueryDict(self, queryDict, returnFieldDict=ALL_FIELDS_DICT):
return self.dbClient.findAsList(self.collectionName, queryDict, returnFieldDict)
def listByKey(self, key):
return self.dbClient.findAsList(self.collectionName, {}, {key : True})
def listById(self):
return self.dbClient.findAsList(self.collectionName, {}, {})
def listByName(self):
return self.findByName('_name')
def listByKeys(self, keyList):
returnFieldDict = {}
for key in keyList:
returnFieldDict[key] = True
return self.dbClient.findAsList(self.collectionName, {}, returnFieldDict)
def listAll(self):
return self.dbClient.findAsList(self.collectionName, {}, DmMongoCollection.ALL_FIELDS_DICT)
def __addDbObject(self, objectDict):
try:
self.dbClient.insert(self.collectionName, objectDict)
except Exception, ex:
self.logger.error('Cannot add %s with %s set to %s: %s' % (self.itemName, key, value, ex))
raise DbError(exception=ex)
return objectDict
def addByKey(self, key, objectDict):
value = objectDict.get(key)
if value is None:
raise InvalidArgument('%s info dictionary does not specify key %s.' % (self.capitalizedItemName, key))
dbObjectDict = self.dbClient.findOne(self.collectionName, {key : value})
if dbObjectDict is not None:
raise ObjectAlreadyExists('%s with %s set to %s already exists.' % (self.capitalizedItemName, key, value))
return self.__addDbObject(objectDict)
def addByName(self, objectDict):
return self.addByKey('_name', objectDict)
def addByKeys(self, keyList, objectDict):
queryDict = {}
for key in keyList:
value = objectDict.get(key)
if value is None:
raise InvalidArgument('%s info dictionary does not specify key %s.' % (self.capitalizedItemName, key))
queryDict[key] = value
dbObjectDict = self.dbClient.findOne(self.collectionName, queryDict)
if dbObjectDict is not None:
raise ObjectAlreadyExists('%s with properties %s already exists.' % (self.capitalizedItemName, queryDict))
return self.__addDbObject(objectDict)
def addByUniqueKeys(self, objectDict):
return self.addByKeys(self.UNIQUE_KEYS_LIST, objectDict)
def __updateDbObject(self, dbObjectDict, objectDict):
try:
id = dbObjectDict.get('_id')
dbObjectDict.update(objectDict)
self.dbClient.update(self.collectionName,
{'_id' : id},
{'$set' : dbObjectDict})
except Exception, ex:
self.logger.error('Cannot update %s %s with %s: %s' % (self.itemName, dbObjectDict, objectDict, ex))
raise DbError(exception=ex)
return dbObjectDict
def updateByKey(self, key, objectDict):
value = objectDict.get(key)
if value is None:
raise InvalidArgument('%s info dictionary does not specify key %s.' % (self.capitalizedItemName, key))
dbObjectDict = self.dbClient.findOne(self.collectionName, {key : value})
if dbObjectDict is None:
raise ObjectNotFound('%s with %s set to %s not found.' % (self.capitalizedItemName, key, value))
return self.__updateDbObject(dbObjectDict, objectDict)
def updateByKeys(self, keyList, objectDict):
queryDict = {}
for key in keyList:
value = objectDict.get(key)
if value is None:
raise InvalidArgument('%s info dictionary does not specify key %s.' % (self.capitalizedItemName, key))
queryDict[key] = value
dbObjectDict = self.dbClient.findOne(self.collectionName, queryDict)
if dbObjectDict is None:
raise ObjectNotFound('%s with properties %s not found.' % (self.capitalizedItemName, queryDict))
return self.__updateDbObject(dbObjectDict, objectDict)
def updateByUniqueKeys(self, objectDict):
return self.updateByKeys(self.UNIQUE_KEYS_LIST, objectDict)
def updateById(self, objectDict):
# Convert 'id' to '_id' key if needed, and wrap it with ObjectId()
if not objectDict.has_key('_id') and objectDict.has_key('id'):
objectDict['_id'] = ObjectId(objectDict['id'])
del objectDict['id']
return self.updateByKey('_id', objectDict)
def updateByName(self, objectDict):
return self.updateByKey('_name', objectDict)
def updateOrAddByKey(self, key, objectDict):
value = objectDict.get(key)
if value is None:
raise InvalidArgument('%s info dictionary does not specify key %s.' % (self.capitalizedItemName, key))
dbObjectDict = self.dbClient.findOne(self.collectionName, {key : value})
if dbObjectDict is None:
return self.__addDbObject(objectDict)
else:
return self.__updateDbObject(dbObjectDict, objectDict)
def updateOrAddByKeys(self, keyList, objectDict):
queryDict = {}
for key in keyList:
value = objectDict.get(key)
if value is None:
raise InvalidArgument('%s info dictionary does not specify key %s.' % (self.capitalizedItemName, key))
queryDict[key] = value
dbObjectDict = self.dbClient.findOne(self.collectionName, queryDict)
if dbObjectDict is None:
return self.__addDbObject(objectDict)
else:
return self.__updateDbObject(dbObjectDict, objectDict)
def updateOrAddByUniqueKeys(self, objectDict):
return self.updateOrAddByKeys(self.UNIQUE_KEYS_LIST, objectDict)
def updateOrAddByName(self, objectDict):
return self.updateOrAddByKey('_name', objectDict)
#######################################################################
# Testing
if __name__ == '__main__':
from dmMongoClient import DmMongoClient
from bson.objectid import ObjectId
mongo = DmMongoClient('dm')
fileCollectionImpl = DmMongoCollection('files', mongo)
#objectDict = {'name' : 'xyz-001', 'experiment' : 'myexp-D', 'update' : 'sv2', 'locationList' : '[/opt/xyz, /data/xyz]'}
#print fileCollectionImpl.updateOrAddByKey('name', objectDict)
#f = fileCollectionImpl.findByKey('name', 'xyz-001')
#print f
#print type(f['_id'])
#print fileCollectionImpl.findById('556de0059e058b0ef4c4413b')
#print fileCollectionImpl.findByQueryDict({'experiment' : 'exp-001'}, {'locationList' : 1})
#print 'LIST BY ID\n', fileCollectionImpl.listById()
#print 'LIST BY NAME\n', fileCollectionImpl.listByKey('name')
print 'LIST ALL\n'
for f in fileCollectionImpl.listAll():
print 'FILE: %s\n' % f
#print fileCollectionImpl.updateByKeys(['name', 'experiment'], objectDict)