Page MenuHomec4science
Files F94062825

storage.py
No OneTemporary
Actions

File Metadata

Created
Tue, Dec 3, 14:49

storage.py
View Options

# -*- coding: utf-8 -*-
## This file is part of Invenio.
## Copyright (C) 2013 CERN.
##
## Invenio is free software; you can redistribute it and/or
## modify it under the terms of the GNU General Public License as
## published by the Free Software Foundation; either version 2 of the
## License, or (at your option) any later version.
##
## Invenio is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Invenio; if not, write to the Free Software Foundation, Inc.,
## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
"""
invenio.utils.jsonalchemy.storage
---------------------------
Record storage interface.
"""
class Storage(object):
"""
Defatul storage interface
"""
#TODO: set return values on success and error and setup a log function
def __init__(self, model, **kargs):
"""docstring for __init__"""
raise NotImplementedError()
def save_one(self, json, id=None):
"""Stores one json in the storage system"""
raise NotImplementedError()
def save_many(self, jsons, ids=None):
"""
Stores many json in the storage system, as elements on the
iterable jsons.
"""
raise NotImplementedError()
def update_one(self, json, id=None):
"""
Updates one json , if id is None a field representing the id is
expected inside the json object.
"""
raise NotImplementedError()
def update_many(self, jsons, ids=None):
"""Update many json objects following the same rule as update_one"""
raise NotImplementedError()
def get_one(self, id):
"""Returns the json matching the id"""
raise NotImplementedError()
def get_many(self, ids):
"""Returns an iterable of json objects which id is inside ids"""
raise NotImplementedError()
def get_field_values(ids, field, repetitive_values=True, count=False,
include_recid=False, split_by=0):
"""
Returns a list of field values for field for the given ids.
:param ids: list (or iterable) of integers
:param repetitive_values: if set to True, returns all values even if
they are doubled. If set to False, then return unique values only.
:param count: in combination with repetitive_values=False, adds to the
result the number of occurrences of the field.
:param split: specifies the size of the output.
"""
raise NotImplementedError()
def get_fields_values(ids, fields, repetitive_values=True, count=False,
include_recid=False, split_by=0):
"""
As in :meth:`get_field_values` but in this case returns a dictionary with each
of the fields and the list of field values.
"""
raise NotImplementedError()

Event Timeline

c4science · Help