# intellij

**Repository Path**: mirrors_mongodb/intellij

## Basic Information

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

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-11-02
- **Last Updated**: 2024-11-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MongoDB Plugin for IntelliJ

* ![Public Preview](https://img.shields.io/badge/status-public_preview-darkgreen.png?logo=mongodb) 
* [![IntelliJ Market Release](https://img.shields.io/github/v/release/mongodb/intellij.png?sort=semver&display_name=release&logo=jetbrains)](https://plugins.jetbrains.com/plugin/24377-mongodb) 
* [![JIRA](https://img.shields.io/badge/bug_tracker-blue.png?logo=jira)](https://jira.mongodb.org/projects/INTELLIJ/issues/) 

The **MongoDB Plugin for IntelliJ** provides seamless integration with MongoDB deployments, whether they are local, containerized, or hosted on MongoDB Atlas (including those managed via `atlascli`). 
The plugin aims to enhance your development workflow with intelligent code autocompletion, valuable performance and correctness insights, and a dedicated query runner. 
It supports Java queries written with the [MongoDB Java Driver](https://www.mongodb.com/docs/drivers/java-drivers/) and [Spring Data MongoDB Criteria](https://spring.io/projects/spring-data-mongodb).

## Features

* **Effortless Connectivity:** Connect your IDE directly to any MongoDB cluster using your Data Explorer using a user-friendly side panel.
* **Intelligent Autocompletion:** Get smart suggestions for database names, collection names, and field names as you type.
* **Performance Insights:** Analyze your project for potential performance bottlenecks and receive actionable index suggestions.
* **Smart Type Checking:** Validate your schema and ensure the correctness of your queries with intelligent type checking.
* **Integrated Query Runner:** Transform your Java queries into valid `mongosh` queries and execute them directly within your IDE.

## Screenshots & Gifs

### Connecting to a Cluster
![Connecting to a Cluster](https://raw.githubusercontent.com/mongodb/intellij/main/etc/readme/img/connecting.gif)

### Intelligent Autocompletion in Java
![Intelligent Autocompletion in Java](https://raw.githubusercontent.com/mongodb/intellij/main/etc/readme/img/autocomplete.gif)

### Performance Insights & Create Index
![Performance Insights](https://raw.githubusercontent.com/mongodb/intellij/main/etc/readme/img/create-index.gif)

### Run Java Queries
![Run Java Queries](https://raw.githubusercontent.com/mongodb/intellij/main/etc/readme/img/run-java-query.gif)

## Documentation
To get more information about plugin features and usage, please visit [the documentation](https://www.mongodb.com/docs/mongodb-intellij/install).

## Troubleshooting

You can report new bugs by creating a new issue either in [JIRA](https://jira.mongodb.org/projects/INTELLIJ/issues/) or
[GitHub](https://github.com/mongodb/intellij/issues). Please include as much information as possible about your
environment and include any relevant logs.

### FAQ

#### When I open the MongoDB Side Panel it shows empty

We are aware of a bug in [Skiko](https://youtrack.jetbrains.com/issue/JEWEL-848/Skiko-crashes-when-DirectX12-is-not-available-and-does-not-fallback-to-SOFTWARE), the rendering library used
by Desktop Compose that doesn't fall back to software rendering when a GPU accelerated driver is not available. This should be fixed in version 0.1.0 so please update the
plugin to the latest available version in the Marketplace.

If you are in the latest version, and it doesn't work for you, do the following:

1. Open IntelliJ IDEA
2. Go to the main menu and select Help | Edit Custom VM Options
3. Add the following line to the end of the file: `-Dskiko.renderApi=SOFTWARE`
4. Save the file and restart IntelliJ IDEA

#### The MongoDB Side Panel feels slow

It might be related to using the software renderer in Skiko. To confirm this situation:

1. Open IntelliJ IDEA
2. Go to the main menu and select Help | Show log in Files
3. Open the idea.log
4. Search the following string: `Could not use GPU accelerated rendering`
5. If it's there, Skiko is using your CPU to render instead of the GPU.

In case the log line is not there, please share the entire log file in a bug report.

#### My query is not picked up by the plugin

The plugin doesn't support yet all the possible query variants. Notable unsupported features are:

* Atlas Search and Atlas Vector Search queries
* $lookup queries
* $text queries

In case you think we should prioritise your query, or it's a bug, please fill a bug report with a sample
query.