Skip to content

Commit

Permalink
Try to clarify the note on postgres support (#32)
Browse files Browse the repository at this point in the history
* On twitter, some folks (myself included) were confused about the note and thought it was implying some issue with using this gem with Postgres

* This tries to emphasize first that all three are fully supported. Then it tries to specify a bit more clearly the distinction about the action cable built-in adapter vs solid cable

* Also mentions potentially hitting issues with the payload size, or not wanting the `NOTIFY` command (which may be a problem for some folks using pgbouncer)
  • Loading branch information
jpcamara authored Sep 19, 2024
1 parent 8bbc0fb commit ba1b1e5
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@
Solid Cable is a database-backed Action Cable adapter that keeps messages in a table and continously polls for updates. This makes it possible to drop the common dependency on Redis, if it isn't needed for any other purpose. Despite polling, the performance of Solid Cable is comparable to Redis in most situations. And in all circumstances, it makes it easier to deploy Rails when Redis is no longer a required dependency for Action Cable functionality.

> [!NOTE]
> Solid Cable is tested to work with MySQL, SQLite, and PostgreSQL. However,
> PostgreSQL has its own dedicated Action Cable adapter which utilizes
> the builtin NOTIFY command for better performance. The dedicated PostgreSQL
> adapter does have an 8kb limit on its payload, though, so if you find yourself
> broadcasting large payloads, Solid Cable will work without a hitch.
> Solid Cable is tested to work with MySQL, SQLite, and PostgreSQL.
>
> Action Cable already has a [dedicated PostgreSQL adapter](https://guides.rubyonrails.org/action_cable_overview.html#postgresql-adapter),
> which utilizes the builtin `NOTIFY` command for better performance. However, that
> adapter has an 8kb limit on its payload. Solid Cable is a great alternative if you find yourself
> broadcasting large payloads, or prefer not to use the `NOTIFY` command.
## Installation

Expand Down

0 comments on commit ba1b1e5

Please sign in to comment.