# frozen_string_literal: true module Gitlab module Database module AsyncIndexes module MigrationHelpers def unprepare_async_index(table_name, column_name, **options) return unless async_index_creation_available? index_name = options[:name] || index_name(table_name, column_name) raise 'Specifying index name is mandatory - specify name: argument' unless index_name unprepare_async_index_by_name(table_name, index_name) end def unprepare_async_index_by_name(table_name, index_name, **options) return unless async_index_creation_available? PostgresAsyncIndex.find_by(name: index_name).try do |async_index| async_index.destroy end end # Prepares an index for asynchronous creation. # # Stores the index information in the postgres_async_indexes table to be created later. The # index will be always be created CONCURRENTLY, so that option does not need to be given. # If an existing asynchronous definition exists with the same name, the existing entry will be # updated with the new definition. # # If the requested index has already been created, it is not stored in the table for # asynchronous creation. def prepare_async_index(table_name, column_name, **options) return unless async_index_creation_available? index_name = options[:name] || index_name(table_name, column_name) raise 'Specifying index name is mandatory - specify name: argument' unless index_name options = options.merge({ algorithm: :concurrently }) if index_exists?(table_name, column_name, **options) Gitlab::AppLogger.warn( message: 'Index not prepared because it already exists', table_name: table_name, index_name: index_name) return end index, algorithm, if_not_exists = add_index_options(table_name, column_name, **options) create_index = ActiveRecord::ConnectionAdapters::CreateIndexDefinition.new(index, algorithm, if_not_exists) schema_creation = ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaCreation.new(ApplicationRecord.connection) definition = schema_creation.accept(create_index) async_index = PostgresAsyncIndex.safe_find_or_create_by!(name: index_name) do |rec| rec.table_name = table_name rec.definition = definition end Gitlab::AppLogger.info( message: 'Prepared index for async creation', table_name: async_index.table_name, index_name: async_index.name) async_index end private def async_index_creation_available? ApplicationRecord.connection.table_exists?(:postgres_async_indexes) && Feature.enabled?(:database_async_index_creation, type: :ops) end end end end end