class Sequel::ADO::Database

Constants

CommandTimeout
DISCONNECT_ERROR_RE
DatasetClass
Provider

Public Class Methods

new(opts) click to toggle source
Calls superclass method Sequel::Database.new
# File lib/sequel/adapters/ado.rb, line 11
def initialize(opts)
  super
  case @opts[:conn_string]
  when /Microsoft\.(Jet|ACE)\.OLEDB/o
    Sequel.ts_require 'adapters/ado/access'
    extend Sequel::ADO::Access::DatabaseMethods
    @dataset_class = ADO::Access::Dataset
  else
    @opts[:driver] ||= 'SQL Server'
    case @opts[:driver]
    when 'SQL Server'
      Sequel.ts_require 'adapters/ado/mssql'
      extend Sequel::ADO::MSSQL::DatabaseMethods
      @dataset_class = ADO::MSSQL::Dataset
      set_mssql_unicode_strings
    end
  end
end

Public Instance Methods

connect(server) click to toggle source

In addition to the usual database options, the following options have an effect:

:command_timeout

Sets the time in seconds to wait while attempting to execute a command before cancelling the attempt and generating an error. Specifically, it sets the ADO CommandTimeout property. If this property is not set, the default of 30 seconds is used.

:driver

The driver to use in the ADO connection string. If not provided, a default of “SQL Server” is used.

:conn_string

The full ADO connection string. If this is provided, the usual options are ignored.

:provider

Sets the Provider of this ADO connection (for example, “SQLOLEDB”). If you don't specify a provider, the default one used by WIN32OLE has major problems, such as creating a new native database connection for every query, which breaks things such as temporary tables.

Pay special attention to the :provider option, as without specifying a provider, many things will be broken. The SQLNCLI10 provider appears to work well if you are connecting to Microsoft SQL Server, but it is not the default as that would break backwards compatability.

# File lib/sequel/adapters/ado.rb, line 50
def connect(server)
  opts = server_opts(server)
  s = opts[:conn_string] || "driver=#{opts[:driver]};server=#{opts[:host]};database=#{opts[:database]}#{";uid=#{opts[:user]};pwd=#{opts[:password]}" if opts[:user]}"
  handle = WIN32OLE.new('ADODB.Connection')
  handle.CommandTimeout = opts[:command_timeout] if opts[:command_timeout]
  handle.Provider = opts[:provider] if opts[:provider]
  handle.Open(s)
  handle
end
disconnect_connection(conn) click to toggle source
# File lib/sequel/adapters/ado.rb, line 60
def disconnect_connection(conn)
  conn.Close
end
do(sql, opts={})
Alias for: execute
execute(sql, opts={}) { |r| ... } click to toggle source
# File lib/sequel/adapters/ado.rb, line 90
def execute(sql, opts={})
  synchronize(opts[:server]) do |conn|
    begin
      r = log_yield(sql){conn.Execute(sql)}
      yield(r) if block_given?
    rescue ::WIN32OLERuntimeError => e
      raise_error(e)
    end
  end
  nil
end
Also aliased as: do
execute_ddl(sql, opts={}) click to toggle source

Just execute so it doesn't attempt to return the number of rows modified.

# File lib/sequel/adapters/ado.rb, line 65
def execute_ddl(sql, opts={})
  execute(sql, opts)
end
execute_dui(sql, opts={}) click to toggle source

Use pass by reference in WIN32OLE to get the number of affected rows, unless is a provider is in use (since some providers don't seem to return the number of affected rows, but the default provider appears to).

Calls superclass method Sequel::Database#execute_dui
# File lib/sequel/adapters/ado.rb, line 78
def execute_dui(sql, opts={})
  return super if opts[:provider]
  synchronize(opts[:server]) do |conn|
    begin
      log_yield(sql){conn.Execute(sql, 1)}
      WIN32OLE::ARGV[1]
    rescue ::WIN32OLERuntimeError => e
      raise_error(e)
    end
  end
end
execute_insert(sql, opts={}) click to toggle source

Just execute so it doesn't attempt to return the number of rows modified.

# File lib/sequel/adapters/ado.rb, line 70
def execute_insert(sql, opts={})
  execute(sql, opts)
end

Private Instance Methods

begin_transaction(conn, opts={}) click to toggle source

The ADO adapter's default provider doesn't support transactions, since it creates a new native connection for each query. So Sequel only attempts to use transactions if an explicit :provider is given.

Calls superclass method Sequel::Database#begin_transaction
# File lib/sequel/adapters/ado.rb, line 108
def begin_transaction(conn, opts={})
  super if @opts[:provider]
end
commit_transaction(conn, opts={}) click to toggle source
Calls superclass method Sequel::Database#commit_transaction
# File lib/sequel/adapters/ado.rb, line 112
def commit_transaction(conn, opts={})
  super if @opts[:provider]
end
database_error_classes() click to toggle source
# File lib/sequel/adapters/ado.rb, line 116
def database_error_classes
  [::WIN32OLERuntimeError]
end
disconnect_error?(e, opts) click to toggle source
Calls superclass method Sequel::Database#disconnect_error?
# File lib/sequel/adapters/ado.rb, line 120
def disconnect_error?(e, opts)
  super || (e.is_a?(::WIN32OLERuntimeError) && e.message =~ DISCONNECT_ERROR_RE)
end
rollback_transaction(conn, opts={}) click to toggle source
Calls superclass method Sequel::Database#rollback_transaction
# File lib/sequel/adapters/ado.rb, line 124
def rollback_transaction(conn, opts={})
  super if @opts[:provider]
end