Skip to content
Snippets Groups Projects
Commit 13557a17 authored by Henrik tom Wörden's avatar Henrik tom Wörden
Browse files

DOC: add doc on serverside

parent e7b7de3f
No related branches found
No related tags found
1 merge request!39DOC: add doc on serverside
Pipeline #17582 passed
......@@ -16,4 +16,5 @@ advanced usage of the Python client.
errors
data-model-interface
complex_data_models
serverside
Server Side Scripting
=====================
Some regular needed scripts, e.g. for computing a standardized analysis, might
be placed by the administrator on the same machine as the CaosDB server such
that they can be executed there, on the server side.
The execution of those scripts can also be started using the Python client.
Call a Script
~~~~~~~~~~~~~
Of course, you need to have access to the server and sufficient permissions to
run the script that you want to run. Execution is then fairly simple:
.. code:: python
from caosdb.utils.server_side_scripting import run_server_side_script
response = run_server_side_script('scriptname.py')
print(response.stderr,response.stdout)
This triggers the execution of the script ``scriptname.py``. The output of the
script (``stderr`` and ``stdout``) is returned within an response object.
If the script requires additional arguments, those can be provided after the
scriptname.
Note, that by default the script runs with your account. It has your
permissions and changes are logged as if they were done by you directly.
Testing it
~~~~~~~~~~
You can try this out using for example the ``diagnositics.py`` script (it is
also available on https://demo.indiscale.com). The script returns some
information in JSON format. You can do for example the following
.. code:: python
import json
from caosdb.utils.server_side_scripting import run_server_side_script
response = run_server_side_script('administration/diagnostics.py')
print(json.loads(response.stdout))
print(response.stderr)
Further Information
~~~~~~~~~~~~~~~~~~~
Additionally, you might have a look at https://docs.indiscale.com/caosdb-server/specification/Server-side-scripting.html
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment