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 13:47:50 UTC
[incubator-pinot] branch master updated: Add documentation (#3986)
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 59fd4aa Add documentation (#3986)
59fd4aa is described below
commit 59fd4aab4480b6c62ba0bfe61f1a976d0ca31221
Author: Jialiang Li <jl...@linkedin.com>
AuthorDate: Wed Mar 20 06:47:45 2019 -0700
Add documentation (#3986)
---
docs/img/generate-segment.png | Bin 218597 -> 0 bytes
docs/img/list-schemas.png | Bin 8952 -> 247946 bytes
docs/img/pinot-console.png | Bin 0 -> 157310 bytes
docs/img/query-table.png | Bin 35914 -> 0 bytes
docs/img/rebalance-table.png | Bin 0 -> 164989 bytes
docs/img/upload-segment.png | Bin 13944 -> 0 bytes
docs/management_api.rst | 68 +++++++++++++++++++++++++++++++++++-------
7 files changed, 58 insertions(+), 10 deletions(-)
diff --git a/docs/img/generate-segment.png b/docs/img/generate-segment.png
deleted file mode 100644
index 5848781..0000000
Binary files a/docs/img/generate-segment.png and /dev/null differ
diff --git a/docs/img/list-schemas.png b/docs/img/list-schemas.png
index 9b00855..3bd0685 100644
Binary files a/docs/img/list-schemas.png and b/docs/img/list-schemas.png differ
diff --git a/docs/img/pinot-console.png b/docs/img/pinot-console.png
new file mode 100644
index 0000000..f73405b
Binary files /dev/null and b/docs/img/pinot-console.png differ
diff --git a/docs/img/query-table.png b/docs/img/query-table.png
deleted file mode 100644
index 5859f2b..0000000
Binary files a/docs/img/query-table.png and /dev/null differ
diff --git a/docs/img/rebalance-table.png b/docs/img/rebalance-table.png
new file mode 100644
index 0000000..65de953
Binary files /dev/null and b/docs/img/rebalance-table.png differ
diff --git a/docs/img/upload-segment.png b/docs/img/upload-segment.png
deleted file mode 100644
index edd348d..0000000
Binary files a/docs/img/upload-segment.png and /dev/null differ
diff --git a/docs/management_api.rst b/docs/management_api.rst
index 5a7a0e4..e3f3c9d 100644
--- a/docs/management_api.rst
+++ b/docs/management_api.rst
@@ -26,26 +26,74 @@ 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.
+``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.
-For example, list all the schema within Pinot cluster:
+ .. figure:: img/pinot-console.png
+
+For example, to list all the schemas within Pinot cluster:
.. figure:: img/list-schemas.png
-Upload a pinot segment:
+To rebalance segments of a table across servers:
- .. figure:: img/upload-segment.png
+ .. figure:: img/rebalance-table.png
-Pinot-admin.sh
+pinot-admin.sh
--------------
-It can be used instead of the ``pinot-admin.sh`` commands to automate the creation of tables and tenants.
+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.
+
+For example, to create a pinot segment:
+
+.. code-block:: none
-For example, create a pinot segment:
+ $ ./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]
+ Finished building StatsCollector!
+ Collected stats for 97889 documents
+ Created dictionary for INT column: homeRuns with cardinality: 67, range: 0 to 73
+ Created dictionary for INT column: playerStint with cardinality: 5, range: 1 to 5
+ Created dictionary for INT column: groundedIntoDoublePlays with cardinality: 35, range: 0 to 36
+ Created dictionary for INT column: numberOfGames with cardinality: 165, range: 1 to 165
+ Created dictionary for INT column: AtBatting with cardinality: 699, range: 0 to 716
+ Created dictionary for INT column: stolenBases with cardinality: 114, range: 0 to 138
+ Created dictionary for INT column: tripples with cardinality: 32, range: 0 to 36
+ Created dictionary for INT column: hitsByPitch with cardinality: 41, range: 0 to 51
+ Created dictionary for STRING column: teamID with cardinality: 149, max length in bytes: 3, range: ALT to WSU
+ Created dictionary for INT column: numberOfGamesAsBatter with cardinality: 166, range: 0 to 165
+ Created dictionary for INT column: strikeouts with cardinality: 199, range: 0 to 223
+ Created dictionary for INT column: sacrificeFlies with cardinality: 20, range: 0 to 19
+ Created dictionary for INT column: caughtStealing with cardinality: 36, range: 0 to 42
+ Created dictionary for INT column: baseOnBalls with cardinality: 154, range: 0 to 232
+ Created dictionary for STRING column: playerName with cardinality: 11976, max length in bytes: 43, range: to Zoilo Casanova
+ Created dictionary for INT column: doules with cardinality: 64, range: 0 to 67
+ Created dictionary for STRING column: league with cardinality: 7, max length in bytes: 2, range: AA to UA
+ Created dictionary for INT column: yearID with cardinality: 143, range: 1871 to 2013
+ Created dictionary for INT column: hits with cardinality: 250, range: 0 to 262
+ Created dictionary for INT column: runsBattedIn with cardinality: 175, range: 0 to 191
+ Created dictionary for INT column: G_old with cardinality: 166, range: 0 to 165
+ Created dictionary for INT column: sacrificeHits with cardinality: 54, range: 0 to 67
+ Created dictionary for INT column: intentionalWalks with cardinality: 45, range: 0 to 120
+ Created dictionary for INT column: runs with cardinality: 167, range: 0 to 192
+ Created dictionary for STRING column: playerID with cardinality: 18107, max length in bytes: 9, range: aardsda01 to zwilldu01
+ 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
+ Driver, record read time : 369
+ Driver, stats collector time : 0
+ Driver, indexing time : 373
- .. figure:: img/generate-segment.png
+To query a table:
-Query a table:
+.. code-block:: none
- .. figure:: img/query-table.png
+ $ ./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
+ 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