Class: DbAgile::Command::Db::Ping

Inherits:
DbAgile::Command show all
Defined in:
lib/dbagile/command/db/ping.rb

Overview

Ping a database (current one by default)

Usage: dba #DbAgile::Command#command_name [CONFIG]

Constant Summary

Constants inherited from DbAgile::Command

CATEGORIES, CATEGORY_NAMES

Instance Attribute Summary collapse

Attributes inherited from DbAgile::Command

#environment

Attributes included from ClassMethods

#description, #summary, #usage

Instance Method Summary collapse

Methods inherited from DbAgile::Command

#add_options, #category, #check_command, #command_name, #description, #initialize, #options, #run, #set_default_options, #show_help, #summary, #unsecure_run, #usage

Methods included from ClassMethods

#build_command_options, #build_me, #category, #command_for, #command_name, #command_name_of, #each_subclass, #inherited, #ruby_method_for, #subclasses

Methods included from Robust

#ambigous_argument_list!, #assumption_error!, #bad_argument_list!, #has_command!, #is_in!, #valid_argument_list!, #valid_read_file!

Methods included from DbAgile::Core::IO::Robustness

#has_database!, #valid_database_name!, #valid_database_uri!, #valid_schema_files!

Constructor Details

This class inherits a constructor from DbAgile::Command

Instance Attribute Details

#match ⇒ Object

Name of the database to ping



13
14
15
 
# File 'lib/dbagile/command/db/ping.rb', line 13

def match
  @match
end

Instance Method Details

#execute_command ⇒ Object

Executes the command



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/dbagile/command/db/ping.rb', line 26

def execute_command
  cf = with_repository do |repository|

    db = has_database!(repository, self.match)

    # Make the job now
    begin
      with_connection(db){|c| c.ping}
      flush("Ping ok (#{db.uri})")
      db
    rescue StandardError => ex
      flush("Ping KO (#{db.uri})", :red)
      flush(ex.message)
      ex
    end
  
  end
  cf
end

#normalize_pending_arguments(arguments) ⇒ Object

Normalizes the pending arguments



16
17
18
19
20
21
22
23
 
# File 'lib/dbagile/command/db/ping.rb', line 16

def normalize_pending_arguments(arguments)
  if arguments.empty?
    self.match = nil
  else
    self.match = valid_argument_list!(arguments, Symbol)
    self.match = valid_database_name!(self.match)
  end
end