Class: ActiveRecord::ConnectionAdapters::IBM_DBAdapter

Inherits:
AbstractAdapter
  • Object
show all
Includes:
QueryCache
Defined in:
lib/active_record/connection_adapters/ibm_db_adapter.rb,
lib/active_record/connection_adapters/ibm_db_pstmt.rb

Overview

The IBM_DB Adapter requires the native Ruby driver (ibm_db) for IBM data servers (ibm_db.so). config the hash passed as an initializer argument content:

mandatory parameters 

adapter:         'ibm_db'        // IBM_DB Adapter name
username:        'db2user'       // data server (database) user
password:        'secret'        // data server (database) password
database:        'ARUNIT'        // remote database name (or catalog entry alias)

optional (highly recommended for data server auditing and monitoring purposes)

schema:          'rails123'      // name space qualifier
account:         'tester'        // OS account (client workstation)
app_user:        'test11'        // authenticated application user
application:     'rtests'        // application name
workstation:     'plato'         // client workstation name

remote TCP/IP connection (required when no local database catalog entry available)

host:            'socrates'      // fully qualified hostname or IP address
port:            '50000'         // data server TCP/IP port number
security:        'SSL'           // optional parameter enabling SSL encryption -
                                 // - Available only from CLI version V95fp2 and above
authentication:  'SERVER'        // AUTHENTICATION type which the client uses - 
                                 // - to connect to the database server. By default value is SERVER
timeout:         10              // Specifies the time in seconds (0 - 32767) to wait for a reply from server -
                                 //- when trying to establish a connection before generating a timeout

Parameterized Queries Support

parameterized:  false            // Specifies if the prepared statement support of 
                                 //- the IBM_DB Adapter is to be turned on or off

When schema is not specified, the username value is used instead. The default setting of parameterized is false.

Defined Under Namespace

Classes: BindSubstitution

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from QueryCache

included, #prepared_select_with_query_cache

Constructor Details

#initialize(connection, ar3, logger, config, conn_options) ⇒ IBM_DBAdapter

Returns a new instance of IBM_DBAdapter.



574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 574

def initialize(connection, ar3, logger, config, conn_options)
  # Caching database connection configuration (+connect+ or +reconnect+ support)
  @connection       = connection
		@isAr3            = ar3
  @conn_options     = conn_options
  @database         = config[:database]
  @username         = config[:username]
  @password         = config[:password]
  if config.has_key?(:host)
    @host           = config[:host]
    @port           = config[:port] || 50000 # default port
  end
  @schema           = config[:schema]
  @security         = config[:security] || nil
  @authentication   = config[:authentication] || nil
  @timeout          = config[:timeout] || 0  # default timeout value is 0

  if( config.has_key?(:parameterized) && config[:parameterized] == true )
    @pstmt_support_on = true
    @set_quoted_literal_replacement = IBM_DB::QUOTED_LITERAL_REPLACEMENT_OFF
  else
    @pstmt_support_on = false
    @set_quoted_literal_replacement = IBM_DB::QUOTED_LITERAL_REPLACEMENT_ON
  end
  
  @app_user = @account = @application = @workstation = nil
  # Caching database connection options (auditing and billing support)
  @app_user         = conn_options[:app_user]     if conn_options.has_key?(:app_user)
  @account          = conn_options[:account]      if conn_options.has_key?(:account)
  @application      = conn_options[:application]  if conn_options.has_key?(:application)
  @workstation      = conn_options[:workstation]  if conn_options.has_key?(:workstation)
  
  @sql                  = []
  @sql_parameter_values = [] #Used only if pstmt support is turned on

  @handle_lobs_triggered = false

  # Calls the parent class +ConnectionAdapters+' initializer
  # which sets @connection, @logger, @runtime and @last_verification
  super(@connection, logger)

  if @connection
    server_info = IBM_DB.server_info( @connection )
    if( server_info )
      case server_info.DBMS_NAME
        when /DB2\//i             # DB2 for Linux, Unix and Windows (LUW)
          case server_info.DBMS_VER
            when /09.07/i          # DB2 Version 9.7 (Cobra)
              @servertype = IBM_DB2_LUW_COBRA.new(self, @isAr3)
            when /10./i #DB2 version 10.1 and above
              @servertype = IBM_DB2_LUW_COBRA.new(self, @isAr3)
            else                  # DB2 Version 9.5 or below
              @servertype = IBM_DB2_LUW.new(self, @isAr3)
          end
        when /DB2/i               # DB2 for zOS
          case server_info.DBMS_VER
            when /09/             # DB2 for zOS version 9 and version 10
              @servertype = IBM_DB2_ZOS.new(self, @isAr3)
            when /10/
              @servertype = IBM_DB2_ZOS.new(self, @isAr3)
            when /08/             # DB2 for zOS version 8
              @servertype = IBM_DB2_ZOS_8.new(self, @isAr3)
            else                  # DB2 for zOS version 7
              raise "Only DB2 z/OS version 8 and above are currently supported"
          end
        when /AS/i                # DB2 for i5 (iSeries)
          @servertype = IBM_DB2_I5.new(self, @isAr3)
        when /IDS/i               # Informix Dynamic Server
          @servertype = IBM_IDS.new(self, @isAr3)
        else
          log( "server_info", "Forcing servertype to LUW: DBMS name could not be retrieved. Check if your client version is of the right level")
          warn "Forcing servertype to LUW: DBMS name could not be retrieved. Check if your client version is of the right level"
          @servertype = IBM_DB2_LUW.new(self, @isAr3)
      end
    else
      error_msg = IBM_DB.getErrormsg( @connection, IBM_DB::DB_CONN )
      IBM_DB.close( @connection )
      raise "Cannot retrieve server information: #{error_msg}"
    end
  end

  # Executes the +set schema+ statement using the schema identifier provided
  @servertype.set_schema(@schema) if @schema && @schema != @username

  # Check for the start value for id (primary key column). By default it is 1
  if config.has_key?(:start_id)
    @start_id = config[:start_id]
  else
    @start_id = 1
  end

  #Check Arel version
  begin
    @arelVersion = Arel::VERSION.to_i
  rescue
    @arelVersion = 0
  end

  if(@arelVersion >=  3 )
    @visitor = Arel::Visitors::IBM_DB.new self
  end
end

Instance Attribute Details

#account ⇒ Object

Returns the value of attribute account.



562
563
564
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 562

def 
  @account
end

#app_user ⇒ Object

Returns the value of attribute app_user.



562
563
564
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 562

def app_user
  @app_user
end

#application ⇒ Object

Returns the value of attribute application.



562
563
564
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 562

def application
  @application
end

#connection ⇒ Object (readonly)

Returns the value of attribute connection.



560
561
562
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 560

def connection
  @connection
end

#handle_lobs_triggered ⇒ Object

Returns the value of attribute handle_lobs_triggered.



561
562
563
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 561

def handle_lobs_triggered
  @handle_lobs_triggered
end

#pstmt_support_on ⇒ Object (readonly)

Returns the value of attribute pstmt_support_on.



563
564
565
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 563

def pstmt_support_on
  @pstmt_support_on
end

#schema ⇒ Object

Returns the value of attribute schema.



562
563
564
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 562

def schema
  @schema
end

#servertype ⇒ Object (readonly)

Returns the value of attribute servertype.



560
561
562
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 560

def servertype
  @servertype
end

#set_quoted_literal_replacement ⇒ Object (readonly)

Returns the value of attribute set_quoted_literal_replacement.



563
564
565
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 563

def set_quoted_literal_replacement
  @set_quoted_literal_replacement
end

#sql ⇒ Object

Returns the value of attribute sql.



561
562
563
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 561

def sql
  @sql
end

#sql_parameter_values ⇒ Object

Returns the value of attribute sql_parameter_values.



561
562
563
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 561

def sql_parameter_values
  @sql_parameter_values
end

#workstation ⇒ Object

Returns the value of attribute workstation.



562
563
564
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 562

def workstation
  @workstation
end

Class Method Details

.visitor_for(pool) ⇒ Object 



725
726
727
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 725

def self.visitor_for(pool)
  Arel::Visitors::IBM_DB.new(pool)
end

Instance Method Details

#active? ⇒ Boolean

Tests the connection status

Returns:

  • (Boolean) 


769
770
771
772
773
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 769

def active?
  IBM_DB.active @connection
  rescue
    false
end

#adapter_name ⇒ Object

Name of the adapter



566
567
568
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 566

def adapter_name
  'IBM_DB'
end

#add_limit_offset!(sql, options) ⇒ Object

Modifies a sql statement in order to implement a LIMIT and an OFFSET. A LIMIT defines the number of rows that should be fetched, while an OFFSET defines from what row the records must be fetched. IBM data servers implement a LIMIT in SQL statements through: FETCH FIRST n ROWS ONLY, where n is the number of rows required. The implementation of OFFSET is more elaborate, and requires the usage of subqueries and the ROW_NUMBER() command in order to add row numbering as an additional column to a copy of the existing table.

Examples

add_limit_offset!(‘SELECT * FROM staff’, => 10) generates: “SELECT * FROM staff FETCH FIRST 10 ROWS ONLY”

add_limit_offset!(‘SELECT * FROM staff’, => 10, :offset => 30) generates “SELECT O.* FROM (SELECT I.*, ROW_NUMBER() OVER () sys_rownum FROM (SELECT * FROM staff) AS I) AS O WHERE sys_row_num BETWEEN 31 AND 40”



1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1354

def add_limit_offset!(sql, options)
  limit = options[:limit]
  offset = options[:offset]

  # if the limit is zero
  if limit && limit == 0
    # Returns a query that will always generate zero records
    # (e.g. WHERE sys_row_num BETWEEN 1 and 0)
    if( @pstmt_support_on )
      sql = @servertype.query_offset_limit!(sql, 0, limit, options)
    else
      sql = @servertype.query_offset_limit(sql, 0, limit)
    end
  # If there is a non-zero limit
  else
    # If an offset is specified builds the query with offset and limit,
    # otherwise retrieves only the first +limit+ rows
    if( @pstmt_support_on )
      sql = @servertype.query_offset_limit!(sql, offset, limit, options)
    else
      sql = @servertype.query_offset_limit(sql, offset, limit)
    end
  end
  # Returns the sql query in any case
  sql
end

#begin_db_transaction ⇒ Object

Begins the transaction (and turns off auto-committing)



1316
1317
1318
1319
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1316

def begin_db_transaction
  # Turns off the auto-commit
  IBM_DB.autocommit(@connection, IBM_DB::SQL_AUTOCOMMIT_OFF)
end

#build_conn_str_for_dbops ⇒ Object 



1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1549

def build_conn_str_for_dbops()
  connect_str = "DRIVER={IBM DB2 ODBC DRIVER};ATTACH=true;"
  if(!@host.nil?)
    connect_str << "HOSTNAME=#{@host};"
    connect_str << "PORT=#{@port};"
    connect_str << "PROTOCOL=TCPIP;"
  end
  connect_str << "UID=#{@username};PWD=#{@password};"
  return connect_str
end

#change_column(table_name, column_name, type, options = {}) ⇒ Object

Changes the column’s definition according to the new options. See TableDefinition#column for details of the options you can use.

Examples
change_column(:suppliers, :name, :string, :limit => 80)
change_column(:accounts, :description, :text)



1941
1942
1943
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1941

def change_column(table_name, column_name, type, options = {})
  @servertype.change_column(table_name, column_name, type, options)
end

#change_column_default(table_name, column_name, default) ⇒ Object

Sets a new default value for a column. This does not set the default value to NULL, instead, it needs DatabaseStatements#execute which can execute the appropriate SQL statement for setting the value.

Examples

change_column_default(:suppliers, :qualification, 'new')
change_column_default(:accounts, :authorized, 1)

Method overriden to satisfy IBM data servers syntax.



1987
1988
1989
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1987

def change_column_default(table_name, column_name, default)
  @servertype.change_column_default(table_name, column_name, default)
end

#change_column_null(table_name, column_name, null, default = nil) ⇒ Object

Changes the nullability value of a column



1992
1993
1994
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1992

def change_column_null(table_name, column_name, null, default = nil)
  @servertype.change_column_null(table_name, column_name, null, default)
end

#columns(table_name, name = nil) ⇒ Object

Returns an array of Column objects for the table specified by table_name



1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1829

def columns(table_name, name = nil)
  # to_s required because it may be a symbol.
  table_name = @servertype.set_case(table_name.to_s)
  # Checks if a blank table name has been given.
  # If so it returns an empty array
  return [] if table_name.strip.empty?
  # +columns+ will contain the resulting array
  columns = []
  # Statement required to access all the columns information
  stmt = IBM_DB.columns( @connection, nil, 
                             @servertype.set_case(@schema), 
                             @servertype.set_case(table_name) )
  if(stmt)
    begin
      # Fetches all the columns and assigns them to col.
      # +col+ is an hash with keys/value pairs for a column
      while col = IBM_DB.fetch_assoc(stmt)
        column_name = col["column_name"].downcase
        # Assigns the column default value.
        column_default_value = col["column_def"]
        # If there is no default value, it assigns NIL
        column_default_value = nil if (column_default_value && column_default_value.upcase == 'NULL')
        # If default value is IDENTITY GENERATED BY DEFAULT (this value is retrieved in case of id columns)
        column_default_value = nil if (column_default_value && column_default_value.upcase =~ /IDENTITY GENERATED BY DEFAULT/i)
        # Removes single quotes from the default value
        column_default_value.gsub!(/^'(.*)'$/, '\1') unless column_default_value.nil?
        # Assigns the column type
        column_type = col["type_name"].downcase
        # Assigns the field length (size) for the column
        column_length = col["column_size"]
        column_scale = col["decimal_digits"]
        # The initializer of the class Column, requires the +column_length+ to be declared 
        # between brackets after the datatype(e.g VARCHAR(50)) for :string and :text types. 
        # If it's a "for bit data" field it does a subsitution in place, if not
        # it appends the (column_length) string on the supported data types
        unless column_length.nil? || 
               column_length == '' || 
               column_type.sub!(/ \(\) for bit data/i,"(#{column_length}) FOR BIT DATA") || 
               !column_type =~ /char|lob|graphic/i
          if column_type =~ /decimal/i
            column_type << "(#{column_length},#{column_scale})"
          elsif column_type =~ /smallint|integer|double|date|time|timestamp|xml|bigint/i
            column_type << ""  # override native limits incompatible with table create
          else
            column_type << "(#{column_length})"
          end
        end
        # col["NULLABLE"] is 1 if the field is nullable, 0 if not.
        column_nullable = (col["nullable"] == 1) ? true : false
        # Make sure the hidden column (db2_generated_rowid_for_lobs) in DB2 z/OS isn't added to the list
        if !(column_name =~ /db2_generated_rowid_for_lobs/i)
          # Pushes into the array the *IBM_DBColumn* object, created by passing to the initializer
          # +column_name+, +default_value+, +column_type+ and +column_nullable+.
          columns << IBM_DBColumn.new(column_name, column_default_value, column_type, column_nullable)
        end
      end
    rescue StandardError => fetch_error # Handle driver fetch errors
      error_msg = IBM_DB.getErrormsg(stmt, IBM_DB::DB_STMT )
      if error_msg && !error_msg.empty?
        raise "Failed to retrieve column metadata during fetch: #{error_msg}"
      else
        error_msg = "An unexpected error occurred during retrieval of column metadata"
        error_msg = error_msg + ": #{fetch_error.message}" if !fetch_error.message.empty?
        raise error_msg
      end
    ensure  # Free resources associated with the statement
      IBM_DB.free_stmt(stmt) if stmt
    end
  else  # Handle driver execution errors
    error_msg = IBM_DB.getErrormsg(@connection, IBM_DB::DB_CONN )
    if error_msg && !error_msg.empty?
      raise "Failed to retrieve column metadata due to error: #{error_msg}"
    else
      raise StandardError.new('An unexpected error occurred during retrieval of columns metadata')
    end
  end
  # Returns the columns array
  return columns
end

#commit_db_transaction ⇒ Object

Commits the transaction and turns on auto-committing



1322
1323
1324
1325
1326
1327
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1322

def commit_db_transaction
  # Commits the transaction
  IBM_DB.commit @connection rescue nil
  # Turns on auto-committing
  IBM_DB.autocommit @connection, IBM_DB::SQL_AUTOCOMMIT_ON
end

#create_database(dbName, codeSet = nil, mode = nil) ⇒ Object 



1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1583

def create_database(dbName, codeSet=nil, mode=nil)
  connect_str = build_conn_str_for_dbops()

  #Ensure connection is closed before trying to drop a database.
  #As a connect call would have been made by call seeing connection in active
  disconnect!

  begin
    createConn = IBM_DB.connect(connect_str, '', '')
  rescue StandardError => connect_err
    raise "Failed to connect to server due to: #{connect_err}"
  end

  if(IBM_DB.createDB(createConn,dbName,codeSet,mode))
    IBM_DB.close(createConn)
    return true
  else
    error = IBM_DB.getErrormsg(createConn, IBM_DB::DB_CONN)
    IBM_DB.close(createConn)
    raise "Could not create Database due to: #{error}"
  end
end

#create_table(name, options = {}) ⇒ Object

DATABASE STATEMENTS



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 833

def create_table(name, options = {})
  @servertype.setup_for_lob_table
  super
  
  #Table definition is complete only when a unique index is created on the primarykey column for DB2 V8 on zOS
  
  #create index on id column if options[:id] is nil or id ==true
  #else check if options[:primary_key]is not nil then create an unique index on that column
  if  !options[:id].nil? || !options[:primary_key].nil?
    if (!options[:id].nil? && options[:id] == true)
      @servertype.create_index_after_table(name,"id")
    elsif !options[:primary_key].nil?
      @servertype.create_index_after_table(name,options[:primary_key].to_s)
    end
  else
    @servertype.create_index_after_table(name,"id")
  end 
end

#default_sequence_name(table, column) ⇒ Object

method add_limit_offset!



1381
1382
1383
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1381

def default_sequence_name(table, column) # :nodoc:
  "#{table}_#{column}_seq"
end

#disconnect! ⇒ Object

Closes the current connection



820
821
822
823
824
825
826
827
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 820

def disconnect!
  # Attempts to close the connection. The methods will return:
  # * true if succesfull
  # * false if the connection is already closed
  # * nil if an error is raised
  return nil if @connection.nil? || @connection == false
  IBM_DB.close(@connection) rescue nil
end

#distinct(columns, order_by) ⇒ Object

Add distinct clause to the sql if there is no order by specified



1972
1973
1974
1975
1976
1977
1978
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1972

def distinct(columns, order_by)
  if order_by.nil?
    "DISTINCT #{columns}"
  else
    "#{columns}"
  end
end

#drop_database(dbName) ⇒ Object 



1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1560

def drop_database(dbName)
  connect_str = build_conn_str_for_dbops()

  #Ensure connection is closed before trying to drop a database. 
  #As a connect call would have been made by call seeing connection in active
  disconnect!

  begin
    dropConn = IBM_DB.connect(connect_str, '', '')
  rescue StandardError => connect_err
    raise "Failed to connect to server due to: #{connect_err}"
  end

  if(IBM_DB.dropDB(dropConn,dbName))
    IBM_DB.close(dropConn)
    return true
  else
    error = IBM_DB.getErrormsg(dropConn, IBM_DB::DB_CONN)
    IBM_DB.close(dropConn)
    raise "Could not drop Database due to: #{error}"
  end
end

#empty_insert_statement_value(pkey) ⇒ Object 



1094
1095
1096
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1094

def empty_insert_statement_value(pkey)
  "(#{pkey}) VALUES (DEFAULT)"
end

#exec_query(sql, name = 'SQL', binds = []) ⇒ Object

Executes sql statement in the context of this connection using binds as the bind substitutes. name is logged along with the executed sql statement.



1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1201

def exec_query(sql, name = 'SQL', binds = [])
  begin
    param_array = binds.map do |column,value|
      quote_value_for_pstmt(value, column)
    end

    stmt = prepare(sql, name)

     if( stmt )
       if(execute_prepared_stmt(stmt, param_array))
         return stmt
       end
     else
       return false
     end
  ensure
    @offset = @limit = nil
  end
end

#execute(sql, name = nil) ⇒ Object

Executes and logs sql commands and returns a IBM_DB.Statement object.



1223
1224
1225
1226
1227
1228
1229
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1223

def execute(sql, name = nil)
  # Logs and execute the sql instructions.
  # The +log+ method is defined in the parent class +AbstractAdapter+
  log(sql, name) do
    @servertype.execute(sql, name)
  end
end

#execute_prepared_stmt(pstmt, param_array = nil) ⇒ Object

Praveen Executes the prepared statement ReturnsTrue on success and False on Failure



1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1179

def execute_prepared_stmt(pstmt, param_array = nil)
  if !param_array.nil? && param_array.size < 1
    param_array = nil
  end

  if( !IBM_DB.execute(pstmt, param_array) )
    error_msg = IBM_DB.getErrormsg(pstmt, IBM_DB::DB_STMT)
    if !error_msg.empty?
      error_msg = "Statement execution failed: " + error_msg
    else
      error_msg = "Statement execution failed"
    end
    IBM_DB.free_stmt(pstmt) if pstmt
    raise StatementInvalid, error_msg
  else
    return true
  end
end

#fetch_data(stmt) ⇒ Object

Calls the servertype select method to fetch the data



919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 919

def fetch_data(stmt)
  if(stmt)
    begin
      return @servertype.select(stmt)
    rescue StandardError => fetch_error # Handle driver fetch errors
      error_msg = IBM_DB.getErrormsg(stmt, IBM_DB::DB_STMT )
      if error_msg && !error_msg.empty?
        raise StatementInvalid,"Failed to retrieve data: #{error_msg}"
      else
        error_msg = "An unexpected error occurred during data retrieval"
        error_msg = error_msg + ": #{fetch_error.message}" if !fetch_error.message.empty?
        raise error_msg
      end
    ensure
    # Ensures to free the resources associated with the statement
      IBM_DB.free_stmt(stmt) if stmt
    end
  end
end

#indexes(table_name, name = nil) ⇒ Object

Returns an array of non-primary key indexes for a specified table name



1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1708

def indexes(table_name, name = nil)
          # to_s required because +table_name+ may be a symbol.
  table_name = table_name.to_s
  # Checks if a blank table name has been given.
  # If so it returns an empty array of columns.
  return [] if table_name.strip.empty?

  indexes = []
  pk_index = nil
  index_schema = []
  
  #fetch the primary keys of the table using function primary_keys
  #TABLE_SCHEM:: pk_index[1]
  #TABLE_NAME:: pk_index[2]
  #COLUMN_NAME:: pk_index[3]
  #PK_NAME:: pk_index[5]
  stmt = IBM_DB.primary_keys( @connection, nil, 
                             @servertype.set_case(@schema), 
                             @servertype.set_case(table_name))
  if(stmt)
    begin
      while ( pk_index_row = IBM_DB.fetch_array(stmt) )
        if pk_index_row[5] 
          pk_index_name = pk_index_row[5].downcase
          pk_index_columns = [pk_index_row[3].downcase]           # COLUMN_NAME
          if pk_index 
            pk_index.columns = pk_index.columns + pk_index_columns
          else
            pk_index = IndexDefinition.new(table_name, pk_index_name, true, pk_index_columns)
          end
        end 
      end
    rescue StandardError => fetch_error # Handle driver fetch errors
      error_msg = IBM_DB.getErrormsg(stmt, IBM_DB::DB_STMT )
      if error_msg && !error_msg.empty?
        raise "Failed to retrieve primarykey metadata during fetch: #{error_msg}"
      else
        error_msg = "An unexpected error occurred during retrieval of primary key metadata"
        error_msg = error_msg + ": #{fetch_error.message}" if !fetch_error.message.empty?
        raise error_msg
      end
    ensure  # Free resources associated with the statement
      IBM_DB.free_stmt(stmt) if stmt
    end
  else  # Handle driver execution errors
    error_msg = IBM_DB.getErrormsg(@connection, IBM_DB::DB_CONN )
    if error_msg && !error_msg.empty?
      raise "Failed to retrieve primary key metadata due to error: #{error_msg}"
    else
      raise StandardError.new('An unexpected error occurred during primary key retrieval')
    end
  end

  # Query table statistics for all indexes on the table
  # "TABLE_NAME:   #{index_stats[2]}"
  # "NON_UNIQUE:   #{index_stats[3]}"
  # "INDEX_NAME:   #{index_stats[5]}"
  # "COLUMN_NAME:  #{index_stats[8]}"
  stmt = IBM_DB.statistics( @connection, nil, 
                            @servertype.set_case(@schema), 
                            @servertype.set_case(table_name), 1 )
  if(stmt)
    begin
      while ( index_stats = IBM_DB.fetch_array(stmt) )
          is_composite = false
        if index_stats[5]             # INDEX_NAME
          index_name = index_stats[5].downcase
          index_unique = (index_stats[3] == 0)
          index_columns = [index_stats[8].downcase]     # COLUMN_NAME
          index_qualifier = index_stats[4].downcase             #Index_Qualifier
          # Create an IndexDefinition object and add to the indexes array
          i = 0;
          indexes.each do |index|
            if index.name == index_name && index_schema[i] == index_qualifier
               index.columns = index.columns + index_columns
               is_composite = true
            end 
            i = i+1
          end
        
          unless is_composite 
            indexes << IndexDefinition.new(table_name, index_name, index_unique, index_columns)
            index_schema << index_qualifier
          end 
        end
      end
    rescue StandardError => fetch_error # Handle driver fetch errors
      error_msg = IBM_DB.getErrormsg(stmt, IBM_DB::DB_STMT )
      if error_msg && !error_msg.empty?
        raise "Failed to retrieve index metadata during fetch: #{error_msg}"
      else
        error_msg = "An unexpected error occurred during retrieval of index metadata"
        error_msg = error_msg + ": #{fetch_error.message}" if !fetch_error.message.empty?
        raise error_msg
      end
    ensure  # Free resources associated with the statement
      IBM_DB.free_stmt(stmt) if stmt
    end
  else  # Handle driver execution errors
    error_msg = IBM_DB.getErrormsg(@connection, IBM_DB::DB_CONN )
    if error_msg && !error_msg.empty?
      raise "Failed to retrieve index metadata due to error: #{error_msg}"
    else
      raise StandardError.new('An unexpected error occurred during index retrieval')
    end
  end
    
  # remove the primary key index entry.... should not be dumped by the dumper
    
  i = 0
  indexes.each do |index|
    if pk_index && index.columns == pk_index.columns
      indexes.delete_at(i)
    end
    i = i+1
  end 
  # Returns the indexes array
  return indexes
end

#insert(arel, name = nil, pk = nil, id_value = nil, sequence_name = nil, binds = []) ⇒ Object 



1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1120

def insert(arel, name = nil, pk = nil, id_value = nil, sequence_name = nil, binds = [] )
  sql, binds = [to_sql(arel),binds]

  #unless IBM_DBAdapter.respond_to?(:exec_insert)
  if binds.nil? || binds.empty?
    return insert_direct(sql, name, pk, id_value, sequence_name)
  end

  clear_query_cache if defined? clear_query_cache
  if stmt = exec_insert(sql, name, binds)
    begin
      @sql << sql
      return id_value || @servertype.last_generated_id(stmt)
    ensure
      IBM_DB.free_stmt(stmt) if stmt
    end
  end
end

#insert_direct(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil) ⇒ Object

Perform an insert and returns the last ID generated. This can be the ID passed to the method or the one auto-generated by the database, and retrieved by the last_generated_id method.



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1101

def insert_direct(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil)
  if @handle_lobs_triggered  #Ensure the array of sql is cleared if they have been handled in the callback
    @sql = []
    @handle_lobs_triggered = false
  end

  clear_query_cache if defined? clear_query_cache

  if stmt = execute(sql, name)
    begin
      @sql << sql
      return id_value || @servertype.last_generated_id(stmt)
      # Ensures to free the resources associated with the statement
    ensure
      IBM_DB.free_stmt(stmt) if stmt
    end
  end
end

#insert_fixture(fixture, table_name) ⇒ Object

inserts values from fixtures overridden to handle LOB’s fixture insertion, as, in normal inserts callbacks are triggered but during fixture insertion callbacks are not triggered hence only markers like @@@IBMBINARY@@@ will be inserted and are not updated to actual data



1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1031

def insert_fixture(fixture, table_name)
  if(fixture.respond_to?(:keys))
    insert_query = "INSERT INTO #{quote_table_name(table_name)} ( #{fixture.keys.join(', ')})"
  else
    insert_query = "INSERT INTO #{quote_table_name(table_name)} ( #{fixture.key_list})"
  end

  insert_values = []
  params = []
  if @servertype.instance_of? IBM_IDS
    super
    return
  end
  column_list = columns(table_name)
  fixture.each do |item|
    col = nil
    column_list.each do |column|
      if column.name.downcase == item.at(0).downcase
        col= column
        break
      end
    end
    if item.at(1).nil? || 
        item.at(1) == {} || 
        (item.at(1) == '' && !(col.type.to_sym == :text))
    
          params << 'NULL'
    
    elsif col.type.to_sym == :xml ||
           col.type.to_sym == :text ||
              col.type.to_sym == :binary 
      #  Add a '?' for the parameter or a NULL if the value is nil or empty 
      # (except for a CLOB field where '' can be a value)
       insert_values << quote_value_for_pstmt(item.at(1))
       params << '?'
    else
      insert_values << quote_value_for_pstmt(item.at(1),col)
      params << '?'
    end 
  end
    
  insert_query << " VALUES ("+ params.join(',') + ")"
  unless stmt = IBM_DB.prepare(@connection, insert_query)
     error_msg = IBM_DB.getErrormsg( @connection, IBM_DB::DB_CONN )
     if error_msg && !error_msg.empty?
       raise "Failed to prepare statement for fixtures insert due to : #{error_msg}"
     else
       raise StandardError.new('An unexpected error occurred during preparing SQL for fixture insert')
     end
  end
    
  #log_query(insert_query,'fixture insert')
  log(insert_query,'fixture insert') do
    unless IBM_DB.execute(stmt, insert_values)
      error_msg = IBM_DB.getErrormsg(stmt, IBM_DB::DB_STMT )
      IBM_DB.free_stmt(stmt) if stmt
      raise "Failed to insert due to: #{error_msg}"
    else
      IBM_DB.free_stmt(stmt) if stmt
    end
  end
end

#log_query(sql, name) ⇒ Object

:nodoc:



759
760
761
762
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 759

def log_query(sql, name) #:nodoc:
  # Used by handle_lobs
  log(sql,name){}
end

#native_database_types ⇒ Object

Returns a Hash of mappings from the abstract data types to the native database types



1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1519

def native_database_types
  {
    :primary_key => { :name => @servertype.primary_key_definition(@start_id)},
    :string      => { :name => "varchar", :limit => 255 },
    :text        => { :name => "clob" },
    :integer     => { :name => "integer" },
    :float       => { :name => "float" },
    :datetime    => { :name => @servertype.get_datetime_mapping },
    :timestamp   => { :name => @servertype.get_datetime_mapping },
    :time        => { :name => @servertype.get_time_mapping },
    :date        => { :name => "date" },
    :binary      => { :name => "blob" },

    # IBM data servers don't have a native boolean type.
    # A boolean can be represented  by a smallint,
    # adopting the convention that False is 0 and True is 1
    :boolean     => { :name => "smallint"},
    :xml         => { :name => "xml"},
    :decimal     => { :name => "decimal" },
    :rowid       => { :name => "rowid" }, # rowid is a supported datatype on z/OS and i/5
    :serial      => { :name => "serial" }, # rowid is a supported datatype on Informix Dynamic Server
    :char        => { :name => "char" },
    :double      => { :name => @servertype.get_double_mapping },
    :decfloat    => { :name => "decfloat"},
    :graphic     => { :name => "graphic", :limit => 1},
    :vargraphic  => { :name => "vargraphic", :limit => 1},
    :bigint      => { :name => "bigint"}
  }
end

#prepare(sql, name = nil) ⇒ Object

Praveen Prepares and logs sql commands and returns a IBM_DB.Statement object.



1168
1169
1170
1171
1172
1173
1174
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1168

def prepare(sql,name = nil)
  # The +log+ method is defined in the parent class +AbstractAdapter+
  @prepared_sql = sql
  log(sql,name) do
    @servertype.prepare(sql, name)
  end
end

#prepared_insert(pstmt, param_array = nil, id_value = nil) ⇒ Object

Praveen Performs an insert using the prepared statement and returns the last ID generated. This can be the ID passed to the method or the one auto-generated by the database, and retrieved by the last_generated_id method.



1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1143

def prepared_insert(pstmt, param_array = nil, id_value = nil)
  if @handle_lobs_triggered  #Ensure the array of sql is cleared if they have been handled in the callback
    @sql                   = []
    @sql_parameter_values  = []
    @handle_lobs_triggered = false
  end

  clear_query_cache if defined? clear_query_cache

  begin
    if execute_prepared_stmt(pstmt, param_array)
      @sql << @prepared_sql
      @sql_parameter_values << param_array
      return id_value || @servertype.last_generated_id(pstmt)
    end
  rescue StandardError => insert_err
    raise insert_err
  ensure
    IBM_DB.free_stmt(pstmt) if pstmt
  end
end

#prepared_select(sql_param_hash, name = nil) ⇒ Object

Returns an array of hashes with the column names as keys and column values as values. sql is the select query, and name is an optional description for logging



855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 855

def prepared_select(sql_param_hash, name = nil)
  # Replaces {"= NULL" with " IS NULL"} OR {"IN (NULL)" with " IS NULL"}

  results = []
  # Invokes the method +prepare+ in order prepare the SQL
  # IBM_DB.Statement is returned from which the statement is executed and results fetched
  pstmt = prepare(sql_param_hash["sqlSegment"], name)
  if(execute_prepared_stmt(pstmt, sql_param_hash["paramArray"]))
    begin
      results = @servertype.select(pstmt)
    rescue StandardError => fetch_error # Handle driver fetch errors
      error_msg = IBM_DB.getErrormsg(pstmt, IBM_DB::DB_STMT )
      if error_msg && !error_msg.empty?
        raise StatementInvalid,"Failed to retrieve data: #{error_msg}"
      else
        error_msg = "An unexpected error occurred during data retrieval"
        error_msg = error_msg + ": #{fetch_error.message}" if !fetch_error.message.empty?
        raise error_msg
      end
    ensure
      # Ensures to free the resources associated with the statement
      IBM_DB.free_stmt(pstmt) if pstmt
    end
  end
  # The array of record hashes is returned
  results
end

#prepared_select_values(sql_param_hash, name = nil) ⇒ Object

Returns an array of hashes with the column names as keys and column values as values. sql is the select query, and name is an optional description for logging



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 886

def prepared_select_values(sql_param_hash, name = nil)
  # Replaces {"= NULL" with " IS NULL"} OR {"IN (NULL)" with " IS NULL"}
  results = []
  # Invokes the method +prepare+ in order prepare the SQL
  # IBM_DB.Statement is returned from which the statement is executed and results fetched
  pstmt = prepare(sql_param_hash["sqlSegment"], name)
  if(execute_prepared_stmt(pstmt, sql_param_hash["paramArray"]))
    begin
      results = @servertype.select_rows(sql_param_hash["sqlSegment"], name, pstmt, results)
      if results
        return results.map { |v| v[0] }
      else
        nil
      end
    rescue StandardError => fetch_error # Handle driver fetch errors
      error_msg = IBM_DB.getErrormsg(pstmt, IBM_DB::DB_STMT )
      if error_msg && !error_msg.empty?
        raise StatementInvalid,"Failed to retrieve data: #{error_msg}"
      else
        error_msg = "An unexpected error occurred during data retrieval"
        error_msg = error_msg + ": #{fetch_error.message}" if !fetch_error.message.empty?
        raise error_msg
      end
    ensure
      # Ensures to free the resources associated with the statement
      IBM_DB.free_stmt(pstmt) if pstmt
    end
  end
  # The array of record hashes is returned
  results
end

#prepared_update(pstmt, param_array = nil) ⇒ Object Also known as: prepared_delete

Praveen



1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1252

def prepared_update(pstmt, param_array = nil )
  if @handle_lobs_triggered  #Ensure the array of sql is cleared if they have been handled in the callback
    @sql                   = []
    @sql_parameter_values  = []
    @handle_lobs_triggered = false
  end

  clear_query_cache if defined? clear_query_cache

  begin
    if execute_prepared_stmt(pstmt, param_array)
      @sql << @prepared_sql
      @sql_parameter_values << param_array
      # Retrieves the number of affected rows
      IBM_DB.num_rows(pstmt)
      # Ensures to free the resources associated with the statement
		  end
  rescue StandardError => updt_err
    raise updt_err
  ensure
    IBM_DB.free_stmt(pstmt) if pstmt
  end
end

#primary_key(table_name) ⇒ Object

Returns the primary key of the mentioned table



1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1674

def primary_key(table_name)
  pk_name = nil
  stmt = IBM_DB.primary_keys( @connection, nil, 
                              @servertype.set_case(@schema), 
                              @servertype.set_case(table_name))
  if(stmt) 
    begin
      if ( pk_index_row = IBM_DB.fetch_array(stmt) )
        pk_name = pk_index_row[3].downcase
      end
    rescue StandardError => fetch_error # Handle driver fetch errors
      error_msg = IBM_DB.getErrormsg( stmt, IBM_DB::DB_STMT )
      if error_msg && !error_msg.empty?
        raise "Failed to retrieve primarykey metadata during fetch: #{error_msg}"
      else
        error_msg = "An unexpected error occurred during retrieval of primary key metadata"
        error_msg = error_msg + ": #{fetch_error.message}" if !fetch_error.message.empty?
        raise error_msg
      end
    ensure  # Free resources associated with the statement
      IBM_DB.free_stmt(stmt) if stmt
    end
  else
    error_msg = IBM_DB.getErrormsg( @connection, IBM_DB::DB_CONN )
    if error_msg && !error_msg.empty?
      raise "Failed to retrieve primary key metadata due to error: #{error_msg}"
    else
      raise StandardError.new('An unexpected error occurred during primary key retrieval')
    end
  end
  return pk_name
end

#quote(value, column = nil) ⇒ Object

Properly quotes the various data types. value contains the data, column is optional and contains info on the field



1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1431

def quote(value, column = nil)
  return value.quoted_id if value.respond_to?(:quoted_id)

  case value
    # If it's a numeric value and the column type is not a string, it shouldn't be quoted
    # (IBM_DB doesn't accept quotes on numeric types)
    when Numeric
      # If the column type is text or string, return the quote value
      if column && column.type.to_sym == :text || column && column.type.to_sym == :string
        unless caller[0] =~ /insert_fixture/i
            "'#{value}'"
        else
            "#{value}"
        end 
      else
        # value is Numeric, column.type is not a string,
        # therefore it converts the number to string without quoting it
        value.to_s
      end
    when String, ActiveSupport::Multibyte::Chars
    if column && column.type.to_sym == :binary && !(column.sql_type =~ /for bit data/i)
      # If quoting is required for the insert/update of a BLOB
        unless caller[0] =~ /add_column_options/i
           # Invokes a convertion from string to binary
          @servertype.set_binary_value
        else
          # Quoting required for the default value of a column
          @servertype.set_binary_default(value)
        end
    elsif column && column.type.to_sym == :text
        unless caller[0] =~ /add_column_options/i
          "'@@@IBMTEXT@@@'"
        else
          @servertype.set_text_default(quote_string(value))
        end
    elsif column && column.type.to_sym == :xml
        unless caller[0] =~ /add_column_options/i
          "'<ibm>@@@IBMXML@@@</ibm>'"
        else
          "#{value}"
        end
    else
        unless caller[0] =~ /insert_fixture/i
          super 
        else
          "#{value}"
        end 
    end
    when TrueClass then quoted_true    # return '1' for true
    when FalseClass then quoted_false  # return '0' for false
    when nil        then "NULL"
    when Date, Time then "'#{quoted_date(value)}'"
    when Symbol     then "'#{quote_string(value.to_s)}'"
    else
      unless caller[0] =~ /insert_fixture/i 
        "'#{quote_string(YAML.dump(value))}'"
      else
        "#{quote_string(YAML.dump(value))}"
      end
  end
end

#quote_column_name(name) ⇒ Object 



1509
1510
1511
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1509

def quote_column_name(name)
   @servertype.check_reserved_words(name)
end

#quote_string(string) ⇒ Object

Quotes a given string, escaping single quote (‘) characters.



1494
1495
1496
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1494

def quote_string(string)
  string.gsub(/'/, "''")
end

#quote_value_for_pstmt(value, column = nil) ⇒ Object 



1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1400

def quote_value_for_pstmt(value, column=nil)

  return value.quoted_id if value.respond_to?(:quoted_id)

  case value
    when String, ActiveSupport::Multibyte::Chars then
      value = value.to_s
      if column && [:integer, :float].include?(column.type)
        value = column.type == :integer ? value.to_i : value.to_f
        value
      else
        value
      end
    when NilClass                 then nil
    when TrueClass                then 1
    when FalseClass               then 0
    when Float, Fixnum, Bignum    then value
    # BigDecimals need to be output in a non-normalized form and quoted.
    when BigDecimal               then value.to_s('F')
    when Numeric, Symbol          then value.to_s
    else
      if value.acts_like?(:date) || value.acts_like?(:time)
        quoted_date(value)
      else
        value.to_yaml
      end
  end
end

#quoted_date(value) ⇒ Object

Quote date/time values for use in SQL input. Includes microseconds, if the value is a Time responding to usec.



1392
1393
1394
1395
1396
1397
1398
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1392

def quoted_date(value) #:nodoc:
  if value.respond_to?(:usec)
    "#{super}.#{sprintf("%06d", value.usec)}"
  else
    super
  end
end

#quoted_false ⇒ Object 



1505
1506
1507
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1505

def quoted_false
  "0"
end

#quoted_true ⇒ Object

true is represented by a smallint 1, false by 0, as no native boolean type exists in DB2. Numerics are not quoted in DB2.



1501
1502
1503
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1501

def quoted_true
  "1"
end

#reconnect! ⇒ Object

Closes the current connection and opens a new one



814
815
816
817
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 814

def reconnect!
  disconnect!
  connect
end

#remove_column(table_name, column_name) ⇒ Object

Removes the column from the table definition.

Examples
remove_column(:suppliers, :qualification)



1932
1933
1934
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1932

def remove_column(table_name, column_name)
  @servertype.remove_column(table_name, column_name)
end

#remove_index(table_name, options = {}) ⇒ Object

Remove the given index from the table.

Remove the suppliers_name_index in the suppliers table (legacy support, use the second or third forms).

remove_index :suppliers, :name

Remove the index named accounts_branch_id in the accounts table.

remove_index :accounts, :column => :branch_id

Remove the index named by_branch_party in the accounts table.

remove_index :accounts, :name => :by_branch_party

You can remove an index on multiple columns by specifying the first column.

add_index :accounts, [:username, :password]
remove_index :accounts, :username

Overriden to use the IBM data servers SQL syntax.



2009
2010
2011
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 2009

def remove_index(table_name, options = {})
  execute("DROP INDEX #{index_name(table_name, options)}")
end

#rename_column(table_name, column_name, new_column_name) ⇒ Object

Renames a column.

Example
rename_column(:suppliers, :description, :name)



1925
1926
1927
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1925

def rename_column(table_name, column_name, new_column_name)
  @servertype.rename_column(table_name, column_name, new_column_name)
end

#rename_table(name, new_name) ⇒ Object

Renames a table.

Example

rename_table(‘octopuses’, ‘octopi’) Overriden to satisfy IBM data servers syntax



1913
1914
1915
1916
1917
1918
1919
1920
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1913

def rename_table(name, new_name)
  # SQL rename table statement
  rename_table_sql = "RENAME TABLE #{name} TO #{new_name}"
  stmt = execute(rename_table_sql)
  # Ensures to free the resources associated with the statement
  ensure
    IBM_DB.free_stmt(stmt) if stmt
end

#rollback_db_transaction ⇒ Object

Rolls back the transaction and turns on auto-committing. Must be done if the transaction block raises an exception or returns false



1331
1332
1333
1334
1335
1336
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1331

def rollback_db_transaction
  # ROLLBACK the transaction
  IBM_DB.rollback(@connection) rescue nil
  # Turns on auto-committing
  IBM_DB.autocommit @connection, IBM_DB::SQL_AUTOCOMMIT_ON
end

#select(sql, name = nil, binds = []) ⇒ Object

# Returns an array of hashes with the column names as keys and

# column values as values. +sql+ is the select query, 
# and +name+ is an optional description for logging
def select(sql, name = nil)
  # Replaces {"= NULL" with " IS NULL"} OR {"IN (NULL)" with " IS NULL"}
  sql.gsub!( /(=\s*NULL|IN\s*\(NULL\))/i, " IS NULL" )

  results = []
  # Invokes the method +execute+ in order to log and execute the SQL
  # IBM_DB.Statement is returned from which results can be fetched
  stmt = execute(sql, name)

  results = fetch_data(stmt)
  # The array of record hashes is returned
  results
end



956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 956

def select(sql, name = nil, binds = [])
  # Replaces {"= NULL" with " IS NULL"} OR {"IN (NULL)" with " IS NULL"}
  sql.gsub!( /(=\s*NULL|IN\s*\(NULL\))/i, " IS NULL" )

  results = []

  if(binds.nil? || binds.empty?)
    stmt = execute(sql, name)
  else
    stmt = exec_query(sql, name, binds)
  end

  cols = IBM_DB.resultCols(stmt)

  if( stmt ) 
    results = fetch_data(stmt)
  end

  if(@isAr3)
    return results
  else
    return ActiveRecord::Result.new(cols, results)
  end
end

#select_rows(sql, name = nil, binds = []) ⇒ Object

Returns an array of arrays containing the field values. This is an implementation for the abstract method sql is the select query and name is an optional description for logging



984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 984

def select_rows(sql, name = nil,binds = [])
  # Replaces {"= NULL" with " IS NULL"} OR {"IN (NULL)" with " IS NULL"}
  sql.gsub!( /(=\s*NULL|IN\s*\(NULL\))/i, " IS NULL" )
  
  results = []
  # Invokes the method +execute+ in order to log and execute the SQL
  # IBM_DB.Statement is returned from which results can be fetched
  if !binds.nil? && !binds.empty?
    param_array = binds.map do |column,value|
      quote_value_for_pstmt(value, column)
    end
    return prepared_select({"sqlSegment" => sql, "paramArray" => param_array})
  end

  stmt = execute(sql, name)
  if(stmt)
    begin
      results = @servertype.select_rows(sql, name, stmt, results)
    rescue StandardError => fetch_error  # Handle driver fetch errors
      error_msg = IBM_DB.getErrormsg(stmt, IBM_DB::DB_STMT )
      if error_msg && !error_msg.empty?
        raise StatementInvalid,"Failed to retrieve data: #{error_msg}"
      else
        error_msg = "An unexpected error occurred during data retrieval"
        error_msg = error_msg + ": #{fetch_error.message}" if !fetch_error.message.empty?
        raise error_msg
      end
    ensure
      # Ensures to free the resources associated with the statement
      IBM_DB.free_stmt(stmt) if stmt
    end
  end
  # The array of record hashes is returned
  results
end

#supports_ddl_transactions? ⇒ Boolean

This Adapter supports DDL transactions. This means CREATE TABLE and other DDL statements can be carried out as a transaction. That is the statements executed can be ROLLED BACK in case of any error during the process.

Returns:

  • (Boolean) 


755
756
757
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 755

def supports_ddl_transactions?
  true
end

#supports_foreign_keys? ⇒ Boolean

Returns:

  • (Boolean) 


748
749
750
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 748

def supports_foreign_keys?
  false
end

#supports_migrations? ⇒ Boolean

This adapter supports migrations. Current limitations: rename_column is not currently supported by the IBM data servers remove_column is not currently supported by the DB2 for zOS data server Tables containing columns of XML data type do not support remove_column

Returns:

  • (Boolean) 


744
745
746
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 744

def supports_migrations?
  true
end

#table_alias_length ⇒ Object

Returns the maximum length a table alias identifier can be. IBM data servers (cross-platform) table limit is 128 characters



1629
1630
1631
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1629

def table_alias_length
  128
end

#tables(name = nil) ⇒ Object

Retrieves table’s metadata for a specified shema name



1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1634

def tables(name = nil)
  # Initializes the tables array
  tables = []
  # Retrieve table's metadata through IBM_DB driver
  stmt = IBM_DB.tables(@connection, nil, 
                      @servertype.set_case(@schema))
  if(stmt)
    begin
      # Fetches all the records available
      while tab = IBM_DB.fetch_assoc(stmt)
        # Adds the lowercase table name to the array
        if(tab["table_type"]== 'TABLE')  #check, so that only tables are dumped,IBM_DB.tables also returns views,alias etc in the schema
          tables << tab["table_name"].downcase    
        end
      end
    rescue StandardError => fetch_error # Handle driver fetch errors
      error_msg = IBM_DB.getErrormsg(stmt, IBM_DB::DB_STMT )
      if error_msg && !error_msg.empty?
        raise "Failed to retrieve table metadata during fetch: #{error_msg}"
      else
        error_msg = "An unexpected error occurred during retrieval of table metadata"
        error_msg = error_msg + ": #{fetch_error.message}" if !fetch_error.message.empty?
        raise error_msg
      end
    ensure
      IBM_DB.free_stmt(stmt)  if stmt # Free resources associated with the statement
    end
  else # Handle driver execution errors
    error_msg = IBM_DB.getErrormsg(@connection, IBM_DB::DB_CONN )
    if error_msg && !error_msg.empty?
      raise "Failed to retrieve tables metadata due to error: #{error_msg}"
    else
      raise StandardError.new('An unexpected error occurred during retrieval of table metadata')
    end
  end
  # Returns the tables array
  return tables
end

#to_sql(arel, binds = []) ⇒ Object 



729
730
731
732
733
734
735
736
737
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 729

def to_sql(arel, binds = [])
  if arel.respond_to?(:ast)
    visitor.accept(arel.ast) do
      quote(*binds.shift.reverse)
    end
  else
    arel
  end
end

#type_to_sql(type, limit = nil, precision = nil, scale = nil) ⇒ Object

IBM data servers do not support limits on certain data types (unlike MySQL) Limit is supported for the decimal, numeric, varchar, clob, blob, graphic, vargraphic data types.



1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1608

def type_to_sql(type, limit = nil, precision = nil, scale = nil)
  if type.to_sym == :decfloat
    sql_segment = native_database_types[type.to_sym][:name].to_s
    sql_segment << "(#{precision})" if !precision.nil?
    return sql_segment
  end
  
  return super if limit.nil?

  # strip off limits on data types not supporting them
  if @servertype.limit_not_supported_types.include? type.to_sym
    return native_database_types[type.to_sym][:name].to_s
  elsif type.to_sym == :boolean
    return "smallint"
  else
    return super
  end
end

#update(arel, name = nil, binds = []) ⇒ Object Also known as: delete 



1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1280

def update(arel, name = nil, binds = [])
  sql = to_sql(arel)

  # Make sure the WHERE clause handles NULL's correctly
  sqlarray = sql.split(/\s*WHERE\s*/)
  size = sqlarray.size
  if size > 1
    sql = sqlarray[0] + " WHERE "
    if size > 2
      1.upto size-2 do |index|
        sqlarray[index].gsub!( /(=\s*NULL|IN\s*\(NULL\))/i, " IS NULL" ) unless sqlarray[index].nil?
        sql = sql + sqlarray[index] + " WHERE "
      end
    end
    sqlarray[size-1].gsub!( /(=\s*NULL|IN\s*\(NULL\))/i, " IS NULL" ) unless sqlarray[size-1].nil?
    sql = sql + sqlarray[size-1]
  end

  clear_query_cache if defined? clear_query_cache

  if binds.nil? || binds.empty?
    update_direct(sql, name)
  else
    begin
      if stmt = exec_query(sql,name,binds)
        IBM_DB.num_rows(stmt)
      end
    ensure
      IBM_DB.free_stmt(stmt) if(stmt)
    end
  end
end

#update_direct(sql, name = nil) ⇒ Object

Executes an “UPDATE” SQL statement



1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
 
# File 'lib/active_record/connection_adapters/ibm_db_adapter.rb', line 1232

def update_direct(sql, name = nil)
  if @handle_lobs_triggered  #Ensure the array of sql is cleared if they have been handled in the callback
    @sql = []
    @handle_lobs_triggered = false
  end

  # Logs and execute the given sql query.
  if stmt = execute(sql, name)
    begin
      @sql << sql
      # Retrieves the number of affected rows
      IBM_DB.num_rows(stmt)
      # Ensures to free the resources associated with the statement
    ensure
      IBM_DB.free_stmt(stmt) if stmt
    end
  end
end