logstash-input-jdbc 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9bab690eb90f270679aa61551938fa2bf7ee6de
-  data.tar.gz: ef01a9593412b885252102358fde81cb50a268e2
+  metadata.gz: 6fc9b06fd127404a35d42af320ad90b37f0ff642
+  data.tar.gz: 21798f6ed0c0620f054acc6abe0c207211fadc70
 SHA512:
-  metadata.gz: bfb164e27f19f96e41026ceaca231a62855aef0e1d9c4e38ab39f923d9d0059bb39361576a442c78fa6b9f618acb6df33dd196b581337b53fc3f26ac6b4f2d64
-  data.tar.gz: 854657f5cecda124c91baf0342921b7cbca9e451957a33587cb670f189cb7dbf93312d3cfdd28634509d3a1858baeedc6f9a4c6a9827cb9fbc8a9f8ba3b08eb6
+  metadata.gz: bc1d4d90e171555d00334ab59ef67699bdf55e714557ef565a9b47d870b20d233f23fe7f0a48ed0025396ab822a9e18971d7eed1692027eac4971ced58f1ffb6
+  data.tar.gz: aeeb2afa34a2767d035c20e71c0efdd709f9df48988954761d064e542def704ba7c4ec8e52248187eb8df8847f6db1bfb5c60f081db2b1bd8709f6bb908210f3

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2.1.1
+  - [#44](https://github.com/logstash-plugins/logstash-input-jdbc/issues/44) add option to control the lowercase or not, of the column names.
+
 ## 2.1.0
   - [#85](https://github.com/logstash-plugins/logstash-input-jdbc/issues/85) make the jdbc_driver_library accept a list of elements separated by commas as in some situations we might need to load more than one jar/lib.
   - [#89](https://github.com/logstash-plugins/logstash-input-jdbc/issues/89) Set application timezone for cases where time fields in data have no timezone.

data/lib/logstash/inputs/jdbc.rb

@@ -12,13 +12,13 @@ require "yaml" # persistence
 #
 # ==== Drivers
 #
-# This plugin does not come packaged with JDBC driver libraries. The desired 
+# This plugin does not come packaged with JDBC driver libraries. The desired
 # jdbc driver library must be explicitly passed in to the plugin using the
 # `jdbc_driver_library` configuration option.
-# 
+#
 # ==== Scheduling
 #
-# Input from this plugin can be scheduled to run periodically according to a specific 
+# Input from this plugin can be scheduled to run periodically according to a specific
 # schedule. This scheduling syntax is powered by https://github.com/jmettraux/rufus-scheduler[rufus-scheduler].
 # The syntax is cron-like with some extensions specific to Rufus (e.g. timezone support ).
 #
@@ -29,16 +29,16 @@ require "yaml" # persistence
 # | `0 * * * *`                 | will execute on the 0th minute of every hour every day.
 # | `0 6 * * * America/Chicago` | will execute at 6:00am (UTC/GMT -5) every day.
 # |==========================================================
-#   
+#
 #
 # Further documentation describing this syntax can be found https://github.com/jmettraux/rufus-scheduler#parsing-cronlines-and-time-strings[here].
 #
 # ==== State
 #
-# The plugin will persist the `sql_last_start` parameter in the form of a 
-# metadata file stored in the configured `last_run_metadata_path`. Upon shutting down, 
+# The plugin will persist the `sql_last_start` parameter in the form of a
+# metadata file stored in the configured `last_run_metadata_path`. Upon shutting down,
 # this file will be updated with the current value of `sql_last_start`. Next time
-# the pipeline starts up, this value will be updated by reading from the file. If 
+# the pipeline starts up, this value will be updated by reading from the file. If
 # `clean_run` is set to true, this value will be ignored and `sql_last_start` will be
 # set to Jan 1, 1970, as if no query has ever been executed.
 #
@@ -48,17 +48,17 @@ require "yaml" # persistence
 # results are pre-fetched at a time from the cursor into the client's cache
 # before retrieving more results from the result-set. This is configured in
 # this plugin using the `jdbc_fetch_size` configuration option. No fetch size
-# is set by default in this plugin, so the specific driver's default size will 
+# is set by default in this plugin, so the specific driver's default size will
 # be used.
 #
 # ==== Usage:
 #
 # Here is an example of setting up the plugin to fetch data from a MySQL database.
 # First, we place the appropriate JDBC driver library in our current
-# path (this can be placed anywhere on your filesystem). In this example, we connect to 
+# path (this can be placed anywhere on your filesystem). In this example, we connect to
 # the 'mydb' database using the user: 'mysql' and wish to input all rows in the 'songs'
-# table that match a specific artist. The following examples demonstrates a possible 
-# Logstash configuration for this. The `schedule` option in this example will 
+# table that match a specific artist. The following examples demonstrates a possible
+# Logstash configuration for this. The `schedule` option in this example will
 # instruct the plugin to execute this input statement on the minute, every minute.
 #
 # [source,ruby]
@@ -77,9 +77,9 @@ require "yaml" # persistence
 # ----------------------------------
 #
 # ==== Configuring SQL statement
-# 
-# A sql statement is required for this input. This can be passed-in via a 
-# statement option in the form of a string, or read from a file (`statement_filepath`). File 
+#
+# A sql statement is required for this input. This can be passed-in via a
+# statement option in the form of a string, or read from a file (`statement_filepath`). File
 # option is typically used when the SQL statement is large or cumbersome to supply in the config.
 # The file option only supports one SQL statement. The plugin will only accept one of the options.
 # It cannot read a statement from a file as well as from the `statement` configuration parameter.
@@ -99,7 +99,7 @@ class LogStash::Inputs::Jdbc < LogStash::Inputs::Base
   config_name "jdbc"
 
   # If undefined, Logstash will complain, even if codec is unused.
-  default :codec, "plain" 
+  default :codec, "plain"
 
   # Statement to execute
   #
@@ -137,6 +137,9 @@ class LogStash::Inputs::Jdbc < LogStash::Inputs::Base
   # Whether to save state or not in last_run_metadata_path
   config :record_last_run, :validate => :boolean, :default => true
 
+  # Whether to force the lowercasing of identifier fields
+  config :lowercase_column_names, :validate => :boolean, :default => true
+
   public
 
   def register

data/lib/logstash/plugin_mixins/jdbc.rb

@@ -156,6 +156,11 @@ module LogStash::PluginMixins::Jdbc
     end
     @database.sql_log_level = @sql_log_level.to_sym
     @database.logger = @logger
+    if @lowercase_column_names
+      @database.identifier_output_method = :downcase
+    else
+      @database.identifier_output_method = :to_s
+    end
     @sql_last_start = Time.at(0).utc
   end # def prepare_jdbc_connection
 

data/logstash-input-jdbc.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-input-jdbc'
-  s.version         = '2.1.0'
+  s.version         = '2.1.1'
   s.licenses = ['Apache License (2.0)']
   s.summary = "This example input streams a string at a definable interval."
   s.description = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"

data/spec/inputs/jdbc_spec.rb

@@ -506,4 +506,39 @@ describe LogStash::Inputs::Jdbc do
     end
   end
 
+  describe "config option lowercase_column_names behaviour" do
+    let(:settings) { { "statement" => "SELECT * FROM ttt" } }
+    let(:events) { [] }
+
+    before do
+      db.create_table(:ttt) do
+        Integer(:num)
+        String(:somestring)
+      end
+      db[:ttt].insert(:num => 42, :somestring => "This is a string")
+      plugin.register
+    end
+
+    after do
+      plugin.stop
+      db.drop_table(:ttt)
+    end
+
+    context "when lowercase_column_names is on (default)" do
+      it "the field names are lower case" do
+        plugin.run(events)
+        expect(events.first.to_hash.keys.sort).to eq(
+          ["@timestamp", "@version","num", "somestring"])
+      end
+    end
+
+    context "when lowercase_column_names is off" do
+      let(:settings) { { "statement" => "SELECT * FROM ttt", "lowercase_column_names" => false } }
+      it "the field names are UPPER case (natural for Derby DB)" do
+        plugin.run(events)
+        expect(events.first.to_hash.keys.sort).to eq(
+          ["@timestamp", "@version","NUM", "SOMESTRING"])
+      end
+    end
+  end
 end

metadata

@@ -1,161 +1,161 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-jdbc
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2015-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
+  name: logstash-core
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.0.0.beta2
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: 3.0.0
-  name: logstash-core
-  prerelease: false
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.0.0.beta2
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: 3.0.0
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-codec-plain
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: sequel
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: sequel
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: tzinfo
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: tzinfo
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: tzinfo-data
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: tzinfo-data
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: rufus-scheduler
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: rufus-scheduler
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-devutils
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: timecop
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: timecop
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: jdbc-derby
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: jdbc-derby
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: docker-api
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: docker-api
   prerelease: false
   type: :development
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program
 email: info@elastic.co
 executables: []
@@ -183,12 +183,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []