Summary
-------
Controller that gives users rql read/ write capabilities. To have token
authentication, install `cubicweb_signedrequest <https://forge.extranet.logilab.fr/cubicweb/cubes/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
Raw data
{
"_id": null,
"home_page": "https://forge.extranet.logilab.fr/cubicweb/cubes/cubicweb-rqlcontroller",
"name": "cubicweb-rqlcontroller",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "LOGILAB S.A. (Paris, FRANCE)",
"author_email": "contact@logilab.fr",
"download_url": "https://files.pythonhosted.org/packages/97/05/18935f0ff4d72ab34e811415a077c9ecaf581eb1c17085dc04513eb549f9/cubicweb-rqlcontroller-1.0.0.tar.gz",
"platform": null,
"description": "Summary\n-------\n\nController that gives users rql read/ write capabilities. To have token\nauthentication, install `cubicweb_signedrequest <https://forge.extranet.logilab.fr/cubicweb/cubes/signedrequest>`_.\n\n\nSample usage\n------------\n\nUsers of this service must perform a HTTP POST request to its endpoint,\nthat is the base url of the CubicWeb application instance appended with\nthe \"rqlio/1.0\" url path.\n\nThe posted data must use the `application/json` or `multipart/form-data`.\nFor the `application/json` MIME type, the posted data must contain a list of\npairs of the form `(rql_string, rql_args)`, where:\n\n* `rql_string` is any valid RQL query that may contain mapping keys with\n their usual form\n\n* `rql_args` is a dictionary, whose keys are the mapping keys from\n `rql_string`, and the values can be:\n\n - actual values\n\n - string references to a previous RQL query's result, with the\n assumption that the referenced RQL query returns a single line and\n single column rset; under such conditions, a string reference\n must be \"__rXXX\" where `XXX` is the (0-based) index of the RQL query in\n the json-encoded list of queries.\n\nThe HTTP request's response (in case where there is no error), is a\njson-encoded list. Its length is the number of RQL queries in the request,\nand each element contains the json-encoded result set rows from the\ncorresponding query.\n\nIn case of an error, a json object with a `reason` key will explain the\nproblem.\n\nPython client example using python-requests::\n\n import requests\n import json\n\n args = [('INSERT CWUser U: U login %(l)s, U upassword %(p)s',\n {'l': 'Babar', 'p': 'cubicweb rulez & 42'}),\n\n ('INSERT CWGroup G: G name \"pachyderms\"', {}),\n\n ('SET U in_group G WHERE U eid %(u)s, G eid %(g)s',\n {'u': '__r0', 'g': '__r1'})\n ]\n\n resp = requests.post('https://myinstance.example.com/rqlio/1.0'),\n data=json.dumps(args),\n headers={'Content-Type': 'application/json'})\n assert resp.status_code == 200\n",
"bugtrack_url": null,
"license": "LGPL",
"summary": "restfull rql edition capabilities",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://forge.extranet.logilab.fr/cubicweb/cubes/cubicweb-rqlcontroller"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6d0fb3fa58ee2b32ab18d2b937e7b6c76ced7bdcc2f6d6c28cc50d32df44d448",
"md5": "4144c8ac4465ce6515b7fd7dc8ab4bdf",
"sha256": "4f6c0a6723f2f1a021997c92b909739ef1e1d385b3ad35715f9fb57ee63638f4"
},
"downloads": -1,
"filename": "cubicweb_rqlcontroller-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4144c8ac4465ce6515b7fd7dc8ab4bdf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10058,
"upload_time": "2023-07-10T14:00:26",
"upload_time_iso_8601": "2023-07-10T14:00:26.590556Z",
"url": "https://files.pythonhosted.org/packages/6d/0f/b3fa58ee2b32ab18d2b937e7b6c76ced7bdcc2f6d6c28cc50d32df44d448/cubicweb_rqlcontroller-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "970518935f0ff4d72ab34e811415a077c9ecaf581eb1c17085dc04513eb549f9",
"md5": "74fa69eebaeff44b121c1735a4e166d0",
"sha256": "1edd8784a1bcfa54e83b6233410a7848efa9f2f8a490698c5f459c99dd9f79d9"
},
"downloads": -1,
"filename": "cubicweb-rqlcontroller-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "74fa69eebaeff44b121c1735a4e166d0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9309,
"upload_time": "2023-07-10T14:00:28",
"upload_time_iso_8601": "2023-07-10T14:00:28.005136Z",
"url": "https://files.pythonhosted.org/packages/97/05/18935f0ff4d72ab34e811415a077c9ecaf581eb1c17085dc04513eb549f9/cubicweb-rqlcontroller-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-10 14:00:28",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cubicweb-rqlcontroller"
}
JSON