Skip to content

update_command.md

Latest commit

 

History

History
70 lines (55 loc) · 1.9 KB

update_command.md

File metadata and controls

70 lines (55 loc) · 1.9 KB
Raw

Class UpdateCommand

The UpdateCommand class is used for updating documents.

Command ← IndexCommand ← TypeCommand ← DocumentCommand ← StoreCommand ← UpdateCommand

REST API:

POST /<index>/<type>/<id>/_update

Methods

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

Methods inherited from StoreCommand

  • getSource() - Returns source of document.
  • setSource(source) - Sets source of document.

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 post = {
    "title": "My first post (updated)",
};

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

Result

{
    "_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