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

perf(sqlite data): switch OR to a UNION in data attributes query PE-6806 #210

Merged
merged 1 commit into from
Sep 25, 2024

Conversation

djwhitt
Copy link
Collaborator

@djwhitt djwhitt commented Sep 24, 2024

The OR in the previous query was preventing effective index usage. This change modifies the query to use a UNION of lookup by ID and data root. That's a much simpler query for the optimizer to understand, and it uses indexes for both.

The OR in the previous query was preventing effective index usage. This
change modifies the query to use a UNION of lookup by ID and data root.
That's a much simpler query for the optimizer to understand, and it uses
indexes for both.
Copy link
Contributor

coderabbitai bot commented Sep 24, 2024

Walkthrough

Walkthrough

The pull request modifies an SQL query in the content-attributes.sql file to enhance its structure and logic. The original query was streamlined into two separate SELECT statements combined with a UNION. The first SELECT targets specific data from contiguous_data and contiguous_data_ids based on a parameter, while the second SELECT retrieves data from data_roots, joining it with the previous tables. Both queries limit the results to one entry, ensuring a single record is returned from the combined output.

Changes

File Change Summary
src/database/sql/data/content-attributes.sql Modified SQL query structure to use two separate SELECT statements combined with a UNION for clarity.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SQLQuery
    participant ContiguousData
    participant DataRoots

    User->>SQLQuery: Request data attributes
    SQLQuery->>ContiguousData: SELECT from contiguous_data where cdi.id matches
    ContiguousData-->>SQLQuery: Return matching entry
    SQLQuery->>DataRoots: SELECT from data_roots where dr.data_root matches
    DataRoots-->>SQLQuery: Return matching entry
    SQLQuery-->>User: Return combined results
Loading

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

codecov bot commented Sep 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.09%. Comparing base (60d421b) to head (fb33ccc).
Report is 4 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #210   +/-   ##
========================================
  Coverage    70.09%   70.09%           
========================================
  Files           32       32           
  Lines         7877     7877           
  Branches       429      429           
========================================
  Hits          5521     5521           
  Misses        2356     2356           

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

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.

Actionable comments posted: 0

Outside diff range and nitpick comments (1)
src/database/sql/data/content-attributes.sql (1)

39-64: Excellent performance optimization!

The restructuring of the selectDataAttributes query from using OR to UNION is a great improvement. This change allows for better index utilization, potentially enhancing query performance significantly. The structure is clear and aligns well with the PR objectives.

Consider using UNION ALL for potential further optimization

If you can guarantee that the results from both subqueries will never overlap (i.e., no duplicates), or if duplicate results are acceptable, consider using UNION ALL instead of UNION. UNION ALL is generally faster as it doesn't need to perform duplicate elimination.

Here's how you could modify the query:

SELECT *
FROM (
  -- First subquery (unchanged)
  SELECT
    cd.hash,
    cd.data_size,
    cd.original_source_content_type,
    cdi.verified
  FROM contiguous_data cd
  JOIN contiguous_data_ids cdi ON cdi.contiguous_data_hash = cd.hash
  WHERE cdi.id = :id
  LIMIT 1
)
UNION ALL  -- Changed from UNION to UNION ALL
SELECT *
FROM (
  -- Second subquery (unchanged)
  SELECT
    cd.hash,
    cd.data_size,
    cd.original_source_content_type,
    cdi.verified
  FROM data_roots dr
  JOIN contiguous_data cd ON dr.contiguous_data_hash = cd.hash
  JOIN contiguous_data_ids cdi ON cdi.contiguous_data_hash = cd.hash
  WHERE dr.data_root = :data_root
  LIMIT 1
)
LIMIT 1

This change could provide a slight performance boost, especially for larger datasets.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between edf56d7 and fb33ccc.

Files selected for processing (1)
  • src/database/sql/data/content-attributes.sql (1 hunks)

@djwhitt djwhitt merged commit 6242301 into develop Sep 25, 2024
4 checks passed
@djwhitt djwhitt deleted the PE-6806-optimize-data-attributes-query branch September 25, 2024 15:27
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.

2 participants