Skip to main content

One command to try Exasol with AI add-ons (MCP Server + JSON Tables) — auto-selects the right setup for your OS (Windows / macOS / Linux).

Project description

exasol-quickstart

Run Exasol with AI add-ons in one command — the database, an MCP server, and JSON Tables, set up the right way for your operating system.

PyPI Python License: MIT

PyPI · GitHub


Quickstart

To try it — runs once, nothing left installed:

pipx run exasol-quickstart      # with pipx
uvx exasol-quickstart           # with uv

To keep it — installs the command so you can run it again later:

pipx install exasol-quickstart && exasol-quickstart      # with pipx
uv tool install exasol-quickstart && exasol-quickstart   # with uv

Either form detects your operating system, provisions Exasol the appropriate way, and prints the connection endpoints. No flags, no multi-step setup.

What you get

Component Endpoint Purpose
Exasol (database) 127.0.0.1:8563 — user sys / password exasol the Exasol SQL engine
MCP Server http://127.0.0.1:4896/mcp connect an LLM / MCP client to the database
JSON Tables exasol-quickstart json-tables … ingest JSON and query it as SQL

Web UI: https://127.0.0.1:8443.

Requirements

The only universal prerequisite is Python 3.9+ with pipx:

python -m pip install --user pipx
python -m pipx ensurepath        # then reopen the terminal

Beyond that, exasol-quickstart chooses how Exasol runs based on your platform:

Operating system How Exasol runs Docker
Windows Exasol Nano, in a container required (no native Windows engine exists)
macOS (Apple Silicon) Exasol Personal, in a native VM not required (experimental)
Linux Exasol Nano, in a container (native install planned) required for now

The container-based path is fully tested today; the macOS native path is experimental and not yet validated end to end.

Usage

exasol-quickstart                      # full stack: database + MCP + JSON Tables
exasol-quickstart --no-json-tables     # database + MCP only
exasol-quickstart --dry-run            # print the plan without making changes
exasol-quickstart --base <name>        # force a base: nano-docker | personal | nano-native
exasol-quickstart json-tables --help   # run the JSON Tables CLI

Stop and remove the stack:

docker rm -f exasol-quickstart-db exasol-quickstart-mcp exasol-quickstart-json-tables

Ingesting JSON

docker cp data.json exasol-quickstart-json-tables:/workspace/data.json
exasol-quickstart json-tables ingest-and-wrap --input /workspace/data.json --name demo
# then query it:  SELECT * FROM "EJT_DEMO_VIEW"."demo";

On the container path, the first run pulls the exasol/nano and exasol/mcp-server images and builds the JSON Tables image once (it compiles a small Rust engine — a few minutes). Subsequent runs are fast.

How it works

exasol-quickstart is a single front-door command that detects the platform and assembles the stack accordingly:

  • With Docker — Exasol Nano (database), the official exasol/mcp-server image, and a JSON Tables sidecar run as containers on a shared network. This path is tested end to end, including ingest.
  • Without Docker — on macOS it uses Exasol Personal (a native VM); on Linux, a native Nano install (planned). The add-ons run as isolated host environments.

MCP Server and JSON Tables have incompatible pyexasol requirements, so each runs in isolation — a separate container, or a separate host environment — never a shared Python environment.

Status

0.3.x — the container path (Nano + MCP + JSON Tables) is tested end to end, including ingest. The no-Docker native bases are selected automatically when Docker is absent; the macOS path is experimental and not yet validated.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

exasol_quickstart-0.3.4.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

exasol_quickstart-0.3.4-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

Details for the file exasol_quickstart-0.3.4.tar.gz.

File metadata

  • Download URL: exasol_quickstart-0.3.4.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for exasol_quickstart-0.3.4.tar.gz
Algorithm Hash digest
SHA256 b54ffb0fa58cf9172dd76403f55a79c88c55d892a354145c544ef58aef8d6e1d
MD5 6400e0a02696c8ee0f47ac0f9f21f019
BLAKE2b-256 3bfcca271899a6ecc0d2abd6b63ff56ba30e7732efe091f298bc30d4b39db0d7

See more details on using hashes here.

Provenance

The following attestation bundles were made for exasol_quickstart-0.3.4.tar.gz:

Publisher: release.yml on krishna-exasol/exasol-quickstart

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file exasol_quickstart-0.3.4-py3-none-any.whl.

File metadata

File hashes

Hashes for exasol_quickstart-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3a962bd71d4bb50421871820ca8f39bd9f7d3a9a455fb61cb60b09fde92a1f16
MD5 d80d071ee5d8e7a2a7e3e2245af8df9d
BLAKE2b-256 1425208335d23bf693d5c6bb152dbefc7ea65863bd06cd294ba77bae92e7a8ba

See more details on using hashes here.

Provenance

The following attestation bundles were made for exasol_quickstart-0.3.4-py3-none-any.whl:

Publisher: release.yml on krishna-exasol/exasol-quickstart

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page