Validate documentation of usage ActiveRecord #473
Conversation
miry
force-pushed
the
473-ar-trilogy-adapter-doc
branch
from
1db68bc
to
10df897
Compare
miry
requested review from
a team,
bradfeehan,
keldin-coding and
ShopifyDotIo
and removed request for
a team
miry
changed the title
README.md
Outdated
| @@ -299,6 +300,32 @@ SEMIAN_PARAMETERS = { tickets: 1, | |||
| open_circuit_server_errors: true } | |||
| ``` | |||
|
|
|||
| #### ActiveRecord | |||
|
|
|||
| Semian supports two Activeredord adapters: `mysql2` and `trilogy`. | |||
There was a problem hiding this comment.
| Semian supports two Activeredord adapters: `mysql2` and `trilogy`. | |
| Semian supports two ActiveRecord adapters: `mysql2` and `trilogy`. |
There was a problem hiding this comment.
Hm, mysql2 is not actually supported as an Active Record adapter right now -- mysql2 has a Semian adapter, but we're targeting the client library directly (nothing to do with Active Record). We should probably just mention trilogy for now, because a non-Rails app could use the mysql2 adapter without having Active Record (as is the case with SFR).
There was a problem hiding this comment.
@adrianna-chang-shopify The mysql2 semian still could be configured via database.yml.
I probably used a wrong expression.
There was a problem hiding this comment.
Some small comments.
Does it also make sense to reference the example cases in this part of the README?
e.g.
Example cases for `activerecord-trilogy-adapter` can be run using
`BUNDLE_GEMFILE=gemfiles/activerecord_trilogy_adapter.gemfile bundle exec rake examples:activerecord_trilogy_adapter`
README.md
Outdated
| @@ -299,6 +300,32 @@ SEMIAN_PARAMETERS = { tickets: 1, | |||
| open_circuit_server_errors: true } | |||
| ``` | |||
|
|
|||
| #### ActiveRecord | |||
|
|
|||
| Semian supports two Activeredord adapters: `mysql2` and `trilogy`. | |||
There was a problem hiding this comment.
Hm, mysql2 is not actually supported as an Active Record adapter right now -- mysql2 has a Semian adapter, but we're targeting the client library directly (nothing to do with Active Record). We should probably just mention trilogy for now, because a non-Rails app could use the mysql2 adapter without having Active Record (as is the case with SFR).
miry
force-pushed
the
473-ar-trilogy-adapter-doc
branch
from
5761ae5
to
1a4b122
Compare
Update README about a new adapter.