Skip to content

docs: add support for Aurora PostgreSQL and MySQL#2320

Merged
goldmedal merged 2 commits into
Canner:mainfrom
kartikshastrakar:feat/add-clickhouse-aurora-support
May 25, 2026
Merged

docs: add support for Aurora PostgreSQL and MySQL#2320
goldmedal merged 2 commits into
Canner:mainfrom
kartikshastrakar:feat/add-clickhouse-aurora-support

Conversation

@kartikshastrakar
Copy link
Copy Markdown
Contributor

@kartikshastrakar kartikshastrakar commented May 24, 2026

Summary by CodeRabbit

Release Notes

  • New Features

    • Added support for Aurora PostgreSQL and Aurora MySQL datasources across multiple skills
  • Documentation

    • Updated skill documentation with clearer instructions and expanded datasource type guidance

Review Change Stack

@github-actions github-actions Bot added documentation Improvements or additions to documentation python Pull requests that update Python code rust Pull requests that update rust code core skills labels May 24, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 24, 2026

Walkthrough

This PR updates skill metadata and documentation to reflect Aurora PostgreSQL and Aurora MySQL as supported data sources. Version numbers are incremented for three skills, and their documentation is expanded with Aurora-specific guidance, connection examples, and datasource lists.

Changes

Skill Metadata and Documentation Updates

Layer / File(s) Summary
Version metadata updates
skills/index.json, skills/versions.json
Minor version bumps for wren-onboarding (2.1→2.2), wren-generate-mdl (2.2→2.3), and wren-usage (2.3→2.4) are recorded in both the main registry and version map.
Skill documentation: Aurora data source guidance
skills/wren-generate-mdl/SKILL.md, skills/wren-onboarding/SKILL.md, skills/wren-usage/SKILL.md
Version frontmatter incremented and documentation expanded to include aurora_postgres and aurora_mysql in datasource examples, connection guidance, and install instructions for all three skills.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • goldmedal
  • cyyeh
  • douenergy

Poem

🐰 Aurora shines in the skill docs now so bright,
With postgres and mysql dancing left and right,
Version bumps flutter like whiskers in the breeze,
Data flows smooth through databases with ease! 🌟

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
Title check ❓ Inconclusive The PR title is partially related to the changeset. While the changes do add Aurora PostgreSQL and MySQL support, the title uses 'docs:' prefix which incorrectly categorizes this as documentation-only. The changes include version increments across multiple skill files (index.json, versions.json, and SKILL.md files), which are structural changes beyond documentation. Consider using 'feat:' instead of 'docs:' to accurately reflect that this is a feature addition with version updates, not just documentation changes. Or clarify if the 'docs:' prefix is intentional for this type of skill update.
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
core/wren/src/wren/model/data_source.py (1)

107-139: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Missing timeout configuration for Aurora PostgreSQL.

The get_connection_info() method applies default connect_timeout and statement_timeout configuration for DataSource.postgres (lines 108-118), but DataSource.aurora_postgres is not handled. Since AuroraPostgresConnectionInfo inherits from PostgresConnectionInfo and supports the same connection parameters, Aurora PostgreSQL connections should receive the same timeout defaults.

🛠️ Proposed fix to add Aurora PostgreSQL timeout handling
         match self:
-            case DataSource.postgres:
+            case DataSource.postgres | DataSource.aurora_postgres:
                 kwargs = info.kwargs if info.kwargs else {}
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@core/wren/src/wren/model/data_source.py` around lines 107 - 139,
get_connection_info currently applies connect_timeout and statement_timeout only
for DataSource.postgres; add the same handling for DataSource.aurora_postgres by
adding a case for DataSource.aurora_postgres that mirrors the Postgres branch:
ensure info.kwargs exists, set kwargs["connect_timeout"] to 120 if missing,
compose/append the -c statement_timeout=...s into kwargs["options"] using
headers.get(X_WREN_DB_STATEMENT_TIMEOUT, 180), and assign back to info.kwargs;
reference the match on self and the DataSource.postgres branch to copy behavior.
🧹 Nitpick comments (1)
skills/index.json (1)

72-85: 💤 Low value

Consider adding tags for other documented datasources.

The tag list includes Aurora variants but omits several datasources that are documented in wren-usage/SKILL.md line 219 (clickhouse, trino, mssql, databricks, redshift, spark, athena, oracle). Adding these tags would improve skill discoverability when users search by datasource.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@skills/index.json` around lines 72 - 85, The tags array under the "tags" key
in skills/index.json is missing several documented datasource tags; update that
"tags" list (the array shown in the diff) to include clickhouse, trino, mssql,
databricks, redshift, spark, athena, and oracle so the skill matches the
datasources listed in wren-usage/SKILL.md and improves discoverability.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@core/wren/src/wren/model/data_source.py`:
- Around line 107-139: get_connection_info currently applies connect_timeout and
statement_timeout only for DataSource.postgres; add the same handling for
DataSource.aurora_postgres by adding a case for DataSource.aurora_postgres that
mirrors the Postgres branch: ensure info.kwargs exists, set
kwargs["connect_timeout"] to 120 if missing, compose/append the -c
statement_timeout=...s into kwargs["options"] using
headers.get(X_WREN_DB_STATEMENT_TIMEOUT, 180), and assign back to info.kwargs;
reference the match on self and the DataSource.postgres branch to copy behavior.

---

Nitpick comments:
In `@skills/index.json`:
- Around line 72-85: The tags array under the "tags" key in skills/index.json is
missing several documented datasource tags; update that "tags" list (the array
shown in the diff) to include clickhouse, trino, mssql, databricks, redshift,
spark, athena, and oracle so the skill matches the datasources listed in
wren-usage/SKILL.md and improves discoverability.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 20fa4f74-992c-4633-8744-af8afcecdfe2

📥 Commits

Reviewing files that changed from the base of the PR and between a523d7b and c4c2e67.

📒 Files selected for processing (11)
  • core/wren-core-base/manifest-macro/src/lib.rs
  • core/wren-core/core/src/mdl/dialect/inner_dialect.rs
  • core/wren/src/wren/connector/factory.py
  • core/wren/src/wren/model/__init__.py
  • core/wren/src/wren/model/data_source.py
  • core/wren/src/wren/model/field_registry.py
  • skills/index.json
  • skills/versions.json
  • skills/wren-generate-mdl/SKILL.md
  • skills/wren-onboarding/SKILL.md
  • skills/wren-usage/SKILL.md

Copy link
Copy Markdown
Contributor Author

@kartikshastrakar kartikshastrakar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

check

Commented in CodeRabbit Change Stack

Copy link
Copy Markdown
Contributor Author

@kartikshastrakar kartikshastrakar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

check

Commented in CodeRabbit Change Stack

@kartikshastrakar kartikshastrakar marked this pull request as draft May 24, 2026 04:47
@kartikshastrakar kartikshastrakar marked this pull request as ready for review May 24, 2026 04:48
@kartikshastrakar kartikshastrakar force-pushed the feat/add-clickhouse-aurora-support branch from c4c2e67 to 35e7ded Compare May 24, 2026 05:11
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@core/wren/src/wren/model/data_source.py`:
- Around line 88-89: The get_connection_info logic only applies Postgres timeout
defaults to DataSource.postgres, so update the conditional to also include
DataSource.aurora_postgres (e.g., change checks like "if datasource ==
DataSource.postgres" to "if datasource in (DataSource.postgres,
DataSource.aurora_postgres)" or add an equivalent branch) so that
connect_timeout and the "x-wren-db-statement_timeout" option are injected for
Aurora Postgres as well; reference the DataSource enum members postgres and
aurora_postgres and the get_connection_info function to locate and adjust the
code.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: e642a4be-2859-44f6-83cf-2991da317217

📥 Commits

Reviewing files that changed from the base of the PR and between c4c2e67 and 35e7ded.

📒 Files selected for processing (11)
  • core/wren-core-base/manifest-macro/src/lib.rs
  • core/wren-core/core/src/mdl/dialect/inner_dialect.rs
  • core/wren/src/wren/connector/factory.py
  • core/wren/src/wren/model/__init__.py
  • core/wren/src/wren/model/data_source.py
  • core/wren/src/wren/model/field_registry.py
  • skills/index.json
  • skills/versions.json
  • skills/wren-generate-mdl/SKILL.md
  • skills/wren-onboarding/SKILL.md
  • skills/wren-usage/SKILL.md
✅ Files skipped from review due to trivial changes (3)
  • skills/versions.json
  • skills/wren-usage/SKILL.md
  • skills/wren-onboarding/SKILL.md

Comment thread core/wren/src/wren/model/data_source.py Outdated
Comment on lines +88 to +89
aurora_postgres = auto()
aurora_mysql = auto()
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Apply Postgres timeout defaults to Aurora Postgres too.

Line 108 only matches DataSource.postgres, so Aurora Postgres skips connect_timeout and x-wren-db-statement_timeout option injection in get_connection_info.

Proposed fix
-            case DataSource.postgres:
+            case DataSource.postgres | DataSource.aurora_postgres:
                 kwargs = info.kwargs if info.kwargs else {}
                 if "connect_timeout" not in kwargs:
                     kwargs["connect_timeout"] = 120
                 options = kwargs.get("options", "")
                 if "statement_timeout" not in options:
                     if options:
                         options += " "
                     options += f"-c statement_timeout={headers.get(X_WREN_DB_STATEMENT_TIMEOUT, 180)}s"
                     kwargs["options"] = options
                 info.kwargs = kwargs
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@core/wren/src/wren/model/data_source.py` around lines 88 - 89, The
get_connection_info logic only applies Postgres timeout defaults to
DataSource.postgres, so update the conditional to also include
DataSource.aurora_postgres (e.g., change checks like "if datasource ==
DataSource.postgres" to "if datasource in (DataSource.postgres,
DataSource.aurora_postgres)" or add an equivalent branch) so that
connect_timeout and the "x-wren-db-statement_timeout" option are injected for
Aurora Postgres as well; reference the DataSource enum members postgres and
aurora_postgres and the get_connection_info function to locate and adjust the
code.

@goldmedal
Copy link
Copy Markdown
Collaborator

@kartikshastrakar, Thanks for working on this. However, I don't see anything different between the official PostgreSQL and Aurora ones. To reduce maintenance effort, if the behavior of the connection and syntax are the same, I think the Aurora user can just use the Postgres and MySQL connectors to connect to Aurora. No need to add a special data source in Wren AI.

@kartikshastrakar kartikshastrakar force-pushed the feat/add-clickhouse-aurora-support branch from 35e7ded to 0b218d0 Compare May 25, 2026 04:00
Copy link
Copy Markdown
Contributor Author

@kartikshastrakar kartikshastrakar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@goldmedal That completely makes sense! I agree that adding separate data sources creates unnecessary maintenance overhead since the standard ones work out of the box for Aurora.

I have reverted all the code changes from the core platform (wren-core, wren-core-base, wren-core-py, etc.). The codebase is now completely clean of any duplicate data sources.

Instead, I just updated the AI Agent Skills (wren-onboarding, wren-generate-mdl, wren-usage). This will teach the AI agents that if a user wants to connect to AWS Aurora, it should seamlessly route them through the standard postgres or mysql connectors.

I force-pushed these documentation updates. Let me know if these tweaks look good to merge!

@goldmedal goldmedal changed the title feat: add support for Aurora PostgreSQL and MySQL chore(doc): add support for Aurora PostgreSQL and MySQL May 25, 2026
@goldmedal goldmedal changed the title chore(doc): add support for Aurora PostgreSQL and MySQL docs: add support for Aurora PostgreSQL and MySQL May 25, 2026
Copy link
Copy Markdown
Collaborator

@goldmedal goldmedal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @kartikshastrakar, look great 👍

@goldmedal goldmedal merged commit 9c9ba89 into Canner:main May 25, 2026
6 checks passed
@kartikshastrakar
Copy link
Copy Markdown
Contributor Author

@goldmedal Thank you

@kartikshastrakar kartikshastrakar deleted the feat/add-clickhouse-aurora-support branch May 25, 2026 04:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core documentation Improvements or additions to documentation python Pull requests that update Python code rust Pull requests that update rust code skills

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants