# mongo4idea

**Repository Path**: sun_grad/mongo4idea

## Basic Information

- **Project Name**: mongo4idea
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-06-16
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Mongo Plugin for IntelliJ IDEA version 0.12.2

* [Jetbrains plugin page](https://plugins.jetbrains.com/idea/plugin/7141)
* [Changelog](https://github.com/dboissier/mongo4idea/blob/master/CHANGELOG.txt)

## Current builds

[![Build Status](https://travis-ci.org/dboissier/mongo4idea.svg?branch=master)](https://travis-ci.org/dboissier/mongo4idea)

* [0.12.2 Build for Idea 2019+](https://github.com/dboissier/mongo4idea/raw/master/snapshot/mongo4idea-0.12.2.zip)

## Description

This plugin integrates MongoDB Servers with database/collections tree, Query Runner and Shell console.

## Plugin Compatibility

This plugin was built for IDEA 2019 and upper versions, requires JRE 1.8 and Mongo 3.

## How to install it?

Download this plugin from your IDE (Mongo Plugin)

## Configuration steps

When you open the Mongo explorer, you will see a panel:

![Browser](https://github.com/dboissier/mongo4idea/raw/master/doc/mongo4idea-explorerWithoutDB.png)

* To use the Mongo shell directly from the plugin, click on the `[wrench]`icon, set its path in the corresponding field. As alternative, you can use the Terminal plugin. 

![PluginConfiguration](https://github.com/dboissier/mongo4idea/raw/master/doc/mongo4idea_pluginConfiguration.png)


* To add a server, click on the `[+]` icon located on the upper toolbar and a dialog will appear

![ServerConfigurationGeneralTab](https://github.com/dboissier/mongo4idea/raw/master/doc/mongo4idea_serverConfigurationGeneralTab.png)

* Set a label for your server, this will be more convenient to distinguish each of them in the Mongo explorer
* Set the server info as the example in the above screenshot
* If your access is restricted to a specific database, just set it in the **User Database** field

* If your server requires authentication, click on the **Authentication** tab and then enter your credentials

![ServerConfigurationAuthenticationTab](https://github.com/dboissier/mongo4idea/raw/master/doc/mongo4idea_serverConfigurationAuthenticationTab.png)

* If you need to use a SSH tunnel, click on the SSH tab and then enter the corresponding settings

![ServerConfigurationSSHTab](https://github.com/dboissier/mongo4idea/raw/master/doc/mongo4idea_serverConfigurationSSHTab.png)


When you are done, click on the **Test Connection** button to check the server configuration.

Additionaly, in **Options** tab:

* **[NEW]** you can change the `row limit` default value
* you can hide some collections with **Collections to ignore** field.
* you can set default Mongo shell parameters

## Usage

### Mongo Explorer

![Browser](https://github.com/dboissier/mongo4idea/raw/master/doc/mongo4idea-explorerWithDB.png)

For each server, the tree displays its databases with all of their collections.

* To edit or remove the server, right-click and select the appropriate action from the server node.
* To view the content of your server, just double-click on it.
* To view the content of a collection, double-click on it (or type `F4`) and the results will be displayed in an editor tab, alongside your open files.
If you double-click on another collection, a new tab will be created for it.

If you want clear a collection or database, you can do so by right clicking on it and selecting **Drop collection/database** (shortcut is `DELETE`). Be cautious with this operation, it should not be used in a production environment.


**[NEW]** 
* When selecting a database or a collection, you will see the `stats` in the below panel
* When selecting a collection, you can import JSON file by right-clicking and selecting `Import data` menu item. Select your JSON file and click on `Replace all content` option if needed.
* When selecting a server, you can copy its configuration

### Mongo collection tab view

The panel shows all documents of the collections (max 300 records by default).

![Collection view](https://github.com/dboissier/mongo4idea/raw/master/doc/mongo4idea_collectionResults.png)

You can copy the result and paste it in a text editor.

If you want to see the results in a table view instead, click on the **Table** icon on the right of the toolbar.

![Collection view](https://github.com/dboissier/mongo4idea/raw/master/doc/mongo4idea_tableView.png)

**[NEW]** You can paginate the results by selecting the number of the documents per page below the results. You will be able to navigate with `[<-]``and `[->]` icon

![Collection view](https://github.com/dboissier/mongo4idea/raw/master/doc/mongo4idea_collectionResults_withPagination.png)


#### Querying

If you want to run a *find* query, click on the Magnifying glass icon or use the `CTRL+F` shortcut.

The query panel will appear at the top.

Type your filter, projection or sort query fragment in JSON format (e.g.: `{ 'name': 'foo'}`)

![Simple query view](https://github.com/dboissier/mongo4idea/raw/master/doc/mongo4idea_queryPanel.png)

If you want to run some aggregate queries, type your pipeline as follows:
```js
{'$operator1': {...}},
{'$operator2': {...}}
```

![Aggregate query view](https://github.com/dboissier/mongo4idea/raw/master/doc/mongo4idea-queryAggregate.png)

Typing `CTRL+SPACE` displays a popup that allows you to select a query operator.

Additionally, you can set a row limit.

When you are done, click on the Run button (or type `CTRL+ENTER` shortcut) to see the query results.


## Document editing

Any document can be edited by double-clicking on the **object id** (or by right-clicking and select **Edit document**). A panel will open at the bottom.

![Document edition](https://github.com/dboissier/mongo4idea/raw/master/doc/mongo4idea-documentEdition.png)

You can edit the value either by double-clicking or by typing `F2`.
You can delete a key by right-clicking on it and select **Delete this**
* Click on the **save** button to send the modification to the mongo server
You can add a key or value (depending on the structure of your document) by right-clicking on it and select **Add a Key** (or **Add a Value**). A dialog will appear.

![Document edition](https://github.com/dboissier/mongo4idea/raw/master/doc/mongo4idea-addKeyDialog.png)

Set the key name, type and value and then validate your form.

You can also edit a document from scratch by right-clicking in the result view and select *Add* (or by typing `ALT+INSERT` shortcut)

## Document deletion

Right click on the `ObjectId` of the selected document and select the **Delete** action

## [NEW] DBRef navigation

When your document has a DBRef field, you can view the referenced document by right clicking on it and select **View Reference** action (shortcut is `CTRL+B` or `⌘+B`).
The referenced document will be displayed in the same tab. A **Back** button will appear and allow you to go back to the navigation history.


### Mongo shell integration

If you set the mongo client path (e.g., `/usr/bin/mongo`), you can run the console by selecting a database under your mongo server node and click on the button **Mongo Shell** on the toolbar of the Mongo explorer.

![Browser](https://github.com/dboissier/mongo4idea/raw/master/doc/mongo4idea-shell.png)

### Run a file

If you need to run a JavaScript file on your mongo server, just type `CTRL+SHIFT+F10` (or right-click in your file and select Run `myscript.js file)

![Document edition](https://github.com/dboissier/mongo4idea/raw/master/doc/mongo4idea-runAFile.png)

Select your server and your database then click on the run button.

## How to build

This project is now built with Gradle with [Intellij plugin](https://github.com/JetBrains/gradle-intellij-plugin). At a glance, 

* `gradlew test` to run all unit tests
* `gradlew runIde` to run Intellij
* `gradlew buildPlugin` to build a distribution of the plugin

## Thanks

I would like to thank:
* MongoDB team
* Mongo Java Driver team
* Jetbrains Team for the great sources of IntelliJ Community Edition which help me to improve this plugin
* Mark James author of the famfamfam web site who provides beautiful icons.
* [Jean Baptiste Potonnier](https://github.com/jbpotonnier) for the suggestion to create this plugin
* [piddubnyi](https://github.com/kocherovf) for adding [*copy server* action](https://github.com/dboissier/mongo4idea/pull/141) and [*search in explorer* action](https://github.com/dboissier/mongo4idea/pull/138)
* [piddubnyi](https://github.com/piddubnyi) for adding [*drop database* action](https://github.com/dboissier/mongo4idea/pull/95)
* [dacopan](https://gitlab.com/JedAI/mongo4idea) for fixing the plugin 2019 compatibility whenever I was far far away in a galaxy
* [mancubus77](https://github.com/dboissier/mongo4idea/pull/274) for the default SSH port
* [cunneen](https://github.com/dboissier/mongo4idea/pull/246) for fixing edit document
* Neko team, my first beta testers ;)
* All users of this plugin who sent me valuable suggestions.
* My wife and my daughters who support me to have fun in software development and also remind me my husband/father duty ;).