Sodarcache Backend API Documentation

This document contains API documentation for the backend plugin in the sodarcache app. Included are functionalities and classes intended to be used by other applications.

Backend API

The SodarCacheAPI class contains the Sodar Cache backend API. It should be initialized with Projectroles.plugins.get_backend_api('sodar_cache').

class sodarcache.api.SodarCacheAPI

SodarCache backend API to be used by Django apps.

classmethod delete_cache(app_name=None, project=None)

Delete cache items. Optionallly limit to project and/or user.

Parameters

• app_name – Name of the app which sets the item (string)

• project – Project object (optional)

Returns

Integer (deleted item count)

Raise

ValueError if app_name is given but invalid

classmethod get_cache_item(app_name, name, project=None)

Return cached data by app_name, name (identifier) and optional project. Returns None if not found.

Parameters

• name – Item name (string)

• app_name – Name of the app which sets the item (string)

• project – Project object (optional)

Returns

JSONCacheItem object

Raise

ValueError if app_name is invalid

classmethod get_project_cache(project, data_type='json')

Return all cached data for a project.

Parameters

• project – Project object

• data_type – String stating the data type of the cache items

Returns

QuerySet

Raise

ValueError if data_type is invalid

classmethod get_update_time(app_name, name, project=None)

Return the time of the last update of a cache object as seconds since epoch.

Parameters

• name – Item name (string)

• app_name – Name of the app which sets the item (string)

• project – Project object (optional)

Returns

Float

classmethod set_cache_item(app_name, name, data, data_type='json', project=None, user=None)

Create or update and save a cache item.

Parameters

• app_name – Name of the app which sets the item (string)

• name – Item name (string)

• data – Item data (dict)

• data_type – String stating the data type of the cache items

• project – Project object (optional)

• user – User object to denote user triggering the update (optional)

Returns

JSONCacheItem object

Raise

ValueError if app_name is invalid

Raise

ValueError if data_type is invalid

classmethod update_cache(name=None, project=None, user=None)

Update items by certain name within a project by calling implemented functions in project app plugins.

Parameters

• name – Item name to limit update to (string, optional)

• project – Project object to limit update to (optional)

• user – User object to denote user triggering the update (optional)

Models

class sodarcache.models.BaseCacheItem(*args, **kwargs)

Abstract class representing a cached item

app_name

App name

date_modified

DateTime of the update

name

Identifier for the item given by the data setting app

project

Project in which the item belongs (optional)

sodar_uuid

UUID for the item

user

User who updated the item (optional)

class sodarcache.models.JSONCacheItem(*args, **kwargs)

Class representing a cached item in JSON format

exception DoesNotExist

exception MultipleObjectsReturned

data

Cached data as JSON