/show/graph - Kinetica Docs

URL: http://<db.host>:<db.port>/show/graph

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

Input Parameter 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 ( {} ).

Show options

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_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’.The default value is false.The supported values are:

true
false

Output Parameter Description

The Kinetica 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:

status

String

‘OK’ or ‘ERROR’

message

String

Empty if success or an error message

data_type

String

‘show_graph_response’ 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:

Show data_str

result

boolean

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

load

array of ints

A percentage approximating the current computational load on the server.

memory

array of longs

Available memory.

graph_names

array of strings

Name(s) of the graph(s).

graph_server_ids

array of ints

Id(s) of the graph(s).

graph_owner_user_names

array of strings

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

graph_owner_resource_groups

array of strings

Owner of the resource groups(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.

num_bytes

array of longs

Memory this graph uses in bytes.

resource_capacity

array of longs

Memory this graph uses in bytes.

is_persisted

array of booleans

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

is_partitioned

array of booleans

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

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 original 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.

​Input Parameter Description

​Output Parameter Description

Input Parameter Description

Output Parameter Description