Class: Dbviewer::Datatable::QueryParams

Inherits:
Object
  • Object
show all
Defined in:
lib/dbviewer/datatable/query_params.rb

Overview

QueryParams encapsulates parameters for table querying operations

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(page: 1, order_by: nil, direction: "ASC", per_page: nil, column_filters: nil, max_records: 1000) ⇒ QueryParams

Initialize query parameters with defaults

Parameters:

  • page (Integer) (defaults to: 1) —

    Page number (1-based)

  • order_by (String, nil) (defaults to: nil) —

    Column to sort by

  • direction (String) (defaults to: "ASC") —

    Sort direction (‘ASC’ or ‘DESC’)

  • per_page (Integer, nil) (defaults to: nil) —

    Number of records per page

  • column_filters (Hash, nil) (defaults to: nil) —

    Hash of column filters

  • max_records (Integer) (defaults to: 1000) —

    Maximum number of records to fetch



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/dbviewer/datatable/query_params.rb', line 14

def initialize(
  page: 1,
  order_by: nil,
  direction: "ASC",
  per_page: nil,
  column_filters: nil,
  max_records: 1000
)
  @page = [ 1, page.to_i ].max
  @order_by = order_by
  @direction = normalize_direction(direction)
  @per_page = normalize_per_page(per_page || 25, max_records)
  @column_filters = column_filters || {}
  @max_records = max_records
end

Instance Attribute Details

#column_filters ⇒ Object (readonly)

Returns the value of attribute column_filters.



5
6
7
 
# File 'lib/dbviewer/datatable/query_params.rb', line 5

def column_filters
  @column_filters
end

#direction ⇒ Object (readonly)

Returns the value of attribute direction.



5
6
7
 
# File 'lib/dbviewer/datatable/query_params.rb', line 5

def direction
  @direction
end

#max_records ⇒ Object (readonly)

Returns the value of attribute max_records.



5
6
7
 
# File 'lib/dbviewer/datatable/query_params.rb', line 5

def max_records
  @max_records
end

#order_by ⇒ Object (readonly)

Returns the value of attribute order_by.



5
6
7
 
# File 'lib/dbviewer/datatable/query_params.rb', line 5

def order_by
  @order_by
end

#page ⇒ Object (readonly)

Returns the value of attribute page.



5
6
7
 
# File 'lib/dbviewer/datatable/query_params.rb', line 5

def page
  @page
end

#per_page ⇒ Object (readonly)

Returns the value of attribute per_page.



5
6
7
 
# File 'lib/dbviewer/datatable/query_params.rb', line 5

def per_page
  @per_page
end