/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

NameTypeDescription
graph_namestringName of the graph on which to retrieve information. If left as the default value, information about all graphs is returned. The default value is ''.
optionsmap 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 default value is true. The supported values are:

  • true
  • false
server_idIndicates which graph server(s) to send the request to. Default is to send to get information about all the servers.

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:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'show_graph_request' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

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

NameTypeDescription
resultbooleanIndicates a success. This call will fails of the graph specified in the request does not exist.
loadarray of intsA percentage approximating the current computational load on the server.
memoryarray of longsAvailable memory.
graph_namesarray of stringsName(s) of the graph(s).
graph_server_idsarray of intsId(s) of the graph(s).
directedarray of booleansWhether 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_nodesarray of longsTotal number of nodes in the graph.
num_edgesarray of longsTotal number of edges in the graph.
is_persistedarray of booleansShows whether or not the graph is persisted (saved and loaded on launch).
is_sync_dbarray of booleansShows 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_monitorarray of booleansShows whether or not the graph has an insert table monitor attached to it.
original_requestarray of stringsThe orignal client request used to create the graph (before any expression evaluation or separator processing).
infomap of string to stringsAdditional information.

Empty string in case of an error.