Parent

Class/Module Index [+]

Quicksearch

Amalgalite::SQLite3::Database::Stat

A Stat represents a single Database Status code and its current highwater mark.

Some stats may not have a current or a highwater value, in those cases the associated has_current? or has_highwater? method returns false and the current or highwater method also returns nil.

Attributes

code[R]
name[R]

Public Class Methods

new( api_db, name ) click to toggle source
# File lib/amalgalite/sqlite3/database/status.rb, line 15
def initialize( api_db, name )
  @name      = name
  @code      = ::Amalgalite::SQLite3::Constants::DBStatus.value_from_name( name )
  @current   = nil
  @highwater = nil
  @api_db    = api_db 
end

Public Instance Methods

current() click to toggle source
# File lib/amalgalite/sqlite3/database/status.rb, line 23
def current
  update!
  return @current
end
highwater() click to toggle source
# File lib/amalgalite/sqlite3/database/status.rb, line 28
def highwater
  update!
  return @highwater
end
reset!() click to toggle source

reset the given stat's highwater mark. This will also populate the _@current_ and _@highwater_ instance variables

# File lib/amalgalite/sqlite3/database/status.rb, line 37
def reset!
  update!( true )
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.