kotovalexarian-likes-github/database_cleaner
1
0
Fork 0
mirror of https://github.com/DatabaseCleaner/database_cleaner synced 2023-03-27 23:22:03 -04:00
Code Releases Activity

move strategy details for each adapter into respective READMEs.

Browse source
This commit is contained in:
Micah Geisel 2019-05-20 16:21:44 -06:00
parent b4850f6616
commit 310a1bfdf5
11 changed files with 254 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

75
README.markdown
View file

@ -30,49 +30,35 @@ group :test do
end end
``` ```
## Supported Databases, Libraries and Strategies ## List of adapters
Here is an overview of the strategies supported for each ORM: Here is an overview of the databases and ORMs supported by each adapter:
Gem | ORM | Truncation | Transaction | Deletion MySQL, PostgreSQL, SQLite, etc
--- | --- | ---------- | ----------- | -------- * [database_cleaner-active_record](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-active_record)
[database_cleaner-active_record](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-active_record) | ActiveRecord | Yes | **Yes** | Yes * [database_cleaner-sequel](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-sequel)
[database_cleaner-data_mapper](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-data_mapper) | DataMapper | Yes | **Yes** | No * [database_cleaner-data_mapper](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-data_mapper)
[database_cleaner-couch_potato](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-couch_potato) | CouchPotato | **Yes** | No | No
[database_cleaner-mongo](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-mongo) | Mongo | **Yes** | No | No
[database_cleaner-mongo_mapper](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-mongo_mapper) | MongoMapper | **Yes** | No | No
[database_cleaner-mongoid](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-mongoid) | Mongoid | **Yes** | No | No
[database_cleaner-moped](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-moped) | Moped | **Yes** | No | No
[database_cleaner-sequel](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-sequel) | Sequel | **Yes** | Yes | Yes
[database_cleaner-redis](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-redis) | Redis | **Yes** | No | No
[database_cleaner-ohm](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-ohm) | Ohm | **Yes** | No | No
[database_cleaner-neo4j](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-neo4j) | Neo4j | Yes | **Yes** | Yes
(Default strategy for each library is denoted in bold) CouchDB
* [database_cleaner-couch_potato](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-couch_potato)
Database Cleaner also includes a `null` strategy (that does no cleaning at all) which can be used with any ORM library. MongoDB
You can also explicitly use it by setting your strategy to `nil`. * [database_cleaner-mongoid](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-mongoid)
* [database_cleaner-mongo_mapper](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-mongo_mapper)
* [database_cleaner-moped](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-moped)
* [database_cleaner-mongo](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-mongo)
Redis
* [database_cleaner-redis](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-redis)
* [database_cleaner-ohm](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-ohm)
Neo4j
* [database_cleaner-neo4j](https://github.com/DatabaseCleaner/database_cleaner/adapters/database_cleaner-neo4j)
More details on available configuration options can be found in the README for the specific adapter gem that you're using. More details on available configuration options can be found in the README for the specific adapter gem that you're using.
For support or to discuss development please use the [Google Group](http://groups.google.com/group/database_cleaner). For support or to discuss development please use the [Google Group](http://groups.google.com/group/database_cleaner).
## What strategy is fastest?
For the SQL libraries the fastest option will be to use `:transaction` as transactions are simply rolled back. If you can use this strategy you should. However, if you wind up needing to use multiple database connections in your tests (i.e. your tests run in a different process than your application) then using this strategy becomes a bit more difficult. You can get around the problem a number of ways.
One common approach is to force all processes to use the same database connection ([common ActiveRecord hack](http://blog.plataformatec.com.br/2011/12/three-tips-to-improve-the-performance-of-your-test-suite/)) however this approach has been reported to result in non-deterministic failures.
Another approach is to have the transactions rolled back in the application's process and relax the isolation level of the database (so the tests can read the uncommitted transactions).
An easier, but slower, solution is to use the `:truncation` or `:deletion` strategy.
So what is fastest out of `:deletion` and `:truncation`? Well, it depends on your table structure and what percentage of tables you populate in an average test. The reasoning is out of the scope of this README but here is a [good SO answer on this topic for Postgres](http://stackoverflow.com/questions/11419536/postgresql-truncation-speed/11423886#11423886).
Some people report much faster speeds with `:deletion` while others say `:truncation` is faster for them. The best approach therefore is it try all options on your test suite and see what is faster.
If you are using ActiveRecord then take a look at the [additional options](#additional-activerecord-options-for-truncation) available for `:truncation`.
## How to use ## How to use
```ruby ```ruby
@ -130,6 +116,27 @@ DatabaseCleaner.strategy = :transaction
# then make the DatabaseCleaner.start and DatabaseCleaner.clean calls appropriately # then make the DatabaseCleaner.start and DatabaseCleaner.clean calls appropriately
``` ```
## What strategy is fastest?
For the SQL libraries the fastest option will be to use `:transaction` as transactions are simply rolled back. If you can use this strategy you should. However, if you wind up needing to use multiple database connections in your tests (i.e. your tests run in a different process than your application) then using this strategy becomes a bit more difficult. You can get around the problem a number of ways.
One common approach is to force all processes to use the same database connection ([common ActiveRecord hack](http://blog.plataformatec.com.br/2011/12/three-tips-to-improve-the-performance-of-your-test-suite/)) however this approach has been reported to result in non-deterministic failures.
Another approach is to have the transactions rolled back in the application's process and relax the isolation level of the database (so the tests can read the uncommitted transactions).
An easier, but slower, solution is to use the `:truncation` or `:deletion` strategy.
So what is fastest out of `:deletion` and `:truncation`? Well, it depends on your table structure and what percentage of tables you populate in an average test. The reasoning is out of the scope of this README but here is a [good SO answer on this topic for Postgres](http://stackoverflow.com/questions/11419536/postgresql-truncation-speed/11423886#11423886).
Some people report much faster speeds with `:deletion` while others say `:truncation` is faster for them. The best approach therefore is it try all options on your test suite and see what is faster.
If you are using ActiveRecord then take a look at the [additional options](#additional-activerecord-options-for-truncation) available for `:truncation`.
Database Cleaner also includes a `null` strategy (that does no cleaning at all) which can be used with any ORM library.
You can also explicitly use it by setting your strategy to `nil`.
## Test Framework Examples
### RSpec Example ### RSpec Example
```ruby ```ruby

21
adapters/database_cleaner-couch_potato/README.md
View file

@ -16,6 +16,27 @@ group :test do
end 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> <b>Yes</b></td>
<td> No</td>
<td> No</td>
</tr>
</tbody>
</table>
(Default strategy is denoted in bold)
## Configuration options ## Configuration options
<table> <table>

21
adapters/database_cleaner-data_mapper/README.md
View file

@ -16,6 +16,27 @@ group :test do
end 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> No</td>
</tr>
</tbody>
</table>
(Default strategy is denoted in bold)
## Configuration options ## Configuration options
<table> <table>

36
adapters/database_cleaner-mongo/README.md
View file

@ -16,6 +16,42 @@ group :test do
end end
``` ```
## Supported Strategies
<table>
<tbody>
<tr>
<th>Truncation</th>
<th>Transaction</th>
<th>Deletion</th>
</tr>
<tr>
<td> <b>Yes</b></td>
<td> No</td>
<td> No</td>
</tr>
</tbody>
</table>
(Default strategy is denoted in bold)
## Configuration options
<table>
<tbody>
<tr>
<th>ORM</th>
<th>How to access</th>
<th>Notes</th>
</tr>
<tr>
<td> Mongo</td>
<td> <code>DatabaseCleaner[:mongo]</code></td>
<td> </td>
</tr>
</tbody>
</table>
## COPYRIGHT ## COPYRIGHT
See [LICENSE] for details. See [LICENSE] for details.

19
adapters/database_cleaner-mongo_mapper/README.md
View file

@ -16,6 +16,25 @@ group :test do
end end
``` ```
## Supported Strategies
<table>
<tbody>
<tr>
<th>Truncation</th>
<th>Transaction</th>
<th>Deletion</th>
</tr>
<tr>
<td> <b>Yes</b></td>
<td> No</td>
<td> No</td>
</tr>
</tbody>
</table>
(Default strategy is denoted in bold)
## Configuration options ## Configuration options
<table> <table>

19
adapters/database_cleaner-mongoid/README.md
View file

@ -16,6 +16,25 @@ group :test do
end end
``` ```
## Supported Strategies
<table>
<tbody>
<tr>
<th>Truncation</th>
<th>Transaction</th>
<th>Deletion</th>
</tr>
<tr>
<td> <b>Yes</b></td>
<td> No</td>
<td> No</td>
</tr>
</tbody>
</table>
(Default strategy is denoted in bold)
## Configuration options ## Configuration options
<table> <table>

19
adapters/database_cleaner-moped/README.md
View file

@ -16,6 +16,25 @@ group :test do
end end
``` ```
## Supported Strategies
<table>
<tbody>
<tr>
<th>Truncation</th>
<th>Transaction</th>
<th>Deletion</th>
</tr>
<tr>
<td> <b>Yes</b></td>
<td> No</td>
<td> No</td>
</tr>
</tbody>
</table>
(Default strategy is denoted in bold)
## Configuration options ## Configuration options
<table> <table>

19
adapters/database_cleaner-neo4j/README.md
View file

@ -16,6 +16,25 @@ group :test do
end end
``` ```
## 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)
## Configuration options ## Configuration options
<table> <table>

19
adapters/database_cleaner-ohm/README.md
View file

@ -16,6 +16,25 @@ group :test do
end end
``` ```
## Supported Strategies
<table>
<tbody>
<tr>
<th>Truncation</th>
<th>Transaction</th>
<th>Deletion</th>
</tr>
<tr>
<td> <b>Yes</b></td>
<td> No</td>
<td> No</td>
</tr>
</tbody>
</table>
(Default strategy is denoted in bold)
## Configuration options ## Configuration options
`:only` and `:except` take a list of strings to be passed to [`keys`](http://redis.io/commands/keys)). `:only` and `:except` take a list of strings to be passed to [`keys`](http://redis.io/commands/keys)).

19
adapters/database_cleaner-redis/README.md
View file

@ -16,6 +16,25 @@ group :test do
end end
``` ```
## Supported Strategies
<table>
<tbody>
<tr>
<th>Truncation</th>
<th>Transaction</th>
<th>Deletion</th>
</tr>
<tr>
<td> <b>Yes</b></td>
<td> No</td>
<td> No</td>
</tr>
</tbody>
</table>
(Default strategy is denoted in bold)
## Configuration options ## Configuration options
`:only` and `:except` take a list of strings to be passed to [`keys`](http://redis.io/commands/keys)). `:only` and `:except` take a list of strings to be passed to [`keys`](http://redis.io/commands/keys)).

21
adapters/database_cleaner-sequel/README.md
View file

@ -16,6 +16,27 @@ group :test do
end 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)
## Configuration options ## Configuration options
<table> <table>