README.md in fibered_mysql2-1.0.0.colin.2 vs README.md in fibered_mysql2-1.0.0.colin.3
- old
+ new
@@ -1,10 +1,11 @@
[![Coverage Status](https://coveralls.io/repos/github/Invoca/fibered_mysql2/badge.svg?branch=master)](https://coveralls.io/github/Invoca/fibered_mysql2?branch=master)
# FiberedMysql2
-FiberedMysql2 adds Fiber support to `ActiveRecord::ConnectionAdapters::EMMysql2Adapter`
+FiberedMysql2 adds Fiber support to `ActiveRecord::ConnectionAdapters::Mysql2Adapter` for Rails 6.
+This is a stop-gap until Rails 7, which adds `isolation_level: :fiber` to `ActiveRecord`.
## Installation
Add this line to your application's Gemfile:
@@ -19,18 +20,18 @@
Or install it yourself as:
$ gem install fibered_mysql2
## Support
-Tested with Rails versions 5.2 and 6.0.
+Tested with Rails 6.0, Ruby 3, and Async.
## Usage
-Behaves the same as `ActiveRecord::ConnectionAdapters::EMMysql2Adapter` but with added Fiber safety while leasing/expiring connections.
+Behaves the same as `ActiveRecord::ConnectionAdapters::Mysql2Adapter` but with using Fibers rather than Threads for tracking ownership when leasing/expiring connections.
```ruby
connection = FiberedMysql2::FiberedMysql2Adapter.new(client, logger, options, config)
connection.lease
-connection.expire # Rails 5+ only
+connection.expire
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.