arangodb/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md

@startDocuBlock JSF_put_api_collection_unload @brief unloads a collection

@RESTHEADER{PUT /_api/collection/{collection-name}/unload, Unload collection}

@RESTURLPARAMETERS

@RESTURLPARAM{collection-name,string,required}

@RESTDESCRIPTION Removes a collection from memory. This call does not delete any documents. You can use the collection afterwards; in which case it will be loaded into memory, again. On success an object with the following attributes is returned:

• id: The identifier of the collection.

• name: The name of the collection.

• status: The status of the collection as number.

• type: The collection type. Valid types are:

  • 2: document collection
  • 3: edges collection

• isSystem: If true then the collection is a system collection.

@RESTRETURNCODES

@RESTRETURNCODE{400} If the collection-name is missing, then a HTTP 400 is returned.

@RESTRETURNCODE{404} If the collection-name is unknown, then a HTTP 404 is returned.

@EXAMPLES

@EXAMPLE_ARANGOSH_RUN{RestCollectionIdentifierUnload} var cn = "products"; db._drop(cn); var coll = db._create(cn, { waitForSync: true }); var url = "/_api/collection/"+ coll.name() + "/unload";

var response = logCurlRequest('PUT', url, '');

assert(response.code === 200);

logJsonResponse(response);
db._drop(cn);

@END_EXAMPLE_ARANGOSH_RUN @endDocuBlock