Document default value for :cache_statement (#223)

elixir-ecto · Apr 17, 2020 · bbfc036 · bbfc036
1 parent d8d468a
commit bbfc036
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 9 deletions.
diff --git a/lib/ecto/adapters/myxql.ex b/lib/ecto/adapters/myxql.ex
@@ -29,9 +29,10 @@ defmodule Ecto.Adapters.MyXQL do
       via the `mysql` command. For more information, please check
       [MySQL docs](https://dev.mysql.com/doc/en/connecting.html)
     * `:cache_statement` - how Ecto should cache INSERT/UPDATE/DELETE statements.
-      It can either be `:per_schema` (one cache key is used for each schema) or
-      `:per_operation` (one cache key is use for each operation). Note SELECTs
-      use a more complete cache mechanism that considers the query itself.
+      It defaults to `:per_schema` (one cache key is used for each schema) and
+      can be set to `:per_operation` (one cache key is use for each operation).
+      Note SELECTs use a more complete cache mechanism that considers the query
+      itself.
     * `:socket_options` - Specifies socket configuration
     * `:show_sensitive_data_on_connection_error` - show connection data and
       configuration whenever there is an error attempting to connect to the

diff --git a/lib/ecto/adapters/postgres.ex b/lib/ecto/adapters/postgres.ex
@@ -41,9 +41,10 @@ defmodule Ecto.Adapters.Postgres do
     * `:ssl_opts` - A list of ssl options, see Erlang's `ssl` docs
     * `:parameters` - Keyword list of connection parameters
     * `:cache_statement` - how Ecto should cache INSERT/UPDATE/DELETE statements.
-      It can either be `:per_schema` (one cache key is used for each schema) or
-      `:per_operation` (one cache key is use for each operation). Note SELECTs
-      use a more complete cache mechanism that considers the query itself.
+      It defaults to `:per_schema` (one cache key is used for each schema) and
+      can be set to `:per_operation` (one cache key is use for each operation).
+      Note SELECTs use a more complete cache mechanism that considers the query
+      itself.
     * `:connect_timeout` - The timeout for establishing new connections (default: 5000)
     * `:prepare` - How to prepare queries, either `:named` to use named queries
       or `:unnamed` to force unnamed queries (default: `:named`)

diff --git a/lib/ecto/adapters/tds.ex b/lib/ecto/adapters/tds.ex
@@ -19,9 +19,10 @@ defmodule Ecto.Adapters.Tds do
     * `:ssl` - Set to true if ssl should be used (default: false)
     * `:ssl_opts` - A list of ssl options, see Erlang's `ssl` docs
     * `:cache_statement` - how Ecto should cache INSERT/UPDATE/DELETE statements.
-      It can either be `:per_schema` (one cache key is used for each schema) or
-      `:per_operation` (one cache key is use for each operation). Note SELECTs
-      use a more complete cache mechanism that considers the query itself.
+      It defaults to `:per_schema` (one cache key is used for each schema) and
+      can be set to `:per_operation` (one cache key is use for each operation).
+      Note SELECTs use a more complete cache mechanism that considers the query
+      itself.
     * `:show_sensitive_data_on_connection_error` - show connection data and
       configuration whenever there is an error attempting to connect to the
       database