Note

Before upgrading from one version to another one, please read the release notes as there may be some incompatibilities between versions.

0.3.0 (March 2020)

0.2.0 (November 2019)

0.1.0 (March 2019, First release)

New Features and Bug Fixes

• Added support for Kafka 2.0

• Table rebalancer now supports a minimum number of serving replicas during rebalance

• Added support for UDF in filter predicates and selection

• Added support to use hex string as the representation of byte array for queries (see PR #4041)

• Added support for parquet reader (see PR #3852)

• Introduced interface stability and audience annotations (see PR #4063)

• Refactor HelixBrokerStarter to separate constructor and start() - backwards incompatible (see PR #4100)

• Admin tool for listing segments with invalid intervals for offline tables

• Migrated to log4j2 (see PR #4139)

• Added simple avro msg decoder

• Added support for passing headers in Pinot client

• Table rebalancer now supports a minimum number of serving replicas during rebalance

• Support transform functions with AVG aggregation function (see PR #4557)

• Configurations additions/changes

  • Allow customized metrics prefix (see PR #4392)

  • Controller.enable.batch.message.mode to false by default (see PR #3928)

  • RetentionManager and OfflineSegmentIntervalChecker initial delays configurable (see PR #3946)

  • Config to control kafka fetcher size and increase default (see PR #3869)

  • Added a percent threshold to consider startup of services (see PR #4011)

  • Make SingleConnectionBrokerRequestHandler as default (see PR #4048)

  • Always enable default column feature, remove the configuration (see PR #4074)

  • Remove redundant default broker configurations (see PR #4106)

  • Removed some config keys in server(see PR #4222)

  • Add config to disable HLC realtime segment (see PR #4235)

  • Make RetentionManager and OfflineSegmentIntervalChecker initial delays configurable (see PR #3946)

  • The following config variables are deprecated and will be removed in the next release:

    • pinot.broker.requestHandlerType will be removed, in favor of using the "singleConnection" broker request handler. If you have set this configuration, please remove it and use the default type ("singleConnection") for broker request handler.

Work in Progress

• We are in the process of separating Helix and Pinot controllers, so that administrators can have the option of running independent Helix controllers and Pinot controllers.

• We are in the process of moving towards supporting SQL query format and results.

• We are in the process of separating instance and segment assignment using instance pools to optimize the number of Helix state transitions in Pinot clusters with thousands of tables.

Other Notes

• Task management does not work correctly in this release, due to bugs in Helix. We will upgrade to Helix 0.9.2 (or later) version to get this fixed.

• You must upgrade to this release before moving onto newer versions of Pinot release. The protocol between Pinot-broker and Pinot-server has been changed and this release has the code to retain compatibility moving forward. Skipping this release may (depending on your environment) cause query errors if brokers are upgraded and servers are in the process of being upgraded.

• As always, we recommend that you upgrade controllers first, and then brokers and lastly the servers in order to have zero downtime in production clusters.

• Pull Request #4100 introduces a backwards incompatible change to Pinot broker. If you use the Java constructor on HelixBrokerStarter class, then you will face a compilation error with this version. You will need to construct the object and call start() method in order to start the broker.

• Pull Request #4139 introduces a backwards incompatible change for log4j configuration. If you used a custom log4j configuration (log4j.xml), you need to write a new log4j2 configuration (log4j2.xml). In addition, you may need to change the arguments on the command line to start Pinot components.

  If you used Pinot-admin command to start Pinot components, you don't need any change. If you used your own commands to start pinot components, you will need to pass the new log4j2 config as a jvm parameter (i.e. substitute -Dlog4j.configuration or -Dlog4j.configurationFile argument with -Dlog4j2.configurationFile=log4j2.xml).

New Features

• First release

• Off-line data ingestion from Apache Hadoop

• Real-time data ingestion from Apache Kafka

What's the big change?

The reason behind the architectural change from the previous release (0.2.0) and this release (0.3.0), is the possibility of extending Apache Pinot. The 0.2.0 release was not flexible enough to support new storage types nor new stream types. Basically, inserting a new functionality required to change too much code. Thus, the Pinot team went through an extensive refactoring and improvement of the source code.

For instance, the picture below shows the module dependencies of the 0.2.X or previous releases. If we wanted to support a new storage type, we would have had to change several modules. Pretty bad, huh?

In order to conquer this challenge, below major changes are made:

• Refactored common interfaces to pinot-spi module

• Concluded four types of modules:

  • Pinot input format: How to read records from various data/file formats: e.g. Avro/CSV/JSON/ORC/Parquet/Thrift

  • Pinot filesystem: How to operate files on various filesystems: e.g. Azure Data Lake/Google Cloud Storage/S3/HDFS

  • Pinot stream ingestion: How to ingest data stream from various upstream systems, e.g. Kafka/Kinesis/Eventhub

  • Pinot batch ingestion: How to run Pinot batch ingestion jobs in various frameworks, like Standalone, Hadoop, Spark.

• Built shaded jars for each individual plugin

• Added support to dynamically load pinot plugins at server startup time

Now the architecture supports a plug-and-play fashion, where new tools can be supported with little and simple extensions, without affecting big chunks of code. Integrations with new streaming services and data formats can be developed in a much more simple and convenient way.

Notable New Features

• SQL Support

  • Added Calcite SQL compiler

  • Added SQL response format (#4694, #4877)

  • Added support for GROUP BY with ORDER BY (#4602)

  • Query console defaults to use SQL syntax (#4994)

  • Support column alias (#5016, #5033)

  • Added SQL query endpoint: /query/sql (#4964)

  • Support arithmetic operators (#5018)

  • Support non-literal expressions for right-side operand in predicate comparison(#5070)

• Added support for DISTINCT (#4535)

• Added support default value for BYTES column (#4583)

• JDK 11 Support

• Added support to tune size vs accuracy for approximation aggregation functions: DistinctCountHLL, PercentileEst, PercentileTDigest (#4666)

• Added Data Anonymizer Tool (#4747)

• Deprecated pinot-hadoop and pinot-spark modules, replace with pinot-batch-ingestion-hadoop and pinot-batch-ingestion-spark

• Support STRING and BYTES for no dictionary columns in realtime consuming segments (#4791)

• Make pinot-distribution to build a pinot-all jar and assemble it (#4977)

• Added support for PQL case insensitive (#4983)

• Enhanced TableRebalancer logics

  • Moved to new rebalance strategy (#4695)

  • Supported rebalancing tables under any condition(#4990)

  • Supported reassigning completed segments along with Consuming segments for LLC realtime table (#5015)

• Added experimental support for Text Search‌ (#4993)

• Upgraded Helix to version 0.9.4, task management now works as expected (#5020)

• Added date_trunc transformation function. (#4740)

• Support schema evolution for consuming segment. (#4954)

• APIs Additions/Changes

  • Pinot Admin Command

    • Added -queryType option in PinotAdmin PostQuery subcommand (#4726)

    • Added -schemaFile as option in AddTable command (#4959)

    • Added OperateClusterConfig sub command in PinotAdmin (#5073)

  • Pinot Controller Rest APIs

    • Get Table leader controller resource (#4545)

    • Support HTTP POST/PUT to upload JSON encoded schema (#4639)

    • Table rebalance API now requires both table name and type as parameters. (#4824)

    • Refactored Segments APIs (#4806)

    • Added segment batch deletion REST API (#4828)

    • Update schema API to reload table on schema change when applicable (#4838)

    • Enhance the task related REST APIs (#5054)

    • Added PinotClusterConfig REST APIs (#5073)

      • GET /cluster/configs

      • POST /cluster/configs

      • DELETE /cluster/configs/{configName}

• Configurations Additions/Changes

  • Config: controller.host is now optional in Pinot Controller

  • Added instance config: queriesDisabled to disable query sending to a running server (#4767)

  • Added broker config: pinot.broker.enable.query.limit.override configurable max query response size (#5040)

  • Removed deprecated server configs (#4903)

    • pinot.server.starter.enableSegmentsLoadingCheck

    • pinot.server.starter.timeoutInSeconds

    • pinot.server.instance.enable.shutdown.delay

    • pinot.server.instance.starter.maxShutdownWaitTime

    • pinot.server.instance.starter.checkIntervalTime

  • Decouple server instance id with hostname/port config. (#4995)

  • Add FieldConfig to encapsulate encoding, indexing info for a field.(#5006)

Major Bug Fixes

• Fixed the bug of releasing the segment when there are still threads working on it. (#4764)

• Fixed the bug of uneven task distribution for threads (#4793)

• Fixed encryption for .tar.gz segment file upload (#4855)

• Fixed controller rest API to download segment from non local FS. (#4808)

• Fixed the bug of not releasing segment lock if segment recovery throws exception (#4882)

• Fixed the issue of server not registering state model factory before connecting the Helix manager (#4929)

• Fixed the exception in server instance when Helix starts a new ZK session (#4976)

• Fixed ThreadLocal DocIdSet issue in ExpressionFilterOperator (#5114)

• Fixed the bug in default value provider classes (#5137)

• Fixed the bug when no segment exists in RealtimeSegmentSelector (#5138)

Work in Progress

• We are in the process of supporting text search query functionalities.

• We are in the process of supporting null value (#4230), currently limited query feature is supported

  • Added Presence Vector to represent null value (#4585)

  • Added null predicate support for leaf predicates (#4943)

Backward Incompatible Changes

• It’s a disruptive upgrade from version 0.1.0 to this because of the protocol changes between Pinot Broker and Pinot Server. Please ensure that you upgrade to release 0.2.0 first, then upgrade to this version.

• If you build your own startable or war without using scripts generated in Pinot-distribution module. For Java 8, an environment variable “plugins.dir” is required for Pinot to find out where to load all the Pinot plugin jars. For Java 11, plugins directory is required to be explicitly set into classpath. Please see pinot-admin.sh as an example.

• As always, we recommend that you upgrade controllers first, and then brokers and lastly the servers in order to have zero downtime in production clusters.

• Kafka 0.9 is no longer included in the release distribution.

• Pull request #4806 introduces a backward incompatible API change for segments management.

  • Removed segment toggle APIs

  • Removed list all segments in cluster APIs

  • Deprecated below APIs:

    • GET /tables/{tableName}/segments

    • GET /tables/{tableName}/segments/metadata

    • GET /tables/{tableName}/segments/crc

    • GET /tables/{tableName}/segments/{segmentName}

    • GET /tables/{tableName}/segments/{segmentName}/metadata

    • GET /tables/{tableName}/segments/{segmentName}/reload

    • POST /tables/{tableName}/segments/{segmentName}/reload

    • GET /tables/{tableName}/segments/reload

    • POST /tables/{tableName}/segments/reload

• Pull request #5054 deprecated below task related APIs:

  • GET:

    • /tasks/taskqueues: List all task queues

    • /tasks/taskqueuestate/{taskType} -> /tasks/{taskType}/state

    • /tasks/tasks/{taskType} -> /tasks/{taskType}/tasks

    • /tasks/taskstates/{taskType} -> /tasks/{taskType}/taskstates

    • /tasks/taskstate/{taskName} -> /tasks/task/{taskName}/taskstate

    • /tasks/taskconfig/{taskName} -> /tasks/task/{taskName}/taskconfig

  • PUT:

    • /tasks/scheduletasks -> POST /tasks/schedule

    • /tasks/cleanuptasks/{taskType} -> /tasks/{taskType}/cleanup

    • /tasks/taskqueue/{taskType}: Toggle a task queue

  • DELETE:

    • /tasks/taskqueue/{taskType} -> /tasks/{taskType}

• Deprecated modules pinot-hadoop and pinot-spark and replaced with pinot-batch-ingestion-hadoop and pinot-batch-ingestion-spark.

• Introduced new Pinot batch ingestion jobs and yaml based job specs to define segment generation jobs and segment push jobs.

• You may see exceptions like below in pinot-brokers during cluster upgrade, but it's safe to ignore them.

  Copy

  2020/03/09 23:37:19.879 ERROR [HelixTaskExecutor] [CallbackProcessor@b808af5-pinot] [pinot-broker] [] Message cannot be processed: 78816abe-5288-4f08-88c0-f8aa596114fe, {CREATE_TIMESTAMP=1583797034542, MSG_ID=78816abe-5288-4f08-88c0-f8aa596114fe, MSG_STATE=unprocessable, MSG_SUBTYPE=REFRESH_SEGMENT, MSG_TYPE=USER_DEFINE_MSG, PARTITION_NAME=fooBar_OFFLINE, RESOURCE_NAME=brokerResource, RETRY_COUNT=0, SRC_CLUSTER=pinot, SRC_INSTANCE_TYPE=PARTICIPANT, SRC_NAME=Controller_hostname.domain,com_9000, TGT_NAME=Broker_hostname,domain.com_6998, TGT_SESSION_ID=f6e19a457b80db5, TIMEOUT=-1, segmentName=fooBar_559, tableName=fooBar_OFFLINE}{}{}
  java.lang.UnsupportedOperationException: Unsupported user defined message sub type: REFRESH_SEGMENT
        at org.apache.pinot.broker.broker.helix.TimeboundaryRefreshMessageHandlerFactory.createHandler(TimeboundaryRefreshMessageHandlerFactory.java:68) ~[pinot-broker-0.2.1172.jar:0.3.0-SNAPSHOT-c9d88e47e02d799dc334d7dd1446a38d9ce161a3]
        at org.apache.helix.messaging.handling.HelixTaskExecutor.createMessageHandler(HelixTaskExecutor.java:1096) ~[helix-core-0.9.1.509.jar:0.9.1.509]
        at org.apache.helix.messaging.handling.HelixTaskExecutor.onMessage(HelixTaskExecutor.java:866) [helix-core-0.9.1.509.jar:0.9.1.509]