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

Optimized tsvectors insertion 🚀 #3892

Merged
merged 2 commits into from
Jan 5, 2023

Conversation

vkWeb
Copy link
Member

@vkWeb vkWeb commented Dec 20, 2022

Summary

Me and @bjester recently co-hacked on slow performance of make set-tsvectors command on hotfixes. Blaine sir came up with a CTE that reduced the execution time exponentially! We analyzed the CTE and realized that the only concern we had was that the published boolean field being non-indexed can dramatically slow down our query. Even indexing published shouldn't make any difference because database will need to traverse the half of the leaf nodes any way.

So, this PR optimizes the performance of make set-tsvectors by first bringing in all the published channel_ids and tree_ids to python memory. Then our query utilizes these values to query for tsvectors. tree_id being indexed seems a good choice for querying.

Our optimization should bring the estimated completion time of make set-tsvectors from 8 months to 8 hours.

Query plan: https://explain.depesz.com/s/jl2m#html

Manual verification steps performed

  1. Create a channel with some nodes, publish the channel and run the command. Does tsvectors get created for all channel nodes? Run the command once again. Now, it should not create any tsvectors because all tsvectors are already created.
  2. Add some more nodes to an existing published channel, re-publish it, run the command. Does tsvectors get created for those newly created nodes?

Reviewer guidance

How can a reviewer test these changes?

Performing manual verification steps and checking on query plan.

References

Closes #3846.


Contributor's Checklist

PR process:

  • If this is an important user-facing change, PR or related issue the CHANGELOG label been added to this PR. Note: items with this label will be added to the CHANGELOG at a later time
  • If this includes an internal dependency change, a link to the diff is provided
  • The docs label has been added if this introduces a change that needs to be updated in the user docs?
  • If any Python requirements have changed, the updated requirements.txt files also included in this PR
  • Opportunities for using Google Analytics here are noted
  • Migrations are safe for a large db

Studio-specifc:

  • All user-facing strings are translated properly
  • The notranslate class been added to elements that shouldn't be translated by Google Chrome's automatic translation feature (e.g. icons, user-generated text)
  • All UI components are LTR and RTL compliant
  • Views are organized into pages, components, and layouts directories as described in the docs
  • Users' storage used is recalculated properly on any changes to main tree files
  • If there new ways this uses user data that needs to be factored into our Privacy Policy, it has been noted.

Testing:

  • Code is clean and well-commented
  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Any new interactions have been added to the QA Sheet
  • Critical and brittle code paths are covered by unit tests

Reviewer's Checklist

This section is for reviewers to fill out.

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

@vkWeb
Copy link
Member Author

vkWeb commented Dec 27, 2022

@rtibbles @bjester now, this is ready for merge!

Copy link
Member

@bjester bjester left a comment

Choose a reason for hiding this comment

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

code review and testing looks good. I will also take a look at it once deployed to hotfixes

@bjester bjester merged commit 15971bb into learningequality:hotfixes Jan 5, 2023
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.

Full Text Search: Optimize make set-tsvectors command
2 participants