Class: Sequel::MySQL::Database
- 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
-
#conversion_procs ⇒ Object
readonly
Hash of conversion procs for the current database.
-
#convert_invalid_date_time ⇒ Object
By default, Sequel raises an exception if in invalid date or time is used.
-
#convert_tinyint_to_bool ⇒ Object
Whether to convert tinyint columns to bool for the current database.
Attributes included from DatabaseMethods
#default_charset, #default_collate, #default_engine
Attributes inherited from Database
#cache_schema, #check_string_typecast_bytesize, #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
-
#connect(server) ⇒ Object
Connect to the database.
- #disconnect_connection(c) ⇒ Object
- #execute_dui(sql, opts = OPTS) ⇒ Object
- #execute_insert(sql, opts = OPTS) ⇒ Object
- #freeze ⇒ Object
Methods included from MysqlMysql2::DatabaseMethods
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, #with_advisory_lock
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=, #new_connection, #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
55 56 57 |
# File 'lib/sequel/adapters/mysql.rb', line 55 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.
64 65 66 |
# File 'lib/sequel/adapters/mysql.rb', line 64 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
58 59 60 |
# File 'lib/sequel/adapters/mysql.rb', line 58 def @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).
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 135 136 137 138 139 140 141 142 143 144 145 146 |
# File 'lib/sequel/adapters/mysql.rb', line 87 def connect(server) opts = server_opts(server) if !RUBY_MYSQL_3 conn = Mysql.init conn.(Mysql::READ_DEFAULT_GROUP, opts[:config_default_group] || "client") conn.(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.(Mysql::SET_CHARSET_NAME, encoding) end if read_timeout = opts[:read_timeout] and defined? Mysql::OPT_READ_TIMEOUT conn.(Mysql::OPT_READ_TIMEOUT, read_timeout) end if connect_timeout = opts[:connect_timeout] and defined? Mysql::OPT_CONNECT_TIMEOUT conn.(Mysql::OPT_CONNECT_TIMEOUT, connect_timeout) end else # ruby-mysql 3+ API conn = Adapter.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 opts[:compress] = false 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
148 149 150 151 152 |
# File 'lib/sequel/adapters/mysql.rb', line 148 def disconnect_connection(c) c.close rescue Mysql::Error nil end |
#execute_dui(sql, opts = OPTS) ⇒ Object
175 176 177 |
# File 'lib/sequel/adapters/mysql.rb', line 175 def execute_dui(sql, opts=OPTS) execute(sql, opts){|c| return affected_rows(c)} end |
#execute_insert(sql, opts = OPTS) ⇒ Object
179 180 181 |
# File 'lib/sequel/adapters/mysql.rb', line 179 def execute_insert(sql, opts=OPTS) execute(sql, opts){|c| return c.insert_id} end |
#freeze ⇒ Object
183 184 185 186 187 |
# File 'lib/sequel/adapters/mysql.rb', line 183 def freeze server_version @conversion_procs.freeze super end |