sqlite3-ruby 0.5.0 → 0.6.0

data/doc/faq/faq.html

@@ -62,25 +62,25 @@
 <ul>
 <li>How do I do a database query?
 <ul>
-<li><a href='#538675576'>I just want an array of the rows&#8230;</a></li>
-<li><a href='#538675536'>I&#8217;d like to use a block to iterate through the rows&#8230;</a></li>
-<li><a href='#538675496'>I need to get the column names as well as the rows&#8230;</a></li>
-<li><a href='#538675456'>I just want the first row of the result set&#8230;</a></li>
-<li><a href='#538675416'>I just want the first value of the first row of the result set&#8230;</a></li>
+<li><a href='#538646076'>I just want an array of the rows&#8230;</a></li>
+<li><a href='#538646036'>I&#8217;d like to use a block to iterate through the rows&#8230;</a></li>
+<li><a href='#538645996'>I need to get the column names as well as the rows&#8230;</a></li>
+<li><a href='#538645956'>I just want the first row of the result set&#8230;</a></li>
+<li><a href='#538645916'>I just want the first value of the first row of the result set&#8230;</a></li>
 </ul>
 </li>
-<li><a href='#538675346'>How do I prepare a statement for repeated execution?</a></li>
-<li><a href='#538675306'>How do I use placeholders in an <span class="caps">SQL</span> statement?</a></li>
-<li><a href='#538675266'>How do I discover metadata about a query?</a></li>
-<li><a href='#538675226'>I&#8217;d like the rows to be indexible by column name.</a></li>
-<li><a href='#538675186'>I&#8217;d like the values from a query to be the correct types, instead of String.</a></li>
-<li><a href='#538675146'>How do insert binary data into the database?</a></li>
-<li><a href='#538675106'>How do I do a <span class="caps">DDL </span>(insert, update, delete) statement?</a></li>
-<li><a href='#538675066'>How do I execute multiple statements in a single string?</a></li>
-<li><a href='#538675026'>How do I begin/end a transaction?</a></li>
+<li><a href='#538645846'>How do I prepare a statement for repeated execution?</a></li>
+<li><a href='#538645806'>How do I use placeholders in an <span class="caps">SQL</span> statement?</a></li>
+<li><a href='#538645766'>How do I discover metadata about a query?</a></li>
+<li><a href='#538645726'>I&#8217;d like the rows to be indexible by column name.</a></li>
+<li><a href='#538645686'>I&#8217;d like the values from a query to be the correct types, instead of String.</a></li>
+<li><a href='#538645646'>How do insert binary data into the database?</a></li>
+<li><a href='#538645606'>How do I do a <span class="caps">DDL </span>(insert, update, delete) statement?</a></li>
+<li><a href='#538645566'>How do I execute multiple statements in a single string?</a></li>
+<li><a href='#538645526'>How do I begin/end a transaction?</a></li>
 </ul>
 </div>
-<a name='538675576'></a>
+<a name='538646076'></a>
 <div class='faq-title'>How do I do a database query? I just want an array of the rows&#8230;</div>
 <div class='faq-answer'><p>Use the <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Database.html'>Database#execute</a> method. If you don&#8217;t give it a block, it will return an array of all the rows:</p>
 
@@ -91,7 +91,7 @@
   db = SQLite3::<a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Database.html'>Database</a>.new( "test.db" )
   rows = db.execute( "select * from test" )
 </pre></div>
-<a name='538675536'></a>
+<a name='538646036'></a>
 <div class='faq-title'>How do I do a database query? I&#8217;d like to use a block to iterate through the rows&#8230;</div>
 <div class='faq-answer'><p>Use the <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Database.html'>Database#execute</a> method. If you give it a block, each row of the result will be yielded to the block:</p>
 
@@ -104,7 +104,7 @@
     ...
   end
 </pre></div>
-<a name='538675496'></a>
+<a name='538645996'></a>
 <div class='faq-title'>How do I do a database query? I need to get the column names as well as the rows&#8230;</div>
 <div class='faq-answer'><p>Use the <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Database.html'>Database#execute2</a> method. This works just like <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Database.html'>Database#execute</a>; if you don&#8217;t give it a block, it returns an array of rows; otherwise, it will yield each row to the block. <em>However</em>, the first row returned is always an array of the column names from the query:</p>
 
@@ -126,7 +126,7 @@
     end
   end
 </pre></div>
-<a name='538675456'></a>
+<a name='538645956'></a>
 <div class='faq-title'>How do I do a database query? I just want the first row of the result set&#8230;</div>
 <div class='faq-answer'><p>Easy. Just call <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Database.html'>Database#get_first_row</a>:</p>
 
@@ -135,7 +135,7 @@
   row = db.get_first_row( "select * from table" )
 </pre>
 	<p>This also supports bind variables, just like <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Database.html'>Database#execute</a> and friends.</p></div>
-<a name='538675416'></a>
+<a name='538645916'></a>
 <div class='faq-title'>How do I do a database query? I just want the first value of the first row of the result set&#8230;</div>
 <div class='faq-answer'><p>Also easy. Just call <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Database.html'>Database#get_first_value</a>:</p>
 
@@ -144,7 +144,7 @@
   count = db.get_first_value( "select count(*) from table" )
 </pre>
 	<p>This also supports bind variables, just like <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Database.html'>Database#execute</a> and friends.</p></div>
-<a name='538675346'></a>
+<a name='538645846'></a>
 <div class='faq-title'>How do I prepare a statement for repeated execution?</div>
 <div class='faq-answer'><p>If the same statement is going to be executed repeatedly, you can speed things up a bit by <em>preparing</em> the statement. You do this via the <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Database.html'>Database#prepare</a> method. It returns a <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Statement.html'>Statement</a> object, and you can then invoke #execute on that to get the <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/ResultSet.html'>ResultSet</a>:</p>
 
@@ -171,7 +171,7 @@
   end
 </pre>
 	<p>This is made more useful by the ability to bind variables to placeholders via the <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Statement.html'>Statement#bind_param</a> and <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Statement.html'>Statement#bind_params</a> methods. (See the next <span class="caps">FAQ</span> for details.)</p></div>
-<a name='538675306'></a>
+<a name='538645806'></a>
 <div class='faq-title'>How do I use placeholders in an <span class="caps">SQL</span> statement?</div>
 <div class='faq-answer'><p>Placeholders in an <span class="caps">SQL</span> statement take any of the following formats:</p>
 	<ul>
@@ -235,7 +235,7 @@
 
   stmt.bind_params( "value", "name" =&gt; "bob" )
 </pre></div>
-<a name='538675266'></a>
+<a name='538645766'></a>
 <div class='faq-title'>How do I discover metadata about a query?</div>
 <div class='faq-answer'><p>If you ever want to know the names or types of the columns in a result set, you can do it in several ways.</p>
 
@@ -265,7 +265,7 @@
   p stmt.columns
   p stmt.types
 </pre></div>
-<a name='538675226'></a>
+<a name='538645726'></a>
 <div class='faq-title'>I&#8217;d like the rows to be indexible by column name.</div>
 <div class='faq-answer'><p>By default, each row from a query is returned as an Array of values. This means that you can only obtain values by their index. Sometimes, however, you would like to obtain values by their column name.</p>
 
@@ -291,7 +291,7 @@
     p row[1] == row['column2']
   end
 </pre></div>
-<a name='538675186'></a>
+<a name='538645686'></a>
 <div class='faq-title'>I&#8217;d like the values from a query to be the correct types, instead of String.</div>
 <div class='faq-answer'><p>You can turn on &#8220;type translation&#8221; by setting <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Database.html'>Database#type_translation</a> to true:</p>
 
@@ -327,7 +327,7 @@
   obj = db.get_first_value( "select thing from objects where name='bob'" )
   p obj == h
 </pre></div>
-<a name='538675146'></a>
+<a name='538645646'></a>
 <div class='faq-title'>How do insert binary data into the database?</div>
 <div class='faq-answer'><p>Use blobs. Blobs are new features of SQLite3. You have to use bind variables to make it work:</p>
 
@@ -338,7 +338,7 @@
     SQLite3::Blob.new( "a\0b\0c\0d ) )
 </pre>
 	<p>The blob values must be indicated explicitly by binding each parameter to a value of type SQLite3::Blob.</p></div>
-<a name='538675106'></a>
+<a name='538645606'></a>
 <div class='faq-title'>How do I do a <span class="caps">DDL </span>(insert, update, delete) statement?</div>
 <div class='faq-answer'><p>You can actually do inserts, updates, and deletes in exactly the same way as selects, but in general the <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Database.html'>Database#execute</a> method will be most convenient:</p>
 
@@ -346,7 +346,7 @@
 <pre>
   db.execute( "insert into table values ( ?, ? )", *bind_vars )
 </pre></div>
-<a name='538675066'></a>
+<a name='538645566'></a>
 <div class='faq-title'>How do I execute multiple statements in a single string?</div>
 <div class='faq-answer'><p>The standard query methods (<a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Database.html'>Database#execute</a>, <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Database.html'>Database#execute2</a>, <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Database.html'>Database#query</a>, and <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Statement.html'>Statement#execute</a>) will only execute the first statement in the string that is given to them. Thus, if you have a string with multiple <span class="caps">SQL</span> statements, each separated by a string, you can&#8217;t use those methods to execute them all at once.</p>
 
@@ -368,7 +368,7 @@
   db.execute_batch( sql )
 </pre>
 	<p>Unlike the other query methods, <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Database.html'>Database#execute_batch</a> accepts no block. It will also only ever return <ins>nil</ins>. Thus, it is really only suitable for batch processing of <span class="caps">DDL</span> statements.</p></div>
-<a name='538675026'></a>
+<a name='538645526'></a>
 <div class='faq-title'>How do I begin/end a transaction?</div>
 <div class='faq-answer'><p>Use <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Database.html'>Database#transaction</a> to start a transaction. If you give it a block, the block will be automatically committed at the end of the block, unless an exception was raised, in which case the transaction will be rolled back. (Never explicitly call <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Database.html'>Database#commit</a> or <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Database.html'>Database#rollback</a> inside of a transaction block&#8212;you&#8217;ll get errors when the block terminates!)</p>
 

data/lib/sqlite3/database.rb

@@ -71,7 +71,16 @@ module SQLite3
     include Pragmas
 
     class <<self
+
       alias :open :new
+
+      # Quotes the given string, making it safe to use in an SQL statement.
+      # It replaces all instances of the single-quote character with two
+      # single-quote characters. The modified string is returned.
+      def quote( string )
+        string.gsub( /'/, "''" )
+      end
+
     end
 
     # The low-level opaque database handle that this object wraps.
@@ -108,13 +117,6 @@ module SQLite3
       @translator = nil
     end
 
-    # Quotes the given string, making it safe to use in an SQL statement.
-    # It replaces all instances of the single-quote character with two
-    # single-quote characters. The modified string is returned.
-    def quote( string )
-      string.gsub( /'/, "''" )
-    end
-
     # Return +true+ if the string is a valid (ie, parsable) SQL statement, and
     # +false+ otherwise. If +utf16+ is +true+, then the string is a UTF-16
     # character string.

data/lib/sqlite3/driver/dl/api.rb

@@ -38,6 +38,8 @@ module SQLite3 ; module Driver; module DL;
     extend ::DL::Importable
 
     library_name = case RUBY_PLATFORM.downcase
+      when /darwin/
+        "libsqlite3.dylib"
       when /linux/
         "libsqlite3.so"
       when /win32/
@@ -49,7 +51,7 @@ The platform '#{RUBY_PLATFORM}' is unsupported. Please help the author by
 editing the following file to allow your sqlite3 library to be found, and
 submitting a patch to jamis_buck@byu.edu. Thanks!
 
-#{' '*((74-__FILE__.length)/2)}-> #{__FILE__} <-
+#{__FILE__}
 =========================================================================== * ==
         EOF
     end

data/lib/sqlite3/driver/dl/api.rb~

@@ -0,0 +1,182 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+#     * Redistributions of source code must retain the above copyright notice,
+#       this list of conditions and the following disclaimer.
+# 
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+# 
+#     * The names of its contributors may not be used to endorse or promote
+#       products derived from this software without specific prior written
+#       permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# =============================================================================
+#++
+
+require 'dl/import'
+
+module SQLite3 ; module Driver; module DL;
+
+  module API
+    extend ::DL::Importable
+
+    library_name = case RUBY_PLATFORM.downcase
+      when /linux/
+        "libsqlite3.so"
+      when /win32/
+        "sqlite3.dll"
+      else
+        abort <<-EOF
+== * UNSUPPORTED PLATFORM ======================================================
+The platform '#{RUBY_PLATFORM}' is unsupported. Please help the author by
+editing the following file to allow your sqlite3 library to be found, and
+submitting a patch to jamis_buck@byu.edu. Thanks!
+
+#{' '*((74-__FILE__.length)/2)}-> #{__FILE__} <-
+=========================================================================== * ==
+        EOF
+    end
+
+    if defined? SQLITE3_LIB_PATH
+      library_name = File.join( SQLITE3_LIB_PATH, library_name )
+    end
+
+    dlload library_name
+
+    typealias "db",      "void*"
+    typealias "stmt",    "void*"
+    typealias "value",   "void*"
+    typealias "context", "void*"
+
+    # until Ruby/DL supports 64-bit ints, we'll just treat them as 32-bit ints
+    typealias "int64", "unsigned long"
+
+    extern "const char *sqlite3_libversion()"
+
+    extern "int sqlite3_open(const char*,db*)"
+    extern "int sqlite3_open16(const void*,db*)"
+    extern "int sqlite3_close(db)"
+    extern "const char* sqlite3_errmsg(db)"
+    extern "void* sqlite3_errmsg16(db)"
+    extern "int sqlite3_errcode(db)"
+
+    extern "int sqlite3_prepare(db,const char*,int,stmt*,const char**)"
+    extern "int sqlite3_prepare16(db,const void*,int,stmt*,const void**)"
+    extern "int sqlite3_finalize(stmt)"
+    extern "int sqlite3_reset(stmt)"
+    extern "int sqlite3_step(stmt)"
+
+    extern "int64 sqlite3_last_insert_rowid(db)"
+    extern "int sqlite3_changes(db)"
+    extern "int sqlite3_total_changes(db)"
+    extern "void sqlite3_interrupt(db)"
+    extern "ibool sqlite3_complete(const char*)"
+    extern "ibool sqlite3_complete16(const void*)"
+
+    extern "int sqlite3_busy_handler(db,void*,void*)"
+    extern "int sqlite3_busy_timeout(db,int)"
+
+    extern "int sqlite3_set_authorizer(db,void*,void*)"
+    extern "void* sqlite3_trace(db,void*,void*)"
+
+    extern "int sqlite3_bind_blob(stmt,int,const void*,int,void*)"
+    extern "int sqlite3_bind_double(stmt,int,double)"
+    extern "int sqlite3_bind_int(stmt,int,int)"
+    extern "int sqlite3_bind_int64(stmt,int,int64)"
+    extern "int sqlite3_bind_null(stmt,int)"
+    extern "int sqlite3_bind_text(stmt,int,const char*,int,void*)"
+    extern "int sqlite3_bind_text16(stmt,int,const void*,int,void*)"
+    #extern "int sqlite3_bind_value(stmt,int,value)"
+
+    extern "int sqlite3_bind_parameter_count(stmt)"
+    extern "const char* sqlite3_bind_parameter_name(stmt,int)"
+    extern "int sqlite3_bind_parameter_index(stmt,const char*)"
+
+    extern "int sqlite3_column_count(stmt)"
+    extern "int sqlite3_data_count(stmt)"
+
+    extern "const void *sqlite3_column_blob(stmt,int)"
+    extern "int sqlite3_column_bytes(stmt,int)"
+    extern "int sqlite3_column_bytes16(stmt,int)"
+    extern "const char *sqlite3_column_decltype(stmt,int)"
+    extern "void *sqlite3_column_decltype16(stmt,int)"
+    extern "double sqlite3_column_double(stmt,int)"
+    extern "int sqlite3_column_int(stmt,int)"
+    extern "int64 sqlite3_column_int64(stmt,int)"
+    extern "const char *sqlite3_column_name(stmt,int)"
+    extern "const void *sqlite3_column_name16(stmt,int)"
+    extern "const char *sqlite3_column_text(stmt,int)"
+    extern "const void *sqlite3_column_text16(stmt,int)"
+    extern "int sqlite3_column_type(stmt,int)"
+
+    extern "int sqlite3_create_function(db,const char*,int,int,void*,void*,void*,void*)"
+    extern "int sqlite3_create_function16(db,const void*,int,int,void*,void*,void*,void*)"
+    extern "int sqlite3_aggregate_count(context)"
+
+    extern "const void *sqlite3_value_blob(value)"
+    extern "int sqlite3_value_bytes(value)"
+    extern "int sqlite3_value_bytes16(value)"
+    extern "double sqlite3_value_double(value)"
+    extern "int sqlite3_value_int(value)"
+    extern "int64 sqlite3_value_int64(value)"
+    extern "const char* sqlite3_value_text(value)"
+    extern "const void* sqlite3_value_text16(value)"
+    extern "const void* sqlite3_value_text16le(value)"
+    extern "const void* sqlite3_value_text16be(value)"
+    extern "int sqlite3_value_type(value)"
+
+    extern "void *sqlite3_aggregate_context(context,int)"
+    extern "void *sqlite3_user_data(context)"
+    extern "void *sqlite3_get_auxdata(context,int)"
+    extern "void sqlite3_set_auxdata(context,int,void*,void*)"
+
+    extern "void sqlite3_result_blob(context,const void*,int,void*)"
+    extern "void sqlite3_result_double(context,double)"
+    extern "void sqlite3_result_error(context,const char*,int)"
+    extern "void sqlite3_result_error16(context,const void*,int)"
+    extern "void sqlite3_result_int(context,int)"
+    extern "void sqlite3_result_int64(context,int64)"
+    extern "void sqlite3_result_null(context)"
+    extern "void sqlite3_result_text(context,const char*,int,void*)"
+    extern "void sqlite3_result_text16(context,const void*,int,void*)"
+    extern "void sqlite3_result_text16le(context,const void*,int,void*)"
+    extern "void sqlite3_result_text16be(context,const void*,int,void*)"
+    extern "void sqlite3_result_value(context,value)"
+
+    extern "int sqlite3_create_collation(db,const char*,int,void*,void*)"
+    extern "int sqlite3_create_collation16(db,const char*,int,void*,void*)"
+    extern "int sqlite3_collation_needed(db,void*,void*)"
+    extern "int sqlite3_collation_needed16(db,void*,void*)"
+
+    # ==== CRYPTO (NOT IN PUBLIC RELEASE) ====
+    if defined?( CRYPTO_API ) && CRYPTO_API
+      extern "int sqlite3_key(db,void*,int)"
+      extern "int sqlite3_rekey(db,void*,int)"
+    end
+
+    # ==== EXPERIMENTAL ====
+    if defined?( EXPERIMENTAL_API ) && EXPERIMENTAL_API
+      extern "int sqlite3_progress_handler(db,int,void*,void*)"
+      extern "int sqlite3_commit_hook(db,void*,void*)"
+    end
+
+  end
+
+end ; end ; end

data/lib/sqlite3/version.rb

@@ -35,7 +35,7 @@ module SQLite3
   module Version
 
     MAJOR = 0
-    MINOR = 5
+    MINOR = 6
     TINY  = 0
 
     STRING = [ MAJOR, MINOR, TINY ].join( "." )

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.3
 specification_version: 1
 name: sqlite3-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
-date: 2004-12-21
+  version: 0.6.0
+date: 2004-12-29
 summary: SQLite3/Ruby is a module to allow Ruby scripts to interface with a SQLite3 database.
 require_paths: 
   - lib
@@ -46,6 +46,7 @@ files:
   - lib/sqlite3/driver/dl
   - lib/sqlite3/driver/dl/driver.rb
   - lib/sqlite3/driver/dl/api.rb
+  - lib/sqlite3/driver/dl/api.rb~
   - test/bm.rb
   - test/mocks.rb
   - test/tests.rb