Skip to content

chore(doc): update supported data source#1409

Merged
douenergy merged 2 commits intoCanner:mainfrom
goldmedal:chore/update-supported-ds
Jan 22, 2026
Merged

chore(doc): update supported data source#1409
douenergy merged 2 commits intoCanner:mainfrom
goldmedal:chore/update-supported-ds

Conversation

@goldmedal
Copy link
Copy Markdown
Contributor

@goldmedal goldmedal commented Jan 22, 2026

  • update Athena, Databricks, Redshift, and Apache Spark in README.

Summary by CodeRabbit

  • Documentation
    • Updated BigQuery data source reference.
    • Expanded Supported Data Sources with eight additions: Minio, MySQL Server, Oracle Server, PostgreSQL Server, Athena, Databricks, Redshift, and Apache Spark.

✏️ Tip: You can customize this high-level summary in your review settings.

@goldmedal goldmedal requested a review from douenergy January 22, 2026 05:08
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 22, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jan 22, 2026

📝 Walkthrough

Walkthrough

README.md updated: corrected BigQuery link target and expanded the Supported Data Sources list with eight new entries (Minio, MySQL Server, Oracle Server, PostgreSQL Server, Athena, Databricks, Redshift, Apache Spark).

Changes

Cohort / File(s) Summary
README documentation update
README.md
Changed BigQuery link target from BigQueryConnectionInfo to BigQueryProjectConnectionInfo; added new Supported Data Sources entries: Minio, MySQL Server, Oracle Server, PostgreSQL Server, Athena, Databricks, Redshift, Apache Spark; updated anchors (typo "Apache Saprk" present).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • Update README.md #1168: Modifies the same README "Supported Data Sources" section and adds overlapping data source entries (Minio, MySQL, Oracle, PostgreSQL).

Suggested reviewers

  • douenergy

Poem

🐰 I hopped through docs with eyes so keen,
Fixed BigQuery's path to the right machine,
Invited eight engines to join the play,
Minio, MySQL, and Spark at bay—
A tiny typo skipped my keen-eyed beam.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating supported data sources in the documentation. It is concise, clear, and directly related to the README modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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


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.

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In `@README.md`:
- Line 46: Correct the typo "Apache Saprk" to "Apache Spark" in the README link
text (search for the literal "Apache Saprk" or the link line referencing
getwren.ai/oss/wren_engine_api#tag/SparkConnectionInfo) so the displayed text
reads "[Apache
Spark](https://docs.getwren.ai/oss/wren_engine_api#tag/SparkConnectionInfo)";
keep the URL unchanged and update only the visible link label.
- Around line 43-46: The README contains a typo in the link display text "Apache
Saprk" — update that string to "Apache Spark" in the README (replace the
incorrect "Apache Saprk" token so the list entry reads "Apache Spark" while
keeping the existing link unchanged).
🧹 Nitpick comments (1)
README.md (1)

31-46: Consider alphabetizing the data sources list for better discoverability.

The supported data sources list is not in alphabetical order. Alphabetizing the list would improve user experience by making it easier for users to quickly locate specific data sources.

📋 Suggested alphabetical ordering
 ## 🔌 Supported Data Sources
+- [Amazon S3](https://docs.getwren.ai/oss/wren_engine_api#tag/S3FileConnectionInfo)
+- [Apache Spark](https://docs.getwren.ai/oss/wren_engine_api#tag/SparkConnectionInfo)
+- [Athena](https://docs.getwren.ai/oss/wren_engine_api#tag/AthenaConnectionInfo)
 - [BigQuery](https://docs.getwren.ai/oss/wren_engine_api#tag/BigQueryProjectConnectionInfo)
+- [Databricks](https://docs.getwren.ai/oss/wren_engine_api#tag/DatabricksTokenConnectionInfo)
 - [Google Cloud Storage](https://docs.getwren.ai/oss/wren_engine_api#tag/GcsFileConnectionInfo)
 - [Local Files](https://docs.getwren.ai/oss/wren_engine_api#tag/LocalFileConnectionInfo)
+- [Minio](https://docs.getwren.ai/oss/wren_engine_api#tag/MinioFileConnectionInfo)
 - [MS SQL Server](https://docs.getwren.ai/oss/wren_engine_api#tag/MSSqlConnectionInfo)
-- [Minio](https://docs.getwren.ai/oss/wren_engine_api#tag/MinioFileConnectionInfo)
 - [MySQL Server](https://docs.getwren.ai/oss/wren_engine_api#tag/MySqlConnectionInfo)
 - [Oracle Server](https://docs.getwren.ai/oss/wren_engine_api#tag/OracleConnectionInfo)
 - [PostgreSQL Server](https://docs.getwren.ai/oss/wren_engine_api#tag/PostgresConnectionInfo)
-- [Amazon S3](https://docs.getwren.ai/oss/wren_engine_api#tag/S3FileConnectionInfo)
+- [Redshift](https://docs.getwren.ai/oss/wren_engine_api#tag/RedshiftConnectionInfo)
 - [Snowflake](https://docs.getwren.ai/oss/wren_engine_api#tag/SnowflakeConnectionInfo)
 - [Trino](https://docs.getwren.ai/oss/wren_engine_api#tag/TrinoConnectionInfo)
-- [Athena](https://docs.getwren.ai/oss/wren_engine_api#tag/AthenaConnectionInfo)
-- [Databricks](https://docs.getwren.ai/oss/wren_engine_api#tag/DatabricksTokenConnectionInfo)
-- [Redshift](https://docs.getwren.ai/oss/wren_engine_api#tag/RedshiftConnectionInfo)
-- [Apache Saprk](https://docs.getwren.ai/oss/wren_engine_api#tag/SparkConnectionInfo)

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@douenergy douenergy merged commit cc01486 into Canner:main Jan 22, 2026
7 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Mar 19, 2026
nhaluc1005 pushed a commit to nhaluc1005/text2sql-practice that referenced this pull request Apr 3, 2026
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants