- A component of the jdbc integration plugin
- Integration version: v5.0.6
- Released on: 2020-08-20
For other versions, see theVersioned plugin docs.
For questions about the plugin, open a topic in the Discuss forums.For bugs or feature requests, open an issue in Github.For the list of Elastic supported plugins, please consult the Elastic Support Matrix.
This plugin was created as a way to ingest data in any databasewith a JDBC interface into Logstash. You can periodically schedule ingestionusing a cron syntax (see schedule setting) or run the query one time to loaddata into Logstash. Each row in the resultset becomes a single event.Columns in the resultset are converted into fields in the event.
Support product highlights, featured content, downloads and more for Graphics Drivers for Intel® G41 Express Chipset. Download Elasticsearch, Logstash, Kibana, and Beats for free, and get started with Elastic APM, Elastic App Search, Elastic Workplace Search, and more in minutes.
This plugin does not come packaged with JDBC driver libraries. The desiredjdbc driver library must be explicitly passed in to the plugin using thejdbc_driver_library configuration option.
See the jdbc_driver_library and jdbc_driver_classoptions for more info.
Input from this plugin can be scheduled to run periodically according to a specificschedule. This scheduling syntax is powered by rufus-scheduler.The syntax is cron-like with some extensions specific to Rufus (e.g. timezone support ).
Examples:
| will execute every minute of 5am every day of January through March. |
| will execute on the 0th minute of every hour every day. |
| will execute at 6:00am (UTC/GMT -5) every day. |
Further documentation describing this syntax can be found here.
The plugin will persist the sql_last_value parameter in the form of ametadata 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 timethe pipeline starts up, this value will be updated by reading from the file. Ifclean_run is set to true, this value will be ignored and sql_last_value will beset to Jan 1, 1970, or 0 if use_column_value is true, as if no query has ever been executed.
Many JDBC drivers use the fetch_size parameter to limit how manyresults are pre-fetched at a time from the cursor into the client’s cachebefore retrieving more results from the result-set. This is configured inthis plugin using the jdbc_fetch_size configuration option. No fetch sizeis set by default in this plugin, so the specific driver’s default size willbe used.
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 currentpath (this can be placed anywhere on your filesystem). In this example, we connect tothe mydb database using the user: mysql and wish to input all rows in the songstable that match a specific artist. The following examples demonstrates a possibleLogstash configuration for this. The schedule option in this example willinstruct the plugin to execute this input statement on the minute, every minute.
A sql statement is required for this input. This can be passed-in via astatement option in the form of a string, or read from a file (statement_filepath). Fileoption 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 is useful when there is a need to query and ingest datafrom different database tables or views. It is possible to define separate Logstashconfiguration files for each statement or to define multiple statements in a single configurationfile. When using multiple statements in a single Logstash configuration file, each statementhas to be defined as a separate jdbc input (including jdbc driver, connection string and otherrequired parameters).
Please note that if any of the statements use the sql_last_value parameter (e.g. foringesting only data changed since last run), each input should define its ownlast_run_metadata_path parameter. Failure to do so will result in undesired behaviour, asall inputs will store their state to the same (default) metadata file, effectivelyoverwriting each other’s sql_last_value.
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 |
Example:
Using server side prepared statements can speed up execution times as the server optimises the query plan and execution.
Not all JDBC accessible technologies will support prepared statements.
With the introduction of Prepared Statement support comes a different code execution path and some new settings. Most of the existing settings are still useful but there are several new settings for Prepared Statements to read up on.Use the boolean setting use_prepared_statements to enable this execution mode. Use the prepared_statement_name setting to specify a name for the Prepared Statement, this identifies the prepared statement locally and remotely and it should be unique in your config and on the database. Use the prepared_statement_bind_values array setting to specify the bind values, use the exact string :sql_last_value (multiple times if necessary) for the predefined parameter mentioned before. The statement (or statement_path) setting still holds the SQL statement but to use bind variables you must use the ? character as a placeholder in the exact order found in the prepared_statement_bind_values array.
Building count queries around a prepared statement is not supported at this time and because jdbc paging uses count queries under the hood, jdbc paging is not supported with prepared statements at this time either. Therefore, jdbc_paging_enabled, jdbc_page_size settings are ignored when using prepared statements.
Example:
This plugin supports the following configuration options plus the Common Options described later.
| Setting | Input type | Required |
|---|---|---|
No | ||
No | ||
No | ||
No | ||
Yes | ||
No | ||
Yes | ||
No | ||
No | ||
No | ||
No | ||
No | ||
a valid filesystem path | No | |
No | ||
Yes | ||
No | ||
No | ||
No | ||
No | ||
No | ||
string, one of | No | |
No | ||
No | ||
No | ||
No | ||
No | ||
string, one of | No | |
No | ||
a valid filesystem path | No | |
No | ||
string, one of | No | |
No | ||
No |
Also see Common Options for a list of options supported by allinput plugins.
- Value type is boolean
- Default value is
false
Whether the previous run state should be preserved
- Value type is hash
- Default value is
{}
The character encoding for specific columns. This option will override the :charset optionfor the specified columns.
Example:
this will only convert column0 that has ISO-8859-1 as an original encoding.
- Value type is number
- Default value is
1
Maximum number of times to try connecting to database
- Value type is number
- Default value is
0.5
Number of seconds to sleep between connection attempts
- This is a required setting.
- Value type is string
- There is no default value for this setting.
JDBC connection string
- Value type is string
- There is no default value for this setting.
Timezone conversion.Logstash (and Elasticsearch) expects that timestamps are expressed in UTC terms.If your database has recorded timestamps that are relative to another timezone,the database timezone if you will, then set this setting to be the timezone thatthe database is using. However, as SQL does not allow for timezone data intimestamp fields we can’t figure this out on a record by record basis. This pluginwill automatically convert your SQL timestamp fields to Logstash timestamps,in relative UTC time in ISO8601 format.
Using this setting will manually assign a specified timezone offset, insteadof using the timezone setting of the local machine. You must use a canonicaltimezone, America/Denver, for example.
- Value can be any of:
utc,local - Default value is
'utc'
If you want this plugin to offset timestamps to a timezone other than UTC, youcan set this setting to local and the plugin will use the OS timezone for offsetadjustments.
Note: when specifying plugin_timezone and/or jdbc_default_timezone, offsetadjustments are made in two places, if sql_last_value is a timestamp and itis used as a parameter in the statement then offset adjustment is done from theplugin timezone into the data timezone and while records are processed, timestampsare offset adjusted from the database timezone to the plugin timezone. If yourdatabase timezone is UTC then you do not need to set either of these settings.
- This is a required setting.
- Value type is string
- There is no default value for this setting.
JDBC driver class to load, for example, 'org.apache.derby.jdbc.ClientDriver'
Per https://github.com/logstash-plugins/logstash-input-jdbc/issues/43, prepending Java:: to the driver class may be required if it appears that the driver is not being loaded correctly despite relevant jar(s) being provided by either via the jdbc_driver_library setting or being placed in the Logstash Java classpath. This is known to be the case for the Oracle JDBC driver (ojdbc6.jar), where the correct jdbc_driver_class is 'Java::oracle.jdbc.driver.OracleDriver', and may also be the case for other JDBC drivers.
- Value type is string
- There is no default value for this setting.
JDBC driver library path to third party driver library. In case of multiple libraries beingrequired you can pass them separated by a comma.
If not provided, Plugin will look for the driver class in the Logstash Java classpath. Additionally, if the library does not appear to be being loaded correctly via this setting, placing the relevant jar(s) in the Logstash Java classpath rather than via this setting may help. Please also make sure the path is readable by the Logstash process (e.g. logstash user when running as a service).
- Value type is number
- There is no default value for this setting.
JDBC fetch size. if not provided, respective driver’s default will be used
- Value type is number
- Default value is
100000
JDBC page size
- Value type is boolean
- Default value is
false
JDBC enable paging
This will cause a sql statement to be broken up into multiple queries.Each query will use limits and offsets to collectively retrieve the fullresult-set. The limit size is set with jdbc_page_size.
Be aware that ordering is not guaranteed between queries.
- Value type is password
- There is no default value for this setting.
JDBC password
- Value type is path
- There is no default value for this setting.
JDBC password filename
- Value type is number
- Default value is
5
Connection pool configuration.The amount of seconds to wait to acquire a connection before raising a PoolTimeoutError (default 5)
- This is a required setting.
- Value type is string
- There is no default value for this setting.
JDBC user
- Value type is boolean
- Default value is
false
Connection pool configuration.Validate connection before use.
- Value type is number
- Default value is
3600
Connection pool configuration.How often to validate a connection (in seconds)
- Value type is string
- Default value is
'$HOME/.logstash_jdbc_last_run'
Path to file with last run time
- Value type is boolean
- Default value is
true
Whether to force the lowercasing of identifier fields
- Value type is hash
- Default value is
{}
Hash of query parameter, for example { 'target_id' => '321' }
- Value type is array
- Default value is
[]
Array of bind values for the prepared statement. :sql_last_value is a reserved predefined string
- Value type is string
- Default value is
'
Name given to the prepared statement. It must be unique in your config and in the database
- Value type is boolean
- Default value is
true
Driver Downloads For Windows 7
Whether to save state or not in last_run_metadata_path
- Value type is string
- There is no default value for this setting.
Schedule of when to periodically run statement, in Cron formatfor example: '* * * * *' (execute query every minute, on the minute)
There is no schedule by default. If no schedule is given, then the statement is runexactly once.
Driver Downloader
- Value type is hash
- Default value is
{}
General/Vendor-specific Sequel configuration options.
An example of an optional connection pool configuration max_connections - The maximum number of connections the connection pool
examples of vendor-specific options can be found in thisdocumentation page: https://github.com/jeremyevans/sequel/blob/master/doc/opening_databases.rdoc
- Value can be any of:
fatal,error,warn,info,debug - Default value is
'info'
Log level at which to log SQL queries, the accepted values are the common ones fatal, error, warn,info and debug. The default value is info.
- Value type is string
- There is no default value for this setting.
If undefined, Logstash will complain, even if codec is unused.Statement to execute
To use parameters, use named parameter syntax.For example:
here, ':target_id' is a named parameter. You can configure named parameterswith the parameters setting.
- Value type is path
- There is no default value for this setting.
Path of file containing statement to execute
- Value type is string
- There is no default value for this setting.
The column whose value is to be tracked if use_column_value is set to true
- Value can be any of:
numeric,timestamp - Default value is
'numeric'
Elk Driver Download Software
Type of tracking column. Currently only 'numeric' and 'timestamp'
- Value type is boolean
- Default value is
false
When set to true, uses the definedtracking_column value as the :sql_last_value. When setto false, :sql_last_value reflects the last time the query was executed.
- Value type is boolean
- Default value is
false
When set to true, enables prepare statement usage
The following configuration options are supported by all input plugins:
| Setting | Input type | Required |
|---|---|---|
No | ||
No | ||
No | ||
No | ||
No | ||
No |
- Value type is hash
- Default value is
{}
Add a field to an event
- Value type is codec
- Default value is
'plain'
The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.
- Value type is boolean
- Default value is
true
Disable or enable metric logging for this specific plugin instanceby default we record all the metrics we can, but you can disable metrics collectionfor a specific plugin.
- Value type is string
- There is no default value for this setting.
Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one.It is strongly recommended to set this ID in your configuration. This is particularly usefulwhen you have two or more plugins of the same type, for example, if you have 2 jdbc inputs.Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
Variable substitution in the id field only supports environment variables and does not support the use of values from the secret store.
- Value type is array
- There is no default value for this setting.
Add any number of arbitrary tags to your event.
This can help with processing later.
- Value type is string
- There is no default value for this setting.
Add a type field to all events handled by this input.
Types are used mainly for filter activation.
The type is stored as part of the event itself, so you canalso use the type to search for it in Kibana.
If you try to set a type on an event that already has one (forexample when you send an event from a shipper to an indexer) thena new input will not override the existing type. A type set atthe shipper stays with that event for its life evenwhen sent to another Logstash server.
Most Popular
GeForce GTX 980M, GeForce GTX 970M, GeForce GTX 965M, GeForce GTX 960M, GeForce GTX 950M, GeForce 940M, GeForce 930M, GeForce 920M
GeForce GTX 880M, GeForce GTX 870M, GeForce GTX 860M, GeForce GTX 850M, GeForce 840M, GeForce 830M, GeForce 820M
GeForce GTX 780M, GeForce GTX 770M, GeForce GTX 765M, GeForce GTX 760M, GeForce GT 755M, GeForce GT 750M, GeForce GT 745M, GeForce GT 740M, GeForce GT 735M, GeForce GT 730M, GeForce GT 720M, GeForce 710M, GeForce 705M
GeForce GTX 680MX, GeForce GTX 680M, GeForce GTX 675MX, GeForce GTX 675M, GeForce GTX 670MX, GeForce GTX 670M, GeForce GTX 660M, GeForce GT 650M, GeForce GT 645M, GeForce GT 640M, GeForce GT 640M LE, GeForce GT 635M, GeForce GT 630M, GeForce GT 625M, GeForce GT 620M, GeForce 610M
GeForce GTX 580M, GeForce GTX 570M, GeForce GTX 560M, GeForce GT 555M, GeForce GT 550M, GeForce GT 540M, GeForce GT 525M, GeForce GT 520M, GeForce GT 520MX
GeForce GTX 485M, GeForce GTX 480M, GeForce GTX 470M, GeForce GTX 460M, GeForce GT 445M, GeForce GT 435M, GeForce GT 425M, GeForce GT 420M, GeForce GT 415M, GeForce 410M