Edit

IS_NUMBER (Azure Cosmos DB)

  • Article

APPLIES TO: NoSQL

Returns a Boolean value indicating if the type of the specified expression is a number.

Syntax

IS_NUMBER(<expr>)

Arguments

expr
Is any expression.

Return types

Returns a Boolean expression.

Examples

The following example checks objects of JSON Boolean, number, string, null, object, array, and undefined types using the IS_NUMBER function.

SELECT   
    IS_NUMBER(true) AS isBooleanANumber,   
    IS_NUMBER(1) AS isNumberANumber, 
    IS_NUMBER("value") AS isTextStringANumber, 
    IS_NUMBER("1") AS isNumberStringANumber,
    IS_NUMBER(null) AS isNullANumber,  
    IS_NUMBER({prop: "value"}) AS isObjectANumber,   
    IS_NUMBER([1, 2, 3]) AS isArrayANumber,  
    IS_NUMBER({stringProp: "value"}.stringProp) AS isObjectStringPropertyANumber, 
    IS_NUMBER({numberProp: 1}.numberProp) AS isObjectNumberPropertyANumber

Here's the result set.

[
    {
        "isBooleanANumber": false,
        "isNumberANumber": true,
        "isTextStringANumber": false,
        "isNumberStringANumber": false,
        "isNullANumber": false,
        "isObjectANumber": false,
        "isArrayANumber": false,
        "isObjectStringPropertyANumber": false,
        "isObjectNumberPropertyANumber": true
    }
]

Remarks

This system function will benefit from a range index.

Next steps