Add missing indexes for foreign keys on postgres

db/migrations/20231114130216_add_missing_fk_indexes.rb

@@ -0,0 +1,51 @@
+def migration_name(table, columns)
+  "#{table}_#{columns.join('_')}_index"
+end
+
+Sequel.migration do
+  foreign_key_indexes = [
+    { table: :organizations, columns: %i[quota_definition_id] },
+    { table: :organizations, columns: %i[guid default_isolation_segment_guid] },
+    { table: :domains, columns: %i[owning_organization_id] },
+    { table: :spaces, columns: %i[isolation_segment_guid] },
+    { table: :routes, columns: %i[domain_id] },
+    { table: :routes, columns: %i[space_id] },
+    { table: :users, columns: %i[default_space_id] },
+    { table: :organizations_users, columns: %i[user_id] },
+    { table: :organizations_managers, columns: %i[user_id] },
+    { table: :organizations_billing_managers, columns: %i[user_id] },
+    { table: :organizations_auditors, columns: %i[user_id] },
+    { table: :spaces_developers, columns: %i[user_id] },
+    { table: :spaces_managers, columns: %i[user_id] },
+    { table: :spaces_auditors, columns: %i[user_id] },
+    { table: :organizations_private_domains, columns: %i[private_domain_id] },
+    { table: :route_bindings, columns: %i[route_id] },
+    { table: :route_bindings, columns: %i[service_instance_id] },
+    { table: :organizations_isolation_segments, columns: %i[isolation_segment_guid] },
+    { table: :staging_security_groups_spaces, columns: %i[staging_space_id] },
+    { table: :service_instance_shares, columns: %i[target_space_guid] },
+    { table: :job_warnings, columns: %i[fk_jobs_id] },
+    { table: :service_broker_update_requests, columns: %i[fk_service_brokers_id] },
+    { table: :kpack_lifecycle_data, columns: %i[app_guid] },
+    { table: :spaces_supporters, columns: %i[user_id] },
+    { table: :route_shares, columns: %i[target_space_guid] }
+  ]
+
+  no_transaction # Disable automatic transactions
+
+  up do
+    if database_type == :postgres
+      foreign_key_indexes.each do |index|
+        add_index index[:table], index[:columns], name: migration_name(index[:table], index[:columns]), concurrently: true, if_not_exists: true
+      end
+    end
+  end
+
+  down do
+    if database_type == :postgres
+      foreign_key_indexes.each do |index|
+        drop_index index[:table], nil, name: migration_name(index[:table], index[:columns]), concurrently: true, if_exists: true
+      end
+    end
+  end
+end

spec/migrations/Readme.md

@@ -17,6 +17,8 @@ At present, the Cloud Controller (CC) supports both Postgres and MySQL in variou
 1. A size should always be specified for a string (and text should not be used). Postgres and MySQL have different size limits on String and TEXT fields. To ensure data can be migrated across the two databases (and others in future) without issues, a maximum size should always be specified. A rubocop linter has enforced this since 2017-07-30.
    1. For MySQL, `String` is `varchar(255)`, `String, text: true` has a max size of 16_000 for UTF-8-encoded DBs.
    1. For Postgres, both `String` and `String, text: true` are TEXT and have a max size of ~1GB.
+1. In Postgres, default indexes are established for primary key and unique key columns. Conversely, an index for a foreign key column isn't automatically generated - it has to be manually added via a migration. In contrast to this, MySQL automatically creates these indexes.
+
 
 ### Rules when writing migrations