index.md

Hoptimator documentation

Hoptimator is a SQL control plane for multi-system data pipelines. You write SQL; it figures out the topology across Kafka, Flink, Venice, and whatever else you plug in, generates the specs, deploys them, and reconciles them.

This documentation is organized by what you're trying to do. Follow the path that matches you.

I'm new here

Start with Getting started:

• Quickstart — five minutes from git clone to a running pipeline on Docker Desktop.
• Concepts — the vocabulary the rest of the docs assume.
• Architecture overview — how a SQL statement turns into running infrastructure.

I want to use Hoptimator from my application or shell

See the User guide:

• SQL CLI — sqlline-based interactive shell with !pipeline, !specify, !resolve for inspecting plans before they deploy.
• JDBC driver — jdbc:hoptimator:// for Java apps, with full connection-property reference.
• MCP server — Model Context Protocol server for AI agents and IDEs.
• DDL reference — CREATE VIEW, CREATE MATERIALIZED VIEW, DROP, PAUSE/RESUME, triggers, and the built-in k8s system schema.
• Hints — runtime overrides for templates and connectors.

I'm operating Hoptimator on Kubernetes

See the Kubernetes guide:

• Operator — what hoptimator-operator does, how to deploy it, RBAC, namespace scoping, the controllers it runs.
• CRD reference — field-by-field for every CRD Hoptimator installs (Database, View, Pipeline, TableTemplate, JobTemplate, TableTrigger, Subscription, LogicalTable, Engine, SqlJob).
• Templates and configuration — authoring TableTemplates and JobTemplates, placeholder syntax, where placeholder values come from (hoptimator-configmap, JDBC properties, system properties), ConfigProvider SPI.
• Triggers — operational guide for TableTrigger: cron vs status-driven firing, pause/resume, common patterns.

I want to extend Hoptimator

See Extending Hoptimator:

• Adding a new data source — JDBC adapter, Database CRD, TableTemplate authoring.
• Deployers — implementing Deployer for a new deployment target, DeployerProvider registration, lifecycle.
• Validators — pre-deploy policy enforcement via Validator and ValidatorProvider.
• Config providers — custom ConfigProvider SPI.
• Templates and configuration — authoring TableTemplate and JobTemplate (lives in the Kubernetes guide).

I'm contributing to Hoptimator

The contributor guide (coming in a later docs phase) will cover the build, the test layout, integration tests, and the release process. Until then, the CONTRIBUTING file at the repo root has the basics.

Background reading

Learn more — engineering blog posts and case studies.