Lists basic information about one or all 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 empty, 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 ( {} ).

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 'list_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 /list/graph endpoint:

Name Type Description
result boolean Indicates a successful listing.
graph_names array of strings Name(s) of the graph(s).
num_nodes array of longs Total number of nodes in the graph.
num_edges array of longs Total number of edges in the graph.
info map of string to strings Additional information.

Empty string in case of an error.