Class | ActiveRecord::ConnectionAdapters::MysqlAdapter |
In: |
vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb
|
Parent: | AbstractAdapter |
The MySQL adapter will work with both Ruby/MySQL, which is a Ruby-based MySQL adapter that comes bundled with Active Record, and with the faster C-based MySQL/Ruby adapter (available both as a gem and from www.tmtm.org/en/mysql/ruby/).
Options:
ADAPTER_NAME | = | 'MySQL'.freeze |
LOST_CONNECTION_ERROR_MESSAGES | = | [ "Server shutdown in progress", "Broken pipe", "Lost connection to MySQL server during query", "MySQL server has gone away" ] |
QUOTED_FALSE | = | '1'.freeze, '0'.freeze |
NATIVE_DATABASE_TYPES | = | { :primary_key => "int(11) DEFAULT NULL auto_increment PRIMARY KEY".freeze, :string => { :name => "varchar", :limit => 255 }, :text => { :name => "text" }, :integer => { :name => "int", :limit => 4 }, :float => { :name => "float" }, :decimal => { :name => "decimal" }, :datetime => { :name => "datetime" }, :timestamp => { :name => "datetime" }, :time => { :name => "time" }, :date => { :name => "date" }, :binary => { :name => "blob" }, :boolean => { :name => "tinyint", :limit => 1 } |
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 201 201: def initialize(connection, logger, connection_options, config) 202: super(connection, logger) 203: @connection_options, @config = connection_options, config 204: @quoted_column_names, @quoted_table_names = {}, {} 205: connect 206: end
CONNECTION MANAGEMENT ====================================
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 277 277: def active? 278: if @connection.respond_to?(:stat) 279: @connection.stat 280: else 281: @connection.query 'select 1' 282: end 283: 284: # mysql-ruby doesn't raise an exception when stat fails. 285: if @connection.respond_to?(:errno) 286: @connection.errno.zero? 287: else 288: true 289: end 290: rescue Mysql::Error 291: false 292: end
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 568 568: def case_sensitive_equality_operator 569: "= BINARY" 570: end
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 490 490: def change_column_null(table_name, column_name, null, default = nil) 491: column = column_for(table_name, column_name) 492: 493: unless null || default.nil? 494: execute("UPDATE #{quote_table_name(table_name)} SET #{quote_column_name(column_name)}=#{quote(default)} WHERE #{quote_column_name(column_name)} IS NULL") 495: end 496: 497: change_column table_name, column_name, column.sql_type, :null => null 498: end
Returns the database character set.
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 430 430: def charset 431: show_variable 'character_set_database' 432: end
Create a new MySQL database with optional :charset and :collation. Charset defaults to utf8.
Example:
create_database 'charset_test', :charset => 'latin1', :collation => 'latin1_bin' create_database 'matt_development' create_database 'matt_development', :charset => :big5
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 413 413: def create_database(name, options = {}) 414: if options[:collation] 415: execute "CREATE DATABASE `#{name}` DEFAULT CHARACTER SET `#{options[:charset] || 'utf8'}` COLLATE `#{options[:collation]}`" 416: else 417: execute "CREATE DATABASE `#{name}` DEFAULT CHARACTER SET `#{options[:charset] || 'utf8'}`" 418: end 419: end
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 362 362: def create_savepoint 363: execute("SAVEPOINT #{current_savepoint_name}") 364: end
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 425 425: def current_database 426: select_value 'SELECT DATABASE() as db' 427: end
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 299 299: def disconnect! 300: @connection.close rescue nil 301: end
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 447 447: def drop_table(table_name, options = {}) 448: super(table_name, options) 449: end
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 572 572: def limited_update_conditions(where_sql, quoted_table_name, quoted_primary_key) 573: where_sql 574: end
Returns just a table‘s primary key
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 563 563: def primary_key(table) 564: pk_and_sequence = pk_and_sequence_for(table) 565: pk_and_sequence && pk_and_sequence.first 566: end
QUOTING ==================================================
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 231 231: def quote(value, column = nil) 232: if value.kind_of?(String) && column && column.type == :binary && column.class.respond_to?(:string_to_binary) 233: s = column.class.string_to_binary(value).unpack("H*")[0] 234: "x'#{s}'" 235: elsif value.kind_of?(BigDecimal) 236: value.to_s("F") 237: else 238: super 239: end 240: end
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 258 258: def quoted_false 259: QUOTED_FALSE 260: end
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 254 254: def quoted_true 255: QUOTED_TRUE 256: end
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 294 294: def reconnect! 295: disconnect! 296: connect 297: end
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 370 370: def release_savepoint 371: execute("RELEASE SAVEPOINT #{current_savepoint_name}") 372: end
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 481 481: def rename_table(table_name, new_name) 482: execute "RENAME TABLE #{quote_table_name(table_name)} TO #{quote_table_name(new_name)}" 483: end
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 303 303: def reset! 304: if @connection.respond_to?(:change_user) 305: # See http://bugs.mysql.com/bug.php?id=33540 -- the workaround way to 306: # reset the connection is to change the user to the same user. 307: @connection.change_user(@config[:username], @config[:password], @config[:database]) 308: configure_connection 309: end 310: end
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 366 366: def rollback_to_savepoint 367: execute("ROLLBACK TO SAVEPOINT #{current_savepoint_name}") 368: end
DATABASE STATEMENTS ======================================
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 314 314: def select_rows(sql, name = nil) 315: @connection.query_with_result = true 316: result = execute(sql, name) 317: rows = [] 318: result.each { |row| rows << row } 319: result.free 320: rows 321: end
SHOW VARIABLES LIKE ‘name‘
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 546 546: def show_variable(name) 547: variables = select_all("SHOW VARIABLES LIKE '#{name}'") 548: variables.first['Value'] unless variables.empty? 549: end
Maps logical Rails types to MySQL-specific data types.
# File vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 531 531: def type_to_sql(type, limit = nil, precision = nil, scale = nil) 532: return super unless type.to_s == 'integer' 533: 534: case limit 535: when 1; 'tinyint' 536: when 2; 'smallint' 537: when 3; 'mediumint' 538: when nil, 4, 11; 'int(11)' # compatibility with MySQL default 539: when 5..8; 'bigint' 540: else raise(ActiveRecordError, "No integer type has byte size #{limit}") 541: end 542: end