/usr/lib/ruby/vendor_ruby/sequel/adapters/ibmdb.rb is in ruby-sequel 4.15.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 | require 'ibm_db'
Sequel.require 'adapters/shared/db2'
module Sequel
module IBMDB
@convert_smallint_to_bool = true
class << self
# Whether to convert smallint values to bool, true by default.
# Can also be overridden per dataset.
attr_accessor :convert_smallint_to_bool
end
tt = Class.new do
def boolean(s) !s.to_i.zero? end
def int(s) s.to_i end
end.new
# Hash holding type translation methods, used by Dataset#fetch_rows.
DB2_TYPES = {
:boolean => tt.method(:boolean),
:int => tt.method(:int),
:blob => ::Sequel::SQL::Blob.method(:new),
:time => ::Sequel.method(:string_to_time),
:date => ::Sequel.method(:string_to_date)
}
# Wraps an underlying connection to DB2 using IBM_DB.
class Connection
# A hash with prepared statement name symbol keys, where each value is
# a two element array with an sql string and cached Statement value.
attr_accessor :prepared_statements
# Error class for exceptions raised by the connection.
class Error < StandardError
attr_reader :sqlstate
def initialize(message, sqlstate)
@sqlstate = sqlstate
super(message)
end
end
# Create the underlying IBM_DB connection.
def initialize(connection_param)
@conn = if connection_param.class == String
IBM_DB.connect(connection_param, '', '')
else # connect using catalog
IBM_DB.connect(*connection_param)
end
self.autocommit = true
@prepared_statements = {}
end
# Check whether the connection is in autocommit state or not.
def autocommit
IBM_DB.autocommit(@conn) == 1
end
# Turn autocommit on or off for the connection.
def autocommit=(value)
IBM_DB.autocommit(@conn, value ? IBM_DB::SQL_AUTOCOMMIT_ON : IBM_DB::SQL_AUTOCOMMIT_OFF)
end
# Close the connection, disconnecting from DB2.
def close
IBM_DB.close(@conn)
end
# Commit the currently outstanding transaction on this connection.
def commit
IBM_DB.commit(@conn)
end
# Return the related error message for the connection.
def error_msg
IBM_DB.getErrormsg(@conn, IBM_DB::DB_CONN)
end
# Return the related error message for the connection.
def error_sqlstate
IBM_DB.getErrorstate(@conn, IBM_DB::DB_CONN)
end
# Execute the given SQL on the database, and return a Statement instance
# holding the results.
def execute(sql)
stmt = IBM_DB.exec(@conn, sql)
raise Error.new(error_msg, error_sqlstate) unless stmt
Statement.new(stmt)
end
# Execute the related prepared statement on the database with the given
# arguments.
def execute_prepared(ps_name, *values)
stmt = @prepared_statements[ps_name].last
res = stmt.execute(*values)
unless res
raise Error.new("Error executing statement #{ps_name}: #{error_msg}", error_sqlstate)
end
stmt
end
# Prepare a statement with the given +sql+ on the database, and
# cache the prepared statement value by name.
def prepare(sql, ps_name)
if stmt = IBM_DB.prepare(@conn, sql)
ps_name = ps_name.to_sym
stmt = Statement.new(stmt)
@prepared_statements[ps_name] = [sql, stmt]
else
err = error_msg
err = "Error preparing #{ps_name} with SQL: #{sql}" if error_msg.nil? || error_msg.empty?
raise Error.new(err, error_sqlstate)
end
end
# Rollback the currently outstanding transaction on this connection.
def rollback
IBM_DB.rollback(@conn)
end
end
# Wraps results returned by queries on IBM_DB.
class Statement
# Hold the given statement.
def initialize(stmt)
@stmt = stmt
end
# Return the number of rows affected.
def affected
IBM_DB.num_rows(@stmt)
end
# If this statement is a prepared statement, execute it on the database
# with the given values.
def execute(*values)
IBM_DB.execute(@stmt, values)
end
# Return the results of a query as an array of values.
def fetch_array
IBM_DB.fetch_array(@stmt) if @stmt
end
# Return the field name at the given column in the result set.
def field_name(ind)
IBM_DB.field_name(@stmt, ind)
end
# Return the field type for the given field name in the result set.
def field_type(key)
IBM_DB.field_type(@stmt, key)
end
# Return the field precision for the given field name in the result set.
def field_precision(key)
IBM_DB.field_precision(@stmt, key)
end
# Free the memory related to this statement.
def free
IBM_DB.free_stmt(@stmt)
end
# Free the memory related to this result set, only useful for prepared
# statements which have a different result set on every call.
def free_result
IBM_DB.free_result(@stmt)
end
# Return the number of fields in the result set.
def num_fields
IBM_DB.num_fields(@stmt)
end
end
class Database < Sequel::Database
include Sequel::DB2::DatabaseMethods
set_adapter_scheme :ibmdb
# Hash of connection procs for converting
attr_reader :conversion_procs
# REORG the related table whenever it is altered. This is not always
# required, but it is necessary for compatibilty with other Sequel
# code in many cases.
def alter_table(name, generator=nil)
res = super
reorg(name)
res
end
# Create a new connection object for the given server.
def connect(server)
opts = server_opts(server)
connection_params = if opts[:host].nil? && opts[:port].nil? && opts[:database]
# use a cataloged connection
opts.values_at(:database, :user, :password)
else
# use uncataloged connection so that host and port can be supported
'Driver={IBM DB2 ODBC DRIVER};' \
"Database=#{opts[:database]};" \
"Hostname=#{opts[:host]};" \
"Port=#{opts[:port] || 50000};" \
'Protocol=TCPIP;' \
"Uid=#{opts[:user]};" \
"Pwd=#{opts[:password]};" \
end
Connection.new(connection_params)
end
# Execute the given SQL on the database.
def execute(sql, opts=OPTS, &block)
if sql.is_a?(Symbol)
execute_prepared_statement(sql, opts, &block)
else
synchronize(opts[:server]){|c| _execute(c, sql, opts, &block)}
end
rescue Connection::Error => e
raise_error(e)
end
# Execute the given SQL on the database, returning the last inserted
# identity value.
def execute_insert(sql, opts=OPTS)
synchronize(opts[:server]) do |c|
if sql.is_a?(Symbol)
execute_prepared_statement(sql, opts)
else
_execute(c, sql, opts)
end
_execute(c, "SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1", opts){|stmt| i = stmt.fetch_array.first.to_i; i}
end
rescue Connection::Error => e
raise_error(e)
end
# Execute a prepared statement named by name on the database.
def execute_prepared_statement(ps_name, opts)
args = opts[:arguments]
ps = prepared_statement(ps_name)
sql = ps.prepared_sql
synchronize(opts[:server]) do |conn|
unless conn.prepared_statements.fetch(ps_name, []).first == sql
log_yield("PREPARE #{ps_name}: #{sql}"){conn.prepare(sql, ps_name)}
end
args = args.map{|v| v.nil? ? nil : prepared_statement_arg(v)}
log_sql = "EXECUTE #{ps_name}"
if ps.log_sql
log_sql << " ("
log_sql << sql
log_sql << ")"
end
begin
stmt = log_yield(log_sql, args){conn.execute_prepared(ps_name, *args)}
if block_given?
yield(stmt)
else
stmt.affected
end
ensure
stmt.free_result if stmt
end
end
end
# On DB2, a table might need to be REORGed if you are testing existence
# of it. This REORGs automatically if the database raises a specific
# error that indicates it should be REORGed.
def table_exists?(name)
v ||= false # only retry once
sch, table_name = schema_and_table(name)
name = SQL::QualifiedIdentifier.new(sch, table_name) if sch
from(name).first
true
rescue DatabaseError => e
if e.to_s =~ /Operation not allowed for reason code "7" on table/ && v == false
# table probably needs reorg
reorg(name)
v = true
retry
end
false
end
private
# Execute the given SQL on the database.
def _execute(conn, sql, opts)
stmt = log_yield(sql){conn.execute(sql)}
if block_given?
yield(stmt)
else
stmt.affected
end
ensure
stmt.free if stmt
end
def adapter_initialize
@conversion_procs = DB2_TYPES.dup
@conversion_procs[:timestamp] = method(:to_application_timestamp)
end
# IBM_DB uses an autocommit setting instead of sending SQL queries.
# So starting a transaction just turns autocommit off.
def begin_transaction(conn, opts=OPTS)
log_yield(TRANSACTION_BEGIN){conn.autocommit = false}
set_transaction_isolation(conn, opts)
end
# This commits transaction in progress on the
# connection and sets autocommit back on.
def commit_transaction(conn, opts=OPTS)
log_yield(TRANSACTION_COMMIT){conn.commit}
end
def database_error_classes
[Connection::Error]
end
def database_exception_sqlstate(exception, opts)
exception.sqlstate
end
# Don't convert smallint to boolean for the metadata
# dataset, since the DB2 metadata does not use
# boolean columns, and some smallint columns are
# accidently treated as booleans.
def metadata_dataset
ds = super
ds.convert_smallint_to_bool = false
ds
end
# Format Numeric, Date, and Time types specially for use
# as IBM_DB prepared statements argument vlaues.
def prepared_statement_arg(v)
case v
when Numeric
v.to_s
when Date, Time
literal(v).gsub("'", '')
else
v
end
end
# Set autocommit back on
def remove_transaction(conn, committed)
conn.autocommit = true
ensure
super
end
# This rolls back the transaction in progress on the
# connection and sets autocommit back on.
def rollback_transaction(conn, opts=OPTS)
log_yield(TRANSACTION_ROLLBACK){conn.rollback}
end
# Convert smallint type to boolean if convert_smallint_to_bool is true
def schema_column_type(db_type)
if Sequel::IBMDB.convert_smallint_to_bool && db_type =~ /smallint/i
:boolean
else
super
end
end
end
class Dataset < Sequel::Dataset
include Sequel::DB2::DatasetMethods
Database::DatasetClass = self
module CallableStatementMethods
# Extend given dataset with this module so subselects inside subselects in
# prepared statements work.
def subselect_sql_append(sql, ds)
ps = ds.to_prepared_statement(:select).clone(:append_sql=>sql)
ps.extend(CallableStatementMethods)
ps = ps.bind(@opts[:bind_vars]) if @opts[:bind_vars]
ps.prepared_args = prepared_args
ps.prepared_sql
end
end
# Methods for DB2 prepared statements using the native driver.
module PreparedStatementMethods
include Sequel::Dataset::UnnumberedArgumentMapper
private
# Execute the prepared statement with arguments instead of the given SQL.
def execute(sql, opts=OPTS, &block)
super(prepared_statement_name, {:arguments=>bind_arguments}.merge(opts), &block)
end
# Execute the prepared statment with arguments instead of the given SQL.
def execute_dui(sql, opts=OPTS, &block)
super(prepared_statement_name, {:arguments=>bind_arguments}.merge(opts), &block)
end
# Execute the prepared statement with arguments instead of the given SQL.
def execute_insert(sql, opts=OPTS, &block)
super(prepared_statement_name, {:arguments=>bind_arguments}.merge(opts), &block)
end
end
# Emulate support of bind arguments in called statements.
def call(type, bind_arguments={}, *values, &block)
ps = to_prepared_statement(type, values)
ps.extend(CallableStatementMethods)
ps.call(bind_arguments, &block)
end
# Whether to convert smallint to boolean arguments for this dataset.
# Defaults to the IBMDB module setting.
def convert_smallint_to_bool
defined?(@convert_smallint_to_bool) ? @convert_smallint_to_bool : (@convert_smallint_to_bool = IBMDB.convert_smallint_to_bool)
end
# Override the default IBMDB.convert_smallint_to_bool setting for this dataset.
attr_writer :convert_smallint_to_bool
# Fetch the rows from the database and yield plain hashes.
def fetch_rows(sql)
execute(sql) do |stmt|
columns = []
convert = convert_smallint_to_bool
cps = db.conversion_procs
stmt.num_fields.times do |i|
k = stmt.field_name i
key = output_identifier(k)
type = stmt.field_type(i).downcase.to_sym
# decide if it is a smallint from precision
type = :boolean if type == :int && convert && stmt.field_precision(i) < 8
type = :blob if type == :clob && Sequel::DB2.use_clob_as_blob
columns << [key, cps[type]]
end
cols = columns.map{|c| c.at(0)}
@columns = cols
while res = stmt.fetch_array
row = {}
res.zip(columns).each do |v, (k, pr)|
row[k] = ((pr ? pr.call(v) : v) if v)
end
yield row
end
end
self
end
# Store the given type of prepared statement in the associated database
# with the given name.
def prepare(type, name=nil, *values)
ps = to_prepared_statement(type, values)
ps.extend(PreparedStatementMethods)
if name
ps.prepared_statement_name = name
db.set_prepared_statement(name, ps)
end
ps
end
end
end
end
|