docs: add timescaledb_toolkit adaptation guide - #307
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
There are documentation consistency issues (Oracle-mode SET syntax) and a likely mixed line-ending problem in CN nav that should be normalized before merge.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Adds a new bilingual (EN/CN) adaptation guide for building and using the TimescaleDB Toolkit extension with IvorySQL 5, and integrates it into the docs navigation and ecosystem overview lists.
Changes:
- Add new
timescaledb_toolkitcomponent documentation pages (EN/CN) covering build/install, validation queries, and Oracle-compatible mode notes. - Register the new component in both EN/CN navigation and ecosystem overview tables.
File summaries
| File | Description |
|---|---|
| EN/modules/ROOT/pages/master/ecosystem_components/timescaledb_toolkit.adoc | New English guide for building/using TimescaleDB Toolkit on IvorySQL, including Oracle-mode notes. |
| CN/modules/ROOT/pages/master/ecosystem_components/timescaledb_toolkit.adoc | New Chinese guide equivalent to the EN page. |
| EN/modules/ROOT/pages/master/ecosystem_components/ecosystem_overview.adoc | Adds Toolkit to the EN ecosystem components table. |
| CN/modules/ROOT/pages/master/ecosystem_components/ecosystem_overview.adoc | Adds Toolkit to the CN ecosystem components table. |
| EN/modules/ROOT/nav.adoc | Adds Toolkit page to EN sidebar navigation. |
| CN/modules/ROOT/nav.adoc | Adds Toolkit page to CN sidebar navigation. |
Review details
- Files reviewed: 6/6 changed files
- Comments generated: 3
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| *** xref:master/ecosystem_components/set_user.adoc[set_user] | ||
| *** xref:master/ecosystem_components/timescaledb_toolkit.adoc[timescaledb_toolkit] |
|
🚀 IvorySQL-Docs Preview Ready
|
|
🚀 IvorySQL-Docs Preview Ready
|
|
🚀 IvorySQL-Docs Preview Ready
|
|
IvorySQL has not yet completed compatibility adaptation with TimescaleDB. |
|
Thanks for pointing this out. This PR is specifically about timescaledb_toolkit, which I tested as a standalone extension on IvorySQL 5.4; the documented functions do not require the TimescaleDB extension to be installed. I agree that this may be confusing while TimescaleDB compatibility itself is unfinished. Would you prefer a clearly labeled standalone Toolkit guide, or should this be deferred until TimescaleDB is adapted? |
Summary\n\n- add bilingual source-build instructions for TimescaleDB Toolkit 1.26.0 on IvorySQL 5\n- document representative statistical, percentile, distinct-count, counter, and time-weighted functions\n- distinguish standalone Toolkit functionality from optional TimescaleDB features\n- document the verified Oracle-mode behavior and the direct Oracle-port installation limitation\n- add the component to both navigation files and ecosystem overview tables\n\n## Validation\n\nValidated with IvorySQL 5.4 / PostgreSQL 18.4, Rust 1.98.1, cargo-pgrx 0.18.1:\n\n- cargo test --workspace --exclude timescaledb_toolkit — passed\n- release build and install without Toolkit source changes — passed\n- PostgreSQL-mode extension lifecycle and representative hyperfunctions — passed\n- representative calls after switching to Oracle-compatible mode — passed\n- direct CREATE EXTENSION through Oracle port — documented limitation (upstream install SQL uses PostgreSQL syntax)\n\nFixes IvorySQL/IvorySQL#1099