lib/logstash/inputs/jdbc.rb in logstash-input-jdbc-2.1.0 vs lib/logstash/inputs/jdbc.rb in logstash-input-jdbc-2.1.1
- old
+ new
@@ -10,57 +10,57 @@
# data into Logstash. Each row in the resultset becomes a single event.
# Columns in the resultset are converted into fields in the event.
#
# ==== 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 ).
#
# Examples:
#
# |==========================================================
# | `* 5 * 1-3 *` | will execute every minute of 5am every day of January through March.
# | `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.
#
# ==== Dealing With Large Result-sets
#
# Many JDBC drivers use the `fetch_size` parameter to limit how many
# 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]
# ----------------------------------
# input {
@@ -75,13 +75,13 @@
# }
# }
# ----------------------------------
#
# ==== 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.
#
# ==== Predefined Parameters
@@ -97,11 +97,11 @@
class LogStash::Inputs::Jdbc < LogStash::Inputs::Base
include LogStash::PluginMixins::Jdbc
config_name "jdbc"
# If undefined, Logstash will complain, even if codec is unused.
- default :codec, "plain"
+ default :codec, "plain"
# Statement to execute
#
# To use parameters, use named parameter syntax.
# For example:
@@ -134,9 +134,12 @@
# Whether the previous run state should be preserved
config :clean_run, :validate => :boolean, :default => false
# 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
require "rufus/scheduler"