sqlite3-full 1.3.9.1

data/lib/sqlite3/pragmas.rb

@@ -0,0 +1,280 @@
+require 'sqlite3/errors'
+
+module SQLite3
+
+  # This module is intended for inclusion solely by the Database class. It
+  # defines convenience methods for the various pragmas supported by SQLite3.
+  #
+  # For a detailed description of these pragmas, see the SQLite3 documentation
+  # at http://sqlite.org/pragma.html.
+  module Pragmas
+
+    # Returns +true+ or +false+ depending on the value of the named pragma.
+    def get_boolean_pragma( name )
+      get_first_value( "PRAGMA #{name}" ) != "0"
+    end
+    private :get_boolean_pragma
+
+    # Sets the given pragma to the given boolean value. The value itself
+    # may be +true+ or +false+, or any other commonly used string or
+    # integer that represents truth.
+    def set_boolean_pragma( name, mode )
+      case mode
+        when String
+          case mode.downcase
+            when "on", "yes", "true", "y", "t"; mode = "'ON'"
+            when "off", "no", "false", "n", "f"; mode = "'OFF'"
+            else
+              raise Exception,
+                "unrecognized pragma parameter #{mode.inspect}"
+          end
+        when true, 1
+          mode = "ON"
+        when false, 0, nil
+          mode = "OFF"
+        else
+          raise Exception,
+            "unrecognized pragma parameter #{mode.inspect}"
+      end
+
+      execute( "PRAGMA #{name}=#{mode}" )
+    end
+    private :set_boolean_pragma
+
+    # Requests the given pragma (and parameters), and if the block is given,
+    # each row of the result set will be yielded to it. Otherwise, the results
+    # are returned as an array.
+    def get_query_pragma( name, *parms, &block ) # :yields: row
+      if parms.empty?
+        execute( "PRAGMA #{name}", &block )
+      else
+        args = "'" + parms.join("','") + "'"
+        execute( "PRAGMA #{name}( #{args} )", &block )
+      end
+    end
+    private :get_query_pragma
+
+    # Return the value of the given pragma.
+    def get_enum_pragma( name )
+      get_first_value( "PRAGMA #{name}" )
+    end
+    private :get_enum_pragma
+
+    # Set the value of the given pragma to +mode+. The +mode+ parameter must
+    # conform to one of the values in the given +enum+ array. Each entry in
+    # the array is another array comprised of elements in the enumeration that
+    # have duplicate values. See #synchronous, #default_synchronous,
+    # #temp_store, and #default_temp_store for usage examples.
+    def set_enum_pragma( name, mode, enums )
+      match = enums.find { |p| p.find { |i| i.to_s.downcase == mode.to_s.downcase } }
+      raise Exception,
+        "unrecognized #{name} #{mode.inspect}" unless match
+      execute( "PRAGMA #{name}='#{match.first.upcase}'" )
+    end
+    private :set_enum_pragma
+
+    # Returns the value of the given pragma as an integer.
+    def get_int_pragma( name )
+      get_first_value( "PRAGMA #{name}" ).to_i
+    end
+    private :get_int_pragma
+
+    # Set the value of the given pragma to the integer value of the +value+
+    # parameter.
+    def set_int_pragma( name, value )
+      execute( "PRAGMA #{name}=#{value.to_i}" )
+    end
+    private :set_int_pragma
+
+    # The enumeration of valid synchronous modes.
+    SYNCHRONOUS_MODES = [ [ 'full', 2 ], [ 'normal', 1 ], [ 'off', 0 ] ]
+
+    # The enumeration of valid temp store modes.
+    TEMP_STORE_MODES  = [ [ 'default', 0 ], [ 'file', 1 ], [ 'memory', 2 ] ]
+
+    # Does an integrity check on the database. If the check fails, a
+    # SQLite3::Exception will be raised. Otherwise it
+    # returns silently.
+    def integrity_check
+      execute( "PRAGMA integrity_check" ) do |row|
+        raise Exception, row[0] if row[0] != "ok"
+      end
+    end
+
+    def auto_vacuum
+      get_boolean_pragma "auto_vacuum"
+    end
+
+    def auto_vacuum=( mode )
+      set_boolean_pragma "auto_vacuum", mode
+    end
+
+    def schema_cookie
+      get_int_pragma "schema_cookie"
+    end
+
+    def schema_cookie=( cookie )
+      set_int_pragma "schema_cookie", cookie
+    end
+
+    def user_cookie
+      get_int_pragma "user_cookie"
+    end
+
+    def user_cookie=( cookie )
+      set_int_pragma "user_cookie", cookie
+    end
+
+    def cache_size
+      get_int_pragma "cache_size"
+    end
+
+    def cache_size=( size )
+      set_int_pragma "cache_size", size
+    end
+
+    def default_cache_size
+      get_int_pragma "default_cache_size"
+    end
+
+    def default_cache_size=( size )
+      set_int_pragma "default_cache_size", size
+    end
+
+    def default_synchronous
+      get_enum_pragma "default_synchronous"
+    end
+
+    def default_synchronous=( mode )
+      set_enum_pragma "default_synchronous", mode, SYNCHRONOUS_MODES
+    end
+
+    def synchronous
+      get_enum_pragma "synchronous"
+    end
+
+    def synchronous=( mode )
+      set_enum_pragma "synchronous", mode, SYNCHRONOUS_MODES
+    end
+
+    def default_temp_store
+      get_enum_pragma "default_temp_store"
+    end
+
+    def default_temp_store=( mode )
+      set_enum_pragma "default_temp_store", mode, TEMP_STORE_MODES
+    end
+  
+    def temp_store
+      get_enum_pragma "temp_store"
+    end
+
+    def temp_store=( mode )
+      set_enum_pragma "temp_store", mode, TEMP_STORE_MODES
+    end
+
+    def full_column_names
+      get_boolean_pragma "full_column_names"
+    end
+
+    def full_column_names=( mode )
+      set_boolean_pragma "full_column_names", mode
+    end
+  
+    def parser_trace
+      get_boolean_pragma "parser_trace"
+    end
+
+    def parser_trace=( mode )
+      set_boolean_pragma "parser_trace", mode
+    end
+  
+    def vdbe_trace
+      get_boolean_pragma "vdbe_trace"
+    end
+
+    def vdbe_trace=( mode )
+      set_boolean_pragma "vdbe_trace", mode
+    end
+
+    def database_list( &block ) # :yields: row
+      get_query_pragma "database_list", &block
+    end
+
+    def foreign_key_list( table, &block ) # :yields: row
+      get_query_pragma "foreign_key_list", table, &block
+    end
+
+    def index_info( index, &block ) # :yields: row
+      get_query_pragma "index_info", index, &block
+    end
+
+    def index_list( table, &block ) # :yields: row
+      get_query_pragma "index_list", table, &block
+    end
+
+    ###
+    # Returns information about +table+.  Yields each row of table information
+    # if a block is provided.
+    def table_info table
+      stmt    = prepare "PRAGMA table_info(#{table})"
+      columns = stmt.columns
+
+      needs_tweak_default =
+        version_compare(SQLite3.libversion.to_s, "3.3.7") > 0
+
+      result = [] unless block_given?
+      stmt.each do |row|
+        new_row = Hash[columns.zip(row)]
+
+        # FIXME: This should be removed but is required for older versions
+        # of rails
+        if(Object.const_defined?(:ActiveRecord))
+          new_row['notnull'] = new_row['notnull'].to_s
+        end
+
+        tweak_default(new_row) if needs_tweak_default
+
+        if block_given?
+          yield new_row
+        else
+          result << new_row
+        end
+      end
+      stmt.close
+
+      result
+    end
+
+    private
+
+      # Compares two version strings
+      def version_compare(v1, v2)
+        v1 = v1.split(".").map { |i| i.to_i }
+        v2 = v2.split(".").map { |i| i.to_i }
+        parts = [v1.length, v2.length].max
+        v1.push 0 while v1.length < parts
+        v2.push 0 while v2.length < parts
+        v1.zip(v2).each do |a,b|
+          return -1 if a < b
+          return  1 if a > b
+        end
+        return 0
+      end
+
+      # Since SQLite 3.3.8, the table_info pragma has returned the default
+      # value of the row as a quoted SQL value. This method essentially
+      # unquotes those values.
+      def tweak_default(hash)
+        case hash["dflt_value"]
+        when /^null$/i
+          hash["dflt_value"] = nil
+        when /^'(.*)'$/m
+          hash["dflt_value"] = $1.gsub(/''/, "'")
+        when /^"(.*)"$/m
+          hash["dflt_value"] = $1.gsub(/""/, '"')
+        end
+      end
+  end
+
+end

data/lib/sqlite3/resultset.rb

@@ -0,0 +1,195 @@
+require 'sqlite3/constants'
+require 'sqlite3/errors'
+
+module SQLite3
+
+  # The ResultSet object encapsulates the enumerability of a query's output.
+  # It is a simple cursor over the data that the query returns. It will
+  # very rarely (if ever) be instantiated directly. Instead, clients should
+  # obtain a ResultSet instance via Statement#execute.
+  class ResultSet
+    include Enumerable
+
+    class ArrayWithTypes < Array # :nodoc:
+      attr_accessor :types
+    end
+
+    class ArrayWithTypesAndFields < Array # :nodoc:
+      attr_writer :types
+      attr_writer :fields
+
+      def types
+        warn(<<-eowarn) if $VERBOSE
+#{caller[0]} is calling #{self.class}#types.  This method will be removed in
+sqlite3 version 2.0.0, please call the `types` method on the SQLite3::ResultSet
+object that created this object
+        eowarn
+        @types
+      end
+
+      def fields
+        warn(<<-eowarn) if $VERBOSE
+#{caller[0]} is calling #{self.class}#fields.  This method will be removed in
+sqlite3 version 2.0.0, please call the `columns` method on the SQLite3::ResultSet
+object that created this object
+        eowarn
+        @fields
+      end
+    end
+
+    # The class of which we return an object in case we want a Hash as
+    # result.
+    class HashWithTypesAndFields < Hash # :nodoc:
+      attr_writer :types
+      attr_writer :fields
+
+      def types
+        warn(<<-eowarn) if $VERBOSE
+#{caller[0]} is calling #{self.class}#types.  This method will be removed in
+sqlite3 version 2.0.0, please call the `types` method on the SQLite3::ResultSet
+object that created this object
+        eowarn
+        @types
+      end
+
+      def fields
+        warn(<<-eowarn) if $VERBOSE
+#{caller[0]} is calling #{self.class}#fields.  This method will be removed in
+sqlite3 version 2.0.0, please call the `columns` method on the SQLite3::ResultSet
+object that created this object
+        eowarn
+        @fields
+      end
+
+      def [] key
+        key = fields[key] if key.is_a? Numeric
+        super key
+      end
+    end
+
+    # Create a new ResultSet attached to the given database, using the
+    # given sql text.
+    def initialize db, stmt
+      @db   = db
+      @stmt = stmt
+    end
+
+    # Reset the cursor, so that a result set which has reached end-of-file
+    # can be rewound and reiterated.
+    def reset( *bind_params )
+      @stmt.reset!
+      @stmt.bind_params( *bind_params )
+      @eof = false
+    end
+
+    # Query whether the cursor has reached the end of the result set or not.
+    def eof?
+      @stmt.done?
+    end
+
+    # Obtain the next row from the cursor. If there are no more rows to be
+    # had, this will return +nil+. If type translation is active on the
+    # corresponding database, the values in the row will be translated
+    # according to their types.
+    #
+    # The returned value will be an array, unless Database#results_as_hash has
+    # been set to +true+, in which case the returned value will be a hash.
+    #
+    # For arrays, the column names are accessible via the +fields+ property,
+    # and the column types are accessible via the +types+ property.
+    #
+    # For hashes, the column names are the keys of the hash, and the column
+    # types are accessible via the +types+ property.
+    def next
+      if @db.results_as_hash
+        return next_hash
+      end
+
+      row = @stmt.step
+      return nil if @stmt.done?
+
+      if @db.type_translation
+        row = @stmt.types.zip(row).map do |type, value|
+          @db.translator.translate( type, value )
+        end
+      end
+
+      if row.respond_to?(:fields)
+        # FIXME: this can only happen if the translator returns something
+        # that responds to `fields`.  Since we're removing the translator
+        # in 2.0, we can remove this branch in 2.0.
+        row = ArrayWithTypes.new(row)
+      else
+        # FIXME: the `fields` and `types` methods are deprecated on this
+        # object for version 2.0, so we can safely remove this branch
+        # as well.
+        row = ArrayWithTypesAndFields.new(row)
+      end
+
+      row.fields = @stmt.columns
+      row.types = @stmt.types
+      row
+    end
+
+    # Required by the Enumerable mixin. Provides an internal iterator over the
+    # rows of the result set.
+    def each
+      while node = self.next
+        yield node
+      end
+    end
+
+    # Provides an internal iterator over the rows of the result set where
+    # each row is yielded as a hash.
+    def each_hash
+      while node = next_hash
+        yield node
+      end
+    end
+
+    # Closes the statement that spawned this result set.
+    # <em>Use with caution!</em> Closing a result set will automatically
+    # close any other result sets that were spawned from the same statement.
+    def close
+      @stmt.close
+    end
+
+    # Queries whether the underlying statement has been closed or not.
+    def closed?
+      @stmt.closed?
+    end
+
+    # Returns the types of the columns returned by this result set.
+    def types
+      @stmt.types
+    end
+
+    # Returns the names of the columns returned by this result set.
+    def columns
+      @stmt.columns
+    end
+
+    # Return the next row as a hash
+    def next_hash
+      row = @stmt.step
+      return nil if @stmt.done?
+
+      # FIXME: type translation is deprecated, so this can be removed
+      # in 2.0
+      if @db.type_translation
+        row = @stmt.types.zip(row).map do |type, value|
+          @db.translator.translate( type, value )
+        end
+      end
+
+      # FIXME: this can be switched to a regular hash in 2.0
+      row = HashWithTypesAndFields[*@stmt.columns.zip(row).flatten]
+
+      # FIXME: these methods are deprecated for version 2.0, so we can remove
+      # this code in 2.0
+      row.fields = @stmt.columns
+      row.types = @stmt.types
+      row
+    end
+  end
+end

data/lib/sqlite3/statement.rb

@@ -0,0 +1,144 @@
+require 'sqlite3/errors'
+require 'sqlite3/resultset'
+
+class String
+  def to_blob
+    SQLite3::Blob.new( self )
+  end
+end
+
+module SQLite3
+  # A statement represents a prepared-but-unexecuted SQL query. It will rarely
+  # (if ever) be instantiated directly by a client, and is most often obtained
+  # via the Database#prepare method.
+  class Statement
+    include Enumerable
+
+    # This is any text that followed the first valid SQL statement in the text
+    # with which the statement was initialized. If there was no trailing text,
+    # this will be the empty string.
+    attr_reader :remainder
+
+    # Binds the given variables to the corresponding placeholders in the SQL
+    # text.
+    #
+    # See Database#execute for a description of the valid placeholder
+    # syntaxes.
+    #
+    # Example:
+    #
+    #   stmt = db.prepare( "select * from table where a=? and b=?" )
+    #   stmt.bind_params( 15, "hello" )
+    #
+    # See also #execute, #bind_param, Statement#bind_param, and
+    # Statement#bind_params.
+    def bind_params( *bind_vars )
+      index = 1
+      bind_vars.flatten.each do |var|
+        if Hash === var
+          var.each { |key, val| bind_param key, val }
+        else
+          bind_param index, var
+          index += 1
+        end
+      end
+    end
+
+    # Execute the statement. This creates a new ResultSet object for the
+    # statement's virtual machine. If a block was given, the new ResultSet will
+    # be yielded to it; otherwise, the ResultSet will be returned.
+    #
+    # Any parameters will be bound to the statement using #bind_params.
+    #
+    # Example:
+    #
+    #   stmt = db.prepare( "select * from table" )
+    #   stmt.execute do |result|
+    #     ...
+    #   end
+    #
+    # See also #bind_params, #execute!.
+    def execute( *bind_vars )
+      reset! if active? || done?
+
+      bind_params(*bind_vars) unless bind_vars.empty?
+      @results = ResultSet.new(@connection, self)
+
+      step if 0 == column_count
+
+      yield @results if block_given?
+      @results
+    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.
+    #
+    # 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, &block )
+      execute(*bind_vars)
+      block_given? ? each(&block) : to_a
+    end
+
+    # Returns true if the statement is currently active, meaning it has an
+    # open result set.
+    def active?
+      !done?
+    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.
+    def columns
+      get_metadata unless @columns
+      return @columns
+    end
+
+    def each
+      loop do
+        val = step
+        break self if done?
+        yield val
+      end
+    end
+
+    # Return an array of the data types for each column in this statement. Note
+    # that this may execute the statement in order to obtain the metadata; this
+    # makes it a (potentially) expensive operation.
+    def types
+      must_be_open!
+      get_metadata unless @types
+      @types
+    end
+
+    # Performs a sanity check to ensure that the statement is not
+    # closed. If it is, an exception is raised.
+    def must_be_open! # :nodoc:
+      if closed?
+        raise SQLite3::Exception, "cannot use a closed statement"
+      end
+    end
+
+    private
+    # A convenience method for obtaining the metadata about the query. Note
+    # that this will actually execute the SQL, which means it can be a
+    # (potentially) expensive operation.
+    def get_metadata
+      @columns = Array.new(column_count) do |column|
+        column_name column
+      end
+      @types = Array.new(column_count) do |column|
+        column_decltype column
+      end
+    end
+  end
+end