Module: ArJdbc::MSSQL

Includes:
ExplainSupport, LimitHelpers, Utils
Included in:
ActiveRecord::ConnectionAdapters::MSSQLAdapter
Defined in:
lib/arjdbc/mssql/utils.rb,
lib/arjdbc/mssql/column.rb,
lib/arjdbc/mssql/adapter.rb,
lib/arjdbc/mssql/lock_methods.rb,
lib/arjdbc/mssql/limit_helpers.rb,
lib/arjdbc/mssql/explain_support.rb

Defined Under Namespace

Modules: Column, ExplainSupport, LimitHelpers, LockMethods, Utils

Constant Summary collapse

ADAPTER_NAME =
'MSSQL'.freeze

Constants included from ExplainSupport

ExplainSupport::DISABLED

Constants included from Utils

Utils::GET_TABLE_NAME_FROM_RE, Utils::GET_TABLE_NAME_INSERT_UPDATE_RE

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ExplainSupport

#explain, #set_showplan_option, #supports_explain?, #with_showplan_on

Methods included from Utils

get_table_name, remove_identifier_delimiters, unqualify_db_name, unqualify_table_name, unqualify_table_schema, unquote_column_name, unquote_string, unquote_table_name

Class Method Details

.arel2_visitors(config) ⇒ Object

Deprecated.

no longer used

See Also:

  • ActiveRecord::ConnectionAdapters::JdbcAdapter#arel2_visitors


77
78
79
80
# File 'lib/arjdbc/mssql/adapter.rb', line 77

def self.arel2_visitors(config)
  visitor = arel_visitor_type(config)
  { 'mssql' => visitor, 'jdbcmssql' => visitor, 'sqlserver' => visitor }
end

.arel_visitor_type(config) ⇒ Object



69
70
71
72
73
# File 'lib/arjdbc/mssql/adapter.rb', line 69

def self.arel_visitor_type(config)
  require 'arel/visitors/sql_server'
  ( config && config[:sqlserver_version].to_s == '2000' ) ?
    ::Arel::Visitors::SQLServer2000 : ::Arel::Visitors::SQLServer
end

.column_selectorObject

See Also:

  • ActiveRecord::ConnectionAdapters::JdbcColumn#column_types


5
6
7
# File 'lib/arjdbc/mssql/column.rb', line 5

def self.column_selector
  [ /sqlserver|tds|Microsoft SQL/i, lambda { |config, column| column.extend(Column) } ]
end

.jdbc_connection_classObject



59
60
61
# File 'lib/arjdbc/mssql/adapter.rb', line 59

def self.jdbc_connection_class
  ::ActiveRecord::ConnectionAdapters::MSSQLJdbcConnection
end

.update_lob_values=(update) ⇒ Object

See Also:

  • #update_lob_values?


46
# File 'lib/arjdbc/mssql/adapter.rb', line 46

def self.update_lob_values=(update); @@update_lob_values = update; end

.update_lob_values?Boolean

Note:

This only applies when prepared statements are not used.

Updating records with LOB values (binary/text columns) in a separate statement can be disabled using :

ArJdbc::MSSQL.update_lob_values = false

Returns:

  • (Boolean)


44
# File 'lib/arjdbc/mssql/adapter.rb', line 44

def self.update_lob_values?; @@update_lob_values; end

Instance Method Details

#adapter_nameObject



230
231
232
# File 'lib/arjdbc/mssql/adapter.rb', line 230

def adapter_name
  ADAPTER_NAME
end

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

Adds a new column to the named table.



348
349
350
351
352
353
354
355
# File 'lib/arjdbc/mssql/adapter.rb', line 348

def add_column(table_name, column_name, type, options = {})
  clear_cached_table(table_name)
  add_column_sql = "ALTER TABLE #{quote_table_name(table_name)} ADD #{quote_column_name(column_name)} #{type_to_sql(type, options[:limit], options[:precision], options[:scale])}"
  add_column_options!(add_column_sql, options)
  # TODO: Add support to mimic date columns, using constraints to mark them as such in the database
  # add_column_sql << " CONSTRAINT ck__#{table_name}__#{column_name}__date_only CHECK ( CONVERT(CHAR(12), #{quote_column_name(column_name)}, 14)='00:00:00:000' )" if type == :date
  execute(add_column_sql)
end

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



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
# File 'lib/arjdbc/mssql/adapter.rb', line 364

def change_column(table_name, column_name, type, options = {})

  indexes = []
  column_object = columns(table_name).detect { |c| c.name.to_s == column_name.to_s }

  if options_include_default?(options) || (column_object && column_object.type != type.to_sym)
    remove_default_constraint(table_name, column_name)
    indexes = indexes(table_name).select{ |index| index.columns.include?(column_name.to_s) }
    remove_indexes(table_name, column_name)
  end

  clear_cached_table(table_name)
  change_column_type(table_name, column_name, type, options)
  change_column_default(table_name, column_name, options[:default]) if options_include_default?(options)

  #Add any removed indexes back
  indexes.each do |index|
    execute "CREATE INDEX #{quote_table_name(index.name)} ON #{quote_table_name(table_name)} (#{index.columns.collect {|c|quote_column_name(c)}.join(', ')})"
  end
end

#change_column_default(table_name, column_name, default) ⇒ Object



392
393
394
395
396
397
398
# File 'lib/arjdbc/mssql/adapter.rb', line 392

def change_column_default(table_name, column_name, default)
  clear_cached_table(table_name)
  remove_default_constraint(table_name, column_name)
  unless default.nil?
    execute "ALTER TABLE #{quote_table_name(table_name)} ADD CONSTRAINT DF_#{table_name}_#{column_name} DEFAULT #{quote(default)} FOR #{quote_column_name(column_name)}"
  end
end

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



385
386
387
388
389
390
# File 'lib/arjdbc/mssql/adapter.rb', line 385

def change_column_type(table_name, column_name, type, options = {})
  clear_cached_table(table_name)
  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])}"
  sql += (options[:null] ? " NULL" : " NOT NULL") if options.has_key?(:null)
  execute(sql)
end

#change_order_direction(order) ⇒ Object



234
235
236
237
238
239
240
241
242
243
# File 'lib/arjdbc/mssql/adapter.rb', line 234

def change_order_direction(order)
  asc, desc = /\bASC\b/i, /\bDESC\b/i
  order.split(",").collect do |fragment|
    case fragment
    when desc  then fragment.gsub(desc, "ASC")
    when asc   then fragment.gsub(asc, "DESC")
    else "#{fragment.split(',').join(' DESC,')} DESC"
    end
  end.join(",")
end

#charsetObject



292
293
294
# File 'lib/arjdbc/mssql/adapter.rb', line 292

def charset
  select_value "SELECT SERVERPROPERTY('SqlCharSetName')"
end

#clear_cached_table(table_name) ⇒ Object



487
488
489
# File 'lib/arjdbc/mssql/adapter.rb', line 487

def clear_cached_table(table_name)
  ( @table_columns ||= {} ).delete(table_name.to_s)
end

#collationObject



296
297
298
# File 'lib/arjdbc/mssql/adapter.rb', line 296

def collation
  select_value "SELECT SERVERPROPERTY('Collation')"
end

#columns(table_name, name = nil, default = EMPTY_ARRAY) ⇒ Object



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
# File 'lib/arjdbc/mssql/adapter.rb', line 466

def columns(table_name, name = nil, default = EMPTY_ARRAY)
  # It's possible for table_name to be an empty string, or nil, if something
  # attempts to issue SQL which doesn't involve a table.
  # IE. "SELECT 1" or "SELECT * FROM someFunction()".
  return default if table_name.blank?

  table_name = unquote_table_name(table_name)

  return default if table_name =~ SKIP_COLUMNS_TABLE_NAMES_RE

  unless columns = ( @table_columns ||= {} )[table_name]
    columns = super(table_name, name)
    for column in columns
      column.identity = true if column.sql_type =~ IDENTITY_COLUMN_TYPE_RE
      column.special = true if column.sql_type =~ SPECIAL_COLUMN_TYPE_RE
    end
    @table_columns[table_name] = columns
  end
  columns
end

#configure_connectionObject



82
83
84
# File 'lib/arjdbc/mssql/adapter.rb', line 82

def configure_connection
  use_database # config[:database]
end

#create_database(name, options = {}) ⇒ Object



332
333
334
# File 'lib/arjdbc/mssql/adapter.rb', line 332

def create_database(name, options = {})
  execute "CREATE DATABASE #{quote_table_name(name)}"
end

#current_databaseObject



300
301
302
# File 'lib/arjdbc/mssql/adapter.rb', line 300

def current_database
  select_value 'SELECT DB_NAME()'
end

#current_userObject

SELECT CURRENT_USER



288
289
290
# File 'lib/arjdbc/mssql/adapter.rb', line 288

def current_user
  @current_user ||= @connection.execute_query_raw("SELECT CURRENT_USER").first['']
end

#database_exists?(name) ⇒ Boolean

Returns:

  • (Boolean)


336
337
338
# File 'lib/arjdbc/mssql/adapter.rb', line 336

def database_exists?(name)
  select_value "SELECT name FROM sys.databases WHERE name = '#{name}'"
end

#default_schemaObject Also known as: current_schema

Returns the default schema (to be used for table resolution) used for the #current_user.



268
269
270
271
272
273
274
# File 'lib/arjdbc/mssql/adapter.rb', line 268

def default_schema
  return current_user if sqlserver_2000?
  @default_schema ||=
    @connection.execute_query_raw(
      "SELECT default_schema_name FROM sys.database_principals WHERE name = CURRENT_USER"
    ).first['default_schema_name']
end

#default_schema=(default_schema) ⇒ Object Also known as: current_schema=

Note:

This is not supported on SQL Server 2000 !

Allows for changing of the default schema (to be used during unqualified table name resolution).



280
281
282
283
284
# File 'lib/arjdbc/mssql/adapter.rb', line 280

def default_schema=(default_schema) # :nodoc:
  raise "changing DEFAULT_SCHEMA only supported on SQLServer 2005+" if sqlserver_2000?
  execute("ALTER #{current_user} WITH DEFAULT_SCHEMA=#{default_schema}")
  @default_schema = nil if defined?(@default_schema)
end

#drop_database(name) ⇒ Object



326
327
328
329
330
# File 'lib/arjdbc/mssql/adapter.rb', line 326

def drop_database(name)
  current_db = current_database
  use_database('master') if current_db.to_s == name
  execute "DROP DATABASE #{quote_table_name(name)}"
end

#exec_proc(proc_name, *variables) ⇒ Object Also known as: execute_procedure

Support for executing a stored procedure.



530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
# File 'lib/arjdbc/mssql/adapter.rb', line 530

def exec_proc(proc_name, *variables)
  vars =
    if variables.any? && variables.first.is_a?(Hash)
      variables.first.map { |k, v| "@#{k} = #{quote(v)}" }
    else
      variables.map { |v| quote(v) }
    end.join(', ')
  sql = "EXEC #{proc_name} #{vars}".strip
  log(sql, 'Execute Procedure') do
    result = @connection.execute_query_raw(sql)
    result.map! do |row|
      row = row.is_a?(Hash) ? row.with_indifferent_access : row
      yield(row) if block_given?
      row
    end
    result
  end
end

#exec_query(sql, name = 'SQL', binds = []) ⇒ Object



551
552
553
554
555
556
557
558
559
560
561
562
563
564
# File 'lib/arjdbc/mssql/adapter.rb', line 551

def exec_query(sql, name = 'SQL', binds = [])
  # NOTE: we allow to execute SQL as requested returning a results.
  # e.g. this allows to use SQLServer's EXEC with a result set ...
  if sql.respond_to?(:to_sql)
    sql = to_sql(sql, binds); to_sql = true
  end
  sql = repair_special_columns(sql)
  if prepared_statements?
    log(sql, name, binds) { @connection.execute_query(sql, binds) }
  else
    sql = suble_binds(sql, binds) unless to_sql # deprecated behavior
    log(sql, name) { @connection.execute_query(sql) }
  end
end

#exec_query_raw(sql, name = 'SQL', binds = [], &block) ⇒ Object



567
568
569
570
571
572
573
574
575
576
577
578
# File 'lib/arjdbc/mssql/adapter.rb', line 567

def exec_query_raw(sql, name = 'SQL', binds = [], &block)
  if sql.respond_to?(:to_sql)
    sql = to_sql(sql, binds); to_sql = true
  end
  sql = repair_special_columns(sql)
  if prepared_statements?
    log(sql, name, binds) { @connection.execute_query_raw(sql, binds, &block) }
  else
    sql = suble_binds(sql, binds) unless to_sql # deprecated behavior
    log(sql, name) { @connection.execute_query_raw(sql, &block) }
  end
end

#jdbc_column_classObject



64
65
66
# File 'lib/arjdbc/mssql/adapter.rb', line 64

def jdbc_column_class
  ::ActiveRecord::ConnectionAdapters::MSSQLColumn
end

#modify_types(types) ⇒ Object



94
95
96
97
98
99
100
101
102
103
104
105
106
# File 'lib/arjdbc/mssql/adapter.rb', line 94

def modify_types(types)
  types[:string] = { :name => "NVARCHAR", :limit => 255 }
  if sqlserver_2000?
    types[:text] = { :name => "NTEXT" }
  else
    types[:text] = { :name => "NVARCHAR(MAX)" }
  end
  types[:primary_key] = "int NOT NULL IDENTITY(1, 1) PRIMARY KEY"
  types[:integer][:limit] = nil
  types[:boolean] = { :name => "bit" }
  types[:binary] = { :name => "image" }
  types
end

#quote(value, column = nil) ⇒ Object



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
# File 'lib/arjdbc/mssql/adapter.rb', line 144

def quote(value, column = nil)
  return value.quoted_id if value.respond_to?(:quoted_id)
  return value if sql_literal?(value)

  case value
  # SQL Server 2000 doesn't let you insert an integer into a NVARCHAR
  when String, ActiveSupport::Multibyte::Chars, Integer
    value = value.to_s
    column_type = column && column.type
    if column_type == :binary
      if update_lob_value?(value, column)
        BLOB_VALUE_MARKER
      else
        "'#{quote_string(column.class.string_to_binary(value))}'" # ' (for ruby-mode)
      end
    elsif column_type == :integer
      value.to_i.to_s
    elsif column_type == :float
      value.to_f.to_s
    elsif ! column.respond_to?(:is_utf8?) || column.is_utf8?
      "N'#{quote_string(value)}'" # ' (for ruby-mode)
    else
      super
    end
  when Date, Time
    if column && column.type == :time
      "'#{quoted_time(value)}'"
    else
      "'#{quoted_date(value)}'"
    end
  when TrueClass  then '1'
  when FalseClass then '0'
  else super
  end
end

#quote_column_name(name) ⇒ Object



222
223
224
225
226
# File 'lib/arjdbc/mssql/adapter.rb', line 222

def quote_column_name(name)
  name.to_s.split('.').map do |n| # "[#{name}]"
    n =~ /^\[.*\]$/ ? n : "[#{n.gsub(']', ']]')}]"
  end.join('.')
end

#quote_table_name(name) ⇒ Object



218
219
220
# File 'lib/arjdbc/mssql/adapter.rb', line 218

def quote_table_name(name)
  quote_column_name(name)
end

#quoted_date(value) ⇒ Object



181
182
183
184
185
186
187
# File 'lib/arjdbc/mssql/adapter.rb', line 181

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

#release_savepoint(name = current_savepoint_name) ⇒ Object



581
582
583
584
585
586
587
# File 'lib/arjdbc/mssql/adapter.rb', line 581

def release_savepoint(name = current_savepoint_name)
  if @connection.jtds_driver?
    @connection.release_savepoint(name)
  else # MS invented it's "own" way
    @connection.rollback_savepoint(name)
  end
end

#remove_check_constraints(table_name, column_name) ⇒ Object



432
433
434
435
436
437
438
439
440
# File 'lib/arjdbc/mssql/adapter.rb', line 432

def remove_check_constraints(table_name, column_name)
  clear_cached_table(table_name)
  constraints = select_values "SELECT constraint_name" <<
    " FROM information_schema.constraint_column_usage" <<
    " WHERE table_name = '#{table_name}' AND column_name = '#{column_name}'"
  constraints.each do |constraint_name|
    execute "ALTER TABLE #{table_name} DROP CONSTRAINT #{constraint_name}"
  end
end

#remove_column(table_name, *column_names) ⇒ Object

Raises:

  • (ArgumentError)


400
401
402
403
404
405
406
407
408
409
410
# File 'lib/arjdbc/mssql/adapter.rb', line 400

def remove_column(table_name, *column_names)
  raise ArgumentError.new("You must specify at least one column name. Example: remove_column(:people, :first_name)") if column_names.empty?
  # remove_columns(:posts, :foo, :bar) old syntax : remove_columns(:posts, [:foo, :bar])
  clear_cached_table(table_name)
  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) unless sqlserver_2000?
    execute "ALTER TABLE #{quote_table_name(table_name)} DROP COLUMN #{quote_column_name(column_name)}"
  end
end

#remove_default_constraint(table_name, column_name) ⇒ Object



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
# File 'lib/arjdbc/mssql/adapter.rb', line 412

def remove_default_constraint(table_name, column_name)
  clear_cached_table(table_name)
  if sqlserver_2000?
    # NOTE: since SQLServer 2005 these are provided as sys.sysobjects etc.
    # but only due backwards-compatibility views and should be avoided ...
    defaults = select_values "SELECT d.name" <<
      " FROM sysobjects d, syscolumns c, sysobjects t" <<
      " WHERE c.cdefault = d.id AND c.name = '#{column_name}'" <<
      " AND t.name = '#{table_name}' AND c.id = t.id"
  else
    defaults = select_values "SELECT d.name FROM sys.tables t" <<
      " JOIN sys.default_constraints d ON d.parent_object_id = t.object_id" <<
      " JOIN sys.columns c ON c.object_id = t.object_id AND c.column_id = d.parent_column_id" <<
      " WHERE t.name = '#{table_name}' AND c.name = '#{column_name}'"
  end
  defaults.each do |def_name|
    execute "ALTER TABLE #{table_name} DROP CONSTRAINT #{def_name}"
  end
end

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



449
450
451
# File 'lib/arjdbc/mssql/adapter.rb', line 449

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

#remove_indexes(table_name, column_name) ⇒ Object



442
443
444
445
446
447
# File 'lib/arjdbc/mssql/adapter.rb', line 442

def remove_indexes(table_name, column_name)
  indexes = self.indexes(table_name)
  indexes.select{ |index| index.columns.include?(column_name.to_s) }.each do |index|
    remove_index(table_name, { :name => index.name })
  end
end

#rename_column(table_name, column_name, new_column_name) ⇒ Object



358
359
360
361
# File 'lib/arjdbc/mssql/adapter.rb', line 358

def rename_column(table_name, column_name, new_column_name)
  clear_cached_table(table_name)
  execute "EXEC sp_rename '#{table_name}.#{column_name}', '#{new_column_name}', 'COLUMN'"
end

#rename_table(table_name, new_table_name) ⇒ Object



341
342
343
344
# File 'lib/arjdbc/mssql/adapter.rb', line 341

def rename_table(table_name, new_table_name)
  clear_cached_table(table_name)
  execute "EXEC sp_rename '#{table_name}', '#{new_table_name}'"
end

#reset_column_informationObject



491
492
493
# File 'lib/arjdbc/mssql/adapter.rb', line 491

def reset_column_information
  @table_columns = nil if defined? @table_columns
end

#set_identity_insert(table_name, enable = true) ⇒ Object



505
506
507
508
509
510
# File 'lib/arjdbc/mssql/adapter.rb', line 505

def set_identity_insert(table_name, enable = true)
  execute "SET IDENTITY_INSERT #{table_name} #{enable ? 'ON' : 'OFF'}"
rescue Exception => e
  raise ActiveRecord::ActiveRecordError, "IDENTITY_INSERT could not be turned" +
        " #{enable ? 'ON' : 'OFF'} for table #{table_name} due : #{e.inspect}"
end

#sqlserver_versionObject



86
87
88
89
90
91
92
# File 'lib/arjdbc/mssql/adapter.rb', line 86

def sqlserver_version
  @sqlserver_version ||= begin
    config_version = config[:sqlserver_version]
    config_version ? config_version.to_s :
      select_value("SELECT @@version")[/(Microsoft SQL Server\s+|Microsoft SQL Azure.+\n.+)(\d{4})/, 2]
  end
end

#supports_ddl_transactions?Boolean

Returns:

  • (Boolean)


245
246
247
# File 'lib/arjdbc/mssql/adapter.rb', line 245

def supports_ddl_transactions?
  true
end

#tables(schema = current_schema) ⇒ Object



249
250
251
# File 'lib/arjdbc/mssql/adapter.rb', line 249

def tables(schema = current_schema)
  @connection.tables(nil, schema)
end

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# File 'lib/arjdbc/mssql/adapter.rb', line 111

def type_to_sql(type, limit = nil, precision = nil, scale = nil)
  type_s = type.to_s
  # MSSQL's NVARCHAR(n | max) column supports either a number between 1 and
  # 4000, or the word "MAX", which corresponds to 2**30-1 UCS-2 characters.
  #
  # It does not accept NVARCHAR(1073741823) here, so we have to change it
  # to NVARCHAR(MAX), even though they are logically equivalent.
  #
  # MSSQL Server 2000 is skipped here because I don't know how it will behave.
  #
  # See: http://msdn.microsoft.com/en-us/library/ms186939.aspx
  if type_s == 'string' && limit == 1073741823 && ! sqlserver_2000?
    'NVARCHAR(MAX)'
  elsif NO_LIMIT_TYPES.include?(type_s)
    super(type)
  elsif type_s == 'integer'
    if limit.nil? || limit == 4
      'int'
    elsif limit == 2
      'smallint'
    elsif limit == 1
      'tinyint'
    else
      'bigint'
    end
  elsif type_s == 'uniqueidentifier'
    type_s
  else
    super
  end
end

#update_lob_value?(value, column = nil) ⇒ Boolean

Returns:

  • (Boolean)

See Also:



54
55
56
# File 'lib/arjdbc/mssql/adapter.rb', line 54

def update_lob_value?(value, column = nil)
  MSSQL.update_lob_values? && ! prepared_statements? # && value
end

#use_database(database = nil) ⇒ Object



304
305
306
307
# File 'lib/arjdbc/mssql/adapter.rb', line 304

def use_database(database = nil)
  database ||= config[:database]
  execute "USE #{quote_table_name(database)}" unless database.blank?
end

#with_identity_insert_enabled(table_name) ⇒ Object

Turns IDENTITY_INSERT ON for table during execution of the block N.B. This sets the state of IDENTITY_INSERT to OFF after the block has been executed without regard to its previous state



498
499
500
501
502
503
# File 'lib/arjdbc/mssql/adapter.rb', line 498

def with_identity_insert_enabled(table_name)
  set_identity_insert(table_name, true)
  yield
ensure
  set_identity_insert(table_name, false)
end