Skip to content

feat: migrator support to change table column#813

Merged
hwbrzzl merged 5 commits intogoravel:masterfrom
almas-x:migrator
Jan 11, 2025
Merged

feat: migrator support to change table column#813
hwbrzzl merged 5 commits intogoravel:masterfrom
almas-x:migrator

Conversation

@almas-x
Copy link
Contributor

@almas-x almas-x commented Jan 9, 2025

📑 Description

Go migrator support to change table column

func (r *M20250108083539UpdateTestTable) Up() error {
	return facades.Schema().Table("test", func(table schema.Blueprint) {
		table.String("votes", 120).Comment("tes change").Change()
	})
}

Closes goravel/goravel#541

@coderabbitai summary

✅ Checks

  • Added test cases for my code

@almas-x almas-x requested a review from a team as a code owner January 9, 2025 11:01
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 9, 2025

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)
  • 🚀 Review Ready

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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.

@codecov
Copy link

codecov bot commented Jan 9, 2025

Codecov Report

Attention: Patch coverage is 88.60759% with 9 lines in your changes missing coverage. Please review.

Project coverage is 69.63%. Comparing base (28200d6) to head (5e1e1e5).
Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
database/schema/grammars/sqlite.go 0.00% 4 Missing ⚠️
database/schema/grammars/mysql.go 66.66% 2 Missing ⚠️
database/schema/grammars/postgres.go 92.30% 2 Missing ⚠️
database/schema/grammars/sqlserver.go 95.23% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #813      +/-   ##
==========================================
+ Coverage   69.56%   69.63%   +0.06%     
==========================================
  Files         215      215              
  Lines       18508    18577      +69     
==========================================
+ Hits        12876    12936      +60     
- Misses       4965     4974       +9     
  Partials      667      667              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@almas-x
Copy link
Contributor Author

almas-x commented Jan 9, 2025

Review Ready

Copy link
Contributor

@hwbrzzl hwbrzzl left a comment

Choose a reason for hiding this comment

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

Amazing PR 👍 please add some test cases in the schema_test.go file.

return fmt.Sprintf("alter table %s add column %s", r.wrap.Table(blueprint.GetTableName()), r.getColumn(blueprint, command.Column))
}

func (r *Sqlite) CompileChange(blueprint schema.Blueprint, command *schema.Command) []string {
Copy link
Contributor

Choose a reason for hiding this comment

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

The biggest difficulty is to implement the Change feature for Sqlite, it's also the reason that the feature isn't implemented in v1.15. Any thoughts, please?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The limitations of SQLite make implementing the Change feature overly complex. Specifically, modifying a column requires creating a new table and migrating data, which introduces a higher risk of failure and potential data loss. Therefore, I believe it’s a prudent choice to forgo support for column modification in SQLite. After all, the use cases for SQLite are typically limited in scope, and applications using it are generally not overly complex, meaning the need for modifying columns is rarely urgent.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, there is a higher risk to change a field in Sqlite, we have to copy entire DB, change the field, then remove the old DB. @kkumar-gcc @devhaozi What do you think about not implementing the Change feature for Sqlite, please? If all agree, we cannot implement it, at least for now.

Copy link
Member

Choose a reason for hiding this comment

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

Agree, since SQLite is not widely used in complex applications. Let's not implement it for now, but if someone requires it in the future, we can always implement it.

@almas-x
Copy link
Contributor Author

almas-x commented Jan 10, 2025

Review Ready

@almas-x
Copy link
Contributor Author

almas-x commented Jan 10, 2025

Review Read

Copy link
Contributor

@hwbrzzl hwbrzzl left a comment

Choose a reason for hiding this comment

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

Perfect

@hwbrzzl hwbrzzl merged commit 458efb9 into goravel:master Jan 11, 2025
@almas-x almas-x deleted the migrator branch January 11, 2025 09:18
hwbrzzl pushed a commit that referenced this pull request Jan 13, 2025
* feat: migrator support to change table column

* fix lint issue

* improve unit test

* add compile default for sql server and improve unit test

* add more test case
@almas-x
Copy link
Contributor Author

almas-x commented Jan 23, 2025

Should this PR be cherry-picked into the 1.5.13 version? @hwbrzzl

almas-x added a commit that referenced this pull request Jan 23, 2025
* feat: migrator support to change table column

* fix lint issue

* improve unit test

* add compile default for sql server and improve unit test

* add more test case

(cherry picked from commit 458efb9)
almas-x added a commit that referenced this pull request Jan 23, 2025
* feat: migrator support to change table column

* fix lint issue

* improve unit test

* add compile default for sql server and improve unit test

* add more test case

(cherry picked from commit 458efb9)
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.

✨ [Feature] Go migrator support to change table column

3 participants