colincasey-sequel 2.10.0 → 2.10.1

data/lib/sequel_core/adapters/shared/progress.rb

@@ -0,0 +1,31 @@
+module Sequel
+  module Progress
+    module DatabaseMethods
+
+      def dataset(opts = nil)
+        ds = super
+        ds.extend(DatasetMethods)
+        ds
+      end
+    end
+  
+    module DatasetMethods
+      include Dataset::UnsupportedIntersectExcept
+
+      SELECT_CLAUSE_ORDER = %w'limit distinct columns from join where group order having compounds'.freeze
+
+      private
+
+      def select_clause_order
+        SELECT_CLAUSE_ORDER
+      end
+
+      # Progress uses TOP for limit, but it is only supported in Progress 10.
+      # The Progress adapter targets Progress 9, so it silently ignores the option.
+      def select_limit_sql(sql, opts)
+        raise(Error, "OFFSET not supported") if opts[:offset]
+        #sql << " TOP #{opts[:limit]}" if opts[:limit]
+      end
+    end
+  end
+end

data/lib/sequel_core/adapters/shared/sqlite.rb

@@ -0,0 +1,265 @@
+module Sequel
+  module SQLite
+    module DatabaseMethods
+      AUTO_VACUUM = {'0' => :none, '1' => :full, '2' => :incremental}.freeze
+      SYNCHRONOUS = {'0' => :off, '1' => :normal, '2' => :full}.freeze
+      TABLES_FILTER = "type = 'table' AND NOT name = 'sqlite_sequence'"
+      TEMP_STORE = {'0' => :default, '1' => :file, '2' => :memory}.freeze
+      TYPES = Sequel::Schema::SQL::TYPES.merge(Bignum=>'integer')
+      
+      # Run all alter_table commands in a transaction.  This is technically only
+      # needed for drop column.
+      def alter_table(name, generator=nil, &block)
+        transaction{super}
+      end
+
+      # SQLite supports limited table modification.  You can add a column
+      # or an index.  Dropping columns is supported by copying the table into
+      # a temporary table, dropping the table, and creating a new table without
+      # the column inside of a transaction.
+      def alter_table_sql(table, op)
+        case op[:op]
+        when :add_column, :add_index, :drop_index
+          super
+        when :drop_column
+          qt = quote_schema_table(table)
+          bt = quote_identifier(backup_table_name(qt.gsub('`', '')))
+          columns_str = dataset.send(:identifier_list, columns_for(table, :except => op[:name]))
+          defined_columns_str = column_list_sql(defined_columns_for(table, :except => op[:name]))
+          ["CREATE TEMPORARY TABLE #{bt}(#{defined_columns_str})",
+           "INSERT INTO #{bt} SELECT #{columns_str} FROM #{qt}",
+           "DROP TABLE #{qt}",
+           "CREATE TABLE #{qt}(#{defined_columns_str})",
+           "INSERT INTO #{qt} SELECT #{columns_str} FROM #{bt}",
+           "DROP TABLE #{bt}"]
+        when :rename_column
+          qt = quote_schema_table(table)
+          bt = quote_identifier(backup_table_name(qt.gsub('`', '')))
+          old_columns = dataset.send(:identifier_list, columns_for(table))
+          new_columns_arr = columns_for(table)
+
+          # Replace the old column in place. This is extremely important.
+          new_columns_arr[new_columns_arr.index(op[:name])] = op[:new_name]
+          
+          new_columns = dataset.send(:identifier_list, new_columns_arr)
+          
+          def_old_columns = column_list_sql(defined_columns_for(table))
+
+          def_new_columns_arr = defined_columns_for(table).map do |c|
+            c[:name] = op[:new_name].to_s if c[:name] == op[:name].to_s
+            c
+          end
+          
+          def_new_columns = column_list_sql(def_new_columns_arr)
+
+          [
+           "CREATE TEMPORARY TABLE #{bt}(#{def_old_columns})",
+           "INSERT INTO #{bt}(#{old_columns}) SELECT #{old_columns} FROM #{qt}",
+           "DROP TABLE #{qt}",
+           "CREATE TABLE #{qt}(#{def_new_columns})",
+           "INSERT INTO #{qt}(#{new_columns}) SELECT #{old_columns} FROM #{bt}",
+           "DROP TABLE #{bt}"
+          ]
+
+        else
+          raise Error, "Unsupported ALTER TABLE operation"
+        end
+      end
+      
+      # A symbol signifying the value of the auto_vacuum PRAGMA.
+      def auto_vacuum
+        AUTO_VACUUM[pragma_get(:auto_vacuum).to_s]
+      end
+      
+      # Set the auto_vacuum PRAGMA using the given symbol (:none, :full, or
+      # :incremental).
+      def auto_vacuum=(value)
+        value = AUTO_VACUUM.key(value) || (raise Error, "Invalid value for auto_vacuum option. Please specify one of :none, :full, :incremental.")
+        pragma_set(:auto_vacuum, value)
+      end
+      
+      # Get the value of the given PRAGMA.
+      def pragma_get(name)
+        self["PRAGMA #{name}"].single_value
+      end
+      
+      # Set the value of the given PRAGMA to value.
+      def pragma_set(name, value)
+        execute_ddl("PRAGMA #{name} = #{value}")
+      end
+      
+      # A symbol signifying the value of the synchronous PRAGMA.
+      def synchronous
+        SYNCHRONOUS[pragma_get(:synchronous).to_s]
+      end
+      
+      # Set the synchronous PRAGMA using the given symbol (:off, :normal, or :full).
+      def synchronous=(value)
+        value = SYNCHRONOUS.key(value) || (raise Error, "Invalid value for synchronous option. Please specify one of :off, :normal, :full.")
+        pragma_set(:synchronous, value)
+      end
+      
+      # Array of symbols specifying the table names in the current database.
+      #
+      # Options:
+      # * :server - Set the server to use.
+      def tables(opts={})
+        ds = self[:sqlite_master].server(opts[:server]).filter(TABLES_FILTER)
+        ds.identifier_output_method = nil
+        ds.identifier_input_method = nil
+        ds2 = dataset
+        ds.map{|r| ds2.send(:output_identifier, r[:name])}
+      end
+      
+      # A symbol signifying the value of the temp_store PRAGMA.
+      def temp_store
+        TEMP_STORE[pragma_get(:temp_store).to_s]
+      end
+      
+      # Set the temp_store PRAGMA using the given symbol (:default, :file, or :memory).
+      def temp_store=(value)
+        value = TEMP_STORE.key(value) || (raise Error, "Invalid value for temp_store option. Please specify one of :default, :file, :memory.")
+        pragma_set(:temp_store, value)
+      end
+      
+      private
+
+      # The array of column symbols in the table, except for ones given in opts[:except]
+      def backup_table_name(table, opts={})
+        (opts[:times]||1000).times do |i|
+          table_name = "#{table}_backup#{i}"
+          return table_name unless table_exists?(table_name)
+        end
+      end
+
+      # The array of column symbols in the table, except for ones given in opts[:except]
+      def columns_for(table, opts={})
+        cols = schema_parse_table(table, {}).map{|c| c[0]}
+        cols = cols - Array(opts[:except])
+        cols
+      end
+
+      # The array of column schema hashes, except for the ones given in opts[:except]
+      def defined_columns_for(table, opts={})
+        cols = parse_pragma(table, {})
+        cols.each{|c| c[:default] = c[:default].lit if c[:default]}
+        if opts[:except]
+          nono= Array(opts[:except]).compact.map{|n| n.to_s}
+          cols.reject!{|c| nono.include? c[:name] }
+        end
+        cols
+      end
+      
+      # SQLite folds unquoted identifiers to lowercase, so it shouldn't need to upcase identifiers on input.
+      def identifier_input_method_default
+        nil
+      end
+      
+      # SQLite folds unquoted identifiers to lowercase, so it shouldn't need to upcase identifiers on output.
+      def identifier_output_method_default
+        nil
+      end
+
+      # Parse the output of the table_info pragma
+      def parse_pragma(table_name, opts)
+        ds2 = dataset
+        ds = self["PRAGMA table_info(?)", ds2.send(:input_identifier, table_name)]
+        ds.identifier_output_method = nil
+        ds.map do |row|
+          row.delete(:cid)
+          row[:allow_null] = row.delete(:notnull).to_i == 0
+          row[:default] = row.delete(:dflt_value)
+          row[:primary_key] = row.delete(:pk).to_i == 1
+          row[:default] = nil if row[:default].blank?
+          row[:db_type] = row.delete(:type)
+          row[:type] = schema_column_type(row[:db_type])
+          row
+        end
+      end
+      
+      # SQLite supports schema parsing using the table_info PRAGMA, so
+      # parse the output of that into the format Sequel expects.
+      def schema_parse_table(table_name, opts)
+        ds = dataset
+        parse_pragma(table_name, opts).map do |row|
+          [ds.send(:output_identifier, row.delete(:name)), row]
+        end
+      end
+      
+      # Override the standard type conversions with SQLite specific ones
+      def type_literal_base(column)
+        TYPES[column[:type]]
+      end
+    end
+    
+    # Instance methods for datasets that connect to an SQLite database
+    module DatasetMethods
+      include Dataset::UnsupportedIntersectExceptAll
+
+      # SQLite does not support pattern matching via regular expressions.
+      # SQLite is case insensitive (depending on pragma), so use LIKE for
+      # ILIKE.
+      def complex_expression_sql(op, args)
+        case op
+        when :~, :'!~', :'~*', :'!~*'
+          raise Error, "SQLite does not support pattern matching via regular expressions"
+        when :LIKE, :'NOT LIKE', :ILIKE, :'NOT ILIKE'
+          # SQLite is case insensitive for ASCII, and non case sensitive for other character sets
+          "#{'NOT ' if [:'NOT LIKE', :'NOT ILIKE'].include?(op)}(#{literal(args.at(0))} LIKE #{literal(args.at(1))})"
+        else
+          super(op, args)
+        end
+      end
+      
+      # SQLite performs a TRUNCATE style DELETE if no filter is specified.
+      # Since we want to always return the count of records, add a condition
+      # that is always true and then delete.
+      def delete(opts = {})
+        # check if no filter is specified
+        opts = @opts.merge(opts)
+        super(opts[:where] ? opts : opts.merge(:where=>{1=>1}))
+      end
+      
+      # Insert the values into the database.
+      def insert(*values)
+        execute_insert(insert_sql(*values))
+      end
+      
+      # Allow inserting of values directly from a dataset.
+      def insert_sql(*values)
+        if (values.size == 1) && values.first.is_a?(Sequel::Dataset)
+          "INSERT INTO #{source_list(@opts[:from])} #{values.first.sql};"
+        else
+          super(*values)
+        end
+      end
+      
+      def literal(v)
+        case v
+        when ::Sequel::SQL::Blob
+          blob = ''
+          v.each_byte{|x| blob << sprintf('%02x', x)}
+          "X'#{blob}'"
+        when Time
+          literal(v.iso8601)
+        when Date, DateTime
+          literal(v.to_s)
+        else
+          super
+        end
+      end
+      
+      # SQLite uses the nonstandard ` (backtick) for quoting identifiers.
+      def quoted_identifier(c)
+        "`#{c}`"
+      end
+      
+      private
+      
+      # SQLite uses string literals instead of identifiers in AS clauses.
+      def as_sql(expression, aliaz)
+        "#{expression} AS #{literal(aliaz.to_s)}"
+      end
+    end
+  end
+end

data/lib/sequel_core/adapters/sqlite.rb

@@ -0,0 +1,248 @@
+require 'sqlite3'
+require 'sequel_core/adapters/shared/sqlite'
+
+module Sequel
+  # Top level module for holding all SQLite-related modules and classes
+  # for Sequel.
+  module SQLite
+    # Database class for PostgreSQL databases used with Sequel and the
+    # ruby-sqlite3 driver.
+    class Database < Sequel::Database
+      UNIX_EPOCH_TIME_FORMAT = /\A\d+\z/.freeze
+      include ::Sequel::SQLite::DatabaseMethods
+      
+      set_adapter_scheme :sqlite
+      
+      # Mimic the file:// uri, by having 2 preceding slashes specify a relative
+      # path, and 3 preceding slashes specify an absolute path.
+      def self.uri_to_options(uri) # :nodoc:
+        { :database => (uri.host.nil? && uri.path == '/') ? nil : "#{uri.host}#{uri.path}" }
+      end
+      
+      private_class_method :uri_to_options
+      
+      # Connect to the database.  Since SQLite is a file based database,
+      # the only options available are :database (to specify the database
+      # name), and :timeout, to specify how long to wait for the database to
+      # be available if it is locked, given in milliseconds (default is 5000).
+      def connect(server)
+        opts = server_opts(server)
+        opts[:database] = ':memory:' if opts[:database].blank?
+        db = ::SQLite3::Database.new(opts[:database])
+        db.busy_timeout(opts.fetch(:timeout, 5000))
+        db.type_translation = true
+        
+        # Handle datetime's with Sequel.datetime_class
+        prok = proc do |t,v|
+          v = Time.at(v.to_i).iso8601 if UNIX_EPOCH_TIME_FORMAT.match(v)
+          v.to_sequel_time
+        end
+        db.translator.add_translator("timestamp", &prok)
+        db.translator.add_translator("datetime", &prok)
+        
+        # Handle numeric values with BigDecimal
+        prok = proc{|t,v| BigDecimal.new(v) rescue v}
+        db.translator.add_translator("numeric", &prok)
+        db.translator.add_translator("decimal", &prok)
+        db.translator.add_translator("money", &prok)
+        
+        # Handle floating point values with Float
+        prok = proc{|t,v| Float(v) rescue v}
+        db.translator.add_translator("float", &prok)
+        db.translator.add_translator("real", &prok)
+        db.translator.add_translator("double precision", &prok)
+        
+        # Handle blob values with Sequel::SQL::Blob
+        db.translator.add_translator("blob"){|t,v| ::Sequel::SQL::Blob.new(v)}
+        
+        db
+      end
+      
+      # Return instance of Sequel::SQLite::Dataset with the given options.
+      def dataset(opts = nil)
+        SQLite::Dataset.new(self, opts)
+      end
+      
+      # Run the given SQL with the given arguments and return the number of changed rows.
+      def execute_dui(sql, opts={})
+        _execute(sql, opts){|conn| conn.execute_batch(sql, opts[:arguments]); conn.changes}
+      end
+      
+      # Run the given SQL with the given arguments and return the last inserted row id.
+      def execute_insert(sql, opts={})
+        _execute(sql, opts){|conn| conn.execute(sql, opts[:arguments]); conn.last_insert_row_id}
+      end
+      
+      # Run the given SQL with the given arguments and yield each row.
+      def execute(sql, opts={}, &block)
+        _execute(sql, opts){|conn| conn.query(sql, opts[:arguments], &block)}
+      end
+      
+      # Run the given SQL with the given arguments and return the first value of the first row.
+      def single_value(sql, opts={})
+        _execute(sql, opts){|conn| conn.get_first_value(sql, opts[:arguments])}
+      end
+      
+      # Use the native driver transaction method if there isn't already a transaction
+      # in progress on the connection, always yielding a connection inside a transaction
+      # transaction.
+      def transaction(server=nil, &block)
+        synchronize(server) do |conn|
+          return yield(conn) if conn.transaction_active?
+          begin
+            result = nil
+            log_info('Transaction.begin')
+            conn.transaction{result = yield(conn)}
+            result
+          rescue ::Exception => e
+            log_info('Transaction.rollback')
+            transaction_error(e, SQLite3::Exception)
+          ensure
+            log_info('Transaction.commit') unless e
+          end
+        end
+      end
+      
+      private
+      
+      # Log the SQL and the arguments, and yield an available connection.  Rescue
+      # any SQLite3::Exceptions and turn the into Error::InvalidStatements.
+      def _execute(sql, opts)
+        begin
+          log_info(sql, opts[:arguments])
+          synchronize(opts[:server]){|conn| yield conn}
+        rescue SQLite3::Exception => e
+          raise_error(e)
+        end
+      end
+      
+      # SQLite does not need the pool to convert exceptions.
+      # Also, force the max connections to 1 if a memory database is being
+      # used, as otherwise each connection gets a separate database.
+      def connection_pool_default_options
+        o = super.merge(:pool_convert_exceptions=>false)
+        # Default to only a single connection if a memory database is used,
+        # because otherwise each connection will get a separate database
+        o[:max_connections] = 1 if @opts[:database] == ':memory:' || @opts[:database].blank?
+        o
+      end
+
+      # Disconnect given connections from the database.
+      def disconnect_connection(c)
+        c.close
+      end
+    end
+    
+    # Dataset class for SQLite datasets that use the ruby-sqlite3 driver.
+    class Dataset < Sequel::Dataset
+      include ::Sequel::SQLite::DatasetMethods
+      
+      EXPLAIN = 'EXPLAIN %s'.freeze
+      PREPARED_ARG_PLACEHOLDER = ':'.freeze
+      
+      # SQLite already supports named bind arguments, so use directly.
+      module ArgumentMapper
+        include Sequel::Dataset::ArgumentMapper
+        
+        protected
+        
+        # Return a hash with the same values as the given hash,
+        # but with the keys converted to strings.
+        def map_to_prepared_args(hash)
+          args = {}
+          hash.each{|k,v| args[k.to_s] = v}
+          args
+        end
+        
+        private
+        
+        # SQLite uses a : before the name of the argument for named
+        # arguments.
+        def prepared_arg(k)
+          "#{prepared_arg_placeholder}#{k}".lit
+        end
+      end
+      
+      # SQLite prepared statement uses a new prepared statement each time
+      # it is called, but it does use the bind arguments.
+      module PreparedStatementMethods
+        include ArgumentMapper
+        
+        private
+        
+        # Run execute_select on the database with the given SQL and the stored
+        # bind arguments.
+        def execute(sql, opts={}, &block)
+          super(sql, {:arguments=>bind_arguments}.merge(opts), &block)
+        end
+        
+        # Same as execute, explicit due to intricacies of alias and super.
+        def execute_dui(sql, opts={}, &block)
+          super(sql, {:arguments=>bind_arguments}.merge(opts), &block)
+        end
+        
+        # Same as execute, explicit due to intricacies of alias and super.
+        def execute_insert(sql, opts={}, &block)
+          super(sql, {:arguments=>bind_arguments}.merge(opts), &block)
+        end
+      end
+      
+      # Prepare an unnamed statement of the given type and call it with the
+      # given values.
+      def call(type, hash, values=nil, &block)
+        prepare(type, nil, values).call(hash, &block)
+      end
+      
+      # Return an array of strings specifying a query explanation for the
+      # current dataset.
+      def explain
+        res = []
+        @db.result_set(EXPLAIN % select_sql(opts), nil) {|r| res << r}
+        res
+      end
+      
+      # Yield a hash for each row in the dataset.
+      def fetch_rows(sql)
+        execute(sql) do |result|
+          @columns = result.columns.map{|c| output_identifier(c)}
+          column_count = @columns.size
+          result.each do |values|
+            row = {}
+            column_count.times {|i| row[@columns[i]] = values[i]}
+            yield row
+          end
+        end
+      end
+      
+      # Use the ISO format for dates and timestamps, and quote strings
+      # using the ::SQLite3::Database.quote method.
+      def literal(v)
+        case v
+        when LiteralString, ::Sequel::SQL::Blob
+          super
+        when String
+          "'#{::SQLite3::Database.quote(v)}'"
+        else
+          super
+        end
+      end
+      
+      # Prepare the given type of query with the given name and store
+      # it in the database.  Note that a new native prepared statement is
+      # created on each call to this prepared statement.
+      def prepare(type, name=nil, values=nil)
+        ps = to_prepared_statement(type, values)
+        ps.extend(PreparedStatementMethods)
+        db.prepared_statements[name] = ps if name
+        ps
+      end
+      
+      private
+      
+      # SQLite uses a : before the name of the argument as a placeholder.
+      def prepared_arg_placeholder
+        PREPARED_ARG_PLACEHOLDER
+      end
+    end
+  end
+end