ARCHIVED-mongoose-repl

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

ARCHIVED-mongoose-repl

★ 16 Open GitHub ↗

A Mongo REPL with the full power of Mongoose

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Notice

_ARCHIVED: This repo is no longer maintained by Clever._

# mongoose-repl

A Mongo REPL with the full power of Mongoose.

If you're using the [Mongoose ODM](http://mongoosejs.com/) to keep your MongoDB code from descending into schema-less chaos, it can be a pain to fall back to the barebones Mongo shell when you want to interact with your data.

`mongoose-repl` registers your schemas and exposes the resulting models in an interactive REPL, so you can `findById` and `populate` to your heart's content. You'll never have to type `ObjectId` again! Oh, and did I mention it interprets CoffeeScript?

$ mongoose --schemas examples/schemas.coffee localhost/test
    > Dog.findById('520bb7baa4e06dc4e9000001').select('enemy name').populate('enemy')
    { name: 'fido',
      enemy: { name: 'fluffy', _id: 520baec9d61fae3ee6000001, __v: 0 },
      _id: 520bb7baa4e06dc4e9000001 }
    > Cat.findById _.enemy._id
    { name: 'fluffy', _id: 520baec9d61fae3ee6000001, __v: 0 }

Some other nice features:

- Tab completion
- Command history
- Colored printing of values

## Installation

npm install -g mongoose-repl

## Usage

### Connecting to a DB

To connect to a Mongo instance, simply pass in a [MongoDB connection string](http://docs.mongodb.org/manual/reference/connection-string/):

$ mongoose localhost/test
    Connecting to: localhost
    Using db: test
    No models loaded
    >

### Loading Models

Notice that no models were loaded, so the REPL isn't very useful yet. In order for `mongoose-repl` to give you access to Mongoose models, you have to first tell it about your schemas. Create a module that exports a mapping from schema names to schemas, like so:

$ cat examples/schemas.coffee
```coffeescript
{Schema} = require 'mongoose'
module.exports =
  Cat: new Schema
    name: String
  Dog: new Schema
    name: String
    enemy: { type: Schema.Types.ObjectId, ref: 'Cat' }
```

Now you can load these schemas into the REPL using the `--schemas` (`-s`) option, which will register them as Mongoose models:

$ mongoose --schemas examples/schemas.coffee localhost/test
    Connecting to: localhost
    Using db: test
    Loaded models: Cat, Dog
    > Cat.modelName
    'Cat'

If you have schemas with references, you may see missing references when you query your models. This is most likely due to the fact that `mongoose-repl` is using a different instance of Mongoose than your schemas. You can tell `mongoose-repl` to use the same instance using the `--mongoose` (`-m`) option:

mongoose --schemas path/to/someproject/schemas --mongoose /path/to/someproject/node_modules/mongoose

### Querying

This is where things get awesome. Now you can query models just like you do in Mongoose:

> Dog.findOne().populate('enemy')
    { name: 'fido',
      enemy: { name: 'fluffy', _id: 520baec9d61fae3ee6000001, __v: 0 },
      _id: 520bb7baa4e06dc4e9000001,
      __v: 0 }

The special variable `_` holds the value of the last expression, so you can use it in further queries:

> Cat.find name: _.enemy.name
    [ { name: 'fluffy', _id: 520baec9d61fae3ee6000001, __v: 0 } ]

### Globals

`mongoose-repl` exposes some helpful global functions and objects in the REPL context:

- `conn` - the Mongoose connection object
- `ObjectId` - because sometimes you just need it
- `inspect` - a colorful variadic pretty printer

ARCHIVED-mongoose-repl

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README