Class: ActiveRecord::ConnectionAdapters::SQLServerAdapter

Inherits:
AbstractAdapter
  • Object
show all
Includes:
ActiveRecord::ConnectionAdapters::Sqlserver::DatabaseLimits, ActiveRecord::ConnectionAdapters::Sqlserver::DatabaseStatements, ActiveRecord::ConnectionAdapters::Sqlserver::Errors, ActiveRecord::ConnectionAdapters::Sqlserver::Quoting, ActiveRecord::ConnectionAdapters::Sqlserver::SchemaStatements, ActiveRecord::ConnectionAdapters::Sqlserver::Showplan
Defined in:
lib/active_record/connection_adapters/sqlserver_adapter.rb

Overview

class SQLServerColumn

Constant Summary collapse

VERSION = 
File.read(File.expand_path("../../../../VERSION",__FILE__)).strip
ADAPTER_NAME = 
'SQLServer'.freeze
DATABASE_VERSION_REGEXP = 
/Microsoft SQL Server\s+"?(\d{4}|\w+)"?/
SUPPORTED_VERSIONS = 
[2005,2008,2010,2011,2012]

Constants included from ActiveRecord::ConnectionAdapters::Sqlserver::Errors

ActiveRecord::ConnectionAdapters::Sqlserver::Errors::LOST_CONNECTION_EXCEPTIONS, ActiveRecord::ConnectionAdapters::Sqlserver::Errors::LOST_CONNECTION_MESSAGES

Constants included from ActiveRecord::ConnectionAdapters::Sqlserver::Showplan

ActiveRecord::ConnectionAdapters::Sqlserver::Showplan::OPTIONS, ActiveRecord::ConnectionAdapters::Sqlserver::Showplan::OPTION_ALL, ActiveRecord::ConnectionAdapters::Sqlserver::Showplan::OPTION_TEXT, ActiveRecord::ConnectionAdapters::Sqlserver::Showplan::OPTION_XML

Constants included from ActiveRecord::ConnectionAdapters::Sqlserver::Quoting

ActiveRecord::ConnectionAdapters::Sqlserver::Quoting::QUOTED_STRING_PREFIX

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ActiveRecord::ConnectionAdapters::Sqlserver::Errors

#lost_connection_exceptions, #lost_connection_messages

Methods included from ActiveRecord::ConnectionAdapters::Sqlserver::DatabaseLimits

#column_name_length, #columns_per_multicolumn_index, #columns_per_table, #in_clause_length, #index_name_length, #indexes_per_table, #joins_per_query, #sql_query_length, #table_alias_length, #table_name_length

Methods included from ActiveRecord::ConnectionAdapters::Sqlserver::SchemaStatements

#change_column, #change_column_default, #change_column_null, #columns, #indexes, #native_database_types, #remove_column, #remove_index!, #rename_column, #rename_table, #table_exists?, #tables, #type_to_sql, #views

Methods included from ActiveRecord::ConnectionAdapters::Sqlserver::Showplan

#explain

Methods included from ActiveRecord::ConnectionAdapters::Sqlserver::DatabaseStatements

#activity_stats, #add_limit_offset!, #begin_db_transaction, #case_sensitive_modifier, #charset, #commit_db_transaction, #create_database, #create_savepoint, #current_database, #drop_database, #empty_insert_statement_value, #exec_delete, #exec_insert, #exec_query, #exec_update, #execute, #execute_procedure, #newid_function, #newsequentialid_function, #outside_transaction?, #recreate_database, #recreate_database!, #release_savepoint, #rollback_db_transaction, #rollback_to_savepoint, #run_with_isolation_level, #select_rows, #supports_statement_cache?, #transaction, #use_database, #user_options, #user_options_dateformat, #user_options_isolation_level, #user_options_language

Methods included from ActiveRecord::ConnectionAdapters::Sqlserver::CoreExt::DatabaseStatements

#transaction_with_retry_deadlock_victim

Methods included from ActiveRecord::ConnectionAdapters::Sqlserver::Quoting

#quote, #quote_column_name, #quote_string, #quote_table_name, #quoted_date, #quoted_datetime, #quoted_false, #quoted_full_iso8601, #quoted_string_prefix, #quoted_true, #substitute_at

Constructor Details

#initialize(connection, logger, pool, config) ⇒ SQLServerAdapter

Returns a new instance of SQLServerAdapter.



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 196

def initialize(connection, logger, pool, config)
  super(connection, logger, pool)
  # AbstractAdapter Responsibility
  @schema_cache = Sqlserver::SchemaCache.new self
  @visitor = Arel::Visitors::SQLServer.new self
  # Our Responsibility
  @config = config
  @connection_options = config
  connect
  @database_version = select_value 'SELECT @@version', 'SCHEMA'
  @database_year = begin
                     if @database_version =~ /Azure/i
                       @sqlserver_azure = true
                       @database_version.match(/\s-\s([0-9.]+)/)[1]
                       year = 2012
                     else
                       year = DATABASE_VERSION_REGEXP.match(@database_version)[1]
                       year == "Denali" ? 2011 : year.to_i
                     end
                   rescue
                     0
                   end
  @product_level    = select_value "SELECT CAST(SERVERPROPERTY('productlevel') AS VARCHAR(128))", 'SCHEMA'
  @product_version  = select_value "SELECT CAST(SERVERPROPERTY('productversion') AS VARCHAR(128))", 'SCHEMA'
  @edition          = select_value "SELECT CAST(SERVERPROPERTY('edition') AS VARCHAR(128))", 'SCHEMA'
  initialize_dateformatter
  use_database
  unless (@sqlserver_azure == true || SUPPORTED_VERSIONS.include?(@database_year))
    raise NotImplementedError, "Currently, only #{SUPPORTED_VERSIONS.to_sentence} are supported. We got back #{@database_version}."
  end
end

Instance Attribute Details

#database_version ⇒ Object (readonly)

Returns the value of attribute database_version.



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

def database_version
  @database_version
end

#database_year ⇒ Object (readonly)

Returns the value of attribute database_year.



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

def database_year
  @database_year
end

#edition ⇒ Object (readonly)

Returns the value of attribute edition.



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

def edition
  @edition
end

#product_level ⇒ Object (readonly)

Returns the value of attribute product_level.



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

def product_level
  @product_level
end

#product_version ⇒ Object (readonly)

Returns the value of attribute product_version.



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

def product_version
  @product_version
end

#spid ⇒ Object (readonly)

Returns the value of attribute spid.



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

def spid
  @spid
end

Instance Method Details

#active? ⇒ Boolean

Abstract Adapter (Connection Management) ================== #

Returns:

  • (Boolean) 


275
276
277
278
279
280
281
282
283
284
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 275

def active?
  case @connection_options[:mode]
  when :dblib
    return @connection.active?
  end
  raw_connection_do("SELECT 1")
  true
rescue *lost_connection_exceptions
  false
end

#adapter_name ⇒ Object

Abstract Adapter ========================================== #



230
231
232
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 230

def adapter_name
  ADAPTER_NAME
end

#auto_connect ⇒ Object 



351
352
353
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 351

def auto_connect
  @@auto_connect.is_a?(FalseClass) ? false : true
end

#auto_connect_duration ⇒ Object 



355
356
357
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 355

def auto_connect_duration
  @@auto_connect_duration ||= 10
end

#cs_equality_operator ⇒ Object 



384
385
386
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 384

def cs_equality_operator
  @@cs_equality_operator || 'COLLATE Latin1_General_CS_AS_WS'
end

#disable_referential_integrity ⇒ Object 



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

def disable_referential_integrity
  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 



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

def disconnect!
  @spid = nil
  case @connection_options[:mode]
  when :dblib
    @connection.close rescue nil
  when :odbc
    @connection.disconnect rescue nil
  end
end

#inspect ⇒ Object 



347
348
349
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 347

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

#native_binary_database_type ⇒ Object 



380
381
382
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 380

def native_binary_database_type
  @@native_binary_database_type || 'varbinary(max)'
end

#native_date_database_type ⇒ Object 



376
377
378
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 376

def native_date_database_type
  sqlserver_2005? ? 'datetime' : 'date'
end

#native_string_database_type ⇒ Object 



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

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

#native_text_database_type ⇒ Object 



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

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

#native_time_database_type ⇒ Object 



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

def native_time_database_type
  sqlserver_2005? ? 'datetime' : 'time'
end

#pk_and_sequence_for(table_name) ⇒ Object

Abstract Adapter (Misc Support) =========================== #



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

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

#primary_key(table_name) ⇒ Object 



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

def primary_key(table_name)
  identity_column(table_name).try(:name) || schema_cache.columns[table_name].detect(&:is_primary?).try(:name)
end

#reconnect! ⇒ Object 



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

def reconnect!
  disconnect!
  connect
  active?
end

#reset! ⇒ Object 



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

def reset!
  remove_database_connections_and_rollback { }
end

#retry_deadlock_victim ⇒ Object Also known as: retry_deadlock_victim? 



359
360
361
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 359

def retry_deadlock_victim
  @@retry_deadlock_victim.is_a?(FalseClass) ? false : true
end

#sqlserver? ⇒ Boolean

SQLServer Specific (DB Reflection) ======================== #

Returns:

  • (Boolean) 


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

def sqlserver?
  true
end

#sqlserver_2005? ⇒ Boolean

Returns:

  • (Boolean) 


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

def sqlserver_2005?
  @database_year == 2005
end

#sqlserver_2008? ⇒ Boolean

Returns:

  • (Boolean) 


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

def sqlserver_2008?
  @database_year == 2008
end

#sqlserver_2011? ⇒ Boolean

Returns:

  • (Boolean) 


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

def sqlserver_2011?
  @database_year == 2011
end

#sqlserver_2012? ⇒ Boolean

Returns:

  • (Boolean) 


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

def sqlserver_2012?
  @database_year == 2012
end

#sqlserver_azure? ⇒ Boolean

Returns:

  • (Boolean) 


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

def sqlserver_azure?
  @sqlserver_azure
end

#supports_bulk_alter? ⇒ Boolean

Returns:

  • (Boolean) 


250
251
252
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 250

def supports_bulk_alter?
  false
end

#supports_count_distinct? ⇒ Boolean

Returns:

  • (Boolean) 


242
243
244
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 242

def supports_count_distinct?
  true
end

#supports_ddl_transactions? ⇒ Boolean

Returns:

  • (Boolean) 


246
247
248
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 246

def supports_ddl_transactions?
  true
end

#supports_explain? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_explain?
  true
end

#supports_index_sort_order? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_index_sort_order?
  true
end

#supports_migrations? ⇒ Boolean

Returns:

  • (Boolean) 


234
235
236
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 234

def supports_migrations?
  true
end

#supports_primary_key? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_primary_key?
  true
end

#supports_savepoints? ⇒ Boolean

Returns:

  • (Boolean) 


254
255
256
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 254

def supports_savepoints?
  true
end

#version ⇒ Object 



343
344
345
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 343

def version
  self.class::VERSION
end