Skip to content

delete_command.md

Latest commit

 

History

History
63 lines (50 loc) · 1.66 KB

delete_command.md

File metadata and controls

63 lines (50 loc) · 1.66 KB
Raw

Class DeleteCommand

The DeleteCommand class is used for removing documents.

Command ← IndexCommand ← TypeCommand ← DocumentCommand ← DeleteCommand

REST API:

DELETE /<index>/<type>/<id>

Methods

  • constructor(index, type, id, source, params) - Initializes new instance of command.
  • execute(client) - Executes this command.

Methods inherited from DocumentCommand

  • getId() - Returns identifier of document.
  • setId(id) - Sets identifier of document.

Methods inherited from TypeCommand

  • getType() - Returns name of type.
  • setType(type) - Sets name of type.

Methods inherited from IndexCommand

  • getIndex() - Returns name of index.
  • setIndex(index) - Sets name of index.

Methods inherited from Command

  • getParameter(name) - Returns value of the specified parameter.
  • setParameter(name, value) - Sets value of the specified parameter.

Usage

var elastic = require("elastic");
var client = new elastic.Client({/*options*/});

var cmd = new elastic.DeleteCommand("test", "post", "1");
cmd.execute(client).then(function (result) {
    console.log(JSON.stringify(result, null, "    "));
});

Result

{
    "found": true,
    "_index": "test",
    "_type": "post",
    "_id": "1",
    "_version": 2
}

Method constructor(index, type, id, source, params)

constructor([index: string, [type: string, [id: string, [source: object, [params: object]]]]])

Method execute(client)

execute(client: Client): Promise