MongoHQ Documentation

Documentation for using and extending the MongoHQ Platform.

Using MongoHQ With CloudBees

This guide provides instructions for how to get started using MongoHQ on the CloudBees Platform for running your Java applications in the cloud. MongoHQ has a special partnership for Mongo Hosting with CloudBees that allows you to provision MongoDB databases from within the CloudBees system.

Even though you can use existing MongoHQ databases for your CloudBees application and create new MongoHQ databases from MongoHQ to use in CloudBees, these instructions will assume that you are doing everything through CloudBees.

Note: This guide assumes that you have a CloudBees account and have a basic understanding of Java and MongoDB.

Create a New CloudBees Application

To begin, let’s create a new CloudBees application from the CloudBees interface.

  1. Log into your CloudBees account.

  2. Click on the “Application” icon and add an application to your account.

  3. Upon creation, the application will deploy and provide you with a URL.

Add MongoHQ to your CloudBees Account

  1. Click the “Home” link and return back to the CloudBees main screen.

  2. Click on the “More Services” icon.

  3. Click on the “Add Services” button.

  4. Find MongoHQ (look for the rocket) in the services and click on the “Learn More”.

  5. From there, choose a plan and select “Install”.

Note: Even though you have added MongoHQ to your CloudBees account, you still have one more step: provisioning the databases.

Provisioning a MongoHQ Database

  1. From the CloudBees main screen, click on the “Services” tab.

  2. Under the MongoHQ listing, click on the “MongoHQ” title/link.

  3. Click on the “create a new mongodb” link.

  4. Select a database type, give the database a name and click the “Create” button.

Note: The name you specify in the last step is your CloudBees reference to the database. You will find that CloudBees still assigned a unique programmatic name to the database. You will need the programmatic name in your code.

Basic Example: Part A - Setting up your Project

In this basic example, we will connect to our provisioned MongoHQ database using NetBeans and a very basic system out call. This is an easy way to verify that all the settings are correct and that you are authenticating to your database properly.

  1. Create a new project in NetBeans. Choose Java > Java Application. You can call it cloudbees_mongohq.

  2. Add a reference to the downloaded Java driver for MongoDB. (need an image here)

  3. Add the MongoDB driver class dependencies to your project.

  4. To save a bit of time and keep this example simple, add these dependencies as well.

Basic Example: Part B - Connecting to your Database

Now that we have the basic dependencies in our project file, let’s set up a simple connection to the database.

  1. In your public class, add a main method.

  2. Add the connection information for the database.

  3. Add an exception handler for the main method.

Basic Example: Part C - Performing Actions on the Database

Ok, so we think we are connected. Now, let’s try some basic actions on the database to verify this. Let’s connect and list out the collections. As you may know, a cleanly provisioned MongoDB database will have a system.users and a system.indexes collection.

  1. Get the collection names.

  2. Now, let’s do a quick iteration and display the collection names.

  3. Now run your application and see how things work. If you see the following, congrats!

That is it. If you have any trouble, please let us know at: support@mongohq.com.