Class: Sequel::MySQL::Database

Inherits:
Database show all
Includes:
DatabaseMethods, MysqlMysql2::DatabaseMethods, PreparedStatements::DatabaseMethods
Defined in:
lib/sequel/adapters/mysql.rb

Constant Summary

Constants included from MysqlMysql2::DatabaseMethods

MysqlMysql2::DatabaseMethods::MYSQL_DATABASE_DISCONNECT_ERRORS

Constants included from DatabaseMethods

Sequel::MySQL::DatabaseMethods::CAST_TYPES, Sequel::MySQL::DatabaseMethods::COLUMN_DEFINITION_ORDER

Constants inherited from Database

Database::ADAPTERS, Database::COLUMN_DEFINITION_ORDER, Database::COLUMN_SCHEMA_DATETIME_TYPES, Database::COLUMN_SCHEMA_STRING_TYPES, Database::COMBINABLE_ALTER_TABLE_OPS, Database::DEFAULT_DATABASE_ERROR_REGEXPS, Database::DEFAULT_STRING_COLUMN_SIZE, Database::EXTENSIONS, Database::OPTS, Database::SCHEMA_TYPE_CLASSES, Database::TRANSACTION_ISOLATION_LEVELS

Instance Attribute Summary collapse

Attributes included from DatabaseMethods

#default_charset, #default_collate, #default_engine

Attributes inherited from Database

#cache_schema, #dataset_class, #default_string_column_size, #log_connection_info, #log_warn_duration, #loggers, #opts, #pool, #prepared_statements, #sql_log_level, #timezone, #transaction_isolation_level

Instance Method Summary collapse

Methods included from MysqlMysql2::DatabaseMethods

#call_sproc, #execute

Methods included from DatabaseMethods

#cast_type_literal, #commit_prepared_transaction, #database_type, #foreign_key_list, #global_index_namespace?, #indexes, #mariadb?, #rename_tables, #rollback_prepared_transaction, #server_version, #supports_create_table_if_not_exists?, #supports_generated_columns?, #supports_prepared_transactions?, #supports_savepoints?, #supports_savepoints_in_prepared_transactions?, #supports_timestamp_usecs?, #supports_transaction_isolation_levels?, #tables, #views

Methods inherited from Database

#<<, #[], adapter_class, #adapter_scheme, adapter_scheme, #add_column, #add_index, #add_servers, #after_commit, after_initialize, #after_rollback, #alter_table, #alter_table_generator, #call, #cast_type_literal, connect, #create_join_table, #create_join_table!, #create_join_table?, #create_or_replace_view, #create_table, #create_table!, #create_table?, #create_table_generator, #create_view, #database_type, #dataset, #disconnect, #drop_column, #drop_index, #drop_join_table, #drop_table, #drop_table?, #drop_view, #execute_ddl, #extend_datasets, extension, #extension, #fetch, #from, #from_application_timestamp, #get, #global_index_namespace?, #in_transaction?, #initialize, #inspect, #literal, #literal_symbol, #literal_symbol_set, load_adapter, #log_connection_yield, #log_exception, #log_info, #logger=, #prepared_statement, #quote_identifier, register_extension, #remove_servers, #rename_column, #rename_table, #rollback_checker, #rollback_on_exit, #run, run_after_initialize, #schema, #schema_type_class, #select, #serial_primary_key_options, #servers, #set_column_default, #set_column_type, #set_prepared_statement, set_shared_adapter_scheme, #sharded?, #single_threaded?, #supports_create_table_if_not_exists?, #supports_deferrable_constraints?, #supports_deferrable_foreign_key_constraints?, #supports_drop_table_if_exists?, #supports_foreign_key_parsing?, #supports_index_parsing?, #supports_partial_indexes?, #supports_prepared_transactions?, #supports_savepoints?, #supports_savepoints_in_prepared_transactions?, #supports_schema_parsing?, #supports_table_listing?, #supports_transaction_isolation_levels?, #supports_transactional_ddl?, #supports_view_listing?, #supports_views_with_check_option?, #supports_views_with_local_check_option?, #synchronize, #table_exists?, #test_connection, #to_application_timestamp, #transaction, #typecast_value, #uri, #url, #valid_connection?

Constructor Details

This class inherits a constructor from Sequel::Database

Instance Attribute Details

#conversion_procs ⇒ Object (readonly)

Hash of conversion procs for the current database


40
41
42
 
# File 'lib/sequel/adapters/mysql.rb', line 40

def conversion_procs
  @conversion_procs
end

#convert_invalid_date_time ⇒ Object

By default, Sequel raises an exception if in invalid date or time is used. However, if this is set to nil or :nil, the adapter treats dates like 0000-00-00 and times like 838:00:00 as nil values. If set to :string, it returns the strings as is.


49
50
51
 
# File 'lib/sequel/adapters/mysql.rb', line 49

def convert_invalid_date_time
  @convert_invalid_date_time
end

#convert_tinyint_to_bool ⇒ Object

Whether to convert tinyint columns to bool for the current database


43
44
45
 
# File 'lib/sequel/adapters/mysql.rb', line 43

def convert_tinyint_to_bool
  @convert_tinyint_to_bool
end

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

:read_timeout

Set the timeout in seconds for reading back results to a query.

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


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/sequel/adapters/mysql.rb', line 72

def connect(server)
  opts = server_opts(server)

  if Mysql.respond_to?(:init)
    conn = Mysql.init
    conn.options(Mysql::READ_DEFAULT_GROUP, opts[:config_default_group] || "client")
    conn.options(Mysql::OPT_LOCAL_INFILE, opts[:config_local_infile]) if opts.has_key?(:config_local_infile)
    if encoding = opts[:encoding] || opts[:charset]
      # Set encoding before connecting so that the mysql driver knows what
      # encoding we want to use, but this can be overridden by READ_DEFAULT_GROUP.
      conn.options(Mysql::SET_CHARSET_NAME, encoding)
    end
    if read_timeout = opts[:read_timeout] and defined? Mysql::OPT_READ_TIMEOUT
      conn.options(Mysql::OPT_READ_TIMEOUT, read_timeout)
    end
    if connect_timeout = opts[:connect_timeout] and defined? Mysql::OPT_CONNECT_TIMEOUT
      conn.options(Mysql::OPT_CONNECT_TIMEOUT, connect_timeout)
    end
  else
    # ruby-mysql 3 API
    conn = Mysql.new
    # no support for default group
    conn.local_infile = opts[:config_local_infile] if opts.has_key?(:config_local_infile)
    if encoding = opts[:encoding] || opts[:charset]
      conn.charset = encoding
    end
    if read_timeout = opts[:read_timeout]
      conn.read_timeout = read_timeout
    end
    if connect_timeout = opts[:connect_timeout]
      conn.connect_timeout = connect_timeout
    end
    conn.singleton_class.class_eval do
      alias real_connect connect
      alias use_result store_result
    end
  end

  conn.ssl_set(opts[:sslkey], opts[:sslcert], opts[:sslca], opts[:sslcapath], opts[:sslcipher]) if opts[:sslca] || opts[:sslkey]
  conn.real_connect(
    opts[:host] || 'localhost',
    opts[:user],
    opts[:password],
    opts[:database],
    (opts[:port].to_i if opts[:port]),
    opts[:socket],
    Mysql::CLIENT_MULTI_RESULTS +
    Mysql::CLIENT_MULTI_STATEMENTS +
    (opts[:compress] == false ? 0 : Mysql::CLIENT_COMPRESS)
  )
  sqls = mysql_connection_setting_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.
  sqls.unshift("SET NAMES #{literal(encoding.to_s)}") if encoding

  sqls.each{|sql| log_connection_yield(sql, conn){conn.query(sql)}}

  add_prepared_statements_cache(conn)
  conn
end

#disconnect_connection(c) ⇒ Object 


136
137
138
139
140
 
# File 'lib/sequel/adapters/mysql.rb', line 136

def disconnect_connection(c)
  c.close
rescue Mysql::Error
  nil
end

#execute_dui(sql, opts = OPTS) ⇒ Object 


163
164
165
 
# File 'lib/sequel/adapters/mysql.rb', line 163

def execute_dui(sql, opts=OPTS)
  execute(sql, opts){|c| return affected_rows(c)}
end

#execute_insert(sql, opts = OPTS) ⇒ Object 


167
168
169
 
# File 'lib/sequel/adapters/mysql.rb', line 167

def execute_insert(sql, opts=OPTS)
  execute(sql, opts){|c| return c.insert_id}
end

#freeze ⇒ Object 


171
172
173
174
175
 
# File 'lib/sequel/adapters/mysql.rb', line 171

def freeze
  server_version
  @conversion_procs.freeze
  super
end