You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pinot.apache.org by su...@apache.org on 2019/03/20 18:09:29 UTC

[incubator-pinot] branch master updated: Update managing pinot doc (#3991)

This is an automated email from the ASF dual-hosted git repository.

sunithabeeram pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-pinot.git


The following commit(s) were added to refs/heads/master by this push:
     new 205ec50  Update managing pinot doc (#3991)
205ec50 is described below

commit 205ec5059cdf07dffc44355660642412bdbf3db5
Author: Jialiang Li <jl...@linkedin.com>
AuthorDate: Wed Mar 20 11:09:24 2019 -0700

    Update managing pinot doc (#3991)
---
 docs/management_api.rst | 21 ++++++++++-----------
 1 file changed, 10 insertions(+), 11 deletions(-)

diff --git a/docs/management_api.rst b/docs/management_api.rst
index e3f3c9d..9468bd1 100644
--- a/docs/management_api.rst
+++ b/docs/management_api.rst
@@ -26,7 +26,7 @@ Pinot Management Console
 ------------------------
 
 There is a REST API which allows management of tables, tenants, segments and schemas. It can be accessed by going to
-``http://[controller host]/help`` which offers a web UI to do these tasks, as well as document the REST API. The below
+``http://[controller_host]/help`` which offers a web UI to do these tasks, as well as document the REST API. The below
 is the screenshot of the console.
 
   .. figure:: img/pinot-console.png
@@ -43,17 +43,16 @@ To rebalance segments of a table across servers:
 pinot-admin.sh
 --------------
 
-It can be used instead of the ``pinot-admin.sh`` commands to automate the creation of tables and tenants. The script
-can be generated by running ``mvn install package -DskipTests -Pbin-dist`` in the directory
-in which you checked out Pinot.
+``pinot-admin.sh`` is another way of managing Pinot cluster. This script can be generated by running
+``mvn install package -DskipTests -Pbin-dist`` in the directory in which you checked out Pinot.
 
 For example, to create a pinot segment:
 
 .. code-block:: none
 
-  $ ./pinot-distribution/target/apache-pinot-incubating-0.1.0-SNAPSHOT-bin/apache-pinot-incubating-0.1.0-SNAPSHOT-bin/bin/pinot-admin.sh CreateSegment -dataDir /Users/jlli/Desktop/test/ -format CSV -outDir /Users/jlli/Desktop/test2/ -tableName baseballStats -segmentName baseballStats_data -overwrite -schemaFile ./pinot-distribution/target/apache-pinot-incubating-0.1.0-SNAPSHOT-bin/apache-pinot-incubating-0.1.0-SNAPSHOT-bin/sample_data/baseballStats_schema.json
-  Executing command: CreateSegment  -generatorConfigFile null -dataDir /Users/jlli/Desktop/test/ -format CSV -outDir /Users/jlli/Desktop/test2/ -overwrite true -tableName baseballStats -segmentName baseballStats_data -timeColumnName null -schemaFile ./pinot-distribution/target/apache-pinot-incubating-0.1.0-SNAPSHOT-bin/apache-pinot-incubating-0.1.0-SNAPSHOT-bin/sample_data/baseballStats_schema.json -readerConfigFile null -enableStarTreeIndex false -starTreeIndexSpecFile null -hllSize 9 - [...]
-  Accepted files: [/Users/jlli/Desktop/test/baseballStats_data.csv]
+  $ ./pinot-distribution/target/apache-pinot-incubating-0.1.0-SNAPSHOT-bin/apache-pinot-incubating-0.1.0-SNAPSHOT-bin/bin/pinot-admin.sh CreateSegment -dataDir /Users/host1/Desktop/test/ -format CSV -outDir /Users/host1/Desktop/test2/ -tableName baseballStats -segmentName baseballStats_data -overwrite -schemaFile ./pinot-distribution/target/apache-pinot-incubating-0.1.0-SNAPSHOT-bin/apache-pinot-incubating-0.1.0-SNAPSHOT-bin/sample_data/baseballStats_schema.json
+  Executing command: CreateSegment  -generatorConfigFile null -dataDir /Users/host1/Desktop/test/ -format CSV -outDir /Users/host1/Desktop/test2/ -overwrite true -tableName baseballStats -segmentName baseballStats_data -timeColumnName null -schemaFile ./pinot-distribution/target/apache-pinot-incubating-0.1.0-SNAPSHOT-bin/apache-pinot-incubating-0.1.0-SNAPSHOT-bin/sample_data/baseballStats_schema.json -readerConfigFile null -enableStarTreeIndex false -starTreeIndexSpecFile null -hllSize 9 [...]
+  Accepted files: [/Users/host1/Desktop/test/baseballStats_data.csv]
   Finished building StatsCollector!
   Collected stats for 97889 documents
   Created dictionary for INT column: homeRuns with cardinality: 67, range: 0 to 73
@@ -84,9 +83,9 @@ For example, to create a pinot segment:
   Start building IndexCreator!
   Finished records indexing in IndexCreator!
   Finished segment seal!
-  Converting segment: /Users/jlli/Desktop/test2/baseballStats_data_0 to v3 format
-  v3 segment location for segment: baseballStats_data_0 is /Users/jlli/Desktop/test2/baseballStats_data_0/v3
-  Deleting files in v1 segment directory: /Users/jlli/Desktop/test2/baseballStats_data_0
+  Converting segment: /Users/host1/Desktop/test2/baseballStats_data_0 to v3 format
+  v3 segment location for segment: baseballStats_data_0 is /Users/host1/Desktop/test2/baseballStats_data_0/v3
+  Deleting files in v1 segment directory: /Users/host1/Desktop/test2/baseballStats_data_0
   Driver, record read time : 369
   Driver, stats collector time : 0
   Driver, indexing time : 373
@@ -95,5 +94,5 @@ To query a table:
 
 .. code-block:: none
 
-  $ ./pinot-distribution/target/apache-pinot-incubating-0.1.0-SNAPSHOT-bin/apache-pinot-incubating-0.1.0-SNAPSHOT-bin/bin/pinot-admin.sh PostQuery -brokerPort 8000 -query "select count(*) from baseballStats" ./pinot-distribution/target/apache-pinot-incubaExecuting command: PostQuery -brokerHost 172.25.118.138 -brokerPort 8000 -query select count(*) from baseballStats
+  $ ./pinot-distribution/target/apache-pinot-incubating-0.1.0-SNAPSHOT-bin/apache-pinot-incubating-0.1.0-SNAPSHOT-bin/bin/pinot-admin.sh PostQuery -query "select count(*) from baseballStats" ./pinot-distribution/target/apache-pinot-incubaExecuting command: PostQuery -brokerHost [broker_host] -brokerPort [broker_port] -query select count(*) from baseballStats
   Result: {"aggregationResults":[{"function":"count_star","value":"97889"}],"exceptions":[],"numServersQueried":1,"numServersResponded":1,"numSegmentsQueried":1,"numSegmentsProcessed":1,"numSegmentsMatched":1,"numDocsScanned":97889,"numEntriesScannedInFilter":0,"numEntriesScannedPostFilter":0,"numGroupsLimitReached":false,"totalDocs":97889,"timeUsedMs":107,"segmentStatistics":[],"traceInfo":{}}


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org
For additional commands, e-mail: commits-help@pinot.apache.org