mongo-export

Description

mongo-export is an npm package for exporting data from a MongoDB database to CSV format, with built-in support for compression and customization.

Installation

npm install chatz-mongo-export

Usage

const exportAsCsv = { require('chatz-mongo-export') };

exportAsCsv(cursor, {
  outFilePath: 'exports/output',// Output path
  separator: ',', // CSV separator
  zip: true, // Compress output using gzip
  bom: true, // Include BOM (Byte Order Mark)
  append: false, // Append to an existing file
  client: mongoClient, // MongoDB client to close after export, if provided
  log: customLogger, // Custom logger (log.v, log.i, log.w, log.e)
  ping: 30000 // Memory usage logging interval
}).then(() => {
  console.log('Export completed!');
}).catch(err => {
  console.error('Error during export:', err);
});

Options

• cursor: The MongoDB cursor to read data from.
• outFilePath: The output file path for the CSV file. Defaults to a timestamped file in the current directory.
• separator: The separator to use in the CSV file. Defaults to a comma.
• zip: Whether to compress the output file using gzip. Defaults to true.
• bom: Whether to include a BOM (Byte Order Mark) in the CSV file. Defaults to true.
• append: Whether to append to an existing file. Defaults to false. If true, the result will be uncompressed regardless of the zip option.
• client: The MongoDB client to close after exporting if provided. Defaults to undefined.
• log: The logger object to use for logging. Defaults to a global logger.
• ping: The interval in milliseconds to log memory usage. Defaults to 30000.

License

This project is released under the MIT License.