An Easy Way to Maintain Clean Collections

With this script you can drop any collection and swiftly insert as many documents as you'd like to it, with simple and straight-forward configurations.

Installation

git clone https://github.com/PCOffline/reset-db.git

cd reset-db

Config

Before running, you'll have to configure the script. Go to the config.js file and set the mongoUri variable to your mongoDB server. Then provide all the collections you'd like to modify in the following syntax:

// config.js
import mongoose from 'mongoose';

const { Schema } = mongoose;

export default {
  noPrompt: false, // Don't prompt before deleting
  preferPath: true, // When both path and data are provided, ignore the data and only use the path. If false, only the data will be used in such case.
  logLevel: 'info', // 'debug' | 'info' | 'warn' | 'error' | 'silent'
  mongoUri: 'mongodb://localhost:27017/my-database', // Can also be retrieved from environment variable: MONGO_URI, MONGODB_URI, DB_URI, DATABASE_URI or mongoUri
  sensitiveDebugLog: false, // Log information that is considered sensitive (such as the MongoDB URI) in debug mode.
  collections: {
    collectionName: {
      schema: new Schema({
        // The mongoose schema of the collection
        fieldName: {
          type: Schema.Types.String,
          required: true,
        },
      }),
      model: 'modelName', // The name of the model to use, will be equal to the collection name by default, use it in order to not break refs
      data: [
        // The data to be inserted into the collection
        {
          fieldName: 'value',
        },
      ],
      path: 'path/to/file.json', // alternative to 'data', can be either .json, .js or .mjs with default export
    },
  },
};

Using the path property, you can refer the config to a file that contains the data to be inserted, as well as all the other properties, such as the schema, and model. Here's a sample file:

export const model = 'modelName';
export const schema = new Schema({
  fieldName: {
    type: Schema.Types.String,
    required: true,
  },
});
export const data = [
  {
    fieldName: 'value',
  },
];

The naming is significant and should match the name of the property in the config.js file, with the exception of data, that can be a default export as well:

const variableName = [
  {
    fieldName: 'value',
  },
];

export default variableName; // Will be treated as data

You can also defaultly export an entire collection configuration as one whole object from a path:

export default {
  model: 'modelName',
  schema: new Schema({
    fieldName: {
      type: Schema.Types.String,
      required: true,
    },
  }),
  data: [
    {
      fieldName: 'value',
    },
  ],
};

Usage

Run using npm start for the process to begin. You can also use npm run dry to see all the changes that would be made.