fluent-plugin-mysql-bulk 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1f4635f23f11af148bbb46bffb0191992a1dd44
-  data.tar.gz: cce2ab34d60e853b727c53f51d5bb1c48b2d56ff
+  metadata.gz: 86de300a43868df18918561c887617eecf22354c
+  data.tar.gz: 2fef1cc8fe51e087a5f6a71a561fda00dc8b438f
 SHA512:
-  metadata.gz: 3666e01d6c87578447e656dec0cd9937cb7e50de564e63e20e2046a940b761d37a4ca14a7d481715a9e6ec5d555e4b4ec7ad0c2decb3519fa4787ad8194cd4d9
-  data.tar.gz: 96cafee91c3690fd8a86db4d64e4a0ea6b819a27b582354f27abdbf5c6e1bd4ed44f193a0905c79b1d345ddb1ff6d990ababc6de9390937b2b920aaa9c4c3af7
+  metadata.gz: d37c300044121019994ce5fb752fad6f12c5a6f14268faf60f5b4d1994e1bd7aabb79b913d5841c0bfe7c84623cb617a23dc52016e39ed294b7695d972198c49
+  data.tar.gz: cf4c3176eb6420c7b324927bd971cc44fa1c79038664bc60a7c6239d6540ed4f138b08a4eeadd3c63710ef5021efd415342720f408f7c9b3101a88cb62fc62bb

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+test.conf

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+gemfile:
+  - Gemfile
+script: "rake test"

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Hiroshi Toyama
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,179 @@
+
+# fluent-plugin-mysql-bulk [![Build Status](https://secure.travis-ci.org/toyama0919/fluent-plugin-mysql-bulk.png?branch=master)](http://travis-ci.org/toyama0919/fluent-plugin-mysql-bulk)
+
+fluent plugin mysql bulk insert is high performance and on duplicate key update respond.
+
+## Installation
+
+### td-agent(Linux)
+
+    /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-mysql-bulk
+
+### td-agent(Mac)
+
+    sudo /usr/local/Cellar/td-agent/1.1.XX/bin/fluent-gem install fluent-plugin-mysql-bulk
+
+### fluentd only
+
+    gem install fluent-plugin-mysql-bulk
+
+
+## Parameters
+
+param|value
+--------|------
+host|database host(default: 127.0.0.1)
+database|database name(require)
+username|user(require)
+password|password(default: blank)
+column_names|bulk insert column (require)
+key_names|value key names (default : column_names)
+table|bulk insert table (require)
+on_duplicate_key_update|on duplicate key update enable (true:false)
+on_duplicate_update_keys|on duplicate key update column, comma separator
+
+## Configuration Example(bulk insert)
+
+```
+<match mysql.input>
+  type mysql_bulk
+  host localhost
+  database test_app_development
+  username root
+  password hogehoge
+  column_names id,user_name,created_at,updated_at
+  table users
+  flush_interval 10s
+</match>
+```
+
+Assume following input is coming:
+
+```js
+mysql.input: {"user_name":"toyama","created_at":"2014/01/03 21:35:15","updated_at":"2014/01/03 21:35:15","dummy":"hogehoge"}
+mysql.input: {"user_name":"toyama2","created_at":"2014/01/03 21:35:21","updated_at":"2014/01/03 21:35:21","dummy":"hogehoge"}
+mysql.input: {"user_name":"toyama3","created_at":"2014/01/03 21:35:27","updated_at":"2014/01/03 21:35:27","dummy":"hogehoge"}
+```
+
+then result becomes as below (indented):
+
+```sql
++-----+-----------+---------------------+---------------------+
+| id  | user_name | created_at          | updated_at          |
++-----+-----------+---------------------+---------------------+
+| 1   | toyama    | 2014-01-03 21:35:15 | 2014-01-03 21:35:15 |
+| 2   | toyama2   | 2014-01-03 21:35:21 | 2014-01-03 21:35:21 |
+| 3   | toyama3   | 2014-01-03 21:35:27 | 2014-01-03 21:35:27 |
++-----+-----------+---------------------+---------------------+
+```
+
+running query
+
+```sql
+INSERT INTO users (id,user_name,created_at,updated_at) VALUES (NULL,'toyama','2014/01/03 21:35:15','2014/01/03 21:35:15'),(NULL,'toyama2','2014/01/03 21:35:21','2014/01/03 21:35:21')
+```
+
+## Configuration Example(bulk insert , if duplicate error record update)
+
+```
+<match mysql.input>
+  type mysql_bulk
+  host localhost
+  database test_app_development
+  username root
+  password hogehoge
+  column_names id,user_name,created_at,updated_at
+  table users
+  on_duplicate_key_update true
+  on_duplicate_update_keys user_name,updated_at
+  flush_interval 60s
+</match>
+```
+
+Assume following input is coming:
+
+```js
+mysql.input: {"id":"1" ,"user_name":"toyama7","created_at":"2014/01/03 21:58:03","updated_at":"2014/01/03 21:58:03"}
+mysql.input: {"id":"2" ,"user_name":"toyama7","created_at":"2014/01/03 21:58:06","updated_at":"2014/01/03 21:58:06"}
+mysql.input: {"id":"3" ,"user_name":"toyama7","created_at":"2014/01/03 21:58:08","updated_at":"2014/01/03 21:58:08"}
+mysql.input: {"id":"10","user_name":"toyama7","created_at":"2014/01/03 21:58:18","updated_at":"2014/01/03 21:58:18"}
+```
+
+then result becomes as below (indented):
+
+```sql
++-----+-----------+---------------------+---------------------+
+| id  | user_name | created_at          | updated_at          |
++-----+-----------+---------------------+---------------------+
+|   1 | toyama7   | 2014-01-03 21:35:15 | 2014-01-03 21:58:03 |
+|   2 | toyama7   | 2014-01-03 21:35:21 | 2014-01-03 21:58:06 |
+|   3 | toyama7   | 2014-01-03 21:35:27 | 2014-01-03 21:58:08 |
+|  10 | toyama7   | 2014-01-03 21:58:18 | 2014-01-03 21:58:18 |
++-----+-----------+---------------------+---------------------+
+```
+
+if duplicate id , update username and updated_at
+
+
+## Configuration Example(bulk insert,fluentd key different column name)
+
+```
+<match mysql.input>
+  type mysql_bulk
+  host localhost
+  database test_app_development
+  username root
+  password hogehoge
+  column_names id,user_name,created_at,updated_at
+  key_names id,user,created_date,updated_date
+  table users
+  flush_interval 10s
+</match>
+```
+
+Assume following input is coming:
+
+```js
+mysql.input: {"user":"toyama","created_date":"2014/01/03 21:35:15","updated_date":"2014/01/03 21:35:15","dummy":"hogehoge"}
+mysql.input: {"user":"toyama2","created_date":"2014/01/03 21:35:21","updated_date":"2014/01/03 21:35:21","dummy":"hogehoge"}
+mysql.input: {"user":"toyama3","created_date":"2014/01/03 21:35:27","updated_date":"2014/01/03 21:35:27","dummy":"hogehoge"}
+```
+
+then result becomes as below (indented):
+
+```sql
++-----+-----------+---------------------+---------------------+
+| id  | user_name | created_at          | updated_at          |
++-----+-----------+---------------------+---------------------+
+| 1   | toyama    | 2014-01-03 21:35:15 | 2014-01-03 21:35:15 |
+| 2   | toyama2   | 2014-01-03 21:35:21 | 2014-01-03 21:35:21 |
+| 3   | toyama3   | 2014-01-03 21:35:27 | 2014-01-03 21:35:27 |
++-----+-----------+---------------------+---------------------+
+```
+
+
+
+
+## spec
+
+```
+bundle install
+rake test
+```
+
+## todo
+
+divide bulk insert(exsample 1000 per)
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new [Pull Request](../../pull/new/master)
+
+## Copyright
+
+Copyright (c) 2013 Hiroshi Toyama. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/fluent-plugin-mysql-bulk.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.name          = "fluent-plugin-mysql-bulk"
+  gem.version       = "0.0.2"
+  gem.authors       = ["Toyama Hiroshi"]
+  gem.email         = ["toyama0919@gmail.com"]
+  gem.description   = %q{fluent plugin mysql bulk insert is high performance and on duplicate key update respond.}
+  gem.summary       = %q{fluent plugin mysql bulk insert is high performance and on duplicate key update respond.}
+  gem.homepage      = "https://github.com/toyama0919/fluent-plugin-mysql-bulk"
+  gem.licenses    = ["MIT"]
+  gem.has_rdoc    = false
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "fluentd"
+  gem.add_runtime_dependency "mysql2-cs-bind"
+  gem.add_development_dependency "bundler", "~> 1.3"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "spork"
+  gem.add_development_dependency "pry"
+
+end

data/lib/fluent/plugin/out_mysql_bulk.rb

@@ -0,0 +1,94 @@
+# -*- encoding : utf-8 -*-
+module Fluent
+  class Fluent::MysqlBulkOutput < Fluent::BufferedOutput
+    Fluent::Plugin.register_output('mysql_bulk', self)
+
+    config_param :host, :string, :default => "127.0.0.1"
+    config_param :port, :integer, :default => 3306
+    config_param :database, :string
+    config_param :username, :string
+    config_param :password, :string, :default => ''
+
+    config_param :column_names, :string
+    config_param :key_names, :string, :default => nil
+    config_param :table, :string
+
+    config_param :on_duplicate_key_update, :bool, :default => false
+    config_param :on_duplicate_update_keys, :string, :default => nil
+
+    attr_accessor :handler
+
+    def initialize
+      super
+      require 'mysql2-cs-bind'
+    end
+
+    def configure(conf)
+      super
+
+      if @column_names.nil?
+        raise Fluent::ConfigError, "column_names MUST be specified, but missing"
+      end
+
+      if @on_duplicate_key_update
+        if @on_duplicate_update_keys.nil?
+          raise Fluent::ConfigError, "on_duplicate_key_update = true , on_duplicate_update_keys nil!"
+        end
+        @on_duplicate_update_keys = @on_duplicate_update_keys.split(',')
+
+        @on_duplicate_key_update_sql = " ON DUPLICATE KEY UPDATE "
+        updates = []
+        @on_duplicate_update_keys.each{|update_column|
+          updates.push(" #{update_column} = VALUES(#{update_column})")
+        }
+        @on_duplicate_key_update_sql += updates.join(',')
+      end
+
+      @column_names = @column_names.split(',')
+      @key_names = @key_names.nil? ? @column_names : @key_names.split(',')
+      @format_proc = Proc.new{|tag, time, record| @key_names.map{|k| record[k]}}
+
+    end
+
+    def start
+      @handler = client
+      super
+    end
+
+    def shutdown
+      super
+    end
+
+    def format(tag, time, record)
+      [tag, time, @format_proc.call(tag, time, record)].to_msgpack
+    end
+
+    def client
+      Mysql2::Client.new({
+          :host => @host,
+          :port => @port,
+          :username => @username,
+          :password => @password,
+          :database => @database,
+          :flags => Mysql2::Client::MULTI_STATEMENTS
+        })
+    end
+
+    def write(chunk)
+      values_templates = []
+      values = Array.new
+      chunk.msgpack_each { |tag, time, data|
+        values_templates.push "(#{@column_names.map{|key| '?'}.join(',')})"
+        values.concat(data)
+      }
+      sql = "INSERT INTO #{@table} (#{@column_names.join(',')}) VALUES #{values_templates.join(',')}"
+      if @on_duplicate_key_update
+        sql += @on_duplicate_key_update_sql
+      end
+
+      $log.info "bulk insert sql => [#{Mysql2::Client.pseudo_bind(sql, values)}]"
+      @handler.xquery(sql, values)
+    end
+
+  end
+end

data/test/helper.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/plugin/out_mysql_bulk'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_mysql_bulk.rb

@@ -0,0 +1,107 @@
+require 'helper'
+require 'mysql2-cs-bind'
+
+class MysqlBulkOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  def create_driver(conf = CONFIG, tag='test')
+    Fluent::Test::BufferedOutputTestDriver.new(Fluent::MysqlBulkOutput, tag).configure(conf)
+  end
+
+  def test_configure_error
+
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver %[
+        host localhost
+        database test_app_development
+        username root
+        password hogehoge
+        table users
+        on_duplicate_key_update true
+        on_duplicate_update_keys user_name,updated_at
+        flush_interval 10s
+      ]
+    }
+
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver %[
+        host localhost
+        database test_app_development
+        username root
+        password hogehoge
+        column_names id,user_name,created_at,updated_at
+        table users
+        on_duplicate_key_update true
+        flush_interval 10s
+      ]
+    }
+
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver %[
+        host localhost
+        username root
+        password hogehoge
+        column_names id,user_name,created_at,updated_at
+        table users
+        on_duplicate_key_update true
+        on_duplicate_update_keys user_name,updated_at
+        flush_interval 10s
+      ]
+    }
+  end
+
+  def test_configure
+    # not define format(default csv)
+    assert_nothing_raised(Fluent::ConfigError) {
+      d = create_driver %[
+        host localhost
+        database test_app_development
+        username root
+        password hogehoge
+        column_names id,user_name,created_at,updated_at
+        table users
+        on_duplicate_key_update true
+        on_duplicate_update_keys user_name,updated_at
+        flush_interval 10s
+      ]
+    }
+
+    assert_nothing_raised(Fluent::ConfigError) {
+      d = create_driver %[
+        database test_app_development
+        username root
+        password hogehoge
+        column_names id,user_name,created_at,updated_at
+        table users
+      ]
+    }
+
+    assert_nothing_raised(Fluent::ConfigError) {
+      d = create_driver %[
+        database test_app_development
+        username root
+        password hogehoge
+        column_names id,user_name,created_at,updated_at
+        table users
+        on_duplicate_key_update true
+        on_duplicate_update_keys user_name,updated_at
+      ]
+    }
+
+    assert_nothing_raised(Fluent::ConfigError) {
+      d = create_driver %[
+        database test_app_development
+        username root
+        password hogehoge
+        column_names id,user_name,created_at,updated_at
+        key_names id,user,created_date,updated_date
+        table users
+        on_duplicate_key_update true
+        on_duplicate_update_keys user_name,updated_at
+      ]
+    }
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-mysql-bulk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Toyama Hiroshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-03 00:00:00.000000000 Z
+date: 2014-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -115,7 +115,17 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-mysql-bulk.gemspec
+- lib/fluent/plugin/out_mysql_bulk.rb
+- test/helper.rb
+- test/plugin/test_out_mysql_bulk.rb
 homepage: https://github.com/toyama0919/fluent-plugin-mysql-bulk
 licenses:
 - MIT
@@ -141,4 +151,6 @@ signing_key:
 specification_version: 4
 summary: fluent plugin mysql bulk insert is high performance and on duplicate key
   update respond.
-test_files: []
+test_files:
+- test/helper.rb
+- test/plugin/test_out_mysql_bulk.rb