MemgraphGraph#

class langchain_community.graphs.memgraph_graph.MemgraphGraph(url: str | None = None, username: str | None = None, password: str | None = None, database: str | None = None, refresh_schema: bool = True, *, driver_config: Dict | None = None)[source]#

Memgraph wrapper for graph operations.

Parameters: url (Optional[str]): The URL of the Memgraph database server. username (Optional[str]): The username for database authentication. password (Optional[str]): The password for database authentication. database (str): The name of the database to connect to. Default is ‘memgraph’. refresh_schema (bool): A flag whether to refresh schema information at initialization. Default is True. driver_config (Dict): Configuration passed to Neo4j Driver.

Security note: Make sure that the database connection uses credentials

that are narrowly-scoped to only include necessary permissions. Failure to do so may result in data corruption or loss, since the calling code may attempt commands that would result in deletion, mutation of data if appropriately prompted or reading sensitive data if such data is present in the database. The best way to guard against such negative outcomes is to (as appropriate) limit the permissions granted to the credentials used with this tool.

See https://python.langchain.com/docs/security for more information.

Create a new Memgraph graph wrapper instance.

Attributes

get_schema

Returns the schema of the Graph database

get_structured_schema

Returns the structured schema of the Graph database

Methods

__init__([url, username, password, ...])

Create a new Memgraph graph wrapper instance.

add_graph_documents(graph_documents[, ...])

Take GraphDocument as input as uses it to construct a graph in Memgraph.

close()

query(query[, params])

Query the graph.

refresh_schema()

Refreshes the Memgraph graph schema information.
Parameters:

  • url (str | None)

  • username (str | None)

  • password (str | None)

  • database (str | None)

  • refresh_schema (bool)

  • driver_config (Dict | None)

__init__(url: str | None = None, username: str | None = None, password: str | None = None, database: str | None = None, refresh_schema: bool = True, *, driver_config: Dict | None = None) → None[source]#

Create a new Memgraph graph wrapper instance.

Parameters:

  • url (str | None)

  • username (str | None)

  • password (str | None)

  • database (str | None)

  • refresh_schema (bool)

  • driver_config (Dict | None)

Return type:

None

add_graph_documents(graph_documents: List[GraphDocument], include_source: bool = False, baseEntityLabel: bool = False) → None[source]#

Take GraphDocument as input as uses it to construct a graph in Memgraph.

Parameters: - graph_documents (List[GraphDocument]): A list of GraphDocument objects that contain the nodes and relationships to be added to the graph. Each GraphDocument should encapsulate the structure of part of the graph, including nodes, relationships, and the source document information. - include_source (bool, optional): If True, stores the source document and links it to nodes in the graph using the MENTIONS relationship. This is useful for tracing back the origin of data. Merges source documents based on the id property from the source document metadata if available; otherwise it calculates the MD5 hash of page_content for merging process. Defaults to False. - baseEntityLabel (bool, optional): If True, each newly created node gets a secondary __Entity__ label, which is indexed and improves import speed and performance. Defaults to False.

Parameters:

  • graph_documents (List[GraphDocument])

  • include_source (bool)

  • baseEntityLabel (bool)

Return type:

None

close() → None[source]#
Return type:

None

query(query: str, params: dict = {}) → List[Dict[str, Any]][source]#

Query the graph.

Parameters:

  • query (str) – The Cypher query to execute.

  • params (dict) – The parameters to pass to the query.

Returns:

The list of dictionaries containing the query results.

Return type:

List[Dict[str, Any]]

refresh_schema() → None[source]#

Refreshes the Memgraph graph schema information.

Return type:

None

Examples using MemgraphGraph