Class: Elasticsearch::Transport::Client
- Inherits:
-
Object
- Object
- Elasticsearch::Transport::Client
- Defined in:
- lib/elasticsearch/transport/client.rb
Overview
Handles communication with an Elasticsearch cluster.
See README for usage and code examples.
Constant Summary collapse
- DEFAULT_TRANSPORT_CLASS =
Transport::HTTP::Faraday
- DEFAULT_LOGGER =
lambda do require 'logger' logger = Logger.new(STDERR) logger.progname = 'elasticsearch' logger.formatter = proc { |severity, datetime, progname, msg| "#{datetime}: #{msg}\n" } logger end
- DEFAULT_TRACER =
lambda do require 'logger' logger = Logger.new(STDERR) logger.progname = 'elasticsearch.tracer' logger.formatter = proc { |severity, datetime, progname, msg| "#{msg}\n" } logger end
Instance Attribute Summary collapse
-
#transport ⇒ Object
Returns the transport object.
Instance Method Summary collapse
-
#__auto_detect_adapter ⇒ Symbol
private
Auto-detect the best adapter (HTTP “driver”) available, based on libraries loaded by the user, preferring those with persistent connections (“keep-alive”) by default.
-
#__extract_hosts(hosts_config, options = {}) ⇒ Array<Hash>
private
Normalizes and returns hosts configuration.
-
#initialize(arguments = {}) {|faraday| ... } ⇒ Client
constructor
Create a client connected to an Elasticsearch cluster.
-
#perform_request(method, path, params = {}, body = nil) ⇒ Object
Performs a request through delegation to #transport.
Constructor Details
#initialize(arguments = {}) {|faraday| ... } ⇒ Client
Create a client connected to an Elasticsearch cluster.
Specify the URL via arguments or set the ‘ELASTICSEARCH_URL` environment variable.
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/elasticsearch/transport/client.rb', line 85 def initialize(arguments={}, &block) hosts = arguments[:hosts] || \ arguments[:host] || \ arguments[:url] || \ arguments[:urls] || \ ENV.fetch('ELASTICSEARCH_URL', 'localhost:9200') arguments[:logger] ||= arguments[:log] ? DEFAULT_LOGGER.call() : nil arguments[:tracer] ||= arguments[:trace] ? DEFAULT_TRACER.call() : nil arguments[:reload_connections] ||= false arguments[:retry_on_failure] ||= false arguments[:reload_on_failure] ||= false arguments[:randomize_hosts] ||= false arguments[:transport_options] ||= {} arguments[:transport_options].update(:request => { :timeout => arguments[:request_timeout] } ) if arguments[:request_timeout] @send_get_body_as = arguments[:send_get_body_as] || 'GET' transport_class = arguments[:transport_class] || DEFAULT_TRANSPORT_CLASS @transport = arguments[:transport] || begin if transport_class == Transport::HTTP::Faraday transport_class.new(:hosts => __extract_hosts(hosts, arguments), :options => arguments) do |faraday| block.call faraday if block unless (h = faraday.builder.handlers.last) && h.name.start_with?("Faraday::Adapter") faraday.adapter(arguments[:adapter] || __auto_detect_adapter) end end else transport_class.new(:hosts => __extract_hosts(hosts, arguments), :options => arguments) end end end |
Instance Attribute Details
#transport ⇒ Object
Returns the transport object.
32 33 34 |
# File 'lib/elasticsearch/transport/client.rb', line 32 def transport @transport end |
Instance Method Details
#__auto_detect_adapter ⇒ Symbol
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Auto-detect the best adapter (HTTP “driver”) available, based on libraries loaded by the user, preferring those with persistent connections (“keep-alive”) by default
185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/elasticsearch/transport/client.rb', line 185 def __auto_detect_adapter case when defined?(::Patron) :patron when defined?(::Typhoeus) :typhoeus when defined?(::HTTPClient) :httpclient when defined?(::Net::HTTP::Persistent) :net_http_persistent else ::Faraday.default_adapter end end |
#__extract_hosts(hosts_config, options = {}) ⇒ Array<Hash>
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Normalizes and returns hosts configuration.
Arrayifies the ‘hosts_config` argument and extracts `host` and `port` info from strings. Performs shuffling when the `randomize_hosts` option is set.
TODO: Refactor, so it’s available in Elasticsearch::Transport::Base as well
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/elasticsearch/transport/client.rb', line 140 def __extract_hosts(hosts_config, ={}) if hosts_config.is_a?(Hash) hosts = [ hosts_config ] else if hosts_config.is_a?(String) && hosts_config.include?(',') hosts = hosts_config.split(/\s*,\s*/) else hosts = Array(hosts_config) end end result = hosts.map do |host| host_parts = case host when String if host =~ /^[a-z]+\:\/\// uri = URI.parse(host) { :scheme => uri.scheme, :user => uri.user, :password => uri.password, :host => uri.host, :path => uri.path, :port => uri.port } else host, port = host.split(':') { :host => host, :port => port } end when URI { :scheme => host.scheme, :user => host.user, :password => host.password, :host => host.host, :path => host.path, :port => host.port } when Hash host else raise ArgumentError, "Please pass host as a String, URI or Hash -- #{host.class} given." end host_parts[:port] = host_parts[:port].to_i unless host_parts[:port].nil? host_parts end result.shuffle! if [:randomize_hosts] result end |
#perform_request(method, path, params = {}, body = nil) ⇒ Object
Performs a request through delegation to #transport.
122 123 124 125 126 |
# File 'lib/elasticsearch/transport/client.rb', line 122 def perform_request(method, path, params={}, body=nil) method = @send_get_body_as if 'GET' == method && body transport.perform_request method, path, params, body end |