1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 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 62 63 64 65 66 67 68 69 70 71 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 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
|
# frozen-string-literal: true
require 'mysql2'
require_relative 'utils/mysql_mysql2'
module Sequel
module Mysql2
NativePreparedStatements = if ::Mysql2::VERSION >= '0.4'
true
else
require_relative 'utils/mysql_prepared_statements'
false
end
class Database < Sequel::Database
include Sequel::MySQL::DatabaseMethods
include Sequel::MySQL::MysqlMysql2::DatabaseMethods
include Sequel::MySQL::PreparedStatements::DatabaseMethods unless NativePreparedStatements
set_adapter_scheme :mysql2
# Whether to convert tinyint columns to bool for this database
attr_accessor :convert_tinyint_to_bool
# 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)
# :encoding :: Set all the related character sets for this
# connection (connection, client, database, server, and results).
#
# The options hash is also passed to mysql2, and can include mysql2
# options such as :local_infile.
def connect(server)
opts = server_opts(server)
opts[:username] ||= opts.delete(:user)
opts[:flags] ||= 0
opts[:flags] |= ::Mysql2::Client::FOUND_ROWS if ::Mysql2::Client.const_defined?(:FOUND_ROWS)
opts[:encoding] ||= opts[:charset]
conn = ::Mysql2::Client.new(opts)
conn.query_options.merge!(:symbolize_keys=>true, :cache_rows=>false)
if NativePreparedStatements
conn.instance_variable_set(:@sequel_default_query_options, conn.query_options.dup)
end
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.
if encoding = opts[:encoding]
sqls.unshift("SET NAMES #{conn.escape(encoding.to_s)}")
end
sqls.each{|sql| log_connection_yield(sql, conn){conn.query(sql)}}
add_prepared_statements_cache(conn)
conn
end
def execute_dui(sql, opts=OPTS)
execute(sql, opts){|c| return c.affected_rows}
end
def execute_insert(sql, opts=OPTS)
execute(sql, opts){|c| return c.last_id}
end
def freeze
server_version
super
end
# Return the version of the MySQL server to which we are connecting.
def server_version(_server=nil)
@server_version ||= super()
end
private
if NativePreparedStatements
# Use a native mysql2 prepared statement to implement prepared statements.
def execute_prepared_statement(ps_name, opts, &block)
if ps_name.is_a?(Sequel::Dataset::ArgumentMapper)
ps = ps_name
ps_name = ps.prepared_statement_name
else
ps = prepared_statement(ps_name)
end
sql = ps.prepared_sql
synchronize(opts[:server]) do |conn|
stmt, ps_sql = conn.prepared_statements[ps_name]
unless ps_sql == sql
stmt.close if stmt
stmt = log_connection_yield("Preparing #{ps_name}: #{sql}", conn){conn.prepare(sql)}
conn.prepared_statements[ps_name] = [stmt, sql]
end
opts = Hash[opts]
opts[:sql] = "Executing #{ps_name || sql}"
if ps_name && ps.log_sql
opts[:log_sql] = " (#{sql})"
end
_execute(conn, stmt, opts, &block)
end
end
end
# Execute the given SQL on the given connection. If the :type
# option is :select, yield the result of the query, otherwise
# yield the connection if a block is given.
def _execute(conn, sql, opts)
stream = opts[:stream]
if NativePreparedStatements
if args = opts[:arguments]
args = args.map{|arg| bound_variable_value(arg)}
end
case sql
when ::Mysql2::Statement
stmt = sql
sql = opts[:sql] || ''
when Dataset
sql = sql.sql
close_stmt = true
stmt = conn.prepare(sql)
end
end
r = log_connection_yield((log_sql = opts[:log_sql]) ? sql + log_sql : sql, conn, args) do
if stmt
conn.query_options.merge!(:cache_rows=>true, :database_timezone => timezone, :application_timezone => Sequel.application_timezone, :stream=>stream, :cast_booleans=>convert_tinyint_to_bool)
stmt.execute(*args)
else
conn.query(sql, :database_timezone => timezone, :application_timezone => Sequel.application_timezone, :stream=>stream)
end
end
if opts[:type] == :select
if r
if stream
begin
r2 = yield r
ensure
# If r2 is nil, it means the block did not exit normally,
# so the rest of the results must be drained to prevent
# "commands out of sync" errors.
r.each{} unless r2
end
else
yield r
end
end
elsif defined?(yield)
yield conn
end
rescue ::Mysql2::Error => e
raise_error(e)
ensure
if stmt
conn.query_options.replace(conn.instance_variable_get(:@sequel_default_query_options))
stmt.close if close_stmt
end
end
# Set the convert_tinyint_to_bool setting based on the default value.
def adapter_initialize
self.convert_tinyint_to_bool = true
end
if NativePreparedStatements
# Handle bound variable arguments that Mysql2 does not handle natively.
def bound_variable_value(arg)
case arg
when true
1
when false
0
when DateTime, Time
literal(arg)[1...-1]
else
arg
end
end
end
def connection_execute_method
:query
end
def database_error_classes
[::Mysql2::Error]
end
def database_exception_sqlstate(exception, opts)
state = exception.sql_state
state unless state == 'HY000'
end
def dataset_class_default
Dataset
end
# If a connection object is available, try pinging it. Otherwise, if the
# error is a Mysql2::Error, check the SQL state and exception message for
# disconnects.
def disconnect_error?(e, opts)
super ||
((conn = opts[:conn]) && !conn.ping) ||
(e.is_a?(::Mysql2::Error) &&
(e.sql_state =~ /\A08/ ||
MYSQL_DATABASE_DISCONNECT_ERRORS.match(e.message)))
end
# Convert tinyint(1) type to boolean if convert_tinyint_to_bool is true
def schema_column_type(db_type)
convert_tinyint_to_bool && db_type =~ /\Atinyint\(1\)/ ? :boolean : super
end
end
class Dataset < Sequel::Dataset
include Sequel::MySQL::DatasetMethods
include Sequel::MySQL::MysqlMysql2::DatasetMethods
include Sequel::MySQL::PreparedStatements::DatasetMethods unless NativePreparedStatements
STREAMING_SUPPORTED = ::Mysql2::VERSION >= '0.3.12'
if NativePreparedStatements
PreparedStatementMethods = prepared_statements_module(
"sql = self; opts = Hash[opts]; opts[:arguments] = bind_arguments",
Sequel::Dataset::UnnumberedArgumentMapper,
%w"execute execute_dui execute_insert")
end
def fetch_rows(sql)
execute(sql) do |r|
self.columns = r.fields.map!{|c| output_identifier(c.to_s)}
r.each(:cast_booleans=>convert_tinyint_to_bool?){|h| yield h}
end
self
end
# Use streaming to implement paging if Mysql2 supports it and
# it hasn't been disabled.
def paged_each(opts=OPTS, &block)
if STREAMING_SUPPORTED && opts[:stream] != false
unless defined?(yield)
return enum_for(:paged_each, opts)
end
stream.each(&block)
else
super
end
end
# Return a clone of the dataset that will stream rows when iterating
# over the result set, so it can handle large datasets that
# won't fit in memory (Requires mysql 0.3.12+ to have an effect).
def stream
clone(:stream=>true)
end
private
# Whether to cast tinyint(1) columns to integer instead of boolean.
# By default, uses the database's convert_tinyint_to_bool
# setting. Exists for compatibility with the mysql adapter.
def convert_tinyint_to_bool?
@db.convert_tinyint_to_bool
end
def execute(sql, opts=OPTS)
opts = Hash[opts]
opts[:type] = :select
opts[:stream] = @opts[:stream]
super
end
if NativePreparedStatements
def bound_variable_modules
[PreparedStatementMethods]
end
def prepared_statement_modules
[PreparedStatementMethods]
end
end
# Handle correct quoting of strings using ::Mysql2::Client#escape.
def literal_string_append(sql, v)
sql << "'" << db.synchronize(@opts[:server]){|c| c.escape(v)} << "'"
end
end
end
end
|