Version:

/show/graph

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/show/graph

Shows information and characteristics of graphs that exist on the graph server.

Input Parameter Description

Name Type Description
graph_name string Name of the graph on which to retrieve information. If left as the default value, information about all graphs is returned. The default value is ''.
options map of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys) Parameter Description
show_original_request

If set to true, the request that was originally used to create the graph is also returned as JSON. The supported values are:

  • true
  • false

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

Name Type Description
status String 'OK' or 'ERROR'
message String Empty if success or an error message
data_type String 'show_graph_request' or 'none' in case of an error
data String Empty string
data_str JSON or String

This embedded JSON represents the result of the /show/graph endpoint:

Name Type Description
result boolean Indicates a successf. This call will fails of the graph specified in the request does not exist.
graph_names array of strings Name(s) of the graph(s).
directed array of booleans Whether or not the edges of the graph have directions (bi- directional edges can still exist in directed graphs). Consult Directed Graphs for more details.
num_nodes array of longs Total number of nodes in the graph.
num_edges array of longs Total number of edges in the graph.
is_persisted array of booleans Shows whether or not the graph is persisted (saved and loaded on launch).
is_sync_db array of booleans Shows whether or not the graph is linked to the original tables that created it, and will potentially be re-created instead loaded from persist on launch.
has_insert_table_monitor array of booleans Shows whether or not the graph has an insert table monitor attached to it.
original_request array of strings The orignal client request used to create the graph (before any expression evaluation or separator processing).
info map of string to strings Additional information.

Empty string in case of an error.