Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clean up shared DB statements code between Mysql2 and Trilogy #48112

Merged
merged 2 commits into from May 3, 2023
+208 −271
Merged

Clean up shared DB statements code between Mysql2 and Trilogy #48112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93b5fc1
Rename MySQL::DatabaseStatements => Mysql2::DatabaseStatements
adrianna-chang-shopify May 2, 2023
630ddc7
Move shared database logic to MySQL::DatabaseStatements
adrianna-chang-shopify May 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb
View file
Open in desktop
Expand Up @@ -3,6 +3,7 @@
require "active_record/connection_adapters/abstract_adapter"
require "active_record/connection_adapters/statement_pool"
require "active_record/connection_adapters/mysql/column"
require "active_record/connection_adapters/mysql/database_statements"
require "active_record/connection_adapters/mysql/explain_pretty_printer"
require "active_record/connection_adapters/mysql/quoting"
require "active_record/connection_adapters/mysql/schema_creation"
Expand All @@ -14,6 +15,7 @@
module ActiveRecord
module ConnectionAdapters
class AbstractMysqlAdapter < AbstractAdapter
include MySQL::DatabaseStatements
include MySQL::Quoting
include MySQL::SchemaStatements

Expand Down
164 changes: 13 additions & 151 deletions activerecord/lib/active_record/connection_adapters/mysql/database_statements.rb
View file
Open in desktop
Expand Up @@ -4,31 +4,26 @@ module ActiveRecord
module ConnectionAdapters
module MySQL
module DatabaseStatements
# Returns an ActiveRecord::Result instance.
def select_all(*, **) # :nodoc:
result = nil
with_raw_connection do |conn|
result = if ExplainRegistry.collect? && prepared_statements
unprepared_statement { super }
else
super
end
conn.abandon_results!
end
result
end

READ_QUERY = ActiveRecord::ConnectionAdapters::AbstractAdapter.build_read_query_regexp(
READ_QUERY = AbstractAdapter.build_read_query_regexp(
:desc, :describe, :set, :show, :use
) # :nodoc:
private_constant :READ_QUERY

# https://dev.mysql.com/doc/refman/5.7/en/date-and-time-functions.html#function_current-timestamp
# https://dev.mysql.com/doc/refman/5.7/en/date-and-time-type-syntax.html
HIGH_PRECISION_CURRENT_TIMESTAMP = Arel.sql("CURRENT_TIMESTAMP(6)").freeze # :nodoc:
private_constant :HIGH_PRECISION_CURRENT_TIMESTAMP

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

def high_precision_current_timestamp
HIGH_PRECISION_CURRENT_TIMESTAMP
end

def explain(arel, binds = [], options = [])
sql = build_explain_clause(options) + " " + to_sql(arel, binds)
start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
Expand All @@ -38,47 +33,6 @@ def explain(arel, binds = [], options = [])
MySQL::ExplainPrettyPrinter.new.pp(result, elapsed)
end

def internal_exec_query(sql, name = "SQL", binds = [], prepare: false, async: false) # :nodoc:
if without_prepared_statement?(binds)
execute_and_free(sql, name, async: async) do |result|
if result
build_result(columns: result.fields, rows: result.to_a)
else
build_result(columns: [], rows: [])
end
end
else
exec_stmt_and_free(sql, name, binds, cache_stmt: prepare, async: async) do |_, result|
if result
build_result(columns: result.fields, rows: result.to_a)
else
build_result(columns: [], rows: [])
end
end
end
end

def exec_delete(sql, name = nil, binds = []) # :nodoc:
if without_prepared_statement?(binds)
with_raw_connection do |conn|
@affected_rows_before_warnings = nil
execute_and_free(sql, name) { @affected_rows_before_warnings || conn.affected_rows }
end
else
exec_stmt_and_free(sql, name, binds) { |stmt| stmt.affected_rows }
end
end
alias :exec_update :exec_delete

# https://dev.mysql.com/doc/refman/5.7/en/date-and-time-functions.html#function_current-timestamp
# https://dev.mysql.com/doc/refman/5.7/en/date-and-time-type-syntax.html
HIGH_PRECISION_CURRENT_TIMESTAMP = Arel.sql("CURRENT_TIMESTAMP(6)").freeze # :nodoc:
private_constant :HIGH_PRECISION_CURRENT_TIMESTAMP

def high_precision_current_timestamp
HIGH_PRECISION_CURRENT_TIMESTAMP
end

def build_explain_clause(options = [])
return "EXPLAIN" if options.empty?

Expand All @@ -92,52 +46,15 @@ def build_explain_clause(options = [])
end

private
def sync_timezone_changes(raw_connection)
raw_connection.query_options[:database_timezone] = default_timezone
end

def execute_batch(statements, name = nil)
statements = statements.map { |sql| transform_query(sql) }
combine_multi_statements(statements).each do |statement|
with_raw_connection do |conn|
raw_execute(statement, name)
conn.abandon_results!
end
end
# https://mariadb.com/kb/en/analyze-statement/
def analyze_without_explain?
mariadb? && database_version >= "10.1.0"
end

def default_insert_value(column)
super unless column.auto_increment?
end

def last_inserted_id(result)
@raw_connection&.last_id
end

def multi_statements_enabled?
flags = @config[:flags]

if flags.is_a?(Array)
flags.include?("MULTI_STATEMENTS")
else
flags.anybits?(Mysql2::Client::MULTI_STATEMENTS)
end
end

def with_multi_statements
if multi_statements_enabled?
return yield
end

with_raw_connection do |conn|
conn.set_server_option(Mysql2::Client::OPTION_MULTI_STATEMENTS_ON)

yield
ensure
conn.set_server_option(Mysql2::Client::OPTION_MULTI_STATEMENTS_OFF)
end
end

def combine_multi_statements(total_sql)
total_sql.each_with_object([]) do |sql, total_sql_chunks|
previous_packet = total_sql_chunks.last
Expand All @@ -164,61 +81,6 @@ def max_allowed_packet_reached?(current_packet, previous_packet)
def max_allowed_packet
@max_allowed_packet ||= show_variable("max_allowed_packet")
end

def raw_execute(sql, name, async: false, allow_retry: false, materialize_transactions: true)
log(sql, name, async: async) do
with_raw_connection(allow_retry: allow_retry, materialize_transactions: materialize_transactions) do |conn|
sync_timezone_changes(conn)
result = conn.query(sql)
handle_warnings(sql)
result
end
end
end

def exec_stmt_and_free(sql, name, binds, cache_stmt: false, async: false)
sql = transform_query(sql)
check_if_write_query(sql)

mark_transaction_written_if_write(sql)

type_casted_binds = type_casted_binds(binds)

log(sql, name, binds, type_casted_binds, async: async) do
with_raw_connection do |conn|
sync_timezone_changes(conn)

if cache_stmt
stmt = @statements[sql] ||= conn.prepare(sql)
else
stmt = conn.prepare(sql)
end

begin
result = ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
stmt.execute(*type_casted_binds)
end
rescue Mysql2::Error => e
if cache_stmt
@statements.delete(sql)
else
stmt.close
end
raise e
end

ret = yield stmt, result
result.free if result
stmt.close unless cache_stmt
ret
end
end
end

# https://mariadb.com/kb/en/analyze-statement/
def analyze_without_explain?
mariadb? && database_version >= "10.1.0"
end
end
end
end
Expand Down
148 changes: 148 additions & 0 deletions activerecord/lib/active_record/connection_adapters/mysql2/database_statements.rb
View file
Open in desktop
@@ -0,0 +1,148 @@
# frozen_string_literal: true

module ActiveRecord
module ConnectionAdapters
module Mysql2
module DatabaseStatements
# Returns an ActiveRecord::Result instance.
def select_all(*, **) # :nodoc:
result = nil
with_raw_connection do |conn|
result = if ExplainRegistry.collect? && prepared_statements
unprepared_statement { super }
else
super
end
conn.abandon_results!
end
result
end

def internal_exec_query(sql, name = "SQL", binds = [], prepare: false, async: false) # :nodoc:
if without_prepared_statement?(binds)
execute_and_free(sql, name, async: async) do |result|
if result
build_result(columns: result.fields, rows: result.to_a)
else
build_result(columns: [], rows: [])
end
end
else
exec_stmt_and_free(sql, name, binds, cache_stmt: prepare, async: async) do |_, result|
if result
build_result(columns: result.fields, rows: result.to_a)
else
build_result(columns: [], rows: [])
end
end
end
end

def exec_delete(sql, name = nil, binds = []) # :nodoc:
if without_prepared_statement?(binds)
with_raw_connection do |conn|
@affected_rows_before_warnings = nil
execute_and_free(sql, name) { @affected_rows_before_warnings || conn.affected_rows }
end
else
exec_stmt_and_free(sql, name, binds) { |stmt| stmt.affected_rows }
end
end
alias :exec_update :exec_delete

private
def sync_timezone_changes(raw_connection)
raw_connection.query_options[:database_timezone] = default_timezone
end

def execute_batch(statements, name = nil)
statements = statements.map { |sql| transform_query(sql) }
combine_multi_statements(statements).each do |statement|
with_raw_connection do |conn|
raw_execute(statement, name)
conn.abandon_results!
end
end
end

def last_inserted_id(result)
@raw_connection&.last_id
end

def multi_statements_enabled?
flags = @config[:flags]

if flags.is_a?(Array)
flags.include?("MULTI_STATEMENTS")
else
flags.anybits?(::Mysql2::Client::MULTI_STATEMENTS)
end
end

def with_multi_statements
if multi_statements_enabled?
return yield
end

with_raw_connection do |conn|
conn.set_server_option(::Mysql2::Client::OPTION_MULTI_STATEMENTS_ON)

yield
ensure
conn.set_server_option(::Mysql2::Client::OPTION_MULTI_STATEMENTS_OFF)
end
end

def raw_execute(sql, name, async: false, allow_retry: false, materialize_transactions: true)
log(sql, name, async: async) do
with_raw_connection(allow_retry: allow_retry, materialize_transactions: materialize_transactions) do |conn|
sync_timezone_changes(conn)
result = conn.query(sql)
handle_warnings(sql)
result
end
end
end

def exec_stmt_and_free(sql, name, binds, cache_stmt: false, async: false)
sql = transform_query(sql)
check_if_write_query(sql)

mark_transaction_written_if_write(sql)

type_casted_binds = type_casted_binds(binds)

log(sql, name, binds, type_casted_binds, async: async) do
with_raw_connection do |conn|
sync_timezone_changes(conn)

if cache_stmt
stmt = @statements[sql] ||= conn.prepare(sql)
else
stmt = conn.prepare(sql)
end

begin
result = ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
stmt.execute(*type_casted_binds)
end
rescue Mysql2::Error => e
if cache_stmt
@statements.delete(sql)
else
stmt.close
end
raise e
end

ret = yield stmt, result
result.free if result
stmt.close unless cache_stmt
ret
end
end
end
end
end
end
end