Skip to content

Fix: Escape special characters in entity descriptions #137

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

Merged
galshubeli merged 2 commits into from
Jan 15, 2026
Merged

Fix: Escape special characters in entity descriptions #137

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
97ec7a6
fix: escape special characters in entity descriptions for Cypher queries
parmar-abhinav Nov 17, 2025
8bb0f76
Merge branch 'main' into develop
galshubeli Jan 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion graphrag_sdk/entity.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,9 @@ def to_graph_query(self) -> str:
[str(attr) for attr in self.attributes if not attr.unique]
)
if self.description:
non_unique_attributes += f"{', ' if len(non_unique_attributes) > 0 else ''} {descriptionKey}: '{self.description}'"
# Escape special characters to prevent Cypher syntax errors
escaped_description = self.description.replace("\\", "\\\\").replace("'", "\\'").replace('"', '\\"')
non_unique_attributes += f"{', ' if len(non_unique_attributes) > 0 else ''} {descriptionKey}: '{escaped_description}'"
return f"MERGE (n:{self.label} {{{unique_attributes}}}) SET n += {{{non_unique_attributes}}} RETURN n"

def __str__(self) -> str:
Expand Down