class InfluxDB::Client
InfluxDB
client class
Attributes
config[R]
writer[R]
Public Class Methods
new(database = nil, **opts)
click to toggle source
Initializes a new InfluxDB
client
Examples:¶ ↑
# connect to localhost using root/root # as the credentials and doesn't connect to a db InfluxDB::Client.new # connect to localhost using root/root # as the credentials and 'db' as the db name InfluxDB::Client.new 'db' # override username, other defaults remain unchanged InfluxDB::Client.new username: 'username' # override username, use 'db' as the db name Influxdb::Client.new 'db', username: 'username'
Valid options in hash¶ ↑
:host
-
the hostname to connect to
:port
-
the port to connect to
:prefix
-
the specified path prefix when building the url e.g.: /prefix/db/dbname…
:username
-
the username to use when executing commands
:password
-
the password associated with the username
:use_ssl
-
use ssl to connect
:verify_ssl
-
verify ssl server certificate?
:ssl_ca_cert
-
ssl CA certificate, chainfile or CA path. The system CA path is automatically included
:retry
-
number of times a failed request should be retried. Defaults to infinite.
# File lib/influxdb/client.rb, line 52 def initialize(database = nil, **opts) opts[:database] = database if database.is_a? String @config = InfluxDB::Config.new(**opts) @stopped = false @writer = find_writer at_exit { stop! } end
Public Instance Methods
now()
click to toggle source
# File lib/influxdb/client.rb, line 77 def now InfluxDB.now(config.time_precision) end
stop!()
click to toggle source
# File lib/influxdb/client.rb, line 61 def stop! if @writer == self @stopped = true else @writer.stop! end end
stopped?()
click to toggle source
# File lib/influxdb/client.rb, line 69 def stopped? if @writer == self @stopped else @writer.stopped? end end
Private Instance Methods
find_writer()
click to toggle source
# File lib/influxdb/client.rb, line 83 def find_writer if config.async? InfluxDB::Writer::Async.new(self, config.async) elsif config.udp.is_a?(Hash) InfluxDB::Writer::UDP.new(self, **config.udp) elsif config.udp? InfluxDB::Writer::UDP.new(self) else self end end