cloud_controller_ng/lib/cloud_controller/paging/sequel_paginator.rb at b8559b3cc70245c5bd81c08fcbe2d7eb9ca91c8b · cloudfoundry/cloud_controller_ng · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
require 'cloud_controller/paging/paginated_result'

module VCAP::CloudController
  class SequelPaginator
    def get_page(dataset, pagination_options)
      page = pagination_options.page
      per_page = pagination_options.per_page
      order_direction = pagination_options.order_direction
      order_by = pagination_options.order_by
      table_name = dataset.model.table_name
      has_guid_column = dataset.model.columns.include?(:guid)

      order_type = Sequel.send(order_direction, Sequel.qualify(table_name, order_by))
      dataset = dataset.order(order_type)

      dataset = dataset.order_append(Sequel.send(order_direction, Sequel.qualify(table_name, :guid))) if order_by != 'id' && has_guid_column

      distinct_opt = dataset.opts[:distinct]
      if !distinct_opt.nil? && !distinct_opt.empty? # DISTINCT ON
        order_opt = dataset.opts[:order]
        dataset = if order_opt.any? { |o| %i[id guid].include?(o.expression.column.to_sym) }
                    # If ORDER BY columns are unique, use them for the DISTINCT ON clause.
                    dataset.distinct(*order_opt.map(&:expression))
                  else
                    # Otherwise, use DISTINCT.
                    dataset.distinct
                  end
      end

      records, count = if can_paginate_with_window_function?(dataset)
                         paginate_with_window_function(dataset, per_page, page, table_name)
                       else
                         paginate_with_extension(dataset, per_page, page, table_name)
                       end

      PaginatedResult.new(records, count, pagination_options)
    end

    def can_paginate_with_window_function?(dataset)
      enable_paginate_window = Config.config.get(:db, :enable_paginate_window).nil? || Config.config.get(:db, :enable_paginate_window)

      enable_paginate_window && dataset.supports_window_functions? && (!dataset.opts[:distinct] || !dataset.requires_unique_column_names_in_subquery_select_list?)
    end

    private

    def paginate_with_window_function(dataset, per_page, page, table_name)
      dataset = dataset.from_self if dataset.opts[:distinct]

      paged_dataset = dataset.limit(per_page, (page - 1) * per_page)

      paged_dataset = if dataset.opts[:graph]
                        paged_dataset.add_graph_aliases(pagination_total_results: [table_name, :pagination_total_results, Sequel.function(:count).*.over])
                      elsif from_is_table?(dataset)
                        dataset.join_table(
                          :inner,
                          paged_dataset.select(Sequel[table_name][:id].as(:tmp_deferred_id)).
                              select_append(Sequel.as(Sequel.function(:count).*.over, :pagination_total_results)).
                              as(:tmp_deferred_table),
                          Sequel[table_name][:id] => Sequel[:tmp_deferred_table][:tmp_deferred_id]
                        ).select_append(:pagination_total_results)
                      else
                        paged_dataset.select_append(Sequel.as(Sequel.function(:count).*.over, :pagination_total_results))
                      end

      records = paged_dataset.all

      count = records.any? ? records.first[:pagination_total_results] : 0

      records.each do |x|
        x.values.delete(:pagination_total_results)
        x.values.delete(:tmp_deferred_id)
      end
      [records, count]
    end

    def paginate_with_extension(dataset, per_page, page, table_name)
      paged_dataset = dataset.extension(:pagination).paginate(page, per_page)
      count = paged_dataset.pagination_record_count

      if from_is_table?(dataset)
        paged_dataset = dataset.join_table(
          :inner,
          paged_dataset.select(Sequel[table_name][:id].as(:tmp_deferred_id)).as(:tmp_deferred_table),
          Sequel[table_name][:id] => Sequel[:tmp_deferred_table][:tmp_deferred_id]
        )
      end

      records = paged_dataset.all

      has_tmp_deferred_id = records.first&.keys&.include?(:tmp_deferred_id)
      records.each { |x| x.values.delete(:tmp_deferred_id) } if has_tmp_deferred_id

      [records, count]
    end

    def from_is_table?(dataset)
      [Symbol, String].include?(dataset.opts[:from].first.class)
    end
  end
end