如何通过 ransack gem 搜索数组？答案

【问题标题】：How to search array through ransack gem?如何通过 ransack gem 搜索数组？
【发布时间】：2016-07-16 10:14:55
【问题描述】：

我正在使用ransack gem 在 Rails 应用程序中进行搜索。我需要在User 表中搜索email_ids 的数组。

参考this洗劫时的问题，我按照步骤将其添加到初始化文件夹ransack.rb

Ransack.configure do |config|
   {
    contained_within_array: :contained_within,
    contained_within_or_equals_array: :contained_within_or_equals,
    contains_array: :contains,
    contains_or_equals_array: :contains_or_equals,
    overlap_array: :overlap
   }.each do |rp, ap|
   config.add_predicate rp, arel_predicate: ap, wants_array: true
  end
end

在 Rails 控制台中，如果我这样做：

a = User.search(email_contains_array: ['priti@gmail.com'])

它会产生这样的 sql：

"SELECT \"users\".* FROM \"users\" WHERE \"users\".\"deleted_at\" IS NULL AND (\"users\".\"email\" >> '---\n- priti@gmail.com\n')"

并给出如下错误：

  User Load (1.8ms)  SELECT "users".* FROM "users" WHERE "users"."deleted_at" IS NULL AND ("users"."email" >> '---
- priti@gmail.com
')
 ActiveRecord::StatementInvalid: PG::UndefinedFunction: ERROR: operator does not exist: character varying >> unknown
 LINE 1: ...RE "users"."deleted_at" IS NULL AND ("users"."email" >> '---
                                                            ^
 HINT:  No operator matches the given name and argument type(s). You might need to add explicit type casts.
 : SELECT "users".* FROM "users" WHERE "users"."deleted_at" IS NULL AND ("users"."email" >> '---
 - priti@gmail.com
')

预期是这个查询：

SELECT "users".* FROM "users"  WHERE ("users"."roles" @> '{"3","4"}')

我做错了什么？

【问题讨论】：

标签： ruby-on-rails ruby postgresql activerecord ransack

【解决方案1】：

我遇到了和你一样的问题。我正在使用 Rails 5，我需要在 User 表中搜索 roles 数组

您的gemfile中似乎已经添加了postgres_ext gem，但是如果您在Rails 5应用程序中使用它会出现一些问题。

所以你可以选择自己在Arel Node中添加contain查询，而不是使用postgres_ext gem

如果您使用的是其他版本的 Rails，我认为它也可以正常工作。

我有一个User 模型和一个数组属性roles。我想要做的是使用ransack 搜索roles。情况和你一样。

ransack 无法搜索数组。但是PostgresSQL 可以像这样搜索数组：

User.where("roles @> ?", '{admin}').to_sql)

它会产生这样的 sql 查询：

SELECT "users".* FROM "users" WHERE "users"."deleted_at" IS NULL AND (roles @> '{admin}')

所以我想做的是在Arel Nodes中添加一个类似的包含查询

你可以做到this way:

# app/config/initializers/arel.rb

require 'arel/nodes/binary'
require 'arel/predications'
require 'arel/visitors/postgresql'

module Arel
  class Nodes::ContainsArray < Arel::Nodes::Binary
    def operator
      :"@>"
    end
  end

  class Visitors::PostgreSQL
    private

    def visit_Arel_Nodes_ContainsArray(o, collector)
      infix_value o, collector, ' @> '
    end
  end

  module Predications
    def contains(other)
      Nodes::ContainsArray.new self, Nodes.build_quoted(other, self)
    end
  end
end

因为你可以自定义 ransack 谓词，所以添加contains Ransack 谓词，如this：

# app/config/initializers/ransack.rb

Ransack.configure do |config|
  config.add_predicate 'contains',
    arel_predicate: 'contains',
    formatter: proc { |v| "{#{v}}" },
    validator: proc { |v| v.present? },
    type: :string
end

完成！

现在，你可以搜索数组了：

User.ransack(roles_contains: 'admin')

SQL 查询将是这样的：

SELECT \"users\".* FROM \"users\" WHERE \"users\".\"deleted_at\" IS NULL AND (\"users\".\"roles\" @> '{[\"admin\"]}')

是的！

【讨论】：

我建议您将config.add_predicate 'contains' 更改为config.add_predicate 'contains_array'，否则您将破坏其他类型列的其他contains 功能。因为我按照您在此处所做的操作并注意到了这种副作用。
这将对 Ransack gem 提出一个很好的拉取请求。 github.com/activerecord-hackery/ransack/issues/897

【解决方案2】：

我使用可搜索范围实现了这一点。

其中 Author 有一个由字符串数组组成的列“隶属关系”。

scope :affiliation_includes, ->(str) {where("array_to_string(affiliation,',') ILIKE ?", "%#{str}%")}
def self.ransackable_scopes(auth_object=nil) 
    [:affiliation_includes]
  end

那么下面的工作

Author.ransack(affiliation_includes:'dresden')

与使用 postgres '@>' 相比，它的优势在于它可以匹配数组中的子字符串，因为 where 命令中的 %（去掉 % 以匹配整个字符串）。它也是不区分大小写的（使用 LIKE 而不是 ILIKE 区分大小写。

【讨论】：