Module: PgSearch

Defined in:
lib/pg_search.rb,
lib/pg_search/model.rb,
lib/pg_search/railtie.rb,
lib/pg_search/version.rb,
lib/pg_search/document.rb,
lib/pg_search/features.rb,
lib/pg_search/normalizer.rb,
lib/pg_search/multisearch.rb,
lib/pg_search/configuration.rb,
lib/pg_search/scope_options.rb,
lib/pg_search/multisearchable.rb,
lib/pg_search/features/feature.rb,
lib/pg_search/features/trigram.rb,
lib/pg_search/features/tsearch.rb,
lib/pg_search/features/dmetaphone.rb,
lib/pg_search/migration/generator.rb,
lib/pg_search/configuration/column.rb,
lib/pg_search/multisearch/rebuilder.rb,
lib/pg_search/configuration/association.rb,
lib/pg_search/configuration/foreign_column.rb,
lib/pg_search/migration/dmetaphone_generator.rb,
lib/pg_search/migration/multisearch_generator.rb

Defined Under Namespace

Modules: Features, Migration, Model, Multisearch, Multisearchable Classes: Configuration, Document, Normalizer, PgSearchHighlightNotSelected, PgSearchRankNotSelected, Railtie, ScopeOptions

Constant Summary collapse

VERSION = 
'2.3.4'

Class Method Summary collapse

Class Method Details

.disable_multisearch ⇒ Object 



41
42
43
44
45
46
 
# File 'lib/pg_search.rb', line 41

def disable_multisearch
  Thread.current["PgSearch.enable_multisearch"] = false
  yield
ensure
  Thread.current["PgSearch.enable_multisearch"] = true
end

.included(base) ⇒ Object 



20
21
22
23
24
25
26
27
28
 
# File 'lib/pg_search.rb', line 20

def self.included(base)
  ActiveSupport::Deprecation.warn <<~MESSAGE
    Directly including `PgSearch` into an Active Record model is deprecated and will be removed in pg_search 3.0.

    Please replace `include PgSearch` with `include PgSearch::Model`.
  MESSAGE

  base.include PgSearch::Model
end

.multisearch(*args) ⇒ Object 



37
38
39
 
# File 'lib/pg_search.rb', line 37

def multisearch(*args)
  PgSearch::Document.search(*args)
end

.multisearch_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


48
49
50
51
52
53
54
 
# File 'lib/pg_search.rb', line 48

def multisearch_enabled?
  if Thread.current.key?("PgSearch.enable_multisearch")
    Thread.current["PgSearch.enable_multisearch"]
  else
    true
  end
end