Class: ActiveRecord::ConnectionAdapters::Mysql2Adapter

Inherits:
AbstractMysqlAdapter show all
Includes:
ActiveRecord::ConnectionAdapters::Mysql2::DatabaseStatements
Defined in:
lib/active_record/connection_adapters/mysql2_adapter.rb

Overview

Active Record MySQL2 Adapter

Constant Summary collapse

ER_BAD_DB_ERROR = 
1049
ER_DBACCESS_DENIED_ERROR = 
1044
ER_ACCESS_DENIED_ERROR = 
1045
ER_CONN_HOST_ERROR = 
2003
ER_UNKNOWN_HOST_ERROR = 
2005
ADAPTER_NAME = 
"Mysql2"
TYPE_MAP = 
Type::TypeMap.new.tap { |m| initialize_type_map(m) }

Constants inherited from AbstractMysqlAdapter

AbstractMysqlAdapter::EMULATE_BOOLEANS_TRUE, AbstractMysqlAdapter::EXTENDED_TYPE_MAPS, AbstractMysqlAdapter::NATIVE_DATABASE_TYPES

Constants included from ActiveRecord::ConnectionAdapters::MySQL::Quoting

ActiveRecord::ConnectionAdapters::MySQL::Quoting::QUOTED_COLUMN_NAMES, ActiveRecord::ConnectionAdapters::MySQL::Quoting::QUOTED_TABLE_NAMES

Constants inherited from AbstractAdapter

AbstractAdapter::COMMENT_REGEX, AbstractAdapter::EXTENDED_TYPE_MAPS, AbstractAdapter::SIMPLE_INT

Constants included from QueryCache

QueryCache::DEFAULT_SIZE

Instance Attribute Summary

Attributes inherited from AbstractAdapter

#lock, #logger, #owner, #pool, #visitor

Attributes included from QueryCache

#query_cache, #query_cache_enabled

Attributes included from DatabaseStatements

#transaction_manager

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ActiveRecord::ConnectionAdapters::Mysql2::DatabaseStatements

#exec_delete, #internal_exec_query, #select_all

Methods inherited from AbstractMysqlAdapter

#add_index, #add_sql_comment!, #begin_db_transaction, #begin_isolated_db_transaction, #build_change_column_default_definition, #build_change_column_definition, #build_create_index_definition, #build_insert_sql, #case_sensitive_comparison, #change_column, #change_column_comment, #change_column_default, #change_column_null, #change_table_comment, #charset, #check_constraints, #check_version, #collation, #columns_for_distinct, #commit_db_transaction, #create_database, #current_database, dbconsole, #default_index_type?, #disable_referential_integrity, #drop_database, #drop_table, #empty_insert_statement_value, #emulate_booleans, #exec_restart_db_transaction, #exec_rollback_db_transaction, #execute_and_free, extended_type_map, #foreign_keys, #get_advisory_lock, #get_database_version, #index_algorithms, #mariadb?, #native_database_types, #primary_keys, #recreate_database, #release_advisory_lock, #rename_column, #rename_index, #rename_table, #show_variable, #strict_mode?, #supports_advisory_locks?, #supports_bulk_alter?, #supports_check_constraints?, #supports_common_table_expressions?, #supports_datetime_with_precision?, #supports_explain?, #supports_expression_index?, #supports_foreign_keys?, #supports_index_sort_order?, #supports_indexes_in_create?, #supports_insert_on_duplicate_skip?, #supports_insert_on_duplicate_update?, #supports_optimizer_hints?, #supports_restart_db_transaction?, #supports_transaction_isolation?, #supports_views?, #supports_virtual_columns?, #table_comment, #table_options

Methods included from ActiveRecord::ConnectionAdapters::MySQL::SchemaStatements

#create_schema_dumper, #create_table, #indexes, #internal_string_options_for_primary_key, #remove_column, #schema_creation, #table_alias_length, #type_to_sql, #update_table_definition

Methods included from ActiveRecord::ConnectionAdapters::MySQL::Quoting

#cast_bound_value, #column_name_matcher, #column_name_with_order_matcher, #quote_column_name, #quote_table_name, #quoted_binary, #quoted_date, #type_cast, #unquote_identifier, #unquoted_false, #unquoted_true

Methods included from ActiveRecord::ConnectionAdapters::MySQL::DatabaseStatements

#build_explain_clause, #explain, #high_precision_current_timestamp, #write_query?

Methods inherited from AbstractAdapter

#adapter_name, #add_enum_value, #advisory_locks_enabled?, #all_foreign_keys_valid?, #async_enabled?, #build_insert_sql, build_read_query_regexp, #case_insensitive_comparison, #case_sensitive_comparison, #check_all_foreign_keys_valid!, #check_if_write_query, #check_version, #clean!, #clear_cache!, #close, #connect!, #connection_class, #connection_retries, #create_enum, #database_exists?, database_exists?, #database_version, dbconsole, #default_index_type?, #default_timezone, #default_uniqueness_comparison, #disable_extension, #disable_referential_integrity, #drop_enum, #enable_extension, #expire, extended_type_map, #extensions, find_cmd_and_exec, #get_advisory_lock, #get_database_version, #index_algorithms, #internal_metadata, #lease, #lock_thread=, #migration_context, #migrations_paths, #prefetch_primary_key?, #prepared_statements?, #prepared_statements_disabled_cache, #preventing_writes?, #raw_connection, #reconnect!, register_class_with_precision, #release_advisory_lock, #rename_enum, #rename_enum_value, #replica?, #requires_reloading?, #retry_deadline, #return_value_after_insert?, #role, #schema_cache, #schema_migration, #schema_version, #seconds_idle, #shard, #steal!, #supports_advisory_locks?, #supports_bulk_alter?, #supports_check_constraints?, #supports_common_table_expressions?, #supports_concurrent_connections?, #supports_datetime_with_precision?, #supports_ddl_transactions?, #supports_deferrable_constraints?, #supports_exclusion_constraints?, #supports_explain?, #supports_expression_index?, #supports_extensions?, #supports_foreign_keys?, #supports_foreign_tables?, #supports_index_include?, #supports_index_sort_order?, #supports_indexes_in_create?, #supports_insert_conflict_target?, #supports_insert_on_duplicate_skip?, #supports_insert_on_duplicate_update?, #supports_insert_returning?, #supports_materialized_views?, #supports_nulls_not_distinct?, #supports_optimizer_hints?, #supports_partial_index?, #supports_partitioned_indexes?, #supports_restart_db_transaction?, #supports_transaction_isolation?, #supports_unique_constraints?, #supports_validate_constraints?, #supports_views?, #supports_virtual_columns?, #throw_away!, type_cast_config_to_boolean, type_cast_config_to_integer, #unprepared_statement, #use_metadata_table?, #valid_type?, validate_default_timezone, #verify!, #with_instrumenter

Methods included from Savepoints

#create_savepoint, #current_savepoint_name, #exec_rollback_to_savepoint, #release_savepoint

Methods included from QueryCache

#cache, #clear_query_cache, dirties_query_cache, #disable_query_cache!, #enable_query_cache!, included, #select_all, #uncached

Methods included from DatabaseLimits

#index_name_length, #max_identifier_length, #table_alias_length, #table_name_length

Methods included from Quoting

#cast_bound_value, #column_name_matcher, #column_name_with_order_matcher, #lookup_cast_type_from_column, #quote, #quote_bound_value, #quote_column_name, #quote_default_expression, #quote_table_name, #quote_table_name_for_assignment, #quoted_binary, #quoted_date, #quoted_false, #quoted_time, #quoted_true, #sanitize_as_sql_comment, #type_cast, #unquoted_false, #unquoted_true

Methods included from DatabaseStatements

#add_transaction_record, #begin_db_transaction, #begin_isolated_db_transaction, #cacheable_query, #commit_db_transaction, #default_sequence_name, #delete, #empty_insert_statement_value, #exec_delete, #exec_insert, #exec_insert_all, #exec_query, #exec_restart_db_transaction, #exec_rollback_db_transaction, #exec_update, #execute, #explain, #high_precision_current_timestamp, #insert, #insert_fixture, #insert_fixtures_set, #internal_exec_query, #mark_transaction_written_if_write, #query, #query_value, #query_values, #reset_sequence!, #reset_transaction, #restart_db_transaction, #rollback_db_transaction, #rollback_to_savepoint, #sanitize_limit, #select_all, #select_one, #select_rows, #select_value, #select_values, #to_sql, #transaction, #transaction_isolation_levels, #transaction_open?, #truncate, #truncate_tables, #update, #with_yaml_fallback, #write_query?

Methods included from SchemaStatements

#add_check_constraint, #add_column, #add_columns, #add_foreign_key, #add_index, #add_index_options, #add_reference, #add_timestamps, #assume_migrated_upto_version, #build_add_column_definition, #build_change_column_default_definition, #build_create_index_definition, #build_create_join_table_definition, #build_create_table_definition, #bulk_change_table, #change_column, #change_column_comment, #change_column_default, #change_column_null, #change_table, #change_table_comment, #check_constraint_exists?, #check_constraint_options, #check_constraints, #column_exists?, #columns, #columns_for_distinct, #create_join_table, #create_schema_dumper, #create_table, #data_source_exists?, #data_sources, #distinct_relation_for_primary_key, #drop_join_table, #drop_table, #dump_schema_information, #foreign_key_column_for, #foreign_key_exists?, #foreign_key_options, #foreign_keys, #index_algorithm, #index_exists?, #index_name, #index_name_exists?, #indexes, #internal_string_options_for_primary_key, #max_index_name_size, #native_database_types, #options_include_default?, #primary_key, #quoted_columns_for_index, #remove_check_constraint, #remove_column, #remove_columns, #remove_foreign_key, #remove_index, #remove_reference, #remove_timestamps, #rename_column, #rename_index, #rename_table, #schema_creation, #table_alias_for, #table_comment, #table_exists?, #table_options, #tables, #type_to_sql, #update_table_definition, #use_foreign_keys?, #valid_column_definition_options, #valid_primary_key_options, #valid_table_definition_options, #view_exists?, #views

Constructor Details

#initialize ⇒ Mysql2Adapter

Returns a new instance of Mysql2Adapter.



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/active_record/connection_adapters/mysql2_adapter.rb', line 66

def initialize(...)
  super

  @config[:flags] ||= 0

  if @config[:flags].kind_of? Array
    @config[:flags].push "FOUND_ROWS"
  else
    @config[:flags] |= ::Mysql2::Client::FOUND_ROWS
  end

  @connection_parameters ||= @config
end

Class Method Details

.new_client(config) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/active_record/connection_adapters/mysql2_adapter.rb', line 35

def new_client(config)
  ::Mysql2::Client.new(config)
rescue ::Mysql2::Error => error
  case error.error_number
  when ER_BAD_DB_ERROR
    raise ActiveRecord::NoDatabaseError.db_error(config[:database])
  when ER_DBACCESS_DENIED_ERROR, ER_ACCESS_DENIED_ERROR
    raise ActiveRecord::DatabaseConnectionError.username_error(config[:username])
  when ER_CONN_HOST_ERROR, ER_UNKNOWN_HOST_ERROR
    raise ActiveRecord::DatabaseConnectionError.hostname_error(config[:host])
  else
    raise ActiveRecord::ConnectionNotEstablished, error.message
  end
end

Instance Method Details

#active? ⇒ Boolean

– CONNECTION MANAGEMENT ==================================== ++

Returns:

  • (Boolean) 


133
134
135
 
# File 'lib/active_record/connection_adapters/mysql2_adapter.rb', line 133

def active?
  !(@raw_connection.nil? || @raw_connection.closed?) && @lock.synchronize { @raw_connection&.ping } || false
end

#discard! ⇒ Object

:nodoc:



149
150
151
152
153
154
155
 
# File 'lib/active_record/connection_adapters/mysql2_adapter.rb', line 149

def discard! # :nodoc:
  @lock.synchronize do
    super
    @raw_connection&.automatic_close = false
    @raw_connection = nil
  end
end

#disconnect! ⇒ Object

Disconnects from the database if already connected. Otherwise, this method does nothing.



141
142
143
144
145
146
147
 
# File 'lib/active_record/connection_adapters/mysql2_adapter.rb', line 141

def disconnect!
  @lock.synchronize do
    super
    @raw_connection&.close
    @raw_connection = nil
  end
end

#each_hash(result, &block) ⇒ Object

HELPER METHODS ===========================================



106
107
108
109
110
111
112
 
# File 'lib/active_record/connection_adapters/mysql2_adapter.rb', line 106

def each_hash(result, &block) # :nodoc:
  if block_given?
    result.each(as: :hash, symbolize_keys: true, &block)
  else
    to_enum(:each_hash, result)
  end
end

#error_number(exception) ⇒ Object 



114
115
116
 
# File 'lib/active_record/connection_adapters/mysql2_adapter.rb', line 114

def error_number(exception)
  exception.error_number if exception.respond_to?(:error_number)
end

#quote_string(string) ⇒ Object

Quotes strings for use in SQL input.



123
124
125
126
127
 
# File 'lib/active_record/connection_adapters/mysql2_adapter.rb', line 123

def quote_string(string)
  with_raw_connection(allow_retry: true, materialize_transactions: false) do |connection|
    connection.escape(string)
  end
end

#savepoint_errors_invalidate_transactions? ⇒ Boolean

Returns:

  • (Boolean) 


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

def savepoint_errors_invalidate_transactions?
  true
end

#supports_comments? ⇒ Boolean

Returns:

  • (Boolean) 


84
85
86
 
# File 'lib/active_record/connection_adapters/mysql2_adapter.rb', line 84

def supports_comments?
  true
end

#supports_comments_in_create? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_comments_in_create?
  true
end

#supports_json? ⇒ Boolean

Returns:

  • (Boolean) 


80
81
82
 
# File 'lib/active_record/connection_adapters/mysql2_adapter.rb', line 80

def supports_json?
  !mariadb? && database_version >= "5.7.8"
end

#supports_lazy_transactions? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_lazy_transactions?
  true
end

#supports_savepoints? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_savepoints?
  true
end