Improve the efficiency of some SQL queries

[schustmi]

Describe changes

TODO:

• verify whether index is helpful and either remove it or generate DB migration for it
• Implement cascade deletion for tag resources and run metadata resources

Pre-requisites

Please ensure you have done the following:

• I have read the CONTRIBUTING.md document.
• I have added tests to cover my changes.
• I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
• IMPORTANT: I made sure that my changes are reflected properly in the following resources:
  • ZenML Docs
  • Dashboard: Needs to be communicated to the frontend team.
  • Templates: Might need adjustments (that are not reflected in the template tests) in case of non-breaking changes and deprecations.
  • Projects: Depending on the version dependencies, different projects might get affected.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Other (add details above)

Summary by CodeRabbit

• New Features

  • Updated schema definitions for artifacts, models, and pipeline runs to enhance clarity and relationships.
  • Introduced a composite index in the RunMetadataResourceSchema for improved query performance.

• Bug Fixes

  • Adjusted various relationship configurations to ensure correct linking between schemas.

• Chores

  • Removed unnecessary relationships and type checking imports to simplify schema structures.

[coderabbitai]

Important

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.

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

📝 Walkthrough

📝 Walkthrough

Walkthrough

The changes in this pull request primarily involve renaming and restructuring schema definitions across various files in the ZenML project. Specifically, RunMetadataResourceSchema and TagResourceSchema have been replaced with RunMetadataSchema and TagSchema, respectively, affecting multiple classes such as ArtifactSchema, ModelSchema, and PipelineRunSchema. Additionally, relationships and field names have been updated to reflect these new schemas, enhancing clarity and consistency in the data model. The modifications also include simplifications in list comprehensions and adjustments to join conditions in SQLAlchemy relationships.

Changes

File Path	Change Summary
src/zenml/zen_stores/schemas/artifact_schemas.py	- Renamed RunMetadataResourceSchema to RunMetadataSchema and TagResourceSchema to TagSchema. - Updated tags and run_metadata fields in schemas.
src/zenml/zen_stores/schemas/model_schemas.py	- Renamed imports and updated tags and run_metadata fields in ModelSchema and ModelVersionSchema.
src/zenml/zen_stores/schemas/pipeline_run_schemas.py	- Updated imports and renamed run_metadata_resources to run_metadata. - Modified relationship configurations for tags and run_metadata.
src/zenml/zen_stores/schemas/pipeline_schemas.py	- Changed TagResourceSchema to TagSchema in PipelineSchema. - Updated relationship join conditions for tags.
src/zenml/zen_stores/schemas/run_metadata_schemas.py	- Added an index to RunMetadataResourceSchema. - Removed several relationships from RunMetadataResourceSchema.
src/zenml/zen_stores/schemas/run_template_schemas.py	- Updated import for TagResourceSchema to TagSchema. - Modified tags relationship configuration in RunTemplateSchema.
src/zenml/zen_stores/schemas/step_run_schemas.py	- Renamed run_metadata_resources to run_metadata and updated its relationship configuration.
src/zenml/zen_stores/schemas/tag_schemas.py	- Removed type checking imports and relationships from TagResourceSchema, retaining only TagSchema.
src/zenml/zen_stores/schemas/utils.py	- Updated method docstrings and internal references in RunMetadataInterface to reflect changes in the data structure.

Possibly related PRs

• Update bentoml integration to 1.3.5 and add containerization #3045: The changes in this PR involve updates to the bentoml integration, including modifications to deployment services that are relevant to the schema changes in the main PR, particularly regarding how models and their metadata are handled in the context of deployment.

🐰 In the land of code where schemas roam,
We’ve renamed the tags to make them feel at home.
RunMetadata and TagSchema take their place,
Simplifying links, bringing clarity and grace.
With relationships clear and models aligned,
Our data flows smoothly, perfectly designed! 🌟

---

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

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

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

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.

[htahir1]

@coderabbitai summary

[coderabbitai]

✅ Actions performed

Summary regeneration triggered.