chore: deprecate unused SchemaBuilder methods

[taka-oyama]

Summary by CodeRabbit

• Documentation
  • Added deprecation notices to certain index-related methods, indicating they will be removed in a future version and suggesting alternative usage.

[coderabbitai]

Walkthrough

The Builder class in the schema component has been updated to mark the dropIndex and dropIndexIfExist methods as deprecated. Docblock annotations now indicate these methods will be removed in version 10.0 and recommend using Blueprint::dropIndex() instead. No changes were made to the methods' logic.

Changes

File(s)	Change Summary
src/Schema/Builder.php	Added @deprecated docblock annotations to dropIndex and dropIndexIfExist methods, indicating future removal and suggesting use of Blueprint::dropIndex() instead.

Tip

⚡️ Faster reviews with caching

• CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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]

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/Schema/Builder.php (2)

57-58: Suggest adding runtime deprecation warning and version metadata
The @deprecated docblock is a good first step, but developers may overlook it. Enhance clarity by specifying the version since deprecation (e.g., since v9.0) and emit a runtime notice via trigger_error().

@@ class Builder {
-    /**
-     * @deprecated Use Blueprint::dropIndex() instead. Will be removed in v10.0.
+    /**
+     * @deprecated since v9.0 Use Blueprint::dropIndex() instead. Will be removed in v10.0.
@@ public function dropIndex($table, $name)
+        trigger_error(
+            __METHOD__ . ' is deprecated and will be removed in v10.0. Use Blueprint::dropIndex() instead.',
+            E_USER_DEPRECATED
+        );
         $blueprint = $this->createBlueprint($table);
         $blueprint->dropIndex($name);
         $this->build($blueprint);

---

71-72: Suggest adding runtime deprecation warning and version metadata
Apply the same enhancement to dropIndexIfExist: include since version in the docblock and trigger a E_USER_DEPRECATED notice at the top of the method.

@@ class Builder {
-    /**
-     * @deprecated Use Blueprint::dropIndex() instead. Will be removed in v10.0.
+    /**
+     * @deprecated since v9.0 Use Blueprint::dropIndex() instead. Will be removed in v10.0.
@@ public function dropIndexIfExist($table, $name)
+        trigger_error(
+            __METHOD__ . ' is deprecated and will be removed in v10.0. Use Blueprint::dropIndex() instead.',
+            E_USER_DEPRECATED
+        );
         if (in_array($name, $this->getIndexes($table), true)) {
             $blueprint = $this->createBlueprint($table);
             $blueprint->dropIndex($name);

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bd0adbe and 7f11f9a.

📒 Files selected for processing (1)

• src/Schema/Builder.php (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Run-PHPUnit