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

Adjust migration settings based on database engine #2236

Merged
merged 9 commits into from
Jan 8, 2024

Conversation

strickvl
Copy link
Contributor

@strickvl strickvl commented Jan 8, 2024

This pull request adjusts the migration settings based on the requirements of the database engine. It fixes the primary key requirement for MySQL and MariaDB engines.

We want to run DB migration testing for MariaDB following #2155, but before we can do that, we need to fix this one migration which is incompatible with MariaDB. I added a check for mariadb and execute a similar setting of the variable, but note that it is only able to be set globally.

Summary by CodeRabbit

  • Refactor
    • Improved database schema to enhance data management.

@strickvl strickvl requested a review from safoinme January 8, 2024 08:40
@strickvl strickvl added bug Something isn't working internal To filter out internal PRs and issues labels Jan 8, 2024
@strickvl strickvl requested a review from schustmi January 8, 2024 08:40
Copy link
Contributor

coderabbitai bot commented Jan 8, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

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.

Walkthrough

The recent update involves modifying the database schema by adding a new column to the primary key of the input artifact table. This includes dropping the existing primary key constraint and creating a new one that incorporates the additional column. The downgrade process is also catered for, which involves reverting the changes based on the specific database engine being used.

Changes

File Path Change Summary
.../migrations/versions/728c6369cfaa_add_name_column_to_input_artifact_pk.py Introduced a new column to the primary key of the input artifact table. The upgrade function updates the primary key constraint, while the downgrade function reverts the changes with engine-specific adjustments.

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@strickvl
Copy link
Contributor Author

strickvl commented Jan 8, 2024

@coderabbitai review

Copy link
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.

Review Status

Actionable comments generated: 1

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 3387404 and a71425e.
Files selected for processing (1)
  • src/zenml/zen_stores/migrations/versions/728c6369cfaa_add_name_column_to_input_artifact_pk.py (2 hunks)
Additional comments: 2
src/zenml/zen_stores/migrations/versions/728c6369cfaa_add_name_column_to_input_artifact_pk.py (2)
  • 52-52: The upgrade function correctly drops and recreates the primary key constraint. However, ensure that this operation is safe and does not lead to data inconsistencies, especially in a production environment.

  • 131-142: The conditional logic for setting session variables based on the database engine and version is well-implemented. However, it's crucial to ensure that these settings are only temporary and do not persist beyond the scope of the migration, as they could have unintended side effects.

@strickvl strickvl merged commit 809cad8 into develop Jan 8, 2024
32 checks passed
@strickvl strickvl deleted the bugfix/disable-mariadb-incompatible-migration branch January 8, 2024 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working internal To filter out internal PRs and issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants