<commit_before># Mongo Plugin for IntelliJ IDEA

## ChangeLog
See CHANGELOG.txt

## Description
This plugin integrates MongoDB Server with database/collections tree and Query Runner

## Plugin Compatibility
This plugin was built with JDK 1.6 and ideaIU-11.1.4 version.

## Installation steps
Download this plugin from your IDE (Mongo Plugin)

## Configuration steps

![Browser](https://github.com/dboissier/mongo4idea/blob/master/doc/mongo4idea-configuration.png?raw=true)

* The plugin intends to connect to the local Mongo server with default parameters (127.0.0.1/27017)
* If you need to specify another server, click on the Mongo Settings button located on the upper toolbar of the Mongo explorer Right Panel
* If the server requires authentication, you can put your credentials
* If you want to hide some collections, you can put them in the **Collections to ignore** field.
* You can click on the **Test Connection** button to check your server configuration

## Usage

### Mongo Explorer

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

The tree displays for each database all collections. Just double-click on a collection and the results will be displayed in the Mongo Runner Panel.

If the server does not respond, you have have the following message:

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

### Mongo Runner
The panel is divided into 2 parts.

* Right part displays the results of the query in a tree (max. 300 records).

![Browser](https://github.com/dboissier/mongo4idea/blob/master/doc/mongo4idea-findAll.png?raw=true)

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

* Left part allows to specify a query (in json format).

![Browser](https://github.com/dboissier/mongo4idea/blob/master/doc/mongo4idea-findWithFilter.png?raw=true)

When you type **CTRL+SPACE** key shortcut a popup is displayed in which you can select query operator.

![Browser](https://github.com/dboissier/mongo4idea/blob/master/doc/mongo4idea-operatorPopup.png?raw=true)

Either you click on the run query button or else type **CTRL+F5** shortcut to run the query
If your server version is at least 2.2, you can use the aggregation framework. You can add a pipeline operation by clicking on the [+] button.
You can also copy/paste the query you wrote.

![Browser](https://github.com/dboissier/mongo4idea/blob/master/doc/mongo4idea-aggregation.png?raw=true)

If you have an error during query execution, a feedback panel is displayed below:

* In case of bad JSON syntax

![Browser](https://github.com/dboissier/mongo4idea/blob/master/doc/mongo4idea-errorInExecution.png?raw=true)

* In case of general error

![Browser](https://github.com/dboissier/mongo4idea/blob/master/doc/mongo4idea-errorInExecutionCommand.png?raw=true)

**Note**: If you use Ultimate Edition, JSON syntax highlighting is enabled.

### Mongo shell integration

If you set the mongo client path (e.g. /usr/bin/mongo), you can run the console by clicking the menu item **Tools -> Mongo Shell**.

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


## Thanks
I would like to thank:
* MongoDB team
* Mongo Java Driver team
* Jetbrains Team for the great sources of the Groovy Plugin that help me to improve this stuff
* Mark James author of the famfamfam web site who provides beautiful icons.
* [<NAME>](https://github.com/JJeeb) for the suggestion to create this plugin
* Neko team, my first beta testers ;)
* My wife and my daughter who support me to have fun in software development and also remind me my husband/father duty ;).
<commit_msg>fix plugin description<commit_after># Mongo Plugin for IntelliJ IDEA

## ChangeLog
See CHANGELOG.txt

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

## Plugin Compatibility
This plugin was built with JDK 1.6 and ideaIU-11.1.4 version.

## Installation steps
Download this plugin from your IDE (Mongo Plugin)

## Configuration steps

![Browser](https://github.com/dboissier/mongo4idea/blob/master/doc/mongo4idea-configuration.png?raw=true)

* The plugin intends to connect to the local Mongo server with default parameters (127.0.0.1/27017)
* If you need to specify another server, click on the Mongo Settings button located on the upper toolbar of the Mongo explorer Right Panel
* If the server requires authentication, you can put your credentials
* If you want to hide some collections, you can put them in the **Collections to ignore** field.
* You can click on the **Test Connection** button to check your server configuration

## Usage

### Mongo Explorer

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

The tree displays for each database all collections. Just double-click on a collection and the results will be displayed in the Mongo Runner Panel.

If the server does not respond, you have have the following message:

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

### Mongo Runner
The panel is divided into 2 parts.

* Right part displays the results of the query in a tree (max. 300 records).

![Browser](https://github.com/dboissier/mongo4idea/blob/master/doc/mongo4idea-findAll.png?raw=true)

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

* Left part allows to specify a query (in json format).

![Browser](https://github.com/dboissier/mongo4idea/blob/master/doc/mongo4idea-findWithFilter.png?raw=true)

When you type **CTRL+SPACE** key shortcut a popup is displayed in which you can select query operator.

![Browser](https://github.com/dboissier/mongo4idea/blob/master/doc/mongo4idea-operatorPopup.png?raw=true)

Either you click on the run query button or else type **CTRL+F5** shortcut to run the query
If your server version is at least 2.2, you can use the aggregation framework. You can add a pipeline operation by clicking on the [+] button.
You can also copy/paste the query you wrote.

![Browser](https://github.com/dboissier/mongo4idea/blob/master/doc/mongo4idea-aggregation.png?raw=true)

If you have an error during query execution, a feedback panel is displayed below:

* In case of bad JSON syntax

![Browser](https://github.com/dboissier/mongo4idea/blob/master/doc/mongo4idea-errorInExecution.png?raw=true)

* In case of general error

![Browser](https://github.com/dboissier/mongo4idea/blob/master/doc/mongo4idea-errorInExecutionCommand.png?raw=true)

**Note**: If you use Ultimate Edition, JSON syntax highlighting is enabled.

### Mongo shell integration

If you set the mongo client path (e.g. /usr/bin/mongo), you can run the console by clicking the menu item **Tools -> Mongo Shell**.

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


## Thanks
I would like to thank:
* MongoDB team
* Mongo Java Driver team
* Jetbrains Team for the great sources of the Groovy Plugin that help me to improve this stuff
* Mark James author of the famfamfam web site who provides beautiful icons.
* [<NAME>](https://github.com/JJeeb) for the suggestion to create this plugin
* Neko team, my first beta testers ;)
* My wife and my daughter who support me to have fun in software development and also remind me my husband/father duty ;).

{'fraction_non_alphanumeric': 0.09172077922077922, 'fraction_numerical': 0.011904761904761904, 'mean_word_length': 4.789350039154268, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 7, 'https://': 22, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2783391', 'n_tokens_mistral': 2242, 'n_tokens_neox': 2139, 'n_words': 844}