sqlite-ruby 2.1.0 → 2.2.0

data/doc/faq/faq.html

@@ -62,25 +62,25 @@
 <ul>
 <li>How do I do a database query?
 <ul>
-<li><a href='#538732450'>I just want an array of the rows&#8230;</a></li>
-<li><a href='#538732410'>I&#8217;d like to use a block to iterate through the rows&#8230;</a></li>
-<li><a href='#538732370'>I need to get the column names as well as the rows&#8230;</a></li>
-<li><a href='#538732330'>I need the result set object itself&#8230;</a></li>
-<li><a href='#538732290'>I just want the first row of the result set&#8230;</a></li>
-<li><a href='#538732250'>I just want the first value of the first row of the result set&#8230;</a></li>
+<li><a href='#538840882'>I just want an array of the rows&#8230;</a></li>
+<li><a href='#538840832'>I&#8217;d like to use a block to iterate through the rows&#8230;</a></li>
+<li><a href='#538840792'>I need to get the column names as well as the rows&#8230;</a></li>
+<li><a href='#538840732'>I need the result set object itself&#8230;</a></li>
+<li><a href='#538840692'>I just want the first row of the result set&#8230;</a></li>
+<li><a href='#538840632'>I just want the first value of the first row of the result set&#8230;</a></li>
 </ul>
 </li>
-<li><a href='#538732180'>How do I prepare a statement for repeated execution?</a></li>
-<li><a href='#538732140'>How do I use placeholders in an <span class="caps">SQL</span> statement?</a></li>
-<li><a href='#538732100'>How do I discover metadata about a query?</a></li>
-<li><a href='#538732060'>I&#8217;d like the rows to be indexible by column name.</a></li>
-<li><a href='#538732020'>I&#8217;d like the values from a query to be the correct types, instead of String.</a></li>
-<li><a href='#538731980'>How do I do a <span class="caps">DDL </span>(insert, update, delete) statement?</a></li>
-<li><a href='#538731940'>How do I execute multiple statements in a single string?</a></li>
-<li><a href='#538731900'>How do I begin/end a transaction?</a></li>
+<li><a href='#538840552'>How do I prepare a statement for repeated execution?</a></li>
+<li><a href='#538840502'>How do I use placeholders in an <span class="caps">SQL</span> statement?</a></li>
+<li><a href='#538840462'>How do I discover metadata about a query?</a></li>
+<li><a href='#538840402'>I&#8217;d like the rows to be indexible by column name.</a></li>
+<li><a href='#538840362'>I&#8217;d like the values from a query to be the correct types, instead of String.</a></li>
+<li><a href='#538840302'>How do I do a <span class="caps">DDL </span>(insert, update, delete) statement?</a></li>
+<li><a href='#538840262'>How do I execute multiple statements in a single string?</a></li>
+<li><a href='#538840212'>How do I begin/end a transaction?</a></li>
 </ul>
 </div>
-<a name='538732450'></a>
+<a name='538840882'></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>
 
@@ -90,7 +90,7 @@
   db = SQLite::<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='538732410'></a>
+<a name='538840832'></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>
 
@@ -102,7 +102,7 @@
     ...
   end
 </pre></div>
-<a name='538732370'></a>
+<a name='538840792'></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>
 
@@ -123,7 +123,7 @@
     end
   end
 </pre></div>
-<a name='538732330'></a>
+<a name='538840732'></a>
 <div class='faq-title'>How do I do a database query? I need the result set object itself&#8230;</div>
 <div class='faq-answer'><p>Sometimes you don&#8217;t want all the rows at once, and yet you&#8217;d like to be able to iterate through the results. For instance, you may want to pass the results to some other function (or series of functions) and have them pull rows from the results on demand. This is more effecient for very large queries.</p>
 
@@ -167,7 +167,7 @@
 </pre>
 
 	<p>In general, <a href='http://sqlite-ruby.rubyforge.org/classes/SQLite/Database.html'>Database#query</a> is not a very good choice for such operations&#8230;</p></div>
-<a name='538732290'></a>
+<a name='538840692'></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>
 
@@ -176,7 +176,7 @@
 </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='538732250'></a>
+<a name='538840632'></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>
 
@@ -185,7 +185,7 @@
 </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='538732180'></a>
+<a name='538840552'></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>
 
@@ -200,7 +200,7 @@
 </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='538732140'></a>
+<a name='538840502'></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>
 
@@ -258,7 +258,7 @@
 
   stmt.bind_params( "value", "name" =&gt; "bob" )
 </pre></div>
-<a name='538732100'></a>
+<a name='538840462'></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>
 
@@ -287,7 +287,7 @@
   p stmt.columns
   p stmt.types
 </pre></div>
-<a name='538732060'></a>
+<a name='538840402'></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>
 
@@ -312,7 +312,7 @@
     p row[1] == row['column2']
   end
 </pre></div>
-<a name='538732020'></a>
+<a name='538840362'></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>
 
@@ -347,14 +347,14 @@
   obj = db.get_first_value( "select thing from objects where name='bob'" )
   p obj == h
 </pre></div>
-<a name='538731980'></a>
+<a name='538840302'></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>
 
 <pre>
   db.execute( "insert into table values ( ?, ? )", *bind_vars )
 </pre></div>
-<a name='538731940'></a>
+<a name='538840262'></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>
 
@@ -376,7 +376,7 @@
 </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='538731900'></a>
+<a name='538840212'></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/ext/sqlite-api.c

@@ -86,7 +86,7 @@ static ID    idTypes;
 static ID    idCall;
 
 static struct {
-  char *name;
+  const char *name;
   VALUE object;
 } g_sqlite_exceptions[] = {
   { "OK", 0 },
@@ -173,15 +173,9 @@ static_api_close( VALUE module, VALUE db );
 static VALUE
 static_api_compile( VALUE module, VALUE db, VALUE sql );
 
-static VALUE
-static_api_bind( VALUE module, VALUE vm, VALUE idx, VALUE value );
-
 static VALUE
 static_api_finalize( VALUE module, VALUE vm );
 
-static VALUE
-static_api_reset( VALUE module, VALUE vm );
-
 static VALUE
 static_api_last_insert_row_id( VALUE module, VALUE db );
 
@@ -200,12 +194,6 @@ static_api_busy_handler( VALUE module, VALUE db, VALUE handler );
 static VALUE
 static_api_busy_timeout( VALUE module, VALUE db, VALUE ms );
 
-static VALUE
-static_api_progress_handler( VALUE module, VALUE db, VALUE n, VALUE handler );
-
-static VALUE
-static_api_commit_hook( VALUE module, VALUE db, VALUE handler );
-
 static VALUE
 static_api_create_function( VALUE module, VALUE db, VALUE name, VALUE n,
   VALUE proc );
@@ -251,12 +239,6 @@ static_free_vm( sqlite_vm *vm );
 static int
 static_busy_handler( void* cookie, const char *entity, int times );
 
-static int
-static_progress_handler( void* cookie );
-
-static int
-static_commit_hook( void* cookie );
-
 static void
 static_function_callback( sqlite_func *func, int argc, const char **argv );
 
@@ -1231,34 +1213,6 @@ static_busy_handler( void* cookie, const char *entity, int times )
   return 1;
 }
 
-static int
-static_progress_handler( void* cookie )
-{
-  VALUE handler = (VALUE)cookie;
-  VALUE result;
-
-  result = rb_funcall( handler, idCall, 0 );
-
-  if( result == Qnil || result == Qfalse )
-    return 0;
-
-  return 1;
-}
-
-static int
-static_commit_hook( void* cookie )
-{
-  VALUE handler = (VALUE)cookie;
-  VALUE result;
-
-  result = rb_funcall( handler, idCall, 0 );
-
-  if( result == Qnil || result == Qfalse )
-    return 0;
-
-  return 1;
-}
-
 static VALUE
 static_protected_function_callback( VALUE args )
 {
@@ -1354,8 +1308,6 @@ NO_RDOC
  */
 void Init_sqlite_api()
 {
-  VALUE version;
-
   idRow = rb_intern( "row" );
   idColumns = rb_intern( "columns" );
   idTypes = rb_intern( "types" );

data/lib/sqlite/statement.rb

@@ -89,6 +89,8 @@ module SQLite
     # returned. In that case, it is the client's responsibility to close the
     # ResultSet.
     #
+    # Any parameters will be bound to the statement using #bind_params.
+    #
     # Example:
     #
     #   stmt = db.prepare( "select * from table" )
@@ -96,8 +98,9 @@ module SQLite
     #     ...
     #   end
     #
-    # See also #bind_params.
-    def execute
+    # See also #bind_params, #execute!.
+    def execute( *bind_vars )
+      bind_params *bind_vars unless bind_vars.empty?
       results = ResultSet.new( @db, @statement.to_s )
 
       if block_given?
@@ -111,6 +114,35 @@ module SQLite
       end
     end
 
+    # Execute the statement. If no block was given, this returns an array of
+    # rows returned by executing the statement. Otherwise, each row will be
+    # yielded to the block and then closed.
+    #
+    # Any parameters will be bound to the statement using #bind_params.
+    #
+    # Example:
+    #
+    #   stmt = db.prepare( "select * from table" )
+    #   stmt.execute! do |row|
+    #     ...
+    #   end
+    #
+    # See also #bind_params, #execute.
+    def execute!( *bind_vars )
+      result = execute( *bind_vars )
+      rows = [] unless block_given?
+      while row = result.next
+        if block_given?
+          yield row
+        else
+          rows << row
+        end
+      end
+      rows
+    ensure
+      result.close if result
+    end
+
     # Return an array of the column names for this statement. Note that this
     # may execute the statement in order to obtain the metadata; this makes it
     # a (potentially) expensive operation.

data/lib/sqlite/version.rb

@@ -35,7 +35,7 @@ module SQLite
   module Version
 
     MAJOR = 2
-    MINOR = 1
+    MINOR = 2
     TINY  = 0
 
     STRING = [ MAJOR, MINOR, TINY ].join( "." )

data/test/tc_database.rb

@@ -237,6 +237,40 @@ class TC_Database < Test::Unit::TestCase
     end
   end
 
+  def test_prepare_bind_execute
+    stmt = @db.prepare( "select * from A where age = ?" )
+    stmt.bind_params 1
+    stmt.execute do |result|
+      row = result.next
+      assert_equal [ "Zephyr", "1" ], row
+      assert_nil result.next
+    end
+  end
+
+  def test_prepare_bind_execute!
+    stmt = @db.prepare( "select * from A where age = ?" )
+    stmt.bind_params 1
+    rows = stmt.execute!
+    assert_equal 1, rows.length
+    assert_equal [ "Zephyr", "1" ], rows.first
+  end
+
+  def test_prepare_execute
+    stmt = @db.prepare( "select * from A where age = ?" )
+    stmt.execute( 1 ) do |result|
+      row = result.next
+      assert_equal [ "Zephyr", "1" ], row
+      assert_nil result.next
+    end
+  end
+
+  def test_prepare_execute!
+    stmt = @db.prepare( "select * from A where age = ?" )
+    rows = stmt.execute!( 1 )
+    assert_equal 1, rows.length
+    assert_equal [ "Zephyr", "1" ], rows.first
+  end
+
   def test_execute_batch
     count = @db.get_first_value( "select count(*) from A" ).to_i
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.1
 specification_version: 1
 name: sqlite-ruby
 version: !ruby/object:Gem::Version 
-  version: 2.1.0
-date: 2004-09-27
+  version: 2.2.0
+date: 2004-10-26
 summary: SQLite/Ruby is a module to allow Ruby scripts to interface with a SQLite database.
 require_paths: 
   - lib