mongooser

Mongoose REPL

npm install mongooser
10 downloads in the last week
44 downloads in the last month

Mongooser

===============

Mongoose REPL

install

npm install mongooser -g

usage

mongooser [options]

  Options:

    -h, --help           output usage information
    -V, --version        output the version number
    -c --config <path>   configuration path

Your configuration should be a module. The module should be formatted as follows:

exports.connect = 'mongodb://localhost:port/dbname'
exports.Users = 'path/to/a/schema'
exports.Views = 'path/to/a/model'
exports.Checkins = [ schema, options ]

connection string (required)

// key must be named "connect"
exports.connect = 'mongodb://localhost/name_of_db'

Schemas/Models

There are three approaches to expose your models to the REPL:

exports.NameOfYourModel = 'path/to/your/schema'
// or
exports.NameOfYourModel = 'path/to/your/model'
// or
exports.NameOfYourModel = [ new Schema(..), schemaOptions ]

The array approach allows us to quickly set up configuration by including the Schema and its options directly in the configuration file.

See the test configuration for another example.

repl

When mongooser starts it exposes your Models globally:

You can query in traditional Mongoose fashion:

A few observations:

  • print: is a global function available which prints query results to the repl nicely.
  • p: is an alias of print
  • executing a query dumps the query object to the repl first
  • the print helper displays returned arguments in order
  • print mimics nodejs repl behavior by assigning the 2nd argument passed to the global _.
  • all queries, as with normal mongoose applications, are run asynchronously

globals

  • connection: your db connection object
  • models: array of each loaded Model name
  • schemas: your schemas included in configuration
  • mongoose: the mongoose module
  • ObjectId the ObjectId constructor
  • Models: each model created from your configuration

tests

Run the tests with make test.

LICENSE

npm loves you