Skip to content

README.md

Latest commit

 

History

History
67 lines (48 loc) · 1.93 KB

README.md

File metadata and controls

67 lines (48 loc) · 1.93 KB

Database Cleaner Adapter for Mongoid

Build Status Code Climate codecov

Clean your Mongoid databases with Database Cleaner.

See https://github.com/DatabaseCleaner/database_cleaner for more information.

Installation

# Gemfile
group :test do
  gem 'database_cleaner-mongoid'
end

RSpec connection example

# spec_helper.rb
require "database_cleaner-mongoid"
DatabaseCleaner[:mongoid].db = :default
  # Clear DB
  config.before(:suite) do
    DatabaseCleaner[:mongoid].strategy = :deletion
  end
  
config.before(:each) { DatabaseCleaner[:mongoid].clean }

Supported Strategies

The mongoid adapter only has one strategy: the deletion strategy.

Strategy configuration options

:only and :except may take a list of collection names:

# Only delete the "users" collection.
DatabaseCleaner[:mongoid].strategy = [:deletion, only: ["users"]]

# Delete all collections except the "users" collection.
DatabaseCleaner[:mongoid].strategy = [:deletion, except: ["users"]]

Adapter configuration options

#db defaults to the default Mongoid database, but can be specified manually in a few ways:

# Redis URI string:
DatabaseCleaner[:mongoid].db = :logs

# Back to default:
DatabaseCleaner[:mongoid].db = :default

# Multiple Mongoid databases can be specified:
DatabaseCleaner[:mongoid, db: :default]
DatabaseCleaner[:mongoid, db: :shard_1]
DatabaseCleaner[:mongoid, db: :shard_2]

COPYRIGHT

See LICENSE for details.