Module: ActiveRecord::ConnectionAdapters::SQLServer::DatabaseStatements

Included in:
ActiveRecord::ConnectionAdapters::SQLServerAdapter
Defined in:
lib/active_record/connection_adapters/sqlserver/database_statements.rb

Instance Method Summary collapse

Instance Method Details

#affected_rows(raw_result) ⇒ Object

Returns the affected rows from results.



46
47
48
49
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 46

def affected_rows(raw_result)
  column_name = lowercase_schema_reflection ? "affectedrows" : "AffectedRows"
  raw_result&.first&.fetch(column_name, nil)
end

#affected_rows_from_results_or_handle(raw_result, handle) ⇒ Object

Returns the affected rows from results or handle.



52
53
54
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 52

def affected_rows_from_results_or_handle(raw_result, handle)
  affected_rows(raw_result) || handle.affected_rows
end

#begin_db_transaction ⇒ Object 



75
76
77
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 75

def begin_db_transaction
  internal_execute("BEGIN TRANSACTION", "TRANSACTION", allow_retry: true, materialize_transactions: false)
end

#begin_isolated_db_transaction(isolation) ⇒ Object 



83
84
85
86
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 83

def begin_isolated_db_transaction(isolation)
  set_transaction_isolation_level(transaction_isolation_levels.fetch(isolation))
  begin_db_transaction
end

#build_insert_sql(insert) ⇒ Object

:nodoc:



148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 148

def build_insert_sql(insert) # :nodoc:
  # Use regular insert if not skipping/updating duplicates.
  return build_sql_for_regular_insert(insert:) unless insert.skip_duplicates? || insert.update_duplicates?

  insert_all = insert.send(:insert_all)
  columns_with_uniqueness_constraints = get_columns_with_uniqueness_constraints(insert_all:, insert:)

  # If we do not have any columns that might have conflicting values just execute a regular insert, else use merge.
  if columns_with_uniqueness_constraints.flatten.empty?
    build_sql_for_regular_insert(insert:)
  else
    build_sql_for_merge_insert(insert:, insert_all:, columns_with_uniqueness_constraints:)
  end
end

#build_sql_for_merge_insert(insert:, insert_all:, columns_with_uniqueness_constraints:) ⇒ Object

:nodoc:



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 163

def build_sql_for_merge_insert(insert:, insert_all:, columns_with_uniqueness_constraints:) # :nodoc:
  insert_all.inserts.reverse! if insert.update_duplicates?

  sql = "    MERGE INTO \#{insert.model.quoted_table_name} WITH (UPDLOCK, HOLDLOCK) AS target\n    USING (\n      SELECT *\n      FROM (\n        SELECT \#{insert.send(:columns_list)}, \#{partition_by_columns_with_uniqueness_constraints(columns_with_uniqueness_constraints:)}\n        FROM (\#{merge_insert_values_list(insert:, insert_all:)})\n        AS t1 (\#{insert.send(:columns_list)})\n      ) AS ranked_source\n      WHERE \#{is_first_record_across_all_uniqueness_constraints(columns_with_uniqueness_constraints:)}\n    ) AS source\n    ON (\#{joining_on_columns_with_uniqueness_constraints(columns_with_uniqueness_constraints:)})\n  SQL\n\n  if insert.update_duplicates?\n    sql << \" WHEN MATCHED THEN UPDATE SET \"\n\n    if insert.raw_update_sql?\n      sql << insert.raw_update_sql\n    else\n      if insert.record_timestamps?\n        sql << build_sql_for_recording_timestamps_when_updating(insert:)\n      end\n\n      sql << insert.updatable_columns.map { |column| \"target.\#{quote_column_name(column)}=source.\#{quote_column_name(column)}\" }.join(\",\")\n    end\n  end\n  sql << \" WHEN NOT MATCHED BY TARGET THEN\"\n  sql << \" INSERT (\#{insert.send(:columns_list)}) VALUES (\#{insert_all.keys_including_timestamps.map { |column| \"source.\#{quote_column_name(column)}\" }.join(\", \")})\"\n  sql << build_sql_for_returning(insert:, insert_all: insert.send(:insert_all))\n  sql << \";\"\n\n  sql\nend\n"

#case_sensitive_comparison(attribute, value) ⇒ Object 



100
101
102
103
104
105
106
107
108
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 100

def case_sensitive_comparison(attribute, value)
  column = column_for_attribute(attribute)

  if column.collation && !column.case_sensitive?
    attribute.eq(Arel::Nodes::Bin.new(value))
  else
    super
  end
end

#cast_result(result) ⇒ Object

Method ‘perform_query` already returns an `ActiveRecord::Result` so we have nothing to cast here. This is different to the MySQL/PostgreSQL adapters where the raw result is converted to `ActiveRecord::Result` in `cast_result`.



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

def cast_result(result)
  result
end

#commit_db_transaction ⇒ Object 



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

def commit_db_transaction
  internal_execute("COMMIT TRANSACTION", "TRANSACTION", allow_retry: false, materialize_transactions: true)
end

#exec_delete(sql, name = nil, binds = []) ⇒ Object 



65
66
67
68
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 65

def exec_delete(sql, name = nil, binds = [])
  sql = sql.dup << "; SELECT @@ROWCOUNT AS AffectedRows"
  super
end

#exec_rollback_db_transaction ⇒ Object 



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

def exec_rollback_db_transaction
  internal_execute("IF @@TRANCOUNT > 0 ROLLBACK TRANSACTION", "TRANSACTION", allow_retry: false, materialize_transactions: true)
end

#exec_update(sql, name = nil, binds = []) ⇒ Object 



70
71
72
73
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 70

def exec_update(sql, name = nil, binds = [])
  sql = sql.dup << "; SELECT @@ROWCOUNT AS AffectedRows"
  super
end

#execute_procedure(proc_name, *variables) ⇒ Object

SQLServer Specific ======================================== #



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 232

def execute_procedure(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 |notification_payload|
    with_raw_connection do |conn|
      result = internal_raw_execute(sql, conn)
      verified!
      options = {as: :hash, cache_rows: true, timezone: ActiveRecord.default_timezone || :utc}

      result.each(options) do |row|
        r = row.with_indifferent_access
        yield(r) if block_given?
      end

      result = result.each.map { |row| row.is_a?(Hash) ? row.with_indifferent_access : row }
      notification_payload[:row_count] = result.count
      result
    end
  end
end

#insert_fixtures_set(fixture_set, tables_to_delete = []) ⇒ Object

We should propose this change to Rails team



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 111

def insert_fixtures_set(fixture_set, tables_to_delete = [])
  fixture_inserts = []

  fixture_set.each do |table_name, fixtures|
    fixtures.each_slice(insert_rows_length) do |batch|
      fixture_inserts << build_fixture_sql(batch, table_name)
    end
  end

  table_deletes = tables_to_delete.map { |table| "DELETE FROM #{quote_table_name table}" }
  total_sqls = Array.wrap(table_deletes + fixture_inserts)

  disable_referential_integrity do
    transaction(requires_new: true) do
      total_sqls.each do |sql|
        execute sql, "Fixtures Load"
        yield if block_given?
      end
    end
  end
end

#internal_exec_sql_query(sql, conn) ⇒ Object 



56
57
58
59
60
61
62
63
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 56

def internal_exec_sql_query(sql, conn)
  handle = internal_raw_execute(sql, conn)
  results = handle_to_names_and_values(handle, ar_result: true)

  [results, affected_rows_from_results_or_handle(results, handle)]
ensure
  finish_statement_handle(handle)
end

#merge_insert_values_list(insert:, insert_all:) ⇒ Object

For ‘nil` identity columns we need to ensure that the values do not match so that they are all inserted. Method is a combination of `ActiveRecord::InsertAll#values_list` and `ActiveRecord::ConnectionAdapters::SQLServer::DatabaseStatements#default_insert_value`.



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 203

def merge_insert_values_list(insert:, insert_all:)
  connection = insert.send(:connection)
  identity_index = 0

  types = insert.send(:extract_types_for, insert.keys_including_timestamps)

  values_list = insert_all.map_key_with_value do |key, value|
    if Arel::Nodes::SqlLiteral === value
      value
    elsif insert.primary_keys.include?(key) && value.nil?
      column = insert.model.columns_hash[key]

      if column.is_identity?
        identity_index += 1
        table_name = quote(quote_table_name(column.table_name))
        Arel.sql("IDENT_CURRENT(#{table_name}) + (IDENT_INCR(#{table_name}) * #{identity_index})")
      else
        connection.default_insert_value(column)
      end
    else
      ActiveModel::Type::SerializeCastValue.serialize(type = types[key], type.cast(value))
    end
  end

  connection.visitor.compile(Arel::Nodes::ValuesList.new(values_list))
end

#newid_function ⇒ Object 



326
327
328
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 326

def newid_function
  select_value "SELECT NEWID()"
end

#newsequentialid_function ⇒ Object 



330
331
332
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 330

def newsequentialid_function
  select_value "SELECT NEWSEQUENTIALID()"
end

#perform_query(raw_connection, sql, binds, type_casted_binds, prepare:, notification_payload:, batch:) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 16

def perform_query(raw_connection, sql, binds, type_casted_binds, prepare:, notification_payload:, batch:)
  unless binds.nil? || binds.empty?
    types, params = sp_executesql_types_and_parameters(binds)
    sql = sp_executesql_sql(sql, types, params, notification_payload[:name])
  end

  id_insert_table_name = query_requires_identity_insert?(sql)

  result, affected_rows = if id_insert_table_name
    with_identity_insert_enabled(id_insert_table_name, raw_connection) do
      internal_exec_sql_query(sql, raw_connection)
    end
  else
    internal_exec_sql_query(sql, raw_connection)
  end

  verified!
  notification_payload[:affected_rows] = affected_rows
  notification_payload[:row_count] = result.count
  result
end

#set_transaction_isolation_level(isolation_level) ⇒ Object 



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

def set_transaction_isolation_level(isolation_level)
  internal_execute("SET TRANSACTION ISOLATION LEVEL #{isolation_level}", "TRANSACTION", allow_retry: true, materialize_transactions: false)
end

#transaction_isolation_levels ⇒ Object 



79
80
81
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 79

def transaction_isolation_levels
  super.merge snapshot: "SNAPSHOT"
end

#use_database(database = nil) ⇒ Object 



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

def use_database(database = nil)
  return if sqlserver_azure?

  name = SQLServer::Utils.extract_identifiers(database || @connection_parameters[:database]).quoted
  execute("USE #{name}", "SCHEMA") unless name.blank?
end

#user_options ⇒ Object 



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 276

def user_options
  return {} if sqlserver_azure?

  rows = select_rows("DBCC USEROPTIONS WITH NO_INFOMSGS", "SCHEMA")
  rows = rows.first if rows.size == 2 && rows.last.empty?
  rows.each_with_object(HashWithIndifferentAccess.new) do |row, values|
    if row.instance_of? Hash
      set_option = row.values[0].gsub(/\s+/, "_")
      user_value = row.values[1]
    elsif row.instance_of? Array
      set_option = row[0].gsub(/\s+/, "_")
      user_value = row[1]
    end
    values[set_option] = user_value
  end
end

#user_options_dateformat ⇒ Object 



293
294
295
296
297
298
299
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 293

def user_options_dateformat
  if sqlserver_azure?
    select_value "SELECT [dateformat] FROM [sys].[syslanguages] WHERE [name] = @@LANGUAGE", "SCHEMA"
  else
    user_options["dateformat"]
  end
end

#user_options_isolation_level ⇒ Object 



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 301

def user_options_isolation_level
  if sqlserver_azure?
    sql = %(SELECT CASE [transaction_isolation_level]
            WHEN 0 THEN NULL
            WHEN 1 THEN 'READ UNCOMMITTED'
            WHEN 2 THEN 'READ COMMITTED'
            WHEN 3 THEN 'REPEATABLE READ'
            WHEN 4 THEN 'SERIALIZABLE'
            WHEN 5 THEN 'SNAPSHOT' END AS [isolation_level]
            FROM [sys].[dm_exec_sessions]
            WHERE [session_id] = @@SPID).squish
    select_value sql, "SCHEMA"
  else
    user_options["isolation_level"]
  end
end

#user_options_language ⇒ Object 



318
319
320
321
322
323
324
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 318

def user_options_language
  if sqlserver_azure?
    select_value "SELECT @@LANGUAGE AS [language]", "SCHEMA"
  else
    user_options["language"]
  end
end

#with_identity_insert_enabled(table_name, conn) ⇒ Object 



258
259
260
261
262
263
264
265
266
267
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 258

def with_identity_insert_enabled(table_name, conn)
  # If the table name is a view, we need to get the base table name for enabling identity insert.
  table_name = view_table_name(table_name) if view_exists?(table_name)
  quoted_table_name = quote_table_name(table_name)

  set_identity_insert(quoted_table_name, conn, true)
  yield
ensure
  set_identity_insert(quoted_table_name, conn, false)
end

#write_query?(sql) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


10
11
12
13
14
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 10

def write_query?(sql) # :nodoc:
  !READ_QUERY.match?(sql)
rescue ArgumentError # Invalid encoding
  !READ_QUERY.match?(sql.b)
end