Ingestion Job Spec
The ingestion job spec is used while generating, running, and pushing segments from the input files.
The Job spec can be in either YAML or JSON format (0.5.0 onwards). Property names remain the same in both formats.
To use the JSON format, add the propertyjob-spec-format=json
in the properties file while launching the ingestion job. The properties file can be passed as follows
The values for the template strings in the jobSpecFile can be passed in one of the following three ways mentioned in their order of precedence,
Values from the -values array passed See Launch Data Ingestion Job
Values from the environment variable
Values from the propertyFile
The following configurations are supported by Pinot
Top Level Spec
Property | Description |
---|---|
executionFrameworkSpec | Contains config related to the executor to use to ingest data. See Execution Framework Spec |
jobType | Type of job to execute. The following types are supported
|
inputDirURI | Absolute Path along with scheme of the directory containing all the files to be ingested, e.g. |
includeFileNamePattern | Only Files matching this pattern will be included from Examples: Use Alternatively, use |
excludeFileNamePattern | Exclude file name pattern, supported glob pattern. Similar usage as |
searchRecursively | Set to |
outputDirURI | Absolute Path along with scheme of the directory where to output all the segments. |
overwriteOutput | Set to |
pinotFSSpecs | List of all the filesystems to be used for ingestions. You can mention multiple values in case input and output directories are present in different filesystems. For more details, scroll down to Pinot FS Spec. |
tableSpec | Defines table name and where to fetch corresponding table config and table schema. For more details, scroll down to Table Spec. |
recordReaderSpec | Parser to use to read and decode input data. For more details, scroll down to Record Reader Spec. |
segmentNameGeneratorSpec | Defines how the names of the segments will be. For more details, scroll down to Segment Name Generator Spec. |
pinotClusterSpecs | Defines the Pinot Cluster Access Point. For more details, scroll down to Pinot Cluster Spec. |
pushJobSpec | Defines segment push job-related configuration. For more details, scroll down to Push Job Spec. |
Example
Execution Framework Spec
The configs specify the execution framework to use to ingest data. Check out Batch Ingestion for configs related to all the supported frameworks
Property | Description |
---|---|
name | name of the execution framework. can be one of |
segmentGenerationJobRunnerClassName | The class name implements org.apache.pinot.spi.ingestion.batch.runner.IngestionJobRunner interface to run the segment generation job |
segmentTarPushJobRunnerClassName | The class name implements org.apache.pinot.spi.ingestion.batch.runner.IngestionJobRunner interface to push the segment TAR file |
segmentUriPushJobRunnerClassName | The class name implements org.apache.pinot.spi.ingestion.batch.runner.IngestionJobRunner interface to send segment URI |
segmentMetadataPushJobRunnerClassName | The class name implements org.apache.pinot.spi.ingestion.batch.runner.IngestionJobRunner interface to send segment Metadata |
extraConfigs | Key-value pairs of configs related to the framework of the executions |
Example
Pinot FS Spec
field | description |
---|---|
schema | used to identify a PinotFS. E.g. local, hdfs, dbfs, etc |
className | Class name used to create the PinotFS instance. E.g.
|
configs | configs used to init PinotFS instance |
Table Spec
Table spec is used to specify the table in which data should be populated along with schema.
Property | Description |
---|---|
tableName | name of the table in which to populate the data |
schemaURI | location from which to read the schema for the table. Supports both File systems as well as |
tableConfigURI | location from which to read the config for the table. Supports both File systems as well as |
Example
Record Reader Spec
field | description |
---|---|
dataFormat | Record data format, e.g. 'avro', 'parquet', 'orc', 'csv', 'json', 'thrift' etc. |
className | Corresponding RecordReader class name. E.g. org.apache.pinot.plugin.inputformat.avro.AvroRecordReader org.apache.pinot.plugin.inputformat.csv.CSVRecordReader org.apache.pinot.plugin.inputformat.parquet.ParquetRecordReader org.apache.pinot.plugin.inputformat.json.JSONRecordReader org.apache.pinot.plugin.inputformat.orc.ORCRecordReader org.apache.pinot.plugin.inputformat.thrift.ThriftRecordReader |
configClassName | Corresponding RecordReaderConfig class name, it's mandatory for CSV and Thrift file format. E.g. org.apache.pinot.plugin.inputformat.csv.CSVRecordReaderConfig org.apache.pinot.plugin.inputformat.thrift.ThriftRecordReaderConfig |
configs | Used to init RecordReaderConfig class name, this config is required for CSV and Thrift data format. |
Segment Name Generator Spec
Property | Description |
---|---|
type | the type of name generator to use. Following values are supported -
|
configs | Configs to init SegmentNameGenerator |
segment.name | For |
segment.name.postfix | For |
segment.name.prefix | For |
exclude.sequence.id | Whether to include sequence ids in segment name. Needed when there are multiple segments for the same time range. |
use.global.directory.sequence.id | Assign sequence ids to input files based on all input files under the directory. Set to |
append.uuid.to.segment.name | If the input data doesn't contain a time column, set this to |
file.path.pattern | For |
segment.name.template | For |
Example
To set the segment name to be the same as the input file name (without the trailing .gz
), use:
Note that $
in the yaml file must be escaped, since Pinot uses Groovy's SimpleTemplateEngine to process the yaml file, and a raw $
is treated as a template specifier.
Pinot Cluster Spec
Property | Description |
---|---|
controllerURI | URI to use to fetch table/schema information and push data |
Example
Push Job Spec
Property | Description |
---|---|
pushAttempts | Number of attempts for push job. Default is 1, which means no retry |
pushParallelism | Workers to use for push job. Default is 1 |
pushRetryIntervalMillis | Time in milliseconds to wait for between retry attempts Default is 1 second. |
segmentUriPrefix | append this string before the path of the push destination. Generally, it is the scheme of the filesystem e.g. |
segmentUriSuffix | append this string after the path of the push destination. |
Example
Last updated