KirbyBase 2.6 → 2.6.1

data/examples/indexes_test/index_test.rb

@@ -1,94 +1,94 @@
-# This script is an example of how to use indexes in KirbyBase.  Indexes
-# allow for faster queries on large datasets.
-#
-# To use indexes, you must first specify which fields are to be indexed.
-# You do this at table creation time.  Both single and compound indexes can
-# be created.  Then, when performing a select query, you simply use the
-# automatically created select_by_?????_index method, where ????? is
-# replaced by the name(s) of the indexed field(s).  That's it.  Everything
-# else concerning building and maintaing indexes is done by KirbyBase.
-require 'kirbybase'
-
-db = KirbyBase.new
-
-# To run as a client in a multi-user environment, uncomment next line.
-# Also, make sure kbserver.rb is running.
-#db = KirbyBase.new do |d|
-#    d.connect_type = :client
-#    d.host = 'localhost'
-#    d.port = 44444
-#end
-
-# If table exists, delete it.
-db.drop_table(:address_book) if db.table_exists?(:address_book)
-
-# Here we are creating a table to hold contact info.  We are going to create
-# two indexes.  One index is going to be a compound index containing the
-# firstname and lastname fields.  Notice how we group the firstname and
-# lastname fields into one index by specifying :Index=>1 for both of them.
-# This just tells KirbyBase that the two fields should be combined into one
-# compound index because they both are using the same index number.  The
-# second index is going to be a single index containing the category field.
-# Since we want it to be a separate index, we simply use the next available
-# number, 2, as the value of it's :Index key.
-address_book_tbl = db.create_table(:address_book,
- :firstname, {:DataType=>:String, :Index=>1},
- :lastname, {:DataType=>:String, :Index=>1},
- :street_address, :String,
- :city, :String,
- :phone, :String,
- :category, {:DataType=>:String, :Index=>2},
- :age, {:DataType=>:Integer, :Index=>3}
-)
-
-# Insert some contact info records.
-address_book_tbl.insert('Bruce', 'Wayne', '1234 Bat Cave', 'Gotham City',
- '111-111-1111', 'Super Hero', 39)
-address_book_tbl.insert('Bugs', 'Bunny', '1234 Rabbit Hole', 'The Forest',
- '222-222-2222', 'Cartoon Character', 12)
-address_book_tbl.insert('George', 'Bush', '1600 Pennsylvania Ave',
- 'Washington', '333-333-3333', 'President', 2)
-address_book_tbl.insert('Silver', 'Surfer', '1234 Galaxy Way',
- 'Any City', '444-444-4444', 'Super Hero', 199)
-address_book_tbl.insert('John', 'Doe', '1234 Robin Lane', 'Detroit',
- '999-999-9999', nil, 54)
-address_book_tbl.insert(nil, 'NoFirstName', 'Nowhere Road', 'Notown',
- '000-000-0000', 'Nothing', nil)
-
-# Select all super heros without using the index.
-address_book_tbl.select { |r| r.category == 'Super Hero' }.each { |r|
-    puts '%s %s %s' % [r.firstname, r.lastname, r.phone]
-}
-puts;puts
-# Now, do the same query, but use the category index.  These
-# select_by_index methods are automatically created by KirbyBase, based on
-# the indexes you specified at table creation.
-address_book_tbl.select_by_category_index { |r|
- r.category == 'Super Hero' }.each { |r|
-    puts '%s %s %s' % [r.firstname, r.lastname, r.phone]
-}
-puts;puts
-# Select Bugs Bunny using the firstname+lastname index.
-address_book_tbl.select_by_firstname_lastname_index { |r|
-    r.firstname == 'Bugs' and r.lastname == 'Bunny'
-}.each { |r| puts '%s %s %s' % [r.firstname, r.lastname, r.phone] }
-
-puts;puts
-# Select the guy with no first name using the firstname+lastname index.
-address_book_tbl.select_by_firstname_lastname_index { |r|
-    r.lastname == 'NoFirstName'
-}.each { |r| puts '%s %s %s' % [r.firstname, r.lastname, r.phone] }
-
-puts;puts
-# Select the guy with no first name using the firstname+lastname index.
-# This time we will explicitly say firstname should be nil
-address_book_tbl.select_by_firstname_lastname_index { |r|
-    r.firstname.nil? and r.lastname == 'NoFirstName'
-}.each { |r| puts '%s %s %s' % [r.firstname, r.lastname, r.phone] }
-
-puts;puts
-address_book_tbl.select_by_age_index { |r| r.age > 30 }.each { |r|
- puts '%s %s %d' % [r.firstname, r.lastname, r.age] }
- 
-puts;puts
-p address_book_tbl.field_indexes
+# This script is an example of how to use indexes in KirbyBase.  Indexes
+# allow for faster queries on large datasets.
+#
+# To use indexes, you must first specify which fields are to be indexed.
+# You do this at table creation time.  Both single and compound indexes can
+# be created.  Then, when performing a select query, you simply use the
+# automatically created select_by_?????_index method, where ????? is
+# replaced by the name(s) of the indexed field(s).  That's it.  Everything
+# else concerning building and maintaing indexes is done by KirbyBase.
+require 'kirbybase'
+
+db = KirbyBase.new
+
+# To run as a client in a multi-user environment, uncomment next line.
+# Also, make sure kbserver.rb is running.
+#db = KirbyBase.new do |d|
+#    d.connect_type = :client
+#    d.host = 'localhost'
+#    d.port = 44444
+#end
+
+# If table exists, delete it.
+db.drop_table(:address_book) if db.table_exists?(:address_book)
+
+# Here we are creating a table to hold contact info.  We are going to create
+# two indexes.  One index is going to be a compound index containing the
+# firstname and lastname fields.  Notice how we group the firstname and
+# lastname fields into one index by specifying :Index=>1 for both of them.
+# This just tells KirbyBase that the two fields should be combined into one
+# compound index because they both are using the same index number.  The
+# second index is going to be a single index containing the category field.
+# Since we want it to be a separate index, we simply use the next available
+# number, 2, as the value of it's :Index key.
+address_book_tbl = db.create_table(:address_book,
+ :firstname, {:DataType=>:String, :Index=>1},
+ :lastname, {:DataType=>:String, :Index=>1},
+ :street_address, :String,
+ :city, :String,
+ :phone, :String,
+ :category, {:DataType=>:String, :Index=>2},
+ :age, {:DataType=>:Integer, :Index=>3}
+)
+
+# Insert some contact info records.
+address_book_tbl.insert('Bruce', 'Wayne', '1234 Bat Cave', 'Gotham City',
+ '111-111-1111', 'Super Hero', 39)
+address_book_tbl.insert('Bugs', 'Bunny', '1234 Rabbit Hole', 'The Forest',
+ '222-222-2222', 'Cartoon Character', 12)
+address_book_tbl.insert('George', 'Bush', '1600 Pennsylvania Ave',
+ 'Washington', '333-333-3333', 'President', 2)
+address_book_tbl.insert('Silver', 'Surfer', '1234 Galaxy Way',
+ 'Any City', '444-444-4444', 'Super Hero', 199)
+address_book_tbl.insert('John', 'Doe', '1234 Robin Lane', 'Detroit',
+ '999-999-9999', nil, 54)
+address_book_tbl.insert(nil, 'NoFirstName', 'Nowhere Road', 'Notown',
+ '000-000-0000', 'Nothing', nil)
+
+# Select all super heros without using the index.
+address_book_tbl.select { |r| r.category == 'Super Hero' }.each { |r|
+    puts '%s %s %s' % [r.firstname, r.lastname, r.phone]
+}
+puts;puts
+# Now, do the same query, but use the category index.  These
+# select_by_index methods are automatically created by KirbyBase, based on
+# the indexes you specified at table creation.
+address_book_tbl.select_by_category_index { |r|
+ r.category == 'Super Hero' }.each { |r|
+    puts '%s %s %s' % [r.firstname, r.lastname, r.phone]
+}
+puts;puts
+# Select Bugs Bunny using the firstname+lastname index.
+address_book_tbl.select_by_firstname_lastname_index { |r|
+    r.firstname == 'Bugs' and r.lastname == 'Bunny'
+}.each { |r| puts '%s %s %s' % [r.firstname, r.lastname, r.phone] }
+
+puts;puts
+# Select the guy with no first name using the firstname+lastname index.
+address_book_tbl.select_by_firstname_lastname_index { |r|
+    r.lastname == 'NoFirstName'
+}.each { |r| puts '%s %s %s' % [r.firstname, r.lastname, r.phone] }
+
+puts;puts
+# Select the guy with no first name using the firstname+lastname index.
+# This time we will explicitly say firstname should be nil
+address_book_tbl.select_by_firstname_lastname_index { |r|
+    r.firstname.nil? and r.lastname == 'NoFirstName'
+}.each { |r| puts '%s %s %s' % [r.firstname, r.lastname, r.phone] }
+
+puts;puts
+address_book_tbl.select_by_age_index { |r| r.age > 30 }.each { |r|
+ puts '%s %s %d' % [r.firstname, r.lastname, r.age] }
+ 
+puts;puts
+p address_book_tbl.field_indexes

data/examples/kbserver_as_win32_service/kbserver_daemon.rb

@@ -1,47 +1,47 @@
-# Modified version of kbserver.rb for use as Windows Service.
-
-require 'kirbybase'
-require 'drb'
-require 'win32/service'
-include Win32
-
-OPTIONS = {}
-
-class KBServerDaemon < Daemon
-    def initialize
-        # NOTE:  Change this line to reflect where you want the log file to
-        #        reside.
-        @log = 'C:\logs\db_server_log.txt'
-        begin
-            # NOTE:  Change this line to reflect where the database tables
-            #        are located.
-            @db = KirbyBase.new do |x|
-                x.connect_type = :server
-                x.path = 'C:\data'
-            end 
-        rescue Exception => e
-            File.open(@log, "a+") { |fh| ft.puts "Error: #{e}" }
-            service_stop
-        end    
-    end
-    
-    def service_main
-        begin
-            # NOTE:  Change this line to reflect what port you want to 
-            #        listen on.
-            DRb.start_service('druby://:44444', @db)
-            DRb.thread.join
-        rescue StandardError, InterrupError => e
-            File.open(@log, "a+") { |fh| fh.puts "Error: #{e}" }
-            service_stop
-        end     
-    end
-    
-    def service_stop
-        DRb.stop_service
-        exit
-    end
-end
-
-d = KBServerDaemon.new
-d.mainloop
+# Modified version of kbserver.rb for use as Windows Service.
+
+require 'kirbybase'
+require 'drb'
+require 'win32/service'
+include Win32
+
+OPTIONS = {}
+
+class KBServerDaemon < Daemon
+    def initialize
+        # NOTE:  Change this line to reflect where you want the log file to
+        #        reside.
+        @log = 'C:\logs\db_server_log.txt'
+        begin
+            # NOTE:  Change this line to reflect where the database tables
+            #        are located.
+            @db = KirbyBase.new do |x|
+                x.connect_type = :server
+                x.path = 'C:\data'
+            end 
+        rescue Exception => e
+            File.open(@log, "a+") { |fh| ft.puts "Error: #{e}" }
+            service_stop
+        end    
+    end
+    
+    def service_main
+        begin
+            # NOTE:  Change this line to reflect what port you want to 
+            #        listen on.
+            DRb.start_service('druby://:44444', @db)
+            DRb.thread.join
+        rescue StandardError, InterrupError => e
+            File.open(@log, "a+") { |fh| fh.puts "Error: #{e}" }
+            service_stop
+        end     
+    end
+    
+    def service_stop
+        DRb.stop_service
+        exit
+    end
+end
+
+d = KBServerDaemon.new
+d.mainloop

data/examples/kbserver_as_win32_service/kbserverctl.rb

@@ -1,75 +1,75 @@
-# Control script for the KBServer service.
-
-require 'optparse'
-require 'win32/service'
-include Win32
-
-# You will want to change these values.
-kbserver_home = 'C:\kbserver'
-kbserver_prog = kbserver_home + '\kbserver_daemon.rb'
-kbserver_svc = 'KirbyBaseServerSvc'
-kbserver_name = 'KirbyBase Database Server'
-
-OPTIONS = {}
-
-ARGV.options do |opts|
-    opts.on("-d",     "--delete",      "Delete the service") { 
-     OPTIONS[:delete] = true }
-    opts.on("-s",     "--start",       "Start the service") { 
-     OPTIONS[:start] = true }
-    opts.on("-x",     "--stop",        "Stop the service") { 
-     OPTIONS[:stop] = true }
-    opts.on("-i",     "--install",     "Install the service") { 
-     OPTIONS[:install] = true }
-    opts.on("-h",     "--help",        "Show this help message") { 
-     puts opts; exit }
-    opts.parse!
-end
-
-# Install the service.
-if OPTIONS[:install]
-    svc = Service.new
-    svc.create_service do |s|
-        s.service_name = kbserver_svc
-        s.display_name = kbserver_name
-        s.binary_path_name = 'c:\ruby\bin\ruby.exe ' + kbserver_prog
-        # This is required for now - bug in win32-service
-        s.dependencies = [] 
-    end
-    svc.close
-    puts "KirbyBase Server service installed"
-end    
-
-# Start the service.
-if OPTIONS[:start]
-    Service.start(kbserver_svc)
-    started = false
-    while started == false
-        s = Service.status(kbserver_svc)
-        started = true if s.current_state == "running"
-        break if started == true
-        puts "One moment, " + s.current_state
-        sleep 1
-    end
-    puts "KirbyBase Server service started"
-end
-
-# Stop the service.
-if OPTIONS[:stop]
-    begin
-        Service.stop(kbserver_svc)
-    rescue
-    end    
-    puts "KirbyBase Server service stopped"
-end
-
-# Delete the service.  Stop it first.
-if OPTIONS[:delete]
-    begin
-        Service.stop(kbserver_svc)
-    rescue
-    end
-    Service.delete(kbserver_svc)    
-    puts "KirbyBase Server service deleted"
-end
-
+# Control script for the KBServer service.
+
+require 'optparse'
+require 'win32/service'
+include Win32
+
+# You will want to change these values.
+kbserver_home = 'C:\kbserver'
+kbserver_prog = kbserver_home + '\kbserver_daemon.rb'
+kbserver_svc = 'KirbyBaseServerSvc'
+kbserver_name = 'KirbyBase Database Server'
+
+OPTIONS = {}
+
+ARGV.options do |opts|
+    opts.on("-d",     "--delete",      "Delete the service") { 
+     OPTIONS[:delete] = true }
+    opts.on("-s",     "--start",       "Start the service") { 
+     OPTIONS[:start] = true }
+    opts.on("-x",     "--stop",        "Stop the service") { 
+     OPTIONS[:stop] = true }
+    opts.on("-i",     "--install",     "Install the service") { 
+     OPTIONS[:install] = true }
+    opts.on("-h",     "--help",        "Show this help message") { 
+     puts opts; exit }
+    opts.parse!
+end
+
+# Install the service.
+if OPTIONS[:install]
+    svc = Service.new
+    svc.create_service do |s|
+        s.service_name = kbserver_svc
+        s.display_name = kbserver_name
+        s.binary_path_name = 'c:\ruby\bin\ruby.exe ' + kbserver_prog
+        # This is required for now - bug in win32-service
+        s.dependencies = [] 
+    end
+    svc.close
+    puts "KirbyBase Server service installed"
+end    
+
+# Start the service.
+if OPTIONS[:start]
+    Service.start(kbserver_svc)
+    started = false
+    while started == false
+        s = Service.status(kbserver_svc)
+        started = true if s.current_state == "running"
+        break if started == true
+        puts "One moment, " + s.current_state
+        sleep 1
+    end
+    puts "KirbyBase Server service started"
+end
+
+# Stop the service.
+if OPTIONS[:stop]
+    begin
+        Service.stop(kbserver_svc)
+    rescue
+    end    
+    puts "KirbyBase Server service stopped"
+end
+
+# Delete the service.  Stop it first.
+if OPTIONS[:delete]
+    begin
+        Service.stop(kbserver_svc)
+    rescue
+    end
+    Service.delete(kbserver_svc)    
+    puts "KirbyBase Server service deleted"
+end
+

data/examples/link_many_test/link_many_test.rb

@@ -1,70 +1,70 @@
-# This script demonstrates how to link a field in the table to a subset
-# of records from another table (i.e. a "one to many" link in database
-# lingo).
-
-# In this example, we have an order table and an order_item table.  Each
-# record in the order table represents a customer order.  The order_item
-# table holds the detail items for each order. We create a one-to-many link
-# between the order table and the order_item table by providing extra
-# information about the order.items field when we create the order table.
-
-require 'kirbybase'
-
-db = KirbyBase.new
-
-# To run as a client in a multi-user environment, uncomment next line.
-# Also, make sure kbserver.rb is running.
-#db = KirbyBase.new do |d|
-#    d.connect_type = :client
-#    d.host = 'localhost'
-#    d.port = 44444
-#end
-
-# If table exists, delete it.
-db.drop_table(:order) if db.table_exists?(:order)
-db.drop_table(:order_item) if db.table_exists?(:order_item)
-
-# Create an order item table.  This is the child table to the order table.
-# Create child table before creating parent table so that KirbyBase can
-# take advantage of any indexes.
-order_item_tbl = db.create_table(:order_item,
- :item_id, :Integer,
- :order_id, :Integer,
- :descr, :String,
- :qty, :Integer,
- :price, :Float
-)
-
-# Create a table.  We are telling KirbyBase that the items field is
-# to be linked to the order_item table by comparing the order.order_id
-# field to the order_item.order_id field.  By specifying :Link_many, we are
-# telling KirbyBase to make this a one-to-many link.  The result of this is
-# that when you do a select, the items field of the order table is going to
-# hold a reference to a ResultSet (i.e. Array) holding all order_item
-# records whose order_id field match the order_id field in the order record.
-order_tbl = db.create_table(:order,
- :order_id, :Integer,
- :customer, :String,
- :items, {:DataType=> :ResultSet, :Link_many=> [:order_id, :order_item,
- :order_id]}
-)
-
-# Insert some order records.
-order_tbl.insert({:order_id=>345, :customer=>'Ford'})
-order_tbl.insert({:order_id=>454, :customer=>'Microsoft'})
-order_tbl.insert({:order_id=>17, :customer=>'Boeing'})
-
-# Insert some order item records.
-order_item_tbl.insert(1,345,'Steel',30,19.99)
-order_item_tbl.insert(2,345,'Glass',5,4.15)
-order_item_tbl.insert(5,454,'Floppies',750000,0.5)
-order_item_tbl.insert(3,17,'Wheels',200,2500.0)
-order_item_tbl.insert(4,17,'Wings',25,1000000.0)
-
-# Print all orders.  Under each order print all items in that order.
-order_tbl.select.each do |r|
-    puts '%3d %s' % [r.order_id, r.customer]
-    r.items.each { |i|
-        puts "\t%d %15s %6d %10.2f" % [i.item_id, i.descr, i.qty, i.price]
-    }
-end
+# This script demonstrates how to link a field in the table to a subset
+# of records from another table (i.e. a "one to many" link in database
+# lingo).
+
+# In this example, we have an order table and an order_item table.  Each
+# record in the order table represents a customer order.  The order_item
+# table holds the detail items for each order. We create a one-to-many link
+# between the order table and the order_item table by providing extra
+# information about the order.items field when we create the order table.
+
+require 'kirbybase'
+
+db = KirbyBase.new
+
+# To run as a client in a multi-user environment, uncomment next line.
+# Also, make sure kbserver.rb is running.
+#db = KirbyBase.new do |d|
+#    d.connect_type = :client
+#    d.host = 'localhost'
+#    d.port = 44444
+#end
+
+# If table exists, delete it.
+db.drop_table(:order) if db.table_exists?(:order)
+db.drop_table(:order_item) if db.table_exists?(:order_item)
+
+# Create an order item table.  This is the child table to the order table.
+# Create child table before creating parent table so that KirbyBase can
+# take advantage of any indexes.
+order_item_tbl = db.create_table(:order_item,
+ :item_id, :Integer,
+ :order_id, :Integer,
+ :descr, :String,
+ :qty, :Integer,
+ :price, :Float
+)
+
+# Create a table.  We are telling KirbyBase that the items field is
+# to be linked to the order_item table by comparing the order.order_id
+# field to the order_item.order_id field.  By specifying :Link_many, we are
+# telling KirbyBase to make this a one-to-many link.  The result of this is
+# that when you do a select, the items field of the order table is going to
+# hold a reference to a ResultSet (i.e. Array) holding all order_item
+# records whose order_id field match the order_id field in the order record.
+order_tbl = db.create_table(:order,
+ :order_id, :Integer,
+ :customer, :String,
+ :items, {:DataType=> :ResultSet, :Link_many=> [:order_id, :order_item,
+ :order_id]}
+)
+
+# Insert some order records.
+order_tbl.insert({:order_id=>345, :customer=>'Ford'})
+order_tbl.insert({:order_id=>454, :customer=>'Microsoft'})
+order_tbl.insert({:order_id=>17, :customer=>'Boeing'})
+
+# Insert some order item records.
+order_item_tbl.insert(1,345,'Steel',30,19.99)
+order_item_tbl.insert(2,345,'Glass',5,4.15)
+order_item_tbl.insert(5,454,'Floppies',750000,0.5)
+order_item_tbl.insert(3,17,'Wheels',200,2500.0)
+order_item_tbl.insert(4,17,'Wings',25,1000000.0)
+
+# Print all orders.  Under each order print all items in that order.
+order_tbl.select.each do |r|
+    puts '%3d %s' % [r.order_id, r.customer]
+    r.items.each { |i|
+        puts "\t%d %15s %6d %10.2f" % [i.item_id, i.descr, i.qty, i.price]
+    }
+end