arrow-left

All pages
gitbookPowered by GitBook
1 of 1

Loading...

JSONPATH

This section contains reference documentation for the JSONPATH function.

Extracts the object value from jsonField based on 'jsonPath', the result type is inferred based on JSON value. This function can only be used in an ingestion transformation function.

hashtag
Signature

JSONPATH(jsonField, 'jsonPath')

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 name property into the name column and 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.

JSONPATH(data, '$.name')

"Pete"

JSONPATH(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":"name",
               "transformFunction":"JSONPATHSTRING(data, '$.name')"
            },
            {
               "columnName":"age",
               "transformFunction":"JSONPATHSTRING(data, '$.age')"
            }
         ]
      }
   }
}