From ed31610ac73eec1dea880bf31c3c83b7354436e1 Mon Sep 17 00:00:00 2001 From: stmandl Date: Wed, 16 Jan 2019 09:49:48 +0000 Subject: [PATCH] updated documentation [ci skip] --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 42b73ddbd..88fade57f 100644 --- a/README.md +++ b/README.md @@ -29,26 +29,26 @@ For running the tests you also need * Docker with privileged mode ## Quickstart -1. Choose a flavor. Currently we have several pre-defined flavors available, e.g., `mini`, `standard` and `conda`. +1. Choose a flavor. Currently we have several pre-defined flavors available, e.g., `mini-EXASOL-6.0.0`, and `standard-EXASOL-6.1.0`. This project supports different versions of script language environments with different libraries and languages. We call these versions _flavors_. The pre-defined flavors can be modified and extended to create customized flavors. Each pre-defined flavor has its own set of Docker build-files in a corresponding subfolder of [flavors](flavors). 2. Create the language container. We choose to use the `mini` flavor which is the smallest of the currently available flavors and which only support the Python language. ```bash -$ ./build --flavor=mini +$ ./build --flavor=mini-EXASOL-6.0.0 ``` -(on Mac OS X, use `./build -f mini`) +(on Mac OS X, use `./build -f mini-EXASOL-6.0.0`) 3. Export it into a standalone archive ```bash -$ ./export --flavor=mini +$ ./export --flavor=mini-EXASOL-6.0.0 ``` -(on Mac OS X, use `./export -f mini`) -This creates the file `mini.tar.gz`. +(on Mac OS X, use `./export -f mini-EXASOL-6.0.0`) +This creates the file `mini-EXASOL-6.0.0.tar.gz`. Optionally, you can run some automated tests for your flavor by using ```bash -$ ./test_complete --flavor=mini +$ ./test_complete --flavor=mini-EXASOL-6.0.0 ``` (on Mac OS X you need to have pip installed for this to work) If the test fails with the message @@ -59,11 +59,11 @@ then run `stop_dockerdb` and restart the test. 4. Upload the file into bucketfs. For the following example we assume the password `pwd` and the bucketname `funwithudfs` in a bucketfs that is running on port `2580` on machine `192.168.122.158` ```bash -curl -v -X PUT -T mini.tar.gz w:pwd@192.168.122.158:2580/funwithudfs/mini.tar.gz +curl -v -X PUT -T mini-EXASOL-6.0.0.tar.gz w:pwd@192.168.122.158:2580/funwithudfs/mini-EXASOL-6.0.0.tar.gz ``` -5. In SQL you activate the Python implementation of the flavor `mini` by using a statement like this +5. In SQL you activate the Python implementation of the flavor `mini-EXASOL-6.0.0` by using a statement like this ```sql -ALTER SESSION SET SCRIPT_LANGUAGES='MYPYTHON=localzmq+protobuf:///bucketfsname/funwithudfs/mini?lang=python#buckets/bucketfsname/funwithudfs/mini/exaudf/exaudfclient'; +ALTER SESSION SET SCRIPT_LANGUAGES='MYPYTHON=localzmq+protobuf:///bucketfsname/funwithudfs/mini-EXASOL-6.0.0?lang=python#buckets/bucketfsname/funwithudfs/mini-EXASOL-6.0.0/exaudf/exaudfclient'; ``` Now the script language `MYPYTHON` can be used to define a script, e.g., ``` @@ -79,7 +79,7 @@ select small_test(); ``` 6. Afterwards you may choose to remove the Docker images for this flavor. This can be done as follows: ```bash -./clean --flavor=mini +./clean --flavor=mini-EXASOL-6.0.0 ``` Please note that this script does not delete the Linux image that is used as basis for the images that were build in the previous steps.