Class: Knj::Db

Inherits:
Object show all
Defined in:
lib/knj/knjdb/libknjdb.rb

Defined Under Namespace

Classes: Dbtime, Revision

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opts) ⇒ Db

Returns a new instance of Db.



9
10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/knj/knjdb/libknjdb.rb', line 9

def initialize(opts)
  require "#{$knjpath}threadhandler"
  
  self.setOpts(opts) if opts != nil
  
  @int_types = ["int", "bigint", "tinyint", "smallint", "mediumint"]
  
  if !@opts[:threadsafe]
    @mutex = Mutex.new
  end
  
  @debug = @opts[:debug]
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_name, *args) ⇒ Object 



513
514
515
516
517
518
519
520
521
 
# File 'lib/knj/knjdb/libknjdb.rb', line 513

def method_missing(method_name, *args)
  conn_exec do |driver|
    if driver.respond_to?(method_name.to_sym)
      return driver.send(method_name, *args)
    end
  end
  
  raise "Method not found: #{method_name}"
end

Instance Attribute Details

#conn ⇒ Object (readonly)

Returns the value of attribute conn.



7
8
9
 
# File 'lib/knj/knjdb/libknjdb.rb', line 7

def conn
  @conn
end

#conns ⇒ Object (readonly)

Returns the value of attribute conns.



7
8
9
 
# File 'lib/knj/knjdb/libknjdb.rb', line 7

def conns
  @conns
end

#int_types ⇒ Object (readonly)

Returns the value of attribute int_types.



7
8
9
 
# File 'lib/knj/knjdb/libknjdb.rb', line 7

def int_types
  @int_types
end

#opts ⇒ Object (readonly)

Returns the value of attribute opts.



7
8
9
 
# File 'lib/knj/knjdb/libknjdb.rb', line 7

def opts
  @opts
end

Instance Method Details

#args ⇒ Object 



27
28
29
 
# File 'lib/knj/knjdb/libknjdb.rb', line 27

def args
  return @opts
end

#clean ⇒ Object

Clean up various memory-stuff if possible.



112
113
114
115
116
117
118
119
120
 
# File 'lib/knj/knjdb/libknjdb.rb', line 112

def clean
  if @conns
    @conns.objects.each do |data|
      data[:object].clean if data[:object].respond_to?("clean")
    end
  elsif @conn
    @conn.clean if @conn.respond_to?("clean")
  end
end

#clone_conn(args = {}) ⇒ Object 



130
131
132
 
# File 'lib/knj/knjdb/libknjdb.rb', line 130

def clone_conn(args = {})
  return Knj::Db.new(@opts.clone.merge(args))
end

#close ⇒ Object 



122
123
124
125
126
127
128
 
# File 'lib/knj/knjdb/libknjdb.rb', line 122

def close
  @conn.close if @conn
  @conns.destroy if @conns
  
  @conn = nil
  @conns = nil
end

#col_table ⇒ Object 



23
24
25
 
# File 'lib/knj/knjdb/libknjdb.rb', line 23

def col_table
  return "`"
end

#cols ⇒ Object

Returns the columns-module and spawns it if it isnt already spawned.



488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/knj/knjdb/libknjdb.rb', line 488

def cols
  if !@cols
    require "#{File.dirname(__FILE__)}/drivers/#{@opts[:type]}/knjdb_#{@opts[:type]}_columns" if (!@opts.key?(:require) or @opts[:require])
    @cols = Kernel.const_get("KnjDB_#{@opts[:type]}".to_sym).const_get(:Columns).new(
      :driver => @conn,
      :db => self
    )
  end
  
  return @cols
end

#conn_exec ⇒ Object

Returns a driver-object based on the current thread and free driver-objects.



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/knj/knjdb/libknjdb.rb', line 331

def conn_exec
  if Thread.current[:knjdb]
    tid = self.__id__
    
    if Thread.current[:knjdb].key?(tid)
      yield(Thread.current[:knjdb][tid])
      return nil
    end
  end
  
  if @conns
    conn = @conns.get_and_lock
    
    begin
      yield(conn)
      return nil
    ensure
      @conns.free(conn)
    end
  elsif @conn
    begin
      @mutex.synchronize do
        yield(@conn)
        return nil
      end
    rescue ThreadError => e
      if e.message != "deadlock; recursive locking"
        yield(@conn)
        return nil
      else
        raise e
      end
    end
  end
  
  raise "Could not figure out how to find a driver to use?"
end

#connect ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/knj/knjdb/libknjdb.rb', line 46

def connect
  if @opts[:threadsafe]
    @conns = Knj::Threadhandler.new
    
    @conns.on_spawn_new do
      self.spawn
    end
    
    @conns.on_inactive do |data|
      data[:obj].close
    end
    
    @conns.on_activate do |data|
      data[:obj].reconnect
    end
  else
    @conn = self.spawn
  end
end

#copy_to(db, args = {}) ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/knj/knjdb/libknjdb.rb', line 134

def copy_to(db, args = {})
  data["tables"].each do |table|
    table_args = nil
    table_args = args["tables"][table["name"].to_s] if args and args["tables"] and args["tables"][table["name"].to_s]
    next if table_args and table_args["skip"]
    table.delete("indexes") if table.key?("indexes") and args["skip_indexes"]
    db.tables.create(table["name"], table)
    
    limit_from = 0
    limit_incr = 1000
    
    loop do
      ins_arr = []
      q_rows = self.select(table["name"], {}, {"limit_from" => limit_from, "limit_to" => limit_incr})
      while d_rows = q_rows.fetch
        col_args = nil
        
        if table_args and table_args["columns"]
          d_rows.each do |col_name, col_data|
            col_args = table_args["columns"][col_name.to_s] if table_args and table_args["columns"]
            d_rows[col_name] = "" if col_args and col_args["empty"]
          end
        end
        
        ins_arr << d_rows
      end
      
      break if ins_arr.empty?
      
      db.insert_multi(table["name"], ins_arr)
      limit_from += limit_incr
    end
  end
end

#data ⇒ Object 



169
170
171
172
173
174
175
176
177
178
 
# File 'lib/knj/knjdb/libknjdb.rb', line 169

def data
  tables_ret = []
  tables.list.each do |name, table|
    tables_ret << table.data
  end
  
  return {
    "tables" => tables_ret
  }
end

#date_in(date_obj) ⇒ Object 



468
469
470
 
# File 'lib/knj/knjdb/libknjdb.rb', line 468

def date_in(date_obj)
  return Knj::Datet.in(date_obj)
end

#date_out(date_obj = Knj::Datet.new, args = {}) ⇒ Object 



464
465
466
 
# File 'lib/knj/knjdb/libknjdb.rb', line 464

def date_out(date_obj = Knj::Datet.new, args = {})
  return Knj::Datet.in(date_obj).dbstr(args)
end

#delete(tablename, arr_terms) ⇒ Object 



297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/knj/knjdb/libknjdb.rb', line 297

def delete(tablename, arr_terms)
  conn_exec do |driver|
    sql = "DELETE FROM #{driver.escape_table}#{tablename}#{driver.escape_table}"
    
    if arr_terms != nil and !arr_terms.empty?
      sql << " WHERE #{self.makeWhere(arr_terms, driver)}"
    end
    
    driver.query(sql)
  end
end

#enc_col ⇒ Object 



454
455
456
457
458
459
460
461
462
 
# File 'lib/knj/knjdb/libknjdb.rb', line 454

def enc_col
  if !@enc_col
    self.conn_exec do |driver|
      @enc_col = driver.escape_col
    end
  end
  
  return @enc_col
end

#enc_table ⇒ Object 



444
445
446
447
448
449
450
451
452
 
# File 'lib/knj/knjdb/libknjdb.rb', line 444

def enc_table
  if !@enc_table
    self.conn_exec do |driver|
      @enc_table = driver.escape_table
    end
  end
  
  return @enc_table
end

#esc_col(str) ⇒ Object 



432
433
434
435
436
 
# File 'lib/knj/knjdb/libknjdb.rb', line 432

def esc_col(str)
  self.conn_exec do |driver|
    return driver.esc_col(str)
  end
end

#esc_table(str) ⇒ Object 



438
439
440
441
442
 
# File 'lib/knj/knjdb/libknjdb.rb', line 438

def esc_table(str)
  self.conn_exec do |driver|
    return driver.esc_table(str)
  end
end

#escape(string) ⇒ Object Also known as: esc

Escapes a string to be safe-to-use in a query-string.



424
425
426
427
428
 
# File 'lib/knj/knjdb/libknjdb.rb', line 424

def escape(string)
  self.conn_exec do |driver|
    return driver.escape(string)
  end
end

#free_thread ⇒ Object 



100
101
102
103
104
105
106
107
108
109
 
# File 'lib/knj/knjdb/libknjdb.rb', line 100

def free_thread
  thread_cur = Thread.current
  tid = self.__id__
  
  if thread_cur[:knjdb] and thread_cur[:knjdb].key?(tid)
    db = thread_cur[:knjdb][tid]
    thread_cur[:knjdb].delete(tid)
    @conns.free(db) if @conns
  end
end

#get_and_register_thread ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/knj/knjdb/libknjdb.rb', line 85

def get_and_register_thread
  raise "KnjDB-object is not in threadding mode." if !@conns
  
  thread_cur = Thread.current
  tid = self.__id__
  thread_cur[:knjdb] = {} if !thread_cur[:knjdb]
  
  if thread_cur[:knjdb][tid]
    #An object has already been spawned - free that first to avoid endless "used" objects.
    self.free_thread
  end
  
  thread_cur[:knjdb][tid] = @conns.get_and_lock if !thread_cur[:knjdb][tid]
end

#indexes ⇒ Object

Returns the index-module and spawns it if it isnt already spawned.



501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/knj/knjdb/libknjdb.rb', line 501

def indexes
  if !@indexes
    require "#{File.dirname(__FILE__)}/drivers/#{@opts[:type]}/knjdb_#{@opts[:type]}_indexes" if (!@opts.key?(:require) or @opts[:require])
    @indexes = Kernel.const_get("KnjDB_#{@opts[:type]}".to_sym).const_get(:Indexes).new(
      :driver => @conn,
      :db => self
    )
  end
  
  return @indexes
end

#insert(tablename, arr_insert, args = {}) ⇒ 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
209
210
211
212
213
 
# File 'lib/knj/knjdb/libknjdb.rb', line 180

def insert(tablename, arr_insert, args = {})
  conn_exec do |driver|
    sql = "INSERT INTO #{driver.escape_table}#{tablename.to_s}#{driver.escape_table} ("
    
    first = true
    arr_insert.each do |key, value|
      if first
        first = false
      else
        sql << ", "
      end
      
      sql << "#{driver.escape_col}#{key.to_s}#{driver.escape_col}"
    end
    
    sql << ") VALUES ("
    
    first = true
    arr_insert.each do |key, value|
      if first
        first = false
      else
        sql << ", "
      end
      
      sql << "#{driver.escape_val}#{driver.escape(value.to_s)}#{driver.escape_val}"
    end
    
    sql << ")"
    
    driver.query(sql)
    return driver.lastID if args[:return_id]
  end
end

#insert_multi(tablename, arr_hashes) ⇒ Object 



215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/knj/knjdb/libknjdb.rb', line 215

def insert_multi(tablename, arr_hashes)
  conn_exec do |driver|
    if driver.respond_to?(:insert_multi)
      return false if arr_hashes.empty?
      driver.insert_multi(tablename, arr_hashes)
    else
      arr_hashes.each do |hash|
        self.insert(tablename, hash)
      end
    end
  end
end

#lastID ⇒ Object Also known as: last_id

Returns the last inserted ID.



415
416
417
418
419
 
# File 'lib/knj/knjdb/libknjdb.rb', line 415

def lastID
  self.conn_exec do |driver|
    return driver.lastID
  end
end

#makeWhere(arr_terms, driver) ⇒ Object 



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/knj/knjdb/libknjdb.rb', line 309

def makeWhere(arr_terms, driver)
  sql = ""
  
  first = true
  arr_terms.each do |key, value|
    if first
      first = false
    else
      sql << " AND "
    end
    
    if value.is_a?(Array)
      sql << "#{driver.escape_col}#{key}#{driver.escape_col} IN (#{Knj::ArrayExt.join(:arr => value, :sep => ",", :surr => "'", :callback => proc{|ele| self.esc(ele)})})"
    else
      sql << "#{driver.escape_col}#{key}#{driver.escape_col} = #{driver.escape_val}#{driver.escape(value)}#{driver.escape_val}"
    end
  end
  
  return sql
end

#q(str, &block) ⇒ Object

Executes a query and returns the result. If a block is given the result is iterated over that block instead and it returns nil.



403
404
405
406
407
408
409
410
411
412
 
# File 'lib/knj/knjdb/libknjdb.rb', line 403

def q(str, &block)
  ret = self.query(str)
  
  if block
    ret.each(&block)
    return nil
  end
  
  return ret
end

#query(string) ⇒ Object

Executes a query and returns the result.



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/knj/knjdb/libknjdb.rb', line 370

def query(string)
  if @debug
    begin
      raise "test"
    rescue => e
      print "SQL: #{string}\n"
      print e.backtrace.join("\n")
      print "\n"
    end
  end
  
  self.conn_exec do |driver|
    return driver.query(string)
  end
end

#query_ubuf(string, &block) ⇒ Object

Execute an ubuffered query and returns the result.



387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/knj/knjdb/libknjdb.rb', line 387

def query_ubuf(string, &block)
  ret = nil
  
  self.conn_exec do |driver|
    ret = driver.query_ubuf(string, &block)
  end
  
  if block
    ret.each(&block)
    return nil
  end
  
  return ret
end

#select(tablename, arr_terms = nil, args = nil, &block) ⇒ Object 



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
284
285
 
# File 'lib/knj/knjdb/libknjdb.rb', line 255

def select(tablename, arr_terms = nil, args = nil, &block)
  sql = ""
  
  conn_exec do |driver|
    sql = "SELECT * FROM #{driver.escape_table}#{tablename.to_s}#{driver.escape_table}"
    
    if arr_terms != nil and !arr_terms.empty?
      sql << " WHERE #{self.makeWhere(arr_terms, driver)}"
    end
    
    if args != nil
      if args["orderby"]
        sql << " ORDER BY "
        sql << args["orderby"]
      end
      
      if args["limit"]
        sql << " LIMIT " + args["limit"].to_s
      end
      
      if args["limit_from"] and args["limit_to"]
        raise "'limit_from' was not numeric: '#{args["limit_from"]}'." if !Knj::Php.is_numeric(args["limit_from"])
        raise "'limit_to' was not numeric: '#{args["limit_to"]}'." if !Knj::Php.is_numeric(args["limit_to"])
        
        sql << " LIMIT #{args["limit_from"]}, #{args["limit_to"]}"
      end
    end
  end
  
  return self.q(sql, &block)
end

#selectsingle(tablename, arr_terms = nil, args = {}) ⇒ Object 



287
288
289
290
 
# File 'lib/knj/knjdb/libknjdb.rb', line 287

def selectsingle(tablename, arr_terms = nil, args = {})
  args["limit"] = 1
  return self.select(tablename, arr_terms, args).fetch
end

#setOpts(arr_opts) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/knj/knjdb/libknjdb.rb', line 31

def setOpts(arr_opts)
  @opts = {}
  arr_opts.each do |key, val|
    @opts[key.to_sym] = val
  end
  
  if RUBY_PLATFORM == "java"
    @opts[:subtype] = "java"
  elsif @opts[:type] == "sqlite3" and RUBY_PLATFORM.index("mswin32") != nil
    @opts[:subtype] = "ironruby"
  end
  
  self.connect
end

#single(tablename, arr_terms = nil, args = {}) ⇒ Object 



292
293
294
295
 
# File 'lib/knj/knjdb/libknjdb.rb', line 292

def single(tablename, arr_terms = nil, args = {})
  args["limit"] = 1
  return self.select(tablename, arr_terms, args).fetch
end

#spawn ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/knj/knjdb/libknjdb.rb', line 66

def spawn
  raise "No type given." if !@opts[:type]
  
  fpaths = [
    "drivers/#{@opts[:type]}/knjdb_#{@opts[:type]}.rb",
    "libknjdb_" + @opts[:type] + ".rb"
  ]
  fpaths.each do |fpath|
    rpath = "#{File.dirname(__FILE__)}/#{fpath}"
    
    if (!@opts.key?(:require) or @opts[:require]) and File.exists?(rpath)
      require rpath
      break
    end
  end
  
  return Kernel.const_get("KnjDB_#{@opts[:type]}").new(self)
end

#tables ⇒ Object

Returns the table-module and spawns it if it isnt already spawned.



473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/knj/knjdb/libknjdb.rb', line 473

def tables
  conn_exec do |driver|
    if !driver.tables
      require "#{File.dirname(__FILE__)}/drivers/#{@opts[:type]}/knjdb_#{@opts[:type]}_tables" if (!@opts.key?(:require) or @opts[:require])
      driver.tables = Kernel.const_get("KnjDB_#{@opts[:type]}".to_sym).const_get(:Tables).new(
        :driver => driver,
        :db => self
      )
    end
    
    return driver.tables
  end
end

#update(tablename, arr_update, arr_terms = {}) ⇒ Object 



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/knj/knjdb/libknjdb.rb', line 228

def update(tablename, arr_update, arr_terms = {})
  return false if arr_update.empty?
  
  conn_exec do |driver|
    sql = ""
    sql << "UPDATE #{driver.escape_col}#{tablename.to_s}#{driver.escape_col} SET "
    
    first = true
    arr_update.each do |key, value|
      if first
        first = false
      else
        sql << ", "
      end
      
      sql << "#{driver.escape_col}#{key.to_s}#{driver.escape_col} = "
      sql << "#{driver.escape_val}#{driver.escape(value.to_s)}#{driver.escape_val}"
    end
    
    if arr_terms and arr_terms.length > 0
      sql << " WHERE #{self.makeWhere(arr_terms, driver)}"
    end
    
    driver.query(sql)
  end
end