JSON Parser Stage

JSON parsing converts JSON content from a single document field into one or more new documents. This parser uses Solr’s JsonRecordReader to split JSON into sub-documents.

Tip
When entering configuration values in the UI, use unescaped characters, such as \t for the tab character. When entering configuration values in the API, use escaped characters, such as \\t for the tab character.

JSON stage-specific properties

Property Description, Type
enabled

Enable this Parser Stage

type: boolean

default value: 'true'

errorHandling

Error Handling

type: string

default value: 'mark'

enum: { ignore log fail mark }

id

Parser ID

type: string

default value: '6de22ddf-6d3a-4e7e-8c7b-b72f38f71027'

includePath

Include root path

Include parent element names when using a root path.

type: boolean

default value: 'false'

inheritMediaTypes

Match default media types in this Parser Stage

Each parser stage has a built-in list of media types it handles by default. If this setting is true, that list will be used along with any optional additional types provided in the mediaTypes list. If this setting is false, this stage will only be selected for media types in the mediaTypes list, and the mediaTypes list becomes a mandatory property which must have at least one valid media type.

type: boolean

default value: 'true'

listHandling

JSON List handling

Create a single multivalued field containing all items, or a separate index-numbered field per list item?

type: string

default value: 'multivalued'

enum: { multivalued index_numbered }

mappings

Mapping rules

Extract parts of the document into specified fields

type: array of object

object attributes: {
  path  (required) : {
    display name: JSONPath expression
    type: string
    }
  target  (required) : {
    display name: Target field
    type: string
    }
  }

mediaTypes

Media Types to match

Documents with a media type on this list will be matched by this parser stage. See inheritMediaTypes / use default media types for more.

type: array of string

outputFieldPrefix

Prefix parsed fields with

Fields extracted by this parser will be prefixed with this string. The remainder of the field name will be as detected in the stream

type: string

maxLength: 20

pattern: ^$|^[A-Za-z_][A-Za-z0-9_\-\.]+$

pathPatterns

File names to parse

Specify a file name or pattern that must be matched for this parser stage to run. Forward slashes ("/") are used to join names of files inside archives with the archive name.

type: array of object

object attributes: {
  pattern : {
    display name: File name or pattern
    type: string
    description : e.g.: "z.txt" or "*.md" or "/a/*/b/f.txt" for glob; "z.txt$" or ".*\.txt$" or "^/a/[^\/]*/b/f.txt$" for regex
    }
  syntax : {
    display name: Pattern type
    type: string
    default value: 'glob'
    description : glob uses bash shell-style wildcards; regex uses Java (PCRE-style) regex
    enum: { glob regex     }

    }
  }
rootPath

Root path

Use only children of this JSON pointer.

type: string

splitArrays

Split arrays

First split top-level arrays into multiple documents, and then apply other rules.

type: boolean

default value: 'true'

type

required

type: string

default value: 'json'

enum: { json }