Skip to main content
show_graph(graph_name=”, options=)[source]

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

Parameters

graph_name (str) –

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 (dict of str to str) –

Optional parameters. Allowed keys are:

  • show_original_request – If set to true, the request that was originally used to create the graph is also returned as JSON. Allowed values are:

    • true

    • false

    The default value is ‘true’.

  • server_id – Indicates which graph server(s) to send the request to. Default is to send to get information about all the servers.

  • export_graph_schema – If true, generates the graph ontology (schema) as a DOT format string in the response info field under the key ‘dot’. Allowed values are:

    • true

    • false

    The default value is ‘false’.

The default value is an empty dict ( ).

Returns

A dict with the following entries–

result (bool) –

Indicates a success. This call will fail if the graph specified in the request does not exist.

load (list of ints) –

A percentage approximating the current computational load on the server.

memory (list of longs) –

Available memory.

graph_names (list of str) –

Name(s) of the graph(s).

graph_server_ids (list of ints) –

Id(s) of the graph(s).

graph_owner_user_names (list of str) –

Owner of the graph(s) and associated solution table(s).

graph_owner_resource_groups (list of str) –

Owner of the resource groups(s) of the graph(s).

directed (list of bools) –

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 (list of longs) –

Total number of nodes in the graph.

num_edges (list of longs) –

Total number of edges in the graph.

num_bytes (list of longs) –

Memory this graph uses in bytes.

resource_capacity (list of longs) –

Memory this graph uses in bytes.

is_persisted (list of bools) –

Shows whether or not the graph is persisted (saved and loaded on launch).

is_partitioned (list of bools) –

Indicates if the graph data is distributed across all available servers.

is_sync_db (list of bools) –

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 (list of bools) –

Shows whether or not the graph has an insert table monitor attached to it.

original_request (list of str) –

The original client request used to create the graph (before any expression evaluation or separator processing).

info (dict of str to str) –

Additional information.