Command-Line Interface (CLI)
Last updated
Last updated
Pinot provides a rich CLI to perform almost every operation on the cluster. You can execute all the commands using the pinot-admin.sh
. The script is located in the bin/
directory of the Pinot binary distribution or /opt/pinot/bin
in docker container.
The following commands are supported by the admin script.
Upload the schema configuration to controller. If their is already a schema with same name, it will be updated.
All the options should be prefixed with -
(hyphen)
Upload the table configuration to controller.
All the options should be prefixed with -
(hyphen)
Add a new tenant to the server
All the options should be prefixed with -
(hyphen)
Lists all the segments which have invalid time interval. Only OFFLINE
segments are supported.
All the options should be prefixed with -
(hyphen)
This command changes the replicas of the table. The number of replicas are set from the latest available table config.
All the options should be prefixed with -
(hyphen)
Enable, Disable or Drop the table available in database.
All the options should be prefixed with -
(hyphen)
Create segment files from the input file in local filesystem.
All the options should be prefixed with -
(hyphen)
Convert the segment file from Pinot specific format to other data formats. Currently only CSV
, AVRO
and JSON
are supported.
All the options should be prefixed with -
(hyphen)
Delete the cluster namespace from zookeeper.
All the options should be prefixed with -
(hyphen)
Run job to consume batch or streaming data and push it to Pinot.
All the options should be prefixed with -
(hyphen)
Perform operations similar to the Minion Merge Rollup Task, where multiple segments can be merged based on the provided spec.
This command is mostly for debugging purpose. Use Minion Merge Rollup Task for production.
Command to migrate a subset of replica group from current servers to the provided destination servers. This command is intended to be run multiple times to migrate all the replicas of a table to the destination servers (if intended).
All the options should be prefixed with -
(hyphen)
Modify cluster level configs for pinot. These are the configs which are applicable to all nodes in the cluster.
All the options should be prefixed with -
(hyphen)
Execute a SQL query on the cluster.
All the options should be prefixed with -
(hyphen)
Rebalance a table i.e. reassign instances and segments for a table in the cluster.
For segment reassignment, the following modes are offered:
With-downtime rebalance
: the IdealState is replaced with the target segment assignment in one go and there are no guarantees around replica availability. This mode returns immediately without waiting for ExternalView to reach the target segment assignment. Disabled tables will always be rebalanced with downtime.
No-downtime rebalance
: care is taken to ensure that the configured number of replicas of any segment are available (ONLINE or CONSUMING) at all times. This mode returns after ExternalView reaching the target segment assignment.
In the edge case scenarios mentioned later, if best-efforts
is disabled, rebalancer will fail the rebalance because the no-downtime contract cannot be achieved, and table might end up in a middle stage. User needs to check the rebalance result, solve the issue, and run the rebalance again if necessary.
If best-efforts
is enabled, rebalancer will log a warning and continue the rebalance, but the no-downtime contract will not be guaranteed.
Downtime can occur in the following edge case scenarios -
Segment falls into ERROR state in ExternalView -> with best-efforts, count ERROR state as good state.
ExternalView has not converged within the maximum wait time -> with best-efforts, continue to the next stage
If the controller that handles the rebalance goes down/restarted, the rebalance isn't automatically resumed by other controllers
All the options should be prefixed with -
(hyphen)
Start a broker instance on host
All the options should be prefixed with -
(hyphen)
Start a controller instance on host
All the options should be prefixed with -
(hyphen)
Start a server instance on host
All the options should be prefixed with -
(hyphen)
Start multiple Pinot processes with all the default configurations using a single command.
All the options should be prefixed with -
(hyphen)
Show all the available clusters namespaces along with metadata
All the options should be prefixed with -
(hyphen)
Stop all the processes of the specified types running on the host.
All the options should be prefixed with -
(hyphen)
Compress and upload segment files to server.
All the options should be prefixed with -
(hyphen)
Validate the table configs and schema present in Zookeeper.
All the options should be prefixed with -
(hyphen)
Compares Helix Ideal state and External view for specified table prefixes.
All the options should be prefixed with -
(hyphen)
Verify if all the tables in the cluster have same Ideal State and External View.
All the options should be prefixed with -
(hyphen)