npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

mongoose-csv-export

v1.0.0

Published

Export mongoose queries as CSV streams.

Downloads

213

Readme

mongoose-csv

This is a mongoose plugin that creates a CsvBuilder instance for your Schema, fully compatible with TypeScript.

Usage

import express, { Request, Response } from 'express';
import mongoose from 'mongoose';
import csv from 'mongoose-csv-export';
import fs from 'fs';

interface IUserSchema extends mongoose.Document {
  fullname: string;
  email: string;
  age: number;
  username: string;
}

var UserSchema = new mongoose.Schema<IUserSchema>({
  fullname: String,
  email: String,
  age: Number,
  username: String,
});

UserSchema.plugin(csv, {
  headers: 'Firstname Lastname Username Email Age',
  alias: {
    'Username': 'username',
    'Email': 'email',
    'Age': 'age'
  },
  virtuals: {
    'Firstname': function(doc) {
      return doc.fullname.split(' ')[0];
    },
    'Lastname': function(doc) {
      return doc.fullname.split(' ')[1];
    }
  }
});

var User = mongoose.model<IUserSchema>('Users', UserSchema);

// Query and stream
User.findAndStreamCsv({age: {$lt: 40}})
  .pipe(fs.createWriteStream('users_under_40.csv'));

// Create stream from query results
User.find({}).exec()
  .then((docs) => {
    User.csvReadStream(docs)
      .pipe(fs.createWriteStream('users.csv'));
  });

// Transform mongoose streams
User.find({})
  .where('age').gt(20).lt(30)
  .limit(10)
  .sort('age')
  .stream()
  .pipe(User.csvTransformStream())
  .pipe(fs.createWriteStream('users.csv'));

// Pipe it to an express route
const app = express();
app.get('/', async (req: Request, res: Response) => {
  const docs = await Test.find({}).exec();
  res.header('Content-Type', 'text/csv; charset=utf-8');
  Test.csvReadStream(docs).pipe(res);
});
app.listen(5000);

Installation

$ npm install mongoose-csv-export
# OR
$ yarn add mongoose-csv-export

Testing

Running tests requires a local mongodb server, and mocha. While most likely not a namespace issue, the test script will create a database __mongoose_csv_test__, and drop the database when finished. You have been warned.

$ npm test

API

Schema.plugin(mongooseToCsv, options)

The options argument is passed to the CsvBuilder instance, please refer to the Docs for more in-depth details. The only aditional property that can be included is the virutals property. The virtuals have nothing to do with mongoose virtuals.

Schema.csvReadStream([docs])

Creates a csv formated read stream from query results.

  • docs: mongoose query result documents

Schema.csvTransformStream()

Transforms mongoose querystreams to csv formated streams.

Schema.findAndStreamCsv(query)

  • query: mongoose query object

This is just a convenience method for:

Schema.find(query).cursor().pipe(Schema.csvTransformStream())

Schema.aggregateAndStreamCsv(pipelines)

  • pipelines: mongoose pipelines array

This is just a convenience method for:

Schema.aggregate(pipelines).cursor().pipe(Schema.csvTransformStream())

Acknowledgments

Thanks to Nick Pisacane for his great job with the original CSV exporter that this repo is based on.