IS_DEFINED (NoSQL query)

The IS_DEFINED function returns a boolean indicating if the property has been assigned a value.

An Azure Cosmos DB for NoSQL system function that returns true if the property has been assigned a value.

Syntax

IS_DEFINED(<expr>)

Arguments

Return types

Returns a boolean expression.

Examples

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

Check if property is defined

In this example, the IS_DEFINED function is used to check for the presence of a property within a JSON document.

SELECT VALUE {
  isDefined: IS_DEFINED({ "quantity" : 5 }.quantity),
  isNotDefined: IS_DEFINED({ "quantity" : 5 }.name)
}

[
  {
    "isDefined": true,
    "isNotDefined": false
  }
]

Remarks

• This function benefits from the use of a range index. For more information, see range indexes.