Change json datatype to jsonb, if available.

Also update existing text columns to jsonb and json.

Signed-off-by: Clemens Gruber <[email protected]>

Author: clemensg

README.md

@@ -239,9 +239,9 @@ All configuration takes place in the form of environment vars. See [queue_classi
 
 ## JSON
 
-If you are running PostgreSQL 9.2 or higher, queue_classic will use the [json](http://www.postgresql.org/docs/9.2/static/datatype-json.html) datatype for storing arguments. Versions 9.1 and lower will use the 'text' column. If you have installed queue_classic prior to version 2.1.4 and are running PostgreSQL >= 9.2, run the following to switch to using the json type:
+If you are running PostgreSQL 9.4 or higher, queue_classic will use the [jsonb](http://www.postgresql.org/docs/9.4/static/datatype-json.html) datatype for storing arguments. Versions 9.2 and 9.3 will use the `json` data type and versions 9.1 and lower will use the `text` data type. If you have installed queue_classic prior to version 2.1.4 and are running PostgreSQL >= 9.4, run the following to switch to using the `jsonb` type:
 ```
-alter table queue_classic_jobs alter column args type json using (args::json);
+alter table queue_classic_jobs alter column args type jsonb using (args::jsonb);
 ```
 
 ## Logging

changelog

@@ -1,5 +1,7 @@
 Unreleased
 - Fixed a bug in the offset calculation of `.enqueue_at`.
+- Use jsonb type for the args column, if available. Otherwise fall back to
+  json type or keep using text. Also added a migration to update old schemas.
 
 Version 3.0.0rc
 - Improved signal handling

lib/generators/queue_classic/install_generator.rb

@@ -31,6 +31,10 @@ def create_migration_file
       if self.class.migration_exists?('db/migrate', 'update_queue_classic_3_1_0').nil?
         migration_template 'update_queue_classic_3_1_0.rb', 'db/migrate/update_queue_classic_3_1_0.rb'
       end
+
+      if self.class.migration_exists?('db/migrate', 'update_queue_classic_3_2_0').nil?
+        migration_template 'update_queue_classic_3_2_0.rb', 'db/migrate/update_queue_classic_3_2_0.rb'
+      end
     end
   end
 end

lib/generators/queue_classic/templates/update_queue_classic_3_2_0.rb

@@ -0,0 +1,9 @@
+class UpdateQueueClassic320 < ActiveRecord::Migration
+  def self.up
+    QC::Setup.update_to_3_2_0
+  end
+
+  def self.down
+    QC::Setup.downgrade_from_3_2_0
+  end
+end

lib/queue_classic/setup.rb

@@ -8,6 +8,8 @@ module Setup
     DowngradeFrom_3_0_0 = File.join(Root, "/sql/downgrade_from_3_0_0.sql")
     UpgradeTo_3_1_0 = File.join(Root, "/sql/update_to_3_1_0.sql")
     DowngradeFrom_3_1_0 = File.join(Root, "/sql/downgrade_from_3_1_0.sql")
+    UpgradeTo_3_2_0 = File.join(Root, "/sql/update_to_3_2_0.sql")
+    DowngradeFrom_3_2_0 = File.join(Root, "/sql/downgrade_from_3_2_0.sql")
 
     def self.create(c = QC::default_conn_adapter.connection)
       conn = QC::ConnAdapter.new(c)
@@ -27,6 +29,7 @@ def self.update(c = QC::default_conn_adapter.connection)
       conn = QC::ConnAdapter.new(c)
       conn.execute(File.read(UpgradeTo_3_0_0))
       conn.execute(File.read(UpgradeTo_3_1_0))
+      conn.execute(File.read(UpgradeTo_3_2_0))
       conn.execute(File.read(DropSqlFunctions))
       conn.execute(File.read(SqlFunctions))
     end
@@ -54,5 +57,15 @@ def self.downgrade_from_3_1_0(c = QC::default_conn_adapter.connection)
       conn = QC::ConnAdapter.new(c)
       conn.execute(File.read(DowngradeFrom_3_1_0))
     end
+
+    def self.update_to_3_2_0(c = QC::default_conn_adapter.connection)
+      conn = QC::ConnAdapter.new(c)
+      conn.execute(File.read(UpgradeTo_3_2_0))
+    end
+
+    def self.downgrade_from_3_2_0(c = QC::default_conn_adapter.connection)
+      conn = QC::ConnAdapter.new(c)
+      conn.execute(File.read(DowngradeFrom_3_2_0))
+    end
   end
 end

sql/create_table.sql

@@ -11,10 +11,12 @@ CREATE TABLE queue_classic_jobs (
   scheduled_at timestamptz default now()
 );
 
--- If json type is available, use it for the args column.
-perform * from pg_type where typname = 'json';
-if found then
-  alter table queue_classic_jobs alter column args type json using (args::json);
+-- If jsonb type is available, use it for the args column
+if exists (select 1 from pg_type where typname = 'jsonb') then
+  alter table queue_classic_jobs alter column args type jsonb using args::jsonb;
+-- Otherwise, use json type for the args column if available
+elsif exists (select 1 from pg_type where typname = 'json') then
+  alter table queue_classic_jobs alter column args type json using args::json;
 end if;
 
 end $$ language plpgsql;

sql/downgrade_from_3_2_0.sql

@@ -0,0 +1,11 @@
+do $$ begin
+
+-- If json type is available, use it for the args column
+if exists (select 1 from pg_type where typname = 'json') then
+  alter table queue_classic_jobs alter column args type json using args::json;
+-- Otherwise use the text type for the args column
+else
+  alter table queue_classic_jobs alter column args type text using args::text;
+end if;
+
+end $$ language plpgsql;

sql/update_to_3_2_0.sql

@@ -0,0 +1,14 @@
+do $$ begin
+
+-- If jsonb type is available, use it for the args column
+if exists (select 1 from pg_type where typname = 'jsonb') then
+  alter table queue_classic_jobs alter column args type jsonb using args::jsonb;
+-- Otherwise, use json type for the args column if available
+elsif exists (select 1 from pg_type where typname = 'json') then
+  alter table queue_classic_jobs alter column args type json using args::json;
+-- Keep using text type for the args column, if neither is available
+else
+  alter table queue_classic_jobs alter column args type text using args::text;
+end if;
+
+end $$ language plpgsql;