Flop 项目使用教程

Flop 项目使用教程

flop Filtering, ordering and pagination for Ecto 项目地址: https://gitcode.com/gh_mirrors/fl/flop

1. 项目介绍

Flop 是一个 Elixir 库，旨在轻松地将过滤、排序和分页应用于 Ecto 查询。它提供了多种功能，包括基于偏移量的分页、基于游标的分页、排序、过滤以及参数验证等。Flop 还支持 Relay 分页参数，并提供了 UI 助手和 URL 构建器，通过 Flop Phoenix 实现分页、可排序表格和过滤表单。

2. 项目快速启动

安装 Flop

首先，将 Flop 添加到项目的依赖列表中。在你的 mix.exs 文件中添加以下内容：

def deps do
  [
    {:flop, "~> 0.26.1"}
  ]
end

然后，运行以下命令来获取依赖：

mix deps.get

配置默认仓库

你可以在配置文件中为 Flop 配置默认的仓库：

config :flop, repo: MyApp.Repo

定义可排序和可过滤字段

在你的 Ecto 模式中，定义可排序和可过滤的字段：

defmodule MyApp.Pet do
  use Ecto.Schema

  @derive {
    Flop.Schema,
    filterable: [:name, :species],
    sortable: [:name, :age, :species]
  }

  schema "pets" do
    field :name, :string
    field :age, :integer
    field :species, :string
    field :social_security_number, :string
  end
end

查询数据

使用 Flop.validate_and_run/3 函数来验证参数并从数据库中获取数据：

defmodule MyApp.Pets do
  import Ecto.Query, warn: false
  alias Ecto.Changeset
  alias MyApp.{Pet, Repo}

  @spec list_pets(map) :: {:ok, {[Pet.t()], Flop.Meta.t()}} | {:error, Flop.Meta.t()}
  def list_pets(params \\ %{}) do
    Flop.validate_and_run(Pet, params, for: Pet)
  end
end

3. 应用案例和最佳实践

分页

Flop 支持基于偏移量和基于游标的分页。以下是一些示例：

基于偏移量的分页

params = %{offset: 20, limit: 10}
Flop.validate_and_run(Pet, params, for: Pet)

基于游标的分页

params = %{first: 10, after: "g3QAAAABZAACaWRiAAACDg=="}
Flop.validate_and_run(Pet, params, for: Pet)

排序

你可以指定多个字段进行排序，并指定每个字段的排序方向：

params = %{order_by: [:name, :age], order_directions: [:asc, :desc]}
Flop.validate_and_run(Pet, params, for: Pet)

过滤

Flop 支持复杂的过滤操作，例如模糊匹配和多条件过滤：

params = %{filters: [%{field: :name, op: :ilike_and, value: "Jane"}]}
Flop.validate_and_run(Pet, params, for: Pet)

4. 典型生态项目

Flop 是一个专注于 Ecto 查询优化的库，适用于需要高效处理大量数据的 Elixir 项目。它与 Ecto 和 Phoenix 框架紧密集成，适合用于构建需要分页、排序和过滤功能的 Web 应用程序。Flop 的灵活性和强大的功能使其成为处理复杂查询需求的理想选择。

flop Filtering, ordering and pagination for Ecto 项目地址: https://gitcode.com/gh_mirrors/fl/flop