/delete/graph

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/delete/graph

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

Input Parameter Description

NameTypeDescription
graph_namestringName of the graph to be deleted.
optionsmap 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_idIndicates 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:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'delete_graph_request' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /delete/graph endpoint:

NameTypeDescription
resultbooleanIndicates a successful deletion.
infomap of string to stringsAdditional information.

Empty string in case of an error.