docs: fix inaccurate GUC name in README for 5.4 release by messere1 · Pull Request #1384 · IvorySQL/IvorySQL

messere1 · 2026-07-09T09:00:55Z

Related Issue

Motivation

Issue #1358 asks to update the README for the 5.4 release. The installation links were already bumped from v5.3 to v5.4 in commit fa976fed, but the README still contained an inaccurate GUC parameter name. The README described the Oracle/PostgreSQL compatibility switch as a compatible_db toggle switch, while the actual configuration parameter is named compatible_mode (full name ivorysql.compatible_mode, accepting values oracle / pg).

This was verified against the source tree — the GUC is referenced as ivorysql.compatible_mode throughout the regression test suite (e.g. contrib/ivorysql_ora/sql/ora_sysview.sql, contrib/ivorysql_ora/sql/ora_like_operator.sql).

Changes

README.md: compatible_db toggle switch → compatible_mode GUC parameter
README_CN.md: compatible_db 开关 → compatible_mode GUC 参数

Both the English and Chinese READMEs are updated to keep them in sync.

How Verified

Documentation-only change, no code or build impact.
Confirmed the GUC name ivorysql.compatible_mode via grep across the codebase (test SQL files and expected output).

Summary by CodeRabbit

Documentation
- Updated the English and Chinese READMEs to reflect the current Oracle/PostgreSQL compatibility switching mechanism.
- Clarified that compatibility is controlled via the compatible_mode GUC parameter, replacing the previously documented toggle name.

The README described the Oracle/PostgreSQL compatibility switch as a 'compatible_db' toggle, but the actual GUC parameter is named 'compatible_mode' (ivorysql.compatible_mode = oracle | pg). Update both the English and Chinese READMEs to use the correct parameter name. See issue IvorySQL#1358.

coderabbitai · 2026-07-09T09:01:46Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 732ec3ef-8932-4a9b-8491-9543700ed7a0

📥 Commits

Reviewing files that changed from the base of the PR and between d1a092b and 0453571.

📒 Files selected for processing (1)

README.md

✅ Files skipped from review due to trivial changes (1)

README.md

📝 Walkthrough

Walkthrough

Both README files now describe compatible_mode as the GUC parameter for switching IvorySQL’s Oracle/PostgreSQL compatibility modes.

Changes

README terminology update

Layer / File(s)	Summary
Update compatibility mode terminology `README.md`, `README_CN.md`	Compatibility-mode descriptions replace the `compatible_db` toggle switch with the `compatible_mode` GUC parameter.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

IvorySQL/IvorySQL#762: Related README compatibility-mode terminology covering the earlier compatible_db wording.
IvorySQL/IvorySQL#923: Related implementation work for the compatible_mode GUC.

Suggested reviewers: bigplaice

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the README documentation fix for the GUC name in the 5.4 release.
Linked Issues check	✅ Passed	The README and README_CN updates match issue `#1358` by correcting the documented compatibility switch name.
Out of Scope Changes check	✅ Passed	The changes stay within documentation updates and wording fixes for the stated README release note scope.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ 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.}

Copilot

Pull request overview

This PR updates IvorySQL’s English and Chinese READMEs for the 5.4 release by correcting the documented name of the Oracle/PostgreSQL compatibility GUC so users configure the intended setting.

Changes:

Replace the outdated compatible_db mention with compatible_mode in README.md.
Replace the outdated compatible_db mention with compatible_mode in README_CN.md.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
README.md	Updates the documented compatibility switch GUC name in the English README.
README_CN.md	Updates the documented compatibility switch GUC name in the Chinese README to stay in sync.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


 IvorySQL is developed based on [PostgreSQL](https://github.com/postgres/postgres). 
-IvorySQL is advanced, fully featured, open source Oracle compatible PostgreSQL with a firm commitment to always remain 100% compatible and a Drop-in replacement of the latest PostgreSQL. IvorySQL adds a “compatible_db” toggle switch to switch between Oracle and PostgreSQL compatibility modes.
+IvorySQL is advanced, fully featured, open source Oracle compatible PostgreSQL with a firm commitment to always remain 100% compatible and a Drop-in replacement of the latest PostgreSQL. IvorySQL adds the `compatible_mode` GUC parameter to switch between Oracle and PostgreSQL compatibility modes.


 [English](README.md) | 中文

-IvorySQL 基于开源[PostgreSQL](https://github.com/postgres/postgres)数据库。是一款先进、功能全面的开源 Oracle 兼容 PostgreSQL，始终承诺100% 兼容最新版本的 PostgreSQL，并可作为其无缝替代方案。IvorySQL 增加了一个 “compatible_db” 开关，支持在 Oracle 和 PostgreSQL 兼容模式之间自由切换。IvorySQL 的一大亮点是 PL/iSQL 过程式语言，它兼容 Oracle 的 PL/SQL 语法并支持 Oracle 风格的 Package。
+IvorySQL 基于开源[PostgreSQL](https://github.com/postgres/postgres)数据库。是一款先进、功能全面的开源 Oracle 兼容 PostgreSQL，始终承诺100% 兼容最新版本的 PostgreSQL，并可作为其无缝替代方案。IvorySQL 增加了 `compatible_mode` GUC 参数，支持在 Oracle 和 PostgreSQL 兼容模式之间自由切换。IvorySQL 的一大亮点是 PL/iSQL 过程式语言，它兼容 Oracle 的 PL/SQL 语法并支持 Oracle 风格的 Package。


coderabbitai

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 `@README.md`:
- Line 14: Update the README description text to hyphenate “open-source” in the
sentence describing IvorySQL; this is a wording-only change, so adjust the
wording in the README content itself and keep the rest of the description
unchanged.

🪄 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 9172f269-1da2-4ee1-905f-3bb72d1037bc

📥 Commits

Reviewing files that changed from the base of the PR and between 7fb2571 and e03c2d8.

📒 Files selected for processing (2)

README.md
README_CN.md

bigplaice · 2026-07-10T02:13:29Z

@hs-liuxh please follow up this pr.

Apply review suggestion on PR IvorySQL#1384: hyphenate the compound modifiers open-source and drop-in in the sentence already touched by this PR. Assisted-by: Claude Code:claude-fable-5 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

coderabbitai

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 `@README.md`:
- Line 14: Update the IvorySQL description in the README to use
“Oracle-compatible” with a hyphen and change “replacement of the latest
PostgreSQL” to “replacement for the latest PostgreSQL,” without altering the
surrounding meaning.

🪄 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 0b75b9b7-1ea9-427d-bf0d-72e39c1bdcc8

📥 Commits

Reviewing files that changed from the base of the PR and between e03c2d8 and d1a092b.

📒 Files selected for processing (1)

README.md

Hyphenate "Oracle-compatible" and use "replacement for" instead of "replacement of", as suggested in the follow-up review on PR IvorySQL#1384. Assisted-by: Claude Code:claude-fable-5 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Copilot AI review requested due to automatic review settings July 9, 2026 09:00

Copilot started reviewing on behalf of messere1 July 9, 2026 09:01 View session

Copilot AI reviewed Jul 9, 2026

View reviewed changes

coderabbitai Bot reviewed Jul 9, 2026

View reviewed changes

Comment thread README.md Outdated

coderabbitai Bot reviewed Jul 10, 2026

View reviewed changes

Comment thread README.md Outdated

docs: apply remaining wording fixes per review

0453571

Hyphenate "Oracle-compatible" and use "replacement for" instead of "replacement of", as suggested in the follow-up review on PR IvorySQL#1384. Assisted-by: Claude Code:claude-fable-5 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: fix inaccurate GUC name in README for 5.4 release#1384

docs: fix inaccurate GUC name in README for 5.4 release#1384
messere1 wants to merge 3 commits into
IvorySQL:masterfrom
messere1:docs/issue-1358-readme-5.4

messere1 commented Jul 9, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jul 9, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

Copilot AI left a comment

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

bigplaice commented Jul 10, 2026

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

messere1 commented Jul 9, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related Issue

Motivation

Changes

How Verified

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bigplaice commented Jul 10, 2026

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

messere1 commented Jul 9, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jul 9, 2026 •

edited

Loading