From aef76b48ce930a1e6b6ca2b5ab8bbd271ea24f46 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Manciot?= Date: Thu, 25 Jun 2026 08:32:57 +0200 Subject: [PATCH 1/2] docs(client): BI-tool integration index (bi_tools.md) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Story 17.4 (Epic 17 — R1 Documentation & Marketing). The full BI-tool guides are web-only (A2 carve-out, like 15.6/17.6/17.3). elasticsql carries an abridged index pointer only, NOT six per-tool MD files. - CREATE documentation/client/bi_tools.md: tier table (Tested = DBeaver/ Superset/Grafana; Compatible = Tableau/Power BI/Metabase) + per-tool website deep links + honest-gap note. - UPDATE documentation/client/README.md: [BI Tool Integration](bi_tools.md) index line. Closed Issue #142 Co-Authored-By: Claude Opus 4.8 (1M context) --- documentation/client/README.md | 1 + documentation/client/bi_tools.md | 22 ++++++++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 documentation/client/bi_tools.md diff --git a/documentation/client/README.md b/documentation/client/README.md index d5e206c6..315f41d8 100644 --- a/documentation/client/README.md +++ b/documentation/client/README.md @@ -23,4 +23,5 @@ Welcome to the Client Engine Documentation. Navigate through the sections below: - [REPL Client](repl.md) - [Arrow Flight SQL](arrow_flight_sql.md) - [ADBC Driver](adbc_driver.md) +- [BI Tool Integration](bi_tools.md) — DBeaver, Superset, Grafana, Tableau, Power BI, Metabase (full guides on the website) - [Telemetry & Privacy](telemetry.md) diff --git a/documentation/client/bi_tools.md b/documentation/client/bi_tools.md new file mode 100644 index 00000000..83029fe7 --- /dev/null +++ b/documentation/client/bi_tools.md @@ -0,0 +1,22 @@ +# BI Tool Integration + +SoftClient4ES connects to common BI and SQL tools through the **JDBC driver** (`jdbc:elastic://host:port`, driver class `app.softnetwork.elastic.jdbc.ElasticDriver`) or the **Arrow Flight SQL** server (`grpc://host:32010`). + +Full, step-by-step guides — connect, browse your indices, and run a cross-index JOIN — live on the website. This page is an index; the website carries the screenshots and per-tool detail. + +## Tested vs Compatible + +**Tested** tools are exercised against SoftClient4ES. **Compatible** tools speak a working protocol but have not been through formal regression (best-effort). + +| Tool | Tier | Path | Guide | +|---|---|---|---| +| Apache Superset | Tested (dedicated dialect) | Arrow Flight SQL | https://softclient4es.dev/integrations/superset/ | +| DBeaver | Tested | JDBC or Arrow Flight SQL | https://softclient4es.dev/integrations/dbeaver/ | +| Grafana | Tested (via Arrow Flight SQL) | Arrow Flight SQL | https://softclient4es.dev/integrations/grafana/ | +| Tableau | Compatible (not formally tested) | JDBC | https://softclient4es.dev/integrations/tableau/ | +| Power BI | Compatible (not formally tested) | JDBC | https://softclient4es.dev/integrations/power-bi/ | +| Metabase | Compatible (not formally tested) | JDBC | https://softclient4es.dev/integrations/metabase/ | + +## Honest-gap note + +Every tool runs the R1 superpower — a **cross-index JOIN** that Elasticsearch can't do — best through explicit `JOIN … ON …` SQL. Some BI tools auto-generate nested subqueries (Tableau live connections, Power BI DirectQuery relationships, the Metabase GUI Question builder); subqueries and CTEs are not in R1 yet. Use Extract / Import / Native-SQL mode with explicit JOINs as the workaround. Full BI-tool subquery / CTE support is coming in R2a. See the website's Known Limitations page for the full picture. From 587b95a1e88a8ce049239f26aac0ecbc2d93dafb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Manciot?= Date: Thu, 25 Jun 2026 14:34:07 +0200 Subject: [PATCH 2/2] docs(17.4): driver version to 0.2.0, rename R1/R2x, remove story refs --- documentation/client/bi_tools.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/client/bi_tools.md b/documentation/client/bi_tools.md index 83029fe7..381d6818 100644 --- a/documentation/client/bi_tools.md +++ b/documentation/client/bi_tools.md @@ -19,4 +19,4 @@ Full, step-by-step guides — connect, browse your indices, and run a cross-inde ## Honest-gap note -Every tool runs the R1 superpower — a **cross-index JOIN** that Elasticsearch can't do — best through explicit `JOIN … ON …` SQL. Some BI tools auto-generate nested subqueries (Tableau live connections, Power BI DirectQuery relationships, the Metabase GUI Question builder); subqueries and CTEs are not in R1 yet. Use Extract / Import / Native-SQL mode with explicit JOINs as the workaround. Full BI-tool subquery / CTE support is coming in R2a. See the website's Known Limitations page for the full picture. +Every tool runs the superpower of this release — a **cross-index JOIN** that Elasticsearch can't do — best through explicit `JOIN … ON …` SQL. Some BI tools auto-generate nested subqueries (Tableau live connections, Power BI DirectQuery relationships, the Metabase GUI Question builder); subqueries and CTEs are not in this release yet. Use Extract / Import / Native-SQL mode with explicit JOINs as the workaround. Full BI-tool subquery / CTE support is coming in the next release (Quarter 4 2026). See the website's Known Limitations page for the full picture.