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
SIMPLE_LIST = 
'simple_list'.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, #child_index, #contains_child?, #delete_children, #dispatch, #display_value, #find_add_child, #find_child, help, inherited, #initialize, #is_alias?, #is_function?, #msg_reload, #msg_unload, #multiline_value?, #pn, #remove_child, #render, #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

.messages ⇒ Object

Get a list of message names that this object receives.



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

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

.short_typename ⇒ Object

The short name of the object type.



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

def self.short_typename
  return KEYWORD_SHORT
end

.typename ⇒ Object

The name of the object type.



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

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:



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

def add_children_on_create?
  return true
end

#add_default_children ⇒ Object

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



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

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

#log_query(sql, params) ⇒ Object

Write the query to the log.



116
117
118
119
 
# File 'lib/gloo/objs/data/query.rb', line 116

def log_query sql, params
  @engine.log.info "QUERY PARAMS: #{params}" if params
  @engine.log.info "QUERY: #{sql}"
end

#msg_run ⇒ Object

Run the query and process the results.



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

def msg_run
  db = db_obj
  return unless db

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

#run_query ⇒ Object

Run the query and return the results.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/gloo/objs/data/query.rb', line 92

def run_query
  db = db_obj
  return unless db

  begin
    log_query sql_value, param_array

    db_start = ::Time.now
    result = db.query( sql_value, param_array )
    db_done = ::Time.now
    elapsed = ( ( db_done - db_start ) * 1000.0 ).round(2)
  
    app = @engine.running_app
    app.add_db_time elapsed if app
    return result
  rescue => e
    @engine.err e.message
    return
  end
end

#simple_list? ⇒ Boolean

Should the output be put in a simple list?

Returns:



129
130
131
132
133
134
 
# File 'lib/gloo/objs/data/query.rb', line 129

def simple_list?
  o = find_child SIMPLE_LIST
  return false unless o

  return o.value
end