zjffdu commented on a change in pull request #3612: add MongoDB interpreter URL: https://github.com/apache/zeppelin/pull/3612#discussion_r368997700
########## File path: docs/interpreter/mongodb.md ########## @@ -0,0 +1,92 @@ +--- +layout: page +title: "MongoDB Interpreter for Apache Zeppelin" +description: "MongoDB is a general purpose, document-based, distributed database built for modern application developers and for the cloud era." +group: interpreter +--- +<!-- +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. +--> +{% include JB/setup %} + +# MongoDB interpreter for Apache Zeppelin + +<div id="toc"></div> + +## Overview +[MongoDB](https://www.mongodb.com/) is a general purpose, document-based, distributed database built for modern application developers and for the cloud era. +This interpreter use mongo shell to execute [scripts](https://docs.mongodb.com/manual/tutorial/write-scripts-for-the-mongo-shell/) +Use mongo-shell `JavaScript` to analyze data as you need +## Installing AND Configuration +First, you need to install mongo shell with Zeppelin in the same machine. +Second, create mongodb interpreter in Zeppelin. + +<table class="table-configuration"> + <tr> + <th>Name</th> + <th>Default Value</th> + <th>Description</th> + </tr> + <tr> + <td>mongo.shell.path</td> + <td>mongo</td> + <td>MongoDB shell local path. <br/> Use `which mongo` to get local path in linux or mac.</td> + </tr> + <tr> + <td>mongo.shell.command.table.limit</td> + <td>1000</td> + <td>Limit of documents displayed in a table. <br/> Use table function when get data from mongodb</td> + </tr> + <tr> + <td>mongo.shell.command.timeout</td> + <td>60000</td> + <td>MongoDB shell command timeout in millisecond</td> + </tr> + <tr> + <td>mongo.server.host</td> + <td>localhost</td> + <td>MongoDB server host to connect to</td> + </tr> + <tr> + <td>mongo.server.port</td> + <td>27017</td> + <td>MongoDB server port to connect to</td> + </tr> + <tr> + <td>mongo.server.database</td> + <td>test</td> + <td>MongoDB database name</td> + </tr> + <tr> + <td>mongo.server.authentdatabase</td> + <td></td> + <td>MongoDB database name for authentication</td> + </tr> + <tr> + <td>mongo.server.username</td> + <td></td> + <td>Username for authentication</td> + </tr> + <tr> + <td>mongo.server.password</td> + <td></td> + <td>Password for authentication</td> + </tr> +</table> +## Examples +In a notebook, to enable the **mongodb** interpreter, click the **Gear** icon and select **mongodb**. Review comment: This line could be deleted, it is not necessary to do it in the latest zeppelin ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
