solid_cache 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbc53d2cf4cc3edfeb5292055f3e8bb9c0057e4e067bee764a4d88a62fbd8278
-  data.tar.gz: e3e9eac0f9a24a26eb3e992b2d2cdd0037c5d9ca4c36ea7cf8751b257fdf152b
+  metadata.gz: 70875a0c2373759080034b37dec27820e3e524972088278b429b5972fce42f5c
+  data.tar.gz: 89651c75f6b9847e22ceafb6d07607c4caee58a5f937a8e0963f3478a93028dd
 SHA512:
-  metadata.gz: 3e94a6318abc57922c7b98c34b4034a660c8f598a557f0fb38a95f313228e02ae437396d415fe7bb2ed8782a492274458f621e059f74ea75905fd91b2bdee155
-  data.tar.gz: deebaed2b15b865e87aaf27ac521e0b85fb8ebffab19651dec622c6ad6008cb489ec1648059a26f7d870bf327b8295f70eb76651bb3465a5613a16c14b2901b8
+  metadata.gz: ff76d3100601e08fa7d16a5f2b0bd9c950f5702ca0bd33c489132b03fd246631c749b3ec049e9001de45d64d562868743b2380b067b5bfd79deda2ec62b9e877
+  data.tar.gz: dcccb3c5faf1911bc7c6c329f9279816520c783df9cac80c72f7b1a33532c667a0d4dc63a2edfd05f9682b0f005feb67afab1427ec178d7e886ed7fc0cdb86b7

data/README.md

@@ -9,7 +9,13 @@ Solid Cache is configured by default in new Rails 8 applications. But if you're
 1. `bundle add solid_cache`
 2. `bin/rails solid_cache:install`
 
-This will configure Solid Cache as the production cache store, create `config/cache.yml`, and create `db/cache_schema.rb`.
+This will configure Solid Cache as the production cache store and create `config/cache.yml`.
+
+If your application uses `config.active_record.schema_format = :ruby` (the default), the installer creates `db/cache_schema.rb`.
+
+If your application uses `config.active_record.schema_format = :sql`, the installer creates `db/cache_structure.sql` with the appropriate SQL for your database adapter (PostgreSQL, MySQL, or SQLite).
+
+### Configuring the cache database
 
 You will then have to add the configuration for the cache database in `config/database.yml`. If you're using sqlite, it'll look like this:
 
@@ -39,7 +45,9 @@ production:
     migrations_paths: db/cache_migrate
 ```
 
-Then run `db:prepare` in production to ensure the database is created and the schema is loaded.
+### Finalizing installation
+
+After configuring `database.yml`, run `db:prepare` in production to ensure the cache database is created and the schema is loaded.
 
 ## Configuration
 
@@ -64,7 +72,7 @@ production: &production
   databases: [production_cache1, production_cache2]
   store_options:
     <<: *default_store_options
-    max_entries: <%= 256.gigabytes %>
+    max_size: <%= 256.gigabytes %>
 ```
 
 For the full list of keys for `store_options` see [Cache configuration](#cache-configuration). Any options passed to the cache lookup will overwrite those specified here.
@@ -80,19 +88,32 @@ config.cache_store = :solid_cache_store
 
 You can set one of `database`, `databases` and `connects_to` in the config file. They will be used to configure the cache databases in `SolidCache::Record#connects_to`.
 
-Setting `database` to `cache_db` will configure with:
+If `connects_to` is set, it will be passed directly.
 
-```ruby
-SolidCache::Record.connects_to database: { writing: :cache_db }
-```
+Setting `database` is shorthand for connecting to a single database:
 
-Setting `databases` to `[cache_db, cache_db2]` is the equivalent of:
+```yaml
+database: :cache_db
 
-```ruby
-SolidCache::Record.connects_to shards: { cache_db1: { writing: :cache_db1 },  cache_db2: { writing: :cache_db2 } }
+# equivalent to
+connects_to:
+  database:
+    writing: :cache_db
 ```
 
-If `connects_to` is set, it will be passed directly.
+And `databases` to `[cache_db, cache_db2]` configures multiple database shards:
+
+```yaml
+databases: [cache_db, cache_db2]
+
+# equivalent to
+connects_to:
+  shards:
+    cache_db1:
+      writing: :cache_db1
+    cache_db2:
+      writing: :cache_db2
+```
 
 If none of these are set, Solid Cache will use the `ActiveRecord::Base` connection pool. This means that cache reads and writes will be part of any wrapping database transaction.
 

data/lib/generators/solid_cache/install/install_generator.rb

@@ -5,11 +5,54 @@ class SolidCache::InstallGenerator < Rails::Generators::Base
 
   def copy_files
     template "config/cache.yml"
-    template "db/cache_schema.rb"
+
+    if Rails.application.config.active_record.schema_format == :sql
+      copy_sql_schema_for_adapter
+    else
+      template "db/cache_schema.rb"
+    end
   end
 
   def configure_cache_store_adapter
     gsub_file Pathname.new(destination_root).join("config/environments/production.rb"),
       /(# )?config\.cache_store = (:.*)/, "config.cache_store = :solid_cache_store"
   end
+
+  private
+    def copy_sql_schema_for_adapter
+      sql_file = sql_schema_file_for_adapter
+
+      if sql_file
+        copy_file sql_file, "db/cache_structure.sql"
+      else
+        raise_unsupported_adapter_error
+      end
+    end
+
+    def sql_schema_file_for_adapter
+      case ActiveRecord::Base.connection_db_config.adapter
+      when "postgresql"
+        "db/cache_structure.postgresql.sql"
+      when "mysql2", "trilogy"
+        "db/cache_structure.mysql.sql"
+      when "sqlite3"
+        "db/cache_structure.sqlite3.sql"
+      else
+        nil
+      end
+    end
+
+    def raise_unsupported_adapter_error
+      error_message = <<~ERROR
+
+        ERROR: Unsupported database adapter for SQL schema format: #{adapter.inspect}
+
+        SolidCache supports installing for the following Rails adapters with schema_format = :sql:
+          - PostgreSQL (postgresql)
+          - MySQL (mysql2, trilogy)
+          - SQLite (sqlite3)
+      ERROR
+
+      raise error_message
+    end
 end

data/lib/generators/solid_cache/install/templates/config/cache.yml.tt

@@ -1,4 +1,5 @@
 default: &default
+  database: <%= ENV.fetch("DATABASE", "cache") %>
   store_options:
     # Cap age of oldest cache entry to fulfill retention policies
     # max_age: <%%= 60.days.to_i %>
@@ -12,5 +13,4 @@ test:
   <<: *default
 
 production:
-  database: <%= ENV.fetch("DATABASE", "cache") %>
   <<: *default

data/lib/generators/solid_cache/install/templates/db/cache_schema.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 ActiveRecord::Schema[7.2].define(version: 1) do
   create_table "solid_cache_entries", force: :cascade do |t|
     t.binary "key", limit: 1024, null: false

data/lib/generators/solid_cache/install/templates/db/cache_structure.mysql.sql

@@ -0,0 +1,56 @@
+
+/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
+/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
+/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
+/*!50503 SET NAMES utf8mb4 */;
+/*!40103 SET @OLD_TIME_ZONE=@@TIME_ZONE */;
+/*!40103 SET TIME_ZONE='+00:00' */;
+/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;
+/*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;
+/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;
+/*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;
+DROP TABLE IF EXISTS `ar_internal_metadata`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `ar_internal_metadata` (
+  `key` varchar(255) NOT NULL,
+  `value` varchar(255) DEFAULT NULL,
+  `created_at` datetime(6) NOT NULL,
+  `updated_at` datetime(6) NOT NULL,
+  PRIMARY KEY (`key`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;
+/*!40101 SET character_set_client = @saved_cs_client */;
+DROP TABLE IF EXISTS `schema_migrations`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `schema_migrations` (
+  `version` varchar(255) NOT NULL,
+  PRIMARY KEY (`version`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;
+/*!40101 SET character_set_client = @saved_cs_client */;
+DROP TABLE IF EXISTS `solid_cache_entries`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `solid_cache_entries` (
+  `id` bigint NOT NULL AUTO_INCREMENT,
+  `key` varbinary(1024) NOT NULL,
+  `value` longblob NOT NULL,
+  `created_at` datetime(6) NOT NULL,
+  `key_hash` bigint NOT NULL,
+  `byte_size` int NOT NULL,
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `index_solid_cache_entries_on_key_hash` (`key_hash`),
+  KEY `index_solid_cache_entries_on_byte_size` (`byte_size`),
+  KEY `index_solid_cache_entries_on_key_hash_and_byte_size` (`key_hash`,`byte_size`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;
+/*!40101 SET character_set_client = @saved_cs_client */;
+/*!40103 SET TIME_ZONE=@OLD_TIME_ZONE */;
+
+/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;
+/*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;
+/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */;
+/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
+/*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;
+/*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;
+/*!40111 SET SQL_NOTES=@OLD_SQL_NOTES */;
+

data/lib/generators/solid_cache/install/templates/db/cache_structure.postgresql.sql

@@ -0,0 +1,128 @@
+SET statement_timeout = 0;
+SET lock_timeout = 0;
+SET idle_in_transaction_session_timeout = 0;
+SET transaction_timeout = 0;
+SET client_encoding = 'UTF8';
+SET standard_conforming_strings = on;
+SELECT pg_catalog.set_config('search_path', '', false);
+SET check_function_bodies = false;
+SET xmloption = content;
+SET client_min_messages = warning;
+SET row_security = off;
+
+SET default_tablespace = '';
+
+SET default_table_access_method = heap;
+
+--
+-- Name: ar_internal_metadata; Type: TABLE; Schema: public; Owner: -
+--
+
+CREATE TABLE public.ar_internal_metadata (
+    key character varying NOT NULL,
+    value character varying,
+    created_at timestamp(6) without time zone NOT NULL,
+    updated_at timestamp(6) without time zone NOT NULL
+);
+
+
+--
+-- Name: schema_migrations; Type: TABLE; Schema: public; Owner: -
+--
+
+CREATE TABLE public.schema_migrations (
+    version character varying NOT NULL
+);
+
+
+--
+-- Name: solid_cache_entries; Type: TABLE; Schema: public; Owner: -
+--
+
+CREATE TABLE public.solid_cache_entries (
+    id bigint NOT NULL,
+    key bytea NOT NULL,
+    value bytea NOT NULL,
+    created_at timestamp(6) without time zone NOT NULL,
+    key_hash bigint NOT NULL,
+    byte_size integer NOT NULL
+);
+
+
+--
+-- Name: solid_cache_entries_id_seq; Type: SEQUENCE; Schema: public; Owner: -
+--
+
+CREATE SEQUENCE public.solid_cache_entries_id_seq
+    START WITH 1
+    INCREMENT BY 1
+    NO MINVALUE
+    NO MAXVALUE
+    CACHE 1;
+
+
+--
+-- Name: solid_cache_entries_id_seq; Type: SEQUENCE OWNED BY; Schema: public; Owner: -
+--
+
+ALTER SEQUENCE public.solid_cache_entries_id_seq OWNED BY public.solid_cache_entries.id;
+
+
+--
+-- Name: solid_cache_entries id; Type: DEFAULT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY public.solid_cache_entries ALTER COLUMN id SET DEFAULT nextval('public.solid_cache_entries_id_seq'::regclass);
+
+
+--
+-- Name: ar_internal_metadata ar_internal_metadata_pkey; Type: CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY public.ar_internal_metadata
+    ADD CONSTRAINT ar_internal_metadata_pkey PRIMARY KEY (key);
+
+
+--
+-- Name: schema_migrations schema_migrations_pkey; Type: CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY public.schema_migrations
+    ADD CONSTRAINT schema_migrations_pkey PRIMARY KEY (version);
+
+
+--
+-- Name: solid_cache_entries solid_cache_entries_pkey; Type: CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY public.solid_cache_entries
+    ADD CONSTRAINT solid_cache_entries_pkey PRIMARY KEY (id);
+
+
+--
+-- Name: index_solid_cache_entries_on_byte_size; Type: INDEX; Schema: public; Owner: -
+--
+
+CREATE INDEX index_solid_cache_entries_on_byte_size ON public.solid_cache_entries USING btree (byte_size);
+
+
+--
+-- Name: index_solid_cache_entries_on_key_hash; Type: INDEX; Schema: public; Owner: -
+--
+
+CREATE UNIQUE INDEX index_solid_cache_entries_on_key_hash ON public.solid_cache_entries USING btree (key_hash);
+
+
+--
+-- Name: index_solid_cache_entries_on_key_hash_and_byte_size; Type: INDEX; Schema: public; Owner: -
+--
+
+CREATE INDEX index_solid_cache_entries_on_key_hash_and_byte_size ON public.solid_cache_entries USING btree (key_hash, byte_size);
+
+
+--
+-- PostgreSQL database dump complete
+--
+
+SET search_path TO "$user", public;
+

data/lib/generators/solid_cache/install/templates/db/cache_structure.sqlite3.sql

@@ -0,0 +1,6 @@
+CREATE TABLE IF NOT EXISTS "schema_migrations" ("version" varchar NOT NULL PRIMARY KEY);
+CREATE TABLE IF NOT EXISTS "ar_internal_metadata" ("key" varchar NOT NULL PRIMARY KEY, "value" varchar, "created_at" datetime(6) NOT NULL, "updated_at" datetime(6) NOT NULL);
+CREATE TABLE IF NOT EXISTS "solid_cache_entries" ("id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "key" blob(1024) NOT NULL, "value" blob(536870912) NOT NULL, "created_at" datetime(6) NOT NULL, "key_hash" integer(8) NOT NULL, "byte_size" integer(4) NOT NULL);
+CREATE INDEX "index_solid_cache_entries_on_byte_size" ON "solid_cache_entries" ("byte_size");
+CREATE INDEX "index_solid_cache_entries_on_key_hash_and_byte_size" ON "solid_cache_entries" ("key_hash", "byte_size");
+CREATE UNIQUE INDEX "index_solid_cache_entries_on_key_hash" ON "solid_cache_entries" ("key_hash");

data/lib/solid_cache/configuration.rb

@@ -37,7 +37,7 @@ module SolidCache
           when database
             { shards: { database.to_sym => { writing: database.to_sym } } }
           when databases
-            { shards: databases.map(&:to_sym).index_with { |database| { writing: database } } }
+            { shards: Array(databases).map(&:to_sym).index_with { |database| { writing: database } } }
           when connects_to
             connects_to
           else

data/lib/solid_cache/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidCache
-  VERSION = "1.0.8"
+  VERSION = "1.0.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solid_cache
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Donal McBreen
@@ -116,6 +116,9 @@ files:
 - lib/generators/solid_cache/install/install_generator.rb
 - lib/generators/solid_cache/install/templates/config/cache.yml.tt
 - lib/generators/solid_cache/install/templates/db/cache_schema.rb
+- lib/generators/solid_cache/install/templates/db/cache_structure.mysql.sql
+- lib/generators/solid_cache/install/templates/db/cache_structure.postgresql.sql
+- lib/generators/solid_cache/install/templates/db/cache_structure.sqlite3.sql
 - lib/solid_cache.rb
 - lib/solid_cache/configuration.rb
 - lib/solid_cache/connections.rb