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:
- :host - Defaults to "localhost".
- :port - Defaults to 3306.
- :socket - Defaults to "/tmp/mysql.sock".
- :username - Defaults to "root"
- :password - Defaults to nothing.
- :database - The name of the database. No default, must be provided.
- :encoding - (Optional) Sets the client encoding by executing "SET NAMES <encoding>" after connection.
- :reconnect - Defaults to false (See MySQL documentation: dev.mysql.com/doc/refman/5.0/en/auto-reconnect.html).
- :sslca - Necessary to use MySQL with an SSL connection.
- :sslkey - Necessary to use MySQL with an SSL connection.
- :sslcert - Necessary to use MySQL with an SSL connection.
- :sslcapath - Necessary to use MySQL with an SSL connection.
- :sslcipher - Necessary to use MySQL with an SSL connection.
- active?
- add_column
- add_column_position!
- case_sensitive_equality_operator
- change_column_null
- charset
- collation
- create_database
- create_savepoint
- current_database
- disconnect!
- drop_table
- limited_update_conditions
- new
- primary_key
- quote
- quoted_columns_for_index
- quoted_false
- quoted_true
- reconnect!
- release_savepoint
- rename_table
- reset!
- rollback_to_savepoint
- select_rows
- show_variable
- type_to_sql
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 } |
[ show source ]
# File 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 ====================================
[ show source ]
# File 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
[ show source ]
# File activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 486 486: def add_column(table_name, column_name, type, options = {}) 487: add_column_sql = "ALTER TABLE #{quote_table_name(table_name)} ADD #{quote_column_name(column_name)} #{type_to_sql(type, options[:limit], options[:precision], options[:scale])}" 488: add_column_options!(add_column_sql, options) 489: add_column_position!(add_column_sql, options) 490: execute(add_column_sql) 491: end
[ show source ]
# File activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 553 553: def add_column_position!(sql, options) 554: if options[:first] 555: sql << " FIRST" 556: elsif options[:after] 557: sql << " AFTER #{quote_column_name(options[:after])}" 558: end 559: end
[ show source ]
# File activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 584 584: def case_sensitive_equality_operator 585: "= BINARY" 586: end
[ show source ]
# File activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 498 498: def change_column_null(table_name, column_name, null, default = nil) 499: column = column_for(table_name, column_name) 500: 501: unless null || default.nil? 502: execute("UPDATE #{quote_table_name(table_name)} SET #{quote_column_name(column_name)}=#{quote(default)} WHERE #{quote_column_name(column_name)} IS NULL") 503: end 504: 505: change_column table_name, column_name, column.sql_type, :null => null 506: end
Returns the database character set.
[ show source ]
# File activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 430 430: def charset 431: show_variable 'character_set_database' 432: end
Returns the database collation strategy.
[ show source ]
# File activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 435 435: def collation 436: show_variable 'collation_database' 437: 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
[ show source ]
# File 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
[ show source ]
# File activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 362 362: def create_savepoint 363: execute("SAVEPOINT #{current_savepoint_name}") 364: end
[ show source ]
# File activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 425 425: def current_database 426: select_value 'SELECT DATABASE() as db' 427: end
[ show source ]
# File activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 299 299: def disconnect! 300: @connection.close rescue nil 301: end
[ show source ]
# File 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
[ show source ]
# File activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 588 588: def limited_update_conditions(where_sql, quoted_table_name, quoted_primary_key) 589: where_sql 590: end
Returns just a table‘s primary key
[ show source ]
# File activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 579 579: def primary_key(table) 580: pk_and_sequence = pk_and_sequence_for(table) 581: pk_and_sequence && pk_and_sequence.first 582: end
QUOTING ==================================================
[ show source ]
# File 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
[ show source ]
# File activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 258 258: def quoted_false 259: QUOTED_FALSE 260: end
[ show source ]
# File activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 254 254: def quoted_true 255: QUOTED_TRUE 256: end
[ show source ]
# File activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 294 294: def reconnect! 295: disconnect! 296: connect 297: end
[ show source ]
# File activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 370 370: def release_savepoint 371: execute("RELEASE SAVEPOINT #{current_savepoint_name}") 372: end
[ show source ]
# File activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 482 482: def rename_table(table_name, new_name) 483: execute "RENAME TABLE #{quote_table_name(table_name)} TO #{quote_table_name(new_name)}" 484: end
[ show source ]
# File 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
[ show source ]
# File 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 ======================================
[ show source ]
# File 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‘
[ show source ]
# File activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 562 562: def show_variable(name) 563: variables = select_all("SHOW VARIABLES LIKE '#{name}'") 564: variables.first['Value'] unless variables.empty? 565: end
Maps logical Rails types to MySQL-specific data types.
[ show source ]
# File activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 540 540: def type_to_sql(type, limit = nil, precision = nil, scale = nil) 541: return super unless type.to_s == 'integer' 542: 543: case limit 544: when 1; 'tinyint' 545: when 2; 'smallint' 546: when 3; 'mediumint' 547: when nil, 4, 11; 'int(11)' # compatibility with MySQL default 548: when 5..8; 'bigint' 549: else raise(ActiveRecordError, "No integer type has byte size #{limit}") 550: end 551: end
[ show source ]
# File activerecord/lib/active_record/connection_adapters/mysql_adapter.rb, line 593 593: def quoted_columns_for_index(column_names, options = {}) 594: length = options[:length] if options.is_a?(Hash) 595: 596: quoted_column_names = case length 597: when Hash 598: column_names.map {|name| length[name] ? "#{quote_column_name(name)}(#{length[name]})" : quote_column_name(name) } 599: when Fixnum 600: column_names.map {|name| "#{quote_column_name(name)}(#{length})"} 601: else 602: column_names.map {|name| quote_column_name(name) } 603: end 604: end