Skip to main content

batch endpoint for guillotina

Project description

Guillotina Batch Docs

This package simple provides a @batch endpoint to Guillotina which allows you to group multiple requests into one.

By default all the requests use a single transaction that is commited when all the requests finish successfully. If ?eager-commit=true is provided, each request will be committed independently.


Just add a few lines to your config.yml::

{"applications": ["guillotina_batch"]}


The @batch endpoint takes a array of batch definitions taking the following parameters:

  • method:str
  • endpoint:str
  • headers:object[str, str]
  • payload:object

For example::

POST /db/container/@batch [{
    "method": "POST",
    "endpoint": "path/to/object/@sharing",
    "payload": {
        "prinperm": [{
            "principal": "user1",
            "permission": "guillotina.AccessContent",
            "setting": "AllowSingle"
    "method": "POST",
    "endpoint": "path/to/object2/@sharing",
    "payload": {
        "prinperm": [{
            "principal": "user1",
            "permission": "guillotina.AccessContent",
            "setting": "AllowSingle"

1.0.5 (2018-11-19)

  • Added GET param eager-commit [masipcat]

1.0.4 (2018-07-06)

  • Copy future object from batch request to request

1.0.3 (2018-06-27)

  • Including parent request's security in batched view [lferran]

1.0.2 (2018-06-27)

  • try again

1.0.1 (2018-06-13)

  • markdown fix

1.0.0 (2018-06-11)

  • Initial release [vangheem]

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
guillotina_batch-1.0.5-py3-none-any.whl (6.6 kB) Copy SHA256 hash SHA256 Wheel py3
guillotina_batch-1.0.5.tar.gz (6.3 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page