Add SHOW STORAGE INFO and BUILD INFO queries

The Problem

GQLAlchemy, the Python OGM (Object Graph Mapper) for Memgraph, was missing programmatic access to critical database introspection capabilities. Specifically, developers had no way to retrieve:

• Storage metrics: Vertex counts, edge counts, memory usage, and other storage-related statistics
• Build information: Memgraph version details, build type, and optimization level

This meant users who needed to monitor their Memgraph instance or gather operational metrics had to drop down to raw Cypher queries, breaking the abstraction that GQLAlchemy provides. Issues #254 and #255 tracked these missing features, both labeled as “good first issue” for community contributors.

The Solution

I implemented two new methods on the Memgraph class that wrap the native SHOW STORAGE INFO and SHOW BUILD INFO Cypher queries, providing a clean Pythonic interface:

from gqlalchemy import Memgraph

memgraph = Memgraph()

# Get storage metrics (vertex count, edge count, memory usage, etc.)
storage_info = memgraph.get_storage_info()

# Get build information (build type, optimization level)
build_info = memgraph.get_build_info()

The implementation follows GQLAlchemy’s existing patterns, using the execute_and_fetch method internally and returning results as a list of dictionaries:

def get_storage_info(self) -> List[dict]:
    """Get detailed storage information about the database instance."""
    return list(self.execute_and_fetch("SHOW STORAGE INFO;"))

def get_build_info(self) -> List[dict]:
    """Get build information about the Memgraph instance."""
    return list(self.execute_and_fetch("SHOW BUILD INFO;"))

Files Changed

Testing

The PR includes comprehensive unit tests that mock the database connection and verify:

• Correct Cypher queries are executed
• Results are properly returned as list of dictionaries
• Both methods follow existing patterns in the codebase

Timeline