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

#begin_db_transactionObject



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

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

#begin_isolated_db_transaction(isolation) ⇒ Object



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

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:



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 152

def build_insert_sql(insert) # :nodoc:
  sql = +"INSERT #{insert.into}"

  if returning = insert.send(:insert_all).returning
    returning_sql = if returning.is_a?(String)
                      returning
                    else
                      returning.map { |column| "INSERTED.#{quote_column_name(column)}" }.join(", ")
                    end
    sql << " OUTPUT #{returning_sql}"
  end

  sql << " #{insert.values_list}"
  sql
end

#case_sensitive_comparison(attribute, value) ⇒ Object



104
105
106
107
108
109
110
111
112
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 104

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

#commit_db_transactionObject



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

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

#exec_delete(sql, name, binds) ⇒ Object



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

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

#exec_rollback_db_transactionObject



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

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

#exec_update(sql, name, binds) ⇒ Object



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

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

#execute_procedure(proc_name, *variables) ⇒ Object

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



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

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



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 115

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_query(sql, name = "SQL", binds = [], prepare: false, async: false, allow_retry: false) ⇒ Object



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 31

def internal_exec_query(sql, name = "SQL", binds = [], prepare: false, async: false, allow_retry: false)
  sql = transform_query(sql)

  check_if_write_query(sql)
  mark_transaction_written_if_write(sql)

  unless without_prepared_statement?(binds)
    types, params = sp_executesql_types_and_parameters(binds)
    sql = sp_executesql_sql(sql, types, params, name)
  end

  log(sql, name, binds, async: async) do |notification_payload|
    with_raw_connection do |conn|
      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, conn) do
                   internal_exec_sql_query(sql, conn)
                 end
               else
                 internal_exec_sql_query(sql, conn)
               end

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

#internal_exec_sql_query(sql, conn) ⇒ Object



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

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_functionObject



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

def newid_function
  select_value "SELECT NEWID()"
end

#newsequentialid_functionObject



266
267
268
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 266

def newsequentialid_function
  select_value "SELECT NEWSEQUENTIALID()"
end

#raw_execute(sql, name, async: false, allow_retry: false, materialize_transactions: true) ⇒ Object



16
17
18
19
20
21
22
23
24
25
26
27
28
29
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 16

def raw_execute(sql, name, async: false, allow_retry: false, materialize_transactions: true)
  log(sql, name, async: async) do |notification_payload|
    with_raw_connection(allow_retry: allow_retry, materialize_transactions: materialize_transactions) do |conn|
      result = if id_insert_table_name = query_requires_identity_insert?(sql)
                 with_identity_insert_enabled(id_insert_table_name, conn) { internal_raw_execute(sql, conn, perform_do: true) }
               else
                 internal_raw_execute(sql, conn, perform_do: true)
               end
      verified!
      notification_payload[:row_count] = result
      result
    end
  end
end

#set_transaction_isolation_level(isolation_level) ⇒ Object



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

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_levelsObject



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

def transaction_isolation_levels
  super.merge snapshot: "SNAPSHOT"
end

#use_database(database = nil) ⇒ Object



204
205
206
207
208
209
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 204

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_optionsObject



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 211

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_dateformatObject



229
230
231
232
233
234
235
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 229

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_levelObject



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 237

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_languageObject



254
255
256
257
258
259
260
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 254

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



196
197
198
199
200
201
202
# File 'lib/active_record/connection_adapters/sqlserver/database_statements.rb', line 196

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