db2_query 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a62d60225cd34e421f6d6fd8becf1d45bb6e0ffb35db266bac881734a4b15340
-  data.tar.gz: 8b02f4869439de1dcdb14cfca0f731ee99ce143f504b6a56c7e04db74684da65
+  metadata.gz: a863b9451d52ea28e71b1477cfd7275bb76b34c91a1302208f4052674dc7b901
+  data.tar.gz: 555eafaa282e3cab7a0d4231592a6d2a6d3087d0c194f98040dff1724f5da0f2
 SHA512:
-  metadata.gz: a684c13ff35469b6f53c13b0bcd2c21c997b9b51abce517bc66ca920a4cc764ae885a1746b1e256d50945cc038d240739c8de72045b899af6e63421b8a520c24
-  data.tar.gz: a2698708b312200a55f93334c5f27b5345f9b0515a6ca8aee82926562388178588766bb708959178f26488774a3994a5e88f2181691e8604f9d7ac6f62a2dcfb
+  metadata.gz: 917d8a2a7a1eefbb85185d021642f42115e7fd51969b302752f1284e274799fca9d7b24c3f6a7fdc764fa9a79cfd6cac7245e4500b0005d5e498f1e718e63a5b
+  data.tar.gz: 353f50ef752eaaee361c939c21f6552e4fa5c8b5bc81a0face640aae420d889fcb1fb148bd0d7b74e8fec3b1867ffa31df9996cacb05465302e512ec0a5d2147

data/README.md

@@ -1,4 +1,4 @@
-# DB2Query
+# Db2Query
 
 [![Gem Version](https://badge.fury.io/rb/db2_query.svg)](https://badge.fury.io/rb/db2_query)
 
@@ -6,7 +6,7 @@ A Rails 5 & Rails 6 plugin for handling Db2 SQL database `SIUD` statement (`SELE
 
 Note: Tested at Rails 5.2.6 and Rails 6.1.4
 
-## Installation
+## 1. Installation
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -22,20 +22,18 @@ Or install it yourself as:
 ```bash
 $ gem install db2_query
 ```
-
-## Initialization
-Execute init task at the app root
+## 2. Initialization
+Execute **db2query:init** task at the app root to create database configurations and initializer file.
 ```bash
 $ rake db2query:init
+      create  config/db2query.yml
+      create  config/initializers/db2query.rb
 ```
-Db2Query will generate two required files:
-- `config/db2query.yml`
-- `config/initializers/db2query.rb`
 
-Edit those files according to the requirement.
+Complete the configurations by editing the files according to your application requirement.
 
 ### Database Configuration
-At version 0.3.0, `db2query.yml` only use DSN connection config:
+File **config/db2query.yml** consist of DSN/database name and connection pool config:
 ```yml
   development:
      dsn: ARUNIT
@@ -54,201 +52,452 @@ At version 0.3.0, `db2query.yml` only use DSN connection config:
      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.
+Key **idle** is a **client** idle maximum limit value (in minutes) to avoid the client being 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 your application idle in a certain period of time.
 
-Ensure that `unixodbc` have been installed and test your connection first by using `isql` commands.
+[**Ensure**](https://github.com/yohaneslumentut/db2_query/wiki/DB2-ODBC-Connection#verify-odbc-connection) that **unixodbc** has been installed and test your connection first by using **isql** commands.
 
-Example:
+### Initializer File
+This file is used by **Db2Query::Base** to load **field types** configurations and establish a **connection** instance.
+```ruby
+# app_root/config/initializers/db2query.rb
 
-ARUNIT DSN connection test
-```bash
-$ isql -v ARUNIT
-+---------------------------------------+
-| Connected!                            |
-|                                       |
-| sql-statement                         |
-| help [tablename]                      |
-| quit                                  |
-|                                       |
-+---------------------------------------+
-SQL> 
+require "db2_query"
+
+Db2Query::Base.initiation do |base|
+  base.set_field_types  # or base.set_field_types(CUSTOM_FIELD_TYPES) if you have CUSTOM TYPES
+  base.establish_connection
+end
+```
+
+### Custom Field Type
+**FieldTypes** are classes that used by **Db2Query** to format the data before sending it to the database by using `serialize` method and converting the **query result** before consumed by your **Rails application** by using `deserialize` method. Both `serialize` and `deserialize` operations are only applied when you provide **QueryDefinitions** on your query. By default, there are ten field types that can be used in your [query definitions](#32-querydefinitions) :
+
+```ruby
+  DEFAULT_FIELD_TYPES = {
+    binary: Db2Query::Type::Binary,
+    boolean:  Db2Query::Type::Boolean,
+    string: Db2Query::Type::String,
+    varchar: Db2Query::Type::String,
+    longvarchar: Db2Query::Type::String,
+    decimal: Db2Query::Type::Decimal,
+    integer: Db2Query::Type::Integer,
+    date: Db2Query::Type::Date,
+    time: Db2Query::Type::Time,
+    timestamp: Db2Query::Type::Timestamp
+  }
 ```
+You can use your own Field type class by extending **Db2Query::Type::Value** class. For example:
+```ruby
+  class CustomTypeClass < Db2Query::Type::Value
+    # Method to convert data from ruby type value into data that is understood by Db2
+    def serialize(value)
+      # Your logic 
+    end
+   
+    # Method to convert Db2 database output data type that is recognized by your rails app
+    def deserialize(value)
+      # Your logic
+    end
+ end
+```
+Then map the classes into a variable and load it into the **Db2Query::Base** by using **set_field_types** method in the initializer file.
+```ruby
+# app_root/config/initializers/db2query.rb
+
+require "db2_query"
+ 
+CUSTOM_FIELD_TYPES = {
+   binary: CustomBinaryTypeClass
+   integer: CustomIntegerTypeClass
+   string: CustomStringTypeClass
+   ...
+}
+
+Db2Query::Base.initiation do |base|
+  base.set_field_types(CUSTOM_FIELD_TYPES)
+  base.establish_connection
+end
 
-## Usage
-Note: Version 0.1.0 use `Db2Query` namespace. Version 0.2 use `DB2Query`. At version 0.3.0 we use `Db2Query`  , revert back to the previous namespace.
+```
 
-### Basic Usage
-Create query class that inherit from `DB2Query::Base` in `app/queries` folder. 
+## 3. Usage
 
-Note: `$`symbol is used as column name prefix.
+Once you completely do [**Installation**](#1-installation) & [**Initialization**](#2-initialization), basically you has been ready to use **Db2Query::Base** with three additional conventions: **SQL Convention**, **Field Type Convention**, **Argument Key Convention**.
 
-### 1. `query` method
-The `query` method must have 2 inputs:
-1. Method name
-2. Body (can be an SQL statement or lamda).
+**SQL Convention**:
+> **"** Dollar symbol **$** is used as the prefix of all column names **in the WHERE clause** of provided **Parameterized Query** SQL string. It is used as a pointer in the binding process of key and value of query arguments. We have to provide it manually in the SQL string of each **Parameterized Query**. Here, **Parameterized Query** is used to minimize SQL injection risks.**"**
+
+**Field Type Convention**:
+> **"** **field_name** written in **query_definition** block must be in downcased format.**"**
+
+**Argument Key Convention**:
+> **"** **Argument Key** passed into query have to follow its parameter written in the SQL. It is case-sensitive. If the parameter in your SQL is written in downcase format, then your argument key has to be in downcase format too.**"**
 
-The lambda is used to facilitate us in using `built-in methods` as shown at examples below:
 
-Example 1.
 ```ruby
-class User < Db2Query::Base
-  query :find_by, <<-SQL
-    SELECT * FROM LIBTEST.USERS WHERE $id = ?
-  SQL
+# SQL Convention Examples
+# Example of Parameterized Query SQL usage
+
+Db2Query::Base.query("SELECT * FROM USERS WHERE $email = ?", "my_account@email.com")
+
+# Example of Normal SQL usage
+
+Db2Query::Base.query("SELECT * FROM USERS WHERE email = 'my_account@email.com'")
+
+# Field Type Convention Example
+
+module Definitions
+  class UsersQueryDefinitions < Db2Query::Definitions
+    def describe
+      query_definition :all do |c|
+        c.id          :integer
+        c.first_name  :varchar
+        c.last_name   :varchar
+        c.email       :varchar
+      end
+    end
+  end
 end
+
+# Argument Key Convention Example
+
+MyQuery.find_user_by_id id: 10000
+
 ```
-```bash
-irb(main):004:0> User.find_by 10000
-  SQL (3.2ms)  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">]>
+
+
+### 3.1 Basic Usage
+
+#### Base Class Query Methods
+
+##### #query(sql, args)
+A raw query to perform a `connection.run(sql, args)` operation and returns an array of hashes representing each row record being executed.
+```ruby
+Db2Query::Base.query("SELECT * FROM USERS WHERE $id < ?", 10003)
+=> [{:id=>10000, :first_name=>"Taisha", :last_name=>"Kutch", :email=>"willie.lesch@toy.org"}, {:id=>10001, :first_name=>"Setsuko", :last_name=>"Kutch", :email=>"thelma@purdy.co"}, {:id=>10002, :first_name=>"Trina", :last_name=>"Mayer", :email=>"dorsey_upton@flatley-gulgowski.name"}]
 ```
-Example 2.
+
+##### #query_rows(sql)
+Execute the `SELECT Statement SQL` and returns collections of arrays consisting of row values.
 ```ruby
-class User < Db2query::Base
-  query :id_greater_than, -> id {
-    exec_query({}, "SELECT * FROM LIBTEST.USERS WHERE $id > ?", [id])
-  }
+Db2Query::Base.query_rows("SELECT * FROM USERS WHERE id < 10003")
+=> [[10000, "Taisha", "Kutch", "willie.lesch@toy.org"], [10001, "Setsuko", "Kutch", "thelma@purdy.co"], [10002, "Trina", "Mayer", "dorsey_upton@flatley-gulgowski.name"]]
+```
+
+##### #query_value(sql)
+Execute the `SELECT Statement SQL` and returns the first value of the query results first row.
+```ruby
+Db2Query::Base.query_value("SELECT * FROM USERS WHERE id < 10003")
+=> 10000
+```
+
+##### #query_values(sql)
+Execute the `SELECT Statement SQL` and returns a collection of the first value of each query result rows.
+```ruby
+Db2Query::Base.query_values("SELECT * FROM USERS WHERE id < 10003")
+=> [10000, 10001, 10002]
+```
+
+##### #execute(sql, args)
+A method to execute `DUI Statement SQL` by using `connection.do(sql, args)`
+```ruby
+Db2Query::Base.execute("DELETE FROM users WHERE $id = ?", 10000)
+=> -1
+```
+
+### 3.2 QueryDefinitions
+
+QueryDefinitions is helpful when you need formatter methods that **serialize** the data before it being sent to the database and **deserialize** database output data before being consumed by **Rails application**. The real examples are **Binary** and **Boolean** field types.
+At **Db2Query::Type::Binary**, the data `unpacked` by `serialize` method before sending to the database and do `deserialize` operation to `pack` the database returned data.
+QueryDefinition can be used as **Query Schema** where the **field types** of a query are outlined. The field-type written in QueryDefinition has to follow the **Field Type Convention**.
+
+A QueryDefinitions reside in `app_root/app/queries/definitions` directory. It is automatically created when you create your query by using run `rails g query query_name` [**generator**](#33-generator) command. The QueryDefinitions class can be defined as follow:
+```ruby
+# app_root/app/queries/definitions/your_query_definitions.rb
+module Definitions
+  class YourQueryDefinitions < Db2Query::Definitions
+    def describe  # method that is used by Db2Query to describe your query definition
+      query_definition :your_first_query_name do |c|
+        c.field_name     :field_type, options 
+        ...
+      end
+
+      query_definition :your_next_query_name do |c|
+        c.field_name     :field_type, options 
+        ...
+      end
+    end
+  end
 end
 ```
+For Example:
+
+```ruby
+# app_root/app/queries/definitions/users_query_definitions.rb
+
+module Definitions
+  class UsersQueryDefinitions < Db2Query::Definitions
+    def describe
+      query_definition :all do |c|
+        c.id          :integer
+        c.first_name  :varchar
+        c.last_name   :varchar
+        c.email       :varchar
+      end
+
+      query_definition :insert do |c|
+        c.id          :integer
+        c.first_name  :varchar
+        c.last_name   :varchar
+        c.email       :varchar
+      end
+    end
+  end
+end
+
+```
+
+
+### 3.3 Generator
+
+Create query class by using `rails g query NAME` commands. For example:
+
 ```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: "Strange", last_name: "Stephen", email: "strange@marvel.universe.com">...">]>
+$ rails g query NameSpace::Name --defines=first_query --queries=next_query  --lambdas=last_query
+    create app/queries/name_space/name_query.rb
+    create  app/queries/definitions/movies_query_definitions.rb
+    create test/queries/name_space/name_query_test.rb
 ```
-Example 3.
+This will create `app/queries/name_space/name_query.rb` file in `app/queries` directory.
+
 ```ruby
-class User < Db2query::Base
-  query :insert_record, -> args {
-    exec_query({},
-      "INSERT INTO users ($id, $first_name, $last_name, $email) VALUES (?, ?, ?, ?)", args
-  )
-}
+module NameSpace
+  class Name < Db2Query::Base
+    def first_query_sql
+
+    end
+
+    query :next_query, <<-SQL
+
+    SQL
+
+    query :last_query, -> {
+      
+    }
+  end
 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">]>
+
+```ruby
+# app_root/app/queries/definitions/name_space/name_query.rb
+
+module Definitions
+  module NameSpace
+    class NameQueryDefinition < Db2Query::Definitions
+      def describe  # method that is used by Db2Query to describe your query definition
+        query_definition :first_query do |c|
+
+        end
+
+        query_definition :next_query do |c|
+
+        end
+
+        query_definition :last_query do |c|
+
+        end
+      end
+    end
+  end
+end
 ```
 
-### 2. Plain/normal method
-At a plain/normal sql method we add `_sql` suffix. For example `find_by_sql`
+Please run `rails g query --help` to get more information on how to use the file generator.
+
+### 3.4 Queries Methods
+
+In a **Query** class that extends **Db2Query::Base** class, there are 3 ways of query implementation:
+
 ```ruby
-class User < Db2Query::Base 
-  def find_by_sql
-    "SELECT * FROM LIBTEST.USERS WHERE $id = ?"
+class MyQuery < Db2Query::Base
+  # 1. Plain Query (--defines)
+  def query_name_sql
+    "YOUR AMAZING SQL STATEMENT STRING"
   end
+
+  # 2. String Query (--queries)
+  query :query_name, <<-SQL
+    YOUR AMAZING SQL STATEMENT
+  SQL
+
+  # 3. Lambda Query (--lambdas)
+  query :query_name, -> args {
+    # implement fetch, fetch_list, and exec_query
+     fetch("YOUR AMAZING SQL", args)
+  }
 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 = ? [["id", 10000]]
-=> #<DB2Query::Result @records=[#<Record id: 10000, first_name: "Strange", last_name: "Stephen", email: "strange@marvel.universe.com">]>
+
+#### 3.4.1 Plain Query (--defines)
+Query implementation that uses the plain method. The method name must have a `_sql` suffix and return SQL statement string.
+
+Example:
+```ruby
+class MyQuery < Db2Query::Base
+  def all_users_sql
+    "SELECT * FROM USERS"
+  end
+
+  def find_user_by_id_sql
+    "SELECT * FROM USERS WHERE $id = ?"
+  end
+end
 ```
-Or with hash arguments input
+
+#### 3.4.2 String Query (--queries)
+Query implementation that uses the built-in `query` method. The input arguments consist of `query_name` symbol and SQL statement
+
+Example:
 ```ruby
-class User < Db2Query::Base
-  def by_name_and_email_sql
-    "SELECT * FROM LIBTEST.USERS WHERE $first_name = ? AND $email = ?"
+class MyQuery < Db2Query::Base
+  query :all_users, <<-SQL
+    SELECT * FROM USERS
+  SQL
+
+  query :find_user_by_id, <<-SQL
+    SELECT * FROM USERS WHERE $id = ?
   end
 end
 ```
+
+#### 3.4.3 Lambda Query (--lambdas)
+Query implementation that uses the built-in `query` method. The input arguments consist of the `query_name` symbol and a lambda function. We have to pass `args` as the arguments of a lambda function. Do not change the `args` with let's say `-> id, email { ... }`. Just leave it written as `args`. The `args` is used by `Db2Query::Base` to store `query_name` and the other `arg` inputs.
+
+Example:
+```ruby
+class MyQuery < Db2Query::Base
+  query :all_users, -> args {
+    fetch("SELECT * FROM USERS", args)
+  }
+
+  query :find_user_by_id, -> args {
+    fetch("SELECT * FROM USERS WHERE $id = ?", args)
+  }
+end
+```
+
+Then you can call all three example with the same methods:
+
 ```bash
-irb(main):001:0> User.by_name_and_email first_name: "Strange", email: "strange@marvel.universe.com"
-SQL Load (3.28ms)  SELECT * FROM LIBTEST.USERS WHERE first_name = ? AND last_name = ? [["first_name", Strange], ["email", strange@marvel.universe.com]]
-=> #<DB2Query::Result @records=[#<Record id: 10000, first_name: "Strange", last_name: "Stephen", email: "strange@marvel.universe.com">]>
+irb(main):001:0> MyQuery.all_users
+  SQL (2.7ms)  SELECT * FROM USERS
+=> #<Db2Query::Result [#<Record id: 10000, first_name: Yohanes, ...]>
+
+irb(main):001:0> MyQuery.find_user_by_id 10000
+  SQL (3.0ms)  SELECT * FROM USERS WHERE id = ?  [["id", 10000]]
+=> #<Db2Query::Result [#<Record id: 10004, first_name: Yohanes, ...]>
 ```
-###  SQL extention (`@extention`)
-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.
+If you pass a key-value argument into query, the key has to follow **Argument Key Convention**
+
+```bash
+irb(main):001:0> MyQuery.find_user_by_id(id: 10000)
+  SQL (3.0ms)  SELECT * FROM USERS WHERE id = ?  [["id", 10000]]
+=> #<Db2Query::Result [#<Record id: 10004, first_name: Yohanes, ...]>
+
+```
+
+And use it at your application
+```ruby
+users = MyQuery.all
+user_records = users.records
+user_1 = user_records.first
+user_1.id         # => 10000
+user_1.first_name # => "Yohanes"
+user_1.last_name  # => "Lumentut"
+user_1.email      # => "yohanes@github.com"
+
+user_1 == users.record   # => true
+
+user = MyQuery.find_user_by_id id: 10000
+user.id         # => 10000
+user.first_name # => "Yohanes"
+user.last_name  # => "Lumentut"
+user.email      # => "yohanes@github.com"
+```
+
+### 3.5 SQL extention (`@extention`)
+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
+class MyQuery < Db2Query::Base
   # reusable SQL
   _SQL = -> extention {
-    sql_with_extention("SELECT * FROM LIBTEST.USERS WHERE @extention", extention)
+    sql_with_extention("SELECT * FROM USERS WHERE @extention", extention)
   }
   
   # implementation
-  query :by_email, _SQL.("$email = ?")
+  query :user_by_email, _SQL.("$email = ?")
 end
 ```
 ```bash
-irb(main):004:0> User.by_email "strange@marvel.universe.com"
-  SQL (3.2ms)  SELECT * FROM LIBTEST.USERS WHERE email = ?  [["email", "strange@marvel.universe.com"]]
-=> #<DB2Query::Result @records=[#<Record id: 10000, first_name: "Strange", last_name: "Stephen", email: "strange@marvel.universe.com">]> 
+irb(main):001:0> MyQuery.user_by_email
+  SQL (2.7ms)  SELECT * FROM USERS email = ?  [["email", "yohanes@github.com"]]
+=> #<Db2Query::Result [#<Record id: 10000, first_name: Yohanes, ...]>
 ```
-### List input (`@list`)
+```ruby
+user = MyQuery.user_by_email "yohanes@github.com"
+user.id         # => 10000
+user.first_name # => "Yohanes"
+user.last_name  # => "Lumentut"
+user.email      # => "yohanes@github.com"
+```
+### 3.6 List input (`@list`)
 For an array consist list of inputs, we can use `fetch_list` method and `@list` pointer at the SQL statement.
 
 ```ruby
-class User < Db2Query
-  query :by_ids, -> ids {
-    fetch_list("SELECT * FROM LIBTEST.USERS WHERE ID IN (@list)", ids)
+class MyQuery < Db2Query::Base
+  query :user_by_ids, -> args {
+    fetch_list("SELECT * FROM USERS WHERE ID IN (@list)", args)
   }
 end
 ```
 ```bash
-irb(main):007:0> User.by_ids [10000,10001,10002]
-  SQL (2.8ms)  SELECT * FROM LIBTEST.USERS WHERE ID IN ('10000', '10001', '10002')
+irb(main):007:0> MyQuery.user_by_ids [10000,10001,10002]
+  SQL (2.8ms)  SELECT * FROM USERS WHERE ID IN ('10000', '10001', '10002')
 => #<Db2Query::Result [#<Record id: 10000, name: "Carol", last_name: "Danvers", email: "captain.marvel@marvel.universe.com">, #<Record id: 10001, first_name: "Natasha", last_name: "Romanova", email: "black.widow@marvel.universe">, #<Record id: 10002, first_name: "Wanda", last_name: "Maximoff", email: "scarlet.witch@marvel.universe.com">]>
 
 ```
-
-### Formatter
-In order to get different result column format, a query result can be reformatted by adding a formatter class that inherits `DB2Query::AbstractFormatter` then register at `config\initializers\db2query.rb`
 ```ruby
-require "db2_query/formatter"
-
-# create a formatter class
-class FirstNameFormatter < Db2Query::AbstractFormatter
-  def format(value)
-    "Dr." + value
-  end
-end
-
-# register the formatter class
-Db2Query::Formatter.registration do |format|
-  format.register(:first_name_formatter, FirstNameFormatter)
-end
-```
-Use it at query class
-```ruby
-class Doctor < User
-  attributes :first_name, :first_name_formatter
-end
-```
-Check it at rails console
-```bash
-Doctor.find_by id: 10000
-SQL Load (3.28ms)  SELECT * FROM LIBTEST.USERS WHERE id = ? [["id", 10000]]
-=> #<DB2Query::Result @records=[#<Record id: 10000, first_name: "Dr.Strange", last_name: "Stephen", email: "strange@marvel.universe.com">]>
+users = MyQuery.user_by_ids [10000,10001,10002]
+user = users.first
+user == users.record # => true
+
+user.id         # => 10000
+user.first_name # => "Carol"
+user.last_name  # => "Danvers"
+user.email      # => "captain.marvel@marvel.universe.com"
 ```
 
-For complete examples please see the basic examples [here](https://github.com/yohaneslumentut/db2_query/blob/master/test/dummy/app/queries/test_query.rb).
+### 3.7 Formatter
+For the latest version of **Db2Query**, there is no more **Db2Query::Formatter** class. We can implement our formater into **deserialize** method of our [**QueryDefinitions**](#32-querydefinitions).
 
-### Available Result Object methods
+If you upgrade from the previous version, you have to run **`rake db2query:init`** again to override the initializer. Please create a backup of your Formatter classes before you do this operation. Then you can implement your Formatter methods into your **QueryDefinitions**.
+
+## 4. Available Result Object methods
 `Db2Query::Result` inherit all `ActiveRecord::Result` methods with additional custom methods:
-  1. `records` to convert query result into array of Record objects.
-  2. `to_h` to convert query result into hash with symbolized keys.
+  1. `records` to convert query result into an array of Result query's Record objects.
+  2. `record` to get the first Record Object of Result query.
+  3. `to_h` to convert query result into an array of hashes with symbolized keys.
 
-### Built-in methods
-These built-in methods are delegated to `Db2Query::Connection` methods
-  1. `query_rows(sql)`
-  2. `query_value(sql)`
-  3. `query_values(sql)`
-  4. `execute(sql)`
-  5. `exec_query(formatters, sql, args = [])`
-They behave just likely `ActiveRecords` connection's public methods.
+## 5. ActiveRecord Combination
 
-### ActiveRecord Combination
+Create an abstract class that inherits from `ActiveRecord::Base`. We have to implement `splat` operator correctly at the arguments to make it works.
 
-Create an abstract class that inherit from `ActiveRecord::Base`
 ```ruby
 class Db2Record < ActiveRecord::Base
   self.abstract_class = true
 
-  def self.query(formatter, sql, args = [])
-    Db2Query::Base.connection.exec_query(formatter, sql, args).to_a.map(&:deep_symbolize_keys)
+  def self.query(sql, args)
+    Db2Query::Base.query(sql, *args)
   end
 end
 ```
@@ -257,32 +506,35 @@ Utilize the goodness of rails model `scope`
 ```ruby
 class User < Db2Record
   scope :by_name, -> *args {
-    query(
-      {}, "SELECT * FROM LIBTEST.USERS WHERE $first_name = ? AND $last_name = ?", args
-    )
+    query("SELECT * FROM USERS WHERE $first_name = ? AND $last_name = ?", args)
   }
 end
 ```
+
 ```bash
 User.by_name first_name: "Strange", last_name: "Stephen"
-SQL Load (3.28ms)  SELECT * FROM LIBTEST.USERS WHERE first_name = ? AND last_name = ? [["first_name", Strange], ["last_name", Stephen]]
+SQL Load (3.28ms)  SELECT * FROM USERS WHERE first_name = ? AND last_name = ? [["first_name", Strange], ["last_name", Stephen]]
 => [{:id=> 10000, :first_name=> "Strange", :last_name=> "Stephen", :email=> "strange@marvel.universe.com"}]
 ```
 
 Another example:
 ```ruby
 class User < Db2Record
-  scope :age_gt, -> age {
-    query("SELECT * FROM LIBTEST.USERS WHERE age > #{age}")
+  scope :age_gt, -> *args {
+    query("SELECT * FROM USERS WHERE age > ?", args)
   }
 end
 ```
 
 ```bash
 User.age_gt 500
-SQL Load (3.28ms)  SELECT * FROM LIBTEST.USERS WHERE age > 500
+SQL Load (3.28ms)  SELECT * FROM USERS WHERE age > 500
 => [{:id=> 99999, :first_name=> "Ancient", :last_name=> "One", :email=> "ancientone@marvel.universe.com"}]
 ```
 
-## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+## 6. Examples
+
+For complete examples please see the basic examples [here](https://github.com/yohaneslumentut/db2_query/blob/master/test/dummy/app/queries/user_query.rb).
+
+## 7. License
+The gem is available as open-source under the terms of the [MIT License](https://opensource.org/licenses/MIT).