You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by zj...@apache.org on 2021/06/03 15:43:43 UTC
svn commit: r1890433 [9/9] - in /zeppelin/site/docs/0.9.0: ./
assets/themes/zeppelin/img/docs-img/
assets/themes/zeppelin/img/screenshots/ development/
development/contribution/ development/helium/ interpreter/ quickstart/
setup/basics/ setup/deploymen...
Modified: zeppelin/site/docs/0.9.0/usage/rest_api/zeppelin_server.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.9.0/usage/rest_api/zeppelin_server.html?rev=1890433&r1=1890432&r2=1890433&view=diff
==============================================================================
--- zeppelin/site/docs/0.9.0/usage/rest_api/zeppelin_server.html (original)
+++ zeppelin/site/docs/0.9.0/usage/rest_api/zeppelin_server.html Thu Jun 3 15:43:41 2021
@@ -125,6 +125,9 @@
<li><a href="/docs/0.9.0/usage/rest_api/configuration.html">Configuration API</a></li>
<li><a href="/docs/0.9.0/usage/rest_api/credential.html">Credential API</a></li>
<li><a href="/docs/0.9.0/usage/rest_api/helium.html">Helium API</a></li>
+ <li class="title"><span>Zeppelin SDK</span></li>
+ <li><a href="/docs/0.9.0/usage/zeppelin_sdk/client_api.html">Client API</a></li>
+ <li><a href="/docs/0.9.0/usage/zeppelin_sdk/session_api.html">Session API</a></li>
</ul>
</li>
@@ -192,17 +195,21 @@
<li><a href="/docs/0.9.0/interpreter/hdfs.html">HDFS</a></li>
<li><a href="/docs/0.9.0/interpreter/hive.html">Hive</a></li>
<li><a href="/docs/0.9.0/interpreter/ignite.html">Ignite</a></li>
+ <li><a href="/docs/0.9.0/interpreter/influxdb.html">influxDB</a></li>
<li><a href="/docs/0.9.0/interpreter/java.html">Java</a></li>
<li><a href="/docs/0.9.0/interpreter/jupyter.html">Jupyter</a></li>
<li><a href="/docs/0.9.0/interpreter/kotlin.html">Kotlin</a></li>
+ <li><a href="/docs/0.9.0/interpreter/ksql.html">KSQL</a></li>
<li><a href="/docs/0.9.0/interpreter/kylin.html">Kylin</a></li>
<li><a href="/docs/0.9.0/interpreter/lens.html">Lens</a></li>
<li><a href="/docs/0.9.0/interpreter/livy.html">Livy</a></li>
+ <li><a href="/docs/0.9.0/interpreter/mahout.html">Mahout</a></li>
<li><a href="/docs/0.9.0/interpreter/markdown.html">Markdown</a></li>
<li><a href="/docs/0.9.0/interpreter/mongodb.html">MongoDB</a></li>
<li><a href="/docs/0.9.0/interpreter/neo4j.html">Neo4j</a></li>
<li><a href="/docs/0.9.0/interpreter/pig.html">Pig</a></li>
<li><a href="/docs/0.9.0/interpreter/postgresql.html">Postgresql, HAWQ</a></li>
+ <li><a href="/docs/0.9.0/interpreter/sap.html">SAP</a></li>
<li><a href="/docs/0.9.0/interpreter/scalding.html">Scalding</a></li>
<li><a href="/docs/0.9.0/interpreter/scio.html">Scio</a></li>
<li><a href="/docs/0.9.0/interpreter/shell.html">Shell</a></li>
@@ -306,21 +313,20 @@ Note that Apache Zeppelin REST APIs rece
</tr>
<tr>
<td>sample JSON response</td>
- <td>
- <pre>
-{
- "status": "OK",
- "message": "Zeppelin version",
- "body": [
- {
- "version": "0.8.0",
- "git-commit-id": "abc0123",
- "git-timestamp": "2017-01-02 03:04:05"
- }
- ]
-}
- </pre>
- </td>
+ <td></p>
+<div class="highlight"><pre><code class="json language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"status"</span><span class="p">:</span> <span class="s2">"OK"</span><span class="p">,</span>
+ <span class="nt">"message"</span><span class="p">:</span> <span class="s2">"Zeppelin version"</span><span class="p">,</span>
+ <span class="nt">"body"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="nt">"version"</span><span class="p">:</span> <span class="s2">"0.8.0"</span><span class="p">,</span>
+ <span class="nt">"git-commit-id"</span><span class="p">:</span> <span class="s2">"abc0123"</span><span class="p">,</span>
+ <span class="nt">"git-timestamp"</span><span class="p">:</span> <span class="s2">"2017-01-02 03:04:05"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</code></pre></div>
+<p></td>
</tr>
</table></p>
@@ -346,24 +352,22 @@ Note that Apache Zeppelin REST APIs rece
</tr>
<tr>
<td>sample JSON response</td>
- <td>
- <pre>
-{
- "status": "OK"
-}
- </pre>
- </td>
+ <td></p>
+<div class="highlight"><pre><code class="json language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"status"</span><span class="p">:</span> <span class="s2">"OK"</span>
+<span class="p">}</span>
+</code></pre></div>
+<p></td>
</tr>
<tr>
<td>sample error JSON response</td>
- <td>
- <pre>
-{
- "status":"NOT_ACCEPTABLE",
- "message":"Please check LOG level specified. Valid values: DEBUG, ERROR, FATAL, INFO, TRACE, WARN"
-}
- </pre>
- </td>
+ <td></p>
+<div class="highlight"><pre><code class="json language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"status"</span><span class="p">:</span><span class="s2">"NOT_ACCEPTABLE"</span><span class="p">,</span>
+ <span class="nt">"message"</span><span class="p">:</span><span class="s2">"Please check LOG level specified. Valid values: DEBUG, ERROR, FATAL, INFO, TRACE, WARN"</span>
+<span class="p">}</span>
+</code></pre></div>
+<p></td>
</tr>
</table></p>
@@ -373,7 +377,7 @@ Note that Apache Zeppelin REST APIs rece
<hr>
<footer>
- <!-- <p>© 2020 The Apache Software Foundation</p>-->
+ <!-- <p>© 2021 The Apache Software Foundation</p>-->
</footer>
</div>
Added: zeppelin/site/docs/0.9.0/usage/zeppelin_sdk/client_api.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.9.0/usage/zeppelin_sdk/client_api.html?rev=1890433&view=auto
==============================================================================
--- zeppelin/site/docs/0.9.0/usage/zeppelin_sdk/client_api.html (added)
+++ zeppelin/site/docs/0.9.0/usage/zeppelin_sdk/client_api.html Thu Jun 3 15:43:41 2021
@@ -0,0 +1,407 @@
+
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Apache Zeppelin 0.9.0 Documentation: Apache Zeppelin SDK - ZeppelinClient API</title>
+ <meta name="description" content="This page contains Apache Zeppelin Client API.">
+ <meta name="author" content="The Apache Software Foundation">
+
+ <!-- Enable responsive viewport -->
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet">
+
+ <!-- Le styles -->
+ <link href="/docs/0.9.0/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet">
+ <link href="/docs/0.9.0/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css">
+ <link href="/docs/0.9.0/assets/themes/zeppelin/css/syntax.css" rel="stylesheet" type="text/css" media="screen" />
+ <!-- Le fav and touch icons -->
+ <!-- Update these with your own images
+ <link rel="shortcut icon" href="images/favicon.ico">
+ <link rel="apple-touch-icon" href="images/apple-touch-icon.png">
+ <link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png">
+ <link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png">
+ -->
+
+ <!-- Js -->
+ <script src="https://code.jquery.com/jquery-1.10.2.min.js"></script>
+ <script src="/docs/0.9.0/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
+ <script src="/docs/0.9.0/assets/themes/zeppelin/js/docs.js"></script>
+ <script src="/docs/0.9.0/assets/themes/zeppelin/js/anchor.min.js"></script>
+ <script src="/docs/0.9.0/assets/themes/zeppelin/js/toc.js"></script>
+ <script src="/docs/0.9.0/assets/themes/zeppelin/js/lunr.min.js"></script>
+ <script src="/docs/0.9.0/assets/themes/zeppelin/js/search.js"></script>
+
+ <!-- atom & rss feed -->
+ <link href="/docs/0.9.0/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
+ <link href="/docs/0.9.0/rss.xml" type="application/rss+xml" rel="alternate" title="Sitewide RSS Feed">
+ </head>
+
+ <body>
+
+ <div id="menu" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container navbar-container">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <div class="navbar-brand">
+ <a class="navbar-brand-main" href="http://zeppelin.apache.org">
+ <img src="/docs/0.9.0/assets/themes/zeppelin/img/zeppelin_logo.png" width="50"
+ style="margin-top: -2px;" alt="I'm zeppelin">
+ <span style="margin-left: 5px; font-size: 27px;">Zeppelin</span>
+ <a class="navbar-brand-version" href="/docs/0.9.0"
+ style="font-size: 15px; color: white;"> 0.9.0
+ </a>
+ </a>
+ </div>
+ </div>
+ <nav class="navbar-collapse collapse" role="navigation">
+ <ul class="nav navbar-nav">
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Quick Start <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li class="title"><span>Getting Started</span></li>
+ <li><a href="/docs/0.9.0/quickstart/install.html">Install</a></li>
+ <li><a href="/docs/0.9.0/quickstart/explore_ui.html">Explore UI</a></li>
+ <li><a href="/docs/0.9.0/quickstart/tutorial.html">Tutorial</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Run Mode</span></li>
+ <li><a href="/docs/0.9.0/quickstart/kubernetes.html">Kubernetes</a></li>
+ <li><a href="/docs/0.9.0/quickstart/docker.html">Docker</a></li>
+ <li><a href="/docs/0.9.0/quickstart/yarn.html">Yarn</a></li>
+ <li role="separator" class="divider"></li>
+ <li><a href="/docs/0.9.0/quickstart/spark_with_zeppelin.html">Spark with Zeppelin</a></li>
+ <li><a href="/docs/0.9.0/quickstart/sql_with_zeppelin.html">SQL with Zeppelin</a></li>
+ <li><a href="/docs/0.9.0/quickstart/python_with_zeppelin.html">Python with Zeppelin</a></li>
+ </ul>
+ </li>
+
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Usage<b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu">
+ <li class="title"><span>Dynamic Form</span></li>
+ <li><a href="/docs/0.9.0/usage/dynamic_form/intro.html">What is Dynamic Form?</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Display System</span></li>
+ <li><a href="/docs/0.9.0/usage/display_system/basic.html#text">Text Display</a></li>
+ <li><a href="/docs/0.9.0/usage/display_system/basic.html#html">HTML Display</a></li>
+ <li><a href="/docs/0.9.0/usage/display_system/basic.html#table">Table Display</a></li>
+ <li><a href="/docs/0.9.0/usage/display_system/basic.html#network">Network Display</a></li>
+ <li><a href="/docs/0.9.0/usage/display_system/angular_backend.html">Angular Display using Backend API</a></li>
+ <li><a href="/docs/0.9.0/usage/display_system/angular_frontend.html">Angular Display using Frontend API</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Interpreter</span></li>
+ <li><a href="/docs/0.9.0/usage/interpreter/overview.html">Overview</a></li>
+ <li><a href="/docs/0.9.0/usage/interpreter/interpreter_binding_mode.html">Interpreter Binding Mode</a></li>
+ <li><a href="/docs/0.9.0/usage/interpreter/user_impersonation.html">User Impersonation</a></li>
+ <li><a href="/docs/0.9.0/usage/interpreter/dependency_management.html">Dependency Management</a></li>
+ <li><a href="/docs/0.9.0/usage/interpreter/installation.html">Installing Interpreters</a></li>
+ <!--<li><a href="/docs/0.9.0/usage/interpreter/dynamic_loading.html">Dynamic Interpreter Loading (Experimental)</a></li>-->
+ <li><a href="/docs/0.9.0/usage/interpreter/execution_hooks.html">Execution Hooks (Experimental)</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Other Features</span></li>
+ <li><a href="/docs/0.9.0/usage/other_features/publishing_paragraphs.html">Publishing Paragraphs</a></li>
+ <li><a href="/docs/0.9.0/usage/other_features/personalized_mode.html">Personalized Mode</a></li>
+ <li><a href="/docs/0.9.0/usage/other_features/customizing_homepage.html">Customizing Zeppelin Homepage</a></li>
+ <li><a href="/docs/0.9.0/usage/other_features/notebook_actions.html">Notebook Actions</a></li>
+ <li><a href="/docs/0.9.0/usage/other_features/cron_scheduler.html">Cron Scheduler</a></li>
+ <li><a href="/docs/0.9.0/usage/other_features/zeppelin_context.html">Zeppelin Context</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>REST API</span></li>
+ <li><a href="/docs/0.9.0/usage/rest_api/interpreter.html">Interpreter API</a></li>
+ <li><a href="/docs/0.9.0/usage/rest_api/zeppelin_server.html">Zeppelin Server API</a></li>
+ <li><a href="/docs/0.9.0/usage/rest_api/notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.9.0/usage/rest_api/notebook_repository.html">Notebook Repository API</a></li>
+ <li><a href="/docs/0.9.0/usage/rest_api/configuration.html">Configuration API</a></li>
+ <li><a href="/docs/0.9.0/usage/rest_api/credential.html">Credential API</a></li>
+ <li><a href="/docs/0.9.0/usage/rest_api/helium.html">Helium API</a></li>
+ <li class="title"><span>Zeppelin SDK</span></li>
+ <li><a href="/docs/0.9.0/usage/zeppelin_sdk/client_api.html">Client API</a></li>
+ <li><a href="/docs/0.9.0/usage/zeppelin_sdk/session_api.html">Session API</a></li>
+ </ul>
+ </li>
+
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Setup<b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu">
+ <li class="title"><span>Basics</span></li>
+ <li><a href="/docs/0.9.0/setup/basics/how_to_build.html">How to Build Zeppelin</a></li>
+ <li><a href="/docs/0.9.0/setup/basics/hadoop_integration.html">Hadoop Integration</a></li>
+ <li><a href="/docs/0.9.0/setup/basics/multi_user_support.html">Multi-user Support</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Deployment</span></li>
+ <!--<li><a href="/docs/0.9.0/setup/deployment/docker.html">Docker Image for Zeppelin</a></li>-->
+ <li><a href="/docs/0.9.0/setup/deployment/spark_cluster_mode.html#spark-standalone-mode">Spark Cluster Mode: Standalone</a></li>
+ <li><a href="/docs/0.9.0/setup/deployment/spark_cluster_mode.html#spark-on-yarn-mode">Spark Cluster Mode: YARN</a></li>
+ <li><a href="/docs/0.9.0/setup/deployment/spark_cluster_mode.html#spark-on-mesos-mode">Spark Cluster Mode: Mesos</a></li>
+ <li><a href="/docs/0.9.0/setup/deployment/flink_and_spark_cluster.html">Zeppelin with Flink, Spark Cluster</a></li>
+ <li><a href="/docs/0.9.0/setup/deployment/cdh.html">Zeppelin on CDH</a></li>
+ <li><a href="/docs/0.9.0/setup/deployment/virtual_machine.html">Zeppelin on VM: Vagrant</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Security</span></li>
+ <li><a href="/docs/0.9.0/setup/security/authentication_nginx.html">HTTP Basic Auth using NGINX</a></li>
+ <li><a href="/docs/0.9.0/setup/security/shiro_authentication.html">Shiro Authentication</a></li>
+ <li><a href="/docs/0.9.0/setup/security/notebook_authorization.html">Notebook Authorization</a></li>
+ <li><a href="/docs/0.9.0/setup/security/datasource_authorization.html">Data Source Authorization</a></li>
+ <li><a href="/docs/0.9.0/setup/security/http_security_headers.html">HTTP Security Headers</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Notebook Storage</span></li>
+ <li><a href="/docs/0.9.0/setup/storage/storage.html#notebook-storage-in-local-git-repository">Git Storage</a></li>
+ <li><a href="/docs/0.9.0/setup/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li>
+ <li><a href="/docs/0.9.0/setup/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li>
+ <li><a href="/docs/0.9.0/setup/storage/storage.html#notebook-storage-in-oss">OSS Storage</a></li>
+ <li><a href="/docs/0.9.0/setup/storage/storage.html#notebook-storage-in-zeppelinhub">ZeppelinHub Storage</a></li>
+ <li><a href="/docs/0.9.0/setup/storage/storage.html#notebook-storage-in-mongodb">MongoDB Storage</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Operation</span></li>
+ <li><a href="/docs/0.9.0/setup/operation/configuration.html">Configuration</a></li>
+ <li><a href="/docs/0.9.0/setup/operation/proxy_setting.html">Proxy Setting</a></li>
+ <li><a href="/docs/0.9.0/setup/operation/upgrading.html">Upgrading</a></li>
+ <li><a href="/docs/0.9.0/setup/operation/trouble_shooting.html">Trouble Shooting</a></li>
+ </ul>
+ </li>
+
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Interpreter <b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu">
+ <li class="title"><span>Interpreters</span></li>
+ <li><a href="/docs/0.9.0/usage/interpreter/overview.html">Overview</a></li>
+ <li role="separator" class="divider"></li>
+ <li><a href="/docs/0.9.0/interpreter/spark.html">Spark</a></li>
+ <li><a href="/docs/0.9.0/interpreter/jdbc.html">JDBC</a></li>
+ <li><a href="/docs/0.9.0/interpreter/python.html">Python</a></li>
+ <li><a href="/docs/0.9.0/interpreter/r.html">R</a></li>
+ <li role="separator" class="divider"></li>
+ <li><a href="/docs/0.9.0/interpreter/alluxio.html">Alluxio</a></li>
+ <li><a href="/docs/0.9.0/interpreter/beam.html">Beam</a></li>
+ <li><a href="/docs/0.9.0/interpreter/bigquery.html">BigQuery</a></li>
+ <li><a href="/docs/0.9.0/interpreter/cassandra.html">Cassandra</a></li>
+ <li><a href="/docs/0.9.0/interpreter/elasticsearch.html">Elasticsearch</a></li>
+ <li><a href="/docs/0.9.0/interpreter/flink.html">Flink</a></li>
+ <li><a href="/docs/0.9.0/interpreter/geode.html">Geode</a></li>
+ <li><a href="/docs/0.9.0/interpreter/groovy.html">Groovy</a></li>
+ <li><a href="/docs/0.9.0/interpreter/hazelcastjet.html">Hazelcast Jet</a></li>
+ <li><a href="/docs/0.9.0/interpreter/hbase.html">HBase</a></li>
+ <li><a href="/docs/0.9.0/interpreter/hdfs.html">HDFS</a></li>
+ <li><a href="/docs/0.9.0/interpreter/hive.html">Hive</a></li>
+ <li><a href="/docs/0.9.0/interpreter/ignite.html">Ignite</a></li>
+ <li><a href="/docs/0.9.0/interpreter/influxdb.html">influxDB</a></li>
+ <li><a href="/docs/0.9.0/interpreter/java.html">Java</a></li>
+ <li><a href="/docs/0.9.0/interpreter/jupyter.html">Jupyter</a></li>
+ <li><a href="/docs/0.9.0/interpreter/kotlin.html">Kotlin</a></li>
+ <li><a href="/docs/0.9.0/interpreter/ksql.html">KSQL</a></li>
+ <li><a href="/docs/0.9.0/interpreter/kylin.html">Kylin</a></li>
+ <li><a href="/docs/0.9.0/interpreter/lens.html">Lens</a></li>
+ <li><a href="/docs/0.9.0/interpreter/livy.html">Livy</a></li>
+ <li><a href="/docs/0.9.0/interpreter/mahout.html">Mahout</a></li>
+ <li><a href="/docs/0.9.0/interpreter/markdown.html">Markdown</a></li>
+ <li><a href="/docs/0.9.0/interpreter/mongodb.html">MongoDB</a></li>
+ <li><a href="/docs/0.9.0/interpreter/neo4j.html">Neo4j</a></li>
+ <li><a href="/docs/0.9.0/interpreter/pig.html">Pig</a></li>
+ <li><a href="/docs/0.9.0/interpreter/postgresql.html">Postgresql, HAWQ</a></li>
+ <li><a href="/docs/0.9.0/interpreter/sap.html">SAP</a></li>
+ <li><a href="/docs/0.9.0/interpreter/scalding.html">Scalding</a></li>
+ <li><a href="/docs/0.9.0/interpreter/scio.html">Scio</a></li>
+ <li><a href="/docs/0.9.0/interpreter/shell.html">Shell</a></li>
+ <li><a href="/docs/0.9.0/interpreter/sparql.html">Sparql</a></li>
+ <li><a href="/docs/0.9.0/interpreter/submarine.html">Submarine</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">More<b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu" style="right: 0; left: auto;">
+ <li class="title"><span>Extending Zeppelin</span></li>
+ <li><a href="/docs/0.9.0/development/writing_zeppelin_interpreter.html">Writing Zeppelin Interpreter</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Helium (Experimental)</span></li>
+ <li><a href="/docs/0.9.0/development/helium/overview.html">Overview</a></li>
+ <li><a href="/docs/0.9.0/development/helium/writing_application.html">Writing Helium Application</a></li>
+ <li><a href="/docs/0.9.0/development/helium/writing_spell.html">Writing Helium Spell</a></li>
+ <li><a href="/docs/0.9.0/development/helium/writing_visualization_basic.html">Writing Helium Visualization: Basics</a></li>
+ <li><a href="/docs/0.9.0/development/helium/writing_visualization_transformation.html">Writing Helium Visualization: Transformation</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Contributing to Zeppelin</span></li>
+ <li><a href="/docs/0.9.0/setup/basics/how_to_build.html">How to Build Zeppelin</a></li>
+ <li><a href="/docs/0.9.0/development/contribution/useful_developer_tools.html">Useful Developer Tools</a></li>
+ <li><a href="/docs/0.9.0/development/contribution/how_to_contribute_code.html">How to Contribute (code)</a></li>
+ <li><a href="/docs/0.9.0/development/contribution/how_to_contribute_website.html">How to Contribute (website)</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>External Resources</span></li>
+ <li><a target="_blank" href="https://zeppelin.apache.org/community.html">Mailing List</a></li>
+ <li><a target="_blank" href="https://cwiki.apache.org/confluence/display/ZEPPELIN/Zeppelin+Home">Apache Zeppelin Wiki</a></li>
+ <li><a target="_blank" href="http://stackoverflow.com/questions/tagged/apache-zeppelin">Stackoverflow Questions about Zeppelin</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="/docs/0.9.0/search.html" class="nav-search-link">
+ <span class="fa fa-search nav-search-icon"></span>
+ </a>
+ </li>
+ </ul>
+ </nav><!--/.navbar-collapse -->
+ </div>
+ </div>
+
+
+
+ <div class="content">
+
+<!--<div class="hero-unit Apache Zeppelin SDK - ZeppelinClient API">
+ <h1></h1>
+</div>
+-->
+
+<div class="row">
+ <div class="col-md-12">
+ <!--
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+<h1>Apache Zeppelin SDK - Zeppelin Client API</h1>
+
+<div id="toc"></div>
+
+<h2>Overview</h2>
+
+<p>Zeppelin client api is a lower level java api which encapsulates Zeppelin's rest api so that you can easily integrate Zeppelin
+with your system. You can use zeppelin client api to do most of the things in notebook ui in a programmatic way, such as create/delete note/paragraph,
+run note/paragraph and etc.</p>
+
+<h2>How to use Zeppelin Client API</h2>
+
+<p>The entry point of zeppelin client api is class <code>ZeppelinClient</code>. All the operations is via this class, e.g. in the following example, we use <code>ZeppelinClient</code> to run the spark tutorial note programmatically.</p>
+
+<div class="highlight"><pre><code class="java"><span class="n">ClientConfig</span> <span class="n">clientConfig</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ClientConfig</span><span class="o">(</span><span class="s">"http://localhost:8080"</span><span class="o">);</span>
+<span class="n">ZeppelinClient</span> <span class="n">zClient</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ZeppelinClient</span><span class="o">(</span><span class="n">clientConfig</span><span class="o">);</span>
+
+<span class="n">String</span> <span class="n">zeppelinVersion</span> <span class="o">=</span> <span class="n">zClient</span><span class="o">.</span><span class="na">getVersion</span><span class="o">();</span>
+<span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Zeppelin version: "</span> <span class="o">+</span> <span class="n">zeppelinVersion</span><span class="o">);</span>
+
+<span class="c1">// execute note 2A94M5J1Z paragraph by paragraph</span>
+<span class="k">try</span> <span class="o">{</span>
+ <span class="n">ParagraphResult</span> <span class="n">paragraphResult</span> <span class="o">=</span> <span class="n">zClient</span><span class="o">.</span><span class="na">executeParagraph</span><span class="o">(</span><span class="s">"2A94M5J1Z"</span><span class="o">,</span> <span class="s">"20150210-015259_1403135953"</span><span class="o">);</span>
+ <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Execute the 1st spark tutorial paragraph, paragraph result: "</span> <span class="o">+</span> <span class="n">paragraphResult</span><span class="o">);</span>
+
+ <span class="n">paragraphResult</span> <span class="o">=</span> <span class="n">zClient</span><span class="o">.</span><span class="na">executeParagraph</span><span class="o">(</span><span class="s">"2A94M5J1Z"</span><span class="o">,</span> <span class="s">"20150210-015302_1492795503"</span><span class="o">);</span>
+ <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Execute the 2nd spark tutorial paragraph, paragraph result: "</span> <span class="o">+</span> <span class="n">paragraphResult</span><span class="o">);</span>
+
+ <span class="n">Map</span><span class="o"><</span><span class="n">String</span><span class="o">,</span> <span class="n">String</span><span class="o">></span> <span class="n">parameters</span> <span class="o">=</span> <span class="k">new</span> <span class="n">HashMap</span><span class="o"><>();</span>
+ <span class="n">parameters</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="s">"maxAge"</span><span class="o">,</span> <span class="s">"40"</span><span class="o">);</span>
+ <span class="n">paragraphResult</span> <span class="o">=</span> <span class="n">zClient</span><span class="o">.</span><span class="na">executeParagraph</span><span class="o">(</span><span class="s">"2A94M5J1Z"</span><span class="o">,</span> <span class="s">"20150212-145404_867439529"</span><span class="o">,</span> <span class="n">parameters</span><span class="o">);</span>
+ <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Execute the 3rd spark tutorial paragraph, paragraph result: "</span> <span class="o">+</span> <span class="n">paragraphResult</span><span class="o">);</span>
+
+ <span class="n">parameters</span> <span class="o">=</span> <span class="k">new</span> <span class="n">HashMap</span><span class="o"><>();</span>
+ <span class="n">parameters</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="s">"marital"</span><span class="o">,</span> <span class="s">"married"</span><span class="o">);</span>
+ <span class="n">paragraphResult</span> <span class="o">=</span> <span class="n">zClient</span><span class="o">.</span><span class="na">executeParagraph</span><span class="o">(</span><span class="s">"2A94M5J1Z"</span><span class="o">,</span> <span class="s">"20150213-230422_1600658137"</span><span class="o">,</span> <span class="n">parameters</span><span class="o">);</span>
+ <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Execute the 4th spark tutorial paragraph, paragraph result: "</span> <span class="o">+</span> <span class="n">paragraphResult</span><span class="o">);</span>
+<span class="o">}</span> <span class="k">finally</span> <span class="o">{</span>
+ <span class="c1">// you need to stop interpreter explicitly if you are running paragraph separately.</span>
+ <span class="n">zClient</span><span class="o">.</span><span class="na">stopInterpreter</span><span class="o">(</span><span class="s">"2A94M5J1Z"</span><span class="o">,</span> <span class="s">"spark"</span><span class="o">);</span>
+<span class="o">}</span>
+</code></pre></div>
+
+<p>Here we list some importance apis of ZeppelinClient, for the completed api, please refer its javadoc.</p>
+
+<div class="highlight"><pre><code class="java"><span class="kd">public</span> <span class="n">String</span> <span class="nf">createNote</span><span class="o">(</span><span class="n">String</span> <span class="n">notePath</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span>
+
+<span class="kd">public</span> <span class="kt">void</span> <span class="nf">deleteNote</span><span class="o">(</span><span class="n">String</span> <span class="n">noteId</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span>
+
+<span class="kd">public</span> <span class="n">NoteResult</span> <span class="nf">executeNote</span><span class="o">(</span><span class="n">String</span> <span class="n">noteId</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span>
+
+<span class="kd">public</span> <span class="n">NoteResult</span> <span class="nf">executeNote</span><span class="o">(</span><span class="n">String</span> <span class="n">noteId</span><span class="o">,</span>
+ <span class="n">Map</span><span class="o"><</span><span class="n">String</span><span class="o">,</span> <span class="n">String</span><span class="o">></span> <span class="n">parameters</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span>
+
+<span class="kd">public</span> <span class="n">NoteResult</span> <span class="nf">queryNoteResult</span><span class="o">(</span><span class="n">String</span> <span class="n">noteId</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span>
+
+<span class="kd">public</span> <span class="n">NoteResult</span> <span class="nf">submitNote</span><span class="o">(</span><span class="n">String</span> <span class="n">noteId</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span>
+
+<span class="kd">public</span> <span class="n">NoteResult</span> <span class="nf">submitNote</span><span class="o">(</span><span class="n">String</span> <span class="n">noteId</span><span class="o">,</span>
+ <span class="n">Map</span><span class="o"><</span><span class="n">String</span><span class="o">,</span> <span class="n">String</span><span class="o">></span> <span class="n">parameters</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span>
+
+<span class="kd">public</span> <span class="n">NoteResult</span> <span class="nf">waitUntilNoteFinished</span><span class="o">(</span><span class="n">String</span> <span class="n">noteId</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span>
+
+<span class="kd">public</span> <span class="n">String</span> <span class="nf">addParagraph</span><span class="o">(</span><span class="n">String</span> <span class="n">noteId</span><span class="o">,</span>
+ <span class="n">String</span> <span class="n">title</span><span class="o">,</span>
+ <span class="n">String</span> <span class="n">text</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span>
+
+<span class="kd">public</span> <span class="kt">void</span> <span class="nf">updateParagraph</span><span class="o">(</span><span class="n">String</span> <span class="n">noteId</span><span class="o">,</span>
+ <span class="n">String</span> <span class="n">paragraphId</span><span class="o">,</span>
+ <span class="n">String</span> <span class="n">title</span><span class="o">,</span>
+ <span class="n">String</span> <span class="n">text</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span>
+
+<span class="kd">public</span> <span class="n">ParagraphResult</span> <span class="nf">executeParagraph</span><span class="o">(</span><span class="n">String</span> <span class="n">noteId</span><span class="o">,</span>
+ <span class="n">String</span> <span class="n">paragraphId</span><span class="o">,</span>
+ <span class="n">String</span> <span class="n">sessionId</span><span class="o">,</span>
+ <span class="n">Map</span><span class="o"><</span><span class="n">String</span><span class="o">,</span> <span class="n">String</span><span class="o">></span> <span class="n">parameters</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span>
+
+<span class="kd">public</span> <span class="n">ParagraphResult</span> <span class="nf">submitParagraph</span><span class="o">(</span><span class="n">String</span> <span class="n">noteId</span><span class="o">,</span>
+ <span class="n">String</span> <span class="n">paragraphId</span><span class="o">,</span>
+ <span class="n">String</span> <span class="n">sessionId</span><span class="o">,</span>
+ <span class="n">Map</span><span class="o"><</span><span class="n">String</span><span class="o">,</span> <span class="n">String</span><span class="o">></span> <span class="n">parameters</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span>
+
+<span class="kd">public</span> <span class="kt">void</span> <span class="nf">cancelParagraph</span><span class="o">(</span><span class="n">String</span> <span class="n">noteId</span><span class="o">,</span> <span class="n">String</span> <span class="n">paragraphId</span><span class="o">)</span>
+
+<span class="kd">public</span> <span class="n">ParagraphResult</span> <span class="nf">queryParagraphResult</span><span class="o">(</span><span class="n">String</span> <span class="n">noteId</span><span class="o">,</span> <span class="n">String</span> <span class="n">paragraphId</span><span class="o">)</span>
+
+<span class="kd">public</span> <span class="n">ParagraphResult</span> <span class="nf">waitUtilParagraphFinish</span><span class="o">(</span><span class="n">String</span> <span class="n">noteId</span><span class="o">,</span> <span class="n">String</span> <span class="n">paragraphId</span><span class="o">)</span>
+</code></pre></div>
+
+<h2>Examples</h2>
+
+<p>For more detailed usage of zeppelin client api, you can check the examples in module <code>zeppelin-client-examples</code></p>
+
+<ul>
+<li><a href="https://github.com/apache/zeppelin/blob/master/zeppelin-client-examples/src/main/java/org/apache/zeppelin/client/examples/ZeppelinClientExample.java">ZeppelinClientExample</a></li>
+<li><a href="https://github.com/apache/zeppelin/blob/master/zeppelin-client-examples/src/main/java/org/apache/zeppelin/client/examples/ZeppelinClientExample2.java">ZeppelinClientExample2</a></li>
+</ul>
+
+ </div>
+</div>
+
+
+ <hr>
+ <footer>
+ <!-- <p>© 2021 The Apache Software Foundation</p>-->
+ </footer>
+ </div>
+
+
+
+
+ <script type="text/javascript">
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-45176241-5', 'zeppelin.apache.org');
+ ga('require', 'linkid', 'linkid.js');
+ ga('send', 'pageview');
+
+</script>
+
+
+
+ </body>
+</html>
+
Added: zeppelin/site/docs/0.9.0/usage/zeppelin_sdk/session_api.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.9.0/usage/zeppelin_sdk/session_api.html?rev=1890433&view=auto
==============================================================================
--- zeppelin/site/docs/0.9.0/usage/zeppelin_sdk/session_api.html (added)
+++ zeppelin/site/docs/0.9.0/usage/zeppelin_sdk/session_api.html Thu Jun 3 15:43:41 2021
@@ -0,0 +1,446 @@
+
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Apache Zeppelin 0.9.0 Documentation: Apache Zeppelin SDK - Session API</title>
+ <meta name="description" content="This page contains Apache Zeppelin SDK - Session API.">
+ <meta name="author" content="The Apache Software Foundation">
+
+ <!-- Enable responsive viewport -->
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet">
+
+ <!-- Le styles -->
+ <link href="/docs/0.9.0/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet">
+ <link href="/docs/0.9.0/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css">
+ <link href="/docs/0.9.0/assets/themes/zeppelin/css/syntax.css" rel="stylesheet" type="text/css" media="screen" />
+ <!-- Le fav and touch icons -->
+ <!-- Update these with your own images
+ <link rel="shortcut icon" href="images/favicon.ico">
+ <link rel="apple-touch-icon" href="images/apple-touch-icon.png">
+ <link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png">
+ <link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png">
+ -->
+
+ <!-- Js -->
+ <script src="https://code.jquery.com/jquery-1.10.2.min.js"></script>
+ <script src="/docs/0.9.0/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
+ <script src="/docs/0.9.0/assets/themes/zeppelin/js/docs.js"></script>
+ <script src="/docs/0.9.0/assets/themes/zeppelin/js/anchor.min.js"></script>
+ <script src="/docs/0.9.0/assets/themes/zeppelin/js/toc.js"></script>
+ <script src="/docs/0.9.0/assets/themes/zeppelin/js/lunr.min.js"></script>
+ <script src="/docs/0.9.0/assets/themes/zeppelin/js/search.js"></script>
+
+ <!-- atom & rss feed -->
+ <link href="/docs/0.9.0/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
+ <link href="/docs/0.9.0/rss.xml" type="application/rss+xml" rel="alternate" title="Sitewide RSS Feed">
+ </head>
+
+ <body>
+
+ <div id="menu" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container navbar-container">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <div class="navbar-brand">
+ <a class="navbar-brand-main" href="http://zeppelin.apache.org">
+ <img src="/docs/0.9.0/assets/themes/zeppelin/img/zeppelin_logo.png" width="50"
+ style="margin-top: -2px;" alt="I'm zeppelin">
+ <span style="margin-left: 5px; font-size: 27px;">Zeppelin</span>
+ <a class="navbar-brand-version" href="/docs/0.9.0"
+ style="font-size: 15px; color: white;"> 0.9.0
+ </a>
+ </a>
+ </div>
+ </div>
+ <nav class="navbar-collapse collapse" role="navigation">
+ <ul class="nav navbar-nav">
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Quick Start <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li class="title"><span>Getting Started</span></li>
+ <li><a href="/docs/0.9.0/quickstart/install.html">Install</a></li>
+ <li><a href="/docs/0.9.0/quickstart/explore_ui.html">Explore UI</a></li>
+ <li><a href="/docs/0.9.0/quickstart/tutorial.html">Tutorial</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Run Mode</span></li>
+ <li><a href="/docs/0.9.0/quickstart/kubernetes.html">Kubernetes</a></li>
+ <li><a href="/docs/0.9.0/quickstart/docker.html">Docker</a></li>
+ <li><a href="/docs/0.9.0/quickstart/yarn.html">Yarn</a></li>
+ <li role="separator" class="divider"></li>
+ <li><a href="/docs/0.9.0/quickstart/spark_with_zeppelin.html">Spark with Zeppelin</a></li>
+ <li><a href="/docs/0.9.0/quickstart/sql_with_zeppelin.html">SQL with Zeppelin</a></li>
+ <li><a href="/docs/0.9.0/quickstart/python_with_zeppelin.html">Python with Zeppelin</a></li>
+ </ul>
+ </li>
+
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Usage<b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu">
+ <li class="title"><span>Dynamic Form</span></li>
+ <li><a href="/docs/0.9.0/usage/dynamic_form/intro.html">What is Dynamic Form?</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Display System</span></li>
+ <li><a href="/docs/0.9.0/usage/display_system/basic.html#text">Text Display</a></li>
+ <li><a href="/docs/0.9.0/usage/display_system/basic.html#html">HTML Display</a></li>
+ <li><a href="/docs/0.9.0/usage/display_system/basic.html#table">Table Display</a></li>
+ <li><a href="/docs/0.9.0/usage/display_system/basic.html#network">Network Display</a></li>
+ <li><a href="/docs/0.9.0/usage/display_system/angular_backend.html">Angular Display using Backend API</a></li>
+ <li><a href="/docs/0.9.0/usage/display_system/angular_frontend.html">Angular Display using Frontend API</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Interpreter</span></li>
+ <li><a href="/docs/0.9.0/usage/interpreter/overview.html">Overview</a></li>
+ <li><a href="/docs/0.9.0/usage/interpreter/interpreter_binding_mode.html">Interpreter Binding Mode</a></li>
+ <li><a href="/docs/0.9.0/usage/interpreter/user_impersonation.html">User Impersonation</a></li>
+ <li><a href="/docs/0.9.0/usage/interpreter/dependency_management.html">Dependency Management</a></li>
+ <li><a href="/docs/0.9.0/usage/interpreter/installation.html">Installing Interpreters</a></li>
+ <!--<li><a href="/docs/0.9.0/usage/interpreter/dynamic_loading.html">Dynamic Interpreter Loading (Experimental)</a></li>-->
+ <li><a href="/docs/0.9.0/usage/interpreter/execution_hooks.html">Execution Hooks (Experimental)</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Other Features</span></li>
+ <li><a href="/docs/0.9.0/usage/other_features/publishing_paragraphs.html">Publishing Paragraphs</a></li>
+ <li><a href="/docs/0.9.0/usage/other_features/personalized_mode.html">Personalized Mode</a></li>
+ <li><a href="/docs/0.9.0/usage/other_features/customizing_homepage.html">Customizing Zeppelin Homepage</a></li>
+ <li><a href="/docs/0.9.0/usage/other_features/notebook_actions.html">Notebook Actions</a></li>
+ <li><a href="/docs/0.9.0/usage/other_features/cron_scheduler.html">Cron Scheduler</a></li>
+ <li><a href="/docs/0.9.0/usage/other_features/zeppelin_context.html">Zeppelin Context</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>REST API</span></li>
+ <li><a href="/docs/0.9.0/usage/rest_api/interpreter.html">Interpreter API</a></li>
+ <li><a href="/docs/0.9.0/usage/rest_api/zeppelin_server.html">Zeppelin Server API</a></li>
+ <li><a href="/docs/0.9.0/usage/rest_api/notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.9.0/usage/rest_api/notebook_repository.html">Notebook Repository API</a></li>
+ <li><a href="/docs/0.9.0/usage/rest_api/configuration.html">Configuration API</a></li>
+ <li><a href="/docs/0.9.0/usage/rest_api/credential.html">Credential API</a></li>
+ <li><a href="/docs/0.9.0/usage/rest_api/helium.html">Helium API</a></li>
+ <li class="title"><span>Zeppelin SDK</span></li>
+ <li><a href="/docs/0.9.0/usage/zeppelin_sdk/client_api.html">Client API</a></li>
+ <li><a href="/docs/0.9.0/usage/zeppelin_sdk/session_api.html">Session API</a></li>
+ </ul>
+ </li>
+
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Setup<b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu">
+ <li class="title"><span>Basics</span></li>
+ <li><a href="/docs/0.9.0/setup/basics/how_to_build.html">How to Build Zeppelin</a></li>
+ <li><a href="/docs/0.9.0/setup/basics/hadoop_integration.html">Hadoop Integration</a></li>
+ <li><a href="/docs/0.9.0/setup/basics/multi_user_support.html">Multi-user Support</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Deployment</span></li>
+ <!--<li><a href="/docs/0.9.0/setup/deployment/docker.html">Docker Image for Zeppelin</a></li>-->
+ <li><a href="/docs/0.9.0/setup/deployment/spark_cluster_mode.html#spark-standalone-mode">Spark Cluster Mode: Standalone</a></li>
+ <li><a href="/docs/0.9.0/setup/deployment/spark_cluster_mode.html#spark-on-yarn-mode">Spark Cluster Mode: YARN</a></li>
+ <li><a href="/docs/0.9.0/setup/deployment/spark_cluster_mode.html#spark-on-mesos-mode">Spark Cluster Mode: Mesos</a></li>
+ <li><a href="/docs/0.9.0/setup/deployment/flink_and_spark_cluster.html">Zeppelin with Flink, Spark Cluster</a></li>
+ <li><a href="/docs/0.9.0/setup/deployment/cdh.html">Zeppelin on CDH</a></li>
+ <li><a href="/docs/0.9.0/setup/deployment/virtual_machine.html">Zeppelin on VM: Vagrant</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Security</span></li>
+ <li><a href="/docs/0.9.0/setup/security/authentication_nginx.html">HTTP Basic Auth using NGINX</a></li>
+ <li><a href="/docs/0.9.0/setup/security/shiro_authentication.html">Shiro Authentication</a></li>
+ <li><a href="/docs/0.9.0/setup/security/notebook_authorization.html">Notebook Authorization</a></li>
+ <li><a href="/docs/0.9.0/setup/security/datasource_authorization.html">Data Source Authorization</a></li>
+ <li><a href="/docs/0.9.0/setup/security/http_security_headers.html">HTTP Security Headers</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Notebook Storage</span></li>
+ <li><a href="/docs/0.9.0/setup/storage/storage.html#notebook-storage-in-local-git-repository">Git Storage</a></li>
+ <li><a href="/docs/0.9.0/setup/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li>
+ <li><a href="/docs/0.9.0/setup/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li>
+ <li><a href="/docs/0.9.0/setup/storage/storage.html#notebook-storage-in-oss">OSS Storage</a></li>
+ <li><a href="/docs/0.9.0/setup/storage/storage.html#notebook-storage-in-zeppelinhub">ZeppelinHub Storage</a></li>
+ <li><a href="/docs/0.9.0/setup/storage/storage.html#notebook-storage-in-mongodb">MongoDB Storage</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Operation</span></li>
+ <li><a href="/docs/0.9.0/setup/operation/configuration.html">Configuration</a></li>
+ <li><a href="/docs/0.9.0/setup/operation/proxy_setting.html">Proxy Setting</a></li>
+ <li><a href="/docs/0.9.0/setup/operation/upgrading.html">Upgrading</a></li>
+ <li><a href="/docs/0.9.0/setup/operation/trouble_shooting.html">Trouble Shooting</a></li>
+ </ul>
+ </li>
+
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Interpreter <b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu">
+ <li class="title"><span>Interpreters</span></li>
+ <li><a href="/docs/0.9.0/usage/interpreter/overview.html">Overview</a></li>
+ <li role="separator" class="divider"></li>
+ <li><a href="/docs/0.9.0/interpreter/spark.html">Spark</a></li>
+ <li><a href="/docs/0.9.0/interpreter/jdbc.html">JDBC</a></li>
+ <li><a href="/docs/0.9.0/interpreter/python.html">Python</a></li>
+ <li><a href="/docs/0.9.0/interpreter/r.html">R</a></li>
+ <li role="separator" class="divider"></li>
+ <li><a href="/docs/0.9.0/interpreter/alluxio.html">Alluxio</a></li>
+ <li><a href="/docs/0.9.0/interpreter/beam.html">Beam</a></li>
+ <li><a href="/docs/0.9.0/interpreter/bigquery.html">BigQuery</a></li>
+ <li><a href="/docs/0.9.0/interpreter/cassandra.html">Cassandra</a></li>
+ <li><a href="/docs/0.9.0/interpreter/elasticsearch.html">Elasticsearch</a></li>
+ <li><a href="/docs/0.9.0/interpreter/flink.html">Flink</a></li>
+ <li><a href="/docs/0.9.0/interpreter/geode.html">Geode</a></li>
+ <li><a href="/docs/0.9.0/interpreter/groovy.html">Groovy</a></li>
+ <li><a href="/docs/0.9.0/interpreter/hazelcastjet.html">Hazelcast Jet</a></li>
+ <li><a href="/docs/0.9.0/interpreter/hbase.html">HBase</a></li>
+ <li><a href="/docs/0.9.0/interpreter/hdfs.html">HDFS</a></li>
+ <li><a href="/docs/0.9.0/interpreter/hive.html">Hive</a></li>
+ <li><a href="/docs/0.9.0/interpreter/ignite.html">Ignite</a></li>
+ <li><a href="/docs/0.9.0/interpreter/influxdb.html">influxDB</a></li>
+ <li><a href="/docs/0.9.0/interpreter/java.html">Java</a></li>
+ <li><a href="/docs/0.9.0/interpreter/jupyter.html">Jupyter</a></li>
+ <li><a href="/docs/0.9.0/interpreter/kotlin.html">Kotlin</a></li>
+ <li><a href="/docs/0.9.0/interpreter/ksql.html">KSQL</a></li>
+ <li><a href="/docs/0.9.0/interpreter/kylin.html">Kylin</a></li>
+ <li><a href="/docs/0.9.0/interpreter/lens.html">Lens</a></li>
+ <li><a href="/docs/0.9.0/interpreter/livy.html">Livy</a></li>
+ <li><a href="/docs/0.9.0/interpreter/mahout.html">Mahout</a></li>
+ <li><a href="/docs/0.9.0/interpreter/markdown.html">Markdown</a></li>
+ <li><a href="/docs/0.9.0/interpreter/mongodb.html">MongoDB</a></li>
+ <li><a href="/docs/0.9.0/interpreter/neo4j.html">Neo4j</a></li>
+ <li><a href="/docs/0.9.0/interpreter/pig.html">Pig</a></li>
+ <li><a href="/docs/0.9.0/interpreter/postgresql.html">Postgresql, HAWQ</a></li>
+ <li><a href="/docs/0.9.0/interpreter/sap.html">SAP</a></li>
+ <li><a href="/docs/0.9.0/interpreter/scalding.html">Scalding</a></li>
+ <li><a href="/docs/0.9.0/interpreter/scio.html">Scio</a></li>
+ <li><a href="/docs/0.9.0/interpreter/shell.html">Shell</a></li>
+ <li><a href="/docs/0.9.0/interpreter/sparql.html">Sparql</a></li>
+ <li><a href="/docs/0.9.0/interpreter/submarine.html">Submarine</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">More<b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu" style="right: 0; left: auto;">
+ <li class="title"><span>Extending Zeppelin</span></li>
+ <li><a href="/docs/0.9.0/development/writing_zeppelin_interpreter.html">Writing Zeppelin Interpreter</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Helium (Experimental)</span></li>
+ <li><a href="/docs/0.9.0/development/helium/overview.html">Overview</a></li>
+ <li><a href="/docs/0.9.0/development/helium/writing_application.html">Writing Helium Application</a></li>
+ <li><a href="/docs/0.9.0/development/helium/writing_spell.html">Writing Helium Spell</a></li>
+ <li><a href="/docs/0.9.0/development/helium/writing_visualization_basic.html">Writing Helium Visualization: Basics</a></li>
+ <li><a href="/docs/0.9.0/development/helium/writing_visualization_transformation.html">Writing Helium Visualization: Transformation</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Contributing to Zeppelin</span></li>
+ <li><a href="/docs/0.9.0/setup/basics/how_to_build.html">How to Build Zeppelin</a></li>
+ <li><a href="/docs/0.9.0/development/contribution/useful_developer_tools.html">Useful Developer Tools</a></li>
+ <li><a href="/docs/0.9.0/development/contribution/how_to_contribute_code.html">How to Contribute (code)</a></li>
+ <li><a href="/docs/0.9.0/development/contribution/how_to_contribute_website.html">How to Contribute (website)</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>External Resources</span></li>
+ <li><a target="_blank" href="https://zeppelin.apache.org/community.html">Mailing List</a></li>
+ <li><a target="_blank" href="https://cwiki.apache.org/confluence/display/ZEPPELIN/Zeppelin+Home">Apache Zeppelin Wiki</a></li>
+ <li><a target="_blank" href="http://stackoverflow.com/questions/tagged/apache-zeppelin">Stackoverflow Questions about Zeppelin</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="/docs/0.9.0/search.html" class="nav-search-link">
+ <span class="fa fa-search nav-search-icon"></span>
+ </a>
+ </li>
+ </ul>
+ </nav><!--/.navbar-collapse -->
+ </div>
+ </div>
+
+
+
+ <div class="content">
+
+<!--<div class="hero-unit Apache Zeppelin SDK - Session API">
+ <h1></h1>
+</div>
+-->
+
+<div class="row">
+ <div class="col-md-12">
+ <!--
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+<h1>Apache Zeppelin SDK - Session API</h1>
+
+<div id="toc"></div>
+
+<h2>Overview</h2>
+
+<p>Session api is a high level api for zeppelin. There's no zeppelin concept (note, paragraph) in this api. The most important thing is a ZSession which represent a running interpreter process.
+It is pretty to create a ZSession and its api is very straightforward, we can see a concret examples below.</p>
+
+<h2>How to use ZSession</h2>
+
+<p>It is very easy to create a ZSession, you need to provide ClientConfig, interpreter and also you can customize your ZSession by specificy its interpreter properties.</p>
+
+<p>After you can create ZSession, you need to start it before running any code.
+ZSession's lifecycle is under your control, you need to call stop method expclitly, otherwise the interpreter processs will keep running.</p>
+
+<div class="highlight"><pre><code class="java"><span class="n">ZSession</span> <span class="n">session</span> <span class="o">=</span> <span class="kc">null</span><span class="o">;</span>
+<span class="k">try</span> <span class="o">{</span>
+ <span class="n">ClientConfig</span> <span class="n">clientConfig</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ClientConfig</span><span class="o">(</span><span class="s">"http://localhost:8080"</span><span class="o">);</span>
+ <span class="n">Map</span><span class="o"><</span><span class="n">String</span><span class="o">,</span> <span class="n">String</span><span class="o">></span> <span class="n">intpProperties</span> <span class="o">=</span> <span class="k">new</span> <span class="n">HashMap</span><span class="o"><>();</span>
+ <span class="n">intpProperties</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="s">"spark.master"</span><span class="o">,</span> <span class="s">"local[*]"</span><span class="o">);</span>
+
+ <span class="n">session</span> <span class="o">=</span> <span class="n">ZSession</span><span class="o">.</span><span class="na">builder</span><span class="o">()</span>
+ <span class="o">.</span><span class="na">setClientConfig</span><span class="o">(</span><span class="n">clientConfig</span><span class="o">)</span>
+ <span class="o">.</span><span class="na">setInterpreter</span><span class="o">(</span><span class="s">"spark"</span><span class="o">)</span>
+ <span class="o">.</span><span class="na">setIntpProperties</span><span class="o">(</span><span class="n">intpProperties</span><span class="o">)</span>
+ <span class="o">.</span><span class="na">build</span><span class="o">();</span>
+
+ <span class="n">session</span><span class="o">.</span><span class="na">start</span><span class="o">();</span>
+ <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Spark Web UI: "</span> <span class="o">+</span> <span class="n">session</span><span class="o">.</span><span class="na">getWeburl</span><span class="o">());</span>
+
+ <span class="c1">// scala (single result)</span>
+ <span class="n">ExecuteResult</span> <span class="n">result</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="na">execute</span><span class="o">(</span><span class="s">"println(sc.version)"</span><span class="o">);</span>
+ <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Spark Version: "</span> <span class="o">+</span> <span class="n">result</span><span class="o">.</span><span class="na">getResults</span><span class="o">().</span><span class="na">get</span><span class="o">(</span><span class="mi">0</span><span class="o">).</span><span class="na">getData</span><span class="o">());</span>
+
+ <span class="c1">// scala (multiple result)</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="na">execute</span><span class="o">(</span><span class="s">"println(sc.version)\n"</span> <span class="o">+</span>
+ <span class="s">"val df = spark.createDataFrame(Seq((1,\"a\"), (2,\"b\")))\n"</span> <span class="o">+</span>
+ <span class="s">"z.show(df)"</span><span class="o">);</span>
+
+ <span class="c1">// The first result is text output</span>
+ <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Result 1: type: "</span> <span class="o">+</span> <span class="n">result</span><span class="o">.</span><span class="na">getResults</span><span class="o">().</span><span class="na">get</span><span class="o">(</span><span class="mi">0</span><span class="o">).</span><span class="na">getType</span><span class="o">()</span> <span class="o">+</span>
+ <span class="s">", data: "</span> <span class="o">+</span> <span class="n">result</span><span class="o">.</span><span class="na">getResults</span><span class="o">().</span><span class="na">get</span><span class="o">(</span><span class="mi">0</span><span class="o">).</span><span class="na">getData</span><span class="o">()</span> <span class="o">);</span>
+ <span class="c1">// The second result is table output</span>
+ <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Result 2: type: "</span> <span class="o">+</span> <span class="n">result</span><span class="o">.</span><span class="na">getResults</span><span class="o">().</span><span class="na">get</span><span class="o">(</span><span class="mi">1</span><span class="o">).</span><span class="na">getType</span><span class="o">()</span> <span class="o">+</span>
+ <span class="s">", data: "</span> <span class="o">+</span> <span class="n">result</span><span class="o">.</span><span class="na">getResults</span><span class="o">().</span><span class="na">get</span><span class="o">(</span><span class="mi">1</span><span class="o">).</span><span class="na">getData</span><span class="o">()</span> <span class="o">);</span>
+ <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Spark Job Urls:\n"</span> <span class="o">+</span> <span class="n">StringUtils</span><span class="o">.</span><span class="na">join</span><span class="o">(</span><span class="n">result</span><span class="o">.</span><span class="na">getJobUrls</span><span class="o">(),</span> <span class="s">"\n"</span><span class="o">));</span>
+
+ <span class="c1">// error output</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="na">execute</span><span class="o">(</span><span class="s">"1/0"</span><span class="o">);</span>
+ <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Result status: "</span> <span class="o">+</span> <span class="n">result</span><span class="o">.</span><span class="na">getStatus</span><span class="o">()</span> <span class="o">+</span>
+ <span class="s">", data: "</span> <span class="o">+</span> <span class="n">result</span><span class="o">.</span><span class="na">getResults</span><span class="o">().</span><span class="na">get</span><span class="o">(</span><span class="mi">0</span><span class="o">).</span><span class="na">getData</span><span class="o">());</span>
+
+ <span class="c1">// pyspark</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="na">execute</span><span class="o">(</span><span class="s">"pyspark"</span><span class="o">,</span> <span class="s">"df = spark.createDataFrame([(1,'a'),(2,'b')])\n"</span> <span class="o">+</span>
+ <span class="s">"df.registerTempTable('df')\n"</span> <span class="o">+</span>
+ <span class="s">"df.show()"</span><span class="o">);</span>
+ <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"PySpark dataframe: "</span> <span class="o">+</span> <span class="n">result</span><span class="o">.</span><span class="na">getResults</span><span class="o">().</span><span class="na">get</span><span class="o">(</span><span class="mi">0</span><span class="o">).</span><span class="na">getData</span><span class="o">());</span>
+
+ <span class="c1">// matplotlib</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="na">execute</span><span class="o">(</span><span class="s">"ipyspark"</span><span class="o">,</span> <span class="s">"%matplotlib inline\n"</span> <span class="o">+</span>
+ <span class="s">"import matplotlib.pyplot as plt\n"</span> <span class="o">+</span>
+ <span class="s">"plt.plot([1,2,3,4])\n"</span> <span class="o">+</span>
+ <span class="s">"plt.ylabel('some numbers')\n"</span> <span class="o">+</span>
+ <span class="s">"plt.show()"</span><span class="o">);</span>
+ <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Matplotlib result, type: "</span> <span class="o">+</span> <span class="n">result</span><span class="o">.</span><span class="na">getResults</span><span class="o">().</span><span class="na">get</span><span class="o">(</span><span class="mi">0</span><span class="o">).</span><span class="na">getType</span><span class="o">()</span> <span class="o">+</span>
+ <span class="s">", data: "</span> <span class="o">+</span> <span class="n">result</span><span class="o">.</span><span class="na">getResults</span><span class="o">().</span><span class="na">get</span><span class="o">(</span><span class="mi">0</span><span class="o">).</span><span class="na">getData</span><span class="o">());</span>
+
+ <span class="c1">// sparkr</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="na">execute</span><span class="o">(</span><span class="s">"r"</span><span class="o">,</span> <span class="s">"df <- as.DataFrame(faithful)\nhead(df)"</span><span class="o">);</span>
+ <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Sparkr dataframe: "</span> <span class="o">+</span> <span class="n">result</span><span class="o">.</span><span class="na">getResults</span><span class="o">().</span><span class="na">get</span><span class="o">(</span><span class="mi">0</span><span class="o">).</span><span class="na">getData</span><span class="o">());</span>
+
+ <span class="c1">// spark sql</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="na">execute</span><span class="o">(</span><span class="s">"sql"</span><span class="o">,</span> <span class="s">"select * from df"</span><span class="o">);</span>
+ <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Spark Sql dataframe: "</span> <span class="o">+</span> <span class="n">result</span><span class="o">.</span><span class="na">getResults</span><span class="o">().</span><span class="na">get</span><span class="o">(</span><span class="mi">0</span><span class="o">).</span><span class="na">getData</span><span class="o">());</span>
+
+ <span class="c1">// spark invalid sql</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="na">execute</span><span class="o">(</span><span class="s">"sql"</span><span class="o">,</span> <span class="s">"select * from unknown_table"</span><span class="o">);</span>
+ <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Result status: "</span> <span class="o">+</span> <span class="n">result</span><span class="o">.</span><span class="na">getStatus</span><span class="o">()</span> <span class="o">+</span>
+ <span class="s">", data: "</span> <span class="o">+</span> <span class="n">result</span><span class="o">.</span><span class="na">getResults</span><span class="o">().</span><span class="na">get</span><span class="o">(</span><span class="mi">0</span><span class="o">).</span><span class="na">getData</span><span class="o">());</span>
+<span class="o">}</span> <span class="k">catch</span> <span class="o">(</span><span class="n">Exception</span> <span class="n">e</span><span class="o">)</span> <span class="o">{</span>
+ <span class="n">e</span><span class="o">.</span><span class="na">printStackTrace</span><span class="o">();</span>
+<span class="o">}</span> <span class="k">finally</span> <span class="o">{</span>
+ <span class="k">if</span> <span class="o">(</span><span class="n">session</span> <span class="o">!=</span> <span class="kc">null</span><span class="o">)</span> <span class="o">{</span>
+ <span class="k">try</span> <span class="o">{</span>
+ <span class="n">session</span><span class="o">.</span><span class="na">stop</span><span class="o">();</span>
+ <span class="o">}</span> <span class="k">catch</span> <span class="o">(</span><span class="n">Exception</span> <span class="n">e</span><span class="o">)</span> <span class="o">{</span>
+ <span class="n">e</span><span class="o">.</span><span class="na">printStackTrace</span><span class="o">();</span>
+ <span class="o">}</span>
+ <span class="o">}</span>
+<span class="o">}</span>
+</code></pre></div>
+
+<p>Here's a list of apis of <code>ZSession</code>.</p>
+
+<div class="highlight"><pre><code class="java"><span class="kd">public</span> <span class="kt">void</span> <span class="nf">start</span><span class="o">()</span> <span class="kd">throws</span> <span class="n">Exception</span>
+
+<span class="kd">public</span> <span class="kt">void</span> <span class="nf">start</span><span class="o">(</span><span class="n">MessageHandler</span> <span class="n">messageHandler</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span>
+
+<span class="kd">public</span> <span class="kt">void</span> <span class="nf">stop</span><span class="o">()</span> <span class="kd">throws</span> <span class="n">Exception</span>
+
+<span class="kd">public</span> <span class="n">ExecuteResult</span> <span class="nf">execute</span><span class="o">(</span><span class="n">String</span> <span class="n">code</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span>
+
+<span class="kd">public</span> <span class="n">ExecuteResult</span> <span class="nf">execute</span><span class="o">(</span><span class="n">String</span> <span class="n">subInterpreter</span><span class="o">,</span>
+ <span class="n">Map</span><span class="o"><</span><span class="n">String</span><span class="o">,</span> <span class="n">String</span><span class="o">></span> <span class="n">localProperties</span><span class="o">,</span>
+ <span class="n">String</span> <span class="n">code</span><span class="o">,</span>
+ <span class="n">StatementMessageHandler</span> <span class="n">messageHandler</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span>
+
+<span class="kd">public</span> <span class="n">ExecuteResult</span> <span class="nf">submit</span><span class="o">(</span><span class="n">String</span> <span class="n">code</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span>
+
+<span class="kd">public</span> <span class="n">ExecuteResult</span> <span class="nf">submit</span><span class="o">(</span><span class="n">String</span> <span class="n">subInterpreter</span><span class="o">,</span>
+ <span class="n">Map</span><span class="o"><</span><span class="n">String</span><span class="o">,</span> <span class="n">String</span><span class="o">></span> <span class="n">localProperties</span><span class="o">,</span>
+ <span class="n">String</span> <span class="n">code</span><span class="o">,</span>
+ <span class="n">StatementMessageHandler</span> <span class="n">messageHandler</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span>
+
+<span class="kd">public</span> <span class="kt">void</span> <span class="nf">cancel</span><span class="o">(</span><span class="n">String</span> <span class="n">statementId</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span>
+
+<span class="kd">public</span> <span class="n">ExecuteResult</span> <span class="nf">queryStatement</span><span class="o">(</span><span class="n">String</span> <span class="n">statementId</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span>
+
+<span class="kd">public</span> <span class="n">ExecuteResult</span> <span class="nf">waitUntilFinished</span><span class="o">(</span><span class="n">String</span> <span class="n">statementId</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span>
+</code></pre></div>
+
+<h2>Examples</h2>
+
+<p>For more detailed usage of session api, you can check the examples in module <code>zeppelin-client-examples</code></p>
+
+<ul>
+<li><a href="https://github.com/apache/zeppelin/blob/master/zeppelin-client-examples/src/main/java/org/apache/zeppelin/client/examples/SparkExample.java">SparkExample</a></li>
+<li><a href="https://github.com/apache/zeppelin/blob/master/zeppelin-client-examples/src/main/java/org/apache/zeppelin/client/examples/SparkAdvancedExample.java">SparkAdvancedExample</a></li>
+<li><a href="https://github.com/apache/zeppelin/blob/master/zeppelin-client-examples/src/main/java/org/apache/zeppelin/client/examples/FlinkExample.java">FlinkExample</a></li>
+<li><a href="https://github.com/apache/zeppelin/blob/master/zeppelin-client-examples/src/main/java/org/apache/zeppelin/client/examples/FlinkAdvancedExample.java">FlinkAdvancedExample</a></li>
+<li><a href="https://github.com/apache/zeppelin/blob/master/zeppelin-client-examples/src/main/java/org/apache/zeppelin/client/examples/FlinkAdvancedExample2.java">FlinkAdvancedExample2</a></li>
+<li><a href="https://github.com/apache/zeppelin/blob/master/zeppelin-client-examples/src/main/java/org/apache/zeppelin/client/examples/HiveExample.java">HiveExample</a></li>
+<li><a href="https://github.com/apache/zeppelin/blob/master/zeppelin-client-examples/src/main/java/org/apache/zeppelin/client/examples/PythonExample.java">PythonExample</a></li>
+<li><a href="https://github.com/apache/zeppelin/blob/master/zeppelin-client-examples/src/main/java/org/apache/zeppelin/client/examples/RExample.java">RExample</a></li>
+</ul>
+
+ </div>
+</div>
+
+
+ <hr>
+ <footer>
+ <!-- <p>© 2021 The Apache Software Foundation</p>-->
+ </footer>
+ </div>
+
+
+
+
+ <script type="text/javascript">
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-45176241-5', 'zeppelin.apache.org');
+ ga('require', 'linkid', 'linkid.js');
+ ga('send', 'pageview');
+
+</script>
+
+
+
+ </body>
+</html>
+