vccs
Vue 3용 차트 컴포넌트 모음, Recharts에서 포팅
Open-source semantic layer: one cube for Excel (MDX/XMLA), dashboards, and AI agents (MCP). Mondrian + Apache Calcite.
저장소 README에서 가져옴
README 전체를 불러오는 중입니다. 아래는 저장된 발췌입니다.
Open-source Semantic Layer analytics for cubes — drag-and-drop in the
browser, SQL through Mondrian + Calcite, and a typed REST surface so AI
agents can query without ever seeing MDX.
Then open and log in with admin / admin. Demo
mode ships a self-contained H2 + FoodMart cube — drag fields onto rows, columns,
or filters and the SPA writes MDX for you.
For a real deployment, drop SAIKU_DEMO=true and set an admin password:
-e SAIKU_ADMIN_PASSWORD='a-strong-password'. Saiku refuses to start on the
default admin/admin once it's network-reachable, so one of those two is
required.README 전문 보기 ↗docker run -d -p 8080:8080 --name saiku -e SAIKU_DEMO=true ghcr.io/spiculedata/saiku
Then open http://localhost:8080/ui/ and log in with admin / admin. Demo
mode ships a self-contained H2 + FoodMart cube — drag fields onto rows, columns,
or filters and the SPA writes MDX for you.
For a real deployment, drop
SAIKU_DEMO=trueand set an admin password:-e SAIKU_ADMIN_PASSWORD='a-strong-password'(or-e SAIKU_ADMIN_PASSWORD_FILE=/run/secrets/saiku-admin-password). Saiku refuses to start on the defaultadmin/adminonce it's network-reachable, so one of those two is required — and the password must itself clear the policy (≥ 12 characters, not a well-known weak password), soSAIKU_ADMIN_PASSWORD=adminis refused too.
Demo fixtures follow demo mode (saiku#1953). A boot without
SAIKU_DEMO=truestages no demo content: no FoodMart/Bank/TPC-DS/Flights schemas, no H2 fixtures, no datasource descriptors — a fresh home comes up with an empty datasource list. SetSAIKU_SEED=trueto install the fixtures on a non-demo boot, orSAIKU_DEMO=true SAIKU_SEED=falsefor the demo login against your own cubes. Seeding is seed-if-absent, so an existingsaiku-homeis never rewritten or emptied.
The container runs as a non-root user (uid/gid
10001:10001). A fresh named/anonymous volume works out of the box. Any pre-existingsaiku-homefrom an older root container — bind mount or named volume — must be re-owned once:sudo chown -R 10001:10001 <host-dir>, or for a named volumedocker run --rm -v saiku-home:/app/saiku-home --user 0 --entrypoint chown ghcr.io/spiculedata/saiku:latest -R 10001:10001 /app/saiku-home. The container fails closed with aFATAL:message (naming the fix) rather than silently rotating its encryption key. On Kubernetes setsecurityContext: { runAsUser: 10001, fsGroup: 10001 }. See the CHANGELOG upgrade note for details.
A hosted instance is always live at https://demo.saiku.bi (auto-reset nightly).
Saiku started in 2010 as an open-source OLAP browser for Mondrian. In 2026 it was rebuilt as a modern Semantic Layer on top of:
SqlQuery builder. Calcite is the default; force
legacy with -Dmondrian.backend=legacy. The Calcite planner reaches
modern engines too — see examples/lakehouse-demo
for a Saiku → Mondrian → Calcite → Trino → Iceberg walkthrough./ui/).Saiku 4.x exposes a typed REST surface — /rest/saiku/api/ai/* — designed
for LLM agents. Hierarchies, levels, measures and synonyms are discoverable
via /ai/cubes and /ai/schema, and a single POST /ai/query translates
a JSON description of a question into validated MDX, runs it, and returns
typed {value, formatted, unit} cells. Every validation failure carries
a {status, field, available} envelope so an agent can self-correct
without scraping logs.
The same self-describing, self-correcting contract has a SQL-side twin at
/rest/saiku/api/ai/ossie/* for datasets modelled with the Ossie semantic
layer — same list → schema → query shape, same VALIDATION_ERROR envelope,
plus POST /ai/ossie/ask for a plain-language question. Anomaly and forecast
endpoints (/ai/anomaly, /ai/forecast) share the same typed envelope.
The container also bundles saiku-mcp, a stdio
Model Context Protocol wrapper so Claude
Desktop / Cursor / Cline can wire to a running Saiku with one line of
config:
{
"command": "docker",
"args": ["exec", "-i", "saiku", "saiku-mcp"]
}
See docs/AI-QUERY-API.md and
docs/schema-annotations.md for the typed
contract and the saiku.semantic.* annotation namespace cubes use to
describe themselves to agents.
Reviewing a schema change before it lands:
# What does this edit break?
saiku model diff --from-git origin/development --from-git HEAD \
--before saiku-launcher/src/main/resources/seed/FoodMart4.xml \
--after saiku-launcher/src/main/resources/seed/FoodMart4.xml \
--repository ./saiku-home/repository/data
Diffs two models (Mondrian XML or Apache Ossie YAML), detects renames as renames,
and lists every saved query, dashboard and app still pointing at a member the change
removes — as Markdown, JSON, or POST /rest/saiku/api/admin/model/diff. On a pull
request that touches a model, the model-diff workflow posts the same report as a
sticky comment. See docs/MODEL-DIFF.md.
Point Saiku at a warehouse and it will build a starting Ossie semantic
model — cubes, dimensions, measures, joins — plus a rationale document
explaining every decision. See
docs/OSSIE-MODEL-GENERATION.md.
Admins can extend the AI surface without code:
saiku-home/skills/*.md) — markdown workflows with YAML
frontmatter, discoverable from /ai/ask. Invoke one explicitly by prefixing
an ask with /<skill-name>, or ask naturally and let the LLM route via the
skill catalogue.saiku-home/agent-spaces/*.json) — named personas that scope an
ask to a system prompt, a cube allowlist and a skill allowlist.
POST /ai/spaces/{id}/ask enforces the persona server-side, so a cube outside
the allowlist is a 403 the user can't override.See docs/SKILLS-SPEC.md and
docs/AGENT-SPACES-SPEC.md.
Build shareable dashboards of chart / table / KPI / text / image tiles over your
cubes — with cross-tile filters, click- and brush-cross-filtering,
drill-down/through, conditional formatting, combo charts, anomaly/forecast
overlays, auto-refresh, PDF/PNG export and read-only share links. See the
docs/dashboards-user-guide.md for the full
walkthrough, and saiku-ui/src/embed/README.md
to embed a dashboard in your own app via the <saiku-embed> web component.
Saiku speaks the SCIM 2.0 core profile, so Okta, Microsoft Entra ID or
OneLogin can own the user lifecycle: an admin mints one bearer token per
connector, and create / update / deactivate / group-assignment all flow into
the Saiku user directory without anyone touching the admin console. SCIM
handles lifecycle; OIDC/SAML handles authentication — a provisioned account has
no usable local password. See
docs/SCIM-PROVISIONING.md for the connector
walkthrough, the attribute mapping and its limits.
A first-party Sheets add-on (integrations/google-sheets/, spiculedata/saiku#1436)
queries the semantic layer from a spreadsheet sidebar — cube picker, measure
and dimension shelves, Insert as table, and a Refresh that rewrites the
same block in place so your formatting survives. It talks to the same typed
/saiku/api/ai/* surface as the MCP server and the Excel add-in. See
docs/sheets.md.
Saiku ships opt-in OpenTelemetry instrumentation via the OTel Java
agent — zero code changes, zero overhead when off. Setting
OTEL_EXPORTER_OTLP_ENDPOINT activates auto-instrumentation for Jetty,
Jersey, JDBC (every Mondrian-emitted SQL becomes a child span),
outbound HTTP, JVM metrics, and DBCP2 connection pool metrics. Trace
context is injected into the Saiku log pattern automatically.
docker run -d -p 8080:8080 \
-e OTEL_EXPORTER_OTLP_ENDPOINT=http://otel-collector:4318 \
-e OTEL_SERVICE_NAME=saiku-prod \
ghcr.io/spiculedata/saiku:latest
Without the endpoint env var the agent is never loaded. See
docs/observability.md for the full env-var
reference, sampling guidance, and what's not yet covered (Tier 2
custom spans for ThinQueryService etc.).
Two guardrails an operator is expected to tune, both documented in
docs/operator-hardening.md:
saiku.mail.smtp.*). Prefer an ops-managed relay via SAIKU_MAIL_SMTP_HOST,
which makes the wizard read-only.saiku.ai.budget.*).Quality signals — per-module test-count and line-coverage floors, UI type
checks, UI tests — are declared as files (.github/test-floors.json,
.coverage-thresholds.json) and gated on every PR by the ci workflow.
A separate weekly run, .github/workflows/quality-report.yml, renders the same
signals as one Markdown quality dashboard in its job summary: where each
module stands, and by how much headroom. That run is read-only and is not a
gate — the gates stay in CI. See docs/quality.md. For how
CI, the merge queue, images, previews and the demo deployment fit together, see
docs/ci-overview.md.
JDK 21 + Maven 3.9+ required.
Set up GitHub Packages auth first, or the build fails before it compiles. Saiku's Mondrian fork, olap4j,
saiku-query and Ossie artifacts are published to GitHub Packages, which requires an authenticated token even
though the packages are public. Without it you get a bare 401 Unauthorized on pentaho:mondrian that never
mentions tokens:
read:packages scope
(Tokens (classic)). It must be classic — GitHub's Maven registry
does not accept fine-grained tokens,
and the UI defaults to fine-grained. Our packages are public, so no repo scope or org membership is needed.<server> entries to ~/.m2/settings.xml — github-mondrian-saiku, github-olap4j,
github-olap4j-xmlaserver, github-saiku-query, github-ossie. Copy the block from
.github/workflows/ci.yml; one token covers all five.Still getting a 401? A fine-grained token and a classic token missing read:packages produce an identical error,
so check what the token actually has before minting another —
curl -sI -H "Authorization: token $PAT" https://api.github.com/user | grep -i x-oauth-scopes. A classic token's
scopes are editable in place, and the value doesn't change, so settings.xml needs no edit.
# Compile, unit tests, Spotless format check (CI gate):
mvn verify
# Build the runnable fat-JAR:
mvn -pl saiku-launcher -am -Dmaven.test.skip=true package
# Run:
java -jar saiku-launcher/target/saiku-*.jar serve --port 8080 --home ./saiku-home
Whole-API integration tests (boots Jetty + the launcher's WAR in-process against the seeded FoodMart H2 datasource):
mvn verify -P integration
See CLAUDE.md for the full layout, the dependency catalog
(saiku-bom), and the GitHub Packages auth gotcha for local builds.
The fat JAR, dist zip, SBOM, container image and npm packages carry
keyless Sigstore-signed SLSA build provenance,
and each release ships a SHA256SUMS file. See
Verifying release artifacts
for the commands per artifact type (gh attestation verify,
cosign verify-attestation, sha256sum -c, npm audit signatures).
saiku-bom/ # central dependency-version catalogue
saiku-core/
saiku-olap-util/ # olap4j helpers
saiku-service/ # Semantic Layer service, AI Query, schema gen, async, cache
saiku-semantic/ # YAML semantic layer
saiku-web/ # JAX-RS REST resources
saiku-webapp/ # Servlet webapp (Spring XML wiring)
saiku-launcher/ # Picocli CLI + embedded Jetty serving the WAR
saiku-mcp/ # stdio JSON-RPC MCP wrapper
saiku-ui/ # SvelteKit SPA (independent versioning)
The SvelteKit SPA lives in saiku-ui/ and is built independently; the
launcher serves the static dist/ under /ui/.
saiku.The old groups.google.com/a/saiku.meteorite.bi lists and ##saiku IRC
channel are no longer monitored.
Saiku is developed with help from "the hive", a self-hosted system of AI agents that works alongside the maintainers. This section explains how an issue becomes a merged change, who signs off, and what happens when something goes wrong. The rules the agents follow live in AGENTS.md; this is the short version for people.
spicule-hive-bot account. It writes most of the agent-made feature PRs..github/ISSUE_TEMPLATE prompt for it.issue-approved label. It is the only thing that lets the agents touch an issue. The issue-gate workflow removes it, with a comment, if the issue has no acceptance criteria, so approval cannot be vague.hold, do-not-merge, needs-human, human-queue, blocked or needs-decision. human-queue is never given to an agent, even next to issue-approved.AGENTS.md, works on a branch, and finishes in exactly one of three ways: a pull request, a written finding on the issue (what it checked, what blocks it, what would unblock it, what it could not verify), or a "no work needed" verdict with evidence. A finding is finished work, not a failure.development, or remove hold, do-not-merge, needs-human or human-queue.risk/high, risk/medium or risk/low from the files it touches, per docs/risk-tiers.md. The label is advisory and does not block anything, but changes to CI, security, builds or the design system are high tier and deserve a closer look.| Situation | What happens | What you do |
|---|---|---|
| A bot PR's CI goes red | A watcher adds needs-rework (once per failing commit) and the quality agent fixes it. After 2 automatic rounds the PR gets needs-human. | Read the failing check, fix or re-scope, then remove needs-human. |
| You want an agent to rework a PR, including your own | Add needs-rework. Within a few minutes it becomes rework-queued and goes to the quality agent. | Re-add needs-rework for another round. |
| An agent cannot finish within scope | It writes an evidenced finding and stops, and the issue gets blocked. It does not retry the same blocked task or widen the scope. | Unblock it and remove blocked, or close the issue. |
| A worker's attempt ends with no PR | The issue returns to the queue after a cooldown, so a later attempt can try. A bad run is not retried at once. | If it keeps happening, add hold and read the finding. |
| A worker stalls | The 90-minute lease expires and the issue is freed. | Nothing. |
| You want agents to leave an issue alone | Add hold, or human-queue for work meant for people. | Remove it when ready. |
PRs written by people are not retried automatically. Add needs-rework to ask for it.
Acceptance specs are enforced here for issues numbered 2181 and above (the ACCEPTANCE_ENFORCE_FROM_ISSUE repository variable; with it unset nothing is enforced). A PR that closes issue N (with a closing keyword in the body) ships acceptance/N/spec.json, a runnable version of the issue's criteria, committed before the fix. Older issues are reported as grandfathered. How to write one: Writing and running a spec; every field: spec-format.md. Saiku specifics (paths, login, worked examples): acceptance/README.md and docs/acceptance-specs.md.
A minimal api spec, acceptance/123/spec.json. Relative paths sit under /rest/saiku/api; a path starting /rest/ is used as is. Use "auth": "session" for endpoints behind login (CI uses the demo admin login). A command spec ("kind": "command", "command": ["node", "check.mjs"]) works too; see acceptance/2172.
{
"issue": 123,
"title": "GET /rest/saiku/info answers anonymously with a JSON array",
"kind": "api",
"criteria": [{ "id": "C1", "given": "an anonymous caller", "then": "GET /rest/saiku/info returns 200 and an array" }],
"steps": [
{
"name": "info is anonymous and returns an array",
"criterion": "C1",
"request": { "method": "GET", "path": "/rest/saiku/info" },
"expect": { "status": 200, "json": { "$": { "type": "array" } } }
}
]
}
To run specs locally, point the shared runner at any running instance (clone spiculedata/acceptance-spec; plain Node 22+, no install):
node <path-to>/acceptance-spec/scripts/acceptance-runner.mjs run --dir acceptance/123 \
--base-url http://localhost:8080 --base-path /rest/saiku/api
For auth: session specs also set ACCEPTANCE_USER, ACCEPTANCE_PASSWORD and ACCEPTANCE_SESSION_PATH=/rest/saiku/session. It prints pass, fail or not-run and exits 1 on a failure.
What the checks mean:
ci / acceptance convention (inside ci, so it blocks the merge) fails a closing PR that has no spec.acceptance / acceptance specs (also republished as acceptance / specs) builds the PR, starts it on loopback with the demo data and runs every spec. A spec that could not run is not-run, never a pass (for example, fork PRs have no build token, so api specs are not run there), and ci treats not-run as red.acceptance / spec fails on base runs only when the PR adds or changes a spec: it must fail on the base branch's build and pass on the PR's, since a spec that already passes proves nothing. The verdict also appears in each workflow's job summary. There is no sticky PR comment here.ci.yml, and the required ci check reads their results and their verdicts. A failing spec, a spec that could not run, a new spec that already passes on base (without a human-applied spec-already-green label) or a missing red-on-base proof turns ci red. They run on pull requests only, and only when the PR changes product code, the UI, a workflow or acceptance/: a docs-only PR skips the Maven build. The merge queue re-runs the build and tests on the queued result but not the specs.spiculedata/acceptance-spec (currently e1ee022; how to bump it). Two separate workflows watch that wiring and are not part of ci: thin-caller-gate (pull requests, mode: report, so findings are warnings, never a red check) flags a drifted or mixed pin and unlisted copies of shared scripts, and acceptance-pin-health (weekly and on manual dispatch) reports in its job summary how far the pin is behind acceptance-spec main. Neither bumps anything. Details: docs/acceptance-specs.md.Two labels excuse the rules for one PR. Both are applied by a human only; agents never apply them. acceptance-waived waives the convention for a docs-only or tests-only PR (the check verifies the changed files). spec-already-green excuses a spec that legitimately passes on the base branch already; it never rescues a spec that fails on the PR. Apply either before pushing, or close and reopen the PR, because they are read from the event payload.
development, is protected and requires the aggregate ci check (ci.yml). ci passes when every job under it succeeded or was legitimately skipped for the files changed, so a red build, UI or script job blocks the merge.development uses GitHub's merge queue with the merge-commit method. ci runs again on the queued result before it lands.issue-gate guards approvals, and the risk-tier classifier labels every PR. The acceptance specs run inside ci (see acceptance specs), so a failing spec blocks the merge like a failing build.dependabot-automerge.yml queues single-package patch bumps and GitHub Actions non-major bumps once ci is green. Everything else waits for a person.development lets promote-green move the public demo's image tag, once ci has passed on that commit (docs/demo-deployment.md). main is only for releases and hotfixes.To run the tests locally, use mvn verify (what the build job gates on), plus mvn spotless:apply before committing. UI checks run from saiku-ui with npm run check. See TESTING.md.
| Label | Meaning |
|---|---|
issue-approved | Admitted to the agents |
human-queue | People only, never agent work |
hold, do-not-merge | Stop |
needs-human | An agent stopped, a person must act |
blocked | Waiting on something outside the task |
needs-decision | Waiting on a maintainer decision |
needs-rework, rework-queued | Sent back to the quality agent |
acceptance-waived | Waives the acceptance-spec convention for one docs-only or tests-only PR (human only) |
spec-already-green | Excuses a spec that legitimately passes on the base branch (human only) |
AGENTS.md is the single source of truth for hard stops, decision gates and conventions (CLAUDE.md imports it). docs/ci-overview.md maps every workflow and label. Reusable agent skills live in .agents/skills.
See CONTRIBUTING.md. Short version:
feature/<name> branch off development — see the Gitflow note in
CLAUDE.md.mvn spotless:apply before committing (a pre-commit hook is
available via ./scripts/install-hooks.sh).**/src/test/java/; integration tests in
saiku-launcher/src/test/java/org/saiku/launcher/it/.development, not main. main is the release
branch — only release/* and hotfix/* PRs go there.Saiku is dual-licensed under Apache 2.0 and EPL 1.0. See
LICENSE. A summary lives at
https://saiku.bi/#license.
The original Saiku project was started by Tom Barber and Paul Stoellberger in 2010 at Meteorite BI and now lives at Spicule. Contributors are listed on the GitHub contributors page.
For release notes see Releases.