module ElasticSearch::Api::Admin::Index

Constants

PSEUDO_INDICES

Public Instance Methods

alias_index(operations, options={}) click to toggle source

:add => { “index” => “alias” } :add => [{“index” => “alias”}, {“index2” => “alias2”}] :add => { “index” => “alias”, “index2” => “alias2” } :remove => { “index” => “alias” } :remove => [{“index” => “alias”, {“index2” => “alias2”}] :remove => { “index” => “alias”, “index2” => “alias2” } :actions => [{:add => {:index => “index”, :alias => “alias”}}]

# File lib/elasticsearch/client/admin_index.rb, line 46
def alias_index(operations, options={})
  if operations[:actions]
    alias_ops = operations
  else
    alias_ops = { :actions => [] }
    [:add, :remove].each do |op|
      next unless operations.has_key?(op)
      op_actions = operations[op].is_a?(Array) ? operations[op] : [operations[op]]
      op_actions.each do |action_hash|
        action_hash.each do |index, index_alias|
          alias_ops[:actions] << { op => { :index => index, :alias => index_alias }}
        end
      end
    end
  end
  execute(:alias_index, alias_ops, options)
end
create_index(index, create_options={}, options={}) click to toggle source

options: number_of_shards, number_of_replicas

# File lib/elasticsearch/client/admin_index.rb, line 28
def create_index(index, create_options={}, options={})
  unless create_options[:index]
    create_options = { :index => create_options }
  end
  execute(:create_index, index, create_options, options)
end
create_river(type, create_options, options={}) click to toggle source
# File lib/elasticsearch/client/admin_index.rb, line 129
def create_river(type, create_options, options={})
  execute(:create_river, type, create_options, options)
end
delete_index(index, options={}) click to toggle source
# File lib/elasticsearch/client/admin_index.rb, line 35
def delete_index(index, options={})
  execute(:delete_index, index, options)
end
delete_mapping(options={}) click to toggle source
# File lib/elasticsearch/client/admin_index.rb, line 83
def delete_mapping(options={})
  index, type, options = extract_required_scope(options)
  execute(:delete_mapping, index, type, options)
end
delete_river(type=nil, options={}) click to toggle source
# File lib/elasticsearch/client/admin_index.rb, line 141
def delete_river(type=nil, options={})
  execute(:delete_river, type, options)
end
flush(*args) click to toggle source

list of indices, or :all options: refresh default: default_index if defined, otherwise :all

# File lib/elasticsearch/client/admin_index.rb, line 100
def flush(*args)
  indices, options = extract_indices_and_options(args)
  execute(:flush, indices, options)
end
get_aliases(index=nil, options={}) click to toggle source
# File lib/elasticsearch/client/admin_index.rb, line 64
def get_aliases(index=nil, options={})
  scope_index, type, options = extract_scope(options)
  execute(:get_aliases, index || scope_index, options)
end
get_river(type, options={}) click to toggle source
# File lib/elasticsearch/client/admin_index.rb, line 133
def get_river(type, options={})
  execute(:get_river, type, options)
end
get_settings(index=default_index, options={}) click to toggle source
# File lib/elasticsearch/client/admin_index.rb, line 93
def get_settings(index=default_index, options={})
  execute(:get_settings, index, options)
end
index_exists?(index) click to toggle source
# File lib/elasticsearch/client/admin_index.rb, line 7
def index_exists?(index)
  !!index_status(index)
rescue RequestError => e
  if e.status == 404
    false
  else
    raise e
  end
end
index_mapping(*args) click to toggle source
# File lib/elasticsearch/client/admin_index.rb, line 22
def index_mapping(*args)
  indices, options = extract_indices_and_options(args)
  execute(:index_mapping, indices, options)
end
index_status(*args) click to toggle source
# File lib/elasticsearch/client/admin_index.rb, line 17
def index_status(*args)
  indices, options = extract_indices_and_options(args)
  execute(:index_status, indices, options)
end
optimize(*args) click to toggle source

list of indices, or :all options: max_num_segments, only_expunge_deletes, refresh, flush default: default_index if defined, otherwise all

# File lib/elasticsearch/client/admin_index.rb, line 124
def optimize(*args)
  indices, options = extract_indices_and_options(args)
  execute(:optimize, indices, options)
end
refresh(*args) click to toggle source

list of indices, or :all no options default: default_index if defined, otherwise all

# File lib/elasticsearch/client/admin_index.rb, line 108
def refresh(*args)
  indices, options = extract_indices_and_options(args)
  execute(:refresh, indices, options)
end
river_status(type, options={}) click to toggle source
# File lib/elasticsearch/client/admin_index.rb, line 137
def river_status(type, options={})
  execute(:river_status, type, options)
end
snapshot(*args) click to toggle source

list of indices, or :all no options default: default_index if defined, otherwise all

# File lib/elasticsearch/client/admin_index.rb, line 116
def snapshot(*args)
  indices, options = extract_indices_and_options(args)
  execute(:snapshot, indices, options)
end
update_mapping(mapping, options={}) click to toggle source

options: ignore_conflicts

# File lib/elasticsearch/client/admin_index.rb, line 70
def update_mapping(mapping, options={})
  index, type, options = extract_required_scope(options)

  options = options.dup
  indices = Array(index)
  unless mapping[type]
    mapping = { type => mapping }
  end

  indices.collect! { |i| PSEUDO_INDICES.include?(i) ? "_#{i}" : i }
  execute(:update_mapping, indices, type, mapping, options)
end
update_settings(settings, options={}) click to toggle source
# File lib/elasticsearch/client/admin_index.rb, line 88
def update_settings(settings, options={})
  index, type, options = extract_scope(options)
  execute(:update_settings, index, settings, options)
end

Private Instance Methods

extract_indices_and_options(args) click to toggle source
# File lib/elasticsearch/client/admin_index.rb, line 146
def extract_indices_and_options(args)
  options = args.last.is_a?(Hash) ? args.pop : {}
  indices = args.empty? ? [(default_index || :all)] : args.flatten
  indices.collect! { |i| PSEUDO_INDICES.include?(i) ? "_#{i}" : i }
  [indices, options]
end