rummage_ecto下载 - rummage_ecto源代码下载

rummage_ecto

其他源码

More

下载

翻箱倒柜

如果您正在寻找完整的Phoenix支持， Rummage.Phoenix使用Rummage.Ecto并向其添加HTML和Controller支持。您可以点击此处查看Rummage.Phoenix

请参阅变更日志以了解版本特定的更改

Rummage.Ecto是一个轻量级但功能强大的框架，可用于通过搜索、排序和分页操作来更改Ecto查询。

它通过使用Hooks来完成上述操作，Hooks 是实现Rummage.Ecto.Hook行为的模块。每个操作： Search 、 Sort和Paginate都在Rummage中定义了它们的钩子。通过这样做， Rummage是完全可配置的。

例如，如果您不喜欢Rummage的其中一个钩子，但喜欢另外两个，则可以将Rummage配置为不使用它并编写自己的自定义钩子。

注意： Rummage不像Ransack ，而且它也不打算像Ransack那样。它不定义基于搜索参数的函数。如果您想要类似的功能，您可以随时将Rummage配置为使用该模型的Search模块。这就是 Rummage 变得可配置的原因。

要查看rummage的示例用法，请检查此存储库。

安装

该软件包以十六进制形式提供，可以安装为：

将rummage_ecto添加到mix.exs中的依赖项列表中：

 def deps do
  [ { :rummage_ecto , "~> 2.0.0-rc.0" } ]
end

博客

当前博客：

翻查演示和基础知识
使用 Rummage.Ecto
使用 Rummage.Phoenix：第 1 部分

接下来：

使用 Rummage.Phoenix：第 2 部分
使用翻查搜索挂钩
使用 Rumage Sort 钩子
编写自定义 Rummage.Ecto Hook
编写自定义 Rummage.Phoenix HTML 帮助器

挂钩

挂钩是模块（使用Rummage.Ecto.Hook ）并实现Rummage.Ecto.Hook行为的回调。每个可以转换查询的 ecto 操作都由Hook定义。 Hooks 有run/2函数，使用它可以转换Ecto.Queryable变量，并有format_params/3函数，使用它可以转换通过rummage_ecto传递给它们的参数

配置

注意：这是可选的。如果未提供配置， Rummage将使用默认挂钩和AppName.Repo作为存储库
如果您想覆盖任何Rummage默认挂钩，请将rummage_ecto配置添加到dev.exs中的配置列表中：
```
 config :rummage_ecto ,
  Rummage.Ecto ,
  search: MyApp.SearchModule
```

用于配置存储库：

 config :rummage_ecto ,
  Rummage.Ecto ,
  repo: MyApp.Repo # This can be overridden per model basis, if need be.

其他配置选项有： repo 、 sort 、 paginate 、 per_page
Rummage.Ecto可以使用per_page值进行全局配置（可以为模型覆盖）。如果您想为不同的模型设置不同的per_page ，请在使用Rummage.Ecto时将其添加到model.exs文件中，如高级用法部分所示。

用法

Rummage.Ecto具有许多强大的功能，无需编写大量代码即可立即使用。

以下是Rummage.Ecto使用方法：

基本用法：

将应用程序的Repo和所需的per_page （如果使用 Rummage 的分页）添加到config.exs中的rummage_ecto配置中：

 config :rummage_ecto , Rummage.Ecto ,
  repo: MyApp.Repo ,
  per_page: 10

您应该能够将Rummage.Ecto与任何Ecto模型一起使用。

高级用法：

如果您想使用自定义挂钩覆盖Rummage的任何默认挂钩，请将应用程序的CustomHook以及所需的操作添加到config.exs中的rummage_ecto配置中：

 config :rummage_ecto , Rummage.Ecto ,
  repo: MyApp.Repo ,
  search: MyApp.SearchModule ,
  paginate: MyApp.PaginateModule

当将Rummage.Ecto与具有多个Repo的应用程序一起使用时，或者需要为每个模型配置Repo时，可以将其与对Rummage.Ecto调用一起传递。这会覆盖配置中设置的默认存储库：

 { queryable , rummage } = Product
  |> Rummage.Ecto . rummage ( rummage , repo: MyApp.Repo2 )

并且您应该能够将Rummage.Ecto与Product模型一起使用，该模型位于与默认仓库不同的Repo中。

示例

设置上面的应用程序将使我们能够执行以下操作：

 rummage = % {
  search: % { field_1 => % { search_type: :like , search_term: "field_!" } } ,
  sort: % { field: :field1 , order: :asc } ,
  paginate: % { per_page: 5 , page: 1 }
}

{ queryable , rummage } = Product
  |> Rummage.Ecto . rummage ( rummage )

products = queryable
  |> Product . another_operation # <-- Since `Rummage` is Ecto, we can pipe the result queryable into another queryable operation.
  |> Repo . all

Rummage 使用键响应params ： search 、 sort和/或paginate 。它不需要拥有所有的钥匙，或者任何与此相关的钥匙。如果传递了无效的密钥，它们不会改变翻找中的任何操作。这是Rummage参数的示例：

 rummage = % {
  search: % { field_1 => % { search_type: :like , search_term: "field_!" } } ,
  sort: % { field: :field1 , order: :asc } ,
  paginate: % { per_page: 5 , page: 1 }
}