db2_query 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09ecde3a8404d9aa56b416cbd3aa89efb21519166dea225cf8e3d7a54a2b4ed1'
-  data.tar.gz: c72fe3cc5e681d99d3dd5a6ec85863cb15b4b95e72b92e42dcb9d20fac910fbc
+  metadata.gz: a62d60225cd34e421f6d6fd8becf1d45bb6e0ffb35db266bac881734a4b15340
+  data.tar.gz: 8b02f4869439de1dcdb14cfca0f731ee99ce143f504b6a56c7e04db74684da65
 SHA512:
-  metadata.gz: 20370e437967f91a7b273b21339c22ad4f868310812be5ff40676eb0ae28044def876276044aa1a0f237fec1b47e3acf6b7591e2bf1d76d53b7876ca688528ae
-  data.tar.gz: aa62b2ff0df74fb300963ab83c36f066b6e032d26de149ade42ed7cd79daac5579aedeae1bafd264747466a0719520b76ef8cef49e7e1e4c64a9cc84eb9f46db
+  metadata.gz: a684c13ff35469b6f53c13b0bcd2c21c997b9b51abce517bc66ca920a4cc764ae885a1746b1e256d50945cc038d240739c8de72045b899af6e63421b8a520c24
+  data.tar.gz: a2698708b312200a55f93334c5f27b5345f9b0515a6ca8aee82926562388178588766bb708959178f26488774a3994a5e88f2181691e8604f9d7ac6f62a2dcfb

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/db2_query.svg)](https://badge.fury.io/rb/db2_query)
 
-A Rails 5 & Rails 6 plugin for handling Db2 SQL database `SIUD` statement (`SELECT`, `INPUT`, `UPDATE`, `DELETE`) by using ODBC connection.
+A Rails 5 & Rails 6 plugin for handling Db2 SQL database `SIUD` statement (`SELECT`, `INSERT`, `UPDATE`, `DELETE`) by using ODBC connection.
 
 Note: Tested at Rails 5.2.6 and Rails 6.1.4
 
@@ -39,23 +39,28 @@ At version 0.3.0, `db2query.yml` only use DSN connection config:
 ```yml
   development:
      dsn: ARUNIT
+     idle: 5
      pool: 5
      timeout: 5
   test:
      dsn: ARUNIT
+     idle: 5
      pool: 5
      timeout: 5
   production:
      dsn: ARUNIT
+     idle: 5
      pool: 5
      timeout: 5
 ```
 
+Note: `idle` is a `db_client` idle maximum limit value (in minutes) to avoid the client disconnected by the host server. Setting this value to zero will lead to an "ODBC driver Communication Link Failure. Comm rc 10054 . [CWBCO1047](https://www.ibm.com/support/pages/cwbco1047-any-function-uses-database-host-server)" error after a certain period of time.
+
 Ensure that `unixodbc` have been installed and test your connection first by using `isql` commands.
 
 Example:
 
-Secondary database connection test
+ARUNIT DSN connection test
 ```bash
 $ isql -v ARUNIT
 +---------------------------------------+
@@ -82,7 +87,8 @@ The `query` method must have 2 inputs:
 1. Method name
 2. Body (can be an SQL statement or lamda).
 
-The lambda is used to facilitate us in using `built-in methods` as shown at two query methods below:
+The lambda is used to facilitate us in using `built-in methods` as shown at examples below:
+
 Example 1.
 ```ruby
 class User < Db2Query::Base
@@ -94,7 +100,7 @@ end
 ```bash
 irb(main):004:0> User.find_by 10000
   SQL (3.2ms)  SELECT * FROM LIBTEST.USERS WHERE id = ?  [["id", 10000]]
-=> #<Db2Query::Result [#<Record id: 10000, first_name: "Wilma", last_name: "Lindgren", email: "cleveland_kilback@breitenberg.com">]>
+=> #<DB2Query::Result @records=[#<Record id: 10000, first_name: "Strange", last_name: "Stephen", email: "strange@marvel.universe.com">]>
 ```
 Example 2.
 ```ruby
@@ -107,7 +113,7 @@ end
 ```bash
 irb(main):003:0> User.id_greater_than 10000
   SQL (3.2ms)  SELECT * FROM LIBTEST.USERS WHERE id > ?  [["id", 1000]]
-=> #<Db2Query::Result [#<Record id: 10000, first_name: "Wilma", last_name: "Lindgren", email: "cleveland_kilback@breitenberg.com">...">]>
+=> #<Db2Query::Result [#<Record id: 10000, first_name: "Strange", last_name: "Stephen", email: "strange@marvel.universe.com">...">]>
 ```
 Example 3.
 ```ruby
@@ -120,6 +126,9 @@ class User < Db2query::Base
 end
 ```
 ```bash
+irb(main):002:0> User.insert_record [77777, "Ancient", "One", "ancientone@marvel.universe.com"]
+  SQL (3651.2ms)  SELECT * FROM NEW TABLE (INSERT INTO users (id, first_name, last_name, email) VALUES (?, ?, ?, ?))  [["id,", 77777], ["first_name,", "Ancient"], ["last_name,", "One"], ["email)", "ancientone@marvel.universe.com"]]
+=> #<Db2Query::Result [#<Record id: 77777, first_name: "Ancient", last_name: "One", email: "ancientone@marvel.universe.com">]>
 ```
 
 ### 2. Plain/normal method
@@ -134,7 +143,7 @@ end
 Then we can call it by using `find_by` class method.
 ```bash
 irb(main):001:0> User.find_by 10000
-SQL Load (3.28ms)  SELECT * FROM LIBTEST.USERS WHERE id = ? [[nil, 10000]]
+SQL Load (3.28ms)  SELECT * FROM LIBTEST.USERS WHERE id = ? [["id", 10000]]
 => #<DB2Query::Result @records=[#<Record id: 10000, first_name: "Strange", last_name: "Stephen", email: "strange@marvel.universe.com">]>
 ```
 Or with hash arguments input
@@ -154,11 +163,12 @@ SQL Load (3.28ms)  SELECT * FROM LIBTEST.USERS WHERE first_name = ? AND last_nam
 For a reusable sql, we can extend it by using a combination of `extention` and `sql_with_extention` methods,  with an `@extention` pointer at SQL statement.
 ```ruby
 class User < Db2Query::Base
-    # reusable SQL
-	_SQL = -> extention {
+  # reusable SQL
+  _SQL = -> extention {
     sql_with_extention("SELECT * FROM LIBTEST.USERS WHERE @extention", extention)
   }
-    # implementation
+  
+  # implementation
   query :by_email, _SQL.("$email = ?")
 end
 ```

data/lib/db2_query.rb

@@ -15,8 +15,8 @@ module Db2Query
   autoload :Core
   autoload :Result
   autoload :Logger
-  autoload :Base
   autoload :Error
+  autoload :Base
 
   require "db2_query/railtie" if defined?(Rails)
 end

data/lib/db2_query/connection.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "error"
-require "connection_pool"
-
 module Db2Query
   class Bind < Struct.new(:name, :value, :index)
   end
@@ -56,11 +53,11 @@ module Db2Query
       binds, args = extract_binds_from_sql(sql, args)
       sql = db2_spec_sql(sql)
       log(sql, "SQL", binds, args) do
-        run_query(formatters, sql, args, binds)
+        run_query(formatters, sql, binds, args)
       end
     end
 
-    def run_query(formatters, sql, args = [], binds)
+    def run_query(formatters, sql,  binds, args = [])
       pool do |odbc_conn|
         begin
           if args.empty?

data/lib/db2_query/core.rb

@@ -6,20 +6,40 @@ module Db2Query
 
     delegate :run, :do, to: :client
 
-    def initialize(dsn)
-      @dsn = dsn
-      @client = retrieve_db_client
+    def initialize(config)
+      @dsn = config[:dsn]
+      @idle_time_limit = config[:idle] || 5
+      @client = new_db_client
+      @last_active = Time.now
     end
 
-    def retrieve_db_client
+    def expire?
+      Time.now - @last_active > 60 * @idle_time_limit
+    end
+
+    def active?
+      @client.connected?
+    end
+
+    def connected_and_persist?
+      active? && !expire?
+    end
+
+    def disconnect!
+      @client.drop_all
+      @client.disconnect if active?
+      @client = nil
+    end
+
+    def new_db_client
       ODBC.connect(dsn)
     end
 
     def client
-      unless @client.connected?
-        @client = retrieve_db_client
-      end
-      @client
+      return @client if connected_and_persist?
+      disconnect!
+      @last_active = Time.now
+      @client = new_db_client
     end
   end
 
@@ -46,7 +66,7 @@ module Db2Query
       def create_connection
         @@mutex.synchronize do
           return @@connection if @@connection
-          @@connection = Connection.new(config) { DbClient.new(config[:dsn]) }
+          @@connection = Connection.new(config) { DbClient.new(config) }
         end
       end
 

data/lib/db2_query/logger.rb

@@ -12,14 +12,14 @@ module Db2Query
       exception
     end
 
-    def log(sql, name = "SQL", binds = [], type_casted_binds = [], statement_name = nil) # :doc:
+    def log(sql, name = "SQL", binds = [], args = [], &block)
       @instrumenter.instrument(
         "sql.active_record",
         sql:               sql,
         name:              name,
         binds:             binds,
-        type_casted_binds: type_casted_binds,
-        statement_name:    statement_name,
+        type_casted_binds: args,
+        statement_name:    nil,
         connection_id:     object_id,
         connection:        self) do
         @lock.synchronize do

data/lib/db2_query/tasks/database.rake

@@ -7,16 +7,19 @@ DB2_QUERY_DATABASE_TEMPLATE ||= <<-EOF
 
 development:
   dsn: TODO
+  idle: 5
   pool: 5
   timeout: 5
 
 test:
   dsn: TODO
+  idle: 5
   pool: 5
   timeout: 5
 
 production:
   dsn: TODO
+  idle: 5
   pool: 5
   timeout: 5
 EOF

data/lib/db2_query/tasks/initializer.rake

@@ -12,15 +12,15 @@ Db2Query::Base.initiation do |base|
 end
 
 # Example
-class FirstNameFormatter < Db2Query::AbstractFormatter
-  def format(value)
-    "Dr." + value
-  end
-end
+#class FirstNameFormatter < Db2Query::AbstractFormatter
+#  def format(value)
+#    "Dr." + value
+#  end
+#end
 
-Db2Query::Formatter.registration do |format|
-  format.register(:first_name_formatter, FirstNameFormatter)
-end
+#Db2Query::Formatter.registration do |format|
+#  format.register(:first_name_formatter, FirstNameFormatter)
+#end
 EOF
 
 namespace :db2query do

data/lib/db2_query/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Db2Query
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: db2_query
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - yohanes_l
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-04 00:00:00.000000000 Z
+date: 2021-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -84,42 +84,30 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.3
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.3.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.3
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.3.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.5
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.5
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-odbc
   requirement: !ruby/object:Gem::Requirement
@@ -134,7 +122,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A Rails Db2 ODBC adapter
+description: A Rails 5 & Rails 6 plugin for handling Db2 SQL SIUD statement (SELECT,
+  INSERT, UPDATE, DELETE) by using ODBC connection.
 email:
 - yohanes.lumentut@gmail.com
 executables: []
@@ -183,5 +172,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Db2 ODBC adapter
+summary: Rails Db2 ODBC plugin
 test_files: []