Class | Sequel::Mysql2::Database
In: | lib/sequel/adapters/mysql2.rb
Parent: | Sequel::Database

Database class for MySQL databases used with Sequel.

### Methods

connect dataset execute server_version

### Included Modules

Sequel::MySQL::DatabaseMethods

### Constants

MYSQL_DATABASE_DISCONNECT_ERRORS | = | /\A(Commands out of sync; you can't run this command now|Can't connect to local MySQL server through socket|MySQL server has gone away)/ |  | Mysql::Error messages that indicate the current connection should be disconnected

### Public Instance methods

connect(server)

Connect to the database. In addition to the usual database options, the following options have effect:

- :auto_is_null - Set to true to use MySQL default behavior of having a filter for an autoincrement column equals NULL to return the last inserted row.
- :charset - Same as :encoding (:encoding takes precendence)
- :compress - Set to false to not compress results from the server
- :config_default_group - The default group to read from the in the MySQL config file.
- :config_local_infile - If provided, sets the Mysql::OPT_LOCAL_INFILE option on the connection with the given value.
- :connect_timeout - Set the timeout in seconds before a connection attempt is abandoned.
- :encoding - Set all the related character sets for this connection (connection, client, database, server, and results).
- :socket - Use a unix socket file instead of connecting via TCP/IP.
- :timeout - Set the timeout in seconds before the server will disconnect this connection (a.k.a. @@wait_timeout).

[Source]

        # File lib/sequel/adapters/mysql2.rb, line 36
    36:       def connect(server)
    37:         opts = server_opts(server)
    38:         opts[:host] ||= 'localhost'
    39:         opts[:username] ||= opts[:user]
    40:         conn = ::Mysql2::Client.new(opts)
    41:
    42:         sqls = []
    43:         # Set encoding a slightly different way after connecting,
    44:         # in case the READ_DEFAULT_GROUP overrode the provided encoding.
    45:         # Doesn't work across implicit reconnects, but Sequel doesn't turn on
    46:         # that feature.
    47:         if encoding = opts[:encoding] || opts[:charset]
    48:           sqls << "SET NAMES #{conn.escape(encoding.to_s)}"
    49:         end
    50:
    51:         # Increase timeout so mysql server doesn't disconnect us.
    52:         # Value used by default is maximum allowed value on Windows.
    53:         sqls << "SET @@wait_timeout = #{opts[:timeout] || 2147483}"
    54:
    55:         # By default, MySQL 'where id is null' selects the last inserted id
    56:         sqls << "SET SQL_AUTO_IS_NULL=0" unless opts[:auto_is_null]
    57:
    58:         sqls.each{|sql| log_yield(sql){conn.query(sql)}}
    59:
    60:         conn
    61:       end

dataset(opts = nil)

Returns instance of Sequel::MySQL::Dataset with the given options.

[Source]

        # File lib/sequel/adapters/mysql2.rb, line 64
    64:       def dataset(opts = nil)
    65:         Mysql2::Dataset.new(self, opts)
    66:       end

execute(sql, opts={}, &block)

Executes the given SQL using an available connection, yielding the connection if the block is given.

[Source]

        # File lib/sequel/adapters/mysql2.rb, line 70
    70:       def execute(sql, opts={}, &block)
    71:         if opts[:sproc]
    72:           call_sproc(sql, opts, &block)
    73:         else
    74:           synchronize(opts[:server]){|conn| _execute(conn, sql, opts, &block)}
    75:         end
    76:       end

server_version(server=nil)

Return the version of the MySQL server two which we are connecting.

[Source]

        # File lib/sequel/adapters/mysql2.rb, line 79
    79:       def server_version(server=nil)
    80:         @server_version ||= (synchronize(server){|conn| conn.server_info[:id]} || super)
    81:       end

[Validate]