Apache Pinot Docs
Search…
latest
Introduction
Basics
Concepts
Architecture
Components
Getting Started
Running Pinot locally
Running Pinot in Docker
Quick Start Examples
Running in Kubernetes
Running on public clouds
Batch import example
Stream ingestion example
HDFS as Deep Storage
Troubleshooting Pinot
Frequently Asked Questions (FAQs)
Import Data
Indexing
Releases
Recipes
For Users
Query
APIs
External Clients
Tutorials
For Developers
Basics
Advanced
Plugins
Design Documents
For Operators
Deployment and Monitoring
Command-Line Interface (CLI)
Configuration Recommendation Engine
Tutorials
Configuration Reference
Cluster
Controller
Broker
Server
Table
Schema
Ingestion Job Spec
Functions
RESOURCES
Community
Team
Blogs
Presentations
Videos
Integrations
Tableau
Trino
ThirdEye
Superset
Presto
Powered By GitBook
Quick Start Examples
This section describes quick start commands that launch all Pinot components in a single process.
Pinot ships with QuickStart commands that launch Pinot components in a single process and import pre-built datasets. These QuickStarts are a good place if you're just getting started with Pinot.
macOS Monterey Users
By default the Airplay receiver server runs on port 7000, which is also the port used by the Pinot Server in the Quick Start. You may see the following error when running these examples:
1
Failed to start a Pinot [SERVER]
2
java.lang.RuntimeException: java.net.BindException: Address already in use
3
at org.apache.pinot.core.transport.QueryServer.start(QueryServer.java:103) ~[pinot-all-0.9.0-jar-with-dependencies.jar:0.9.0-cf8b84e8b0d6ab62374048de586ce7da21132906]
4
at org.apache.pinot.server.starter.ServerInstance.start(ServerInstance.java:158) ~[pinot-all-0.9.0-jar-with-dependencies.jar:0.9.0-cf8b84e8b0d6ab62374048de586ce7da21132906]
5
at org.apache.helix.manager.zk.ParticipantManager.handleNewSession(ParticipantManager.java:110) ~[pinot-all-0.9.0-jar-with-dependencies.jar:0.9.0-cf8b84e8b0d6ab62374048de586ce7da2113
Copied!
If you disable the Airplay receiver server and try again, you shouldn't see this error message anymore.

Batch

This example demonstrates how to do batch processing with Pinot. The command:
  • Starts Apache Zookeeper, Pinot Controller, Pinot Broker, and Pinot Server.
  • Creates the baseballStats table
  • Launches a standalone data ingestion job that builds one segment for a given CSV data file for the baseballStats table and pushes the segment to the Pinot Controller.
  • Issues sample queries to Pinot
Docker
Launcher scripts
1
docker run \
2
-p 9000:9000 \
3
apachepinot/pinot:0.9.3 QuickStart \
4
-type batch
Copied!
1
./bin/pinot-admin.sh QuickStart -type batch
Copied!

Batch JSON

This example demonstrates how to import and query JSON documents in Pinot. The command:
  • Starts Apache Zookeeper, Pinot Controller, Pinot Broker, and Pinot Server.
  • Creates the githubEvents table
  • Launches a standalone data ingestion job that builds one segment for a given JSON data file for the githubEvents table and pushes the segment to the Pinot Controller.
  • Issues sample queries to Pinot
Docker
Launcher scripts
1
docker run \
2
-p 9000:9000 \
3
apachepinot/pinot:0.9.3 QuickStart \
4
-type batch_json_index
Copied!
1
./bin/pinot-admin.sh QuickStart -type batch_json_index
Copied!

Batch with complex data types

This example demonstrates how to do batch processing in Pinot where the the data items have complex fields that need to be unnested. The command:
  • Starts Apache Zookeeper, Pinot Controller, Pinot Broker, and Pinot Server.
  • Creates the githubEvents table
  • Launches a standalone data ingestion job that builds one segment for a given JSON data file for the githubEvents table and pushes the segment to the Pinot Controller.
  • Issues sample queries to Pinot
Docker
Launcher scripts
1
docker run \
2
-p 9000:9000 \
3
apachepinot/pinot:0.9.3 QuickStart \
4
-type batch_json_index
Copied!
1
./bin/pinot-admin.sh QuickStart -type batch_json_index
Copied!

Streaming

This example demonstrates how to do stream processing with Pinot. The command:
  • Starts Apache Kafka, Apache Zookeeper, Pinot Controller, Pinot Broker, and Pinot Server.
  • Creates meetupRsvp table
  • Launches a meetup stream
  • Publishes data to a Kafka topic meetupRSVPEvents that is subscribed to by Pinot.
  • Issues sample queries to Pinot
Docker
Launcher scripts
1
docker run \
2
-p 9000:9000 \
3
apachepinot/pinot:0.9.3 QuickStart \
4
-type stream
Copied!
1
./bin/pinot-admin.sh QuickStart -type stream
Copied!

Streaming JSON

This example demonstrates how to do stream processing with JSON documents in Pinot. The command:
  • Starts Apache Kafka, Apache Zookeeper, Pinot Controller, Pinot Broker, and Pinot Server.
  • Creates meetupRsvp table
  • Launches a meetup stream
  • Publishes data to a Kafka topic meetupRSVPEvents that is subscribed to by Pinot
  • Issues sample queries to Pinot
Docker
Launcher scripts
1
docker run \
2
-p 9000:9000 \
3
apachepinot/pinot:0.9.3 QuickStart \
4
-type stream_json_index
Copied!
1
./bin/pinot-admin.sh QuickStart -type stream_json_index
Copied!

Streaming with minion cleanup

This example demonstrates how to do stream processing in Pinot with RealtimeToOfflineSegmentsTask and MergeRollupTask minion tasks continuously optimizing segments as data gets ingested. The command:
  • Starts Apache Kafka, Apache Zookeeper, Pinot Controller, Pinot Broker, Pinot Minion, and Pinot Server.
  • Creates githubEvents table
  • Launches a GitHub events stream
  • Publishes data to a Kafka topic githubEvents that is subscribed to by Pinot.
  • Issues sample queries to Pinot
Docker
Launcher scripts
1
docker run \
2
-p 9000:9000 \
3
apachepinot/pinot:0.9.3 QuickStart \
4
-type realtime_minion
Copied!
1
./bin/pinot-admin.sh QuickStart -type realtime_minion
Copied!

Streaming with complex data types

This example demonstrates how to do stream processing in Pinot where the stream contains items that have complex fields that need to be unnested. The command:
  • Starts Apache Kafka, Apache Zookeeper, Pinot Controller, Pinot Broker, Pinot Minion, and Pinot Server.
  • Creates meetupRsvp table
  • Launches a meetup stream
  • Publishes data to a Kafka topic meetupRSVPEvents that is subscribed to by Pinot.
  • Issues sample queries to Pinot
Docker
Launcher scripts
1
docker run \
2
-p 9000:9000 \
3
apachepinot/pinot:0.9.3 QuickStart \
4
-type stream_complex_type
Copied!
1
./bin/pinot-admin.sh QuickStart -type stream_complex_type
Copied!

Upsert

This example demonstrates how to do stream processing with upsert with Pinot. The command:
  • Starts Apache Kafka, Apache Zookeeper, Pinot Controller, Pinot Broker, and Pinot Server.
  • Creates meetupRsvp table
  • Launches a meetup stream
  • Publishes data to a Kafka topic meetupRSVPEvents that is subscribed to by Pinot
  • Issues sample queries to Pinot
Docker
Launcher scripts
1
docker run \
2
-p 9000:9000 \
3
apachepinot/pinot:0.9.3 QuickStart \
4
-type upsert
Copied!
1
./bin/pinot-admin.sh QuickStart -type upsert
Copied!

Upsert JSON

This example demonstrates how to do stream processing with upsert with JSON documents in Pinot. The command:
  • Starts Apache Kafka, Apache Zookeeper, Pinot Controller, Pinot Broker, and Pinot Server.
  • Creates meetupRsvp table
  • Launches a meetup stream
  • Publishes data to a Kafka topic meetupRSVPEvents that is subscribed to by Pinot
  • Issues sample queries to Pinot
Docker
Launcher scripts
1
docker run \
2
-p 9000:9000 \
3
apachepinot/pinot:0.9.3 QuickStart \
4
-type upsert_json_index
Copied!
1
./bin/pinot-admin.sh QuickStart -type upsert_json_index
Copied!

Hybrid

This example demonstrates how to do hybrid stream and batch processing with Pinot. The command:
  1. 1.
    Starts Apache Kafka, Apache Zookeeper, Pinot Controller, Pinot Broker, and Pinot Server.
  2. 2.
    Creates airlineStats table
  3. 3.
    Launches a standalone data ingestion job that builds segments under a given directory of Avro files for the airlineStats table and pushes the segments to the Pinot Controller.
  4. 4.
    Launches a stream of flights stats
  5. 5.
    Publishes data to a Kafka topic airlineStatsEvents that is subscribed to by Pinot.
  6. 6.
    Issues sample queries to Pinot
Docker
Launcher scripts
1
docker run \
2
-p 9000:9000 \
3
apachepinot/pinot:0.9.3 QuickStart \
4
-type hybrid
Copied!
1
./bin/pinot-admin.sh QuickStart -type hybrid
Copied!

Join

This example demonstrates how to do joins in Pinot using the Lookup UDF. The command:
  • Starts Apache Zookeeper, Pinot Controller, Pinot Broker, and Pinot Server in the same container.
  • Creates the baseballStats table
  • Launches a data ingestion job that builds one segment for a given CSV data file for the baseballStats table and pushes the segment to the Pinot Controller.
  • Creates the dimBaseballTeams table
  • Launches a data ingestion job that builds one segment for a given CSV data file for the dimBaseballStats table and pushes the segment to the Pinot Controller.
  • Issues sample queries to Pinot
Docker
Launcher scripts
1
docker run \
2
-p 9000:9000 \
3
apachepinot/pinot:0.9.3 QuickStart \
4
-type join
Copied!
1
./bin/pinot-admin.sh QuickStart -type join
Copied!
Previous
Running Pinot in Docker
Next
Running in Kubernetes
Last modified 16d ago
Copy link
Contents
Batch
Batch JSON
Batch with complex data types
Streaming
Streaming JSON
Streaming with minion cleanup
Streaming with complex data types
Upsert
Upsert JSON
Hybrid
Join