#### 0.6.0 and later -Inside of a notebook, %[INTERPRETER\_GROUP].[INTERPRETER\_NAME] directive will call your interpreter. +Inside of a notebook, `%[INTERPRETER_GROUP].[INTERPRETER_NAME]` directive will call your interpreter. Note that the first interpreter configuration in zeppelin.interpreters will be the default one. -You can omit either [INTERPRETER\_GROUP] or [INTERPRETER\_NAME]. Omit [INTERPRETER\_NAME] selects first available interpreter in the [INTERPRETER\_GROUP]. -Omit '[INTERPRETER\_GROUP]' will selects [INTERPRETER\_NAME] from default interpreter group. +You can omit either [INTERPRETER\_GROUP] or [INTERPRETER\_NAME]. If you omit [INTERPRETER\_NAME], then first available interpreter will be selected in the [INTERPRETER\_GROUP]. +Likewise, if you skip [INTERPRETER\_GROUP], then [INTERPRETER\_NAME] will be chosen from default interpreter group. -For example, if you have two interpreter myintp1 and myintp2 in group mygrp, - -you can call myintp1 like +For example, if you have two interpreter myintp1 and myintp2 in group mygrp, you can call myintp1 like ``` %mygrp.myintp1 @@ -125,7 +121,7 @@ and you can call myintp2 like codes for myintp2 ``` -If you omit your interpreter name, it'll selects first available interpreter in the group (myintp1) +If you omit your interpreter name, it'll select first available interpreter in the group ( myintp1 ). ``` %mygrp diff --git a/docs/interpreter/cassandra.md b/docs/interpreter/cassandra.md index eded545e52..2eb86c3d00 100644 --- a/docs/interpreter/cassandra.md +++ b/docs/interpreter/cassandra.md @@ -6,10 +6,8 @@ group: manual --- {% include JB/setup %} -
## 1. Cassandra CQL Interpreter for Apache Zeppelin -
| Name | @@ -23,35 +21,32 @@ group: manual
|---|
## 2. Enabling Cassandra Interpreter - In a notebook, to enable the **Cassandra** interpreter, click on the **Gear** icon and select **Cassandra** + In a notebook, to enable the **Cassandra** interpreter, click on the **Gear** icon and select **Cassandra**. -
+ +
- + ## 3. Using the Cassandra Interpreter In a paragraph, use **_%cassandra_** to select the **Cassandra** interpreter and then input all commands. - To access the interactive help, type **HELP;** + To access the interactive help, type `HELP;` -
## 4. Interpreter Commands - The **Cassandra** interpreter accepts the following commands + The **Cassandra** interpreter accepts the following commands.
| All CQL-compatible statements (SELECT, INSERT, CREATE ...) | All CQL statements are executed directly against the Cassandra server | -
## 5. CQL statements This interpreter is compatible with any CQL statement supported by Cassandra. Ex: @@ -97,7 +91,7 @@ This interpreter is compatible with any CQL statement supported by Cassandra. Ex INSERT INTO users(login,name) VALUES('jdoe','John DOE'); SELECT * FROM users WHERE login='jdoe'; -``` +``` Each statement should be separated by a semi-colon ( **;** ) except the special commands below: @@ -149,7 +143,7 @@ This means that the following statements are equivalent and valid: ``` The complete list of all CQL statements and versions can be found below: -
| Cassandra Version | @@ -163,7 +157,7 @@ The complete list of all CQL statements and versions can be found below: http://docs.datastax.com/en/cql/3.3/cql/cqlIntro.html -|
|---|---|
| 2.1 & 2.0 | @@ -172,7 +166,7 @@ The complete list of all CQL statements and versions can be found below: http://docs.datastax.com/en/cql/3.1/cql/cql_intro_c.html | -
| 1.2 | @@ -181,11 +175,10 @@ The complete list of all CQL statements and versions can be found below: http://docs.datastax.com/en/cql/3.0/cql/aboutCQL.html | -
## 6. Comments in statements @@ -203,21 +196,19 @@ It is possible to add comments between statements. Single line comments start wi Insert into users(login,name) vAlues('hsue','Helen SUE'); ``` -
## 7. Syntax Validation The interpreters is shipped with a built-in syntax validator. This validator only checks for basic syntax errors. -All CQL-related syntax validation is delegated directly to **Cassandra** +All CQL-related syntax validation is delegated directly to **Cassandra**. Most of the time, syntax errors are due to **missing semi-colons** between statements or **typo errors**. -
## 8. Schema commands To make schema discovery easier and more interactive, the following commands are supported: -
| Command | @@ -226,67 +217,65 @@ To make schema discovery easier and more interactive, the following commands are|
|---|---|
| DESCRIBE CLUSTER; | Show the current cluster name and its partitioner | -
| DESCRIBE KEYSPACES; | List all existing keyspaces in the cluster and their configuration (replication factor, durable write ...) | -
| DESCRIBE TABLES; | List all existing keyspaces in the cluster and for each, all the tables name | -
| DESCRIBE TYPES; | List all existing user defined types in the current (logged) keyspace | -
| DESCRIBE FUNCTIONS <keyspace_name>; | List all existing user defined functions in the given keyspace | -
| DESCRIBE AGGREGATES <keyspace_name>; | List all existing user defined aggregates in the given keyspace | -
| DESCRIBE KEYSPACE <keyspace_name>; | -Describe the given keyspace configuration and all its table details (name, columns, ...) | -Describe the given keyspace configuration and all its table details (name, columns, ...) | +
| DESCRIBE TABLE (<keyspace_name>).<table_name>; | Describe the given table. If the keyspace is not provided, the current logged in keyspace is used. If there is no logged in keyspace, the default system keyspace is used. - If no table is found, an error message is raised + If no table is found, an error message is raised. | -
| DESCRIBE TYPE (<keyspace_name>).<type_name>; | Describe the given type(UDT). If the keyspace is not provided, the current logged in keyspace is used. If there is no logged in keyspace, the default system keyspace is used. - If no type is found, an error message is raised + If no type is found, an error message is raised. | -
| DESCRIBE FUNCTION (<keyspace_name>).<function_name>; | -Describe the given user defined function. The keyspace is optional | -Describe the given user defined function. The keyspace is optional. | +
| DESCRIBE AGGREGATE (<keyspace_name>).<aggregate_name>; | -Describe the given user defined aggregate. The keyspace is optional | -Describe the given user defined aggregate. The keyspace is optional. | +
## 9. Runtime Parameters @@ -294,8 +283,7 @@ Sometimes you want to be able to pass runtime query parameters to your statement Those parameters are not part of the CQL specs and are specific to the interpreter. Below is the list of all parameters: -
-
| Parameter | @@ -305,38 +293,37 @@ Below is the list of all parameters:|||
|---|---|---|---|
| Consistency Level | @consistency=value | -Apply the given consistency level to all queries in the paragraph | +Apply the given consistency level to all queries in the paragraph. |
| Serial Consistency Level | @serialConsistency=value | -Apply the given serial consistency level to all queries in the paragraph | +Apply the given serial consistency level to all queries in the paragraph. |
| Timestamp | @timestamp=long value | Apply the given timestamp to all queries in the paragraph. - Please note that timestamp value passed directly in CQL statement will override this value + Please note that timestamp value passed directly in CQL statement will override this value. | |
| Retry Policy | @retryPolicy=value | -Apply the given retry policy to all queries in the paragraph | +Apply the given retry policy to all queries in the paragraph. |
| Fetch Size | @fetchSize=integer value | -Apply the given fetch size to all queries in the paragraph | +Apply the given fetch size to all queries in the paragraph. |
-
| Parameter | @@ -344,11 +331,11 @@ Below is the list of all parameters:||
|---|---|---|
| Consistency Level | -ALL, ANY, ONE, TWO, THREE, QUORUM, LOCAL_ONE, LOCAL_QUORUM, EACH_QUORUM | +ALL, ANY, ONE, TWO, THREE, QUORUM, LOCAL\_ONE, LOCAL\_QUORUM, EACH\_QUORUM |
| Serial Consistency Level | -SERIAL, LOCAL_SERIAL | +SERIAL, LOCAL\_SERIAL |
| Timestamp | @@ -356,7 +343,7 @@ Below is the list of all parameters:||
| Retry Policy | -DEFAULT, DOWNGRADING_CONSISTENCY, FALLTHROUGH, LOGGING_DEFAULT, LOGGING_DOWNGRADING, LOGGING_FALLTHROUGH | +DEFAULT, DOWNGRADING\_CONSISTENCY, FALLTHROUGH, LOGGING\_DEFAULT, LOGGING\_DOWNGRADING, LOGGING\_FALLTHROUGH |
| Fetch Size | @@ -365,7 +352,7 @@ Below is the list of all parameters:
## 10. Support for Prepared Statements @@ -424,17 +410,15 @@ Example: @remove_prepare[statement_name] ``` -
#### a. @prepare -
-You can use the syntax _"@prepare[statement_name]=SELECT ..."_ to create a prepared statement. -The _statement_name_ is **mandatory** because the interpreter prepares the given statement with the Java driver and -saves the generated prepared statement in an **internal hash map**, using the provided _statement_name_ as search key. +You can use the syntax `@prepare[statement_name]=SELECT ...` to create a prepared statement. +The `statement_name` is **mandatory** because the interpreter prepares the given statement with the Java driver and +saves the generated prepared statement in an **internal hash map**, using the provided `statement_name` as search key. > Please note that this internal prepared statement map is shared with **all notebooks** and **all paragraphs** because -there is only one instance of the interpreter for Cassandra +there is only one instance of the interpreter for Cassandra. -> If the interpreter encounters **many** @prepare for the **same _statement_name_ (key)**, only the **first** statement will be taken into account. +> If the interpreter encounters **many** @prepare for the **same statement_name (key)**, only the **first** statement will be taken into account. Example: @@ -443,37 +427,36 @@ Example: @prepare[select]=SELECT * FROM spark_demo.albums LIMIT ? @prepare[select]=SELECT * FROM spark_demo.artists LIMIT ? -``` +``` -For the above example, the prepared statement is _SELECT * FROM spark_demo.albums LIMIT ?_. -_SELECT * FROM spark_demo.artists LIMIT ?_ is ignored because an entry already exists in the prepared statements map with the key select. +For the above example, the prepared statement is `SELECT * FROM spark_demo.albums LIMIT ?`. +`SELECT * FROM spark_demo.artists LIMIT ?` is ignored because an entry already exists in the prepared statements map with the key select. In the context of **Zeppelin**, a notebook can be scheduled to be executed at regular interval, thus it is necessary to **avoid re-preparing many time the same statement (considered an anti-pattern)**. -
-
+ #### b. @bind -
-Once the statement is prepared (possibly in a separated notebook/paragraph). You can bind values to it: + +Once the statement is prepared ( possibly in a separated notebook/paragraph ). You can bind values to it: ``` @bind[select_first]=10 -``` +``` -Bound values are not mandatory for the **@bind** statement. However if you provide bound values, they need to comply to some syntax: +Bound values are not mandatory for the `@bind` statement. However if you provide bound values, they need to comply to some syntax: * String values should be enclosed between simple quotes ( ‘ ) * Date values should be enclosed between simple quotes ( ‘ ) and respect the formats: 1. yyyy-MM-dd HH:MM:ss 2. yyyy-MM-dd HH:MM:ss.SSS -* **null** is parsed as-is -* **boolean** (true|false) are parsed as-is +* **null** is parsed as-is. +* **boolean** (true|false) is parsed as-is. * collection values must follow the **[standard CQL syntax]**: * list: [‘list_item1’, ’list_item2’, ...] * set: {‘set_item1’, ‘set_item2’, …} * map: {‘key1’: ‘val1’, ‘key2’: ‘val2’, …} -* **tuple** values should be enclosed between parenthesis (see **[Tuple CQL syntax]**): (‘text’, 123, true) -* **udt** values should be enclosed between brackets (see **[UDT CQL syntax]**): {stree_name: ‘Beverly Hills’, number: 104, zip_code: 90020, state: ‘California’, …} +* **tuple** values should be enclosed between parenthesis ( see **[Tuple CQL syntax]** ): (‘text’, 123, true) +* **udt** values should be enclosed between brackets ( see **[UDT CQL syntax]** ): {stree_name: ‘Beverly Hills’, number: 104, zip_code: 90020, state: ‘California’, …} > It is possible to use the @bind statement inside a batch: > @@ -485,14 +468,12 @@ Bound values are not mandatory for the **@bind** statement. However if you provi > APPLY BATCH; > ``` -
#### c. @remove_prepare -
+ To avoid for a prepared statement to stay forever in the prepared statement map, you can use the -**@remove_prepare[statement_name]** syntax to remove it. +`@remove_prepare[statement_name]` syntax to remove it. Removing a non-existing prepared statement yields no error. -
## 11. Using Dynamic Forms @@ -529,7 +510,6 @@ It is also possible to use dynamic forms for **prepared statements**: {% endraw %} -
## 12. Execution parallelism and shared states @@ -543,44 +523,34 @@ Consequently, if you use the **USE _keyspace name_;** statement to log into a ke per instance of **Cassandra** interpreter. The same remark does apply to the **prepared statement hash map**, it is shared by **all users** using the same instance of **Cassandra** interpreter. - Until **Zeppelin** offers a real multi-users separation, there is a work-around to segregate user environment and states: -_create different **Cassandra** interpreter instances_ +create different **Cassandra** interpreter instances. -For this, first go to the **Interpreter** menu and click on the **Create** button -
-
+For this, first go to the **Interpreter** menu and click on the **Create** button.
-
+in the interpreter drop-down list
-
-
## 13. Interpreter Configuration @@ -638,7 +608,7 @@ Below are the configuration parameters and their default value. It is strongly recommended to let the default value and prefix the table name with the actual keyspace - in all of your queries + in all of your queries.
- Available values: ONE, TWO, THREE, QUORUM, LOCAL_ONE, LOCAL_QUORUM, EACH_QUORUM, ALL + Available values: ONE, TWO, THREE, QUORUM, LOCAL\_ONE, LOCAL\_QUORUM, EACH\_QUORUM, ALL
## 14. Bugs & Contacts If you encounter a bug for this interpreter, please create a **[JIRA]** ticket and ping me on Twitter - at **[@doanduyhai]** + at **[@doanduyhai]**. [Cassandra Java Driver]: https://github.com/datastax/java-driver diff --git a/docs/interpreter/elasticsearch.md b/docs/interpreter/elasticsearch.md index 34a23ba354..ba1b6f7886 100644 --- a/docs/interpreter/elasticsearch.md +++ b/docs/interpreter/elasticsearch.md @@ -8,10 +8,11 @@ group: manual ## Elasticsearch Interpreter for Apache Zeppelin +[Elasticsearch](https://www.elastic.co/products/elasticsearch) is a highly scalable open-source full-text search and analytics engine. It allows you to store, search, and analyze big volumes of data quickly and in near real time. It is generally used as the underlying engine/technology that powers applications that have complex search features and requirements. -### 1. Configuration +
+## 1. Configuration -
+
+
+
-### What is zeppelin interpreter setting?
+
-### What is zeppelin interpreter group?
-Every Interpreter belongs to an InterpreterGroup. InterpreterGroup is a unit of start/stop interpreter.
-By default, every interpreter belong to a single group but the group might contain more interpreters. For example, spark interpreter group include spark support, pySpark,
+
-### Programming langages for interpreter
+