module LogStash

This filter executes a SQL query and store the result set in the field specified as `target`. It will cache the results locally in an LRU cache with expiry

For example you can load a row based on an id from in the event

source,ruby

filter {

jdbc_streaming {
  jdbc_driver_library => "/path/to/mysql-connector-java-5.1.34-bin.jar"
  jdbc_driver_class => "com.mysql.jdbc.Driver"
  jdbc_connection_string => ""jdbc:mysql://localhost:3306/mydatabase"
  jdbc_user => "me"
  jdbc_password => "secret"
  statement => "select * from WORLD.COUNTRY WHERE Code = :code"
  parameters => { "code" => "country_code"}
  target => "country_details"
}

}

Prepared Statement Mode example

source,ruby

filter {

jdbc_streaming {
  jdbc_driver_library => "/path/to/mysql-connector-java-5.1.34-bin.jar"
  jdbc_driver_class => "com.mysql.jdbc.Driver"
  jdbc_connection_string => ""jdbc:mysql://localhost:3306/mydatabase"
  jdbc_user => "me"
  jdbc_password => "secret"
  statement => "select * from WORLD.COUNTRY WHERE Code = ?"
  use_prepared_statements => true
  prepared_statement_name => "get_country_from_code"
  prepared_statement_bind_values => ["[country_code]"]
  target => "country_details"
}

}

This plugin was created as a way to ingest data from any database with a JDBC interface into Logstash. You can periodically schedule ingestion using a cron syntax (see `schedule` setting) or run the query one time to load 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 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 schedule. This scheduling syntax is powered by 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 github.com/jmettraux/rufus-scheduler#parsing-cronlines-and-time-strings[here].

State¶ ↑

The plugin will persist the `sql_last_value` parameter in the form of a metadata file stored in the configured `last_run_metadata_path`. Upon query execution, this file will be updated with the current value of `sql_last_value`. Next time 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_value` will be set to Jan 1, 1970, or 0 if `use_column_value` is true, 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 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 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 instruct the plugin to execute this input statement on the minute, every minute.

source,ruby

input {

jdbc {
  jdbc_driver_library => "mysql-connector-java-5.1.36-bin.jar"
  jdbc_driver_class => "com.mysql.jdbc.Driver"
  jdbc_connection_string => "jdbc:mysql://localhost:3306/mydb"
  jdbc_user => "mysql"
  parameters => { "favorite_artist" => "Beethoven" }
  schedule => "* * * * *"
  statement => "SELECT * from songs where artist = :favorite_artist"
}

}

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 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.

Configuring multiple SQL statements¶ ↑

Configuring multiple SQL statements is useful when there is a need to query and ingest data from different database tables or views. It is possible to define separate Logstash configuration files for each statement or to define multiple statements in a single configuration file. When using multiple statements in a single Logstash configuration file, each statement has to be defined as a separate jdbc input (including jdbc driver, connection string and other required parameters).

Please note that if any of the statements use the `sql_last_value` parameter (e.g. for ingesting only data changed since last run), each input should define its own `last_run_metadata_path` parameter. Failure to do so will result in undesired behaviour, as all inputs will store their state to the same (default) metadata file, effectively overwriting each other's `sql_last_value`.

Predefined Parameters¶ ↑

Some parameters are built-in and can be used from within your queries. Here is the list:

|========================================================== |sql_last_value | The value used to calculate which rows to query. Before any query is run, this is set to Thursday, 1 January 1970, or 0 if `use_column_value` is true and `tracking_column` is set. It is updated accordingly after subsequent queries are run. |==========================================================

Example:

source,ruby

input {

jdbc {
  statement => "SELECT id, mycolumn1, mycolumn2 FROM my_table WHERE id > :sql_last_value"
  use_column_value => true
  tracking_column => "id"
  # ... other configuration bits
}

}

Tentative of abstracting JDBC logic to a mixin for potential reuse in other plugins (input/output)