SDK
SDK Javascript v6.x
1

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

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');
  /*
  { _index: 'nyc-open-data',
    _type: 'yellow-taxi',
    _id: 'some-id',
    _version: 1,
    found: true,
    _source:
    { capacity: 4,
      _kuzzle_info:
        { author: '-1',
          createdAt: 1538409095673,
          updatedAt: null,
          updater: null,
          active: true,
          deletedAt: null } } }
  */
  console.log('Success');
} catch (error) {
  console.error(error.message);
}