DOCUMENTID (NoSQL query)

The DOCUMENTID function returns the unique document ID for a given item in the container.

This can be used for filtering or retrieving the document's internal identifier.

Syntax

DOCUMENTID(<item_expr>)

Arguments

Return types

Returns the unique document ID as a numeric value.

Examples

This section contains examples of how to use this query language construct.

Retrieve document ID

In this example, the DOCUMENTID function is used to get the internal document ID for each product.

SELECT
  p.id,
  p._rid,
  DOCUMENTID(p) AS documentId
FROM  
  product p

[
  {
    "id": "5741047452",
    "_rid": "36ZyAPW+uN8NAAAAAAAAAA==",
    "documentId": 13
  }
]

Filter by document ID range

In this example, the DOCUMENTID function is used in a WHERE clause to filter documents by their internal ID.

SELECT
  p.id,
  DOCUMENTID(p) AS documentId
FROM  
  product p
WHERE
  DOCUMENTID(p) >= 5 AND
  DOCUMENTID(p) <= 15

[
  {
    "id": "5720559175",
    "documentId": 13
  }
]

Remarks

• This function returns an integer value that is only unique within a single physical partition.