Class: Elasticsearch::Model::Indexing::Mappings

Inherits:
Object
  • Object
show all
Defined in:
lib/elasticsearch/model/indexing.rb

Overview

Wraps the [index mappings](www.elasticsearch.org/guide/en/elasticsearch/reference/current/mapping.html)

Constant Summary collapse

TYPES_WITH_EMBEDDED_PROPERTIES = 
%w(object nested)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type, options = {}) ⇒ Mappings

Returns a new instance of Mappings.

Raises:

  • (ArgumentError) 


42
43
44
45
46
47
48
 
# File 'lib/elasticsearch/model/indexing.rb', line 42

def initialize(type, options={})
  raise ArgumentError, "`type` is missing" if type.nil?

  @type    = type
  @options = options
  @mapping = {}
end

Instance Attribute Details

#options ⇒ Object

Returns the value of attribute options.



37
38
39
 
# File 'lib/elasticsearch/model/indexing.rb', line 37

def options
  @options
end

#type ⇒ Object

Returns the value of attribute type.



37
38
39
 
# File 'lib/elasticsearch/model/indexing.rb', line 37

def type
  @type
end

Instance Method Details

#as_json(options = {}) ⇒ Object 



78
79
80
 
# File 'lib/elasticsearch/model/indexing.rb', line 78

def as_json(options={})
  to_hash
end

#indexes(name, options = {}, &block) ⇒ Object 



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

def indexes(name, options={}, &block)
  @mapping[name] = options

  if block_given?
    @mapping[name][:type] ||= 'object'
    properties = TYPES_WITH_EMBEDDED_PROPERTIES.include?(@mapping[name][:type].to_s) ? :properties : :fields

    @mapping[name][properties] ||= {}

    previous = @mapping
    begin
      @mapping = @mapping[name][properties]
      self.instance_eval(&block)
    ensure
      @mapping = previous
    end
  end

  # Set the type to `text` by default
  @mapping[name][:type] ||= 'text'

  self
end

#to_hash ⇒ Object 



74
75
76
 
# File 'lib/elasticsearch/model/indexing.rb', line 74

def to_hash
  { @type.to_sym => @options.merge( properties: @mapping ) }
end