MongoDB to CSV

Every once in a while, I need to give a non-technical user (like a business analyst) data residing in MongoDB; consequently, I export the target data as a CSV file (which they can presumably slice and dice once they import it into Excel or some similar tool). Mongo has a handy export utility that takes a bevy of options, however, there is an outstanding bug and some general confusion as to how to properly export data in CSV format.

Accordingly, if you need to export some specific data from MongoDB into CSV format, here’s how you do it. The key parameters are connection information to include authentication, an output file, and most important, a list of fields to export. What’s more, you can provide a query in escaped JSON format.

You can find the mongoexport utility in your Mongo installation bin directory. I tend to favor verbose parameter names and explicit connection information (i.e. rather than a URL syntax, I prefer to spell out the host, port, db, etc directly). As I’m targeting specific data, I’m going to specify the collection; what’s more, I’m going to further filter the data via a query.

ObjectId’s can be referenced via the $oid format; furthermore, you’ll need to escape all JSON quotes. For example, if my query is against a users collection and filtered by account_id (which is an ObjectId), the query via the mongo shell would be:

Mongo Shell Query
<span class='line-number'>1</span>
<code class='javascript'><span class='line'><span class="nx">db</span><span class="p">.</span><span class="nx">users</span><span class="p">.</span><span class="nx">find</span><span class="p">({</span><span class="nx">account_id</span><span class="o">:</span><span class="nx">ObjectId</span><span class="p">(</span><span class="s1">'5058ca07b7628c0002099006'</span><span class="p">)})</span>

Via the command line à la monogexport, this translates to:

Collections and queries
<span class='line-number'>1</span>
<code class='bash'><span class='line'> --collection users --query <span class="s2">"{\"account_id\": {\"\$oid\": \"5058ca07b7628c0002000006\"}}"</span>

Finally, if you want to only export a portion of the fields in a user document, for example, name, email, and created_at, you need to provide them via the fields parameter like so:

Fields declaration
<span class='line-number'>1</span>
<code class='bash'><span class='line'>--fields name,email,created_at

Putting it all together yields the following command:

Puttin’ it all together
<span class='line-number'>1</span>
<span class='line-number'>2</span>
<span class='line-number'>3</span>
<code class='bash'><span class='line'>mongoexport --host --port 10332 --username acmeman --password 12345  <span class="se">\</span>
</span><span class='line'>--collection users --csv --fields name,email,created_at --out all_users.csv --db my_db <span class="se">\</span>
</span><span class='line'>--query <span class="s2">"{\"account_id\": {\"\$oid\": \"5058ca07b7628c0999000006\"}}"</span>

Of course, you can throw this into a bash script and parameterize the collection, fields, output file, and query with bash’s handy $1, $2, etc variables.

Got it?

This story, "MongoDB to CSV" was originally published by JavaWorld.


Copyright © 2013 IDG Communications, Inc.

InfoWorld Technology of the Year Awards 2023. Now open for entries!