SHOW GRAPH

Displays the full configuration of one or all named graph definitions, including vertex/edge table mappings, column assignments, directionality, property storage modes, and CSR caching settings.

Category: graphDeltaForge extension

Syntax

SHOW GRAPH [<name>]

Description

## Overview SHOW GRAPH retrieves and displays the configuration of named graph definitions. It is the primary introspection command for understanding how graphs are mapped onto Delta tables. When a specific graph name is provided, the command returns a single row with that graph's configuration. When no name is provided, all graph definitions visible to the current session are listed. ## Data Sources The command resolves graph definitions using a two-tier lookup: 1. **Catalog API** (primary): If a catalog router is configured, the command queries the catalog database for persisted graph definitions. This returns definitions that survive session restarts and are shared across compute nodes. 2. **Session registry** (fallback): If the catalog is unavailable, the command falls back to the in-memory graph definition registry, which contains definitions created during the current session. ## Result Columns The result set contains the following columns: | Column | Type | Description | |--------|------|-------------| | graph_name | VARCHAR | The simple name of the graph definition. | | entity_ref | VARCHAR | The fully qualified entity reference (zone.schema.graph_name). | | vertex_table | VARCHAR | The fully qualified vertex table reference. | | vertex_id_column | VARCHAR | The vertex ID column name. | | vertex_type_column | VARCHAR | The optional vertex type (label) column. NULL if not set. | | vertex_name_column | VARCHAR | The optional vertex display name column. NULL if not set. | | edge_table | VARCHAR | The fully qualified edge table reference. | | source_column | VARCHAR | The edge source column name. | | target_column | VARCHAR | The edge target column name. | | weight_column | VARCHAR | The optional edge weight column. NULL if not set. | | edge_label_column | VARCHAR | The optional edge type (label) column. NULL if not set. | | directed | BOOLEAN | TRUE for directed graphs, FALSE for undirected. | | auto_cache_csr | BOOLEAN | TRUE if automatic CSR disk caching is enabled. | | vertex_property_mode | VARCHAR | The vertex property storage mode: 'flattened', 'json', or 'hybrid'. NULL if default. | | edge_property_mode | VARCHAR | The edge property storage mode: 'flattened', 'json', or 'hybrid'. NULL if default. | ## Typical Use Cases - **Verification after CREATE GRAPH**: Confirm that vertex/edge table mappings, column assignments, and property modes are correct. - **Debugging Cypher query failures**: Check that the expected graph exists and that column names match the actual table schema. - **Auditing graph topology**: Review all graph definitions before running algorithms or granting access to downstream users. - **Inventory for cleanup**: List all graphs before a bulk DROP GRAPH operation. ## Access Control | Privilege | Object | Notes | |-----------|--------|-------| | None | N/A | SHOW GRAPH is a read-only command. Any authenticated user can list graph definitions. | ## Compatibility SHOW GRAPH is a DeltaForge extension. It provides functionality similar to catalog introspection queries in SQL/PGQ implementations but uses a dedicated command syntax for convenience.

Parameters

Name	Type	Description
`name`		Specifies the name of a specific graph definition to display. When omitted, all graph definitions are listed. Accepts both simple names and fully qualified names.

Examples

-- List all graph definitions with their full configuration
SHOW GRAPH;

-- Show configuration for a specific graph
SHOW GRAPH social_network;

-- Show configuration using a fully qualified name
SHOW GRAPH gold.social.social_network;

-- Verify a graph definition after creation
CREATE GRAPH IF NOT EXISTS org_chart
    VERTEX TABLE gold.hr.employees ID COLUMN id
        NODE TYPE COLUMN department
        NODE NAME COLUMN full_name
    EDGE TABLE gold.hr.reports_to SOURCE COLUMN employee_id TARGET COLUMN manager_id
        WEIGHT COLUMN influence_score
    DIRECTED;

SHOW GRAPH org_chart;

Pitfalls

SHOW GRAPH without a name lists all definitions visible to the session. In environments with many graphs, the result set can be large. Filter by name to inspect a specific definition.
When the catalog is unavailable, SHOW GRAPH falls back to the session registry. Definitions created by other compute nodes or in previous sessions are not visible in this fallback mode.
The vertex_property_mode and edge_property_mode columns are NULL when the default flattened mode (all columns) is used, since no explicit PROPERTIES clause was specified in the CREATE GRAPH statement.
SHOW GRAPH does not display the current state of the CSR cache (whether it is loaded, stale, or missing). It only shows the graph definition configuration.