Repository: incubator-zeppelin Updated Branches: refs/heads/master a30aeb06b -> 4b55a9c02
[ZEPPELIN-466][DOCS] fix typos PostgreSQL doc just notice this has typos too Author: Felix Cheung <[email protected]> Closes #475 from felixcheung/postgresdoc and squashes the following commits: 08baa89 [Felix Cheung] fix broken link 3f728f3 [Felix Cheung] fix typos Project: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/commit/4b55a9c0 Tree: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/tree/4b55a9c0 Diff: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/diff/4b55a9c0 Branch: refs/heads/master Commit: 4b55a9c0235ee7a2ecc2b3088226cf4cc9ae87ad Parents: a30aeb0 Author: Felix Cheung <[email protected]> Authored: Wed Nov 25 18:56:45 2015 -0800 Committer: Lee moon soo <[email protected]> Committed: Sat Nov 28 14:31:21 2015 +0900 ---------------------------------------------------------------------- docs/interpreter/postgresql.md | 42 ++++++++++++++++++------------------- 1 file changed, 20 insertions(+), 22 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/4b55a9c0/docs/interpreter/postgresql.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/postgresql.md b/docs/interpreter/postgresql.md index 9753cdc..9d3a283 100644 --- a/docs/interpreter/postgresql.md +++ b/docs/interpreter/postgresql.md @@ -19,7 +19,7 @@ group: manual <tr> <td>%psql.sql</td> <td>PostgreSqlInterpreter</td> - <td>Provides SQL environment for Postgresql, HAWQ and Greenplum</td> + <td>Provides SQL environment for PostgreSQL, HAWQ and Greenplum</td> </tr> </table> @@ -28,22 +28,22 @@ group: manual This interpreter seamlessly supports the following SQL data processing engines: -* [PostgreSQL](http://www.postgresql.org/) - OSS, Object-relational database management system (ORDBMS) -* [Apache HAWQ](http://pivotal.io/big-data/pivotal-hawq) - Powerful [Open Source](https://wiki.apache.org/incubator/HAWQProposal) SQL-On-Hadoop engine. +* [PostgreSQL](http://www.postgresql.org/) - OSS, Object-relational database management system (ORDBMS) +* [Apache HAWQ](http://pivotal.io/big-data/pivotal-hawq) - Powerful [Open Source](https://wiki.apache.org/incubator/HAWQProposal) SQL-On-Hadoop engine. * [Greenplum](http://pivotal.io/big-data/pivotal-greenplum-database) - MPP database built on open source PostgreSQL. This [Video Tutorial](https://www.youtube.com/watch?v=wqXXQhJ5Uk8) illustrates some of the features provided by the `Postgresql Interpreter`. -### Create Interpreter +### Create Interpreter -By default Zeppelin creates one `PSQL` instance. You can remove it or create new instances. +By default Zeppelin creates one `PSQL` instance. You can remove it or create new instances. -Multiple PSQL instances can be created, each configured to the same or different backend databases. But over time a `Notebook` can have only one PSQL interpreter instance `bound`. That means you _can not_ connect to different databases in the same `Notebook`. This is a known Zeppelin limitation. +Multiple PSQL instances can be created, each configured to the same or different backend databases. But over time a `Notebook` can have only one PSQL interpreter instance `bound`. That means you _cannot_ connect to different databases in the same `Notebook`. This is a known Zeppelin limitation. -To create new PSQL instance open the `Interprter` section and click the `+Create` button. Pick a `Name` of your choice and from the `Interpreter` drop-down select `psql`. Then follow the configuration instructions and `Save` the new instance. +To create new PSQL instance open the `Interpreter` section and click the `+Create` button. Pick a `Name` of your choice and from the `Interpreter` drop-down select `psql`. Then follow the configuration instructions and `Save` the new instance. -> Note: The `Name` of the instance is used only to distinct the instances while binding them to the `Notebook`. The `Name` is irrelevant inside the `Notebook`. In the `Notebook` you must use `%psql.sql` tag. +> Note: The `Name` of the instance is used only to distinct the instances while binding them to the `Notebook`. The `Name` is irrelevant inside the `Notebook`. In the `Notebook` you must use `%psql.sql` tag. ### Bind to Notebook In the `Notebook` click on the `settings` icon in the top right corner. The select/deselect the interpreters to be bound with the `Notebook`. @@ -51,7 +51,7 @@ In the `Notebook` click on the `settings` icon in the top right corner. The sele ### Configuration You can modify the configuration of the PSQL from the `Interpreter` section. The PSQL interpreter expenses the following properties: - + <table class="table-configuration"> <tr> <th>Property Name</th> @@ -84,15 +84,15 @@ You can modify the configuration of the PSQL from the `Interpreter` section. Th <td>1000</td> </tr> </table> - - + + ### How to use ``` Tip: Use (CTRL + .) for SQL auto-completion. ``` #### DDL and SQL commands -Start the paragraphs with the full `%psql.sql` prefix tag! The short notation: `%psql` would still be able run the queries but the syntax highlighting and the auto-completions will be disabled. +Start the paragraphs with the full `%psql.sql` prefix tag! The short notation: `%psql` would still be able run the queries but the syntax highlighting and the auto-completions will be disabled. You can use the standard CREATE / DROP / INSERT commands to create or modify the data model: @@ -147,14 +147,14 @@ This will produce output like this: #### Apply Zeppelin Dynamic Forms -You can leverage [Zepplein Dynamic Form](https://zeppelin.incubator.apache.org/docs/manual/dynamicform.html) inside your queries. You can use both the `text input` and `select form` parametrization features +You can leverage [Zeppelin Dynamic Form](../manual/dynamicform.html) inside your queries. You can use both the `text input` and `select form` parametrization features ```sql %psql.sql -SELECT ${group_by}, count(*) as count -FROM retail_demo.order_lineitems_pxf -GROUP BY ${group_by=product_id,product_id|product_name|customer_id|store_id} -ORDER BY count ${order=DESC,DESC|ASC} +SELECT ${group_by}, count(*) as count +FROM retail_demo.order_lineitems_pxf +GROUP BY ${group_by=product_id,product_id|product_name|customer_id|store_id} +ORDER BY count ${order=DESC,DESC|ASC} LIMIT ${limit=10}; ``` #### Example HAWQ PXF/HDFS Tables @@ -172,9 +172,7 @@ And retrieve content ```sql %psql.sql -seelect * from retail_demo.payment_methods_pxf +select * from retail_demo.payment_methods_pxf ``` -### Auto-completion -The PSQL Interpreter provides a basic auto-completion functionality. On `(Ctrl+.)` it list the most relevant suggesntions in a pop-up window. In addition to the SQL keyword the interpter provides suggestions for the Schema, Table, Column names as well. - - +### Auto-completion +The PSQL Interpreter provides a basic auto-completion functionality. On `(Ctrl+.)` it list the most relevant suggestions in a pop-up window. In addition to the SQL keyword the interpreter provides suggestions for the Schema, Table, Column names as well.
