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 — in one command.

A full Exasol analytics database, an LLM-ready MCP server, and JSON-native SQL — set up the right way for your OS, in minutes.


PyPI Python Platforms License

📦 PyPI  •  💻 GitHub


⚡ Get started in one line

pipx run exasol-quickstart
Prefer uv?  uvx exasol-quickstart

Choose the form that fits — try it (runs once, nothing installed) or keep it (installs the command for repeated use):

with pipx with uv
▶️ Try it once pipx run exasol-quickstart uvx exasol-quickstart
📌 Keep it pipx install exasol-quickstart && exasol-quickstart uv tool install exasol-quickstart && exasol-quickstart

Every form detects your OS, provisions Exasol the right way, and prints the endpoints. No flags. No multi-step setup.


🎁 What you get

exasol-quickstart  ->  three services on one shared network:

+----------------------+   +----------------------+   +----------------------+
|  Exasol  (database)  |   |  MCP server          |   |  JSON Tables         |
|  127.0.0.1:8563      |   |  :4896/mcp           |   |  JSON  ->  SQL       |
+----------------------+   +----------------------+   +----------------------+

The MCP server and JSON Tables both connect to the Exasol database over a shared Docker network.

Component Endpoint Purpose
🗄️ Exasol (database) 127.0.0.1:8563sys / exasol the Exasol SQL engine
🤖 MCP Server http://127.0.0.1:4896/mcp connect Claude / any 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 thing you always need is Python 3.9+ with pipx:

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

From there, exasol-quickstart picks how Exasol runs, per 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 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, change nothing
exasol-quickstart --base <name>        # force a base: nano-docker | personal | nano-native
exasol-quickstart json-tables --help   # run the JSON Tables CLI
📥 Ingest some 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 exasol/nano + exasol/mcp-server and builds the JSON Tables image once (it compiles a small Rust engine — a few minutes). Subsequent runs are fast.

🧹 Stop & remove everything
docker rm -f exasol-quickstart-db exasol-quickstart-mcp exasol-quickstart-json-tables

🧩 How it works

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

  • With Docker — Exasol Nano (database), the official exasol/mcp-server image, and a JSON Tables sidecar run as containers on a shared network. Tested end to end, including ingest.
  • Without Docker — macOS uses Exasol Personal (a native VM); Linux uses a native Nano install (planned). 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. No-Docker native bases are chosen automatically when Docker is absent; the macOS path is experimental.


📦 Install from PyPI  •  Made to make trying Exasol effortless  •  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.6.tar.gz (9.8 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.6-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: exasol_quickstart-0.3.6.tar.gz
  • Upload date:
  • Size: 9.8 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.6.tar.gz
Algorithm Hash digest
SHA256 3781cdfee31f1c7266aafbef0bcb17de3091a6b331c451c27cff0fe9e41cc19b
MD5 9281311c0d25e55fb4bcb800d4b0ee17
BLAKE2b-256 1b3797f0350df78656d9659351a82cfea17323888d579d392dd7d60ec71e6bee

See more details on using hashes here.

Provenance

The following attestation bundles were made for exasol_quickstart-0.3.6.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.6-py3-none-any.whl.

File metadata

File hashes

Hashes for exasol_quickstart-0.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4ebe2535f293c1aefbb91dd22138fe04d7c82fa1a341c7498ece577685c9badf
MD5 492e46bd668a33fed371c5a223893f1f
BLAKE2b-256 25fb4db7b2b946de051d7ca8b06dc4defbb67b4e230570eeb269d1416a294f7d

See more details on using hashes here.

Provenance

The following attestation bundles were made for exasol_quickstart-0.3.6-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