exasol-script-languages-container-tool 0.16.0

Script Languages Container Tool

Script-Languages-Container-Tool

Overview

The Script-Languages-Container-Tool (exaslct) is the build tool for the script language container. You can build, export and upload script-language container from so-called flavors which are description how to build the script language container. You can find pre-defined flavors in the script-languages-release repository. There we also described how you could customize these flavors to your needs.

In a Nutshell

Prerequisites

For installation

In order to install this tool, your system needs to provide the following prerequisites:

• Software
  • Linux
    • bash >= 4.2
  • MacOsX
    • bash > 3.2
  • coreutils
    • sha512sum
    • sed
  • curl
  • Python 3 (>=3.8)
    • Pip

For running

In order to use this tool, your system needs to fulfill the following prerequisites:

• Software

  • Linux
    • bash >= 4.2
    • coreutils
      • readlink with -f option
      • realpath
      • dirname
  • MacOsX (Please see limitations on MacOsX)
    • bash >= 3.2
    • coreutils
      • greadlink with -f option
      • realpath
      • dirname
  • Docker >= 17.05
    • with support for multi-stage builds required
    • host volume mounts need to be allowed

• System Setup

  • We recommend at least 50 GB free disk space on the partition where Docker stores its images, on linux Docker typically stores the images at /var/lib/docker.
  • For the partition where the output directory (default: ./.build_output) is located we recommend additionally at least 10 GB free disk space.

Further, prerequisites might be necessary for specific tasks. These are listed under the corresponding section.

Installation

You have two options to use this project:

• as a pure Python project
• using the start scripts which pull the correct container image from Dockerhub and execute it within the Docker container

Pure Python

Find the wheel package for a specific release under assets.

Install the python package with python3 -m pip install https://github.com/exasol/script-languages-container-tool/releases/download/$VERSION/exasol_script_languages_container_tool-$VERSION-py3-none-any.whl. Replace $VERSION with the latest version or the specific version you are interested in.

Starter scripts

You need to install the Python package only once to install the starter scripts (see the previous section).

Install the starter scripts which allow to run exaslct within a docker image: python3 -m exasol_script_languages_container_tool.main install-starter-scripts --install-path $YOUR_INSTALL_PATH

This will create a subfolder with the scripts itself and a symlink exaslct in $YOUR_INSTALL_PATH, which can be used as entry point.

Usage

For simplicity the following examples use the starter script version (exaslct). If you want to use the pure Python package, simply replace exaslct with python3 -m exasol_script_languages_container_tool.main in all examples.

How to build an existing flavor?

Create the language container and export it to the local file system

./exaslct export --flavor-path=flavors/<flavor-name> --export-path <export-path>

or upload it directly into the BucketFS (currently http only, https follows soon)

./exaslct upload --flavor-path=flavors/<flavor-name> --database-host <hostname-or-ip> --bucketfs-port <port> \ 
                   --bucketfs-username w --bucketfs-password <password>  --bucketfs-name <bucketfs-name> \
                   --bucket-name <bucket-name> --path-in-bucket <path/in/bucket>

Once it is successfully uploaded, it will print the ALTER SESSION statement that can be used to activate the script language container in the database.

How to activate a script language container in the database

If you uploaded a container manually, you can generate the language activation statement with

./exaslct generate-language-activation --flavor-path=flavors/<flavor-name> --bucketfs-name <bucketfs-name> \
                                         --bucket-name <bucket-name> --path-in-bucket <path/in/bucket> --container-name <container-name>

where <container-name> is the name of the uploaded archive without its file extension. To activate the language, execute the generated statement in your database session to activate the container for the current session or system wide.

This command will print a SQL statement to activate the language similar to the following one:

ALTER SESSION SET SCRIPT_LANGUAGES='<LANGUAGE_ALIAS>=localzmq+protobuf:///<bucketfs-name>/<bucket-name>/<path-in-bucket>/<container-name>?lang=<language>#buckets/<bucketfs-name>/<bucket-name>/<path-in-bucket>/<container-name>/exaudf/exaudfclient[_py3]';

Please, refer to the User Guide for more detailed information, how to use exalsct.

Features

• Build a script language container as docker images
• Export a script language container as an archive which can be used for extending Exasol UDFs
• Upload a script language container as an archive to the Exasol DB's BucketFS
• Generating the activation command for a script language container
• Can use Docker registries, such as Docker Hub, as a cache to avoid rebuilding image without changes
• Can push Docker images to Docker registries
• Run tests for you container against an Exasol DB (docker-db or external db)

Limitations

• Caution with symbolic links: If you use symbolic links inside any directory of the command line arguments they must not point to files or directories outside the root of the path of the command line argument (i.e. --flavor-path ./flavors/my_flavor/ => There must be no symbolic link inside ./flavors/my_flavor point to anywhere outside of ./flavors/my_flavor). Background: Local directories paths must be mounted manually to the docker container. We currently support only the mounting of the given command line arguments, but we do not analyze the content of those directories. Plan is to fix this limitation with #35

MacOsX Limitations

• On MacOsX all arguments (flavors path, output directory, etc.) must point to locations within the current directory (background is that the MacOsX version does not support mount binding additional directories).

Table of Contents

Information for Users

• User Guide
• Changelog

Information for Developers

• Developer Guide
• Dependencies