ActiveRecord::Relation methods for fluent force-index and index-hint query modifications with CockroachDB-specific syntax

crdb_index_hint_extensions.rb

module ActiveRecord
  class Relation
    def force_index(index_name, direction: nil)
      directionality = direction.to_s.upcase
      directionality = directionality.in?(%w[ASC DESC]) ? ",#{directionality}" : ""

      @crdb_force_index = "FORCE_INDEX=#{index_name}#{directionality}"
      compiled_index_hint_text
    end

    def index_hint(hint_lable)
      @crdb_index_hint = hint_lable.to_s
      compiled_index_hint_text
    end

    private

    def compiled_index_hint_text
      force_index = @crdb_force_index || ""
      index_hint = @crdb_index_hint || ""
      index_hint += "," if [index_hint, force_index].all?(&:present?)
      self.from("#{self.quoted_table_name}@{#{index_hint + force_index}}")
    end
  end
end