ffi-mysql 1.0.0 → 1.1.0

data/.hgignore

@@ -0,0 +1,7 @@
+syntax: glob
+
+.yardoc/
+doc/
+pkg/
+*~
+.hg/

data/.hgtags

@@ -1,2 +1,4 @@
 afd66b4b7cda50c08a79f51574d46e49c4dc083b v0.0.1
 2bfcf2ddedd5d9589ecc0dc915d0393e218aa603 v0.0.2
+a8bbc2c818cd66f86fbeb43f59bdb21499d58768 v1.0.0
+84d7cd84016aaade9b5530d183d9d3378d1c0c33 v1.1.0

data/History.markdown

@@ -1,9 +1,17 @@
+1.1.0 / 2012-01-21
+------------------
+
+* add several methods for compatibility with MySQL 5.0 and MySQL/Ruby
+  2.8.2
+
+
 1.0.0 / 2010-04-21
 ------------------
 
 * fix Fixnum size bugs 
 * update to mysql-ruby-2.8.2 test-suite
 
+
 0.0.2 / 2010-03-08
 ------------------
 

data/README.markdown

@@ -31,7 +31,7 @@ for examples.
 REQUIREMENTS
 ------------
 
-* ffi >= 0.6.2
+* ffi ~> 1.0
 
 INSTALL
 -------
@@ -44,6 +44,8 @@ ACKNOWLEDGEMENTS
 Tomita Masahiro for his MySQL/Ruby and Ruby/MySQL gems from which some
 of the code has been stolen.
 
+Norman Meilick for implementing some missing methods.
+
 LICENSE
 -------
 

data/announcement.txt

@@ -0,0 +1,13 @@
+ffi-mysql version 1.1.0
+    by Frank Fischer
+    http://bitbucket.org/lyro/ffi-mysql
+
+== DESCRIPTION
+
+Pure Ruby FFI interface to MySQL.
+
+== CHANGES
+
+* add several methods for compatibility with MySQL 5.0 and MySQL/Ruby
+  2.8.2
+

data/lib/ffi-mysql/error.rb

@@ -1,4 +1,11 @@
 class Mysql
     class Error < Exception
+        alias error message
+        attr_reader :errno
+
+        def initialize(msg = nil, errno = nil)
+            super msg
+            @errno = errno
+        end
     end
 end

data/lib/ffi-mysql/mysql.rb

@@ -63,21 +63,56 @@ class Mysql
                    :type,             FieldType)
         end
 
-        StmtAttrType = enum( :update_max_length, :cursor_type, :prefetch_rows )
+        def self.maybe_attach_function name, *args
+            attach_function name, *args
+        rescue FFI::NotFoundError => e
+            define_singleton_method(name) {|*a| raise e}
+        end
 
+        StmtAttrType = enum( :update_max_length, :cursor_type, :prefetch_rows )
         attach_function :mysql_init, [:pointer], :pointer
         attach_function :mysql_close, [:pointer], :void
+        attach_function :mysql_errno, [:pointer], :uint
         attach_function :mysql_error, [:pointer], :string
+        attach_function :mysql_warning_count, [:pointer], :uint
+        attach_function :mysql_debug, [:string], :void
+        attach_function :mysql_dump_debug_info, [:pointer], :int
+        attach_function :mysql_ping, [:pointer], :int
+        attach_function :mysql_refresh, [:pointer, :uint ], :int
+        maybe_attach_function :mysql_reload, [:pointer], :int
+        attach_function :mysql_shutdown, [:pointer], :int
+        attach_function :mysql_change_user, [:pointer, :string, :string, :string], :char
+        attach_function :mysql_select_db, [:pointer, :string], :int
+        attach_function :mysql_thread_id, [:pointer], :ulong
+        attach_function :mysql_kill, [:pointer, :ulong], :int
+        attach_function :mysql_info, [:pointer], :string
+        attach_function :mysql_stat, [:pointer], :string
+        attach_function :mysql_character_set_name, [:pointer], :string
+        attach_function :mysql_set_character_set, [:pointer, :string], :int
         attach_function :mysql_get_client_version, [], :int
         attach_function :mysql_get_client_info, [], :string
         attach_function :mysql_get_server_version, [:pointer], :int
         attach_function :mysql_get_server_info, [:pointer], :string
+        attach_function :mysql_get_host_info, [:pointer], :string
+        attach_function :mysql_get_proto_info, [:pointer], :uint
+        attach_function :mysql_ssl_set, [:pointer, :string, :string, :string, :string, :string], :int
         attach_function :mysql_real_connect, [:pointer, :string, :string, :string, :string, :uint, :string, :ulong], :pointer
+        attach_function :mysql_ping, [:pointer], :int
         attach_function :mysql_options, [:pointer, :int, :pointer], :int
         attach_function :mysql_set_server_option, [:pointer, :int], :int
+        attach_function :mysql_real_escape_string, [:pointer, :pointer, :char, :ulong], :ulong
         attach_function :mysql_real_query, [:pointer, :string, :ulong], :int
+        attach_function :mysql_insert_id, [:pointer], :ulong_long
+        attach_function :mysql_list_dbs, [:pointer, :string], :pointer
+        attach_function :mysql_list_fields, [:pointer, :string, :string], :pointer
+        attach_function :mysql_list_processes, [:pointer], :pointer
+        attach_function :mysql_list_tables, [:pointer, :string], :pointer
+        attach_function :mysql_autocommit, [:pointer, :char], :char
+        attach_function :mysql_commit, [:pointer], :char
+        attach_function :mysql_rollback, [:pointer], :char
         attach_function :mysql_field_count, [:pointer], :uint
         attach_function :mysql_store_result, [:pointer], :pointer
+        attach_function :mysql_use_result, [:pointer], :pointer
         attach_function :mysql_free_result, [:pointer], :void
         attach_function :mysql_next_result, [:pointer], :int
         attach_function :mysql_more_results, [:pointer], :bool
@@ -116,6 +151,7 @@ class Mysql
         attach_function :mysql_stmt_sqlstate, [:pointer], :string
         attach_function :mysql_stmt_errno, [:pointer], :uint
         attach_function :mysql_stmt_error, [:pointer], :string
+
     end
 
     # Creates a new MySQL object.
@@ -142,12 +178,25 @@ class Mysql
     def client_version
         Mysql.client_version
     end
+    alias get_client_version client_version
 
     # @return [String] string containing the client's version
     def self.client_info
         C::mysql_get_client_info
     end
 
+    # @return [String] string containing the client's version
+    def client_info
+        Mysql.client_info
+    end
+    alias get_client_info client_info
+
+    # Does a DBUG_PUSH with the given string.
+    def self.debug(arg)
+        C::mysql_debug(arg)
+        self
+    end
+
     # Escape special character in MySQL.
     # === Note
     # In Ruby 1.8, this is not safe for multibyte charset such as 'SJIS'.
@@ -196,6 +245,22 @@ class Mysql
         end
     end
 
+    # Set SSL settings (must be called before real_connect)
+    #
+    # @param [String] key path to the key file
+    # @param [String] cert path to the certificate file
+    # @param [String] ca path to the certificate authority file
+    # @param [String] capath path name to a directory with SSL CA certificates in pem format
+    # @param [String] cipher list of permissible ciphers to use
+    #
+    # Any unused SSL parameters may be given as NULL.
+    def ssl_set(key, cert, ca, capath, cipher)
+      if C::mysql_ssl_set(@mysql, key, cert, ca, capath, cipher) != 0
+        raise Error.new(error, errno)
+      end
+      self
+    end
+
     # Opens a new connection to a MySQL server.
     #
     # @param [String] host the MySQL server
@@ -210,7 +275,7 @@ class Mysql
         ObjectSpace.define_finalizer( self, Mysql.finalizer(@mysql, @mysql_free))
 
         if C::mysql_real_connect( @mysql, host, user, passwd, db, port, sock, flag ).null?
-            raise Mysql::Error, error_msg
+            raise Mysql::Error, error
         end
 
         @connected = true
@@ -224,8 +289,154 @@ class Mysql
         @mysql = nil
         @mysql_free[0] = true
         @connected = false
+        self
+    end
+
+    # Checks whether the connection to the server is working.
+    def ping
+        if C::mysql_ping(@mysql) != 0
+            raise Error.new(error, errno)
+        end
+        self
+    end
+
+    # @return [Integer] error code for the most recently failed API function
+    def errno
+        C::mysql_errno(@mysql)
+    end
+
+    # @return [String] error message for the most recently failing API function
+    def error
+        C::mysql_error(@mysql)
+    end
+
+    # @return [Integer] the number of errors, warnings and notes generated during the previous SQL statement
+    def warning_count
+        C::mysql_warning_count(@mysql)
+    end
+
+    # Write debug information to the log
+    # Raises an error when there is a problem, otherwise returns self.
+    def dump_debug_info
+        if C::mysql_dump_debug_info(@mysql) != 0
+            raise Error.new(error, errno)
+        end
+        self
+    end
+
+    # Check whether the connection to the server is working.
+    # Raises an error when there is a problem, otherwise returns self.
+    def ping
+        if C::mysql_ping(@mysql) != 0
+            raise Error.new(error, errno)
+        end
+        self
+    end
+
+    # Flush tables or caches, or reset replication server information.
+    #
+    # @param [Integer] options bit mask of REFRESH_... values
+    def refresh(options)
+        if C::mysql_refresh(@mysql, options) != 0
+            raise Error.new(error, errno)
+        end
+        self
+    end
+
+    # Asks the MySQL server to reload the grant table.
+    def reload
+        if C::mysql_reload(@mysql) != 0
+            raise Error.new(error, errno)
+        end
+        self
+    end
+
+    # Asks the MySQL server to shut down.
+    def shutdown
+        if C::mysql_shutdown(@mysql) != 0
+            raise Error.new(error, errno)
+        end
+        self
+    end
+
+    # Change the user and change to a different database
+    #
+    # @param [String] user user to change to
+    # @param [String] password password of user
+    # @param [String] db name of database to change to
+    #
+    # Raises an error when there is a problem, otherwise returns self.
+    def change_user(user, password, db)
+        if C::mysql_change_user(@mysql, user, password, db) != 0
+            raise Error.new(error, errno)
+        end
+        self
+    end
+
+    # Change the current database
+    #
+    # @param [String] db name of database to change to
+    #
+    # Raises an error when there is a problem, otherwise returns self.
+    def select_db(db)
+        if C::mysql_select_db(@mysql, db) != 0
+            raise Error.new(error, errno)
+        end
+        self
     end
 
+    # Returns the thread ID of the current connection
+    # @return [Integer] thread id of the current connection
+    def thread_id
+        C::mysql_thread_id(@mysql)
+    end
+
+    # Asks the server to kill the specified thread.
+    # @param [Integer] pid thread id to kill
+    def kill(pid)
+        if C::mysql_kill(@mysql, pid) != 0
+            raise Error.new(error, errno)
+        end
+        self
+    end
+
+    # Return information about the most recently executed statement
+    # @return [String] information about statement
+    def info
+        C::mysql_info(@mysql)
+    end
+
+    # Return information about the server status
+    # @return [String] string describing the server status
+    def stat
+        C::mysql_stat(@mysql)
+    end
+
+    # @return [String] default character set name for the current connection
+    def character_set_name
+        C::mysql_character_set_name(@mysql)
+    end
+
+    # Set default character set for the current connection.
+    # @param [String] csname default character set to use
+    def set_character_set(csname)
+        if C::mysql_set_character_set(@mysql, csname) != 0
+            raise Error.new(error, errno)
+        end
+        self
+    end
+
+    # Returns a legal SQL string to be used in SQL statements
+    # @param [String] str The string to be escaped
+    # @return [String] The escaped string
+    def real_escape_string(str)
+        to = FFI::MemoryPointer.new(str.size * 2 + 1, 1, false)
+        len = C::mysql_real_escape_string(@mysql, to, str, str.size)
+        to.read_string(len)
+    end
+    alias :escape_string :real_escape_string
+    alias :quote :real_escape_string
+
     # @return [Integer] the version of the server
     def server_version
         C::mysql_get_server_version(@mysql)
@@ -238,12 +449,23 @@ class Mysql
     end
     alias get_server_info server_info
 
+    # @return [String] string containing the host name and connection type
+    def host_info
+        C::mysql_get_host_info(@mysql)
+    end
+    alias get_host_info host_info
+
+    # @return [Integer] containing the current connection's procol version
+    def proto_info
+        C::mysql_get_proto_info(@mysql)
+    end
+    alias get_proto_info proto_info
+
     # @return [String] the SQLSTATE error code for the most recent statement
     def sqlstate
         C::mysql_sqlstate(@mysql)
     end
 
-
     # Sets extra connection options.
     #
     # @param [Integer] option the option to set
@@ -262,7 +484,7 @@ class Mysql
                  else
                      raise ArgumentError, "value must one of [String, Integer, nil, true, false]"
                  end
-        raise Error, error_msg if result != 0
+        raise Error.new(error, errno) if result != 0
         self
     end
 
@@ -271,12 +493,11 @@ class Mysql
     # @param [Integer] option server option
     def set_server_option( option )
         if C::mysql_set_server_option( @mysql, option ) != 0
-            raise Error, error_msg
+            raise Error.new(error, errno)
         end
         self
     end
 
-
     # Sets the auto-reconnect flag of mysql
     #
     # @param [true,false] The new reconnect state.
@@ -291,6 +512,89 @@ class Mysql
         @reconnect
     end
 
+    # Returns the value generated for an AUTO_INCREMENT column by
+    # the previous INSERT or UPDATE statement.
+    def insert_id
+        C::mysql_insert_id(@mysql)
+    end
+
+    # Returns a list of all databases on the server matching a pattern
+    # @param [String,nil] wild The pattern the databases must match
+    def list_dbs(wild = nil)
+        res = C::mysql_list_dbs(@mysql, wild)
+        if res.null?
+            raise Error.new(error, errno)
+        end
+        res = Result.new(@mysql, res)
+        dbs = []
+        res.each do |row|
+            dbs << row[0]
+        end
+        dbs
+    end
+
+    # Returns a result consisting the field names in the given table matching a pattern
+    # @param [String] table The table whose fields should be returned
+    # @param [String,nil] wild The pattern the field names must match
+    # @return [Result] A MySQL result of the field names
+    def list_fields(table, wild = nil)
+        res = C::mysql_list_fields(@mysql, table, wild)
+        if res.null?
+            raise Error.new(error, errno)
+        end
+        Result.new(@mysql, res)
+    end
+
+    # Returns a result describing the current server threads
+    # @return [Result] A MySQL result of the current server threads
+    def list_processes
+        res = C::mysql_list_processes(@mysql)
+        if res.null?
+            raise Error.new(error, errno)
+        end
+        Result.new(@mysql, res)
+    end
+
+    # Returns a result consisting the table names matching a pattern
+    # @param [String,nil] wild The pattern the table names must match
+    # @return [Array<String>] The table names
+    def list_tables(wild = nil)
+        res = C::mysql_list_tables(@mysql, wild)
+        if res.null?
+            raise Error.new(error, errno)
+        end
+        res = Result.new(@mysql, res)
+        tables = []
+        res.each do |row|
+            tables << row[0]
+        end
+        tables
+    end
+
+    # Sets autocommit mode on if mode is true, off if mode is false.
+    def autocommit(mode)
+      if C::mysql_autocommit(@mysql, mode ? 1 : 0) != 0
+        raise Error.new(error, errno)
+      end
+      self
+    end
+
+    # Commit transaction
+    def commit
+        if C::mysql_commit(@mysql) != 0
+            raise Error.new(error, errno)
+        end
+        self
+    end
+
+    # Rollback the current transaction
+    def rollback
+        if C::mysql_rollback(@mysql) != 0
+            raise Error.new(error, errno)
+        end
+        self
+    end
+
     # Execute a query statement.
     #
     # @param [String] sql the SQL statement
@@ -300,7 +604,7 @@ class Mysql
     def query(sql)
         raise Error, "Not connected" unless @connected
         if C::mysql_real_query(@mysql, sql, sql.size) != 0
-            raise Error, error_msg
+            raise Error.new(error, errno)
         end
 
         if block_given?
@@ -321,11 +625,26 @@ class Mysql
             self
         end
     end
+    alias real_query query
 
     # Stores the current result in a result set.
     # @return [Result] the result set
     def store_result
-        Result.new(@mysql, C::mysql_store_result(@mysql))
+        res = C::mysql_store_result(@mysql)
+        if res.null?
+            raise Error.new(error, errno)
+        end
+        Result.new(@mysql, res)
+    end
+
+    # Initialize result set retrieval but do not read data.
+    # @return [Result] the result set
+    def use_result
+        res = C::mysql_use_result(@mysql)
+        if res.null?
+            raise Error.new(error, errno)
+        end
+        Result.new(@mysql, res)
     end
 
     # Advances to the next result set.
@@ -337,7 +656,7 @@ class Mysql
         elsif result < 0
             false
         else
-            raise Error, error_msg
+            raise Error.new(error, errno)
         end
     end
 
@@ -368,11 +687,4 @@ class Mysql
     def prepare( stmt )
         stmt_init.prepare(stmt)
     end
-
-    # Returns the current error message.
-    def error_msg
-        C::mysql_error(@mysql)
-    end
-    private :error_msg
-
 end

data/lib/ffi-mysql/mysql.rb.rej

@@ -0,0 +1,10 @@
+--- mysql.rb
++++ mysql.rb
+@@ -74,6 +74,7 @@
+         attach_function :mysql_ping, [:pointer], :int
+         attach_function :mysql_refresh, [:pointer, :uint ], :int
+         attach_function :mysql_reload, [:pointer], :int
++        attach_function :mysql_shutdown, [:pointer], :int
+         attach_function :mysql_change_user, [:pointer, :string, :string, :string], :char
+         attach_function :mysql_select_db, [:pointer, :string], :int
+         attach_function :mysql_thread_id, [:pointer], :ulong

data/lib/ffi-mysql/version.rb

@@ -2,7 +2,7 @@ class Mysql
     # Major version
     MAJOR = 1
     # Minor version
-    MINOR = 0
+    MINOR = 1
     # Tiny version
     TINY = 0
 

data/test/test_mysql.rb

@@ -1,5 +1,4 @@
 #!/usr/local/bin/ruby
-# $Id: test.rb 244 2009-02-01 08:43:39Z tommy $
 
 require "test/unit"
 require 'ostruct'
@@ -30,7 +29,7 @@ class TC_Mysql < Test::Unit::TestCase
   end
 
   def test_version()
-    assert_equal("1.0.0", Mysql::VERSION)
+    assert_equal("1.1.0", Mysql::VERSION)
   end
 
   def test_init()

metadata

@@ -2,7 +2,7 @@
 name: ffi-mysql
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Frank Fischer
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-21 00:00:00 +02:00
+date: 2012-01-21 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 3.6.5
+        version: 3.7.3
   type: :development
   version_requirements: *id002
 description: Pure Ruby FFI interface to MySQL.
@@ -41,24 +41,27 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- announcement.txt
+- lib/ffi-mysql/mysql.rb.rej
 files: 
+- .hgignore
 - .hgtags
 - History.markdown
 - README.markdown
 - Rakefile
+- announcement.txt
 - lib/ffi-mysql.rb
 - lib/ffi-mysql/constants.rb
 - lib/ffi-mysql/error.rb
 - lib/ffi-mysql/field.rb
 - lib/ffi-mysql/mysql.rb
+- lib/ffi-mysql/mysql.rb.rej
 - lib/ffi-mysql/result.rb
 - lib/ffi-mysql/stmt.rb
 - lib/ffi-mysql/time.rb
 - lib/ffi-mysql/version.rb
 - test/test_mysql.rb
-- test/test_mysql.rb.orig
 has_rdoc: true
 homepage: http://bitbucket.org/lyro/ffi-mysql
 licenses: []