Skip to content

Document Information API

Edit page

You can retrieve information about a given document ID using the INFO method:

INFO /twitter/tweet/1
INFO /twitter/tweet/1?human=true

The response includes a set of valuable information about the required document:

  • docid - Internal document ID.
  • version - The document’s version.
  • shard, endpoint - The shard that holds the document, when the index has more than one shard.
  • data - Content types stored in the document data (inplace or stored, with the volume, offset and size of a stored one; sizes are humanized with human=true).
  • values - Object containing all values stored by the document.
  • raw_data - The serialized document data, with the raw query param.

Sources: src/database/handler.cc:1915-1985, src/server/search_views.cc:1243-1250.