""" Copyright 2024, Zep Software, Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. """ import copy import logging from abc import ABC, abstractmethod from collections.abc import Coroutine from enum import Enum from typing import Any logger = logging.getLogger(__name__) class GraphProvider(Enum): NEO4J = 'neo4j' FALKORDB = 'falkordb' class GraphDriverSession(ABC): async def __aenter__(self): return self @abstractmethod async def __aexit__(self, exc_type, exc, tb): # No cleanup needed for Falkor, but method must exist pass @abstractmethod async def run(self, query: str, **kwargs: Any) -> Any: raise NotImplementedError() @abstractmethod async def close(self): raise NotImplementedError() @abstractmethod async def execute_write(self, func, *args, **kwargs): raise NotImplementedError() class GraphDriver(ABC): provider: GraphProvider fulltext_syntax: str = ( '' # Neo4j (default) syntax does not require a prefix for fulltext queries ) _database: str @abstractmethod def execute_query(self, cypher_query_: str, **kwargs: Any) -> Coroutine: raise NotImplementedError() @abstractmethod def session(self, database: str | None = None) -> GraphDriverSession: raise NotImplementedError() @abstractmethod def close(self): raise NotImplementedError() @abstractmethod def delete_all_indexes(self) -> Coroutine: raise NotImplementedError() def with_database(self, database: str) -> 'GraphDriver': """ Returns a shallow copy of this driver with a different default database. Reuses the same connection (e.g. FalkorDB, Neo4j). """ cloned = copy.copy(self) cloned._database = database return cloned