Class: Gloo::Objs::Query

Inherits:
Core::Obj show all
Defined in:
lib/gloo/objs/data/query.rb

Constant Summary collapse

KEYWORD =
'query'.freeze
KEYWORD_SHORT =
'sql'.freeze
DB =
'database'.freeze
SQL =
'sql'.freeze
RESULT =
'result'.freeze
PARAMS =
'params'.freeze
DB_MISSING_ERR =
'The database connection is missing!'.freeze

Constants inherited from Core::Baseo

Core::Baseo::NOT_IMPLEMENTED_ERR

Instance Attribute Summary

Attributes inherited from Core::Obj

#children, #parent, #value

Attributes inherited from Core::Baseo

#name

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Core::Obj

#add_child, can_create?, #can_receive_message?, #child_count, #contains_child?, #delete_children, #dispatch, #display_value, #find_add_child, #find_child, help, inherited, #initialize, #msg_reload, #msg_unload, #multiline_value?, #pn, #remove_child, #root?, #send_message, #set_parent, #set_value, #type_display, #value_display, #value_is_array?, #value_is_blank?, #value_string?

Methods inherited from Core::Baseo

#initialize, #type_display

Constructor Details

This class inherits a constructor from Gloo::Core::Obj

Class Method Details

.messagesObject

Get a list of message names that this object receives.



68
69
70
# File 'lib/gloo/objs/data/query.rb', line 68

def self.messages
  return super + [ 'run' ]
end

.short_typenameObject

The short name of the object type.



32
33
34
# File 'lib/gloo/objs/data/query.rb', line 32

def self.short_typename
  return KEYWORD_SHORT
end

.typenameObject

The name of the object type.



25
26
27
# File 'lib/gloo/objs/data/query.rb', line 25

def self.typename
  return KEYWORD
end

Instance Method Details

#add_children_on_create?Boolean

Does this object have children to add when an object is created in interactive mode? This does not apply during obj load, etc.

Returns:



45
46
47
# File 'lib/gloo/objs/data/query.rb', line 45

def add_children_on_create?
  return true
end

#add_default_childrenObject

Add children to this object. This is used by containers to add children needed for default configurations.



54
55
56
57
58
59
# File 'lib/gloo/objs/data/query.rb', line 54

def add_default_children
  fac = @engine.factory
  fac.create_alias DB, nil, self
  fac.create_string SQL, nil, self
  fac.create_can RESULT, self
end

#msg_runObject

SSH to the host and execute the command, then update result.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/gloo/objs/data/query.rb', line 75

def msg_run
  db = db_obj
  unless db
    @engine.err DB_MISSING_ERR
    return
  end

  begin
    result = db.query( sql_value, param_array )
    process_result result
  rescue => e
    @engine.err e.message
    return
  end
end