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.5'.freeze
DATABASE_VERSION_REGEXP = 
/Microsoft SQL Server\s+(\d{4})/
SUPPORTED_VERSIONS = 
[2000,2005,2008].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.



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

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) 


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

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

Instance Method Details

#active? ⇒ Boolean

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

Returns:

  • (Boolean) 


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

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

#adapter_name ⇒ Object

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



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

def adapter_name
  ADAPTER_NAME
end

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



538
539
540
541
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 538

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

#add_limit_offset!(sql, options) ⇒ Object 



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
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
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 343

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]
    
    # adjust :limit to accommodate edge cases where there is not enough rows to reach the limit.
    # Do we even need this??

    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 



419
420
421
422
423
424
425
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 419

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 



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

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 



331
332
333
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 331

def begin_db_transaction
  do_execute "BEGIN TRANSACTION"
end

#case_sensitive_equality_operator ⇒ Object 



431
432
433
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 431

def case_sensitive_equality_operator
  "COLLATE Latin1_General_CS_AS ="
end

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



553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 553

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 



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

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 



606
607
608
609
610
611
612
613
614
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 606

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 



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

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 



335
336
337
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 335

def commit_db_transaction
  do_execute "COMMIT TRANSACTION"
end

#create_database(name) ⇒ Object 



653
654
655
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 653

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

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



524
525
526
527
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 524

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

#current_database ⇒ Object 



657
658
659
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 657

def current_database
  select_value 'SELECT DB_NAME()'
end

#database_version ⇒ Object 



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

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

#database_year ⇒ Object 



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

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

#disable_referential_integrity(&block) ⇒ Object

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



283
284
285
286
287
288
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 283

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 



307
308
309
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 307

def disconnect!
  raw_connection.disconnect rescue nil
end

#drop_database(name) ⇒ Object 



634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 634

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 



533
534
535
536
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 533

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

#empty_insert_statement(table_name) ⇒ Object 



427
428
429
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 427

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

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



322
323
324
325
326
327
328
329
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 322

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

#finish_statement_handle(handle) ⇒ Object 



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

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

#indexes(table_name, name = nil) ⇒ Object 



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

def indexes(table_name, name = nil)
  select("EXEC sp_helpindex #{quote_table_name(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 



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

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 



435
436
437
438
439
440
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 435

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 



227
228
229
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 227

def native_binary_database_type
  self.class.native_binary_database_type || ((sqlserver_2005? || sqlserver_2008?) ? 'varbinary(max)' : 'image')
end

#native_database_types ⇒ Object

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



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 444

def native_database_types
  {
    :primary_key  => "int NOT NULL IDENTITY(1, 1) PRIMARY KEY",
    :string       => { :name => "varchar", :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_text_database_type ⇒ Object 



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

def native_text_database_type
  self.class.native_text_database_type || ((sqlserver_2005? || sqlserver_2008?) ? 'varchar(max)' : 'text')
end

#pk_and_sequence_for(table_name) ⇒ Object 



616
617
618
619
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 616

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

#quote(value, column = nil) ⇒ Object

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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 233

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 



252
253
254
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 252

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

#quote_string(string) ⇒ Object 



248
249
250
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 248

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

#quote_table_name(table_name) ⇒ Object 



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

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

#quoted_date(value) ⇒ Object 



269
270
271
272
273
274
275
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 269

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 



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

def quoted_false
  '0'
end

#quoted_true ⇒ Object 



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

def quoted_true
  '1'
end

#quoted_utf8_value(value) ⇒ Object 



277
278
279
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 277

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

#reconnect! ⇒ Object 



299
300
301
302
303
304
305
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 299

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 =====================================#



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

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

#remove_column(table_name, *column_names) ⇒ Object 



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

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 



661
662
663
664
665
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 661

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 



578
579
580
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 578

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 



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

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 



529
530
531
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 529

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

#rollback_db_transaction ⇒ Object 



339
340
341
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 339

def rollback_db_transaction
  do_execute "ROLLBACK TRANSACTION" rescue nil
end

#select_rows(sql, name = nil) ⇒ Object

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



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

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

#sqlserver? ⇒ Boolean

Returns:

  • (Boolean) 


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

def sqlserver?
  true
end

#sqlserver_2000? ⇒ Boolean

Returns:

  • (Boolean) 


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

def sqlserver_2000?
  database_year == 2000
end

#sqlserver_2005? ⇒ Boolean

Returns:

  • (Boolean) 


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

def sqlserver_2005?
  database_year == 2005
end

#sqlserver_2008? ⇒ Boolean

Returns:

  • (Boolean) 


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

def sqlserver_2008?
  database_year == 2008
end

#supports_ddl_transactions? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_ddl_transactions?
  true
end

#supports_migrations? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_migrations?
  true
end

#table_alias_length ⇒ Object 



468
469
470
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 468

def table_alias_length
  128
end

#table_exists?(table_name) ⇒ Boolean

Returns:

  • (Boolean) 


494
495
496
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 494

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

#tables(name = nil) ⇒ Object 



472
473
474
475
476
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 472

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 



582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 582

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 



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

def version
  self.class::VERSION
end

#view_information(table_name) ⇒ Object 



483
484
485
486
487
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 483

def view_information(table_name)
  table_name = unqualify_table_name(table_name)
  @sqlserver_view_information_cache[table_name] ||= 
    info_schema_query { select_one("SELECT * FROM INFORMATION_SCHEMA.VIEWS WHERE TABLE_NAME = '#{table_name}'") }
end

#view_table_name(table_name) ⇒ Object 



489
490
491
492
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 489

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 



478
479
480
481
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 478

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