Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Apache Pinot

Query Apache Pinot tables, inspect their schemas and sizes, and load files or generated segments into offline tables.

Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

Connector
Authentication

Apache Pinot

API key or token

Apache Pinot

Connect to an Apache Pinot cluster to read metadata, run SQL, and ingest bounded OFFLINE data.

Set up in Apache Pinot

  1. For native Basic authentication, enter both username and password. Use a Bearer token only when your proxy or authentication provider supports it, and do not combine it with Basic credentials.

Set up in StackAI

  1. Open Settings → Connections, add a connection, and select Apache Pinot.

  2. Enter the credentials and connection details in the fields below.

  3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

Connection fields

StackAI field
Required
What to enter

Controller URL

Yes

The Pinot controller HTTPS URL (serves tables, schemas and sizes).

Broker URL

Yes

The Pinot broker HTTPS URL used to run SQL queries. It must use the same auth as the controller.

Username

Optional / as applicable

Username for Pinot Basic auth. Provide it together with Password.

Password

Optional / as applicable

Password for Pinot Basic auth. It is sent to both the controller and broker.

Bearer Token

Optional / as applicable

Bearer token for token-authenticated clusters. Do not also provide Basic credentials.

Provider documentation: Setup reference.

Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

Use an action

  1. Add the required Apache Pinot action to the workflow.

  2. Select a connection when the action requests one.

  3. Complete the required fields. Use the reference picker when a value comes from another workflow step.

  4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

Actions

List Tables

List the tables in the connected Pinot cluster.

Inputs

Field
Type
Required
Description

Maximum results

integer

No

Maximum tables to return (1-5000). Minimum: 1. Maximum: 5000.

Outputs

Field
Type
Description

Tables

string_array

Table names in the connected Pinot cluster.

Returned count

integer

Number of tables returned.

Total count

integer

Total number of tables reported by Pinot.

Truncated

boolean

Whether the returned table list was capped.

Get Table Schema

Get the column definitions for a Pinot table.

Inputs

Field
Type
Required
Description

Table name

select (string)

Yes

A Pinot table name, with or without an _OFFLINE or _REALTIME suffix. Options load from the selected connection.

Outputs

Field
Type
Description

Schema name

string

The schema name.

Dimension fields

dict_array

Dimension column specs.

Metric fields

dict_array

Metric column specs.

Date-time fields

dict_array

Date-time column specs.

Get Table Size

Get the storage size of a Pinot table.

Inputs

Field
Type
Required
Description

Table name

select (string)

Yes

The name of the table. Options load from the selected connection.

Outputs

Field
Type
Description

Table name

string

The table name.

Reported size (bytes)

integer

Actual on-disk size reported by servers, in bytes.

Estimated size (bytes)

integer

Estimated size accounting for missing segments, in bytes.

Execute SQL Query

Execute a SQL query against the connected Pinot cluster.

Inputs

Field
Type
Required
Description

SQL query

textarea

Yes

The SQL query to run against the Pinot broker.

Maximum rows

integer

No

Maximum rows to return (1-5000). Minimum: 1. Maximum: 5000.

Query timeout (ms)

integer

No

Maximum Pinot query execution time in milliseconds. Minimum: 1. Maximum: 30000. Default: 10000.

Outputs

Field
Type
Description

Rows

dict_array

Result rows, each keyed by column name.

Column names

string_array

Result column names, in order.

Column data types

string_array

Result column data types, in order.

Row count

integer

Number of rows returned.

Ingest From File

Load a small CSV or JSON file into an offline table for testing.

Inputs

Field
Type
Required
Description

Offline table

select (string)

Yes

Existing offline table. Its schema must match the file. Options load from the selected connection.

File URL

secret

Yes

HTTPS download URL for a CSV or JSON file up to 10 MiB.

File format

select (string)

Yes

The format of the file contents. Available values: CSV, JSON.

Outputs

Field
Type
Description

Table name

string

Offline table that received the file.

Ingestion acknowledged

boolean

The controller confirmed ingestion. Verify the rows with a query.

Uploaded bytes

integer

Number of file bytes uploaded.

Upload Segment

Upload a Pinot-generated segment archive to an existing offline table.

Inputs

Field
Type
Required
Description

Offline table

select (string)

Yes

Existing offline table that will receive the segment. Options load from the selected connection.

Segment archive URL

secret

Yes

HTTPS download URL for a Pinot-generated segment archive up to 50 MiB.

Allow segment replacement

boolean

No

Allow Pinot to replace a matching existing segment when needed. Default: false.

Outputs

Field
Type
Description

Table name

string

Offline table targeted by the segment upload.

Controller acknowledgement

string

The controller accepted the segment archive for processing.

Uploaded bytes

integer

Number of segment archive bytes uploaded.

Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.

Last updated

Was this helpful?