Class: ActiveRecord::ConnectionAdapters::SQLServerAdapter

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

Constant Summary collapse

ADAPTER_NAME = 
'SQLServer'.freeze

Constants included from ActiveRecord::ConnectionAdapters::SQLServer::Version

ActiveRecord::ConnectionAdapters::SQLServer::Version::VERSION

Constants included from ActiveRecord::ConnectionAdapters::SQLServer::Quoting

ActiveRecord::ConnectionAdapters::SQLServer::Quoting::QUOTED_FALSE, ActiveRecord::ConnectionAdapters::SQLServer::Quoting::QUOTED_STRING_PREFIX, ActiveRecord::ConnectionAdapters::SQLServer::Quoting::QUOTED_TRUE

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ActiveRecord::ConnectionAdapters::SQLServer::Quoting

#quote_column_name, #quote_default_value, #quote_string, #quoted_date, #quoted_false, #quoted_true, #unquoted_false, #unquoted_true

Methods included from ActiveRecord::ConnectionAdapters::SQLServer::DatabaseStatements

#begin_db_transaction, #begin_isolated_db_transaction, #case_insensitive_comparison, #case_sensitive_comparison, #case_sensitive_modifier, #commit_db_transaction, #create_savepoint, #exec_delete, #exec_insert, #exec_query, #exec_rollback_db_transaction, #exec_rollback_to_savepoint, #exec_update, #execute, #execute_procedure, #newid_function, #newsequentialid_function, #release_savepoint, #select_rows, #set_transaction_isolation_level, #supports_statement_cache?, #transaction_isolation_levels, #use_database, #user_options, #user_options_dateformat, #user_options_isolation_level, #user_options_language, #with_identity_insert_enabled

Methods included from ActiveRecord::ConnectionAdapters::SQLServer::Showplan

#explain

Methods included from ActiveRecord::ConnectionAdapters::SQLServer::SchemaStatements

#change_column, #change_column_default, #change_column_null, #columns, #columns_for_distinct, #create_table, #data_sources, #extract_foreign_key_action, #foreign_keys, #indexes, #native_database_types, #new_column, #remove_column, #remove_index!, #rename_column, #rename_index, #rename_table, #table_exists?, #tables, #type_to_sql, #views

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::DatabaseTasks

#charset, #collation, #create_database, #current_database, #drop_database

Constructor Details

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

Returns a new instance of SQLServerAdapter.



50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 50

def initialize(connection, logger, pool, config)
  super(connection, logger, pool)
  # AbstractAdapter Responsibility
  @schema_cache = SQLServer::SchemaCache.new self
  @visitor = Arel::Visitors::SQLServer.new self
  @prepared_statements = true
  # Our Responsibility
  @connection_options = config
  connect
  @sqlserver_azure = !!(select_value('SELECT @@version', 'SCHEMA') =~ /Azure/i)
  initialize_dateformatter
  use_database
end

Instance Attribute Details

#spid ⇒ Object (readonly)

Returns the value of attribute spid.



41
42
43
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 41

def spid
  @spid
end

Instance Method Details

#active? ⇒ Boolean

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

Returns:

  • (Boolean) 


132
133
134
135
136
137
138
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 132

def active?
  return false unless @connection
  raw_connection_do 'SELECT 1'
  true
rescue *connection_errors
  false
end

#adapter_name ⇒ Object 



74
75
76
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 74

def adapter_name
  ADAPTER_NAME
end

#database_prefix ⇒ Object 



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

def database_prefix
  @connection_options[:database_prefix]
end

#database_prefix_remote_server? ⇒ Boolean

Returns:

  • (Boolean) 


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

def database_prefix_remote_server?
  return false if database_prefix.blank?
  name = SQLServer::Utils.extract_identifiers(database_prefix)
  name.fully_qualified? && name.object.blank?
end

#disable_referential_integrity ⇒ Object 



122
123
124
125
126
127
128
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 122

def disable_referential_integrity
  tables = tables_with_referential_integrity
  tables.each { |t| do_execute "ALTER TABLE #{t} NOCHECK CONSTRAINT ALL" }
  yield
ensure
  tables.each { |t| do_execute "ALTER TABLE #{t} CHECK CONSTRAINT ALL" }
end

#disconnect! ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 146

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

#inspect ⇒ Object 



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

def inspect
  "#<#{self.class} version: #{version}, mode: #{@connection_options[:mode]}, azure: #{sqlserver_azure?.inspect}>"
end

#pk_and_sequence_for(table_name) ⇒ Object 



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

def pk_and_sequence_for(table_name)
  pk = primary_key(table_name)
  pk ? [pk, nil] : nil
end

#primary_key(table_name) ⇒ Object 



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

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

#reconnect! ⇒ Object 



140
141
142
143
144
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 140

def reconnect!
  super
  disconnect!
  connect
end

#reset! ⇒ Object 



158
159
160
161
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 158

def reset!
  reset_transaction
  do_execute 'IF @@TRANCOUNT > 0 ROLLBACK TRANSACTION'
end

#schema_creation ⇒ Object 



70
71
72
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 70

def schema_creation
  SQLServer::SchemaCreation.new self
end

#sqlserver? ⇒ Boolean

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

Returns:

  • (Boolean) 


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

def sqlserver?
  true
end

#sqlserver_azure? ⇒ Boolean

Returns:

  • (Boolean) 


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

def sqlserver_azure?
  @sqlserver_azure
end

#supports_bulk_alter? ⇒ Boolean

Returns:

  • (Boolean) 


94
95
96
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 94

def supports_bulk_alter?
  false
end

#supports_count_distinct? ⇒ Boolean

Returns:

  • (Boolean) 


86
87
88
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 86

def supports_count_distinct?
  true
end

#supports_ddl_transactions? ⇒ Boolean

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 90

def supports_ddl_transactions?
  true
end

#supports_explain? ⇒ Boolean

Returns:

  • (Boolean) 


106
107
108
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 106

def supports_explain?
  true
end

#supports_foreign_keys? ⇒ Boolean

Returns:

  • (Boolean) 


118
119
120
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 118

def supports_foreign_keys?
  true
end

#supports_index_sort_order? ⇒ Boolean

Returns:

  • (Boolean) 


98
99
100
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 98

def supports_index_sort_order?
  true
end

#supports_migrations? ⇒ Boolean

Returns:

  • (Boolean) 


78
79
80
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 78

def supports_migrations?
  true
end

#supports_partial_index? ⇒ Boolean

Returns:

  • (Boolean) 


102
103
104
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 102

def supports_partial_index?
  true
end

#supports_primary_key? ⇒ Boolean

Returns:

  • (Boolean) 


82
83
84
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 82

def supports_primary_key?
  true
end

#supports_transaction_isolation? ⇒ Boolean

Returns:

  • (Boolean) 


110
111
112
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 110

def supports_transaction_isolation?
  true
end

#supports_views? ⇒ Boolean

Returns:

  • (Boolean) 


114
115
116
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 114

def supports_views?
  true
end

#tables_with_referential_integrity ⇒ Object

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



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

def tables_with_referential_integrity
  schemas_and_tables = select_rows <<-SQL.strip_heredoc
    SELECT s.name, o.name
    FROM sys.foreign_keys i
    INNER JOIN sys.objects o ON i.parent_object_id = o.OBJECT_ID
    INNER JOIN sys.schemas s ON o.schema_id = s.schema_id
  SQL
  schemas_and_tables.map do |schema_table|
    schema, table = schema_table
    "#{SQLServer::Utils.quoted_raw(schema)}.#{SQLServer::Utils.quoted_raw(table)}"
  end
end

#valid_type?(type) ⇒ Boolean

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

Returns:

  • (Boolean) 


66
67
68
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 66

def valid_type?(type)
  !native_database_types[type].nil?
end

#version ⇒ Object 



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

def version
  self.class::VERSION
end