1
0
Fork 0
arangodb/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_exa...

1.2 KiB

@startDocuBlock general_graph_drop_http_examples @brief delete an existing graph

@RESTHEADER{DELETE /_api/gharial/{graph-name}, Drop a graph}

@RESTDESCRIPTION Removes a graph from the collection _graphs.

@RESTURLPARAMETERS

@RESTURLPARAM{graph-name,string,required} The name of the graph.

@RESTQUERYPARAMETERS

@RESTQUERYPARAM{dropCollections,boolean,optional} Drop collections of this graph as well. Collections will only be dropped if they are not used in other graphs.

@RESTRETURNCODES

@RESTRETURNCODE{201} Is returned if the graph could be dropped and waitForSync is enabled for the _graphs collection.

@RESTRETURNCODE{202} Returned if the graph could be dropped and waitForSync is disabled for the _graphs collection.

@RESTRETURNCODE{404} Returned if no graph with this name could be found.

@EXAMPLES

@EXAMPLE_ARANGOSH_RUN{HttpGharialDrop} var examples = require("@arangodb/graph-examples/example-graph.js"); ~ examples.dropGraph("social"); examples.loadGraph("social"); var url = "/_api/gharial/social?dropCollections=true"; var response = logCurlRequest('DELETE', url);

assert(response.code === 202);

logJsonResponse(response); ~ examples.dropGraph("social"); @END_EXAMPLE_ARANGOSH_RUN @endDocuBlock