Class: LogStash::Inputs::Jdbc

Inherits:
Base
  • Object
show all
Extended by:
PluginMixins::ValidatorSupport::FieldReferenceValidationAdapter
Includes:
PluginMixins::ECSCompatibilitySupport::TargetCheck, PluginMixins::EventSupport::EventFactoryAdapter, PluginMixins::Jdbc::Common, PluginMixins::Jdbc::Jdbc
Defined in:
lib/logstash/inputs/jdbc.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from PluginMixins::Jdbc::Jdbc

#close_jdbc_connection, #execute_statement, #get_column_value, included, #prepare_jdbc_connection, #setup_jdbc_config

Instance Attribute Details

#database ⇒ Object (readonly)

for test mocking/stubbing



232
233
234
 
# File 'lib/logstash/inputs/jdbc.rb', line 232

def database
  @database
end

Instance Method Details

#close ⇒ Object

def run



306
307
308
 
# File 'lib/logstash/inputs/jdbc.rb', line 306

def close
  @scheduler.shutdown if @scheduler
end

#register ⇒ Object 



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/logstash/inputs/jdbc.rb', line 236

def register
  @logger = self.logger
  require "rufus/scheduler"
  prepare_jdbc_connection

  if @use_column_value
    # Raise an error if @use_column_value is true, but no @tracking_column is set
    if @tracking_column.nil?
      raise(LogStash::ConfigurationError, "Must set :tracking_column if :use_column_value is true.")
    end
  end

  unless @statement.nil? ^ @statement_filepath.nil?
    raise(LogStash::ConfigurationError, "Must set either :statement or :statement_filepath. Only one may be set at a time.")
  end

  @statement = ::File.read(@statement_filepath) if @statement_filepath

  # must validate prepared statement mode after trying to read in from @statement_filepath
  if @use_prepared_statements
    validation_errors = validate_prepared_statement_mode
    unless validation_errors.empty?
      raise(LogStash::ConfigurationError, "Prepared Statement Mode validation errors: " + validation_errors.join(", "))
    end
  end

  set_value_tracker(LogStash::PluginMixins::Jdbc::ValueTracking.build_last_value_tracker(self))
  set_statement_logger(LogStash::PluginMixins::Jdbc::CheckedCountLogger.new(@logger))

  @enable_encoding = !@charset.nil? || !@columns_charset.empty?

  if (@jdbc_password_filepath and @jdbc_password)
    raise(LogStash::ConfigurationError, "Only one of :jdbc_password, :jdbc_password_filepath may be set at a time.")
  end

  @jdbc_password = LogStash::Util::Password.new(::File.read(@jdbc_password_filepath).strip) if @jdbc_password_filepath

  if enable_encoding?
    encodings = @columns_charset.values
    encodings << @charset if @charset

    @converters = encodings.each_with_object({}) do |encoding, converters|
      converter = LogStash::Util::Charset.new(encoding)
      converter.logger = self.logger
      converters[encoding] = converter
    end
  end
end

#run(queue) ⇒ Object 



294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/logstash/inputs/jdbc.rb', line 294

def run(queue)
  load_driver
  if @schedule
    # input thread (Java) name example "[my-oracle]<jdbc"
    @scheduler = LogStash::PluginMixins::Jdbc::Scheduler.
        start_cron_scheduler(@schedule, thread_name: "[#{id}]<jdbc__scheduler") { execute_query(queue) }
    @scheduler.join
  else
    execute_query(queue)
  end
end

#set_statement_logger(instance) ⇒ Object

test injection points



286
287
288
 
# File 'lib/logstash/inputs/jdbc.rb', line 286

def set_statement_logger(instance)
  @statement_handler = LogStash::PluginMixins::Jdbc::StatementHandler.build_statement_handler(self, instance)
end

#set_value_tracker(instance) ⇒ Object 



290
291
292
 
# File 'lib/logstash/inputs/jdbc.rb', line 290

def set_value_tracker(instance)
  @value_tracker = instance
end

#stop ⇒ Object 



310
311
312
313
 
# File 'lib/logstash/inputs/jdbc.rb', line 310

def stop
  close_jdbc_connection
  @scheduler.shutdown(:wait) if @scheduler
end