database_cleaner/adapters/database_cleaner-sequel/README.md

66 lines
1.7 KiB
Markdown
Raw Normal View History

2019-05-20 18:03:59 -04:00
# Database Cleaner Adapter for Sequel
2019-05-20 18:03:59 -04:00
[![Build Status](https://travis-ci.org/DatabaseCleaner/database_cleaner-sequel.svg?branch=master)](https://travis-ci.org/DatabaseCleaner/database_cleaner-sequel)
[![Code Climate](https://codeclimate.com/github/DatabaseCleaner/database_cleaner-sequel/badges/gpa.svg)](https://codeclimate.com/github/DatabaseCleaner/database_cleaner-sequel)
2019-05-20 18:03:59 -04:00
Clean your Sequel databases with Database Cleaner.
2019-05-20 18:03:59 -04:00
See https://github.com/DatabaseCleaner/database_cleaner for more information.
2019-05-20 18:03:59 -04:00
## Installation
```ruby
2019-05-20 18:03:59 -04:00
# Gemfile
group :test do
gem 'database_cleaner-sequel'
end
```
## Supported Strategies
Here is an overview of the supported strategies:
<table>
<tbody>
<tr>
<th>Truncation</th>
<th>Transaction</th>
<th>Deletion</th>
</tr>
<tr>
<td> Yes</td>
<td> <b>Yes</b></td>
<td> Yes</td>
</tr>
</tbody>
</table>
(Default strategy is denoted in bold)
2019-05-20 18:03:59 -04:00
## Configuration options
<table>
<tbody>
<tr>
<th>ORM</th>
<th>How to access</th>
<th>Notes</th>
</tr>
<tr>
<td> Sequel</td>
<td> <code>DatabaseCleaner[:sequel]</code></td>
<td> Multiple databases supported; specify <code>DatabaseCleaner[:sequel, {:connection =&gt; Sequel.connect(uri)}]</code></td>
</tr>
</tbody>
</table>
## Common Errors
### Nothing happens in JRuby with Sequel using transactions
Due to an inconsistency in JRuby's implementation of Fibers, Sequel gives a different connection to `DatabaseCleaner.start` than is used for tests run between `.start` and `.clean`. This can be worked around by running your tests in a block like `DatabaseCleaner.cleaning { run_my_tests }` instead, which does not use Fibers.
2019-05-20 18:03:59 -04:00
## COPYRIGHT
2019-05-20 18:03:59 -04:00
See [LICENSE] for details.