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::SchemaDumper, 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

#fetch_type_metadata, #quote_column_name, #quote_default_expression, #quote_string, #quote_string_single, #quote_string_single_national, #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_sensitive_comparison, #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_source_exists?, #drop_table, #extract_foreign_key_action, #foreign_keys, #indexes, #native_database_types, #new_column, #primary_keys, #remove_column, #remove_index!, #rename_column, #rename_index, #rename_table, #table_exists?, #tables, #type_to_sql, #update_table_definition, #view_exists?, #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 = nil, config = {}) ⇒ SQLServerAdapter

Returns a new instance of SQLServerAdapter.



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

def initialize(connection, logger = nil, config = {})
  super(connection, logger, config)
  # Our Responsibility
  @connection_options = config
  connect
  initialize_dateformatter
  use_database
end

Instance Attribute Details

#spid ⇒ Object (readonly)

Returns the value of attribute spid.



43
44
45
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 43

def spid
  @spid
end

Instance Method Details

#active? ⇒ Boolean

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

Returns:

  • (Boolean) 


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

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

#arel_visitor ⇒ Object

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



64
65
66
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 64

def arel_visitor
  Arel::Visitors::SQLServer.new self
end

#clear_cache! ⇒ Object 



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

def clear_cache!
  @view_information = nil
  super
end

#combine_bind_parameters(from_clause: [], join_clause: [], where_clause: [], having_clause: [], limit: nil, offset: nil) ⇒ Object 



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

def combine_bind_parameters(from_clause: [], join_clause: [], where_clause: [], having_clause: [], limit: nil, offset: nil)
  result = from_clause + join_clause + where_clause + having_clause
  result << offset if offset
  result << limit if limit
  result
end

#database_prefix ⇒ Object 



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

def database_prefix
  @connection_options[:database_prefix]
end

#database_prefix_remote_server? ⇒ Boolean

Returns:

  • (Boolean) 


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

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 



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

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 



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 172

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

#inspect ⇒ Object 



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

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

#pk_and_sequence_for(table_name) ⇒ Object 



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

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

#reconnect! ⇒ Object 



166
167
168
169
170
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 166

def reconnect!
  super
  disconnect!
  connect
end

#reset! ⇒ Object 



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

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

#schema_creation ⇒ Object 



72
73
74
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 72

def schema_creation
  SQLServer::SchemaCreation.new self
end

#sqlserver? ⇒ Boolean

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

Returns:

  • (Boolean) 


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

def sqlserver?
  true
end

#sqlserver_azure? ⇒ Boolean

Returns:

  • (Boolean) 


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

def sqlserver_azure?
  @sqlserver_azure ||= !!(select_value('SELECT @@version', 'SCHEMA') =~ /Azure/i)
end

#supports_advisory_locks? ⇒ Boolean

Returns:

  • (Boolean) 


92
93
94
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 92

def supports_advisory_locks?
  false
end

#supports_bulk_alter? ⇒ Boolean

Returns:

  • (Boolean) 


88
89
90
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 88

def supports_bulk_alter?
  false
end

#supports_comments? ⇒ Boolean

Returns:

  • (Boolean) 


136
137
138
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 136

def supports_comments?
  false
end

#supports_comments_in_create? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_comments_in_create?
  false
end

#supports_datetime_with_precision? ⇒ Boolean

Returns:

  • (Boolean) 


128
129
130
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 128

def supports_datetime_with_precision?
  true
end

#supports_ddl_transactions? ⇒ Boolean

Returns:

  • (Boolean) 


84
85
86
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 84

def supports_ddl_transactions?
  true
end

#supports_explain? ⇒ Boolean

Returns:

  • (Boolean) 


108
109
110
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 108

def supports_explain?
  true
end

#supports_expression_index? ⇒ Boolean

Returns:

  • (Boolean) 


104
105
106
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 104

def supports_expression_index?
  false
end

#supports_foreign_keys? ⇒ Boolean

Returns:

  • (Boolean) 


120
121
122
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 120

def supports_foreign_keys?
  true
end

#supports_in_memory_oltp? ⇒ Boolean

Returns:

  • (Boolean) 


144
145
146
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 144

def supports_in_memory_oltp?
  @version_year >= 2014
end

#supports_index_sort_order? ⇒ Boolean

Returns:

  • (Boolean) 


96
97
98
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 96

def supports_index_sort_order?
  true
end

#supports_indexes_in_create? ⇒ Boolean

Returns:

  • (Boolean) 


116
117
118
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 116

def supports_indexes_in_create?
  false
end

#supports_json? ⇒ Boolean

Returns:

  • (Boolean) 


132
133
134
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 132

def supports_json?
  @version_year >= 2016
end

#supports_migrations? ⇒ Boolean

Returns:

  • (Boolean) 


76
77
78
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 76

def supports_migrations?
  true
end

#supports_partial_index? ⇒ Boolean

Returns:

  • (Boolean) 


100
101
102
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 100

def supports_partial_index?
  true
end

#supports_primary_key? ⇒ Boolean

Returns:

  • (Boolean) 


80
81
82
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 80

def supports_primary_key?
  true
end

#supports_transaction_isolation? ⇒ Boolean

Returns:

  • (Boolean) 


112
113
114
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 112

def supports_transaction_isolation?
  true
end

#supports_views? ⇒ Boolean

Returns:

  • (Boolean) 


124
125
126
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 124

def supports_views?
  true
end

#tables_with_referential_integrity ⇒ Object

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



195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 195

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

Returns:

  • (Boolean) 


68
69
70
 
# File 'lib/active_record/connection_adapters/sqlserver_adapter.rb', line 68

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

#version ⇒ Object 



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

def version
  self.class::VERSION
end