API¶

class quaerere_base_flask.schemas.ArangoDBFilterSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]¶

:py:attr: filters : :py:class: ~.fields.List: condition
:py:attr: variables : :py:class: ~.fields.Dict: variables used to bind

class quaerere_base_flask.schemas.ArangoDBMetadataSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]¶

Schema for ArangoDB insert/update metadata

:py:attr: _id : :py:class: marshmallow.fields.String : required=True: Id of document
:py:attr: _key : :py:class: ~marshmallow.fields.String : required=True: Key of document
:py:attr: _rev : :py:class: ~.fields.String : required=True: Current revision of document
:py:attr: _old_rev : :py:class: ~.fields.String: Previous revision of document

class quaerere_base_flask.views.BaseView[source]¶

Base class for defining a Restful access method to a resource

BaseView provides basic Restful access to a resource defined by a given data object and schema.

Current supported functionality

index()
get()
post()
put()
patch()
delete()
find()

Supported callbacks

pre and post create (HTTP POST)
pre and post read (HTTP GET)
pre and post update (HTTP PUT and PATCH)
pre and post delete (HTTP DELETE)

__init__()[source]¶

_post_create_callback(resp_data)[source]¶

Call back function ran after object is created in data store

Parameters:	resp_data – Response data
Returns:

_post_delete_callback(key, resp_data)[source]¶

Call back function ran before object is deleted in data store

Parameters:	key – Object key resp_data – Response data
Returns:

_post_read_callback(key, resp_data)[source]¶

Call back function ran after object is read from data store

Parameters:	key – Object key resp_data – Response data
Returns:

_post_update_callback(key, resp_data, http_method)[source]¶

Call back function ran after object is updated in data store

Parameters:	key – Object key resp_data – Response data http_method – ‘patch’ or ‘put’
Returns:

_pre_create_callback(req_data)[source]¶

Call back function ran before object is created in data store

Parameters:	req_data – Request data
Returns:

_pre_delete_callback(key)[source]¶

Call back function ran before object is deleted in data store

Parameters:	key – Object key
Returns:

_pre_read_callback(key)[source]¶

Call back function ran before object is read from data store

Parameters:	key – Object key
Returns:

_pre_update_callback(key, req_data, http_method)[source]¶

Call back function ran before object is updated in data store

Parameters:	key – Object key req_data – Request data http_method – ‘patch’ or ‘put’
Returns:

delete(key)[source]¶

Delete an object

Parameters:	key – Key of object
Returns:	DB Delete metadata

find()[source]¶

Find an object based on criteria

Returns:	objects

get(key)[source]¶

Get a specific object by key

Parameters:	key – Primary key of an object to retrieve
Returns:	Object of provided key

index()[source]¶

Returns all objects

Returns:	All objects of the model type

patch(key)[source]¶

Update specific data elements

Parameters:	key – Key of object
Returns:	DB Update metadata

post()[source]¶

Create a new object

Returns:	DB Insert metadata

put(key)[source]¶

Update all fields on an object

Parameters:	key – Key of object
Returns:	DB Update metadata

quaerere_base_flask.views.register_views(app, view_module, version, prefix='api')[source]¶

Registers FlaskView classes to the Flask app passed as argument

Parameters:	app (flask.Flask) – Flask app instance version (str) – API version string prefix (str or None) – String to prepend to API path
Returns: