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


⚡ Get started

▶️ Try it — runs once, nothing installed:

pipx run exasol-quickstart

…or, if you prefer uv:

uvx exasol-quickstart

📌 Keep it — installs the command so you can run it again later:

pipx install exasol-quickstart && exasol-quickstart

…or, with uv:

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       |
+----------------------+   +----------------------+   +----------------------+
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";

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). 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.


GitHub  •  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.11.tar.gz (11.9 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.11-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: exasol_quickstart-0.3.11.tar.gz
  • Upload date:
  • Size: 11.9 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.11.tar.gz
Algorithm Hash digest
SHA256 120aceeec7ce0d5dc1ce7d42d5145f50cd787ac17002a2ab3888a02be3666743
MD5 b6e947389540e6d51e47e8aa5143d616
BLAKE2b-256 03b4377e67babfa407cd58c1875552b2aad70d933e6f135ae5c1ac25eba5ae87

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for exasol_quickstart-0.3.11-py3-none-any.whl
Algorithm Hash digest
SHA256 a0c206b17bb7cdf8d5a2e6f457dca99db535611e0cdf0fbd857658e3f83e4387
MD5 f6a2ed2857b6dace558c3b4564551538
BLAKE2b-256 88de685e584ed6939638acd58e2e6d5cdb27c9a2f643d99da8f7e8db5290d534

See more details on using hashes here.

Provenance

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