enable search across beneficiary, note, reason, account in /credits endpoint
#120
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…credits` endpoint
badgley
reviewed
Sep 10, 2024
| @@ -117,10 +119,30 @@ def upgrade() -> None: | |||
| op.create_index( | |||
| op.f('ix_credit_transaction_date'), 'credit', ['transaction_date'], unique=False | |||
| ) | |||
|
|
|||
| # Create GIN indexes for trigram similarity search | |||
| op.execute( | |||
There was a problem hiding this comment.
would be curious to learn about advantages / disadvantages of i) indexing each column separately and ii) indexing all together.
There was a problem hiding this comment.
the endpoint exposes a search_fields parameter
search_fields: list[str] = Query(
default=[
'retirement_beneficiary',
'retirement_account',
'retirement_note',
'retirement_reason',
],
description='Fields to search in',with this parameter which allows users to search on a subset of columns, it made sense to create an appropriate index for each column. this potentially improves performance for queries that only search on a subset of columns
…e don't need to apply it again in our query
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
after discussing with Grayson, we decided that the easiest initial improvement is to implement a basic partial match search. the rationale is that the search functionality doesn't need to be advanced at this point. for instance, if a user searches for
apple, it's acceptable for the results to include transactions forsnapple. the idea is that offsetsDB acts as a magnifying glass; users who need precise and accurate results can always download the data and analyze it using their preferred tools, such as pandas.