Class: Exwiw::Adapter::MysqlAdapter

Inherits:
Base
  • Object
show all
Defined in:
lib/exwiw/adapter/mysql_adapter.rb

Instance Attribute Summary

Attributes inherited from Base

#connection_config

Instance Method Summary collapse

Methods inherited from Base

#commented_sql, #describe_query, #dumpable?, #initialize, #output_extension, #post_insert_sql, #query_comment_text, #schema_output_extension, #sql_query_comment, #supports_bulk_delete?, table_config_class, #to_copy_from_stdin, #validate_as_dump_target!

Constructor Details

This class inherits a constructor from Exwiw::Adapter::Base

Instance Method Details

#build_query(table, dump_target, table_by_name) ⇒ Object 



8
9
10
 
# File 'lib/exwiw/adapter/mysql_adapter.rb', line 8

def build_query(table, dump_target, table_by_name)
  Exwiw::QueryAstBuilder.run(table.name, table_by_name, dump_target, @logger)
end

#compile_ast(query_ast) ⇒ Object

Raises:

  • (NotImplementedError) 


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
200
201
202
 
# File 'lib/exwiw/adapter/mysql_adapter.rb', line 168

def compile_ast(query_ast)
  raise NotImplementedError unless query_ast.is_a?(Exwiw::QueryAst::Select)

  sql = "SELECT "
  sql += if query_ast.select_all
           "*"
         else
           query_ast.columns.map { |col| compile_column_name(query_ast, col) }.join(', ')
         end
  sql += " FROM #{query_ast.from_table_name}"

  query_ast.join_clauses.each do |join|
    sql += " JOIN #{join.join_table_name} ON #{join.base_table_name}.#{join.foreign_key} = #{join.join_table_name}.#{join.primary_key}"

    join.where_clauses.each do |where|
      compiled_where_condition = compile_where_condition(where, join.join_table_name)
      sql += " AND #{compiled_where_condition}"
    end

    # base_where_clauses is compiled against the joined-from table
    # (base_table_name), e.g. the type-column filter on a polymorphic
    # source table.
    join.base_where_clauses.each do |where|
      compiled_where_condition = compile_where_condition(where, join.base_table_name)
      sql += " AND #{compiled_where_condition}"
    end
  end

  if query_ast.where_clauses.any?
    sql += " WHERE "
    sql += query_ast.where_clauses.map { |where| compile_where_condition(where, query_ast.from_table_name) }.join(' AND ')
  end

  sql
end

#dump_schema(ordered_tables, output_path) ⇒ Object 



30
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/exwiw/adapter/mysql_adapter.rb', line 30

def dump_schema(ordered_tables, output_path)
  table_names = ordered_tables.map(&:name)
  if table_names.empty?
    File.write(output_path, "-- Auto-generated by exwiw. No tables in scope.\n")
    return
  end

  # The mysqldump binary is invoked directly (not via the mysql2/trilogy
  # driver), so point EXWIW_MYSQLDUMP at a specific binary when the one on
  # PATH is incompatible with the server — e.g. a MySQL 9.x client whose
  # mysqldump cannot load `mysql_native_password` ("plugin ... cannot be
  # loaded", exit 2) against a server still using that auth plugin.
  mysqldump_bin = ENV['EXWIW_MYSQLDUMP']
  mysqldump_bin = 'mysqldump' if mysqldump_bin.nil? || mysqldump_bin.empty?

  # MariaDB's mysqldump does not recognise the MySQL-specific
  # --set-gtid-purged flag and exits with code 7.
  gtid_flags = mariadb_mysqldump?(mysqldump_bin) ? [] : ['--set-gtid-purged=OFF']

  cmd = [
    mysqldump_bin,
    "--host=#{@connection_config.host}",
    "--port=#{@connection_config.port}",
    "--user=#{@connection_config.user}",
    '--no-data',
    '--skip-add-drop-table',
    '--skip-comments',
    '--skip-set-charset',
    '--no-tablespaces', # skip tablespace query that requires PROCESS privilege (unavailable on managed MySQL like RDS)
    *gtid_flags,
    '--compact',
    @connection_config.database_name,
    *table_names,
  ]
  env = { 'MYSQL_PWD' => @connection_config.password.to_s }

  @logger.debug("  Running #{mysqldump_bin} for #{table_names.size} table(s)...")
  stdout, stderr, status =
    begin
      Open3.capture3(env, *cmd)
    rescue Errno::ENOENT
      raise "Failed to run `#{mysqldump_bin}`. Ensure the mysql client is installed and on PATH, " \
            "or set EXWIW_MYSQLDUMP to a mysqldump binary."
    end
  unless status.success?
    if stderr.include?('command not found') || stderr.empty?
      raise "Failed to run `#{mysqldump_bin}`. Ensure the mysql client is installed and on PATH, " \
            "or set EXWIW_MYSQLDUMP to a mysqldump binary. stderr: #{stderr}"
    end
    raise "mysqldump failed (exit #{status.exitstatus}): #{stderr}"
  end

  idempotent = DdlPostprocessor.add_if_not_exists_to_create_table(stdout)

  File.open(output_path, 'w') do |file|
    file.puts("-- Auto-generated by exwiw via mysqldump. Idempotent CREATE TABLE statements for mysql.")
    file.write(idempotent)
  end
  @logger.info("  Wrote schema for #{table_names.size} table(s) to #{output_path}.")
end

#execute(query_ast) ⇒ Object 



12
13
14
15
16
17
 
# File 'lib/exwiw/adapter/mysql_adapter.rb', line 12

def execute(query_ast)
  sql = commented_sql(query_ast)

  @logger.debug("  Executing SQL: \n#{sql}")
  connection.query(sql).rows
end

#explain(query_ast) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
 
# File 'lib/exwiw/adapter/mysql_adapter.rb', line 19

def explain(query_ast)
  sql = commented_sql(query_ast)

  @logger.debug("  Executing EXPLAIN: \n#{sql}")
  result = connection.query("EXPLAIN #{sql}")
  result.rows.each_with_index.flat_map do |row, i|
    ["*************************** #{i + 1}. row ***************************"] +
      result.fields.zip(row).map { |k, v| "#{k}: #{v}" }
  end.join("\n")
end

#to_bulk_delete(select_query_ast, table) ⇒ Object

Raises:

  • (NotImplementedError) 


110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/exwiw/adapter/mysql_adapter.rb', line 110

def to_bulk_delete(select_query_ast, table)
  raise NotImplementedError unless select_query_ast.is_a?(Exwiw::QueryAst::Select)

  sql = "DELETE FROM #{select_query_ast.from_table_name}"

  if select_query_ast.join_clauses.empty?
    # Ignore filter option, because bulk delete is for cleaning before import,
    # so it should delete all records to avoid foreign key violation & data consistancy.
    compiled_where_conditions = select_query_ast.
      where_clauses.
      select { |where| where.is_a?(Exwiw::QueryAst::WhereClause) }.
      map do |where|
      compile_where_condition(where, select_query_ast.from_table_name)
    end

    if compiled_where_conditions.size > 0
      sql += "\nWHERE "
      sql += compiled_where_conditions.join(' AND ')
    end
    sql += ";"

    return sql
  end

  subquery_ast = Exwiw::QueryAst::Select.new
  first_join = select_query_ast.join_clauses.first.clone

  subquery_ast.from(first_join.join_table_name)
  primay_key_col = table.columns.find { |col| col.name == table.primary_key }
  subquery_ast.select([primay_key_col])
  select_query_ast.join_clauses[1..].each do |join|
    subquery_ast.join(join)
  end
  first_join.where_clauses.each do |where|
    # Ignore filter option, because bulk delete is for cleaning before import,
    # so it should delete all records to avoid foreign key violation & data consistancy.
    subquery_ast.where(where) if where.is_a?(Exwiw::QueryAst::WhereClause)
  end

  foreign_key = first_join.foreign_key
  subquery_sql = compile_ast(subquery_ast)
  sql += "\nWHERE #{select_query_ast.from_table_name}.#{foreign_key} IN (#{subquery_sql})"

  # first_join.base_where_clauses holds conditions on the outer
  # delete-target table (from_table_name), such as a polymorphic type
  # column. They are not part of the subquery, so add them to the outer
  # WHERE. This prevents deleting rows that belong to a different
  # polymorphic type.
  first_join.base_where_clauses.each do |where|
    next unless where.is_a?(Exwiw::QueryAst::WhereClause)

    sql += " AND #{compile_where_condition(where, select_query_ast.from_table_name)}"
  end
  sql += ";"

  sql
end

#to_bulk_insert(results, table) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/exwiw/adapter/mysql_adapter.rb', line 91

def to_bulk_insert(results, table)
  table_name = table.name

  value_list = results.map do |row|
    quoted_values = row.map do |value|
      escape_value(value)
    end
    "(" + quoted_values.join(', ') + ")"
  end
  values = value_list.join(",\n")

  if table.rails_managed?
    "INSERT INTO #{table_name} VALUES\n#{values};"
  else
    column_names = table.columns.map(&:name).join(', ')
    "INSERT INTO #{table_name} (#{column_names}) VALUES\n#{values};"
  end
end