Searchkon is Advanced active record search(filter) command that makes easy to search throw models and their relationships.
Lets say we want to return a list of products filtered by multiple parameters. our request contain below parameters:
{
title: 'foobar',
id: [1, 2, 3, 4],
created_at: '(2012-12-21..2019-12-21)'
categories.name: 'mobile'
}
Filter above parameters with Searchkon gem:
Searchkon::QueryBuilder.filter('Product', filters)Add Searchkon to your Gemfile:
gem 'searchkon'at the first we should determine witch columns of model can be filter in Searchkon
class Product < ActiveRecord::Base
has_many :coupons
has_many :payments
def self.searchable_columns
{
like: ['title', 'coupons.code'],
exact: [
'created_at',
'coupons.title', ## relational filter on coupons table
'payments.id', ## relational filter on payments table
'id'
]
}
end
endlike: if you add specific column in your like scope, your query will be like below sql.
select * from products where title like %foo%exact: Searchkon create query using equal operation.
select * from products where created_at = fooparams = {
id: 1,
title: 'foobar'
}Searchkon::QueryBuilder.filter('Product', params)sql result:
SELECT "products".* FROM "products" WHERE (products.title like '%foobar%') AND "products"."id" = 1params = {
id: '(1..10)',
created_at: '(2012-12-21..2019-12-21)'
}sql result:
SELECT "products".* FROM "products" WHERE (products.title like '%foobar%') AND "products"."id" = 1params = {
'coupons.id': [1,4,8]
}sql result:
SELECT "products".* FROM "products" INNER JOIN "coupons" ON "coupons"."product_id" = "products"."id" WHERE "coupons"."id" IN (1, 4, 8)if your filter parameters contain invalid column name, Searchkon skip it and create query without that column.
invalid_mock_params = {
id: 1,
foo: 'foobar'
}Searchkon::QueryBuilder.filter('Product', invalid_mock_params)sql result:
SELECT "products".* FROM "products" WHERE "products"."id" = 1