The Backpex.Adapter to connect your Backpex.LiveResource to an Ecto.Schema.

adapter_config

• :repo (atom/0) - Required. The Ecto.Repo that will be used to perform CRUD operations for the given schema.

• :schema (atom/0) - Required. The Ecto.Schema for the resource.

• :update_changeset (function of arity 3) - Required. Changeset to use when updating items. Additional metadata is passed as a keyword list via the third parameter:

  • :assigns - the assigns
  • :target - the name of the form target that triggered the changeset call. Default to nil if the call was not triggered by a form field.

• :create_changeset (function of arity 3) - Required. Changeset to use when creating items. Additional metadata is passed as a keyword list via the third parameter:

  • :assigns - the assigns
  • :target - the name of the form target that triggered the changeset call. Default to nil if the call was not triggered by a form field.

• :item_query (function of arity 3) - The function that can be used to modify the ecto query. It will be used when resources are being fetched. This happens on index, edit and show view. In most cases this function will be used to filter items on index view based on certain criteria, but it may also be used to join other tables on edit or show view.

  This function should accept the following parameters:

  • query - Ecto.Query.t()
  • live_action - atom()
  • assigns - map()

  It should return an Ecto.Queryable. It is recommended to build your item_query on top of the incoming query. Otherwise you will likely get binding errors.

Work in progress

The Backpex.Adapters.Ecto is under heavy development and will change drastically in future updates. Backpex started out as Ecto-only and we are working on decoupling things to support multiple data sources. This is the first draft of moving all Ecto related functions into a dedicated Ecto adapter.