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.

Sign up for GitHub

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

Jump to bottom

Feature/custom highlight on search #11339

Merged
merged 5 commits into from
Sep 11, 2024
Merged

Feature/custom highlight on search #11339

merged 5 commits into from
Sep 11, 2024

Conversation

arpanchakra29
Copy link
Contributor

This PR aims to introduce a new feature to enable custom highlighting while searching via Datahub native graphql queries .
By default , Datahub graphql engine adds all searchable fields inside elastic search highlighter which adds huge overhead if the search universe is large and have enriched description on column level . Because for each field mentioned in the highlighter , Elastic search reruns another in memory indexing per entity .

We have introduced a new field called customHighlightingFields where user can pass the fields which they want to highlight , we then only take these fields in to account for search highlighting . This features enables faster retrieval of data and offers customization .

Please refer below on the usage -
**Highlight with Valid Field **

custom_highlighting_with_valid_field

Custom Highlight when highlighting disabled

custom_highlighting_with_highlighting_disabled

Custom Highlight with empty fields array ( It default backs to original highlighting in case of empty array or invalid items)

custom_highlighting_with_empty_fields_array

@github-actions github-actions bot added product PR or Issue related to the DataHub UI/UX community-contribution PR or Issue raised by member(s) of DataHub Community labels Sep 10, 2024
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 10, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

david-leifker
david-leifker approved these changes Sep 10, 2024
View reviewed changes
Copy link
Collaborator

@david-leifker david-leifker left a comment

Choose a reason for hiding this comment

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

LGTM!

@david-leifker david-leifker self-assigned this Sep 10, 2024
@david-leifker
Copy link
Collaborator

Looks like a linting failure. This can be fixed up by running and commiting the changes from ./gradlew spotlessApply --rerun-tasks

@arpanchakra29
Copy link
Contributor Author

arpanchakra29 commented Sep 10, 2024 •
edited
Loading

thank you @david-leifker . have updated with lint commit . Could you please reapprove .

@david-leifker
Copy link
Collaborator

Looks like some missing files due to the schema change.
Log

M metadata-service/restli-api/src/main/snapshot/com.linkedin.entity.aspects.snapshot.json M metadata-service/restli-api/src/main/snapshot/com.linkedin.entity.entities.snapshot.json M metadata-service/restli-api/src/main/snapshot/com.linkedin.entity.runs.snapshot.json M metadata-service/restli-api/src/main/snapshot/com.linkedin.operations.operations.snapshot.json M metadata-service/restli-api/src/main/snapshot/com.linkedin.platform.platform.snapshot.json

@arpanchakra29
Copy link
Contributor Author

@david-leifker can you please rerun the failed step , looks like some timeout happened

@david-leifker david-leifker merged commit 33e898a into datahub-project:master Sep 11, 2024
75 checks passed
@maggiehays
Copy link
Collaborator

@coderabbitai summary

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@david-leifker david-leifker Awaiting requested review from david-leifker

Assignees

@david-leifker david-leifker

Labels
community-contribution PR or Issue raised by member(s) of DataHub Community product PR or Issue related to the DataHub UI/UX
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@arpanchakra29 @david-leifker @maggiehays @kkrekacs