Class: Sequel::ADO::Database

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

Constant Summary

Constants inherited from Database

Database::ADAPTERS, Database::COLUMN_DEFINITION_ORDER, Database::COLUMN_SCHEMA_DATETIME_TYPES, Database::COLUMN_SCHEMA_STRING_TYPES, Database::COMBINABLE_ALTER_TABLE_OPS, Database::DEFAULT_DATABASE_ERROR_REGEXPS, Database::DEFAULT_STRING_COLUMN_SIZE, Database::EXTENSIONS, Database::OPTS, Database::SCHEMA_TYPE_CLASSES, Database::TRANSACTION_ISOLATION_LEVELS

Instance Attribute Summary collapse

Attributes inherited from Database

#cache_schema, #dataset_class, #default_string_column_size, #log_connection_info, #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_initialize, #after_rollback, #alter_table, #alter_table_generator, #call, #cast_type_literal, connect, #create_join_table, #create_join_table!, #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, #extend_datasets, extension, #extension, #fetch, #from, #from_application_timestamp, #get, #global_index_namespace?, #in_transaction?, #initialize, #inspect, #literal, #literal_symbol, #literal_symbol_set, load_adapter, #log_connection_yield, #log_exception, #log_info, #logger=, #prepared_statement, #quote_identifier, register_extension, #remove_servers, #rename_column, #rename_table, #rollback_checker, #run, run_after_initialize, #schema, #schema_type_class, #select, #serial_primary_key_options, #servers, #set_column_default, #set_column_type, #set_prepared_statement, set_shared_adapter_scheme, #sharded?, #single_threaded?, #supports_create_table_if_not_exists?, #supports_deferrable_constraints?, #supports_deferrable_foreign_key_constraints?, #supports_drop_table_if_exists?, #supports_foreign_key_parsing?, #supports_index_parsing?, #supports_partial_indexes?, #supports_prepared_transactions?, #supports_savepoints?, #supports_savepoints_in_prepared_transactions?, #supports_schema_parsing?, #supports_table_listing?, #supports_transaction_isolation_levels?, #supports_transactional_ddl?, #supports_view_listing?, #supports_views_with_check_option?, #supports_views_with_local_check_option?, #synchronize, #table_exists?, #test_connection, #to_application_timestamp, #transaction, #typecast_value, #uri, #url, #valid_connection?

Constructor Details

This class inherits a constructor from Sequel::Database

Instance Attribute Details

#conversion_procsObject (readonly)

Returns the value of attribute conversion_procs


85
86
87
# File 'lib/sequel/adapters/ado.rb', line 85

def conversion_procs
  @conversion_procs
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.

: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 is not always available and would break backwards compatability.


106
107
108
109
110
111
112
113
114
# File 'lib/sequel/adapters/ado.rb', line 106

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


116
117
118
119
120
# File 'lib/sequel/adapters/ado.rb', line 116

def disconnect_connection(conn)
  conn.Close
rescue WIN32OLERuntimeError
  nil
end

#execute(sql, opts = OPTS) ⇒ Object


153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
# File 'lib/sequel/adapters/ado.rb', line 153

def execute(sql, opts=OPTS)
  synchronize(opts[:server]) do |conn|
    begin
      r = log_connection_yield(sql, conn){conn.Execute(sql)}
      begin
        yield r if block_given?
      ensure
        begin
          r.close
        rescue ::WIN32OLERuntimeError
        end
      end
    rescue ::WIN32OLERuntimeError => e
      raise_error(e)
    end
  end
  nil
end

#execute_ddl(sql, opts = OPTS) ⇒ Object

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


128
129
130
# File 'lib/sequel/adapters/ado.rb', line 128

def execute_ddl(sql, opts=OPTS)
  execute(sql, opts)
end

#execute_dui(sql, opts = 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).


141
142
143
144
145
146
147
148
149
150
151
# File 'lib/sequel/adapters/ado.rb', line 141

def execute_dui(sql, opts=OPTS)
  return super if opts[:provider]
  synchronize(opts[:server]) do |conn|
    begin
      log_connection_yield(sql, conn){conn.Execute(sql, 1)}
      WIN32OLE::ARGV[1]
    rescue ::WIN32OLERuntimeError => e
      raise_error(e)
    end
  end
end

#execute_insert(sql, opts = OPTS) ⇒ Object

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


133
134
135
# File 'lib/sequel/adapters/ado.rb', line 133

def execute_insert(sql, opts=OPTS)
  execute(sql, opts)
end

#freezeObject


122
123
124
125
# File 'lib/sequel/adapters/ado.rb', line 122

def freeze
  @conversion_procs.freeze
  super
end