influxdb 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79714dbe624e4485dfefc69e334b3234daf4c5c6
-  data.tar.gz: 8a36045de479f5406d65b332c191edb3cfe327bb
+  metadata.gz: 5122c2a56a46565d1ee7481c6d20e1647035e94d
+  data.tar.gz: e4c1e752d0d49a5d3749e92f6c1afd1fbc269549
 SHA512:
-  metadata.gz: f29ae07c03cd04314bfc82af8510334c7a6e829a33ef1eaa1a7d8a5be802bf53883bab852075d64b3fd142b319e7ea9ecfb5a4f447671bd5629af0be4087dda3
-  data.tar.gz: 478b0d0002b481bed502b6682f795bad4a61f69eaa4c459dacc9f8050023ba1ed78d15bd27187914d0c6b6d2ea0b6e6989945f5b399f97c0ffefb0596e2d9514
+  metadata.gz: d4053245ecd16e82ee75055a407099a4ab44740722abc225d2a27fa1c3c562f6b703c07dae3322f523ec4cb3181ec69c991c17d2b8842af58970df10a343f717
+  data.tar.gz: adcf58659107dfc6ef3c99a4628c33662cbabc2782e06eb47cdfa90e345c2946d2e56af2e5849641221b5971cfad8ebc83d2cae4149a6a5bd778fe21270f6211

data/.gitignore

@@ -19,3 +19,4 @@ Gemfile.lock
 .yardoc
 _yardoc
 doc/
+*.local

data/.rubocop.yml

@@ -0,0 +1,41 @@
+AllCops:
+  # Include gemspec and Rakefile
+  Include:
+    - 'lib/**/*.rb'
+    - 'lib/**/*.rake'
+    - 'spec/**/*.rb'
+  Exclude:
+    - 'bin/**/*'
+  RunRailsCops: false
+  DisplayCopNames: true
+  StyleGuideCopsOnly: false
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/StringLiterals: 
+  Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/RescueModifier:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Enabled: false
+
+Lint/Void:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/**/*.rb'

data/.travis.yml

@@ -2,9 +2,10 @@ language: ruby
 before_install:
   - gem update bundler
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.0
   - 2.2.0
   - ruby-head
-  - jruby
+  - jruby-20mode
+  - jruby-21mode
+  - jruby-head

data/Gemfile

@@ -2,4 +2,10 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "webmock", :git => "https://github.com/influxdb/webmock.git"
+gem "webmock", git: "https://github.com/influxdb/webmock.git"
+
+local_gemfile = 'Gemfile.local'
+
+if File.exist?(local_gemfile)
+  eval(File.read(local_gemfile)) # rubocop:disable Lint/Eval
+end

data/README.md

@@ -1,17 +1,9 @@
 influxdb-ruby
 =============
 
-# This library is not updated for InfluxDB 0.9.0. There are breaking changes to the API, use at your own risk.
-
-We encourage you to submit a pull request if you have a contribution.
-
-----------
-
-
-
 [![Build Status](https://travis-ci.org/influxdb/influxdb-ruby.png?branch=master)](https://travis-ci.org/influxdb/influxdb-ruby)
 
-Ruby client library for [InfluxDB](http://influxdb.org/).
+The official ruby client library for [InfluxDB](https://influxdb.com/).
 
 Install
 -------
@@ -46,56 +38,179 @@ influxdb = InfluxDB::Client.new hosts: ["influxdb1.domain.com", "influxdb2.domai
 Create a database:
 
 ``` ruby
-require 'influxdb'
+database = 'site_development'
+
+influxdb.create_database(database)
+```
 
-influxdb = InfluxDB::Client.new
+Delete a database:
 
+``` ruby
 database = 'site_development'
 
-influxdb.create_database(database)
+influxdb.delete_database(database)
 ```
 
-Create a user for a database:
+List databases:
 
 ``` ruby
-require 'influxdb'
+influxdb.list_databases
+```
 
-influxdb = InfluxDB::Client.new
+Create a user for a database:
 
+``` ruby
 database = 'site_development'
 new_username = 'foo'
 new_password = 'bar'
+permission = :write
+
+# with all permissions
 influxdb.create_database_user(database, new_username, new_password)
+
+# with specified permission - options are: :read, :write, :all
+influxdb.create_database_user(database, new_username, new_password, permissions: permission)
 ```
 
-Update a database user:
+Update a user password:
 
 ``` ruby
-require 'influxdb'
+username = 'foo'
+new_password = 'bar'
 
-influxdb = InfluxDB::Client.new
+influxdb.update_user_password(username, new_password)
+```
+
+Grant user privileges on database:
 
-influxdb.update_database_user(database, username, :password => "new_password")
+``` ruby
+username = 'foobar'
+database = 'foo'
+permission = :read # options are :read, :write, :all
+
+influxdb.grant_user_privileges(username, database, permission)
 ```
 
-Write some data:
+Revoke user privileges from database:
 
 ``` ruby
-require 'influxdb'
+username = 'foobar'
+database = 'foo'
+permission = :write # options are :read, :write, :all
+
+influxdb.revoke_user_privileges(username, database, permission)
+```
+Delete a user:
+
+``` ruby
+username = 'foobar'
+
+influxdb.delete_user(username)
+```
+
+List users:
+
+``` ruby
+influxdb.list_users
+```
+
+Create cluster admin:
+
+``` ruby
+username = 'foobar'
+password = 'pwd'
+
+influxdb.create_cluster_admin(username, password)
+```
+
+List cluster admins:
+
+``` ruby
+influxdb.list_cluster_admins
+```
+
+Revoke cluster admin privileges from user:
+
+``` ruby
+username = 'foobar'
+
+influxdb.revoke_cluster_admin_privileges(username)
+```
+
+List continuous queries of a database:
+
+``` ruby
+database = 'foo'
+
+influxdb.list_continuous_queries(database)
+```
+
+Create a continuous query for a database:
+
+``` ruby
+database = 'foo'
+name = 'clicks_count'
+query = 'SELECT COUNT(name) INTO clicksCount_1h FROM clicks GROUP BY time(1h)'
+
+influxdb.create_continuous_query(name, database, query)
+```
+
+Delete a continuous query from a database:
+
+``` ruby
+database = 'foo'
+name = 'clicks_count'
+
+influxdb.delete_continuous_query(name, database)
+```
+
+List retention policies of a database:
+
+``` ruby
+database = 'foo'
+
+influxdb.list_retention_policies(database)
+```
+
+Create a retention policy for a database:
 
+``` ruby
+database = 'foo'
+name = '1h.cpu'
+duration = '10m'
+replication = 2
+
+influxdb.create_retention_policy(name, database, duration, replication)
+```
+
+Delete a retention policy from a database:
+
+``` ruby
+database = 'foo'
+name = '1h.cpu'
+
+influxdb.delete_retention_policy(name, database)
+```
+
+Write some data:
+
+``` ruby
 username = 'foo'
 password = 'bar'
 database = 'site_development'
 name     = 'foobar'
 
-influxdb = InfluxDB::Client.new database, :username => username, :password => password
+influxdb = InfluxDB::Client.new database,
+                                username: username,
+                                password: password
 
 # Enumerator that emits a sine wave
 Value = (0..360).to_a.map {|i| Math.send(:sin, i / 10.0) * 10 }.each
 
 loop do
   data = {
-    :value => Value.next
+    values: { value: Value.next },
+    tags: { wave: 'sine' } # tags are optional
   }
 
   influxdb.write_point(name, data)
@@ -104,9 +219,7 @@ loop do
 end
 ```
 
-Write data with time precision:
-
-Time precision can be set in 2 ways, either in the client initialization
+Write data with time precision (precision can be set in 2 ways):
 
 ``` ruby
 require 'influxdb'
@@ -117,18 +230,49 @@ database = 'site_development'
 name     = 'foobar'
 time_precision = 's'
 
-influxdb = InfluxDB::Client.new database, :username => username,
-                                          :password => password,
-                                          :time_precision => time_precision
+# either in the client initialization:
+influxdb = InfluxDB::Client.new database, username: username,
+                                          password: password,
+                                          time_precision: time_precision
 
 data = {
-  :value => 0,
-  :time => Time.now.to_i
+  values: { value: 0 },
+  timestamp: Time.now.to_i # timestamp is optional, if not provided point will be saved with current time
 }
 
 influxdb.write_point(name, data)
+
+# or in a method call:
+influxdb.write_point(name, data, time_precision)
+
 ```
-or in the write call
+
+Write multiple points in a batch (performance boost):
+
+``` ruby
+
+data = [
+  {
+    series: 'cpu',
+    tags: { host: 'server_1', regios: 'us' },
+    values: {internal: 5, external: 0.453345}
+  },
+  {
+    series: 'gpu',
+    values: {value: 0.9999},
+  }
+]
+
+influxdb.write_points(data)
+
+# you can also specify precision in method call
+
+precision = 'm'
+influxdb.write_points(data, precision)
+
+```
+
+Write asynchronously:
 
 ``` ruby
 require 'influxdb'
@@ -139,14 +283,18 @@ database = 'site_development'
 name     = 'foobar'
 time_precision = 's'
 
-influxdb = InfluxDB::Client.new database, :username => username, :password => password
+influxdb = InfluxDB::Client.new database,
+                                username: username,
+                                password: password,
+                                async: true
 
 data = {
-  :value => 0,
-  :time => Time.now.to_i
+  values: { value: 0 },
+  tags: { foo: 'bar', bar: 'baz' }
+  timestamp: Time.now.to_i
 }
 
-influxdb.write_point(name, data, false, time_precision)
+influxdb.write_point(name, data)
 ```
 
 Write data via UDP:
@@ -156,98 +304,66 @@ require 'influxdb'
 host = '127.0.0.1'
 port = 4444
 
-influxdb = InfluxDB::Client.new :udp => { :host => host, :port => port }
+influxdb = InfluxDB::Client.new udp: { host: host, port: port }
 
 name = 'hitchhiker'
 
 data = {
-  :answer => 42,
-  :question => "life the universe and everything?"
+  values: { value: 666 },
+  tags: { foo: 'bar', bar: 'baz' }
 }
 
 influxdb.write_point(name, data)
 ```
 
-
-List cluster admins:
-
-``` ruby
-require 'influxdb'
-
-influxdb = InfluxDB::Client.new
-
-influxdb.get_cluster_admin_list
-```
-
-List databases:
-
-``` ruby
-require 'influxdb'
-
-influxdb = InfluxDB::Client.new
-
-influxdb.get_database_list
-```
-
-List database users:
-
-``` ruby
-require 'influxdb'
-
-influxdb = InfluxDB::Client.new
-
-influxdb.get_database_user_list(database)
-```
-
-List a database user:
-
-``` ruby
-require 'influxdb'
-
-influxdb = InfluxDB::Client.new
-
-influxdb.get_database_user_info(database, username)
-```
-
-Delete a database:
+Querying:
 
 ``` ruby
-require 'influxdb'
-
-influxdb = InfluxDB::Client.new
-
+username = 'foo'
+password = 'bar'
 database = 'site_development'
-influxdb.delete_database(database)
-```
 
-Delete a database user:
+influxdb = InfluxDB::Client.new database,
+                                username: username,
+                                password: password
 
-``` ruby
-require 'influxdb'
+# without a block:
+influxdb.query 'select * from time_series_1' # results are grouped by name, but also their tags
+
+# result:
+[{"name"=>"time_series_1", "tags"=>{"region"=>"uk"}, "values"=>[{"time"=>"2015-07-09T09:03:31Z", "count"=>32, "value"=>0.9673}, {"time"=>"2015-07-09T09:03:49Z", "count"=>122, "value"=>0.4444}]},
+ {"name"=>"time_series_1", "tags"=>{"region"=>"us"}, "values"=>[{"time"=>"2015-07-09T09:02:54Z", "count"=>55, "value"=>0.4343}]}]
 
-influxdb = InfluxDB::Client.new
+# with a block:
+influxdb.query 'select * from time_series_1' do |name, tags, points|
+  puts "#{name} [ #{tags} ] => #{points}"
+end
 
-influxdb.delete_database_user(database, username)
+# result:
+# time_series_1 [ {"region"=>"uk"} ] => [{"time"=>"2015-07-09T09:03:31Z", "count"=>32, "value"=>0.9673}, {"time"=>"2015-07-09T09:03:49Z", "count"=>122, "value"=>0.4444}]
+# time_series_1 [ {"region"=>"us"} ] => [{"time"=>"2015-07-09T09:02:54Z", "count"=>55, "value"=>0.4343}]
 ```
 
-Querying:
+By default, InfluxDB::Client will denormalize points (received from InfluxDB as columns and rows), if you want to get _raw_ data add `denormalize: false` to initialization options or to query itself:
 
 ``` ruby
-require 'influxdb'
+influxdb.query 'select * from time_series_1', denormalize: false
 
-username = 'foo'
-password = 'bar'
-database = 'site_development'
+# result
+[{"name"=>"time_series_1", "tags"=>{"region"=>"uk"}, "columns"=>["time", "count", "value"], "values"=>[["2015-07-09T09:03:31Z", 32, 0.9673], ["2015-07-09T09:03:49Z", 122, 0.4444]]},
+ {"name"=>"time_series_1", "tags"=>{"region"=>"us"}, "columns"=>["time", "count", "value"], "values"=>[["2015-07-09T09:02:54Z", 55, 0.4343]]}]
 
-influxdb = InfluxDB::Client.new database, :username => username, :password => password
 
-influxdb.query 'select * from time_series_1' do |name, points|
-  puts "#{name} => #{points}"
+influxdb.query 'select * from time_series_1', denormalize: false do |name, tags, points|
+  puts "#{name} [ #{tags} ] => #{points}"
 end
+
+# result:
+# time_series_1 [ {"region"=>"uk"} ] => {"columns"=>["time", "count", "value"], "values"=>[["2015-07-09T09:03:31Z", 32, 0.9673], ["2015-07-09T09:03:49Z", 122, 0.4444]]}
+# time_series_1 [ {"region"=>"us"} ] => {"columns"=>["time", "count", "value"], "values"=>[["2015-07-09T09:02:54Z", 55, 0.4343]]}
 ```
 
-By default, an InfluxDB::Client will keep trying to connect to the database when
-it gets connection denied, if you want to retry a finite number of times
+By default, InfluxDB::Client will keep trying to connect to the database when it gets connection denied, if you want to retry a finite number of times
 (or disable retries altogether), you should pass the `:retry`
 value. `:retry` can be either `true`, `false` or an `Integer` to retry
 infinite times, disable retries or retry a finite number of times,