Class: Sequel::Mysql2::Database

Inherits:
Database show all
Includes:
Sequel::MySQL::DatabaseMethods
Defined in:
lib/sequel/adapters/mysql2.rb

Overview

Database class for MySQL databases used with Sequel.

Constant Summary collapse

MYSQL_DATABASE_DISCONNECT_ERRORS =

Mysql::Error messages that indicate the current connection should be disconnected

/\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)/

Constants included from Sequel::MySQL::DatabaseMethods

Sequel::MySQL::DatabaseMethods::AUTO_INCREMENT, Sequel::MySQL::DatabaseMethods::CAST_TYPES, Sequel::MySQL::DatabaseMethods::COLUMN_DEFINITION_ORDER, Sequel::MySQL::DatabaseMethods::PRIMARY

Constants inherited from Database

Database::ADAPTERS, Database::AUTOINCREMENT, Database::CASCADE, Database::COLUMN_DEFINITION_ORDER, Database::COMMA_SEPARATOR, Database::MSSQL_DEFAULT_RE, Database::MYSQL_TIMESTAMP_RE, Database::NOT_NULL, Database::NO_ACTION, Database::NULL, Database::POSTGRES_DEFAULT_RE, Database::PRIMARY_KEY, Database::RESTRICT, Database::SET_DEFAULT, Database::SET_NULL, Database::SQL_BEGIN, Database::SQL_COMMIT, Database::SQL_RELEASE_SAVEPOINT, Database::SQL_ROLLBACK, Database::SQL_ROLLBACK_TO_SAVEPOINT, Database::SQL_SAVEPOINT, Database::STRING_DEFAULT_RE, Database::TEMPORARY, Database::TRANSACTION_BEGIN, Database::TRANSACTION_COMMIT, Database::TRANSACTION_ISOLATION_LEVELS, Database::TRANSACTION_ROLLBACK, Database::UNDERSCORE, Database::UNIQUE, Database::UNSIGNED

Instance Attribute Summary

Attributes inherited from Database

#default_schema, #log_warn_duration, #loggers, #opts, #pool, #prepared_statements, #sql_log_level, #transaction_isolation_level

Instance Method Summary collapse

Methods included from Sequel::MySQL::DatabaseMethods

#cast_type_literal, #commit_prepared_transaction, #database_type, #indexes, #rollback_prepared_transaction, #supports_create_table_if_not_exists?, #supports_prepared_transactions?, #supports_savepoints?, #supports_transaction_isolation_levels?, #tables, #use, #views

Methods inherited from Database

#<<, #[], adapter_class, #adapter_scheme, adapter_scheme, #add_column, #add_index, #add_servers, #alter_table, #call, #cast_type_literal, connect, #create_or_replace_view, #create_table, #create_table!, #create_table?, #create_view, #database_type, #disconnect, #drop_column, #drop_index, #drop_table, #drop_view, #dump_indexes_migration, #dump_schema_migration, #dump_table_schema, #each_server, #execute_ddl, #execute_dui, #execute_insert, #fetch, #from, #get, identifier_input_method, #identifier_input_method, identifier_input_method=, #identifier_input_method=, identifier_output_method, #identifier_output_method, #identifier_output_method=, identifier_output_method=, #indexes, #initialize, #inspect, #literal, #log_info, #log_yield, #logger=, #query, quote_identifiers=, #quote_identifiers=, #quote_identifiers?, #remove_servers, #rename_column, #rename_table, #run, #schema, #select, #serial_primary_key_options, #servers, #set_column_default, #set_column_type, single_threaded=, #single_threaded?, #supports_create_table_if_not_exists?, #supports_prepared_transactions?, #supports_savepoints?, #supports_transaction_isolation_levels?, #synchronize, #table_exists?, #tables, #test_connection, #transaction, #typecast_value, #uri, #url, #views

Methods included from Sequel::Metaprogramming

#meta_def

Constructor Details

This class inherits a constructor from Sequel::Database

Instance Method Details

#connect(server) ⇒ Object

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).



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/sequel/adapters/mysql2.rb', line 36

def connect(server)
  opts = server_opts(server)
  opts[:host] ||= 'localhost'
  opts[:username] ||= opts[:user]
  conn = ::Mysql2::Client.new(opts)

  sqls = []
  # Set encoding a slightly different way after connecting,
  # in case the READ_DEFAULT_GROUP overrode the provided encoding.
  # Doesn't work across implicit reconnects, but Sequel doesn't turn on
  # that feature.
  if encoding = opts[:encoding] || opts[:charset]
    sqls << "SET NAMES #{conn.escape(encoding.to_s)}"
  end

  # Increase timeout so mysql server doesn't disconnect us.
  # Value used by default is maximum allowed value on Windows.
  sqls << "SET @@wait_timeout = #{opts[:timeout] || 2147483}"

  # By default, MySQL 'where id is null' selects the last inserted id
  sqls << "SET SQL_AUTO_IS_NULL=0" unless opts[:auto_is_null]

  sqls.each{|sql| log_yield(sql){conn.query(sql)}}

  conn
end

#dataset(opts = nil) ⇒ Object

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



64
65
66
 
# File 'lib/sequel/adapters/mysql2.rb', line 64

def dataset(opts = nil)
  Mysql2::Dataset.new(self, opts)
end

#execute(sql, opts = {}, &block) ⇒ Object

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



70
71
72
73
74
75
76
 
# File 'lib/sequel/adapters/mysql2.rb', line 70

def execute(sql, opts={}, &block)
  if opts[:sproc]
    call_sproc(sql, opts, &block)
  else
    synchronize(opts[:server]){|conn| _execute(conn, sql, opts, &block)}
  end
end

#server_version(server = nil) ⇒ Object

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



79
80
81
 
# File 'lib/sequel/adapters/mysql2.rb', line 79

def server_version(server=nil)
  @server_version ||= (synchronize(server){|conn| conn.server_info[:id]} || super)
end