DataGrip Setup for Couchbase

There are many ways to deploy Couchbase Server:

For local development, I prefer to install it via a Docker container. You can do the same by following this quick start: Couchbase Server CE Docker Container – Example Manual Configuration.

Any of these methods should work fine with DataGrip. Make sure that Couchbase Server is accessible from wherever you intend to run DataGrip (i.e. your laptop) and that all the necessary ports are opened.

Finally, for this tutorial, I’ll be using the travel-sample sample bucket.

At the current time, DataGrip with Couchbase support is EAP (Early Access Preview). The JetBrains EAP program doesn’t require you to purchase a license. EAP versions do expire.

Click “Download” next to the latest EAP build and follow DataGrip’s instructions to install. If you’ve never used DataGrip before, I recommend checking out the Quick Start Guide.

After installing DataGrip, let’s connect it to Couchbase Server.

You can click File → New → Data Source → Couchbase Query, or you can click the “+” in the Database pane, then Data Source → Couchbase Query.

Configure the connection to Couchbase using the following values:

It’s a good idea to click “Test Connection” to make sure the connection is working, the DataGrip setup is correct, all the correct ports are open, and everything is ready before proceeding.

If this is your first time connecting to Couchbase from DataGrip, you may see a prompt to download the JDBC driver. Click “Download Driver Files” to proceed.

When there are driver updates, you can also install them directly from DataGrip.

At this point, couchbase-local should appear in the DataGrip Database pane. “travel-sample” should also appear. If it does not, try a right-click and then “Refresh”.

As you start to explore DataGrip, remember that this is an EAP. The experience of those reading this months from now may be slightly different. Enhancements are coming soon to better help you navigate Couchbase buckets and the data in them. If you find any bugs or think of ideas for enhancements, create a DataGrip issue on JetBrains’s YouTrack site.

Now, let’s try running a N1QL query. Right click on travel-sample → New → Query Console. This will give you a workspace to start writing your N1QL (SQL for JSON). Here’s an example you can copy/paste into DataGrip:

Click the green “Execute” button to run the query.

The results will appear in the DataGrip output window in “table” format. However, Couchbase is still returning JSON data. You can click the “eye” icon above the DataGrip output window to change to “text” view to see the raw JSON.

Also notice that you can change the results view from JSON to HTML, Markdown, XML, etc.

Another great thing about DataGrip is autocomplete and autosuggestion (like IntelliSense in Visual Studio).

Let’s try typing out the query instead of copy/pasting it. Along the way, you’ll get helpful, time-saving suggestions which you can autocomplete by pressing TAB. Here’s an example animation: