diff --git a/CHANGELOG.md b/CHANGELOG.md index 94ce70b..9c3a8dc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -64,7 +64,7 @@ auto-generated per-PR notes; this file is the curated, human-readable history. monotonically increasing generation counter so a superseded in-flight response can never overwrite a newer edit's result. `ch-client.js`'s `queryJson`/`queryDashboardTile` gained an optional `params` argument - (backward compatible) to forward `param_` args to ClickHouse. Per-tile + (backward compatible) to forward `param_` args to ClickHouse®. Per-tile Type/X/Y overrides, KPI tiles, and dropdown/cascading filters arrive in later phases (#149 D5–D7). - **Schema-aware, FROM-driven autocompletion** (#84) — column completion now diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7f9cf28..134c3b4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,8 @@ -# Contributing to the Altinity SQL Browser +# Contributing to the Altinity® SQL Browser Thanks for your interest! This is a modular, no-framework ES-module SPA that builds to **one self-contained HTML file** (`dist/sql.html`) served from a -ClickHouse cluster. Quality is held by tests and a strict layering discipline — +ClickHouse® cluster. Quality is held by tests and a strict layering discipline — please read the hard rules below before opening a PR. ## Quickstart diff --git a/README.md b/README.md index 074ac30..2661430 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# Altinity SQL Browser +# Altinity® SQL Browser **🌐 Website & screenshots: [docs.altinity.com/altinity-sql-browser](https://docs.altinity.com/altinity-sql-browser/)** -An OAuth-gated **SQL browser for any ClickHouse cluster** — schema explorer, +An OAuth-gated **SQL browser for any ClickHouse® cluster** — schema explorer, tabbed SQL editor with syntax highlighting, find/replace, bracket matching, and schema-aware autocomplete, streaming results with table / JSON / chart views, saved queries, history, and shareable links. It ships as a diff --git a/SECURITY.md b/SECURITY.md index 51ce902..040b95d 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,7 +1,7 @@ # Security Policy -The Altinity SQL Browser is a single self-contained HTML file (no application -backend) served from a ClickHouse cluster's `user_files/` by an +The Altinity® SQL Browser is a single self-contained HTML file (no application +backend) served from a ClickHouse® cluster's `user_files/` by an `` static rule. It talks only to that ClickHouse server and your OAuth IdP, and makes zero third-party requests. The notes below describe how to report a vulnerability and the threat model you should deploy against. diff --git a/THIRD-PARTY-NOTICES.md b/THIRD-PARTY-NOTICES.md index 7b76d6d..d74aedd 100644 --- a/THIRD-PARTY-NOTICES.md +++ b/THIRD-PARTY-NOTICES.md @@ -1,6 +1,6 @@ # Third-party notices -The Altinity SQL Browser is licensed under Apache-2.0 (see `LICENSE`). The built +The Altinity® SQL Browser is licensed under Apache-2.0 (see `LICENSE`). The built single-file artifact (`dist/sql.html`) inlines the four runtime dependencies below (CodeMirror 6 ships as several packages); this file reproduces their MIT license texts as required, and the same notices are embedded as a comment at diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 005f85e..f1a8dee 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -4,7 +4,7 @@ ``` core/ pure logic — strings/numbers/JWT/PKCE/SQL-tokenize/stream-parse -net/ integration — OAuth (config+flow) and the ClickHouse HTTP client +net/ integration — OAuth (config+flow) and the ClickHouse® HTTP client ui/ presentation — hyperscript (h), icons, and render modules state model — the state object and pure operations over it main bootstrap — OAuth callback handling + initial render diff --git a/docs/ASSET-DISTRIBUTION.md b/docs/ASSET-DISTRIBUTION.md index 8335824..8a4dd34 100644 --- a/docs/ASSET-DISTRIBUTION.md +++ b/docs/ASSET-DISTRIBUTION.md @@ -1,6 +1,6 @@ -# Serving the assets across a ClickHouse cluster +# Serving the assets across a ClickHouse® cluster -The Altinity SQL Browser is served *from ClickHouse itself* — there is no +The Altinity® SQL Browser is served *from ClickHouse itself* — there is no separate web server. That makes "how do the asset bytes reach every node?" a real design question on a multi-node cluster, because **ClickHouse does not replicate the `user_files/` directory**: it is a node-local folder. diff --git a/docs/CLICKHOUSE-OAUTH.md b/docs/CLICKHOUSE-OAUTH.md index 560a776..d470228 100644 --- a/docs/CLICKHOUSE-OAUTH.md +++ b/docs/CLICKHOUSE-OAUTH.md @@ -1,4 +1,4 @@ -# Configuring ClickHouse (Antalya) to accept OAuth JWTs +# Configuring ClickHouse® (Antalya) to accept OAuth JWTs The SQL browser authenticates each user with your OAuth/OIDC provider in the browser, then sends the resulting JWT to ClickHouse on **every query**: @@ -8,7 +8,7 @@ POST / Authorization: Bearer ``` For ClickHouse to accept that, it must (1) validate the JWT and (2) map it to a -ClickHouse user with some roles. The **Altinity Antalya** build does this +ClickHouse user with some roles. The **Altinity® Antalya** build does this natively with a `` entry plus a `` user-directory — no sidecar, no shared service account; every query runs as the real user. diff --git a/docs/CLICKHOUSE-OSS-OAUTH.md b/docs/CLICKHOUSE-OSS-OAUTH.md index f4a1618..844a40c 100644 --- a/docs/CLICKHOUSE-OSS-OAUTH.md +++ b/docs/CLICKHOUSE-OSS-OAUTH.md @@ -1,4 +1,4 @@ -# OAuth on stock/OSS ClickHouse via ch-jwt-verify +# OAuth on stock/OSS ClickHouse® via ch-jwt-verify Stock (OSS) ClickHouse has no ``, so it can't validate a `Bearer` JWT itself (it returns `Code: 516. 'Bearer' HTTP Authorization scheme diff --git a/docs/DEPLOYMENT.md b/docs/DEPLOYMENT.md index c3519bc..6f40756 100644 --- a/docs/DEPLOYMENT.md +++ b/docs/DEPLOYMENT.md @@ -2,7 +2,7 @@ There are now two distinct deployment surfaces: -1. **ClickHouse-native hosted mode** — upload `sql.html` + `sql-config.json` into +1. **ClickHouse®-native hosted mode** — upload `sql.html` + `sql-config.json` into ClickHouse `user_files/` and serve them from the cluster itself. 2. **Containerized local-runner mode** — run the existing Python local server in Docker or Kubernetes for local/shared testing, with connections mounted from a diff --git a/docs/LOGIN-SCREEN.md b/docs/LOGIN-SCREEN.md index 5ccc3a4..e03358d 100644 --- a/docs/LOGIN-SCREEN.md +++ b/docs/LOGIN-SCREEN.md @@ -1,7 +1,7 @@ # Configuring the login screen The sign-in screen offers up to three sign-in paths at once — SSO, a -ClickHouse username/password, and a picker for connecting to a different +ClickHouse® username/password, and a picker for connecting to a different server — so a first-time visitor can see more controls than their deployment actually needs (#123). All of it is a `config.json` choice; this page is the full reference for that config, and for what each part of the screen does. diff --git a/docs/ONTIME-CHART-DEMO.md b/docs/ONTIME-CHART-DEMO.md index a3bae42..4f7bd22 100644 --- a/docs/ONTIME-CHART-DEMO.md +++ b/docs/ONTIME-CHART-DEMO.md @@ -1,7 +1,7 @@ # Chart demo — the `ontime` flight dataset A ready-made **Library** of 10 analytical queries that show off every chart type and -feature in the Altinity SQL Browser, running against the public US flight-history +feature in the Altinity® SQL Browser, running against the public US flight-history dataset (`ontime`, ~230M rows, 1987–2025) on the Antalya demo cluster. - **Live demo:** **https://antalya.demo.altinity.cloud/sql** diff --git a/docs/SYSTEM-EXPLORER-DEMO.md b/docs/SYSTEM-EXPLORER-DEMO.md index 0c1c541..42bf324 100644 --- a/docs/SYSTEM-EXPLORER-DEMO.md +++ b/docs/SYSTEM-EXPLORER-DEMO.md @@ -1,4 +1,4 @@ -# System explorer demo — introspecting ClickHouse itself +# System explorer demo — introspecting ClickHouse® itself A ready-made **Library** of 14 queries against ClickHouse's own `system` database — running queries, merges/mutations/replication health, storage, and historical diff --git a/docs/blog/explain-pipeline-graph.html b/docs/blog/explain-pipeline-graph.html index 0ad6fb3..b667aee 100644 --- a/docs/blog/explain-pipeline-graph.html +++ b/docs/blog/explain-pipeline-graph.html @@ -3,7 +3,7 @@ -Read your query plan as a graph — Altinity SQL Browser +Read your query plan as a graph — Altinity® SQL Browser @@ -12,7 +12,7 @@