Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation about transaction modes #155

Merged
merged 4 commits into from
Nov 4, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 45 additions & 2 deletions lib/ecto/adapters/sqlite3.ex
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ defmodule Ecto.Adapters.SQLite3 do

* `:database` - The path to the database. In memory is allowed. You can use
`:memory` or `":memory:"` to designate that.
* `:default_transaction_mode` - one of `deferred` (default), `immediate`,
or `exclusive`. If a mode is not specified in a call to `Repo.transaction/2`,
this will be the default transaction mode.
* `:journal_mode` - Sets the journal mode for the sqlite connection. Can be
one of the following `:delete`, `:truncate`, `:persist`, `:memory`,
`:wal`, or `:off`. Defaults to `:wal`.
Expand Down Expand Up @@ -51,8 +54,8 @@ defmodule Ecto.Adapters.SQLite3 do
* `:datetime_type` - Defaults to `:iso8601`. Determines how datetime fields are stored in the database.
The allowed values are `:iso8601` and `:text_datetime`. `:iso8601` corresponds to a string of the form
`YYYY-MM-DDThh:mm:ss` and `:text_datetime` corresponds to a string of the form `YYYY-MM-DD hh:mm:ss`
* `:load_extensions` - list of paths identifying extensions to load. Defaults to []. The provided list will
be merged with the global extensions list, set on :exqlite, :load_extensions. Be aware that the path should
* `:load_extensions` - list of paths identifying extensions to load. Defaults to []. The provided list will
be merged with the global extensions list, set on :exqlite, :load_extensions. Be aware that the path should
handle pointing to a library compiled for the current architecture. See `Exqlite.Connection.connect/1` for more.

For more information about the options above, see [sqlite documentation][1]
Expand Down Expand Up @@ -177,11 +180,51 @@ defmodule Ecto.Adapters.SQLite3 do
types, despite the fact SQLite only has [five storage classes][5]. The query will still
work and return data, but you will need to do this mapping on your own.

### Transaction mode

By default, [SQLite transactions][8] run in `DEFERRED` mode. However, in
web applications with a balanced load of reads and writes, using `IMMEDIATE`
mode may yield better performance.

Here are several ways to specify a different transaction mode:

**Pass `mode: :immediate` to `Repo.transaction/2`:** Use this approach to set
the transaction mode for individual transactions.

Multi.new()
|> Multi.run(:example, fn _repo, _changes_so_far ->
# ... do some work ...
end)
|> Repo.transaction(mode: :immediate)

**Define custom transaction functions:** Create wrappers, such as
`Repo.immediate_transaction/2` or `Repo.deferred_transaction/2`, to easily
apply different modes where needed.

defmodule MyApp.Repo do
def immediate_transaction(fun_or_multi) do
transaction(fun_or_multi, mode: :immediate)
end

def deferred_transaction(fun_or_multi) do
transaction(fun_or_multi, mode: :deferred)
end
end

**Set a global default:** Configure `:default_transaction_mode` to apply a
preferred mode for all transactions, unless explicitly passed a different
`:mode` to `Repo.transaction/2`.

config :my_app, MyApp.Repo,
database: "path/to/my/database.db",
default_transaction_mode: :immediate

[3]: https://www.sqlite.org/compile.html
[4]: https://www.sqlite.org/whentouse.html
[5]: https://www.sqlite.org/datatype3.html
[6]: https://www.sqlite.org/datatype3.html#collating_sequences
[7]: https://hexdocs.pm/ecto/schemaless-queries.html
[8]: https://www.sqlite.org/lang_transaction.html#deferred_immediate_and_exclusive_transactions
"""

use Ecto.Adapters.SQL,
Expand Down
Loading