Module: ThinkingSphinx

Defined in:
lib/thinking_sphinx.rb,
lib/thinking_sphinx/facet.rb,
lib/thinking_sphinx/field.rb,
lib/thinking_sphinx/index.rb,
lib/thinking_sphinx/deltas.rb,
lib/thinking_sphinx/search.rb,
lib/thinking_sphinx/source.rb,
lib/thinking_sphinx/property.rb,
lib/thinking_sphinx/attribute.rb,
lib/thinking_sphinx/collection.rb,
lib/thinking_sphinx/source/sql.rb,
lib/thinking_sphinx/association.rb,
lib/thinking_sphinx/class_facet.rb,
lib/thinking_sphinx/core/string.rb,
lib/thinking_sphinx/active_record.rb,
lib/thinking_sphinx/configuration.rb,
lib/thinking_sphinx/index/builder.rb,
lib/thinking_sphinx/search/facets.rb,
lib/thinking_sphinx/rails_additions.rb,
lib/thinking_sphinx/rails_additions.rb,
lib/thinking_sphinx/rails_additions.rb,
lib/thinking_sphinx/rails_additions.rb,
lib/thinking_sphinx/rails_additions.rb,
lib/thinking_sphinx/facet_collection.rb,
lib/thinking_sphinx/index/faux_column.rb,
lib/thinking_sphinx/active_record/delta.rb,
lib/thinking_sphinx/active_record/search.rb,
lib/thinking_sphinx/deltas/default_delta.rb,
lib/thinking_sphinx/deltas/delayed_delta.rb,
lib/thinking_sphinx/deltas/datetime_delta.rb,
lib/thinking_sphinx/adapters/mysql_adapter.rb,
lib/thinking_sphinx/deltas/delayed_delta/job.rb,
lib/thinking_sphinx/adapters/abstract_adapter.rb,
lib/thinking_sphinx/source/internal_properties.rb,
lib/thinking_sphinx/adapters/postgresql_adapter.rb,
lib/thinking_sphinx/deltas/delayed_delta/delta_job.rb,
lib/thinking_sphinx/active_record/attribute_updates.rb,
lib/thinking_sphinx/active_record/has_many_association.rb,
lib/thinking_sphinx/deltas/delayed_delta/flag_as_deleted_job.rb,
lib/thinking_sphinx/rails_additions.rb,
lib/thinking_sphinx/rails_additions.rb

Defined Under Namespace

Modules: AbstractQuotedTableName, ActiveRecord, ActiveRecordQuotedName, ActiveRecordStoreFullSTIClass, ArrayExtractOptions, ClassAttributeMethods, Core, Deltas, HashExcept, MysqlQuotedTableName, Version Classes: AbstractAdapter, Association, Attribute, ClassFacet, Collection, Configuration, ConnectionError, Facet, FacetCollection, Field, Index, MysqlAdapter, PostgreSQLAdapter, Property, Search, Source, StaleIdsException

Constant Summary collapse

@@deltas_enabled = 
nil
@@updates_enabled = 
nil
@@suppress_delta_output = 
false

Class Method Summary collapse

Class Method Details

.define_indexes=(value) ⇒ Object

Enable/disable indexes - you may want to do this while migrating data.

ThinkingSphinx.define_indexes = false



81
82
83
 
# File 'lib/thinking_sphinx.rb', line 81

def self.define_indexes=(value)
  @@define_indexes = value
end

.define_indexes? ⇒ Boolean

Check if index definition is disabled.

Returns:

  • (Boolean) 


72
73
74
75
 
# File 'lib/thinking_sphinx.rb', line 72

def self.define_indexes?
  @@define_indexes =  true unless defined?(@@define_indexes)
  @@define_indexes == true
end

.deltas_enabled=(value) ⇒ Object

Enable/disable all delta indexing.

ThinkingSphinx.deltas_enabled = false



98
99
100
 
# File 'lib/thinking_sphinx.rb', line 98

def self.deltas_enabled=(value)
  @@deltas_enabled = value
end

.deltas_enabled? ⇒ Boolean

Check if delta indexing is enabled.

Returns:

  • (Boolean) 


89
90
91
92
 
# File 'lib/thinking_sphinx.rb', line 89

def self.deltas_enabled?
  @@deltas_enabled  = (ThinkingSphinx::Configuration.environment != 'test') if @@deltas_enabled.nil?
  @@deltas_enabled
end

.indexed_models ⇒ Object

The collection of indexed models. Keep in mind that Rails lazily loads its classes, so this may not actually be populated with all the models that have Sphinx indexes.



62
63
64
 
# File 'lib/thinking_sphinx.rb', line 62

def self.indexed_models
  @@indexed_models ||= []
end

.jruby? ⇒ Boolean

Returns:

  • (Boolean) 


173
174
175
 
# File 'lib/thinking_sphinx.rb', line 173

def self.jruby?
  defined?(JRUBY_VERSION)
end

.microsoft? ⇒ Boolean

Returns:

  • (Boolean) 


169
170
171
 
# File 'lib/thinking_sphinx.rb', line 169

def self.microsoft?
  RUBY_PLATFORM =~ /mswin/
end

.mysql? ⇒ Boolean

Returns:

  • (Boolean) 


177
178
179
180
181
 
# File 'lib/thinking_sphinx.rb', line 177

def self.mysql?
  ::ActiveRecord::Base.connection.class.name.demodulize == "MysqlAdapter" || (
    jruby? && ::ActiveRecord::Base.connection.config[:adapter] == "jdbcmysql"
  )
end

.pid_active?(pid) ⇒ Boolean

Returns:

  • (Boolean) 


158
159
160
161
162
163
164
165
166
167
 
# File 'lib/thinking_sphinx.rb', line 158

def self.pid_active?(pid)
  return true if microsoft?
  
  begin
    # In JRuby this returns -1 if the process doesn't exist
    Process.getpgid(pid.to_i) != -1
  rescue Exception => e
    false
  end
end

.sphinx_pid ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/thinking_sphinx.rb', line 145

def self.sphinx_pid
  pid_file    = ThinkingSphinx::Configuration.instance.pid_file
  cat_command = 'cat'
  return nil unless File.exists?(pid_file)
  
  if microsoft?
    pid_file.gsub!('/', '\\')
    cat_command = 'type'
  end
  
  `#{cat_command} #{pid_file}`[/\d+/]
end

.sphinx_running? ⇒ Boolean

Returns:

  • (Boolean) 


141
142
143
 
# File 'lib/thinking_sphinx.rb', line 141

def self.sphinx_running?
  !!sphinx_pid && pid_active?(sphinx_pid)
end

.suppress_delta_output=(value) ⇒ Object 



126
127
128
 
# File 'lib/thinking_sphinx.rb', line 126

def self.suppress_delta_output=(value)
  @@suppress_delta_output = value
end

.suppress_delta_output? ⇒ Boolean

Returns:

  • (Boolean) 


122
123
124
 
# File 'lib/thinking_sphinx.rb', line 122

def self.suppress_delta_output?
  @@suppress_delta_output
end

.unique_id_expression(offset = nil) ⇒ Object 



66
67
68
 
# File 'lib/thinking_sphinx.rb', line 66

def self.unique_id_expression(offset = nil)
  "* #{ThinkingSphinx.indexed_models.size} + #{offset || 0}"
end

.updates_enabled=(value) ⇒ Object

Enable/disable updates to Sphinx

ThinkingSphinx.updates_enabled = false



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

def self.updates_enabled=(value)
  @@updates_enabled = value
end

.updates_enabled? ⇒ Boolean

Check if updates are enabled. True by default, unless within the test environment.

Returns:

  • (Boolean) 


107
108
109
110
 
# File 'lib/thinking_sphinx.rb', line 107

def self.updates_enabled?
  @@updates_enabled  = (ThinkingSphinx::Configuration.environment != 'test') if @@updates_enabled.nil?
  @@updates_enabled
end

.use_group_by_shortcut? ⇒ Boolean

Checks to see if MySQL will allow simplistic GROUP BY statements. If not, or if not using MySQL, this will return false.

Returns:

  • (Boolean) 


133
134
135
136
137
138
139
 
# File 'lib/thinking_sphinx.rb', line 133

def self.use_group_by_shortcut?
  !!(
    mysql? && ::ActiveRecord::Base.connection.select_all(
      "SELECT @@global.sql_mode, @@session.sql_mode;"
    ).all? { |key,value| value.nil? || value[/ONLY_FULL_GROUP_BY/].nil? }
  )
end