1ed6cfd918
<!-- .github/pull_request_template.md --> ## Description <!-- Provide a clear description of the changes in this PR --> ## DCO Affirmation I affirm that all code in every commit of this pull request conforms to the terms of the Topoteretes Developer Certificate of Origin. --------- Co-authored-by: Boris Arzentar <borisarzentar@gmail.com> Co-authored-by: Boris <boris@topoteretes.com>
125 lines
4.7 KiB
Python
125 lines
4.7 KiB
Python
"""Factory function to get the appropriate graph client based on the graph type."""
|
|
|
|
from functools import lru_cache
|
|
|
|
from .config import get_graph_context_config
|
|
from .graph_db_interface import GraphDBInterface
|
|
from .supported_databases import supported_databases
|
|
|
|
|
|
async def get_graph_engine() -> GraphDBInterface:
|
|
"""Factory function to get the appropriate graph client based on the graph type."""
|
|
# Get appropriate graph configuration based on current async context
|
|
config = get_graph_context_config()
|
|
|
|
graph_client = create_graph_engine(**config)
|
|
|
|
# Async functions can't be cached. After creating and caching the graph engine
|
|
# handle all necessary async operations for different graph types bellow.
|
|
# Handle loading of graph for NetworkX
|
|
if config["graph_database_provider"].lower() == "networkx" and graph_client.graph is None:
|
|
await graph_client.load_graph_from_file()
|
|
|
|
return graph_client
|
|
|
|
|
|
@lru_cache
|
|
def create_graph_engine(
|
|
graph_database_provider,
|
|
graph_file_path,
|
|
graph_database_url="",
|
|
graph_database_username="",
|
|
graph_database_password="",
|
|
graph_database_port="",
|
|
):
|
|
"""
|
|
Create a graph engine based on the specified provider type.
|
|
|
|
This factory function initializes and returns the appropriate graph client depending on
|
|
the database provider specified. It validates required parameters and raises an
|
|
EnvironmentError if any are missing for the respective provider implementations.
|
|
|
|
Parameters:
|
|
-----------
|
|
|
|
- graph_database_provider: The type of graph database provider to use (e.g., neo4j,
|
|
falkordb, kuzu, memgraph).
|
|
- graph_database_url: The URL for the graph database instance. Required for neo4j,
|
|
falkordb, and memgraph providers.
|
|
- graph_database_username: The username for authentication with the graph database.
|
|
Required for neo4j and memgraph providers.
|
|
- graph_database_password: The password for authentication with the graph database.
|
|
Required for neo4j and memgraph providers.
|
|
- graph_database_port: The port number for the graph database connection. Required
|
|
for the falkordb provider.
|
|
- graph_file_path: The filesystem path to the graph file. Required for the kuzu
|
|
provider.
|
|
|
|
Returns:
|
|
--------
|
|
|
|
Returns an instance of the appropriate graph adapter depending on the provider type
|
|
specified.
|
|
"""
|
|
|
|
if graph_database_provider in supported_databases:
|
|
adapter = supported_databases[graph_database_provider]
|
|
|
|
return adapter(
|
|
graph_database_url=graph_database_url,
|
|
graph_database_username=graph_database_username,
|
|
graph_database_password=graph_database_password,
|
|
)
|
|
|
|
if graph_database_provider == "neo4j":
|
|
if not (graph_database_url and graph_database_username and graph_database_password):
|
|
raise EnvironmentError("Missing required Neo4j credentials.")
|
|
|
|
from .neo4j_driver.adapter import Neo4jAdapter
|
|
|
|
return Neo4jAdapter(
|
|
graph_database_url=graph_database_url,
|
|
graph_database_username=graph_database_username,
|
|
graph_database_password=graph_database_password,
|
|
)
|
|
|
|
elif graph_database_provider == "falkordb":
|
|
if not (graph_database_url and graph_database_port):
|
|
raise EnvironmentError("Missing required FalkorDB credentials.")
|
|
|
|
from cognee.infrastructure.databases.vector.embeddings import get_embedding_engine
|
|
from cognee.infrastructure.databases.hybrid.falkordb.FalkorDBAdapter import FalkorDBAdapter
|
|
|
|
embedding_engine = get_embedding_engine()
|
|
|
|
return FalkorDBAdapter(
|
|
database_url=graph_database_url,
|
|
database_port=graph_database_port,
|
|
embedding_engine=embedding_engine,
|
|
)
|
|
|
|
elif graph_database_provider == "kuzu":
|
|
if not graph_file_path:
|
|
raise EnvironmentError("Missing required Kuzu database path.")
|
|
|
|
from .kuzu.adapter import KuzuAdapter
|
|
|
|
return KuzuAdapter(db_path=graph_file_path)
|
|
|
|
elif graph_database_provider == "memgraph":
|
|
if not (graph_database_url and graph_database_username and graph_database_password):
|
|
raise EnvironmentError("Missing required Memgraph credentials.")
|
|
|
|
from .memgraph.memgraph_adapter import MemgraphAdapter
|
|
|
|
return MemgraphAdapter(
|
|
graph_database_url=graph_database_url,
|
|
graph_database_username=graph_database_username,
|
|
graph_database_password=graph_database_password,
|
|
)
|
|
|
|
from .networkx.adapter import NetworkXAdapter
|
|
|
|
graph_client = NetworkXAdapter(filename=graph_file_path)
|
|
|
|
return graph_client
|