showGraph - Kinetica Docs

◆ showGraph() [1/4]

ShowGraphResponse gpudb::GPUdb::showGraph ( const ShowGraphRequest & request_ ) const

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns

Response object containing the result of the operation.

ShowGraphResponse & gpudb::GPUdb::showGraph	(	const ShowGraphRequest &	request_,
		ShowGraphResponse &	response_ ) const

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).

ShowGraphResponse gpudb::GPUdb::showGraph	(	const std::string &	graphName,
		const std::map< std::string, std::string > &	options ) const

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

Parameters

[in]	graphName	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 ”.
[in]	options	Optional parameters. show_graph_show_original_request: If set to true, the request that was originally used to create the graph is also returned as JSON. Supported values: show_graph_true show_graph_false The default value is show_graph_true. show_graph_server_id: Indicates which graph server(s) to send the request to. Default is to send to get information about all the servers. show_graph_export_graph_schema: If true, generates the graph ontology (schema) as a DOT format string in the response info field under the key ‘dot’. Supported values: show_graph_true show_graph_false The default value is show_graph_false. The default value is an empty map.

Returns

Response object containing the result of the operation.

ShowGraphResponse & gpudb::GPUdb::showGraph	(	const std::string &	graphName,
		const std::map< std::string, std::string > &	options,
		ShowGraphResponse &	response_ ) const

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

Parameters

[in]	graphName	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 ”.
[in]	options	Optional parameters. show_graph_show_original_request: If set to true, the request that was originally used to create the graph is also returned as JSON. Supported values: show_graph_true show_graph_false The default value is show_graph_true. show_graph_server_id: Indicates which graph server(s) to send the request to. Default is to send to get information about all the servers. show_graph_export_graph_schema: If true, generates the graph ontology (schema) as a DOT format string in the response info field under the key ‘dot’. Supported values: show_graph_true show_graph_false The default value is show_graph_false. The default value is an empty map.
[out]	response_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).