arrow-left

All pages
gitbookPowered by GitBook
1 of 1

Loading...

JSONPATHSTRING

This section contains reference documentation for the JSONPATHSTRING function.

Extracts the String value from jsonField based on 'jsonPath', use optional defaultValuefor null or parsing error. This function can only be used in an ingestion transformation function.

hashtag
Signature

JSONPATHSTRING(jsonField, 'jsonPath', [defaultValue])

Arguments
Description
circle-exclamation

'jsonPath'` is a literal. Pinot uses single quotes to distinguish them from identifiers.

hashtag
Usage Examples

The usage examples are based on extracting fields from the following JSON document:

Expression
Value

This function can be used in the to extract the age property into the age column, as described below:

jsonField

An Identifier/Expression contains JSON documents.

'jsonPath'

Follows JsonPath Syntaxarrow-up-right to read values from JSON documents.

JSONPATHSTRING(data, '$.age')

"24"

table config
{
  "data": {
    "name": "Pete",
    "age": 24,
    "subjects": [
      {
        "name": "maths",
        "homework_grades": [80, 85, 90, 95, 100],
        "grade": "A",
        "score": 90
      },
      {
        "name": "english",
        "homework_grades": [60, 65, 70, 85, 90],
        "grade": "B",
        "score": 70
      }
    ]
  }
}
{
   "tableConfig":{
      "ingestionConfig":{
         "transformConfigs":[
            {
               "columnName":"age",
               "transformFunction":"JSONPATHSTRING(data, '$.age')"
            }
         ]
      }
   }
}