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
                              │
                              ▼
        ┌──────────────────────────────────────────────┐
        │   Exasol  (database)        127.0.0.1:8563    │
        │      ▲            ▲                            │
        │      │            │                            │
        │   MCP server   JSON Tables                     │
        │   :4896/mcp    ingest 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";

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.5.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.5-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: exasol_quickstart-0.3.5.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.5.tar.gz
Algorithm Hash digest
SHA256 f30005ce03f8ea936cfff0af9711f2fc1ba050323f5c239256a5f08d818003fd
MD5 ad8c9d8968355d9a34af59be54029faa
BLAKE2b-256 ef74ea2376506779b1783e25bf2ad64bc3136e77149fdcc7444faada6fc1e45d

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for exasol_quickstart-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 a7aaf0cb049279a9fb75ccbeb0d64df46c4661d418ccb41f056dc126d39c3c14
MD5 f56641518cd802a9ac8ead142f1a24a9
BLAKE2b-256 634099626685877ea2bf41531fde0d8bd900efd6212628e0d4c221667db38075

See more details on using hashes here.

Provenance

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