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

feat: Add ability to change graph database configuration through cognee #421

Merged
merged 1 commit into from
Jan 9, 2025

Conversation

dexters1
Copy link
Collaborator

@dexters1 dexters1 commented Jan 9, 2025

Summary by CodeRabbit

  • New Features

    • Added a method to configure graph database settings dynamically
    • Enhanced configuration flexibility for graph database connections
  • Bug Fixes

    • Updated error handling for configuration attribute validation

Copy link
Contributor

coderabbitai bot commented Jan 9, 2025

Walkthrough

The pull request introduces a new static method set_graph_db_config to the configuration class, which allows updating graph database configuration settings dynamically. The method accepts a dictionary of configuration parameters and updates the graph database configuration object by directly setting attributes. It includes error handling to raise an AttributeError if an invalid attribute is provided, ensuring strict configuration management.

Changes

File Change Summary
cognee/api/v1/config/config.py Added set_graph_db_config static method to update graph database configuration with dictionary input

Poem

🐰 A rabbit's config tale, so neat and bright,
Setting graph DB settings with delight!
Attributes checked with a careful paw,
No invalid keys shall break the law
Configuration magic, swift and clean! 🔧

Finishing Touches

  • 📝 Generate Docstrings

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@hajdul88 hajdul88 self-requested a review January 9, 2025 15:43
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
cognee/api/v1/config/config.py (2)

135-135: Add type hints for dictionary keys and values.

The config_dict parameter lacks specific type hints for its contents. This could lead to type-related issues at runtime.

Apply this diff to add specific type hints:

-    def set_graph_db_config(config_dict: dict) -> None:
+    def set_graph_db_config(config_dict: dict[str, Any]) -> None:

Don't forget to add the import:

from typing import Any

136-138: Enhance docstring with parameter and raises information.

The current docstring is basic and could be more descriptive about the expected input and potential exceptions.

Consider updating the docstring:

-        """
-        Updates the graph db config with values from config_dict.
-        """
+        """Updates the graph database configuration with the provided values.
+
+        Args:
+            config_dict: Dictionary containing configuration key-value pairs.
+                        Keys must be valid attributes of the graph database config.
+
+        Raises:
+            InvalidAttributeError: If any key in config_dict is not a valid
+                                 attribute of the graph database configuration.
+        """
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c5e15d7 and 6b57bfc.

📒 Files selected for processing (1)
  • cognee/api/v1/config/config.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (17)
  • GitHub Check: run_simple_example_test / test
  • GitHub Check: run_notebook_test / test
  • GitHub Check: run_multimedia_example_test / test
  • GitHub Check: run_notebook_test / test
  • GitHub Check: run_dynamic_steps_example_test / test
  • GitHub Check: test
  • GitHub Check: test
  • GitHub Check: test
  • GitHub Check: test
  • GitHub Check: run_notebook_test / test
  • GitHub Check: test
  • GitHub Check: test
  • GitHub Check: test
  • GitHub Check: test
  • GitHub Check: test
  • GitHub Check: docker-compose-test
  • GitHub Check: profiler
🔇 Additional comments (1)
cognee/api/v1/config/config.py (1)

139-142: Consider validating the configuration values.

The method sets configuration values directly without any validation. Consider adding value validation similar to other config methods (e.g., set_graphistry_config).

Let me check what attributes are available in the graph config:

Comment on lines +134 to +145
@staticmethod
def set_graph_db_config(config_dict: dict) -> None:
"""
Updates the graph db config with values from config_dict.
"""
graph_db_config = get_graph_config()
for key, value in config_dict.items():
if hasattr(graph_db_config, key):
object.__setattr__(graph_db_config, key, value)
else:
raise AttributeError(message=f"'{key}' is not a valid attribute of the config.")

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Maintain consistency with error handling across config methods.

The method uses AttributeError while similar methods (set_llm_config, set_relational_db_config, set_vector_db_config) use InvalidAttributeError. This inconsistency could lead to different error handling flows.

Apply this diff to maintain consistency:

-                raise AttributeError(message=f"'{key}' is not a valid attribute of the config.")
+                raise InvalidAttributeError(
+                    message=f"'{key}' is not a valid attribute of the config."
+                )

Committable suggestion skipped: line range outside the PR's diff.

@dexters1 dexters1 merged commit 64e803b into dev Jan 9, 2025
23 of 24 checks passed
@dexters1 dexters1 deleted the add-set-graph-database branch January 9, 2025 16:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants