Class: FullSearch::Index

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

Class Method Summary collapse

Class Method Details

.drop!(model) ⇒ Object 



105
106
107
108
109
110
 
# File 'lib/full_search/index.rb', line 105

def drop!(model)
  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

.ensure_table!(model) ⇒ Object 



17
18
19
20
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
 
# File 'lib/full_search/index.rb', line 17

def ensure_table!(model)
  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)
  end

  store_config_hash!(model)
  ensure_triggers!(model) if model_table_exists?(model)
end

.fts_table_name(model) ⇒ Object 



112
113
114
 
# File 'lib/full_search/index.rb', line 112

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

.optimize!(model) ⇒ Object 



94
95
96
97
 
# File 'lib/full_search/index.rb', line 94

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 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/full_search/index.rb', line 49

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)
  end
end

.rebuild_if_needed!(model) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/full_search/index.rb', line 76

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 



99
100
101
102
103
 
# File 'lib/full_search/index.rb', line 99

def reindex_source_fields!(model)
  model.find_each do |record|
    FullSearch::Callbacks.reindex_record!(record)
  end
end

.sqlite!(model) ⇒ Object

Raises:



130
131
132
133
 
# File 'lib/full_search/index.rb', line 130

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) 


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

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 



135
136
137
138
139
140
 
# File 'lib/full_search/index.rb', line 135

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 



116
117
118
 
# File 'lib/full_search/index.rb', line 116

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