Class: FullSearch::Index

Inherits:
Object
  • Object
show all
Defined in:
lib/full_search/index.rb

Class Method Summary collapse

Class Method Details

.create_triggers!(model) ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/full_search/index.rb', line 119

def create_triggers!(model)
  connection.execute(insert_trigger_sql(model))
  connection.execute(delete_trigger_sql(model))
  connection.execute(update_trigger_sql(model))
  if model.full_search_dsl.soft_delete_column
    connection.execute(soft_delete_removal_trigger_sql(model))
  end
  if model.full_search_dsl.typo_tolerance?
    connection.execute(insert_trigram_trigger_sql(model))
    connection.execute(delete_trigram_trigger_sql(model))
    connection.execute(update_trigram_trigger_sql(model))
  end
end

.drop!(model) ⇒ Object 



139
140
141
142
143
144
145
 
# File 'lib/full_search/index.rb', line 139

def drop!(model)
  verified_tables.delete(model.table_name)
  sqlite!(model)
  drop_triggers!(model)
  connection.execute("DROP TABLE IF EXISTS #{qt(fts_table_name(model))};")
  connection.execute("DROP TABLE IF EXISTS #{qt(trigram_table_name(model))};")
end

.drop_triggers!(model) ⇒ Object 



133
134
135
136
137
 
# File 'lib/full_search/index.rb', line 133

def drop_triggers!(model)
  (trigger_names(model) + trigram_trigger_names(model)).each do |name|
    connection.execute("DROP TRIGGER IF EXISTS #{qt(name)};")
  end
end

.ensure_table!(model) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/full_search/index.rb', line 21

def ensure_table!(model)
  return if model.respond_to?(:table_name) && verified_tables.include?(model.table_name)

  sqlite!(model)

  conn = connection
  dsl = model.full_search_dsl
  return unless dsl

  create_metadata_table!

  fts_was_created = false
  unless table_exists?(model)
    conn.execute(create_virtual_table_sql(model))
    fts_was_created = true
  end

  trigram_was_created = false
  if dsl.typo_tolerance? && !trigram_table_exists?(model)
    FullSearch::Typo.warn_unsupported!(model) unless FullSearch::Typo.supported?(model)
    conn.execute(create_trigram_virtual_table_sql(model))
    trigram_was_created = true
  end

  if fts_was_created || trigram_was_created
    conn.execute(backfill_sql(model)) if fts_was_created
    conn.execute(backfill_trigram_sql(model)) if trigram_was_created
    reindex_source_fields!(model) if dsl.fields.any?(&:source)
    store_config_hash!(model)
  end

  ensure_triggers!(model) if model_table_exists?(model)

  verified_tables.add(model.table_name)
end

.fts_table_name(model) ⇒ Object 



147
148
149
 
# File 'lib/full_search/index.rb', line 147

def fts_table_name(model)
  "#{model.table_name}_fts"
end

.missing_table?(model) ⇒ Boolean

Returns:

  • (Boolean) 


177
178
179
 
# File 'lib/full_search/index.rb', line 177

def missing_table?(model)
  !table_exists?(model)
end

.optimize!(model) ⇒ Object 



103
104
105
106
 
# File 'lib/full_search/index.rb', line 103

def optimize!(model)
  sqlite!(model)
  connection.execute("INSERT INTO #{qt(fts_table_name(model))}(#{qt(fts_table_name(model))}) VALUES('optimize');")
end

.rebuild!(model) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/full_search/index.rb', line 57

def rebuild!(model)
  sqlite!(model)

  dsl = model.full_search_dsl
  return unless dsl
  conn = connection

  create_metadata_table!

  with_rebuild_lock(model) do
    drop_triggers!(model)
    conn.execute("DROP TABLE IF EXISTS #{qt(fts_table_name(model))};")
    conn.execute("DROP TABLE IF EXISTS #{qt(trigram_table_name(model))};")
    conn.execute(create_virtual_table_sql(model))
    if dsl.typo_tolerance?
      FullSearch::Typo.warn_unsupported!(model) unless FullSearch::Typo.supported?(model)
      conn.execute(create_trigram_virtual_table_sql(model))
    end
    conn.execute(backfill_sql(model))
    conn.execute(backfill_trigram_sql(model)) if dsl.typo_tolerance?
    reindex_source_fields!(model) if dsl.fields.any?(&:source)
    create_triggers!(model)
    optimize!(model)
    store_config_hash!(model, rebuilt_at: Time.current)
    verified_tables.add(model.table_name)
  end
end

.rebuild_if_needed!(model) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/full_search/index.rb', line 85

def rebuild_if_needed!(model)
  sqlite!(model)

  dsl = model.full_search_dsl
  return false unless dsl

  create_metadata_table!
  ensure_table!(model)

  stored = stored_config_hash(model)
  if stored && stored == dsl.config_hash
    false
  else
    rebuild!(model)
    true
  end
end

.reindex_source_fields!(model) ⇒ Object 



108
109
110
111
112
113
114
115
116
117
 
# File 'lib/full_search/index.rb', line 108

def reindex_source_fields!(model)
  dsl = model.full_search_dsl
  return unless dsl

  model.find_each do |record|
    dsl.fields.each do |field|
      FullSearch::Callbacks.reindex_field!(record, field.name) if field.source
    end
  end
end

.sqlite!(model) ⇒ Object

Raises:



165
166
167
168
 
# File 'lib/full_search/index.rb', line 165

def sqlite!(model)
  adapter = model ? model.connection.adapter_name : connection.adapter_name
  raise UnsupportedDatabaseError, "full_search requires SQLite, but #{adapter} is configured" unless sqlite?(model)
end

.sqlite?(model = nil) ⇒ Boolean

Returns:

  • (Boolean) 


155
156
157
158
159
160
161
162
163
 
# File 'lib/full_search/index.rb', line 155

def sqlite?(model = nil)
  if model
    model.connection.adapter_name.downcase.include?("sqlite")
  else
    connection.adapter_name.downcase.include?("sqlite")
  end
rescue
  connection.adapter_name.downcase.include?("sqlite")
end

.stored_config_hash(model) ⇒ Object 



170
171
172
173
174
175
 
# File 'lib/full_search/index.rb', line 170

def stored_config_hash(model)
  row = connection.execute(
    "SELECT config_hash FROM full_search_index_versions WHERE table_name=#{q(model.table_name)}"
  ).first
  row&.[]("config_hash")
end

.trigram_table_name(model) ⇒ Object 



151
152
153
 
# File 'lib/full_search/index.rb', line 151

def trigram_table_name(model)
  "#{fts_table_name(model)}_trigram"
end

.verified_tables ⇒ Object 



17
18
19
 
# File 'lib/full_search/index.rb', line 17

def verified_tables
  @verified_tables ||= Set.new
end