mysql2 0.2.24 → 0.3.0

data/ext/mysql2/result.h

@@ -2,20 +2,17 @@
 #define MYSQL2_RESULT_H
 
 void init_mysql2_result();
-VALUE rb_mysql_result_to_obj(VALUE client, VALUE encoding, VALUE options, MYSQL_RES *r);
+VALUE rb_mysql_result_to_obj(MYSQL_RES * r);
 
 typedef struct {
   VALUE fields;
   VALUE rows;
-  VALUE client;
   VALUE encoding;
   unsigned int numberOfFields;
   unsigned long numberOfRows;
   unsigned long lastRowProcessed;
-  char streamingComplete;
   char resultFreed;
   MYSQL_RES *result;
-  mysql_client_wrapper *client_wrapper;
 } mysql2_result_wrapper;
 
 #define GetMysql2Result(obj, sval) (sval = (mysql2_result_wrapper*)DATA_PTR(obj));

data/lib/active_record/connection_adapters/em_mysql2_adapter.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+# AR adapter for using a fibered mysql2 connection with EM
+# This adapter should be used within Thin or Unicorn with the rack-fiber_pool middleware.
+# Just update your database.yml's adapter to be 'em_mysql2'
+
+module ActiveRecord
+  class Base
+    def self.em_mysql2_connection(config)
+      client = ::Mysql2::Fibered::Client.new(config.symbolize_keys)
+      options = [config[:host], config[:username], config[:password], config[:database], config[:port], config[:socket], 0]
+      ConnectionAdapters::Mysql2Adapter.new(client, logger, options, config)
+    end
+  end
+end
+
+require 'fiber'
+require 'eventmachine'
+require 'mysql2'
+require 'active_record/connection_adapters/mysql2_adapter'
+require 'active_record/fiber_patches'
+
+module Mysql2
+  module Fibered
+    class Client < ::Mysql2::Client
+      module Watcher
+        def initialize(client, deferable)
+          @client = client
+          @deferable = deferable
+        end
+
+        def notify_readable
+          begin
+            detach
+            results = @client.async_result
+            @deferable.succeed(results)
+          rescue Exception => e
+            @deferable.fail(e)
+          end
+        end
+      end
+
+      def query(sql, opts={})
+        if ::EM.reactor_running?
+          super(sql, opts.merge(:async => true))
+          deferrable = ::EM::DefaultDeferrable.new
+          ::EM.watch(self.socket, Watcher, self, deferrable).notify_readable = true
+          fiber = Fiber.current
+          deferrable.callback do |result|
+            fiber.resume(result)
+          end
+          deferrable.errback do |err|
+            fiber.resume(err)
+          end
+          Fiber.yield.tap do |result|
+            raise result if result.is_a?(Exception)
+          end
+        else
+          super(sql, opts)
+        end
+      end
+    end
+  end
+end

data/lib/active_record/fiber_patches.rb

@@ -0,0 +1,104 @@
+# Necessary monkeypatching to make AR fiber-friendly.
+
+module ActiveRecord
+  module ConnectionAdapters
+
+    def self.fiber_pools
+      @fiber_pools ||= []
+    end
+    def self.register_fiber_pool(fp)
+      fiber_pools << fp
+    end
+
+    class FiberedMonitor
+      class Queue
+        def initialize
+          @queue = []
+        end
+
+        def wait(timeout)
+          t = timeout || 5
+          fiber = Fiber.current
+          x = EM::Timer.new(t) do
+            @queue.delete(fiber)
+            fiber.resume(false)
+          end
+          @queue << fiber
+          Fiber.yield.tap do
+            x.cancel
+          end
+        end
+
+        def signal
+          fiber = @queue.pop
+          fiber.resume(true) if fiber
+        end
+      end
+
+      def synchronize
+        yield
+      end
+
+      def new_cond
+        Queue.new
+      end
+    end
+
+    # ActiveRecord's connection pool is based on threads.  Since we are working
+    # with EM and a single thread, multiple fiber design, we need to provide
+    # our own connection pool that keys off of Fiber.current so that different
+    # fibers running in the same thread don't try to use the same connection.
+    class ConnectionPool
+      def initialize(spec)
+        @spec = spec
+
+        # The cache of reserved connections mapped to threads
+        @reserved_connections = {}
+
+        # The mutex used to synchronize pool access
+        @connection_mutex = FiberedMonitor.new
+        @queue = @connection_mutex.new_cond
+
+        # default 5 second timeout unless on ruby 1.9
+        @timeout = spec.config[:wait_timeout] || 5
+
+        # default max pool size to 5
+        @size = (spec.config[:pool] && spec.config[:pool].to_i) || 5
+
+        @connections = []
+        @checked_out = []
+      end
+
+      def clear_stale_cached_connections!
+        cache = @reserved_connections
+        keys = Set.new(cache.keys)
+
+        ActiveRecord::ConnectionAdapters.fiber_pools.each do |pool|
+          pool.busy_fibers.each_pair do |object_id, fiber|
+            keys.delete(object_id)
+          end
+        end
+
+        keys.each do |key|
+          next unless cache.has_key?(key)
+          checkin cache[key]
+          cache.delete(key)
+        end
+      end
+
+      private
+
+      def current_connection_id #:nodoc:
+        Fiber.current.object_id
+      end
+
+      def checkout_and_verify(c)
+        @checked_out << c
+        c.run_callbacks :checkout
+        c.verify!
+        c
+      end
+    end
+
+  end
+end

data/lib/mysql2.rb

@@ -6,8 +6,8 @@ require 'rational' unless RUBY_VERSION >= '1.9.2'
 require 'mysql2/version' unless defined? Mysql2::VERSION
 require 'mysql2/error'
 require 'mysql2/mysql2'
-require 'mysql2/result'
 require 'mysql2/client'
+require 'mysql2/result'
 
 # = Mysql2
 #
@@ -15,22 +15,7 @@ require 'mysql2/client'
 module Mysql2
 end
 
-if defined?(ActiveRecord::VERSION::STRING) && ActiveRecord::VERSION::STRING >= "3.1"
-  warn "============= WARNING FROM mysql2 ============="
-  warn "This version of mysql2 (#{Mysql2::VERSION}) isn't compatible with Rails 3.1 as the ActiveRecord adapter was pulled into Rails itself."
-  warn "Please use the 0.3.x (or greater) releases if you plan on using it in Rails >= 3.1.x"
-  warn "============= END WARNING FROM mysql2 ============="
-end
-
-# For holding utility methods
-module Mysql2::Util
-
-  #
-  # Rekey a string-keyed hash with equivalent symbols.
-  #
-  def self.key_hash_as_symbols(hash)
-    return nil unless hash
-    Hash[hash.map { |k,v| [k.to_sym, v] }]
-  end
-
-end
+if defined?(ActiveRecord) && ActiveRecord::VERSION::STRING < "3.1"
+  puts "WARNING: This version of mysql2 (#{Mysql2::VERSION}) doesn't ship with the ActiveRecord adapter bundled anymore as it's now part of Rails 3.1"
+  puts "WARNING: Please use the 0.2.x releases if you plan on using it in Rails <= 3.0.x"
+end

data/lib/mysql2/client.rb

@@ -1,6 +1,6 @@
 module Mysql2
   class Client
-    attr_reader :query_options, :read_timeout
+    attr_reader :query_options
     @@default_query_options = {
       :as => :hash,                   # the type of object you want each row back as; also supports :array (an array of values)
       :async => false,                # don't wait for a result after sending the query, you'll have to monitor the socket yourself then eventually call Mysql2::Client#async_result
@@ -9,63 +9,35 @@ module Mysql2
       :database_timezone => :local,   # timezone Mysql2 will assume datetime objects are stored in
       :application_timezone => nil,   # timezone Mysql2 will convert to before handing the object back to the caller
       :cache_rows => true,            # tells Mysql2 to use it's internal row cache for results
-      :connect_flags => REMEMBER_OPTIONS | LONG_PASSWORD | LONG_FLAG | TRANSACTIONS | PROTOCOL_41 | SECURE_CONNECTION,
-      :cast => true,
-      :default_file => nil,
-      :default_group => nil
+      :connect_flags => REMEMBER_OPTIONS | LONG_PASSWORD | LONG_FLAG | TRANSACTIONS | PROTOCOL_41 | SECURE_CONNECTION
     }
 
     def initialize(opts = {})
-      opts = Mysql2::Util.key_hash_as_symbols( opts )
-      @read_timeout = nil
       @query_options = @@default_query_options.dup
-      @query_options.merge! opts
 
-      initialize_ext
+      init_connection
 
-      # Set default connect_timeout to avoid unlimited retries from signal interruption
-      opts[:connect_timeout] = 120 unless opts.key?(:connect_timeout)
-
-      [:reconnect, :connect_timeout, :local_infile, :read_timeout, :write_timeout, :default_file, :default_group, :secure_auth, :init_command].each do |key|
+      [:reconnect, :connect_timeout].each do |key|
         next unless opts.key?(key)
-        case key
-        when :reconnect, :local_infile, :secure_auth
-          send(:"#{key}=", !!opts[key])
-        when :connect_timeout, :read_timeout, :write_timeout
-          send(:"#{key}=", opts[key].to_i)
-        else
-          send(:"#{key}=", opts[key])
-        end
+        send(:"#{key}=", opts[key])
       end
-
       # force the encoding to utf8
       self.charset_name = opts[:encoding] || 'utf8'
 
-      ssl_options = opts.values_at(:sslkey, :sslcert, :sslca, :sslcapath, :sslcipher)
-      ssl_set(*ssl_options) if ssl_options.any?
-
-      if [:user,:pass,:hostname,:dbname,:db,:sock].any?{|k| @query_options.has_key?(k) }
-        warn "============= WARNING FROM mysql2 ============="
-        warn "The options :user, :pass, :hostname, :dbname, :db, and :sock will be deprecated at some point in the future."
-        warn "Instead, please use :username, :password, :host, :port, :database, :socket, :flags for the options."
-        warn "============= END WARNING FROM mysql2 ========="
+      @read_timeout = opts[:read_timeout]
+      if @read_timeout and @read_timeout < 0
+        raise Mysql2::Error, "read_timeout must be a positive integer, you passed #{@read_timeout}"
       end
 
-      user     = opts[:username] || opts[:user]
-      pass     = opts[:password] || opts[:pass]
-      host     = opts[:host] || opts[:hostname]
-      port     = opts[:port]
-      database = opts[:database] || opts[:dbname] || opts[:db]
-      socket   = opts[:socket] || opts[:sock]
-      flags    = opts[:flags] ? opts[:flags] | @query_options[:connect_flags] : @query_options[:connect_flags]
+      ssl_set(*opts.values_at(:sslkey, :sslcert, :sslca, :sslcapath, :sslciper))
 
-      # Correct the data types before passing these values down to the C level
-      user = user.to_s unless user.nil?
-      pass = pass.to_s unless pass.nil?
-      host = host.to_s unless host.nil?
-      port = port.to_i unless port.nil?
-      database = database.to_s unless database.nil?
-      socket = socket.to_s unless socket.nil?
+      user     = opts[:username]
+      pass     = opts[:password]
+      host     = opts[:host] || 'localhost'
+      port     = opts[:port] || 3306
+      database = opts[:database]
+      socket   = opts[:socket]
+      flags    = opts[:flags] ? opts[:flags] | @query_options[:connect_flags] : @query_options[:connect_flags]
 
       connect user, pass, host, port, database, socket, flags
     end
@@ -74,12 +46,190 @@ module Mysql2
       @@default_query_options
     end
 
-    def query_info
-      info = query_info_string
-      return {} unless info
-      info_hash = {}
-      info.split.each_slice(2) { |s| info_hash[s[0].downcase.delete(':').to_sym] = s[1].to_i }
-      info_hash
+    # NOTE: from ruby-mysql
+    if defined? Encoding
+      CHARSET_MAP = {
+        "armscii8" => nil,
+        "ascii"    => Encoding::US_ASCII,
+        "big5"     => Encoding::Big5,
+        "binary"   => Encoding::ASCII_8BIT,
+        "cp1250"   => Encoding::Windows_1250,
+        "cp1251"   => Encoding::Windows_1251,
+        "cp1256"   => Encoding::Windows_1256,
+        "cp1257"   => Encoding::Windows_1257,
+        "cp850"    => Encoding::CP850,
+        "cp852"    => Encoding::CP852,
+        "cp866"    => Encoding::IBM866,
+        "cp932"    => Encoding::Windows_31J,
+        "dec8"     => nil,
+        "eucjpms"  => Encoding::EucJP_ms,
+        "euckr"    => Encoding::EUC_KR,
+        "gb2312"   => Encoding::EUC_CN,
+        "gbk"      => Encoding::GBK,
+        "geostd8"  => nil,
+        "greek"    => Encoding::ISO_8859_7,
+        "hebrew"   => Encoding::ISO_8859_8,
+        "hp8"      => nil,
+        "keybcs2"  => nil,
+        "koi8r"    => Encoding::KOI8_R,
+        "koi8u"    => Encoding::KOI8_U,
+        "latin1"   => Encoding::ISO_8859_1,
+        "latin2"   => Encoding::ISO_8859_2,
+        "latin5"   => Encoding::ISO_8859_9,
+        "latin7"   => Encoding::ISO_8859_13,
+        "macce"    => Encoding::MacCentEuro,
+        "macroman" => Encoding::MacRoman,
+        "sjis"     => Encoding::SHIFT_JIS,
+        "swe7"     => nil,
+        "tis620"   => Encoding::TIS_620,
+        "ucs2"     => Encoding::UTF_16BE,
+        "ujis"     => Encoding::EucJP_ms,
+        "utf8"     => Encoding::UTF_8,
+      }
+
+      MYSQL_CHARSET_MAP = {
+        1 => {:name => "big5",      :collation => "big5_chinese_ci"},
+        2 => {:name => "latin2",    :collation => "latin2_czech_cs"},
+        3 => {:name => "dec8",      :collation => "dec8_swedish_ci"},
+        4 => {:name => "cp850",     :collation => "cp850_general_ci"},
+        5 => {:name => "latin1",    :collation => "latin1_german1_ci"},
+        6 => {:name => "hp8",       :collation => "hp8_english_ci"},
+        7 => {:name => "koi8r",     :collation => "koi8r_general_ci"},
+        8 => {:name => "latin1",    :collation => "latin1_swedish_ci"},
+        9 => {:name => "latin2",    :collation => "latin2_general_ci"},
+        10 => {:name => "swe7",     :collation => "swe7_swedish_ci"},
+        11 => {:name => "ascii",    :collation => "ascii_general_ci"},
+        12 => {:name => "ujis",     :collation => "ujis_japanese_ci"},
+        13 => {:name => "sjis",     :collation => "sjis_japanese_ci"},
+        14 => {:name => "cp1251",   :collation => "cp1251_bulgarian_ci"},
+        15 => {:name => "latin1",   :collation => "latin1_danish_ci"},
+        16 => {:name => "hebrew",   :collation => "hebrew_general_ci"},
+        17 => {:name => "filename", :collation => "filename"},
+        18 => {:name => "tis620",   :collation => "tis620_thai_ci"},
+        19 => {:name => "euckr",    :collation => "euckr_korean_ci"},
+        20 => {:name => "latin7",   :collation => "latin7_estonian_cs"},
+        21 => {:name => "latin2",   :collation => "latin2_hungarian_ci"},
+        22 => {:name => "koi8u",    :collation => "koi8u_general_ci"},
+        23 => {:name => "cp1251",   :collation => "cp1251_ukrainian_ci"},
+        24 => {:name => "gb2312",   :collation => "gb2312_chinese_ci"},
+        25 => {:name => "greek",    :collation => "greek_general_ci"},
+        26 => {:name => "cp1250",   :collation => "cp1250_general_ci"},
+        27 => {:name => "latin2",   :collation => "latin2_croatian_ci"},
+        28 => {:name => "gbk",      :collation => "gbk_chinese_ci"},
+        29 => {:name => "cp1257",   :collation => "cp1257_lithuanian_ci"},
+        30 => {:name => "latin5",   :collation => "latin5_turkish_ci"},
+        31 => {:name => "latin1",   :collation => "latin1_german2_ci"},
+        32 => {:name => "armscii8", :collation => "armscii8_general_ci"},
+        33 => {:name => "utf8",     :collation => "utf8_general_ci"},
+        34 => {:name => "cp1250",   :collation => "cp1250_czech_cs"},
+        35 => {:name => "ucs2",     :collation => "ucs2_general_ci"},
+        36 => {:name => "cp866",    :collation => "cp866_general_ci"},
+        37 => {:name => "keybcs2",  :collation => "keybcs2_general_ci"},
+        38 => {:name => "macce",    :collation => "macce_general_ci"},
+        39 => {:name => "macroman", :collation => "macroman_general_ci"},
+        40 => {:name => "cp852",    :collation => "cp852_general_ci"},
+        41 => {:name => "latin7",   :collation => "latin7_general_ci"},
+        42 => {:name => "latin7",   :collation => "latin7_general_cs"},
+        43 => {:name => "macce",    :collation => "macce_bin"},
+        44 => {:name => "cp1250",   :collation => "cp1250_croatian_ci"},
+        47 => {:name => "latin1",   :collation => "latin1_bin"},
+        48 => {:name => "latin1",   :collation => "latin1_general_ci"},
+        49 => {:name => "latin1",   :collation => "latin1_general_cs"},
+        50 => {:name => "cp1251",   :collation => "cp1251_bin"},
+        51 => {:name => "cp1251",   :collation => "cp1251_general_ci"},
+        52 => {:name => "cp1251",   :collation => "cp1251_general_cs"},
+        53 => {:name => "macroman", :collation => "macroman_bin"},
+        57 => {:name => "cp1256",   :collation => "cp1256_general_ci"},
+        58 => {:name => "cp1257",   :collation => "cp1257_bin"},
+        59 => {:name => "cp1257",   :collation => "cp1257_general_ci"},
+        63 => {:name => "binary",   :collation => "binary"},
+        64 => {:name => "armscii8", :collation => "armscii8_bin"},
+        65 => {:name => "ascii",    :collation => "ascii_bin"},
+        66 => {:name => "cp1250",   :collation => "cp1250_bin"},
+        67 => {:name => "cp1256",   :collation => "cp1256_bin"},
+        68 => {:name => "cp866",    :collation => "cp866_bin"},
+        69 => {:name => "dec8",     :collation => "dec8_bin"},
+        70 => {:name => "greek",    :collation => "greek_bin"},
+        71 => {:name => "hebrew",   :collation => "hebrew_bin"},
+        72 => {:name => "hp8",      :collation => "hp8_bin"},
+        73 => {:name => "keybcs2",  :collation => "keybcs2_bin"},
+        74 => {:name => "koi8r",    :collation => "koi8r_bin"},
+        75 => {:name => "koi8u",    :collation => "koi8u_bin"},
+        77 => {:name => "latin2",   :collation => "latin2_bin"},
+        78 => {:name => "latin5",   :collation => "latin5_bin"},
+        79 => {:name => "latin7",   :collation => "latin7_bin"},
+        80 => {:name => "cp850",    :collation => "cp850_bin"},
+        81 => {:name => "cp852",    :collation => "cp852_bin"},
+        82 => {:name => "swe7",     :collation => "swe7_bin"},
+        83 => {:name => "utf8",     :collation => "utf8_bin"},
+        84 => {:name => "big5",     :collation => "big5_bin"},
+        85 => {:name => "euckr",    :collation => "euckr_bin"},
+        86 => {:name => "gb2312",   :collation => "gb2312_bin"},
+        87 => {:name => "gbk",      :collation => "gbk_bin"},
+        88 => {:name => "sjis",     :collation => "sjis_bin"},
+        89 => {:name => "tis620",   :collation => "tis620_bin"},
+        90 => {:name => "ucs2",     :collation => "ucs2_bin"},
+        91 => {:name => "ujis",     :collation => "ujis_bin"},
+        92 => {:name => "geostd8",  :collation => "geostd8_general_ci"},
+        93 => {:name => "geostd8",  :collation => "geostd8_bin"},
+        94 => {:name => "latin1",   :collation => "latin1_spanish_ci"},
+        95 => {:name => "cp932",    :collation => "cp932_japanese_ci"},
+        96 => {:name => "cp932",    :collation => "cp932_bin"},
+        97 => {:name => "eucjpms",  :collation => "eucjpms_japanese_ci"},
+        98 => {:name => "eucjpms",  :collation => "eucjpms_bin"},
+        99 => {:name => "cp1250",   :collation => "cp1250_polish_ci"},
+        128 => {:name => "ucs2",    :collation => "ucs2_unicode_ci"},
+        129 => {:name => "ucs2",    :collation => "ucs2_icelandic_ci"},
+        130 => {:name => "ucs2",    :collation => "ucs2_latvian_ci"},
+        131 => {:name => "ucs2",    :collation => "ucs2_romanian_ci"},
+        132 => {:name => "ucs2",    :collation => "ucs2_slovenian_ci"},
+        133 => {:name => "ucs2",    :collation => "ucs2_polish_ci"},
+        134 => {:name => "ucs2",    :collation => "ucs2_estonian_ci"},
+        135 => {:name => "ucs2",    :collation => "ucs2_spanish_ci"},
+        136 => {:name => "ucs2",    :collation => "ucs2_swedish_ci"},
+        137 => {:name => "ucs2",    :collation => "ucs2_turkish_ci"},
+        138 => {:name => "ucs2",    :collation => "ucs2_czech_ci"},
+        139 => {:name => "ucs2",    :collation => "ucs2_danish_ci"},
+        140 => {:name => "ucs2",    :collation => "ucs2_lithuanian_ci"},
+        141 => {:name => "ucs2",    :collation => "ucs2_slovak_ci"},
+        142 => {:name => "ucs2",    :collation => "ucs2_spanish2_ci"},
+        143 => {:name => "ucs2",    :collation => "ucs2_roman_ci"},
+        144 => {:name => "ucs2",    :collation => "ucs2_persian_ci"},
+        145 => {:name => "ucs2",    :collation => "ucs2_esperanto_ci"},
+        146 => {:name => "ucs2",    :collation => "ucs2_hungarian_ci"},
+        192 => {:name => "utf8",    :collation => "utf8_unicode_ci"},
+        193 => {:name => "utf8",    :collation => "utf8_icelandic_ci"},
+        194 => {:name => "utf8",    :collation => "utf8_latvian_ci"},
+        195 => {:name => "utf8",    :collation => "utf8_romanian_ci"},
+        196 => {:name => "utf8",    :collation => "utf8_slovenian_ci"},
+        197 => {:name => "utf8",    :collation => "utf8_polish_ci"},
+        198 => {:name => "utf8",    :collation => "utf8_estonian_ci"},
+        199 => {:name => "utf8",    :collation => "utf8_spanish_ci"},
+        200 => {:name => "utf8",    :collation => "utf8_swedish_ci"},
+        201 => {:name => "utf8",    :collation => "utf8_turkish_ci"},
+        202 => {:name => "utf8",    :collation => "utf8_czech_ci"},
+        203 => {:name => "utf8",    :collation => "utf8_danish_ci"},
+        204 => {:name => "utf8",    :collation => "utf8_lithuanian_ci"},
+        205 => {:name => "utf8",    :collation => "utf8_slovak_ci"},
+        206 => {:name => "utf8",    :collation => "utf8_spanish2_ci"},
+        207 => {:name => "utf8",    :collation => "utf8_roman_ci"},
+        208 => {:name => "utf8",    :collation => "utf8_persian_ci"},
+        209 => {:name => "utf8",    :collation => "utf8_esperanto_ci"},
+        210 => {:name => "utf8",    :collation => "utf8_hungarian_ci"},
+        254 => {:name => "utf8",    :collation => "utf8_general_cs"}
+      }
+
+      def self.encoding_from_charset(charset)
+        CHARSET_MAP[charset.to_s.downcase]
+      end
+
+      def self.encoding_from_charset_code(code)
+        if mapping = MYSQL_CHARSET_MAP[code]
+          encoding_from_charset(mapping[:name])
+        else
+          nil
+        end
+      end
     end
 
     private