Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including mongo-csv with all npm packages installed. Try it out:

var mongoCsv = require("mongo-csv")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

mongo-csv v2.2.4

Query your Mongo DB collection and write the results to a CSV file

mongo-csv

CLI tool that runs your query against MongoDB and outputs the results to CSV.

npm version Build Status Dependency Status Open Source Love

Supports both find and aggregate queries.

Usage

Provide a config.json file in the directory you'll run mongo-csv, with the following format:

{
  "url": "mongodb://my-mongo-server-url",
  "databaseName": "my_db",
  "collection": "my_collection",
  "query": { "color": "purple" }
}

Then you can either run mongo-csv with npx:

MONGO_USER=my_user MONGO_PASSWORD=secret npx mongo-csv

Or you can install mongo-csv globally:

npm install -g mongo-csv
MONGO_USER=my_user MONGO_PASSWORD=secret mongo-csv

Config

OptionDescriptionDefault value
databaseNameName of the database with your datarequired
collectionName of the collection with your datarequired
urlURL of the Mongo server to which you're connectingmongodb://localhost:27017
methodMethod you want to call on the collection - find or aggregatefind
queryThe query you'd like to run to filter the data returned{} (all records)
optionsLets you specify any of the Mongo driver's find or aggregate options. This is especially useful when running a find for specifying a projection to limit the number of columns returned, or a limit, to limit the number of rows.{}
outputFilePathPath to the file to which you want the results written./query_results.csv
authDbSpecify the database against which to authenticateDefaults to the value supplied for databaseName

Performance tips

mongo-csv will read documents using a cursor to avoid reading them all at once, but here are some additional performance considerations:

  • Write as specific a query as you can so you only get the data you really need
  • Use the projection option to specify only the fields you really need, so Mongo doesn't need to work to get you the rest
  • It's usually a good idea to have a database index in place to support your query, so it can run quickly
  • Avoid reading huge amounts of data at your peak usage periods
  • If your Mongo environment is a replica set, it's a good idea to point at one of your secondary servers to leave the primary server free to take care of new data being written

FAQ

  • Does mongo-csv support distinct? Not directly, but you can achieve the same result using an aggregation.

Licence

MIT

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free