Source code for langchain_neo4j.graphs.graph_store

from typing import Any, Dict, List, Protocol, runtime_checkable

from langchain_neo4j.graphs.graph_document import GraphDocument



[docs]
@runtime_checkable
class GraphStore(Protocol):
    """Abstract class for graph operations."""

    @property
    def get_schema(self) -> str:
        """Return the schema of the Graph database"""
        ...

    @property
    def get_structured_schema(self) -> Dict[str, Any]:
        """Return the schema of the Graph database"""
        ...


[docs]
    def query(self, query: str, params: dict = {}) -> List[Dict[str, Any]]:
        """Query the graph."""
        ...



[docs]
    def refresh_schema(self) -> None:
        """Refresh the graph schema information."""
        ...



[docs]
    def add_graph_documents(
        self, graph_documents: List[GraphDocument], include_source: bool = False
    ) -> None:
        """Take GraphDocument as input as uses it to construct a graph."""
        ...