Class KirbyBase
In: lib/kirbybase.rb
Parent: Object

Methods

Included Modules

DRb::DRbUndumped KBTypeConversionsMixin

Classes and Modules

Class KirbyBase::KBEngine
Class KirbyBase::KBTable

Constants

VERSION = "2.6"

Attributes

connect_type  [RW] 
delay_index_creation  [RW] 
engine  [R] 
ext  [RW] 
host  [RW] 
memo_blob_path  [RW] 
path  [RW] 
port  [RW] 

Public Class methods

Create a new database instance.

connect_type:Symbol (:local, :client, :server) specifying role to play.
host:String containing IP address or DNS name of server hosting database. (Only valid if connect_type is :client.)
port:Integer specifying port database server is listening on. (Only valid if connect_type is :client.)
path:String specifying path to location of database tables.
ext:String specifying extension of table files.
memo_blob_path:String specifying path to location of memo/blob files.
delay_index_creation:Boolean specifying whether to delay index creation for each table until that table is requested by user.

Public Instance methods

Is this running as a client?

Create new table and return a reference to the new table.

name:Symbol of table name.
field_defs:List of field names (Symbols), field types (Symbols), field indexes, and field extras (Indexes, Lookups, Link_manys, Calculateds, etc.)
Block:Optional code block allowing you to set the following:
encrypt:true/false specifying whether table should be encrypted.
record_class:Class or String specifying the user create class that will be associated with table records.

Delete a table.

tablename:Symbol of table name.

Return a reference to the requested table.

name:Symbol of table name.

Is this running in single-user, embedded mode?

Rename a table.

old_tablename:Symbol of old table name.
new_tablename:Symbol of new table name.

Is this running as a server?

Return true if table exists.

tablename:Symbol of table name.

Return an array containing the names of all tables in this database.

[Validate]