Document {:unsafe_fragment, fragment} option for :returning

[henryzhan013]

Document {:unsafe_fragment, fragment} option for :returning

Summary

Documents the new {:unsafe_fragment, fragment} tuple format for the :returning
option, which was added in elixir-ecto/ecto_sql#722

This allows raw SQL expressions in the RETURNING clause (PostgreSQL) and OUTPUT
clause (MSSQL), enabling use cases like:

Repo.insert(changeset,
  on_conflict: {:replace, [:price]},
  conflict_target: :id,
  returning: {:unsafe_fragment, "id, (price != EXCLUDED.price) AS was_updated"}
)

Changes

Added documentation for {:unsafe_fragment, fragment} to the :returning option in:

• insert_all/3
• insert/2
• update/2
• delete/2