Skip to content

docs: complete package command reference#1421

Open
Z95-cmyk wants to merge 1 commit into
IvorySQL:masterfrom
Z95-cmyk:docs-package-reference
Open

docs: complete package command reference#1421
Z95-cmyk wants to merge 1 commit into
IvorySQL:masterfrom
Z95-cmyk:docs-package-reference

Conversation

@Z95-cmyk

@Z95-cmyk Z95-cmyk commented Jul 19, 2026

Copy link
Copy Markdown

Why

The package command reference pages contain only skeletal synopses, and several forms do not match the Oracle parser. In particular, ALTER PACKAGE ... COMPILE is documented but unsupported, while supported ALTER and DROP forms are missing. The CREATE PACKAGE BODY entity also points to a nonexistent file name, so that page is omitted from the manual and its cross-references cannot be validated.

What Changed

  • Documented the supported syntax, behavior, privileges, parameters, examples, and compatibility notes for CREATE PACKAGE, CREATE PACKAGE BODY, ALTER PACKAGE, and DROP PACKAGE.
  • Corrected AUTHID, default collation, mandatory IS/AS, IF EXISTS, multi-name drop, and dependency behavior in the command synopses.
  • Removed unsupported package recompilation syntax from the reference.
  • Documented the current runtime limits of compatibility-only package clauses.
  • Corrected the package body entity path so the page is included in the manual.

Verification

The full out-of-tree doc/src/sgml check passes, including DocBook DTD validation, cross-reference validation, tab checks, and non-breaking-space checks.

Related issue

Fixes #1425

AI assistance disclosure

This contribution was prepared with OpenAI Codex using GPT-5. The agent assisted with source and test inspection, issue scoping, drafting code, documentation and tests where applicable, running verification, and preparing the PR description. I directed the scope, reviewed the resulting changes against the source and test results, and remain responsible for the submission.

Assisted-by: OpenAI:Codex
@coderabbitai

coderabbitai Bot commented Jul 19, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

@Z95-cmyk, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 59 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 1bffe8cf-7acd-4e0a-9c4b-46a12e70cfa6

📥 Commits

Reviewing files that changed from the base of the PR and between 15d3b5b and 614f051.

📒 Files selected for processing (5)
  • doc/src/sgml/ref/allfiles.sgml
  • doc/src/sgml/ref/alter_package.sgml
  • doc/src/sgml/ref/create_package.sgml
  • doc/src/sgml/ref/create_package_body.sgml
  • doc/src/sgml/ref/drop_package.sgml
✨ 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.

@Z95-cmyk
Z95-cmyk marked this pull request as ready for review July 20, 2026 04:47
@hs-liuxh

Copy link
Copy Markdown
Collaborator

Thanks for the careful work here — and for the clear AI-assistance disclosure.

For direction: IvorySQL is consolidating user-facing documentation into a dedicated docs repo, so new documentation should generally go there rather than into doc/src/sgml in this repo.

That said, this PR is a special case and we've decided to merge it here. It fixes a real bug that breaks the doc build, corrects some inaccurate info, and fills in the package reference pages. After this, make html succeeds.

Thanks again for the contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: complete the package command reference

2 participants