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: added take and last methods to query #867

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

saqijaan
Copy link

@saqijaan saqijaan commented Feb 8, 2025

📑 Description

Its new Feature.

The First method provided by orm.Query automatically adds an ORDER BY clause. This meant that if someone wanted to retrieve a single record using a custom order, there was no built-in method available. To address this, GORM provides the Take method, which fetches a single record without applying any ORDER BY condition.

Additionally, the Last method was missing in the query, so I added it to quickly fetch the last record without requiring an ORDER BY clause. This method is also provided by GORM.

Using ORDER BY with First can lead to performance issues because it automatically includes the primary key in the ORDER BY clause along with any other fields specified for ordering. In the absence of a composite index, this can result in a significantly slow query.

@coderabbitai summary

✅ Checks

  • Added test cases for my code

@saqijaan saqijaan requested a review from a team as a code owner February 8, 2025 18:07
Copy link
Contributor

coderabbitai bot commented Feb 8, 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.

@saqijaan saqijaan changed the title Feature/added take and last methods to query Feat added take and last methods to query Feb 8, 2025
@saqijaan saqijaan changed the title Feat added take and last methods to query feat : added take and last methods to query Feb 8, 2025
@devhaozi devhaozi closed this Feb 8, 2025
@devhaozi devhaozi reopened this Feb 8, 2025
@devhaozi
Copy link
Member

devhaozi commented Feb 8, 2025

@saqijaan Please run mockery in your local to generate new mocks for your methods.

@hwbrzzl
Copy link
Contributor

hwbrzzl commented Feb 9, 2025

@saqijaan
Copy link
Author

Sure I'll add

Copy link

codecov bot commented Feb 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.51%. Comparing base (da0832e) to head (e483ae3).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #867   +/-   ##
=======================================
  Coverage   67.51%   67.51%           
=======================================
  Files         151      151           
  Lines       10355    10355           
=======================================
  Hits         6991     6991           
  Misses       2996     2996           
  Partials      368      368           

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

@saqijaan saqijaan changed the title feat : added take and last methods to query feat: added take and last methods to query Feb 10, 2025
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.

LGTM, could you add some test cases in tests/queue_test.go for the logic?

@saqijaan
Copy link
Author

Sure, I will. I’m just adding this whenever I have time so I don’t miss this feature 😉. It caused me a major performance issue. I have a table with around 2 million records, and using first with orderBy was making the query take around 7-9 seconds. Later, when checking the query log, I found out that the issue was caused by the first method.

@hwbrzzl
Copy link
Contributor

hwbrzzl commented Feb 11, 2025

@saqijaan Or try to add some indexes?

@saqijaan
Copy link
Author

Indexes are already there on required columns. But I don't want to order by id and this still requires me to add composite index on id and other column I'm using for ordering my records. So adding indexes is not a proper solution because it should only include columns in OrderBy which are provided by user.

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.

3 participants