From ba1b1e54755249a028de69918db5071f02772688 Mon Sep 17 00:00:00 2001 From: JP Camara <48120+jpcamara@users.noreply.github.com> Date: Thu, 19 Sep 2024 10:24:24 -0400 Subject: [PATCH] Try to clarify the note on postgres support (#32) * 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) --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 61a7654..929673d 100644 --- a/README.md +++ b/README.md @@ -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