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 



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

def affected_rows(raw_result)
  column_name = lowercase_schema_reflection ? 'affectedrows' : 'AffectedRows'
  raw_result.first[column_name]
end

#begin_db_transaction ⇒ Object 



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

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

#begin_isolated_db_transaction(isolation) ⇒ Object 



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

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:



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

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:



161
162
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
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 161

def build_sql_for_merge_insert(insert:, insert_all:, columns_with_uniqueness_constraints:) # :nodoc:
  sql = <<~SQL
    MERGE INTO #{insert.model.quoted_table_name} WITH (UPDLOCK, HOLDLOCK) AS target
    USING (
      SELECT *
      FROM (
        SELECT #{insert.send(:columns_list)}, #{partition_by_columns_with_uniqueness_constraints(columns_with_uniqueness_constraints:)}
        FROM (#{insert.values_list})
        AS t1 (#{insert.send(:columns_list)})
      ) AS ranked_source
      WHERE #{is_first_record_across_all_uniqueness_constraints(columns_with_uniqueness_constraints:)}
    ) AS source
    ON (#{joining_on_columns_with_uniqueness_constraints(columns_with_uniqueness_constraints:)})
  SQL

  if insert.update_duplicates?
    sql << " WHEN MATCHED THEN UPDATE SET "

    if insert.raw_update_sql?
      sql << insert.raw_update_sql
    else
      if insert.record_timestamps?
        sql << build_sql_for_recording_timestamps_when_updating(insert:)
      end

      sql << insert.updatable_columns.map { |column| "target.#{quote_column_name(column)}=source.#{quote_column_name(column)}" }.join(",")
    end
  end
  sql << " WHEN NOT MATCHED BY TARGET THEN"
  sql << " INSERT (#{insert.send(:columns_list)}) VALUES (#{insert_all.keys_including_timestamps.map { |column| "source.#{quote_column_name(column)}" }.join(", ")})"
  sql << build_sql_for_returning(insert:, insert_all: insert.send(:insert_all))
  sql << ";"

  sql
end

#case_sensitive_comparison(attribute, value) ⇒ Object 



97
98
99
100
101
102
103
104
105
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 97

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(raw_result) ⇒ Object 



33
34
35
36
37
38
39
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 33

def cast_result(raw_result)
  if raw_result.columns.empty?
    ActiveRecord::Result.empty
  else
    ActiveRecord::Result.new(raw_result.columns, raw_result.rows)
  end
end

#commit_db_transaction ⇒ Object 



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

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

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



62
63
64
65
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 62

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

#exec_rollback_db_transaction ⇒ Object 



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

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 



67
68
69
70
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 67

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

#execute_procedure(proc_name, *variables) ⇒ Object

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



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
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 199

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



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

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 



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

def internal_exec_sql_query(sql, conn)
  handle = internal_raw_execute(sql, conn)
  handle_to_names_and_values(handle, ar_result: true)
ensure
  finish_statement_handle(handle)
end

#newid_function ⇒ Object 



291
292
293
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 291

def newid_function
  select_value "SELECT NEWID()"
end

#newsequentialid_function ⇒ Object 



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

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
 
# 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:)
  result = if id_insert_table_name = query_requires_identity_insert?(sql)
             # If the table name is a view, we need to get the base table name for enabling identity insert.
             id_insert_table_name = view_table_name(id_insert_table_name) if view_exists?(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[:row_count] = result.count
  result
end

#raw_execute(sql, name = nil, binds = [], prepare: false, async: false, allow_retry: false, materialize_transactions: true, batch: false) ⇒ Object 



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

def raw_execute(sql, name = nil, binds = [], prepare: false, async: false, allow_retry: false, materialize_transactions: true, batch: false)
  unless binds.nil? || binds.empty?
    types, params = sp_executesql_types_and_parameters(binds)
    sql = sp_executesql_sql(sql, types, params, name)
  end

  super
end

#set_transaction_isolation_level(isolation_level) ⇒ Object 



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

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 



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

def transaction_isolation_levels
  super.merge snapshot: "SNAPSHOT"
end

#use_database(database = nil) ⇒ Object 



233
234
235
236
237
238
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 233

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 



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 240

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.reduce(HashWithIndifferentAccess.new) do |values, row|
    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
    values
  end
end

#user_options_dateformat ⇒ Object 



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

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

#user_options_isolation_level ⇒ Object 



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 266

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 



283
284
285
286
287
288
289
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 283

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 



225
226
227
228
229
230
231
 
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 225

def with_identity_insert_enabled(table_name, conn)
  table_name = quote_table_name(table_name)
  set_identity_insert(table_name, conn, true)
  yield
ensure
  set_identity_insert(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