Code Setup

Dev Environment Setup
To contribute to Pinot, please follow the instructions below.
Git
Pinot uses git for source code management. If you are new to Git, it will be good to review basics of Git and a common tasks like managing branches and rebasing.
Getting the Source Code
Create a fork
To limit the number of branches created on the Apache Pinot repository, we recommend that you create a fork by clicking on the fork button in this page. Read more about fork workflow here​
Clone the repository locally
1
$ mkdir workspace
2
$ cd workspace
3
$ git clone [email protected]:<github username>/pinot.git
4
$ cd pinot
5
# set upstream
6
$ git remote add upstream https://github.com/apache/pinot
7
# check that the upstream shows up correctly
8
$ git remote -v
Copied!
Maven
Pinot is a Maven project and familiarity with Maven will help you work with Pinot code. If you are new to Maven, you can read about Maven here and get a quick overview here.
Run the following maven command to setup the project.
1
# compile, download sources
2
$mvn install package -DskipTests -Pbin-dist -DdownloadSources -DdownloadJavadocs
Copied!
Setup IDE
Import the project into your favorite IDE. Setup stylesheet according to your IDE. We have provided instructions for intellij and eclipse. If you are using other IDEs, please ensure you use stylesheet based on this.
Intellij
To import the Pinot stylesheet this launch intellij and navigate to Preferences (on Mac) or Settings on Linux.
Navigate to Editor -> Code Style -> Java
Select Import Scheme -> Intellij IDES code style XML
Choose codestyle-intellij.xml from pinot/config folder of your workspace. Click Apply.
Eclipse
To import the Pinot stylesheet this launch eclipse and navigate to Preferences (on Mac) or Settings on Linux.
Navigate to Java->Code Style->Formatter
Choose codestyle-eclipse.xml from pinot/config folder of your workspace. Click Apply.
Starting Pinot via IDE
Once the IDE is set up, you can run Batch QuickStart for batch mode or Realtime QuickStart for realtime mode.
Batch Quickstart
start all Pinot components (ZK, Controller, Server, Broker) in the same JVM
create Baseball Stats table
Go to localhost:9000 in your browser and play with the query console.
Realtime Quickstart
start all Pinot components (ZK, Controller, Server, Broker) in the same JVM
Start Kafka in the same JVM
create MeetUpRSVP table.
Live stream meetup events into Kafka
Go to localhost:9000 in your browser and play with the meetup RSVP table.

Contribution Guidelines

Code Modules and Organization

Last modified 1mo ago

Copy link

Contents

Dev Environment Setup

Git

Getting the Source Code

Maven

Setup IDE

Starting Pinot via IDE