Class: Blazer::DataSource

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/blazer/data_source.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, settings) ⇒ DataSource

Returns a new instance of DataSource.



11
12
13
14
 
# File 'lib/blazer/data_source.rb', line 11

def initialize(id, settings)
  @id = id
  @settings = settings
end

Instance Attribute Details

#id ⇒ Object (readonly)

Returns the value of attribute id.



7
8
9
 
# File 'lib/blazer/data_source.rb', line 7

def id
  @id
end

#settings ⇒ Object (readonly)

Returns the value of attribute settings.



7
8
9
 
# File 'lib/blazer/data_source.rb', line 7

def settings
  @settings
end

Instance Method Details

#adapter ⇒ Object 



16
17
18
 
# File 'lib/blazer/data_source.rb', line 16

def adapter
  settings["adapter"] || detect_adapter
end

#bind_params(statement, variables) ⇒ Object 



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/blazer/data_source.rb', line 180

def bind_params(statement, variables)
  if parameter_binding == :positional
    locations = []
    variables.each do |k, v|
      i = 0
      while (idx = statement.index("{#{k}}", i))
        locations << [v, idx]
        i = idx + 1
      end
    end
    variables.each do |k, v|
      statement = statement.gsub("{#{k}}", "?")
    end
    [statement, locations.sort_by(&:last).map(&:first)]
  elsif parameter_binding == :numeric
    variables.each_with_index do |(k, v), i|
      # add trailing space if followed by digit
      # try to keep minimal to avoid fixing invalid queries like SELECT{var}
      statement = statement.gsub(/#{Regexp.escape("{#{k}}")}(\d)/, "$#{i + 1} \\1").gsub("{#{k}}", "$#{i + 1}")
    end
    [statement, variables.values]
  elsif parameter_binding.respond_to?(:call)
    parameter_binding.call(statement, variables)
  elsif parameter_binding.nil?
    [sub_variables(statement, variables), []]
  else
    raise Blazer::Error, "Unknown bind parameters"
  end
end

#cache ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/blazer/data_source.rb', line 44

def cache
  @cache ||= begin
    if settings["cache"].is_a?(Hash)
      settings["cache"]
    elsif settings["cache"]
      {
        "mode" => "all",
        "expires_in" => settings["cache"]
      }
    else
      {
        "mode" => "off"
      }
    end
  end
end

#cache_expires_in ⇒ Object 



65
66
67
 
# File 'lib/blazer/data_source.rb', line 65

def cache_expires_in
  (cache["expires_in"] || 60).to_f
end

#cache_key(key) ⇒ Object 



143
144
145
 
# File 'lib/blazer/data_source.rb', line 143

def cache_key(key)
  (["blazer", "v4"] + key).join("/")
end

#cache_mode ⇒ Object 



61
62
63
 
# File 'lib/blazer/data_source.rb', line 61

def cache_mode
  cache["mode"]
end

#cache_slow_threshold ⇒ Object 



69
70
71
 
# File 'lib/blazer/data_source.rb', line 69

def cache_slow_threshold
  (cache["slow_threshold"] || 15).to_f
end

#clear_cache(statement) ⇒ Object 



139
140
141
 
# File 'lib/blazer/data_source.rb', line 139

def clear_cache(statement)
  Blazer.cache.delete(statement_cache_key(statement))
end

#delete_results(run_id) ⇒ Object 



88
89
90
 
# File 'lib/blazer/data_source.rb', line 88

def delete_results(run_id)
  Blazer.cache.delete(run_cache_key(run_id))
end

#linked_columns ⇒ Object 



24
25
26
 
# File 'lib/blazer/data_source.rb', line 24

def linked_columns
  settings["linked_columns"] || {}
end

#local_time_suffix ⇒ Object 



73
74
75
 
# File 'lib/blazer/data_source.rb', line 73

def local_time_suffix
  @local_time_suffix ||= Array(settings["local_time_suffix"])
end

#name ⇒ Object 



20
21
22
 
# File 'lib/blazer/data_source.rb', line 20

def name
  settings["name"] || @id
end

#quote(value) ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/blazer/data_source.rb', line 155

def quote(value)
  if quoting == :backslash_escape || quoting == :single_quote_escape
    # only need to support types generated by process_vars
    if value.is_a?(Integer) || value.is_a?(Float)
      value.to_s
    elsif value.nil?
      "NULL"
    else
      value = value.to_formatted_s(:db) if value.is_a?(ActiveSupport::TimeWithZone)

      if quoting == :backslash_escape
        "'#{value.gsub("\\") { "\\\\" }.gsub("'") { "\\'" }}'"
      else
        "'#{value.gsub("'", "''")}'"
      end
    end
  elsif quoting.respond_to?(:call)
    quoting.call(value)
  elsif quoting.nil?
    raise Blazer::Error, "Quoting not specified"
  else
    raise Blazer::Error, "Unknown quoting"
  end
end

#read_cache(cache_key) ⇒ Object 



77
78
79
80
81
82
 
# File 'lib/blazer/data_source.rb', line 77

def read_cache(cache_key)
  value = Blazer.cache.read(cache_key)
  if value
    Blazer::Result.new(self, *Marshal.load(value), nil)
  end
end

#run_cache_key(run_id) ⇒ Object 



151
152
153
 
# File 'lib/blazer/data_source.rb', line 151

def run_cache_key(run_id)
  cache_key(["run", run_id])
end

#run_results(run_id) ⇒ Object 



84
85
86
 
# File 'lib/blazer/data_source.rb', line 84

def run_results(run_id)
  read_cache(run_cache_key(run_id))
end

#run_statement(statement, options = {}) ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/blazer/data_source.rb', line 101

def run_statement(statement, options = {})
  statement = Statement.new(statement, self) if statement.is_a?(String)
  statement.bind unless statement.bind_statement

  async = options[:async]
  result = nil
  if cache_mode != "off"
    if options[:refresh_cache]
      clear_cache(statement) # for checks
    else
      result = read_cache(statement_cache_key(statement))
    end
  end

  unless result
    comment = "blazer"
    if options[:user].respond_to?(:id)
      comment << ",user_id:#{options[:user].id}"
    end
    if options[:user].respond_to?(Blazer.user_name)
      # only include letters, numbers, and spaces to prevent injection
      comment << ",user_name:#{options[:user].send(Blazer.user_name).to_s.gsub(/[^a-zA-Z0-9 ]/, "")}"
    end
    if options[:query].respond_to?(:id)
      comment << ",query_id:#{options[:query].id}"
    end
    if options[:check]
      comment << ",check_id:#{options[:check].id},check_emails:#{options[:check].emails}"
    end
    if options[:run_id]
      comment << ",run_id:#{options[:run_id]}"
    end
    result = run_statement_helper(statement, comment, async ? options[:run_id] : nil, options)
  end

  result
end

#smart_columns ⇒ Object 



28
29
30
 
# File 'lib/blazer/data_source.rb', line 28

def smart_columns
  settings["smart_columns"] || {}
end

#smart_variables ⇒ Object 



32
33
34
 
# File 'lib/blazer/data_source.rb', line 32

def smart_variables
  settings["smart_variables"] || {}
end

#statement_cache_key(statement) ⇒ Object 



147
148
149
 
# File 'lib/blazer/data_source.rb', line 147

def statement_cache_key(statement)
  cache_key(["statement", id, Digest::MD5.hexdigest(statement.bind_statement.to_s.gsub("\r\n", "\n") + statement.bind_values.to_json)])
end

#sub_variables(statement, vars) ⇒ Object 



92
93
94
95
96
97
98
99
 
# File 'lib/blazer/data_source.rb', line 92

def sub_variables(statement, vars)
  statement = statement.dup
  vars.each do |var, value|
    # use block form to disable back-references
    statement.gsub!("{#{var}}") { quote(value) }
  end
  statement
end

#timeout ⇒ Object 



40
41
42
 
# File 'lib/blazer/data_source.rb', line 40

def timeout
  settings["timeout"]
end

#variable_defaults ⇒ Object 



36
37
38
 
# File 'lib/blazer/data_source.rb', line 36

def variable_defaults
  settings["variable_defaults"] || {}
end