Note

This documentation is for a prior release of Kinetica. For the latest documentation, click here.

/delete/graph

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

Deletes an existing graph from the graph server and/or persist.

Input Parameter Description

Name

Type

Description

graph_name

string

Name of the graph to be deleted.

options

map of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)

Parameter Description

delete_persist

If set to true, the graph is removed from the server and persist. If set to false, the graph is removed from the server but is left in persist. The graph can be reloaded from persist if it is recreated with the same 'graph_name'. 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.

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

'delete_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 /delete/graph endpoint:

Name	Type	Description
result	boolean	Indicates a successful deletion.
info	map of string to strings	Additional information.

Empty string in case of an error.