Class: ActiveRecord::ConnectionAdapters::SQLServerAdapter

Inherits:
AbstractAdapter
  • Object
show all
Defined in:
lib/active_record/connection_adapters/sqlserver_adapter.rb

Overview

In ADO mode, this adapter will ONLY work on Windows systems, since it relies on Win32OLE, which, to my knowledge, is only available on Windows.

This mode also relies on the ADO support in the DBI module. If you are using the one-click installer of Ruby, then you already have DBI installed, but the ADO module is NOT installed. You will need to get the latest source distribution of Ruby-DBI from ruby-dbi.sourceforge.net/ unzip it, and copy the file from src/lib/dbd_ado/ADO.rb to X:/Ruby/lib/ruby/site_ruby/1.8/DBD/ADO/ADO.rb

You will more than likely need to create the ADO directory. Once you’ve installed that file, you are ready to go.

In ODBC mode, the adapter requires the ODBC support in the DBI module which requires the Ruby ODBC module. Ruby ODBC 0.996 was used in development and testing, and it is available at www.ch-werner.de/rubyodbc/

Options:

  • :mode – ADO or ODBC. Defaults to ADO.

  • :username – Defaults to sa.

  • :password – Defaults to empty string.

  • :windows_auth – Defaults to “User ID=#username;Password=#password”

ADO specific options:

  • :host – Defaults to localhost.

  • :database – The name of the database. No default, must be provided.

  • :windows_auth – Use windows authentication instead of username/password.

ODBC specific options:

  • :dsn – Defaults to nothing.

Constant Summary collapse

ADAPTER_NAME = 
'SQLServer'.freeze
VERSION = 
'2.2.14'.freeze
DATABASE_VERSION_REGEXP = 
/Microsoft SQL Server\s+(\d{4})/
SUPPORTED_VERSIONS = 
[2000,2005].freeze
LIMITABLE_TYPES = 
['string','integer','float','char','nchar','varchar','nvarchar'].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connection, logger, connection_options = nil) ⇒ SQLServerAdapter

Returns a new instance of SQLServerAdapter.



169
170
171
172
173
174
175
176
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 169

def initialize(connection, logger, connection_options=nil)
  super(connection, logger)
  @connection_options = connection_options
  initialize_sqlserver_caches
  unless SUPPORTED_VERSIONS.include?(database_year)
    raise NotImplementedError, "Currently, only #{SUPPORTED_VERSIONS.to_sentence} are supported."
  end
end

Class Method Details

.type_limitable?(type) ⇒ Boolean

Returns:

  • (Boolean) 


163
164
165
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 163

def type_limitable?(type)
  LIMITABLE_TYPES.include?(type.to_s)
end

Instance Method Details

#active? ⇒ Boolean

CONNECTION MANAGEMENT ====================================#

Returns:

  • (Boolean) 


302
303
304
305
306
307
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 302

def active?
  raw_connection.execute("SELECT 1").finish
  true
rescue DBI::DatabaseError, DBI::InterfaceError
  false
end

#adapter_name ⇒ Object

ABSTRACT ADAPTER =========================================#



180
181
182
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 180

def adapter_name
  ADAPTER_NAME
end

#add_column(table_name, column_name, type, options = {}) ⇒ Object 



565
566
567
568
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 565

def add_column(table_name, column_name, type, options = {})
  super
  remove_sqlserver_columns_cache_for(table_name)
end

#add_limit_offset!(sql, options) ⇒ Object 



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 376

def add_limit_offset!(sql, options)
  # Validate and/or convert integers for :limit and :offets options.
  if options[:offset]
    raise ArgumentError, "offset should have a limit" unless options[:limit]
    unless options[:offset].kind_of?(Integer)
      if options[:offset] =~ /^\d+$/
        options[:offset] = options[:offset].to_i
      else
        raise ArgumentError, "offset should be an integer"
      end
    end
  end
  if options[:limit] && !(options[:limit].kind_of?(Integer))
    if options[:limit] =~ /^\d+$/
      options[:limit] = options[:limit].to_i
    else
      raise ArgumentError, "limit should be an integer"
    end
  end
  # The business of adding limit/offset
  if options[:limit] and options[:offset]
    total_rows = select_value("SELECT count(*) as TotalRows from (#{sql.sub(/\bSELECT(\s+DISTINCT)?\b/i, "SELECT#{$1} TOP 1000000000")}) tally").to_i
    if (options[:limit] + options[:offset]) >= total_rows
      options[:limit] = (total_rows - options[:offset] >= 0) ? (total_rows - options[:offset]) : 0
    end
    # Make sure we do not need a special limit/offset for association limiting. http://gist.github.com/25118
    add_limit_offset_for_association_limiting!(sql,options) and return if sql_for_association_limiting?(sql)
    # Wrap the SQL query in a bunch of outer SQL queries that emulate proper LIMIT,OFFSET support.
    sql.sub!(/^\s*SELECT(\s+DISTINCT)?/i, "SELECT * FROM (SELECT TOP #{options[:limit]} * FROM (SELECT#{$1} TOP #{options[:limit] + options[:offset]}")
    sql << ") AS tmp1"
    if options[:order]
      order = options[:order].split(',').map do |field|
        order_by_column, order_direction = field.split(" ")
        order_by_column = quote_column_name(order_by_column)
        # Investigate the SQL query to figure out if the order_by_column has been renamed.
        if sql =~ /#{Regexp.escape(order_by_column)} AS (t\d_r\d\d?)/
          # Fx "[foo].[bar] AS t4_r2" was found in the SQL. Use the column alias (ie 't4_r2') for the subsequent orderings
          order_by_column = $1
        elsif order_by_column =~ /\w+\.\[?(\w+)\]?/
          order_by_column = $1
        else
          # It doesn't appear that the column name has been renamed as part of the query. Use just the column
          # name rather than the full identifier for the outer queries.
          order_by_column = order_by_column.split('.').last
        end
        # Put the column name and eventual direction back together
        [order_by_column, order_direction].join(' ').strip
      end.join(', ')
      sql << " ORDER BY #{change_order_direction(order)}) AS tmp2 ORDER BY #{order}"
    else
      sql << ") AS tmp2"
    end
  elsif options[:limit] && sql !~ /^\s*SELECT (@@|COUNT\()/i
    if md = sql.match(/^(\s*SELECT)(\s+DISTINCT)?(.*)/im)
      sql.replace "#{md[1]}#{md[2]} TOP #{options[:limit]}#{md[3]}"
    else
      # Account for building SQL fragments without SELECT yet. See #update_all and #limited_update_conditions.
      sql.replace "TOP #{options[:limit]} #{sql}"
    end
  end
end

#add_lock!(sql, options) ⇒ Object 



438
439
440
441
442
443
444
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 438

def add_lock!(sql, options)
  # http://blog.sqlauthority.com/2007/04/27/sql-server-2005-locking-hints-and-examples/
  return unless options[:lock]
  lock_type = options[:lock] == true ? 'WITH(HOLDLOCK, ROWLOCK)' : options[:lock]
  from_table = sql.match(/FROM(.*)WHERE/im)[1]
  sql.sub! from_table, "#{from_table}#{lock_type} "
end

#add_order_by_for_association_limiting!(sql, options) ⇒ Object 



624
625
626
627
628
629
630
631
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 624

def add_order_by_for_association_limiting!(sql, options)
  # Disertation http://gist.github.com/24073
  # Information http://weblogs.sqlteam.com/jeffs/archive/2007/12/13/select-distinct-order-by-error.aspx
  return sql if options[:order].blank?
  columns = sql.match(/SELECT\s+DISTINCT(.*)FROM/)[1].strip
  sql.sub!(/SELECT\s+DISTINCT/,'SELECT')
  sql << "GROUP BY #{columns} ORDER BY #{order_to_min_set(options[:order])}"
end

#begin_db_transaction ⇒ Object 



353
354
355
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 353

def begin_db_transaction
  do_execute "BEGIN TRANSACTION"
end

#case_sensitive_equality_operator ⇒ Object 



450
451
452
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 450

def case_sensitive_equality_operator
  "COLLATE Latin1_General_CS_AS ="
end

#change_column(table_name, column_name, type, options = {}) ⇒ Object 



580
581
582
583
584
585
586
587
588
589
590
591
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 580

def change_column(table_name, column_name, type, options = {})
  sql_commands = []
  change_column_sql = "ALTER TABLE #{quote_table_name(table_name)} ALTER COLUMN #{quote_column_name(column_name)} #{type_to_sql(type, options[:limit], options[:precision], options[:scale])}"
  change_column_sql << " NOT NULL" if options[:null] == false
  sql_commands << change_column_sql
  if options_include_default?(options)
    remove_default_constraint(table_name, column_name)
    sql_commands << "ALTER TABLE #{quote_table_name(table_name)} ADD CONSTRAINT #{default_name(table_name,column_name)} DEFAULT #{quote(options[:default])} FOR #{quote_column_name(column_name)}"
  end
  sql_commands.each { |c| do_execute(c) }
  remove_sqlserver_columns_cache_for(table_name)
end

#change_column_default(table_name, column_name, default) ⇒ Object 



593
594
595
596
597
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 593

def change_column_default(table_name, column_name, default)
  remove_default_constraint(table_name, column_name)
  do_execute "ALTER TABLE #{quote_table_name(table_name)} ADD CONSTRAINT #{default_name(table_name, column_name)} DEFAULT #{quote(default)} FOR #{quote_column_name(column_name)}"
  remove_sqlserver_columns_cache_for(table_name)
end

#change_column_null(table_name, column_name, null, default = nil) ⇒ Object 



633
634
635
636
637
638
639
640
641
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 633

def change_column_null(table_name, column_name, null, default = nil)
  column = column_for(table_name,column_name)
  unless null || default.nil?
    do_execute("UPDATE #{quote_table_name(table_name)} SET #{quote_column_name(column_name)}=#{quote(default)} WHERE #{quote_column_name(column_name)} IS NULL")
  end
  sql = "ALTER TABLE #{table_name} ALTER COLUMN #{quote_column_name(column_name)} #{type_to_sql column.type, column.limit, column.precision, column.scale}"
  sql << " NOT NULL" unless null
  do_execute sql
end

#columns(table_name, name = nil) ⇒ Object 



542
543
544
545
546
547
548
549
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 542

def columns(table_name, name = nil)
  return [] if table_name.blank?
  cache_key = unqualify_table_name(table_name)
  @sqlserver_columns_cache[cache_key] ||= column_definitions(table_name).collect do |ci|
    sqlserver_options = ci.except(:name,:default_value,:type,:null)
    SQLServerColumn.new ci[:name], ci[:default_value], ci[:type], ci[:null], sqlserver_options
  end
end

#commit_db_transaction ⇒ Object 



357
358
359
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 357

def commit_db_transaction
  do_execute "COMMIT TRANSACTION"
end

#create_database(name) ⇒ Object 



680
681
682
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 680

def create_database(name)
  do_execute "CREATE DATABASE #{name}"
end

#create_savepoint ⇒ Object 



365
366
367
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 365

def create_savepoint
  do_execute "SAVE TRANSACTION #{current_savepoint_name}"
end

#create_table(table_name, options = {}) ⇒ Object 



551
552
553
554
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 551

def create_table(table_name, options = {})
  super
  remove_sqlserver_columns_cache_for(table_name)
end

#current_database ⇒ Object 



684
685
686
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 684

def current_database
  select_value 'SELECT DB_NAME()'
end

#database_version ⇒ Object 



196
197
198
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 196

def database_version
  @database_version ||= info_schema_query { select_value('SELECT @@version') }
end

#database_year ⇒ Object 



200
201
202
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 200

def database_year
  DATABASE_VERSION_REGEXP.match(database_version)[1].to_i
end

#disable_referential_integrity(&block) ⇒ Object

REFERENTIAL INTEGRITY ====================================#



293
294
295
296
297
298
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 293

def disable_referential_integrity(&block)
  do_execute "EXEC sp_MSForEachTable 'ALTER TABLE ? NOCHECK CONSTRAINT ALL'"
  yield
ensure
  do_execute "EXEC sp_MSForEachTable 'ALTER TABLE ? CHECK CONSTRAINT ALL'"
end

#disconnect! ⇒ Object 



317
318
319
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 317

def disconnect!
  raw_connection.disconnect rescue nil
end

#drop_database(name) ⇒ Object 



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 661

def drop_database(name)
  retry_count = 0
  max_retries = 1
  begin
    do_execute "DROP DATABASE #{name}"
  rescue ActiveRecord::StatementInvalid => err
    # Remove existing connections and rollback any transactions if we received the message
    #  'Cannot drop the database 'test' because it is currently in use'
    if err.message =~ /because it is currently in use/
      raise if retry_count >= max_retries
      retry_count += 1
      remove_database_connections_and_rollback(name)
      retry
    else
      raise
    end
  end
end

#drop_table(table_name, options = {}) ⇒ Object 



560
561
562
563
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 560

def drop_table(table_name, options = {})
  super
  remove_sqlserver_columns_cache_for(table_name)
end

#empty_insert_statement(table_name) ⇒ Object 



446
447
448
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 446

def empty_insert_statement(table_name)
  "INSERT INTO #{quote_table_name(table_name)} DEFAULT VALUES"
end

#execute(sql, name = nil, &block) ⇒ Object 



332
333
334
335
336
337
338
339
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 332

def execute(sql, name = nil, &block)
  if table_name = query_requires_identity_insert?(sql)
    handle = with_identity_insert_enabled(table_name) { raw_execute(sql,name,&block) }
  else
    handle = raw_execute(sql,name,&block)
  end
  finish_statement_handle(handle)
end

#execute_procedure(proc_name, *variables) ⇒ Object 



341
342
343
344
345
346
347
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 341

def execute_procedure(proc_name, *variables)
  vars = variables.map{ |v| quote(v) }.join(', ')
  sql = "EXEC #{proc_name} #{vars}".strip
  select(sql,'Execute Procedure',true).inject([]) do |results,row|
    results << row.with_indifferent_access
  end
end

#finish_statement_handle(handle) ⇒ Object 



321
322
323
324
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 321

def finish_statement_handle(handle)
  handle.finish if handle && handle.respond_to?(:finish) && !handle.finished?
  handle
end

#indexes(table_name, name = nil) ⇒ Object 



524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 524

def indexes(table_name, name = nil)
  unquoted_table_name = unqualify_table_name(table_name)
  select("EXEC sp_helpindex #{quote_table_name(unquoted_table_name)}",name).inject([]) do |indexes,index|
    if index['index_description'] =~ /primary key/
      indexes
    else
      name    = index['index_name']
      unique  = index['index_description'] =~ /unique/
      columns = index['index_keys'].split(',').map do |column|
        column.strip!
        column.gsub! '(-)', '' if column.ends_with?('(-)')
        column
      end
      indexes << IndexDefinition.new(table_name, name, unique, columns)
    end
  end
end

#inspect ⇒ Object 



220
221
222
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 220

def inspect
  "#<#{self.class} version: #{version}, year: #{database_year}, connection_options: #{@connection_options.inspect}>"
end

#limited_update_conditions(where_sql, quoted_table_name, quoted_primary_key) ⇒ Object 



454
455
456
457
458
459
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 454

def limited_update_conditions(where_sql, quoted_table_name, quoted_primary_key)
  match_data = where_sql.match(/(.*)WHERE/)
  limit = match_data[1]
  where_sql.sub!(limit,'')
  "WHERE #{quoted_primary_key} IN (SELECT #{limit} #{quoted_primary_key} FROM #{quoted_table_name} #{where_sql})"
end

#native_binary_database_type ⇒ Object 



237
238
239
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 237

def native_binary_database_type
  @@native_binary_database_type || (sqlserver_2005? ? 'varbinary(max)' : 'image')
end

#native_database_types ⇒ Object

SCHEMA STATEMENTS ========================================#



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 463

def native_database_types
  {
    :primary_key  => "int NOT NULL IDENTITY(1, 1) PRIMARY KEY",
    :string       => { :name => native_string_database_type, :limit => 255  },
    :text         => { :name => native_text_database_type },
    :integer      => { :name => "int", :limit => 4 },
    :float        => { :name => "float", :limit => 8 },
    :decimal      => { :name => "decimal" },
    :datetime     => { :name => "datetime" },
    :timestamp    => { :name => "datetime" },
    :time         => { :name => "datetime" },
    :date         => { :name => "datetime" },
    :binary       => { :name => native_binary_database_type },
    :boolean      => { :name => "bit"},
    # These are custom types that may move somewhere else for good schema_dumper.rb hacking to output them.
    :char         => { :name => 'char' },
    :varchar_max  => { :name => 'varchar(max)' },
    :nchar        => { :name => "nchar" },
    :nvarchar     => { :name => "nvarchar", :limit => 255 },
    :nvarchar_max => { :name => "nvarchar(max)" },
    :ntext        => { :name => "ntext" }
  }
end

#native_string_database_type ⇒ Object 



224
225
226
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 224

def native_string_database_type
  @@native_string_database_type || (enable_default_unicode_types ? 'nvarchar' : 'varchar') 
end

#native_text_database_type ⇒ Object 



228
229
230
231
232
233
234
235
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 228

def native_text_database_type
  @@native_text_database_type || 
  if sqlserver_2005?
    enable_default_unicode_types ? 'nvarchar(max)' : 'varchar(max)'
  else
    enable_default_unicode_types ? 'ntext' : 'text'
  end
end

#outside_transaction? ⇒ Boolean

Returns:

  • (Boolean) 


349
350
351
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 349

def outside_transaction?
  info_schema_query { select_value("SELECT @@TRANCOUNT") == 0 }
end

#pk_and_sequence_for(table_name) ⇒ Object 



643
644
645
646
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 643

def pk_and_sequence_for(table_name)
  idcol = identity_column(table_name)
  idcol ? [idcol.name,nil] : nil
end

#quote(value, column = nil) ⇒ Object

QUOTING ==================================================#



243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 243

def quote(value, column = nil)
  case value
  when String, ActiveSupport::Multibyte::Chars
    if column && column.type == :binary
      column.class.string_to_binary(value)
    elsif column && column.respond_to?(:is_utf8?) && column.is_utf8?
      quoted_utf8_value(value)
    else
      super
    end
  else
    super
  end
end

#quote_column_name(column_name) ⇒ Object 



262
263
264
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 262

def quote_column_name(column_name)
  column_name.to_s.split('.').map{ |name| "[#{name}]" }.join('.')
end

#quote_string(string) ⇒ Object 



258
259
260
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 258

def quote_string(string)
  string.to_s.gsub(/\'/, "''")
end

#quote_table_name(table_name) ⇒ Object 



266
267
268
269
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 266

def quote_table_name(table_name)
  return table_name if table_name =~ /^\[.*\]$/
  quote_column_name(table_name)
end

#quoted_date(value) ⇒ Object 



279
280
281
282
283
284
285
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 279

def quoted_date(value)
  if value.acts_like?(:time) && value.respond_to?(:usec)
    "#{super}.#{sprintf("%03d",value.usec/1000)}"
  else
    super
  end
end

#quoted_false ⇒ Object 



275
276
277
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 275

def quoted_false
  '0'
end

#quoted_true ⇒ Object 



271
272
273
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 271

def quoted_true
  '1'
end

#quoted_utf8_value(value) ⇒ Object 



287
288
289
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 287

def quoted_utf8_value(value)
  "N'#{quote_string(value)}'"
end

#reconnect! ⇒ Object 



309
310
311
312
313
314
315
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 309

def reconnect!
  disconnect!
  @connection = DBI.connect(*@connection_options)
rescue DBI::DatabaseError => e
  @logger.warn "#{adapter_name} reconnection failed: #{e.message}" if @logger
  false
end

#recreate_database(name) ⇒ Object

RAKE UTILITY METHODS =====================================#



650
651
652
653
654
655
656
657
658
659
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 650

def recreate_database(name)
  existing_database = current_database.to_s
  if name.to_s == existing_database
    do_execute 'USE master' 
  end
  drop_database(name)
  create_database(name)
ensure
  do_execute "USE #{existing_database}" if name.to_s == existing_database 
end

#release_savepoint ⇒ Object 



369
370
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 369

def release_savepoint
end

#remove_column(table_name, *column_names) ⇒ Object 



570
571
572
573
574
575
576
577
578
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 570

def remove_column(table_name, *column_names)
  column_names.flatten.each do |column_name|
    remove_check_constraints(table_name, column_name)
    remove_default_constraint(table_name, column_name)
    remove_indexes(table_name, column_name)
    do_execute "ALTER TABLE #{quote_table_name(table_name)} DROP COLUMN #{quote_column_name(column_name)}"
  end
  remove_sqlserver_columns_cache_for(table_name)
end

#remove_database_connections_and_rollback(name) ⇒ Object 



688
689
690
691
692
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 688

def remove_database_connections_and_rollback(name)
  # This should disconnect all other users and rollback any transactions for SQL 2000 and 2005
  # http://sqlserver2000.databases.aspfaq.com/how-do-i-drop-a-sql-server-database.html
  do_execute "ALTER DATABASE #{name} SET SINGLE_USER WITH ROLLBACK IMMEDIATE"
end

#remove_index(table_name, options = {}) ⇒ Object 



605
606
607
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 605

def remove_index(table_name, options = {})
  do_execute "DROP INDEX #{table_name}.#{quote_column_name(index_name(table_name, options))}"
end

#rename_column(table_name, column_name, new_column_name) ⇒ Object 



599
600
601
602
603
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 599

def rename_column(table_name, column_name, new_column_name)
  column_for(table_name,column_name)
  do_execute "EXEC sp_rename '#{table_name}.#{column_name}', '#{new_column_name}', 'COLUMN'"
  remove_sqlserver_columns_cache_for(table_name)
end

#rename_table(table_name, new_name) ⇒ Object 



556
557
558
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 556

def rename_table(table_name, new_name)
  do_execute "EXEC sp_rename '#{table_name}', '#{new_name}'"
end

#rollback_db_transaction ⇒ Object 



361
362
363
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 361

def rollback_db_transaction
  do_execute "ROLLBACK TRANSACTION" rescue nil
end

#rollback_to_savepoint ⇒ Object 



372
373
374
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 372

def rollback_to_savepoint
  do_execute "ROLLBACK TRANSACTION #{current_savepoint_name}"
end

#select_rows(sql, name = nil) ⇒ Object

DATABASE STATEMENTS ======================================#



328
329
330
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 328

def select_rows(sql, name = nil)
  raw_select(sql,name).last
end

#sqlserver? ⇒ Boolean

Returns:

  • (Boolean) 


204
205
206
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 204

def sqlserver?
  true
end

#sqlserver_2000? ⇒ Boolean

Returns:

  • (Boolean) 


208
209
210
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 208

def sqlserver_2000?
  database_year == 2000
end

#sqlserver_2005? ⇒ Boolean

Returns:

  • (Boolean) 


212
213
214
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 212

def sqlserver_2005?
  database_year == 2005
end

#supports_ddl_transactions? ⇒ Boolean

Returns:

  • (Boolean) 


188
189
190
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 188

def supports_ddl_transactions?
  true
end

#supports_migrations? ⇒ Boolean

Returns:

  • (Boolean) 


184
185
186
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 184

def supports_migrations?
  true
end

#supports_savepoints? ⇒ Boolean

Returns:

  • (Boolean) 


192
193
194
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 192

def supports_savepoints?
  true
end

#table_alias_length ⇒ Object 



487
488
489
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 487

def table_alias_length
  128
end

#table_exists?(table_name) ⇒ Boolean

Returns:

  • (Boolean) 


520
521
522
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 520

def table_exists?(table_name)
  super || tables.include?(unqualify_table_name(table_name)) || views.include?(table_name.to_s)
end

#tables(name = nil) ⇒ Object 



491
492
493
494
495
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 491

def tables(name = nil)
  info_schema_query do
    select_values "SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_TYPE = 'BASE TABLE' AND TABLE_NAME <> 'dtproperties'"
  end
end

#type_to_sql(type, limit = nil, precision = nil, scale = nil) ⇒ Object 



609
610
611
612
613
614
615
616
617
618
619
620
621
622
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 609

def type_to_sql(type, limit = nil, precision = nil, scale = nil)
  limit = nil unless self.class.type_limitable?(type)
  case type.to_s
  when 'integer'
    case limit
      when 1..2       then  'smallint'
      when 3..4, nil  then  'integer'
      when 5..8       then  'bigint'
      else raise(ActiveRecordError, "No integer type has byte size #{limit}. Use a numeric with precision 0 instead.")
    end
  else
    super
  end
end

#version ⇒ Object 



216
217
218
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 216

def version
  self.class::VERSION
end

#view_information(table_name) ⇒ Object 



502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 502

def view_information(table_name)
  table_name = unqualify_table_name(table_name)
  @sqlserver_view_information_cache[table_name] ||= begin
    view_info = info_schema_query { select_one("SELECT * FROM INFORMATION_SCHEMA.VIEWS WHERE TABLE_NAME = '#{table_name}'") }
    if view_info
      if view_info['VIEW_DEFINITION'].blank? || view_info['VIEW_DEFINITION'].length == 4000
        view_info['VIEW_DEFINITION'] = info_schema_query { select_values("EXEC sp_helptext #{table_name}").join }
      end
    end
    view_info
  end
end

#view_table_name(table_name) ⇒ Object 



515
516
517
518
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 515

def view_table_name(table_name)
  view_info = view_information(table_name)
  view_info ? get_table_name(view_info['VIEW_DEFINITION']) : table_name
end

#views(name = nil) ⇒ Object 



497
498
499
500
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 497

def views(name = nil)
  @sqlserver_views_cache ||= 
    info_schema_query { select_values("SELECT TABLE_NAME FROM INFORMATION_SCHEMA.VIEWS WHERE TABLE_NAME NOT IN ('sysconstraints','syssegments')") }
end