Skip to content

Commit 9bba9f1

Browse files
authored
Merge pull request #352 from robbavey/minor_doc_fix
Add additional troubleshooting section for jdbc driver loading and remove confusing language about mixins.
2 parents c7c91c4 + c14c143 commit 9bba9f1

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

docs/index.asciidoc

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ This plugin does not come packaged with JDBC driver libraries. The desired
3333
jdbc driver library must be explicitly passed in to the plugin using the
3434
`jdbc_driver_library` configuration option.
3535

36+
See the <<plugins-{type}s-{plugin}-jdbc_driver_library>> and <<plugins-{type}s-{plugin}-jdbc_driver_class>>
37+
options for more info.
38+
3639
==== Scheduling
3740

3841
Input from this plugin can be scheduled to run periodically according to a specific
@@ -317,23 +320,25 @@ database timezone is UTC then you do not need to set either of these settings.
317320
* There is no default value for this setting.
318321

319322
JDBC driver class to load, for example, "org.apache.derby.jdbc.ClientDriver"
320-
NB per https://github.com/logstash-plugins/logstash-input-jdbc/issues/43 if you are using
321-
the Oracle JDBC driver (ojdbc6.jar) the correct `jdbc_driver_class` is `"Java::oracle.jdbc.driver.OracleDriver"`
323+
324+
NOTE: Per https://github.com/logstash-plugins/logstash-input-jdbc/issues/43, prepending `Java::` to the driver class
325+
may be required if it appears that the driver is not being loaded correctly despite relevant jar(s) being provided by
326+
either via the `jdbc_driver_library` setting or being placed in the Logstash Java classpath. This is known to be the
327+
case for the Oracle JDBC driver (ojdbc6.jar), where the correct `jdbc_driver_class` is
328+
`"Java::oracle.jdbc.driver.OracleDriver"`, and may also be the case for other JDBC drivers.
322329

323330
[id="plugins-{type}s-{plugin}-jdbc_driver_library"]
324331
===== `jdbc_driver_library`
325332

326333
* Value type is <<string,string>>
327334
* There is no default value for this setting.
328335

329-
Tentative of abstracting JDBC logic to a mixin
330-
for potential reuse in other plugins (input/output)
331-
This method is called when someone includes this module
332-
Add these methods to the 'base' given.
333336
JDBC driver library path to third party driver library. In case of multiple libraries being
334337
required you can pass them separated by a comma.
335338

336-
If not provided, Plugin will look for the driver class in the Logstash Java classpath.
339+
NOTE: If not provided, Plugin will look for the driver class in the Logstash Java classpath. Additionally, if the library
340+
does not appear to be being loaded correctly via this setting, placing the relevant jar(s) in the Logstash Java
341+
classpath rather than via this setting may help.
337342

338343
[id="plugins-{type}s-{plugin}-jdbc_fetch_size"]
339344
===== `jdbc_fetch_size`

0 commit comments

Comments
 (0)