Apache Pinot

https://docs.pinot.apache.org
Admin
Apache Pinot is a real-time distributed OLAP datastore designed for ultra-low-latency,...
Tokens:1,241,728
Snippets:10,222
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Build and run the batch quickstart example

Source: https://docs.pinot.apache.org/build-with-pinot/connectors-clients-apis/client-libraries/golang

Builds the Go example application and runs it to query the Pinot batch quickstart.

```bash
go build ./examples/batch-quickstart
./batch-quickstart
```

--------------------------------

### Sample output from batch quickstart example

Source: https://docs.pinot.apache.org/build-with-pinot/connectors-clients-apis/client-libraries/python

Example output from running the batch quickstart script, showing results of three SQL queries.

```text
Sending SQL to Pinot: SELECT * FROM baseballStats LIMIT 5
[0, 11, 0, 0, 0, 0, 0, 0, 0, 0, 'NL', 11, 11, 'aardsda01', 'David Allan', 1, 0, 0, 0, 0, 0, 0, 'SFN', 0, 2004]
[2, 45, 0, 0, 0, 0, 0, 0, 0, 0, 'NL', 45, 43, 'aardsda01', 'David Allan', 1, 0, 0, 0, 1, 0, 0, 'CHN', 0, 2006]
[0, 2, 0, 0, 0, 0, 0, 0, 0, 0, 'AL', 25, 2, 'aardsda01', 'David Allan', 1, 0, 0, 0, 0, 0, 0, 'CHA', 0, 2007]
[1, 5, 0, 0, 0, 0, 0, 0, 0, 0, 'AL', 47, 5, 'aardsda01', 'David Allan', 1, 0, 0, 0, 0, 0, 1, 'BOS', 0, 2008]
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 'AL', 73, 3, 'aardsda01', 'David Allan', 1, 0, 0, 0, 0, 0, 0, 'SEA', 0, 2009]

Sending SQL to Pinot: SELECT playerName, sum(runs) FROM baseballStats WHERE yearID>=2000 GROUP BY playerName LIMIT 5
['Scott Michael', 26.0]
['Justin Morgan', 0.0]
['Jason Andre', 0.0]
['Jeffrey Ellis', 0.0]
['Maximiliano R.', 16.0]

Sending SQL to Pinot: SELECT playerName,sum(runs) AS sum_runs FROM baseballStats WHERE yearID>=2000 GROUP BY playerName ORDER BY sum_runs DESC LIMIT 5
['Adrian', 1820.0]
['Jose Antonio', 1692.0]
['Rafael', 1565.0]
['Brian Michael', 1500.0]
['Alexander Emmanuel', 1426.0]
```

--------------------------------

### Run Quickstart for Materialized Views

Source: https://docs.pinot.apache.org/build-with-pinot/querying-and-sql/materialized-views

Start the bundled Pinot quickstart that loads a base table, creates an MV table, and runs the MaterializedViewTask. The quickstart creates airlineStatsMv and provides a local setup for testing direct MV queries and, after enabling the broker rewrite switch, transparent rewrite behavior.

```bash
bin/pinot-admin.sh QuickStart -type MATERIALIZED_VIEW
```

--------------------------------

### Batch Multi-Directory QuickStart - Brew

Source: https://docs.pinot.apache.org/start-here/quick-start

Runs the Batch with Multi-Directory (Tiered Storage) demo using the Brew installation. Starts the same components and performs the same actions as the Docker command.

```bash
pinot-admin QuickStart -type BATCH_MULTIDIR
```

--------------------------------

### Run hybrid quickstart example script

Source: https://docs.pinot.apache.org/build-with-pinot/connectors-clients-apis/client-libraries/python

Execute the sample Python script to query Pinot against the Hybrid Quickstart.

```bash
python3 examples/pinot-quickstart-hybrid.py
```

--------------------------------

### Run batch quickstart example script

Source: https://docs.pinot.apache.org/build-with-pinot/connectors-clients-apis/client-libraries/python

Execute the sample Python script to query Pinot after the batch quickstart is up.

```bash
python3 examples/pinot-quickstart-batch.py
```

--------------------------------

### Start Pinot batch quickstart

Source: https://docs.pinot.apache.org/build-with-pinot/connectors-clients-apis/client-libraries/golang

Runs the Pinot batch quickstart script to start a local Pinot instance.

```bash
bin/quick-start-batch.sh
```

--------------------------------

### Run TPC-H QuickStart with Brew

Source: https://docs.pinot.apache.org/start-here/quick-start

Uses the pinot-admin command (installed via Brew) to run the TPC-H quick start.

```bash
pinot-admin QuickStart -type TPCH
```

--------------------------------

### GitHub Events QuickStart - Brew

Source: https://docs.pinot.apache.org/start-here/quick-start

Runs the GitHub Events demo using the Brew installation. Starts the same components and performs the same actions as the Docker command.

```bash
pinot-admin QuickStart -type GITHUB_EVENTS
```

--------------------------------

### Geospatial Quick Start (Brew)

Source: https://docs.pinot.apache.org/start-here/quick-start

Starts Pinot with the GEOSPATIAL example using the Brew-installed pinot-admin command.

```bash
pinot-admin QuickStart -type GEOSPATIAL
```

--------------------------------

### Start Pinot with local build (quick-start-batch.sh)

Source: https://docs.pinot.apache.org/tutorials/getting-started/jupyter-jupysql

Starts the Pinot batch quickstart from a local build of the Pinot repository. Requires a binary build to have been completed first.

```bash
./build/bin/quick-start-batch.sh
```

--------------------------------

### Null Handling Quick Start (Brew)

Source: https://docs.pinot.apache.org/start-here/quick-start

Starts Pinot with the NULL_HANDLING example using the Brew-installed pinot-admin command.

```bash
pinot-admin QuickStart -type NULL_HANDLING
```

--------------------------------

### Geospatial Quick Start (Launcher Scripts)

Source: https://docs.pinot.apache.org/start-here/quick-start

Starts Pinot with the GEOSPATIAL example using the launcher script.

```bash
./bin/pinot-admin.sh QuickStart -type GEOSPATIAL
```

--------------------------------

### Run Pinot streaming with minion cleanup example with Brew

Source: https://docs.pinot.apache.org/start-here/quick-start

Starts the streaming with minion cleanup example using the Brew-installed pinot-admin command.

```bash
pinot-admin QuickStart -type realtime_minion
```

--------------------------------

### Run Pinot streaming example with Brew

Source: https://docs.pinot.apache.org/start-here/quick-start

Starts the same streaming example as the Docker command, but uses the Brew-installed pinot-admin command.

```bash
pinot-admin QuickStart -type stream
```

--------------------------------

### Geospatial Quick Start (Docker)

Source: https://docs.pinot.apache.org/start-here/quick-start

Starts Pinot with the GEOSPATIAL example using Docker. Creates a table with geospatial indexes and runs sample queries.

```bash
docker run \
    -p 9000:9000 \
    apachepinot/pinot:latest QuickStart \
    -type GEOSPATIAL
```

--------------------------------

### Null Handling Quick Start (Launcher Scripts)

Source: https://docs.pinot.apache.org/start-here/quick-start

Starts Pinot with the NULL_HANDLING example using the launcher script.

```bash
./bin/pinot-admin.sh QuickStart -type NULL_HANDLING
```

--------------------------------

### Run Pinot streaming example with launcher script

Source: https://docs.pinot.apache.org/start-here/quick-start

Starts the same streaming example as the Docker command, but uses the Pinot launcher script.

```bash
./bin/pinot-admin.sh QuickStart -type stream
```

--------------------------------

### Run Pinot streaming JSON example with Brew

Source: https://docs.pinot.apache.org/start-here/quick-start

Starts the streaming JSON example using the Brew-installed pinot-admin command.

```bash
pinot-admin QuickStart -type realtime
```

--------------------------------

### Run Pinot streaming JSON example with launcher script

Source: https://docs.pinot.apache.org/start-here/quick-start

Starts the streaming JSON example using the launcher script.

```bash
./bin/pinot-admin.sh QuickStart -type realtime
```

--------------------------------

### Run Pinot streaming with minion cleanup example with launcher script

Source: https://docs.pinot.apache.org/start-here/quick-start

Starts the streaming with minion cleanup example using the launcher script.

```bash
./bin/pinot-admin.sh QuickStart -type realtime_minion
```

--------------------------------

### Run Logical Table Quickstart with Launcher Scripts

Source: https://docs.pinot.apache.org/architecture-and-concepts/components/table/logical-table

Command to run the logical table quickstart using the launcher script. It starts a Pinot instance with the LOGICAL_TABLE quickstart type.

```bash
./bin/pinot-admin.sh QuickStart -type LOGICAL_TABLE
```

--------------------------------

### Start Pinot with Docker quickstart

Source: https://docs.pinot.apache.org/build-with-pinot/connectors-clients-apis/bi-tools/metabase

Runs Apache Pinot in a Docker container using the quickstart mode with MULTI_STAGE. Exposes ports 9000, 8000, and 8080.

```bash
docker run -d --name pinot-quickstart -p 9000:9000 -p 8000:8000 -p 8080:8080 apachepinot/pinot:latest  QuickStart -type MULTI_STAGE
```

--------------------------------

### Example GET request to /query_range with curl

Source: https://docs.pinot.apache.org/build-with-pinot/querying-and-sql/time-series-queries

Sends a PromQL query to the /query_range endpoint using GET with URL-encoded parameters. The example uses language=promql, a rate query, start and end Unix timestamps, and a step of 60s.

```bash
curl -G 'http://localhost:8099/timeseries/api/v1/query_range' \
  --data-urlencode 'language=promql' \
  --data-urlencode 'query=sum(rate(myMetric[5m]))' \
  --data-urlencode 'start=1700000000' \
  --data-urlencode 'end=1700003600' \
  --data-urlencode 'step=60s'
```

--------------------------------

### Run Lookup Join QuickStart with Brew

Source: https://docs.pinot.apache.org/start-here/quick-start

Uses the pinot-admin command (installed via Brew) to run the lookup join quick start.

```bash
pinot-admin QuickStart -type LOOKUP_JOIN
```

--------------------------------

### Run Colocated Join QuickStart with Brew

Source: https://docs.pinot.apache.org/start-here/quick-start

Uses the pinot-admin command (installed via Brew) to run the colocated join quick start.

```bash
pinot-admin QuickStart -type COLOCATED_JOIN
```

--------------------------------

### Run Lookup Join QuickStart with Docker

Source: https://docs.pinot.apache.org/start-here/quick-start

Starts Pinot components, creates fact and dimension tables, ingests data, and runs sample lookup join queries.

```bash
docker run \
    -p 9000:9000 \
    apachepinot/pinot:latest QuickStart \
    -type LOOKUP_JOIN
```

--------------------------------

### Batch Multi-Directory QuickStart - Docker

Source: https://docs.pinot.apache.org/start-here/quick-start

Runs the Batch with Multi-Directory (Tiered Storage) demo using Docker. Starts Zookeeper, Pinot Controller, Broker, and Server with tiered storage, creates the airlineStats table with hot and cold tiers, launches a data ingestion job, and issues sample queries.

```bash
docker run \
    -p 9000:9000 \
    apachepinot/pinot:latest QuickStart \
    -type BATCH_MULTIDIR
```

--------------------------------

### Run Logical Table QuickStart with Brew

Source: https://docs.pinot.apache.org/start-here/quick-start

Starts a Pinot cluster with logical tables using the Brew-installed pinot-admin. Creates three physical tables and a logical table, then issues sample queries.

```bash
pinot-admin QuickStart -type LOGICAL_TABLE
```

--------------------------------

### Run Hybrid QuickStart with Brew

Source: https://docs.pinot.apache.org/start-here/quick-start

Alternative to Docker for running the Hybrid example using the Brew-installed pinot-admin command.

```bash
pinot-admin QuickStart -type hybrid
```

--------------------------------

### arraySliceLong usage example

Source: https://docs.pinot.apache.org/functions/array/arrayslicelong

Returns the LONG values in the array between the start and end positions. The start index is inclusive and the end index is exclusive. This example uses a LONG array literal.

```sql
select arraySliceLong(ARRAY[10000000000, 20000000000, 30000000000, 40000000000], 1, 3) AS slice
```

--------------------------------

### Run Empty QuickStart with Brew

Source: https://docs.pinot.apache.org/start-here/quick-start

Starts a bare Pinot cluster with no tables or data using the Brew-installed pinot-admin. Use this to set up your own tables and schemas from scratch.

```bash
pinot-admin QuickStart -type EMPTY
```

--------------------------------

### Run Empty QuickStart with Docker

Source: https://docs.pinot.apache.org/start-here/quick-start

Starts a bare Pinot cluster with no tables or data using Docker. Use this to set up your own tables and schemas from scratch.

```bash
docker run \
    -p 9000:9000 \
    apachepinot/pinot:latest QuickStart \
    -type EMPTY
```

--------------------------------

### Install Azure CLI via Homebrew

Source: https://docs.pinot.apache.org/start-here/install/managed-kubernetes/azure

Install Azure CLI via Homebrew. Follow the Azure CLI installation guide for other platforms.

```bash
brew update && brew install azure-cli
```

--------------------------------

### dateTrunc(unit, timeValue) examples

Source: https://docs.pinot.apache.org/functions/datetime

Examples showing truncation to the start of a minute and day in UTC.

```sql
SELECT dateTrunc('minute', 1700001234567)
-- Returns 1700001180000 (start of the minute)

SELECT dateTrunc('day', 1700001234567)
-- Returns 1700000000000 (start of the day in UTC)
```

--------------------------------

### Run TPC-H QuickStart with Docker

Source: https://docs.pinot.apache.org/start-here/quick-start

Starts Zookeeper, Pinot Controller, Broker, and Server, creates all 8 TPC-H tables, ingests data, and runs sample multi-stage queries.

```bash
docker run \
    -p 9000:9000 \
    apachepinot/pinot:latest QuickStart \
    -type TPCH
```

--------------------------------

### Run Hybrid QuickStart with Launcher Scripts

Source: https://docs.pinot.apache.org/start-here/quick-start

Alternative to Docker for running the Hybrid example using the Pinot admin launcher script.

```bash
./bin/pinot-admin.sh QuickStart -type hybrid
```

--------------------------------

### GET /health - response

Source: https://docs.pinot.apache.org/reference/api-reference/controller-api

Example response for the GET /health endpoint, indicating the controller is healthy.

```text
OK
```

--------------------------------

### Run Empty QuickStart with Launcher Scripts

Source: https://docs.pinot.apache.org/start-here/quick-start

Starts a bare Pinot cluster with no tables or data using the launcher script. Use this to set up your own tables and schemas from scratch.

```bash
./bin/pinot-admin.sh QuickStart -type EMPTY
```

--------------------------------

### GET /cluster/info - response

Source: https://docs.pinot.apache.org/reference/api-reference/controller-api

Example response for the GET /cluster/info endpoint, showing the cluster name.

```json
{
  "clusterName": "QuickStartCluster"
}
```

--------------------------------

### dateTrunc(unit, timeValue, inputTimeUnit, timezone) example

Source: https://docs.pinot.apache.org/functions/datetime

Example truncating to the start of the day in IST (Asia/Kolkata).

```sql
SELECT dateTrunc('day', 1700000000000, 'MILLISECONDS', 'Asia/Kolkata')
-- Returns start of day in IST.
```

--------------------------------

### Run Hybrid QuickStart with Docker

Source: https://docs.pinot.apache.org/start-here/quick-start

Starts Apache Kafka, Zookeeper, Pinot Controller, Broker, and Server, creates the airlineStats table, runs a data ingestion job, launches a stream, publishes data to Kafka topic airlineStatsEvents, and issues sample queries.

```bash
docker run \
    -p 9000:9000 \
    apachepinot/pinot:latest QuickStart \
    -type hybrid
```

--------------------------------

### GitHub Events QuickStart

Source: https://docs.pinot.apache.org/tutorials/getting-started/github-events-stream

Use the GitHubEventsQuickStart command to set up all the steps for streaming GitHub events in a single command. Requires a GitHub personal access token.

```bash
$ bin/pinot-admin.sh GitHubEventsQuickStart \
  -personalAccessToken <your_github_personal_access_token>
```

--------------------------------

### Run Logical Table Quickstart with Docker

Source: https://docs.pinot.apache.org/architecture-and-concepts/components/table/logical-table

Command to run the logical table quickstart using Docker. It starts a Pinot instance with the LOGICAL_TABLE quickstart type.

```bash
docker run \
    -p 9000:9000 \
    apachepinot/pinot:latest QuickStart \
    -type LOGICAL_TABLE
```

--------------------------------

### Run Pinot QuickStart with basic authentication (AUTH)

Source: https://docs.pinot.apache.org/start-here/quick-start

Starts Apache Zookeeper, Pinot Controller, Broker, and Server with basic auth enabled, creates tables, loads data, and issues authenticated queries. Use the -type AUTH flag with the QuickStart command.

```bash
docker run \
    -p 9000:9000 \
    apachepinot/pinot:latest QuickStart \
    -type AUTH
```

```bash
./bin/pinot-admin.sh QuickStart -type AUTH
```

```bash
pinot-admin QuickStart -type AUTH
```

--------------------------------

### Run Pinot QuickStart with sorted column indexing (SORTED)

Source: https://docs.pinot.apache.org/start-here/quick-start

Starts Pinot components, creates a table with sorted column configuration, generates a 100,000-row dataset, ingests it, and runs sample queries demonstrating sorted index performance. Use the -type SORTED flag.

```bash
docker run \
    -p 9000:9000 \
    apachepinot/pinot:latest QuickStart \
    -type SORTED
```

```bash
./bin/pinot-admin.sh QuickStart -type SORTED
```

```bash
pinot-admin QuickStart -type SORTED
```

--------------------------------

### Null Handling Quick Start (Docker)

Source: https://docs.pinot.apache.org/start-here/quick-start

Starts Pinot with the NULL_HANDLING example using Docker. Creates a table with null values and runs sample queries for IS NULL, IS NOT NULL, and aggregate behavior.

```bash
docker run \
    -p 9000:9000 \
    apachepinot/pinot:latest QuickStart \
    -type NULL_HANDLING
```

--------------------------------

### Multi-Cluster QuickStart - Brew

Source: https://docs.pinot.apache.org/start-here/quick-start

Runs the Multi-Cluster demo using the Brew installation. Initializes two independent Pinot clusters and performs the same actions as the Docker command.

```bash
pinot-admin QuickStart -type MULTI_CLUSTER
```
Tokens:
Raw