Add index on pending_changes <> '{}'

thomasleese · thomasleese · commit a3dff9e3490b · 2025-09-16T10:30:50.000+01:00
This `WHERE` clause is used on each page to render the count of import
issues in the navigation bar, therefore we should try and speed up this
query as it will have an impact on every page render. Adding an index on
this filter should ensure that selecting the number of patients or
vaccination records with import issues is quicker.

Jira-Issue: MAV-2001
diff --git a/app/models/patient.rb b/app/models/patient.rb
@@ -33,13 +33,14 @@
 #
 # Indexes
 #
-#  index_patients_on_family_name_trigram  (family_name) USING gin
-#  index_patients_on_given_name_trigram   (given_name) USING gin
-#  index_patients_on_gp_practice_id       (gp_practice_id)
-#  index_patients_on_names_family_first   (family_name,given_name)
-#  index_patients_on_names_given_first    (given_name,family_name)
-#  index_patients_on_nhs_number           (nhs_number) UNIQUE
-#  index_patients_on_school_id            (school_id)
+#  index_patients_on_family_name_trigram        (family_name) USING gin
+#  index_patients_on_given_name_trigram         (given_name) USING gin
+#  index_patients_on_gp_practice_id             (gp_practice_id)
+#  index_patients_on_names_family_first         (family_name,given_name)
+#  index_patients_on_names_given_first          (given_name,family_name)
+#  index_patients_on_nhs_number                 (nhs_number) UNIQUE
+#  index_patients_on_pending_changes_not_empty  (id) WHERE (pending_changes <> '{}'::jsonb)
+#  index_patients_on_school_id                  (school_id)
 #
 # Foreign Keys
 #
diff --git a/app/models/vaccination_record.rb b/app/models/vaccination_record.rb
@@ -40,17 +40,18 @@
 #
 # Indexes
 #
-#  index_vaccination_records_on_batch_id                  (batch_id)
-#  index_vaccination_records_on_discarded_at              (discarded_at)
-#  index_vaccination_records_on_location_id               (location_id)
-#  index_vaccination_records_on_nhs_immunisations_api_id  (nhs_immunisations_api_id) UNIQUE
-#  index_vaccination_records_on_patient_id                (patient_id)
-#  index_vaccination_records_on_performed_by_user_id      (performed_by_user_id)
-#  index_vaccination_records_on_programme_id              (programme_id)
-#  index_vaccination_records_on_session_id                (session_id)
-#  index_vaccination_records_on_supplied_by_user_id       (supplied_by_user_id)
-#  index_vaccination_records_on_uuid                      (uuid) UNIQUE
-#  index_vaccination_records_on_vaccine_id                (vaccine_id)
+#  index_vaccination_records_on_batch_id                   (batch_id)
+#  index_vaccination_records_on_discarded_at               (discarded_at)
+#  index_vaccination_records_on_location_id                (location_id)
+#  index_vaccination_records_on_nhs_immunisations_api_id   (nhs_immunisations_api_id) UNIQUE
+#  index_vaccination_records_on_patient_id                 (patient_id)
+#  index_vaccination_records_on_pending_changes_not_empty  (id) WHERE (pending_changes <> '{}'::jsonb)
+#  index_vaccination_records_on_performed_by_user_id       (performed_by_user_id)
+#  index_vaccination_records_on_programme_id               (programme_id)
+#  index_vaccination_records_on_session_id                 (session_id)
+#  index_vaccination_records_on_supplied_by_user_id        (supplied_by_user_id)
+#  index_vaccination_records_on_uuid                       (uuid) UNIQUE
+#  index_vaccination_records_on_vaccine_id                 (vaccine_id)
 #
 # Foreign Keys
 #
diff --git a/db/migrate/20250916074716_add_index_on_pending_changes_not_empty.rb b/db/migrate/20250916074716_add_index_on_pending_changes_not_empty.rb
@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class AddIndexOnPendingChangesNotEmpty < ActiveRecord::Migration[8.0]
+  disable_ddl_transaction!
+
+  def change
+    add_index :patients,
+              :id,
+              where: "pending_changes <> '{}'",
+              algorithm: :concurrently,
+              name: "index_patients_on_pending_changes_not_empty"
+    add_index :vaccination_records,
+              :id,
+              where: "pending_changes <> '{}'",
+              algorithm: :concurrently,
+              name: "index_vaccination_records_on_pending_changes_not_empty"
+  end
+end
diff --git a/db/schema.rb b/db/schema.rb
@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[8.0].define(version: 2025_09_12_134432) do
+ActiveRecord::Schema[8.0].define(version: 2025_09_16_074716) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "pg_catalog.plpgsql"
   enable_extension "pg_trgm"
@@ -715,6 +715,7 @@
     t.index ["given_name", "family_name"], name: "index_patients_on_names_given_first"
     t.index ["given_name"], name: "index_patients_on_given_name_trigram", opclass: :gin_trgm_ops, using: :gin
     t.index ["gp_practice_id"], name: "index_patients_on_gp_practice_id"
+    t.index ["id"], name: "index_patients_on_pending_changes_not_empty", where: "(pending_changes <> '{}'::jsonb)"
     t.index ["nhs_number"], name: "index_patients_on_nhs_number", unique: true
     t.index ["school_id"], name: "index_patients_on_school_id"
   end
@@ -1013,6 +1014,7 @@
     t.integer "source", null: false
     t.index ["batch_id"], name: "index_vaccination_records_on_batch_id"
     t.index ["discarded_at"], name: "index_vaccination_records_on_discarded_at"
+    t.index ["id"], name: "index_vaccination_records_on_pending_changes_not_empty", where: "(pending_changes <> '{}'::jsonb)"
     t.index ["location_id"], name: "index_vaccination_records_on_location_id"
     t.index ["nhs_immunisations_api_id"], name: "index_vaccination_records_on_nhs_immunisations_api_id", unique: true
     t.index ["patient_id"], name: "index_vaccination_records_on_patient_id"
diff --git a/spec/factories/patients.rb b/spec/factories/patients.rb
@@ -33,13 +33,14 @@
 #
 # Indexes
 #
-#  index_patients_on_family_name_trigram  (family_name) USING gin
-#  index_patients_on_given_name_trigram   (given_name) USING gin
-#  index_patients_on_gp_practice_id       (gp_practice_id)
-#  index_patients_on_names_family_first   (family_name,given_name)
-#  index_patients_on_names_given_first    (given_name,family_name)
-#  index_patients_on_nhs_number           (nhs_number) UNIQUE
-#  index_patients_on_school_id            (school_id)
+#  index_patients_on_family_name_trigram        (family_name) USING gin
+#  index_patients_on_given_name_trigram         (given_name) USING gin
+#  index_patients_on_gp_practice_id             (gp_practice_id)
+#  index_patients_on_names_family_first         (family_name,given_name)
+#  index_patients_on_names_given_first          (given_name,family_name)
+#  index_patients_on_nhs_number                 (nhs_number) UNIQUE
+#  index_patients_on_pending_changes_not_empty  (id) WHERE (pending_changes <> '{}'::jsonb)
+#  index_patients_on_school_id                  (school_id)
 #
 # Foreign Keys
 #
diff --git a/spec/factories/vaccination_records.rb b/spec/factories/vaccination_records.rb
@@ -40,17 +40,18 @@
 #
 # Indexes
 #
-#  index_vaccination_records_on_batch_id                  (batch_id)
-#  index_vaccination_records_on_discarded_at              (discarded_at)
-#  index_vaccination_records_on_location_id               (location_id)
-#  index_vaccination_records_on_nhs_immunisations_api_id  (nhs_immunisations_api_id) UNIQUE
-#  index_vaccination_records_on_patient_id                (patient_id)
-#  index_vaccination_records_on_performed_by_user_id      (performed_by_user_id)
-#  index_vaccination_records_on_programme_id              (programme_id)
-#  index_vaccination_records_on_session_id                (session_id)
-#  index_vaccination_records_on_supplied_by_user_id       (supplied_by_user_id)
-#  index_vaccination_records_on_uuid                      (uuid) UNIQUE
-#  index_vaccination_records_on_vaccine_id                (vaccine_id)
+#  index_vaccination_records_on_batch_id                   (batch_id)
+#  index_vaccination_records_on_discarded_at               (discarded_at)
+#  index_vaccination_records_on_location_id                (location_id)
+#  index_vaccination_records_on_nhs_immunisations_api_id   (nhs_immunisations_api_id) UNIQUE
+#  index_vaccination_records_on_patient_id                 (patient_id)
+#  index_vaccination_records_on_pending_changes_not_empty  (id) WHERE (pending_changes <> '{}'::jsonb)
+#  index_vaccination_records_on_performed_by_user_id       (performed_by_user_id)
+#  index_vaccination_records_on_programme_id               (programme_id)
+#  index_vaccination_records_on_session_id                 (session_id)
+#  index_vaccination_records_on_supplied_by_user_id        (supplied_by_user_id)
+#  index_vaccination_records_on_uuid                       (uuid) UNIQUE
+#  index_vaccination_records_on_vaccine_id                 (vaccine_id)
 #
 # Foreign Keys
 #
diff --git a/spec/models/patient_spec.rb b/spec/models/patient_spec.rb
@@ -33,13 +33,14 @@
 #
 # Indexes
 #
-#  index_patients_on_family_name_trigram  (family_name) USING gin
-#  index_patients_on_given_name_trigram   (given_name) USING gin
-#  index_patients_on_gp_practice_id       (gp_practice_id)
-#  index_patients_on_names_family_first   (family_name,given_name)
-#  index_patients_on_names_given_first    (given_name,family_name)
-#  index_patients_on_nhs_number           (nhs_number) UNIQUE
-#  index_patients_on_school_id            (school_id)
+#  index_patients_on_family_name_trigram        (family_name) USING gin
+#  index_patients_on_given_name_trigram         (given_name) USING gin
+#  index_patients_on_gp_practice_id             (gp_practice_id)
+#  index_patients_on_names_family_first         (family_name,given_name)
+#  index_patients_on_names_given_first          (given_name,family_name)
+#  index_patients_on_nhs_number                 (nhs_number) UNIQUE
+#  index_patients_on_pending_changes_not_empty  (id) WHERE (pending_changes <> '{}'::jsonb)
+#  index_patients_on_school_id                  (school_id)
 #
 # Foreign Keys
 #
diff --git a/spec/models/vaccination_record_spec.rb b/spec/models/vaccination_record_spec.rb
@@ -40,17 +40,18 @@
 #
 # Indexes
 #
-#  index_vaccination_records_on_batch_id                  (batch_id)
-#  index_vaccination_records_on_discarded_at              (discarded_at)
-#  index_vaccination_records_on_location_id               (location_id)
-#  index_vaccination_records_on_nhs_immunisations_api_id  (nhs_immunisations_api_id) UNIQUE
-#  index_vaccination_records_on_patient_id                (patient_id)
-#  index_vaccination_records_on_performed_by_user_id      (performed_by_user_id)
-#  index_vaccination_records_on_programme_id              (programme_id)
-#  index_vaccination_records_on_session_id                (session_id)
-#  index_vaccination_records_on_supplied_by_user_id       (supplied_by_user_id)
-#  index_vaccination_records_on_uuid                      (uuid) UNIQUE
-#  index_vaccination_records_on_vaccine_id                (vaccine_id)
+#  index_vaccination_records_on_batch_id                   (batch_id)
+#  index_vaccination_records_on_discarded_at               (discarded_at)
+#  index_vaccination_records_on_location_id                (location_id)
+#  index_vaccination_records_on_nhs_immunisations_api_id   (nhs_immunisations_api_id) UNIQUE
+#  index_vaccination_records_on_patient_id                 (patient_id)
+#  index_vaccination_records_on_pending_changes_not_empty  (id) WHERE (pending_changes <> '{}'::jsonb)
+#  index_vaccination_records_on_performed_by_user_id       (performed_by_user_id)
+#  index_vaccination_records_on_programme_id               (programme_id)
+#  index_vaccination_records_on_session_id                 (session_id)
+#  index_vaccination_records_on_supplied_by_user_id        (supplied_by_user_id)
+#  index_vaccination_records_on_uuid                       (uuid) UNIQUE
+#  index_vaccination_records_on_vaccine_id                 (vaccine_id)
 #
 # Foreign Keys
 #

Original file line number	Diff line number	Diff line change
`@@ -33,13 +33,14 @@`
`33`	`33`	`#`
`34`	`34`	`# Indexes`
`35`	`35`	`#`
`36`		`-# index_patients_on_family_name_trigram (family_name) USING gin`
`37`		`-# index_patients_on_given_name_trigram (given_name) USING gin`
`38`		`-# index_patients_on_gp_practice_id (gp_practice_id)`
`39`		`-# index_patients_on_names_family_first (family_name,given_name)`
`40`		`-# index_patients_on_names_given_first (given_name,family_name)`
`41`		`-# index_patients_on_nhs_number (nhs_number) UNIQUE`
`42`		`-# index_patients_on_school_id (school_id)`
	`36`	`+# index_patients_on_family_name_trigram (family_name) USING gin`
	`37`	`+# index_patients_on_given_name_trigram (given_name) USING gin`
	`38`	`+# index_patients_on_gp_practice_id (gp_practice_id)`
	`39`	`+# index_patients_on_names_family_first (family_name,given_name)`
	`40`	`+# index_patients_on_names_given_first (given_name,family_name)`
	`41`	`+# index_patients_on_nhs_number (nhs_number) UNIQUE`
	`42`	`+# index_patients_on_pending_changes_not_empty (id) WHERE (pending_changes <> '{}'::jsonb)`
	`43`	`+# index_patients_on_school_id (school_id)`
`43`	`44`	`#`
`44`	`45`	`# Foreign Keys`
`45`	`46`	`#`