Toggle Menu
Prev Up Next

# `langchain_community.graphs.memgraph_graph`.MemgraphGraph

class langchain_community.graphs.memgraph_graph.MemgraphGraph(url: str, username: str, password: str, *, database: str = 'memgraph')

  Memgraph wrapper for graph operations.

  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
  `get_structured_schema` | Returns the structured schema of the Graph

  Methods

  `__init__`(url, username, password, *[, database]) | Create a new Memgraph graph wrapper instance.
  `add_graph_documents`(graph_documents[, ...]) | This method constructs nodes and relationships in the graph based on the provided GraphDocument objects.
  `query`(query[, params]) | Query Neo4j database.
  `refresh_schema`() | Refreshes the Memgraph graph schema information.

  Parameters

    - url (str) –

    - username (str) –

    - password (str) –

    - database (str) –

  __init__(url: str, username: str, password: str, *, database: str = 'memgraph') → None

    Create a new Memgraph graph wrapper instance.

    Parameters

      - url (str) –

      - username (str) –

      - password (str) –

      - database (str) –

    Return type

      None

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

    This method constructs nodes and relationships in the graph based on the provided GraphDocument objects.

    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

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

    Query Neo4j database.

    Parameters

      - query (str) –

      - params (dict) –

    Return type

      List[Dict[str, Any]]

  refresh_schema() → None

    Refreshes the Memgraph graph schema information.

    Return type

      None

# Examples using MemgraphGraph

- Creating and executing the seeding query