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..381d6818 --- /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 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.