rummage_ecto

翻箱倒櫃

如果您正在尋找完整的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 }
}