Class: ThinkingSphinx::Attribute

Inherits:
Property
  • Object
show all
Defined in:
lib/thinking_sphinx/attribute.rb

Overview

Attributes - eternally useful when it comes to filtering, sorting or grouping. This class isn’t really useful to you unless you’re hacking around with the internals of Thinking Sphinx - but hey, don’t let that stop you.

One key thing to remember - if you’re using the attribute manually to generate SQL statements, you’ll need to set the base model, and all the associations. Which can get messy. Use Index.link!, it really helps.

Instance Attribute Summary collapse

Attributes inherited from Property

#admin, #alias, #associations, #columns, #faceted, #model

Instance Method Summary collapse

Methods inherited from Property

#admin?, #changed?, #public?, #to_facet, #to_group_sql, #unique_name

Constructor Details

#initialize(columns, options = {}) ⇒ Attribute

To create a new attribute, you’ll need to pass in either a single Column or an array of them, and some (optional) options.

Valid options are:

  • :as => :alias_name

  • :type => :attribute_type

  • :source => :field, :query, :ranged_query

Alias is only required in three circumstances: when there’s another attribute or field with the same name, when the column name is ‘id’, or when there’s more than one column.

Type is not required, unless you want to force a column to be a certain type (but keep in mind the value will not be CASTed in the SQL statements). The only time you really need to use this is when the type can’t be figured out by the column - ie: when not actually using a database column as your source.

Source is only used for multi-value attributes (MVA). By default this will use a left-join and a group_concat to obtain the values. For better performance during indexing it can be beneficial to let Sphinx use a separate query to retrieve all document,value-pairs. Either :query or :ranged_query will enable this feature, where :ranged_query will cause the query to be executed incremental.

Example usage:

Attribute.new(
  Column.new(:created_at)
)

Attribute.new(
  Column.new(:posts, :id),
  :as => :post_ids
)

Attribute.new(
  Column.new(:posts, :id),
  :as => :post_ids,
  :source => :ranged_query
)

Attribute.new(
  [Column.new(:pages, :id), Column.new(:articles, :id)],
  :as => :content_ids
)

Attribute.new(
  Column.new("NOW()"),
  :as   => :indexed_at,
  :type => :datetime
)

If you’re creating attributes for latitude and longitude, don’t forget that Sphinx expects these values to be in radians.



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/thinking_sphinx/attribute.rb', line 70

def initialize(columns, options = {})
  super
  
  @type     = options[:type]
  @source   = options[:source]
  @crc      = options[:crc]
  
  @type   ||= :multi    unless @source.nil?
  @type     = :integer  if @type == :string && @crc
end

Instance Attribute Details

#source ⇒ Object

Returns the value of attribute source.



12
13
14
 
# File 'lib/thinking_sphinx/attribute.rb', line 12

def source
  @source
end

Instance Method Details

#config_value(offset = nil) ⇒ Object

Returns the configuration value that should be used for the attribute. Special case is the multi-valued attribute that needs some extra configuration.



125
126
127
128
129
130
131
132
133
 
# File 'lib/thinking_sphinx/attribute.rb', line 125

def config_value(offset = nil)
  if type == :multi
    multi_config = include_as_association? ? "field" :
      source_value(offset).gsub(/\n\s*/, " ")
    "uint #{unique_name} from #{multi_config}"
  else
    unique_name
  end
end

#include_as_association? ⇒ Boolean

Returns:

  • (Boolean) 


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

def include_as_association?
  ! (type == :multi && (source == :query || source == :ranged_query))
end

#live_value(instance) ⇒ Object 



164
165
166
167
168
169
 
# File 'lib/thinking_sphinx/attribute.rb', line 164

def live_value(instance)
  object = instance
  column = @columns.first
  column.__stack.each { |method| object = object.send(method) }
  object.send(column.__name)
end

#to_select_sql ⇒ Object

Get the part of the SELECT clause related to this attribute. Don’t forget to set your model and associations first though.

This will concatenate strings and arrays of integers, and convert datetimes to timestamps, as needed.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/thinking_sphinx/attribute.rb', line 87

def to_select_sql
  return nil unless include_as_association?
  
  clause = @columns.collect { |column|
    column_with_prefix(column)
  }.join(', ')
  
  separator = all_ints? ? ',' : ' '
  
  clause = adapter.concatenate(clause, separator)       if concat_ws?
  clause = adapter.group_concatenate(clause, separator) if is_many?
  clause = adapter.cast_to_datetime(clause)             if type == :datetime
  clause = adapter.convert_nulls(clause)                if type == :string
  clause = adapter.crc(clause)                          if @crc
  
  "#{clause} AS #{quote_column(unique_name)}"
end

#type ⇒ Object

Returns the type of the column. If that’s not already set, it returns :multi if there’s the possibility of more than one value, :string if there’s more than one association, otherwise it figures out what the actual column’s datatype is and returns that.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/thinking_sphinx/attribute.rb', line 140

def type
  @type ||= begin
    base_type = case
    when is_many?, is_many_ints?
      :multi
    when @associations.values.flatten.length > 1
      :string
    else
      translated_type_from_database
    end
    
    if base_type == :string && @crc
      :integer
    else
      @crc = false
      base_type
    end
  end
end

#type_to_config ⇒ Object 



105
106
107
108
109
110
111
112
113
114
 
# File 'lib/thinking_sphinx/attribute.rb', line 105

def type_to_config
  {
    :multi    => :sql_attr_multi,
    :datetime => :sql_attr_timestamp,
    :string   => :sql_attr_str2ordinal,
    :float    => :sql_attr_float,
    :boolean  => :sql_attr_bool,
    :integer  => :sql_attr_uint
  }[type]
end

#updatable? ⇒ Boolean

Returns:

  • (Boolean) 


160
161
162
 
# File 'lib/thinking_sphinx/attribute.rb', line 160

def updatable?
  [:integer, :datetime, :boolean].include?(type) && !is_string?
end