{"id":520,"date":"2017-08-18T17:28:56","date_gmt":"2017-08-19T00:28:56","guid":{"rendered":"https:\/\/www.kenwalger.com\/blog\/?p=520"},"modified":"2017-08-18T17:58:19","modified_gmt":"2017-08-19T00:58:19","slug":"mongodb-plugin-pycharm","status":"publish","type":"post","link":"https:\/\/www.kenwalger.com\/blog\/nosql\/mongodb\/mongodb-plugin-pycharm\/","title":{"rendered":"MongoDB Plugin for PyCharm"},"content":{"rendered":"

There are many different options available when developing to look at and examine your MongoDB<\/a> collections. MongoDB’s Compass<\/a> is a great example of a tool that allows for the viewing and interaction with a database, collection, or document. However, when developing it is often useful to have the ability to see your data inside your development environment. Let’s take a look at a useful MongoDB Plugin for PyCharm for viewing collections.<\/p>\n

MongoDB Plugin<\/h3>\n

While I will be discussing the Mongo Plugin<\/a> specifically as it relates to PyCharm<\/a>, the plugin itself works with the vast majority of IDEs provided by JetBrains<\/a>. After downloading and installing the plugin we need to set a few things up. I’ll walk through setting up connections for a local installation of a MongoDB server as well as a connection to their Database as a Service, Atlas<\/a>. For testing the connection we will want to make sure both of these servers are up and running.<\/p>\n

MongoDB Plugin Settings<\/h4>\n
Local Server<\/h6>\n

For the local server, the settings are relatively straight forward. Assuming that we are working with a server on the default port of 27107, let’s take a look at our settings.<\/p>\n

\"MongoDB
File -> Settings -> Other Settings<\/figcaption><\/figure>\n

We see here that there is a place to input the path to our\u00a0Path to Mongo Shell<\/a><\/em>. Be sure to put the location to the mongo<\/code> executable and not the one for mongod<\/code>.\u00a0You can hit the\u00a0test<\/strong> button next to the path name to make sure the plugin is happy with the correct file.<\/p>\n

We next need to add a server to use and connect with. By clicking on the +<\/code> symbol we are presented with an option to configure our server connection.<\/p>\n

\"MongoDB
Localhost setup configuration.<\/figcaption><\/figure>\n

Here we see that we are able to label, or name, our connection and put in the server location in the format of\u00a0host:port<\/em>. For our example, we can use localhost:27017<\/code>, as displayed above. For a single server without any authentication in place, these settings will connect to the database and you can see\u00a0all<\/strong> of the databases on the server.<\/p>\n

What if, however, you do have some authentication in place and want to establish a connection to a specific database? Let’s examine that with a connection to an Atlas configuration.<\/p>\n

Atlas Server<\/h6>\n

We will need our Atlas<\/a> connection URL that is available within our Atlas dashboard. Feel free to use your own server’s host name or IP address. For my server settings, I want to set a read preference for the Primary node and to connect to the travel collection in the database.\u00a0I also selected that I’d like it to use SSL for the connection.<\/p>\n

\"MongoDB
Connection to an Atlas database.<\/figcaption><\/figure>\n

Since my Atlas server does require authentication, let’s take a look at that tab.<\/p>\n

\"MongoDB
Setting up connection Authentication<\/figcaption><\/figure>\n

We put in an appropriately established username and password along with the name of the authentication<\/a> database. In this case, I am using the admin database. For Atlas, we want to choose the SCRAM-SHA-1<\/a> authorization mechanism. And then we can test\u00a0this<\/em> connection. If everything is configured correctly, we should get the good news pop up.<\/p>\n

\"MongoDB
Successful Connection Test.<\/figcaption><\/figure>\n

Starting the Plugin<\/h4>\n

With our connections established, we can use the Mongo Explorer by navigating to\u00a0View -> \u00a0Tool Windows -> Mongo Explorer<\/em>. It will show our configured connections and when opening the connection up we see our databases listed.<\/p>\n

\"MongoDB
Enabling the Plugin in PyCharm<\/figcaption><\/figure>\n

Upon selecting a given database we are given a list of the collections<\/a>. We can then choose a given collection and see a list of the documents in the collection.<\/p>\n

\"MongoDB
Examining a collection with the Mongo Plugin.<\/figcaption><\/figure>\n

MongoDB Plugin ToolBar<\/h4>\n

If we have a look at the toolbar that appears above our collection:<\/p>\n

\"MongoDB<\/p>\n

There are some great features in there.<\/p>\n

\"MongoDB<\/p>\n

We see that we have a find<\/code> option, an option to toggle the aggregation mode, and the ability to add and edit documents directly from PyCharm. We are given options to run queries with\u00a0Filter<\/em>,\u00a0Projection<\/em>, and\u00a0Sort<\/em> parameters as well. \u00a0A group of very useful tools included with this plugin.<\/p>\n

Wrap Up<\/h3>\n

With successfully configured connections to MongoDB servers, we can now utilize the Mongo Plugin to see what our data looks like as we develop. I personally find this to be a\u00a0huge<\/strong> benefit and time saver when developing. If you use a JetBrains IDE for your development, I would highly encourage you to have a look at this very useful plugin.<\/p>\n

There are several MongoDB specific terms in this post. I created a MongoDB Dictionary<\/a> skill for the Amazon Echo<\/a>\u00a0line of products. Check it out and you can say “Alexa, ask MongoDB what is a document?” and get a helpful response.<\/p>\n

\n

Follow me on Twitter @kenwalger<\/a> to get the latest updates on my postings.<\/em><\/p>\n\"Facebook\"<\/a>\"twitter\"<\/a>\"reddit\"<\/a>\"linkedin\"<\/a>\"mail\"<\/a>","protected":false},"excerpt":{"rendered":"

There are many different options available when developing to look at and examine your MongoDB collections. MongoDB’s Compass is a great example of a tool that allows for the viewing and interaction with a database, collection, or document. However, when developing it is often useful to have the ability to see your data inside your … Continue reading “MongoDB Plugin for PyCharm”<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":525,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"pmpro_default_level":"","_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[4],"tags":[],"yst_prominent_words":[89,774,775,771,117,780,253,772,104,764,756,765,776,779,87,760,759,708,102,763],"class_list":["post-520","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-mongodb","pmpro-has-access"],"jetpack_featured_media_url":"https:\/\/i0.wp.com\/www.kenwalger.com\/blog\/wp-content\/uploads\/2017\/08\/feature-1-e1502998623242.png?fit=125%2C125&ssl=1","jetpack_sharing_enabled":true,"jetpack_shortlink":"https:\/\/wp.me\/p8lx70-8o","jetpack-related-posts":[],"_links":{"self":[{"href":"https:\/\/www.kenwalger.com\/blog\/wp-json\/wp\/v2\/posts\/520","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.kenwalger.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.kenwalger.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.kenwalger.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.kenwalger.com\/blog\/wp-json\/wp\/v2\/comments?post=520"}],"version-history":[{"count":7,"href":"https:\/\/www.kenwalger.com\/blog\/wp-json\/wp\/v2\/posts\/520\/revisions"}],"predecessor-version":[{"id":547,"href":"https:\/\/www.kenwalger.com\/blog\/wp-json\/wp\/v2\/posts\/520\/revisions\/547"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.kenwalger.com\/blog\/wp-json\/wp\/v2\/media\/525"}],"wp:attachment":[{"href":"https:\/\/www.kenwalger.com\/blog\/wp-json\/wp\/v2\/media?parent=520"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.kenwalger.com\/blog\/wp-json\/wp\/v2\/categories?post=520"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.kenwalger.com\/blog\/wp-json\/wp\/v2\/tags?post=520"},{"taxonomy":"yst_prominent_words","embeddable":true,"href":"https:\/\/www.kenwalger.com\/blog\/wp-json\/wp\/v2\/yst_prominent_words?post=520"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}