| |
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <title>Apache Zeppelin 0.9.0 Documentation: Elasticsearch Interpreter for Apache Zeppelin</title> |
| <meta name="description" content="Elasticsearch is a highly scalable open-source full-text search and analytics engine."> |
| <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="/docs/0.9.0/assets/themes/zeppelin/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="/docs/0.9.0/assets/themes/zeppelin/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"> |
| |
| <!-- Matomo --> |
| <script> |
| var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| _paq.push(["setDoNotTrack", true]); |
| _paq.push(["disableCookies"]); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '69']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script> |
| <!-- End Matomo Code --> |
| </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 Elasticsearch Interpreter for Apache Zeppelin"> |
| <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>Elasticsearch Interpreter for Apache Zeppelin</h1> |
| |
| <div id="toc"></div> |
| |
| <h2>Overview</h2> |
| |
| <p><a href="https://www.elastic.co/products/elasticsearch">Elasticsearch</a> 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.</p> |
| |
| <h2>Configuration</h2> |
| |
| <table class="table-configuration"> |
| <tr> |
| <th>Property</th> |
| <th>Default</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>elasticsearch.cluster.name</td> |
| <td>elasticsearch</td> |
| <td>Cluster name</td> |
| </tr> |
| <tr> |
| <td>elasticsearch.host</td> |
| <td>localhost</td> |
| <td>Host of a node in the cluster</td> |
| </tr> |
| <tr> |
| <td>elasticsearch.port</td> |
| <td>9300</td> |
| <td>Connection port <b>( Important: it depends on the client type, transport or http)</b></td> |
| </tr> |
| <tr> |
| <td>elasticsearch.client.type</td> |
| <td>transport</td> |
| <td>The type of client for Elasticsearch (transport or http)<b>( Important: the port depends on this value)</b></td> |
| </tr> |
| <tr> |
| <td>elasticsearch.basicauth.username</td> |
| <td></td> |
| <td>Username for a basic authentication (http)</b></td> |
| </tr> |
| <tr> |
| <td>elasticsearch.basicauth.password</td> |
| <td></td> |
| <td>Password for a basic authentication (http)</b></td> |
| </tr> |
| <tr> |
| <td>elasticsearch.result.size</td> |
| <td>10</td> |
| <td>The size of the result set of a search query</td> |
| </tr> |
| </table> |
| |
| <p><center> |
| <img src="/docs/0.9.0/assets/themes/zeppelin/img/docs-img/elasticsearch-config.png" alt="Interpreter configuration"> |
| </center></p> |
| |
| <blockquote> |
| <p><strong>Note #1 :</strong> You can add more properties to configure the Elasticsearch client.</p> |
| |
| <p><strong>Note #2 :</strong> If you use Shield, you can add a property named <code>shield.user</code> with a value containing the name and the password ( format: <code>username:password</code> ). For more details about Shield configuration, consult the <a href="https://www.elastic.co/guide/en/shield/current/_using_elasticsearch_java_clients_with_shield.html">Shield reference guide</a>. Do not forget, to copy the shield client jar in the interpreter directory (<code>ZEPPELIN_HOME/interpreters/elasticsearch</code>).</p> |
| </blockquote> |
| |
| <h2>Enabling the Elasticsearch Interpreter</h2> |
| |
| <p>In a notebook, to enable the <strong>Elasticsearch</strong> interpreter, click the <strong>Gear</strong> icon and select <strong>Elasticsearch</strong>.</p> |
| |
| <h2>Using the Elasticsearch Interpreter</h2> |
| |
| <p>In a paragraph, use <code>%elasticsearch</code> to select the Elasticsearch interpreter and then input all commands. |
| To get the list of available commands, use <code>help</code>.</p> |
| <div class="highlight"><pre><code class="bash language-bash" data-lang="bash">%elasticsearch |
| <span class="nb">help</span> |
| |
| Elasticsearch interpreter: |
| General format: <<span class="nb">command</span>> /<indices>/<types>/<id> <option> <JSON> |
| - indices: list of indices separated by commas <span class="o">(</span>depends on the <span class="nb">command</span><span class="o">)</span> |
| - types: list of document types separated by commas <span class="o">(</span>depends on the <span class="nb">command</span><span class="o">)</span> |
| Commands: |
| - search /indices/types <query> |
| . indices and types can be omitted <span class="o">(</span>at least, you have to provide <span class="s1">'/'</span><span class="o">)</span> |
| . a query is either a JSON-formatted query, nor a lucene query |
| - size <value> |
| . defines the size of the result <span class="nb">set</span> <span class="o">(</span>default value is in the config<span class="o">)</span> |
| . <span class="k">if </span>used, this <span class="nb">command </span>must be declared before a search <span class="nb">command</span> |
| - count /indices/types <query> |
| . same comments as <span class="k">for </span>the search |
| - get /index/type/id |
| - delete /index/type/id |
| - index /index/type/id <json-formatted document> |
| . the id can be omitted, elasticsearch will generate one |
| </code></pre></div> |
| <blockquote> |
| <p><strong>Tip :</strong> Use ( Ctrl + . ) for autocompletion.</p> |
| </blockquote> |
| |
| <h3>Get</h3> |
| |
| <p>With the <code>get</code> command, you can find a document by id. The result is a JSON document.</p> |
| <div class="highlight"><pre><code class="bash language-bash" data-lang="bash">%elasticsearch |
| get /index/type/id |
| </code></pre></div> |
| <p>Example: |
| <img src="/docs/0.9.0/assets/themes/zeppelin/img/docs-img/elasticsearch-get.png" alt="Elasticsearch - Get"></p> |
| |
| <h3>Search</h3> |
| |
| <p>With the <code>search</code> command, you can send a search query to Elasticsearch. There are two formats of query:</p> |
| |
| <ul> |
| <li>You can provide a JSON-formatted query, that is exactly what you provide when you use the REST API of Elasticsearch.<br> |
| |
| <ul> |
| <li>See <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/search.html">Elasticsearch search API reference document</a> for more details about the content of the search queries.</li> |
| </ul></li> |
| <li>You can also provide the content of a <code>query_string</code>. |
| |
| <ul> |
| <li>This is a shortcut to a query like that: <code>{ "query": { "query_string": { "query": "__HERE YOUR QUERY__", "analyze_wildcard": true } } }</code></li> |
| <li>See <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax">Elasticsearch query string syntax</a> for more details about the content of such a query.</li> |
| </ul></li> |
| </ul> |
| <div class="highlight"><pre><code class="bash language-bash" data-lang="bash">%elasticsearch |
| search /index1,index2,.../type1,type2,... <JSON document containing the query or query_string elements> |
| </code></pre></div> |
| <p>If you want to modify the size of the result set, you can add a line that is setting the size, before your search command.</p> |
| <div class="highlight"><pre><code class="bash language-bash" data-lang="bash">%elasticsearch |
| size 50 |
| search /index1,index2,.../type1,type2,... <JSON document containing the query or query_string elements> |
| </code></pre></div> |
| <blockquote> |
| <p>A search query can also contain <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html">aggregations</a>. |
| If there is at least one aggregation, the result of the first aggregation is shown, otherwise, you get the search hits.</p> |
| </blockquote> |
| |
| <p>Examples:</p> |
| |
| <ul> |
| <li><p>With a JSON query:</p> |
| <div class="highlight"><pre><code class="bash language-bash" data-lang="bash">%elasticsearch |
| search / <span class="o">{</span> <span class="s2">"query"</span>: <span class="o">{</span> <span class="s2">"match_all"</span>: <span class="o">{</span> <span class="o">}</span> <span class="o">}</span> <span class="o">}</span> |
| |
| %elasticsearch |
| search /logs <span class="o">{</span> <span class="s2">"query"</span>: <span class="o">{</span> <span class="s2">"query_string"</span>: <span class="o">{</span> <span class="s2">"query"</span>: <span class="s2">"request.method:GET AND status:200"</span> <span class="o">}</span> <span class="o">}</span> <span class="o">}</span> |
| |
| %elasticsearch |
| search /logs <span class="o">{</span> <span class="s2">"aggs"</span>: <span class="o">{</span> |
| <span class="s2">"content_length_stats"</span>: <span class="o">{</span> |
| <span class="s2">"extended_stats"</span>: <span class="o">{</span> |
| <span class="s2">"field"</span>: <span class="s2">"content_length"</span> |
| <span class="o">}</span> |
| <span class="o">}</span> |
| <span class="o">}</span> <span class="o">}</span> |
| </code></pre></div></li> |
| <li><p>With query_string elements:</p> |
| <div class="highlight"><pre><code class="bash language-bash" data-lang="bash">%elasticsearch |
| search /logs request.method:GET AND status:200 |
| |
| %elasticsearch |
| search /logs <span class="o">(</span>404 AND <span class="o">(</span>POST OR DELETE<span class="o">))</span> |
| </code></pre></div></li> |
| </ul> |
| |
| <blockquote> |
| <p><strong>Important</strong> : a document in Elasticsearch is a JSON document, so it is hierarchical, not flat as a row in a SQL table. |
| For the Elastic interpreter, the result of a search query is flattened.</p> |
| </blockquote> |
| |
| <p>Suppose we have a JSON document:</p> |
| <div class="highlight"><pre><code class="text language-text" data-lang="text">{ |
| "date": "2015-12-08T21:03:13.588Z", |
| "request": { |
| "method": "GET", |
| "url": "/zeppelin/4cd001cd-c517-4fa9-b8e5-a06b8f4056c4", |
| "headers": [ "Accept: *.*", "Host: apache.org"] |
| }, |
| "status": "403", |
| "content_length": 1234 |
| } |
| </code></pre></div> |
| <p>The data will be flattened like this:</p> |
| |
| <table><thead> |
| <tr> |
| <th>content_length</th> |
| <th>date</th> |
| <th>request.headers[0]</th> |
| <th>request.headers[1]</th> |
| <th>request.method</th> |
| <th>request.url</th> |
| <th>status</th> |
| </tr> |
| </thead><tbody> |
| <tr> |
| <td>1234</td> |
| <td>2015-12-08T21:03:13.588Z</td> |
| <td>Accept: *.*</td> |
| <td>Host: apache.org</td> |
| <td>GET</td> |
| <td>/zeppelin/4cd001cd-c517-4fa9-b8e5-a06b8f4056c4</td> |
| <td>403</td> |
| </tr> |
| </tbody></table> |
| |
| <p>Examples:</p> |
| |
| <ul> |
| <li><p>With a table containing the results: |
| <img src="/docs/0.9.0/assets/themes/zeppelin/img/docs-img/elasticsearch-search-table.png" alt="Elasticsearch - Search - table"></p></li> |
| <li><p>You can also use a predefined diagram: |
| <img src="/docs/0.9.0/assets/themes/zeppelin/img/docs-img/elasticsearch-search-pie.png" alt="Elasticsearch - Search - diagram"></p></li> |
| <li><p>With a JSON query: |
| <img src="/docs/0.9.0/assets/themes/zeppelin/img/docs-img/elasticsearch-search-json-query-table.png" alt="Elasticsearch - Search with query"></p></li> |
| <li><p>With a JSON query containing a <code>fields</code> parameter (for filtering the fields in the response): in this case, all the fields values in the response are arrays, so, after flattening the result, the format of all the field names is <code>field_name[x]</code> |
| <img src="/docs/0.9.0/assets/themes/zeppelin/img/docs-img/elasticsearch-query-with-fields-param.png" alt="Elasticsearch - Search with query and a fields param"></p></li> |
| <li><p>With a query string: |
| <img src="/docs/0.9.0/assets/themes/zeppelin/img/docs-img/elasticsearch-query-string.png" alt="Elasticsearch - Search with query string"></p></li> |
| <li><p>With a query containing a multi-value metric aggregation: |
| <img src="/docs/0.9.0/assets/themes/zeppelin/img/docs-img/elasticsearch-agg-multi-value-metric.png" alt="Elasticsearch - Search with aggregation (multi-value metric)"></p></li> |
| <li><p>With a query containing a multi-bucket aggregation: |
| <img src="/docs/0.9.0/assets/themes/zeppelin/img/docs-img/elasticsearch-agg-multi-bucket-pie.png" alt="Elasticsearch - Search with aggregation (multi-bucket)"></p></li> |
| </ul> |
| |
| <h3>Count</h3> |
| |
| <p>With the <code>count</code> command, you can count documents available in some indices and types. You can also provide a query.</p> |
| <div class="highlight"><pre><code class="bash language-bash" data-lang="bash">%elasticsearch |
| count /index1,index2,.../type1,type2,... <JSON document containing the query OR a query string> |
| </code></pre></div> |
| <p>Examples:</p> |
| |
| <ul> |
| <li><p>Without query: |
| <img src="/docs/0.9.0/assets/themes/zeppelin/img/docs-img/elasticsearch-count.png" alt="Elasticsearch - Count"></p></li> |
| <li><p>With a query: |
| <img src="/docs/0.9.0/assets/themes/zeppelin/img/docs-img/elasticsearch-count-with-query.png" alt="Elasticsearch - Count with query"></p></li> |
| </ul> |
| |
| <h3>Index</h3> |
| |
| <p>With the <code>index</code> command, you can insert/update a document in Elasticsearch.</p> |
| <div class="highlight"><pre><code class="bash language-bash" data-lang="bash">%elasticsearch |
| index /index/type/id <JSON document> |
| |
| %elasticsearch |
| index /index/type <JSON document> |
| </code></pre></div> |
| <h3>Delete</h3> |
| |
| <p>With the <code>delete</code> command, you can delete a document.</p> |
| <div class="highlight"><pre><code class="bash language-bash" data-lang="bash">%elasticsearch |
| delete /index/type/id |
| </code></pre></div> |
| <h3>Apply Zeppelin Dynamic Forms</h3> |
| |
| <p>You can leverage <a href="../usage/dynamic_form/intro.html">Zeppelin Dynamic Form</a> inside your queries. You can use both the <code>text input</code> and <code>select form</code> parameterization features.</p> |
| <div class="highlight"><pre><code class="bash language-bash" data-lang="bash">%elasticsearch |
| size <span class="k">${</span><span class="nv">limit</span><span class="p">=10</span><span class="k">}</span> |
| search /index/type <span class="o">{</span> <span class="s2">"query"</span>: <span class="o">{</span> <span class="s2">"match_all"</span>: <span class="o">{</span> <span class="o">}</span> <span class="o">}</span> <span class="o">}</span> |
| </code></pre></div> |
| </div> |
| </div> |
| |
| |
| <hr> |
| <footer> |
| <!-- <p>© 2021 The Apache Software Foundation</p>--> |
| </footer> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
| |
