restfull rql edition capabilities
Project description
Summary
Controller that gives users rql read/ write capabilities. To have token authentication, install cubicweb_signedrequest.
Sample usage
Users of this service must perform a HTTP POST request to its endpoint, that is the base url of the CubicWeb application instance appended with the “rqlio/1.0” url path.
The posted data must use the application/json or multipart/form-data. For the application/json MIME type, the posted data must contain a list of pairs of the form (rql_string, rql_args), where:
rql_string is any valid RQL query that may contain mapping keys with their usual form
rql_args is a dictionary, whose keys are the mapping keys from rql_string, and the values can be:
actual values
string references to a previous RQL query’s result, with the assumption that the referenced RQL query returns a single line and single column rset; under such conditions, a string reference must be “__rXXX” where XXX is the (0-based) index of the RQL query in the json-encoded list of queries.
The HTTP request’s response (in case where there is no error), is a json-encoded list. Its length is the number of RQL queries in the request, and each element contains the json-encoded result set rows from the corresponding query.
In case of an error, a json object with a reason key will explain the problem.
Python client example using python-requests:
import requests
import json
args = [('INSERT CWUser U: U login %(l)s, U upassword %(p)s',
{'l': 'Babar', 'p': 'cubicweb rulez & 42'}),
('INSERT CWGroup G: G name "pachyderms"', {}),
('SET U in_group G WHERE U eid %(u)s, G eid %(g)s',
{'u': '__r0', 'g': '__r1'})
]
resp = requests.post('https://myinstance.example.com/rqlio/1.0'),
data=json.dumps(args),
headers={'Content-Type': 'application/json'})
assert resp.status_code == 200
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cubicweb-rqlcontroller-0.10.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | bd5e205efb6e66030fdf6b62c0f0a88c72b937db8e464877b2265a5a883f4ed5 |
|
| MD5 | 5ae659ee2c06ad7f631b17288a287867 |
|
| BLAKE2b-256 | f46cb807e8f673874b5ca2f228ef716eb0f6bc7eee2dd1c70b55f6d11edfdb8f |
Hashes for cubicweb_rqlcontroller-0.10.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | be6d294d3cdafab2cebb6af6eebfc939415fac132764aaf04025947ca3320252 |
|
| MD5 | 85cb275916ef01b6f8ac935f93b9d5fb |
|
| BLAKE2b-256 | 3384ece7223c36b821acff9327d4ee9726c42f913f9fc7a1b52093229c3b9476 |
