def get_document_by_name(
project,
typeof,
name,
institute=None,
latest_only=True
):
"""Retrieves a single document by it's name.
:param str project: Project code.
:param str typeof: Document type.
:param str name: Document name.
:param str institute: Institute code.
:param boolean latest_only: Project with which document is associated.
:returns: First matching document.
:rtype: db.models.Document
"""
qry = session.query(Document)
qry = text_filter(qry, Document.project, project)
qry = text_filter(qry, Document.typeof, typeof)
qry = text_filter(qry, Document.name, name)
if institute:
qry = text_filter(qry, Document.institute, institute)
if latest_only == True:
qry = qry.filter(Document.is_latest == True)
return qry.first()
def get_document_by_drs_keys(
project,
key_01=None,
key_02=None,
key_03=None,
key_04=None,
key_05=None,
key_06=None,
key_07=None,
key_08=None,
latest_only = True
):
"""Retrieves a single document by it's drs keys.
:param str project: Project code.
:param str key_01: DRS key 1.
:param str key_02: DRS key 2.
:param str key_03: DRS key 3.
:param str key_04: DRS key 4.
:param str key_05: DRS key 5.
:param str key_06: DRS key 6.
:param str key_07: DRS key 7.
:param str key_08: DRS key 8.
:param boolean latest_only: Flag indicating whether only the latest document is to be returned.
:returns: First matching document.
:rtype: db.models.Document
"""
qry = session.query(Document).join(DocumentDRS)
qry = text_filter(qry, Document.project, project)
if key_01:
qry = text_filter(qry, DocumentDRS.key_01, key_01)
if key_02:
qry = text_filter(qry, DocumentDRS.key_02, key_02)
if key_03:
qry = text_filter(qry, DocumentDRS.key_03, key_03)
if key_04:
qry = text_filter(qry, DocumentDRS.key_04, key_04)
if key_05:
qry = text_filter(qry, DocumentDRS.key_05, key_05)
if key_06:
qry = text_filter(qry, DocumentDRS.key_06, key_06)
if key_07:
qry = text_filter(qry, DocumentDRS.key_07, key_07)
if key_08:
qry = text_filter(qry, DocumentDRS.key_08, key_08)
if latest_only == True:
qry = qry.filter(Document.is_latest == True)
return qry.first()
def get_document_by_type(project, typeof, latest_only=True):
"""Retrieves documents by type.
:param str project: Project code.
:param str typeof: Document type.
:param boolean latest_only: Flag indicating whether to return only the latest documents.
:returns: Matching documents.
:rtype: list
"""
qry = session.query(Document)
qry = text_filter(qry, Document.project, project)
qry = text_filter(qry, Document.typeof, typeof)
if latest_only == True:
qry = qry.filter(Document.is_latest == True)
return qry.all()
def get_document_type_count(project, typeof):
"""Returns count over a project's document type.
:param str typeof: Document type.
:param str project: Project code.
:returns: List of counts over a project's document types.
:rtype: list
"""
qry = session.query(sa.func.count(Document.typeof))
qry = text_filter(qry, Document.project, project)
qry = text_filter(qry, Document.typeof, typeof)
qry = qry.group_by(Document.typeof)
counts = qry.all()
return 0 if not len(counts) else counts[0][0]
def get_documents_by_external_id(project, external_id):
"""Retrieves a list of documents with a matching external ID.
:param str project: Project code.
:param str external_id: External ID to be resolved to a document.
:returns: List of Document instances with matching external ID.
:rtype: list
"""
qry = session.query(Document).join(DocumentExternalID)
qry = text_filter(qry, Document.project, project)
qry = like_filter(qry, DocumentExternalID.external_id, external_id.upper())
return qry.all()
def get_document(uid, version, project=None):
"""Returns a Document instance by it's project, UID & version.
:param str uid: Document unique identifier.
:param str version: Document version.
:param str project: Project code.
:returns: First matching document.
:rtype: db.models.Document
"""
qry = session.query(Document)
if project:
qry = text_filter(qry, Document.project, project)
qry = qry.filter(Document.uid == unicode(uid))
if version is None or version in constants.DOCUMENT_VERSIONS:
qry = qry.order_by(Document.version.desc())
else:
qry = qry.filter(Document.version == int(version))
return qry.all() if version == constants.DOCUMENT_VERSION_ALL else qry.first()
def get_document_summaries(
project,
typeof,
version,
sub_project=None,
institute=None,
model=None,
experiment=None
):
"""Returns document summary information.
:param str project: Project code.
:param str typeof: Document type.
:param str version: Document version (latest | all).
:param str sub_project: Sub-project code.
:param str institute: Institute code.
:param str model: Model code.
:param str experiment: Experiment code.
:returns: List of matching documents.
:rtype: db.models.Document
"""
# Format params.
if version:
version = version.lower()
typeof = typeof.upper()
if model:
model = model.upper()
if experiment:
experiment = experiment.upper()
# Set query.
qry = session.query(
Document.experiment,
Document.institute,
Document.long_name,
Document.model,
Document.name,
Document.canonical_name,
Document.uid,
Document.version,
Document.alternative_name
)
# Set filters.
qry = text_filter(qry, Document.project, project)
qry = qry.filter(Document.canonical_name != u"")
if typeof != constants.DOCUMENT_TYPE_ALL:
qry = text_filter(qry, Document.typeof, typeof)
if version == constants.DOCUMENT_VERSION_LATEST:
qry = qry.filter(Document.is_latest == True)
if experiment:
qry = text_filter(qry, Document.experiment, experiment)
if institute:
qry = text_filter(qry, Document.institute, institute)
if model:
qry = text_filter(qry, Document.model, model)
if sub_project:
qry = like_filter(qry, Document.sub_projects, "<{}>".format(sub_project.lower()))
# Apply query limit.
try:
load_all = constants.MAPPED_DOCUMENT_TYPES[typeof]['loadAll']
except AttributeError:
load_all = False
if not load_all:
qry = qry.limit(session.QUERY_LIMIT)
return sort(Document, qry.all())
