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

Searchable column descriptions #371

Merged
merged 4 commits into from
Feb 17, 2023
Merged

Conversation

dbeatty10
Copy link
Contributor

resolves #322

Description

Being able to search by column description has been requested multiple times (along with at least a dozen +1 upvotes):

Among other benefits, it was mentioned a couple times is that this would enable multi-language search at the column level.

Implementation details

The bulk of the new logic is in the fuzzySearchObj function within src/app/services/project_service.js. The code here looked a little long in the tooth, and I didn't make any attempts to improve it. Rather, I aimed for the minimal additions that would accomplish the goal. So now it's even longer in the tooth.

It appeared that at one point, this code was meant to parse values purely based on their type (string, object, array, etc), but the original intent seem to have devolved a bit. Also, arguments and label no longer appear to be used.

Down the road, a motivated individual could do some surgical refactoring of fuzzySearchObj without affecting anything else.

Screenshot

🎩 Here's an example search result:

image

Clicking on the result and then the "Columns" tab gives:

image

Checklist

@cla-bot cla-bot bot added the cla:yes label Feb 10, 2023
@dbeatty10 dbeatty10 marked this pull request as ready for review February 10, 2023 04:33
@dbeatty10 dbeatty10 added the ready_for_review Externally contributed PR has functional approval, ready for code review from Core engineering label Feb 10, 2023
@emmyoop emmyoop self-requested a review February 16, 2023 19:47
Copy link
Member

@emmyoop emmyoop left a comment

Choose a reason for hiding this comment

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

LGTM

@dbeatty10 dbeatty10 merged commit ddd7fd9 into main Feb 17, 2023
@dbeatty10 dbeatty10 deleted the dbeatty/search-column-descriptions branch February 17, 2023 15:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla:yes ready_for_review Externally contributed PR has functional approval, ready for code review from Core engineering
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[CT-1309] dbt docs - column descriptions are not searchable
2 participants