Core 2.x

get

Gets a document.


Copied to clipboard!
get(index, collection, id, [options]);
Argument Type Description
index
string
Index name
collection
string
Collection name
id
string
Document ID
options
object
Query options

Options

Additional query options

Options Type
(default)
Description
queuable
boolean

(true)
If true, queues the request during downtime, until connected to Kuzzle again

Resolves

Usage

Copied to clipboard!
try {
  await kuzzle.document.create(
    'nyc-open-data',
    'yellow-taxi',
    { capacity: 4 },
    'some-id'
  );
  const response = await kuzzle.document.get('nyc-open-data', 'yellow-taxi', 'some-id');
  console.log(response);
  /*
  { _id: 'some-id',
    _version: 1,
    _source:
    { capacity: 4,
      _kuzzle_info:
        { author: '-1',
          createdAt: 1538409095673,
          updatedAt: null,
          updater: null } } }
  */
  console.log('Success');
} catch (error) {
  console.error(error.message);
}