Class: Sequel::ADO::Database

Inherits:
Database show all
Defined in:
lib/sequel/adapters/ado.rb

Constant Summary collapse

DISCONNECT_ERROR_RE = 
/Communication link failure/
DatasetClass = 
self

Constants inherited from Database

Database::ADAPTERS, Database::AUTOINCREMENT, Database::COLUMN_DEFINITION_ORDER, Database::COLUMN_SCHEMA_DATETIME_TYPES, Database::COLUMN_SCHEMA_STRING_TYPES, Database::COMBINABLE_ALTER_TABLE_OPS, Database::COMMA_SEPARATOR, Database::CURRENT_TIMESTAMP_RE, Database::DEFAULT_JOIN_TABLE_COLUMN_OPTIONS, Database::DEFAULT_STRING_COLUMN_SIZE, Database::EXTENSIONS, Database::NOT_NULL, Database::NULL, Database::PRIMARY_KEY, Database::SQL_BEGIN, Database::SQL_COMMIT, Database::SQL_RELEASE_SAVEPOINT, Database::SQL_ROLLBACK, Database::SQL_ROLLBACK_TO_SAVEPOINT, Database::SQL_SAVEPOINT, Database::STRING_DEFAULT_RE, Database::TEMPORARY, Database::TRANSACTION_BEGIN, Database::TRANSACTION_COMMIT, Database::TRANSACTION_ISOLATION_LEVELS, Database::TRANSACTION_ROLLBACK, Database::UNDERSCORE, Database::UNIQUE, Database::UNSIGNED

Instance Attribute Summary

Attributes inherited from Database

#cache_schema, #dataset_class, #default_schema, #default_string_column_size, #log_warn_duration, #loggers, #opts, #pool, #prepared_statements, #sql_log_level, #timezone, #transaction_isolation_level

Instance Method Summary collapse

Methods inherited from Database

#<<, #[], adapter_class, #adapter_scheme, adapter_scheme, #add_column, #add_index, #add_servers, #after_commit, #after_rollback, #alter_table, #alter_table_generator, #call, #cast_type_literal, connect, #create_join_table, #create_or_replace_view, #create_table, #create_table!, #create_table?, #create_table_generator, #create_view, #database_type, #dataset, #disconnect, #drop_column, #drop_index, #drop_join_table, #drop_table, #drop_table?, #drop_view, #dump_foreign_key_migration, #dump_indexes_migration, #dump_schema_cache, #dump_schema_cache?, #dump_schema_migration, #dump_table_schema, #each_server, #extend_datasets, #extension, #fetch, #foreign_key_list, #from, #from_application_timestamp, #get, #global_index_namespace?, #identifier_input_method, identifier_input_method, #identifier_input_method=, identifier_input_method=, #identifier_output_method, identifier_output_method, #identifier_output_method=, identifier_output_method=, #in_transaction?, #indexes, #inspect, #literal, #load_schema_cache, #load_schema_cache?, #log_exception, #log_info, #log_yield, #logger=, #prepared_statement, #query, quote_identifiers=, #quote_identifiers=, #quote_identifiers?, register_extension, #remove_servers, #rename_column, #rename_table, #run, #schema, #select, #serial_primary_key_options, #servers, #set_column_default, #set_column_type, #set_prepared_statement, single_threaded=, #single_threaded?, #supports_create_table_if_not_exists?, #supports_deferrable_constraints?, #supports_deferrable_foreign_key_constraints?, #supports_drop_table_if_exists?, #supports_prepared_transactions?, #supports_savepoints?, #supports_savepoints_in_prepared_transactions?, #supports_transaction_isolation_levels?, #supports_transactional_ddl?, #synchronize, #table_exists?, #tables, #test_connection, #to_application_timestamp, #transaction, #typecast_value, #uri, #url, #valid_connection?, #views

Methods included from Metaprogramming

#meta_def

Constructor Details

#initialize(opts) ⇒ Database

Returns a new instance of Database.



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/sequel/adapters/ado.rb', line 11

def initialize(opts)
  super
  case @opts[:conn_string]
  when /Microsoft\.(Jet|ACE)\.OLEDB/io
    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

Instance Method Details

#connect(server) ⇒ Object

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.



50
51
52
53
54
55
56
57
58
 
# 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) ⇒ Object 



60
61
62
 
# File 'lib/sequel/adapters/ado.rb', line 60

def disconnect_connection(conn)
  conn.Close
end

#execute(sql, opts = {}) ⇒ Object Also known as: do 



90
91
92
93
94
95
96
97
98
99
100
 
# 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

#execute_ddl(sql, opts = {}) ⇒ Object

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



65
66
67
 
# File 'lib/sequel/adapters/ado.rb', line 65

def execute_ddl(sql, opts={})
  execute(sql, opts)
end

#execute_dui(sql, opts = {}) ⇒ Object

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).



78
79
80
81
82
83
84
85
86
87
88
 
# 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 = {}) ⇒ Object

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



70
71
72
 
# File 'lib/sequel/adapters/ado.rb', line 70

def execute_insert(sql, opts={})
  execute(sql, opts)
end