Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: rename table support #259

Merged
merged 3 commits into from
Jan 31, 2025
Merged

feat: rename table support #259

merged 3 commits into from
Jan 31, 2025

Conversation

taka-oyama
Copy link
Collaborator

@taka-oyama taka-oyama commented Jan 17, 2025

Closes #198

Summary by CodeRabbit

  • New Features

    • Added support for table renaming with optional synonym management
    • Introduced methods to add and drop table synonyms
    • Enhanced schema manipulation capabilities for database operations
  • Tests

    • Added comprehensive test coverage for new table renaming and synonym management functionality

@taka-oyama taka-oyama added enhancement New feature or request waiting for review labels Jan 17, 2025
@taka-oyama taka-oyama requested a review from a team January 17, 2025 06:23
@taka-oyama taka-oyama self-assigned this Jan 17, 2025
Copy link

coderabbitai bot commented Jan 17, 2025

Walkthrough

The pull request introduces comprehensive support for table renaming and synonym management in the Spanner schema migration system. The changes include adding new methods to the Blueprint, Grammar, and a new RenameDefinition class to facilitate table renaming operations. These modifications enable developers to rename tables, add synonyms, and drop synonyms using a fluent interface, aligning with Google Cloud Spanner's table name synonym functionality.

Changes

File Change Summary
src/Schema/Blueprint.php Added three new public methods: rename(), addSynonym(), and dropSynonym() to support table renaming and synonym management
src/Schema/Grammar.php Added three new compilation methods: compileRename(), compileAddSynonym(), and compileDropSynonym() to generate corresponding SQL statements
src/Schema/RenameDefinition.php New class introduced to encapsulate rename and synonym operations, extending Illuminate\Support\Fluent
tests/Schema/BlueprintTest.php Added five new test methods to verify table renaming, synonym addition, and synonym dropping functionality

Assessment against linked issues

Objective Addressed Explanation
Rename table support [#198]
Support table name synonyms

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • 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.

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. (Beta)
  • @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.

Copy link

@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)
src/Schema/Grammar.php (1)

222-239: Consider using parameterized values for SQL generation.

While the current implementation uses the wrapTable method for escaping, consider using parameterized values for better SQL injection protection.

-        $schema = "alter table {$from} rename to {$to}";
+        $schema = sprintf('alter table %s rename to %s',
+            $from,
+            $to
+        );
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between eb3984c and 2ffefa7.

📒 Files selected for processing (4)
  • src/Schema/Blueprint.php (1 hunks)
  • src/Schema/Grammar.php (1 hunks)
  • src/Schema/RenameDefinition.php (1 hunks)
  • tests/Schema/BlueprintTest.php (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Run-PHPUnit
🔇 Additional comments (12)
src/Schema/RenameDefinition.php (2)

23-29: LGTM! Well-documented class definition.

The class is well-structured with clear PHPDoc annotations for properties and methods.


32-39: LGTM! Clean constructor implementation.

The constructor properly initializes the required properties through the parent Fluent class.

src/Schema/Blueprint.php (3)

311-319: LGTM! Clean implementation of rename method.

The method follows the class's pattern for schema modifications and properly integrates with the command system.


321-329: LGTM! Well-implemented addSynonym method.

The method correctly creates a RenameDefinition with synonym support.


331-339: LGTM! Consistent dropSynonym implementation.

The method maintains consistency with the other synonym-related methods.

src/Schema/Grammar.php (2)

241-251: LGTM! Clean addSynonym compilation.

The method properly generates the SQL for adding a synonym.


253-263: LGTM! Consistent dropSynonym compilation.

The method maintains consistency with other SQL generation methods.

tests/Schema/BlueprintTest.php (5)

371-390: LGTM! Good test coverage for basic rename.

The test properly verifies the basic table rename functionality.


392-411: LGTM! Well-tested synonym support.

The test thoroughly verifies renaming with synonym creation.


413-432: LGTM! Comprehensive custom synonym testing.

The test properly verifies custom synonym naming functionality.


434-453: LGTM! Good coverage of addSynonym.

The test verifies standalone synonym addition.


455-478: LGTM! Complete synonym lifecycle testing.

The test properly verifies the full lifecycle of synonym operations including cleanup.

Copy link
Contributor

@halnique halnique left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@taka-oyama taka-oyama merged commit 1e53489 into master Jan 31, 2025
1 check passed
@taka-oyama taka-oyama deleted the feature/rename-table branch January 31, 2025 00:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request waiting for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename table support
2 participants