amalgalite 0.4.2-x86-mswin32-60

data/examples/gem-db.rb

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+
+#
+# Basic amalgalite example creating a table, inserting rows and doing various
+# selects and prepared statements
+#
+require 'rubygems'
+require 'amalgalite'
+
+#
+# Create a database, this will create the DB if it doesn't exist
+#
+puts "Opening database (version #{Amalgalite::Version})"
+db = Amalgalite::Database.new("gems.db")
+
+#
+# Setup taps into profile and trace information of sqlite, the profile tap will
+# goto the profile_tap.log file and the trace information will go to the
+# trace_tap.log file
+#
+puts "Establishing taps"
+db.trace_tap   = Amalgalite::Taps::IO.new( trace_tap_file = File.open("trace_tap.log", "w+") )
+db.profile_tap = Amalgalite::Taps::IO.new( profile_tap_file = File.open("profile_tap.log", "w+") )
+
+#
+# Create the schema unless it already exists in the table.  The meta information
+# about the database schema is available as the result of the db.schema method
+#
+schema = db.schema
+unless schema.tables['gems'] 
+  puts "Create schema"
+  db.execute <<-SQL
+  CREATE TABLE gems (
+    id      INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    name    VARCHAR(128),
+    version VARCHAR(32),
+    author  VARCHAR(128)
+  );
+  SQL
+  db.reload_schema!
+end
+
+#
+# Get some data from the system to insert into the database.  Since everyone
+# probably has gems installed, that's a ready known piece of information.  We'll
+# just pull in the latest version of each installed gem and dump some meta
+# information into a db for testing.
+#
+latest_specs = Gem.source_index.latest_specs
+
+puts "Inserting #{latest_specs.size} rows of gem information..."
+before = Time.now
+
+# Inserting bulk rows as a transaction is good practice with SQLite, it is
+# MUCH faster.  
+db.transaction do |db_in_transaction|
+  db_in_transaction.prepare("INSERT INTO gems(name, version, author) VALUES( :name, :version, :author );") do |stmt|
+    latest_specs.each do |spec|
+      insert_data = {}
+      insert_data[':name']    = spec.name.to_s
+      insert_data[':version'] = spec.version.to_s
+      insert_data[':author']  = spec.authors.join(' ')
+      #puts "Inserting #{insert_data.inspect}"
+      stmt.execute( insert_data )
+    end
+  end
+end
+puts "Took #{Time.now - before} seconds"
+puts "Done Inserting"
+
+authors_by_number = db.execute("SELECT author, count( name ) as num_gems FROM gems GROUP BY author ORDER BY num_gems DESC")
+favorite_author   = authors_by_number.first
+puts "Your favorite gem author is <#{favorite_author['author']}>, with #{favorite_author['num_gems']} gems installed."
+
+#
+# Now we'll look at the profile sampler and see what information it traced about
+# our behavoir.
+#
+db.profile_tap.samplers.each do |stat_name, stat_values|
+  puts "-" * 20
+  puts stat_values.to_s
+end
+
+#
+# Clear out the taps (not really necessary, just cleaning up)
+#
+db.trace_tap = profile_tap = nil
+
+#
+# close things down
+#
+db.close
+trace_tap_file.close
+profile_tap_file.close

data/examples/requires.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+#
+# An Amalgalite example showing how to 'require' data in an amalgalite database
+#
+# We'll make a database with one table, that we store file contents in.
+#
+
+$: << "../lib"
+$: << "../ext"
+require 'rubygems'
+require 'amalgalite'
+
+#
+# create the database 
+#
+File.unlink( "lib.db" ) if File.exist?( "lib.db" )
+db = Amalgalite::Database.new( "lib.db" )
+STDERR.puts "Creating rubylibs table"
+db.execute(<<-create)
+CREATE TABLE rubylibs(
+  id        INTEGER PRIMARY KEY AUTOINCREMENT,
+  filename  VARCHAR UNIQUE,
+  contents  TEXT
+)
+create
+
+
+#
+# insert some source code into a row
+#
+db.execute("INSERT INTO rubylibs(filename, contents) VALUES ( $filename, $contents )",
+           { "$filename" => "example",
+             "$contents" => <<code 
+class ExampleCode
+  def initialize( x )
+    puts "Initializing ExampleCode"
+    @x = x
+  end
+  
+  def foo
+   puts @x
+  end
+end
+code
+})
+db.close
+
+require 'amalgalite/requires'
+Amalgalite::Requires.new( :dbfile_name => "lib.db" )
+require 'example'
+e = ExampleCode.new( 'it works!' )
+e.foo
+                            

data/examples/schema-info.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'amalgalite'
+
+db_name = ARGV.shift
+unless db_name 
+  puts "Usage: #{File.basename($0)} dbname" 
+  exit 1
+end
+db = Amalgalite::Database.new( db_name )
+col_info = %w[ default_value declared_data_type collation_sequence_name not_null_constraint primary_key auto_increment ]
+max_width = col_info.collect { |c| c.length }.sort.last
+
+db.schema.tables.keys.sort.each do |table_name|
+  puts "Table: #{table_name}"
+  puts "=" * 42
+  db.schema.tables[table_name].columns.each_pair do |col_name, col|
+    puts "  Column : #{col.name}"
+    col_info.each do |ci|
+      puts "    |#{ci.rjust( max_width, "." )} : #{col.send( ci )}"
+    end
+    puts 
+  end
+
+  db.schema.tables[table_name].indexes.each_pair do |idx_name, index|
+    puts "  Index : #{index.name}"
+    puts "    |#{"sequence_number".rjust( max_width, "." )} : #{index.sequence_number}"
+    puts "    |#{"is unique?".rjust( max_width, ".")} : #{index.unique?}"
+    puts "    |#{"columns".rjust( max_width, ".")} : #{index.columns.collect { |c| c.name }.join(',') }"
+    puts
+  end
+end
+

data/ext/amalgalite3.c

@@ -0,0 +1,201 @@
+/**
+ * Copyright (c) 2008 Jeremy Hinegardner
+ * All rights reserved.  See LICENSE and/or COPYING for details.
+ *
+ * vim: shiftwidth=4 
+ */ 
+
+#include "amalgalite3.h"
+
+/* Module and Classes */
+VALUE mA;              /* module Amalgalite                     */
+VALUE mAS;             /* module Amalgalite::SQLite3            */
+VALUE mASV;            /* module Amalgalite::SQLite3::Version   */
+VALUE eAS_Error;       /* class  Amalgalite::SQLite3::Error     */
+VALUE cAS_Stat;        /* class  Amalgalite::SQLite3::Stat      */
+
+/*----------------------------------------------------------------------
+ * module methods for Amalgalite::SQLite3
+ *---------------------------------------------------------------------*/
+
+/*
+ * call-seq:
+ *    Amalgalite::SQLite3.threadsafe? -> true or false
+ *
+ * Has the SQLite3 extension been compiled "threadsafe".  If threadsafe? is
+ * true then the internal SQLite mutexes are enabled and SQLite is threadsafe.
+ * That is threadsafe within the context of 'C' threads.
+ *
+ */
+VALUE am_sqlite3_threadsafe(VALUE self)
+{
+    if (sqlite3_threadsafe()) {
+        return Qtrue;
+    } else {
+        return Qfalse;
+    }
+}
+
+/*
+ * call-seq:
+ *    Amalgalite::SQLite3.complete?( ... , opts = { :utf16 => false }) -> True, False
+ *
+ * Is the text passed in as a parameter a complete SQL statement?  Or is
+ * additional input required before sending the SQL to the extension.  If the
+ * extra 'opts' parameter is used, you can send in a UTF-16 encoded string as
+ * the SQL.
+ *
+ * A complete statement must end with a semicolon.
+ *
+ */
+VALUE am_sqlite3_complete(VALUE self, VALUE args)
+{
+    VALUE sql      = rb_ary_shift( args );
+    VALUE opts     = rb_ary_shift( args );
+    VALUE utf16    = Qnil;
+    int   result = 0;
+
+    if ( ( Qnil != opts ) && ( T_HASH == TYPE(opts) ) ){
+        utf16 = rb_hash_aref( opts, rb_intern("utf16") );
+    }
+
+    if ( (Qfalse == utf16) || (Qnil == utf16) ) {
+        result = sqlite3_complete( StringValuePtr( sql ) );
+    } else {
+        result = sqlite3_complete16( (void*) StringValuePtr( sql ) );
+    }
+
+    return ( result > 0 ) ? Qtrue : Qfalse;
+}
+
+/*
+ * call-seq:
+ *    Amalgalite::SQLite3::Stat.update!( reset = false ) -> nil
+ *
+ * Populates the _@current_ and _@higwater_ instance variables of self
+ * object with the values from the sqlite3_status call.  If reset it true then
+ * the highwater mark for the stat is reset
+ *
+ */
+VALUE am_sqlite3_stat_update_bang( int argc, VALUE *argv, VALUE self )
+{
+    int status_op  = -1;
+    int current    = -1;
+    int highwater  = -1;
+    VALUE reset    = Qfalse;
+    int reset_flag = 0;
+    int rc;
+
+    status_op  = FIX2INT( rb_iv_get( self, "@code" ) );
+    if ( argc > 0 ) {
+        reset = argv[0];
+        reset_flag = ( Qtrue == reset ) ? 1 : 0 ;
+    }
+
+    rc = sqlite3_status( status_op, &current, &highwater, reset_flag );
+
+    if ( SQLITE_OK != rc ) {
+        VALUE n    = rb_iv_get( self,  "@name" ) ;
+        char* name = StringValuePtr( n );
+        rb_raise(eAS_Error, "Failure to retrieve status for %s : [SQLITE_ERROR %d] \n", name, rc);
+    }
+
+    rb_iv_set( self, "@current", INT2NUM( current ) );
+    rb_iv_set( self, "@highwater", INT2NUM( highwater) );
+
+    return Qnil;
+}
+
+/*
+ * call-seq:
+ *    Amalgalite::SQLite3.randomness( N ) -> String of length N
+ *
+ * Generate N bytes of random data.
+ *
+ */
+VALUE am_sqlite3_randomness(VALUE self, VALUE num_bytes)
+{
+    int n     = NUM2INT(num_bytes);
+    char *buf = ALLOCA_N(char, n);
+
+    sqlite3_randomness( n, buf );
+    return rb_str_new( buf, n );
+}
+
+/*----------------------------------------------------------------------
+ * module methods for Amalgalite::SQLite3::Version
+ *---------------------------------------------------------------------*/
+
+/*
+ * call-seq:
+ *    Amalgalite::SQLite3::Version.to_s -> String
+ *
+ * Return the SQLite C library version number as a string
+ *
+ */
+VALUE am_sqlite3_libversion(VALUE self)
+{
+    return rb_str_new2(sqlite3_libversion());
+}
+
+/*
+ * call-seq:
+ *    Amalgalite::SQLite3.Version.to_i -> Fixnum
+ *
+ * Return the SQLite C library version number as an integer
+ *
+ */
+VALUE am_sqlite3_libversion_number(VALUE self)
+{
+    return INT2FIX(sqlite3_libversion_number());
+}
+
+/**
+ * Document-class: Amalgalite::SQLite3
+ *
+ * The SQLite ruby extension inside Amalgalite.
+ *
+ */
+
+void Init_amalgalite3()
+{
+    /*
+     * top level module encapsulating the entire Amalgalite library
+     */
+    mA   = rb_define_module("Amalgalite");
+
+    mAS  = rb_define_module_under(mA, "SQLite3");
+    rb_define_module_function(mAS, "threadsafe?", am_sqlite3_threadsafe, 0);
+    rb_define_module_function(mAS, "complete?", am_sqlite3_complete, -2);
+    rb_define_module_function(mAS, "randomness", am_sqlite3_randomness,1);
+
+    /*
+     * class encapsulating a single Stat
+     */
+    cAS_Stat = rb_define_class_under(mAS, "Stat", rb_cObject);
+    rb_define_method(cAS_Stat, "update!", am_sqlite3_stat_update_bang, -1);
+
+    /* 
+     * Base class of all SQLite3 errors
+     */
+    eAS_Error = rb_define_class_under(mAS, "Error", rb_eStandardError); /* in amalgalite.c */
+
+    /**
+     * Encapsulation of the SQLite C library version
+     */
+    mASV = rb_define_module_under(mAS, "Version");
+    rb_define_module_function(mASV, "to_s", am_sqlite3_libversion, 0); /* in amalgalite3.c */
+    rb_define_module_function(mASV, "to_i", am_sqlite3_libversion_number, 0); /* in amalgalite3.c */
+
+    /*
+     * Initialize the rest of the module
+     */
+    Init_amalgalite3_constants( );
+    Init_amalgalite3_database( );
+    Init_amalgalite3_statement( );
+    Init_amalgalite3_blob( );
+    Init_amalgalite3_requires_bootstrap( );
+
+ }
+
+

data/ext/amalgalite3.h

@@ -0,0 +1,121 @@
+/**
+ * Copyright (c) 2008 Jeremy Hinegardner
+ * All rights reserved.  See LICENSE and/or COPYING for details.
+ *
+ * vim: shiftwidth=4 
+ */ 
+
+#ifndef __AMALGALITE_H__
+#define __AMALGALITE_H__
+
+#include "ruby.h"
+#include "sqlite3.h"
+
+/* wrapper struct around the sqlite3 opaque pointer */
+typedef struct am_sqlite3 {
+  sqlite3 *db;
+  VALUE    trace_obj;
+  VALUE    profile_obj;
+} am_sqlite3;
+
+/* wrapper struct around the sqlite3_statement opaque pointer */
+typedef struct am_sqlite3_stmt {
+  sqlite3_stmt *stmt;
+  VALUE         remaining_sql;
+} am_sqlite3_stmt;
+
+/* wrapper struct around the sqlite3_blob opaque ponter */
+typedef struct am_sqlite3_blob {
+  sqlite3_blob *blob;
+  sqlite3      *db;
+  int           length;
+  int           current_offset;
+} am_sqlite3_blob;
+
+
+/** module and classes **/
+extern VALUE mA;              /* module Amalgalite                     */
+extern VALUE mAS;             /* module Amalgalite::SQLite3            */
+extern VALUE mASV;            /* module Amalgalite::SQLite3::Version   */
+extern VALUE eAS_Error;       /* class  Amalgalite::SQLite3::Error     */
+
+/*----------------------------------------------------------------------
+ * Prototype for Amalgalite::SQLite3::Database
+ *---------------------------------------------------------------------*/
+extern VALUE cAS_Database;    /* class  Amalgliate::SQLite3::Database  */
+
+extern void  am_define_constants_under(VALUE);
+extern VALUE am_sqlite3_database_alloc(VALUE klass);
+extern void  am_sqlite3_database_free(am_sqlite3*);
+extern VALUE am_sqlite3_database_open(int argc, VALUE* argv, VALUE self);
+extern VALUE am_sqlite3_database_close(VALUE self);
+extern VALUE am_sqlite3_database_open16(VALUE self, VALUE rFilename);
+extern VALUE am_sqlite3_database_last_insert_rowid(VALUE self);
+extern VALUE am_sqlite3_database_is_autocommit(VALUE self);
+extern VALUE am_sqlite3_database_row_changes(VALUE self);
+extern VALUE am_sqlite3_database_total_changes(VALUE self);
+extern VALUE am_sqlite3_database_table_column_metadata(VALUE self, VALUE db_name, VALUE tbl_name, VALUE col_name);
+
+extern VALUE am_sqlite3_database_prepare(VALUE self, VALUE rSQL);
+extern VALUE am_sqlite3_database_register_trace_tap(VALUE self, VALUE tap);
+extern VALUE am_sqlite3_database_register_profile_tap(VALUE self, VALUE tap);
+
+/*----------------------------------------------------------------------
+ * Prototype for Amalgalite::SQLite3::Statement 
+ *---------------------------------------------------------------------*/
+extern VALUE cAS_Statement;   /* class  Amalgalite::SQLite3::Statement */
+
+extern VALUE am_sqlite3_statement_alloc(VALUE klass);
+extern void  am_sqlite3_statement_free(am_sqlite3_stmt* );
+extern VALUE am_sqlite3_statement_sql(VALUE self);
+extern VALUE am_sqlite3_statement_close(VALUE self);
+extern VALUE am_sqlite3_statement_step(VALUE self);
+extern VALUE am_sqlite3_statement_column_count(VALUE self);
+extern VALUE am_sqlite3_statement_column_name(VALUE self, VALUE index);
+extern VALUE am_sqlite3_statement_column_decltype(VALUE self, VALUE index);
+extern VALUE am_sqlite3_statement_column_type(VALUE self, VALUE index);
+extern VALUE am_sqlite3_statement_column_blob(VALUE self, VALUE index);
+extern VALUE am_sqlite3_statement_column_text(VALUE self, VALUE index);
+extern VALUE am_sqlite3_statement_column_int(VALUE self, VALUE index);
+extern VALUE am_sqlite3_statement_column_int64(VALUE self, VALUE index);
+extern VALUE am_sqlite3_statement_column_double(VALUE self, VALUE index);
+
+extern VALUE am_sqlite3_statement_column_database_name(VALUE self, VALUE position);
+extern VALUE am_sqlite3_statement_column_table_name(VALUE self, VALUE position);
+extern VALUE am_sqlite3_statement_column_origin_name(VALUE self, VALUE position);
+
+extern VALUE am_sqlite3_statement_reset(VALUE self);
+extern VALUE am_sqlite3_statement_clear_bindings(VALUE self);
+extern VALUE am_sqlite3_statement_bind_parameter_count(VALUE self);
+extern VALUE am_sqlite3_statement_bind_parameter_index(VALUE self, VALUE parameter_name);
+extern VALUE am_sqlite3_statement_remaining_sql(VALUE self);
+extern VALUE am_sqlite3_statement_bind_text(VALUE self, VALUE position, VALUE value);
+extern VALUE am_sqlite3_statement_bind_blob(VALUE self, VALUE position, VALUE value);
+extern VALUE am_sqlite3_statement_bind_zeroblob(VALUE self, VALUE position, VALUE value);
+extern VALUE am_sqlite3_statement_bind_int(VALUE self, VALUE position, VALUE value);
+extern VALUE am_sqlite3_statement_bind_int64(VALUE self, VALUE position, VALUE value);
+extern VALUE am_sqlite3_statement_bind_double(VALUE self, VALUE position, VALUE value);
+extern VALUE am_sqlite3_statement_bind_null(VALUE self, VALUE position);
+
+/*----------------------------------------------------------------------
+ * Prototype for Amalgalite::SQLite3::Blob
+ *---------------------------------------------------------------------*/
+extern VALUE cAS_Blob; /* class Amalgalite::SQLite3::Blob */
+
+extern VALUE am_sqlite3_blob_alloc(VALUE klass);
+extern VALUE am_sqlite3_blob_initialize( VALUE self, VALUE db, VALUE db_name, VALUE table_name, VALUE column_name, VALUE rowid, VALUE flag) ;
+extern void  am_sqlite3_blob_free(am_sqlite3_blob* );
+extern VALUE am_sqlite3_blob_read(VALUE self, VALUE length);
+extern VALUE am_sqlite3_blob_write(VALUE self, VALUE buffer);
+extern VALUE am_sqlite3_blob_close(VALUE self);
+extern VALUE am_sqlite3_blob_length(VALUE self);
+
+/***********************************************************************
+ * Type conversion macros between sqlite data types and ruby types
+ **********************************************************************/
+
+#define SQLINT64_2NUM(x)      ( LL2NUM( x ) )
+#define SQLUINT64_2NUM(x)     ( ULL2NUM( x ) )
+#define NUM2SQLINT64( obj )   ( NUM2LL( obj ) )
+#define NUM2SQLUINT64( obj )  ( NUM2ULL( obj ) )
+#endif