Skip to content

update readme for 4.5 release#812

Closed
jiaoshuntian wants to merge 4 commits intoIvorySQL:masterfrom
jiaoshuntian:update-readme
Closed

update readme for 4.5 release#812
jiaoshuntian wants to merge 4 commits intoIvorySQL:masterfrom
jiaoshuntian:update-readme

Conversation

@jiaoshuntian
Copy link
Copy Markdown
Collaborator

@jiaoshuntian jiaoshuntian commented Jun 4, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Documentation
    • Updated links in both English and Chinese README files to reference IvorySQL 4.5 documentation.
    • Improved formatting of the installation methods list in the English README for better readability.
  • New Features
    • Added support for Oracle SQL*PLUS-compatible client commands (VARIABLE, PRINT) in psql.
    • Introduced bind variable management with declaration, assignment, listing, and printing capabilities.
    • Enhanced psql to parse and execute Oracle-style client commands with error handling and history support.
    • Added comprehensive tests validating Oracle-compatible variable and print command behavior.
  • Build
    • Integrated new lexer and parser components for Oracle-compatible commands into the psql build system.
  • Bug Fixes
    • Refined parallel test scheduling rules to include new Oracle psql tests and adjust concurrency constraints.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jun 4, 2025 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

This update adds Oracle-compatible client command support (VARIABLE and PRINT) to the psql tool, including new lexer and parser components, integration into the main input loop, and management of bind variables alongside shell variables. Documentation URLs were updated to IvorySQL 4.5. Build files were modified to include new sources. A comprehensive SQL test script was added for these commands.

Changes

File(s) Change Summary
README.md, README_CN.md Updated documentation URLs from version 4.4 to 4.5; adjusted installation method list formatting and anchor fragments.
src/bin/psql/Makefile, meson.build Added new build targets and rules for psqlplus lexer and parser sources; updated object file list.
src/bin/psql/mainloop.c Added parsing and execution logic for Oracle-compatible client commands in the main input loop for line 1 only.
src/bin/psql/psqlplus.h Added new header defining scanner interface, Oracle type OIDs, keyword categories, and function declarations.
src/bin/psql/psqlplusparse.y Added new Bison grammar for parsing VARIABLE and PRINT Oracle-compatible client commands with semantic actions.
src/bin/psql/psqlplusscan.l Added new Flex scanner for Oracle-compatible client commands with keyword recognition and literal handling.
src/bin/psql/variables.c, variables.h Extended variable management to support bind variables with type info, validation, and new functions for bind vars.
src/include/fe_utils/psqlscan_int.h Added new data structures and enums to support SQL*PLUS command parsing and bind variable tracking in lexer state.
src/oracle_fe_utils/ora_psqlscan.l Extended lexer reset function to clear new SQL*PLUS command state fields; added TODO comment about memory management.
src/oracle_test/regress/parallel_schedule Updated parallel test scheduling constraints; added ora_psql test group; adjusted collate test concurrency notes.
src/oracle_test/regress/sql/ora_psql.sql Added new SQL test script validating psql support for Oracle-compatible VARIABLE and PRINT commands.

Possibly related PRs

Poem

🐇 In psql’s burrow, new commands appear,
VARIABLE and PRINT now hop quite near.
Lexer and parser dance in sync,
Bind variables join the link.
Docs updated, tests all set,
IvorySQL’s best leap yet!
🌿✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 06a9b58 and 446af3f.

⛔ Files ignored due to path filters (2)
  • src/oracle_test/regress/expected/compression.out is excluded by !**/*.out
  • src/oracle_test/regress/expected/ora_psql.out is excluded by !**/*.out
📒 Files selected for processing (14)
  • README.md (1 hunks)
  • README_CN.md (1 hunks)
  • src/bin/psql/Makefile (3 hunks)
  • src/bin/psql/mainloop.c (2 hunks)
  • src/bin/psql/meson.build (1 hunks)
  • src/bin/psql/psqlplus.h (1 hunks)
  • src/bin/psql/psqlplusparse.y (1 hunks)
  • src/bin/psql/psqlplusscan.l (1 hunks)
  • src/bin/psql/variables.c (14 hunks)
  • src/bin/psql/variables.h (3 hunks)
  • src/include/fe_utils/psqlscan_int.h (2 hunks)
  • src/oracle_fe_utils/ora_psqlscan.l (1 hunks)
  • src/oracle_test/regress/parallel_schedule (1 hunks)
  • src/oracle_test/regress/sql/ora_psql.sql (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed Jun 4, 2025
View reviewed changes
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: 0

🧹 Nitpick comments (1)
README.md (1)

29-32: Consistent capitalization for RPM installation

The list item uses "Rpm" but the conventional acronym is "RPM". Consider updating for consistency:

- - [Rpm installation](https://docs.ivorysql.org/en/ivorysql-doc/v4.5/v4.5/6#Rpm-installation)
+ - [RPM installation](https://docs.ivorysql.org/en/ivorysql-doc/v4.5/v4.5/6#Rpm-installation)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d7154fd and 06a9b58.

📒 Files selected for processing (2)
  • README.md (1 hunks)
  • README_CN.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: contrib_regression
  • GitHub Check: build (ubuntu-latest)
  • GitHub Check: meson_build (ubuntu-latest)
  • GitHub Check: oracle_pg_regression (ubuntu-latest)
  • GitHub Check: oracle_regression (ubuntu-latest)
  • GitHub Check: pg_regression (ubuntu-latest)
🔇 Additional comments (3)
README_CN.md (2)

24-26: Update Quick Start and detailed installation links to v4.5

The URLs have been correctly bumped from v4.4 to v4.5 for both the Quick Start guide and the detailed installation docs.

27-30: Verify installation methods list links and formatting

The four installation methods are now properly listed. Ensure the link anchors (e.g., #Yum-installation, #Source-code-installation) match the actual section IDs in the v4.5 Chinese documentation.

README.md (1)

26-28: Update Quick Start and Installation Docs links to v4.5

The Quick Start and Installation Docs URLs have been updated to v4.5. Please confirm the duplicate v4.5/v4.5 segments in the path are intentional and resolve correctly.

@jiaoshuntian jiaoshuntian deleted the update-readme branch June 4, 2025 06:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jiaoshuntian @myzhen