database_statements.rb 3.1 KB
Newer Older
1 2 3
module ActiveRecord
  module ConnectionAdapters # :nodoc:
    module DatabaseStatements
4 5
      # Returns an array of record hashes with the column names as keys and
      # column values as values.
6 7
      def select_all(sql, name = nil)
      end
8

9 10
      # Returns a record hash with the column names as keys and column values
      # as values.
11 12
      def select_one(sql, name = nil)
      end
13 14 15 16 17 18 19 20 21 22 23 24 25 26

      # Returns a single value from a record
      def select_value(sql, name = nil)
        result = select_one(sql, name)
        result.nil? ? nil : result.values.first
      end

      # Returns an array of the values of the first column in a select:
      #   select_values("SELECT id FROM companies LIMIT 3") => [1,2,3]
      def select_values(sql, name = nil)
        result = select_all(sql, name)
        result.map{ |v| v.values.first }
      end

27 28 29 30 31
      # Executes the SQL statement in the context of this connection.
      # This abstract method raises a NotImplementedError.
      def execute(sql, name = nil)
        raise NotImplementedError, "execute is an abstract method"
      end
32 33 34 35 36 37 38 39 40 41 42 43

      # Returns the last auto-generated ID from the affected table.
      def insert(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil) end

      # Executes the update statement and returns the number of rows affected.
      def update(sql, name = nil) end

      # Executes the delete statement and returns the number of rows affected.
      def delete(sql, name = nil) end

      # Wrap a block in a transaction.  Returns result of block.
      def transaction(start_db_transaction = true)
44
        transaction_open = false
45 46
        begin
          if block_given?
47 48 49 50
            if start_db_transaction
              begin_db_transaction 
              transaction_open = true
            end
51
            yield
52 53
          end
        rescue Exception => database_transaction_rollback
54 55 56 57
          if transaction_open
            transaction_open = false
            rollback_db_transaction
          end
58 59
          raise
        end
60
      ensure
61
        commit_db_transaction if transaction_open
62 63 64 65 66 67 68 69
      end

      # Begins the transaction (and turns off auto-committing).
      def begin_db_transaction()    end

      # Commits the transaction (and turns on auto-committing).
      def commit_db_transaction()   end

70 71
      # Rolls back the transaction (and turns on auto-committing). Must be
      # done if the transaction block raises an exception or returns false.
72 73
      def rollback_db_transaction() end

74 75
      # Alias for #add_limit_offset!.
      def add_limit!(sql, options)
76
        add_limit_offset!(sql, options) if options
77 78
      end

79 80 81 82 83 84 85
      # Appends +LIMIT+ and +OFFSET+ options to a SQL statement.
      # This method *modifies* the +sql+ parameter.
      # ===== Examples
      #  add_limit_offset!('SELECT * FROM suppliers', {:limit => 10, :offset => 50})
      # generates
      #  SELECT * FROM suppliers LIMIT 10 OFFSET 50
      def add_limit_offset!(sql, options)
86 87 88 89 90 91
        if limit = options[:limit]
          sql << " LIMIT #{limit}"
          if offset = options[:offset]
            sql << " OFFSET #{offset}"
          end
        end
92 93 94
      end
    end
  end
95
end