fix(ingest/graph): Update get_results_by_filter graphql query

[asikowitz]

Checklist

• The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
• Links to related issues (if applicable)
• Tests for the changes have been added/updated (if applicable)
• Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
• For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

Summary by CodeRabbit

• New Features

  • Enhanced data retrieval function to support more detailed output with additional properties.
  • Improved documentation for the retrieval function, clarifying usage with Acryl Cloud.

• Bug Fixes

  • Updated response structure to ensure consistency and added clarity in the returned data.

[coderabbitai]

Walkthrough

The recent changes enhance the get_results_by_filter function in the client module, improving its documentation and adjusting its return structure. Key updates include clarifying its exclusive support for Acryl Cloud and incorporating extraProperties in the output, which enriches the data returned with additional details. These modifications aim to improve usability and clarity for users accessing entity data.

Changes

Files	Change Summary
metadata-ingestion/src/datahub/ingestion/.../client.py	Updated get_results_by_filter with enhanced docstring and modified return structure to include extraProperties.

Poem

In the code where functions play,
A rabbit hops with joyful sway.
Extra properties now in view,
Making data richer for me and you!
With each change, we leap and cheer,
For clearer paths and new frontier! 🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fde71d4 and 377fd2f.

Files selected for processing (1)

• metadata-ingestion/src/datahub/ingestion/graph/client.py (2 hunks)

Additional comments not posted (2)

metadata-ingestion/src/datahub/ingestion/graph/client.py (2)

929-930: Clarify the Acryl Cloud support note.

The note in the docstring clarifies that the function is only supported with Acryl Cloud. This is a helpful addition for users.

---

996-999: Verify the addition of extraProperties in the return structure.

The inclusion of extraProperties in the GraphQL query is correct. Ensure that the additional fields (name and value) are handled properly in the consuming code.