Browse Source

Mention default for `nulls` in README

Sergey Prokhorov 5 years ago
parent
commit
2d1180a5ed
1 changed files with 4 additions and 2 deletions
  1. 4 2
      README.md

+ 4 - 2
README.md

@@ -74,7 +74,7 @@ connect(Opts) -> {ok, Connection :: epgsql:connection()} | {error, Reason :: epg
       timeout =>  timeout(),             % socket connect timeout, default: 5000 ms
       timeout =>  timeout(),             % socket connect timeout, default: 5000 ms
       async =>    pid() | atom(),        % process to receive LISTEN/NOTIFY msgs
       async =>    pid() | atom(),        % process to receive LISTEN/NOTIFY msgs
       codecs =>   [{epgsql_codec:codec_mod(), any()}]}
       codecs =>   [{epgsql_codec:codec_mod(), any()}]}
-      nulls =>    [null, undefined],     % NULL terms
+      nulls =>    [any(), ...],          % NULL terms
       replication => Replication :: string()} % Pass "database" to connect in replication mode
       replication => Replication :: string()} % Pass "database" to connect in replication mode
     | list().
     | list().
 
 
@@ -105,10 +105,12 @@ Only `host` and `username` are mandatory, but most likely you would need `databa
 - `ssl_opts` will be passed as is to `ssl:connect/3`
 - `ssl_opts` will be passed as is to `ssl:connect/3`
 - `async` see [Server notifications](#server-notifications)
 - `async` see [Server notifications](#server-notifications)
 - `codecs` see [Pluggable datatype codecs](#pluggable-datatype-codecs)
 - `codecs` see [Pluggable datatype codecs](#pluggable-datatype-codecs)
-- `nulls` terms which will be used to represent `NULL`. If any of those has been encountered in
+- `nulls` terms which will be used to represent SQL `NULL`. If any of those has been encountered in
    placeholder parameters (`$1`, `$2` etc values), it will be interpreted as `NULL`.
    placeholder parameters (`$1`, `$2` etc values), it will be interpreted as `NULL`.
    1st element of the list will be used to represent NULLs received from the server. It's not recommended
    1st element of the list will be used to represent NULLs received from the server. It's not recommended
    to use `"string"`s or lists. Try to keep this list short for performance!
    to use `"string"`s or lists. Try to keep this list short for performance!
+   Default is `[null, undefined]`, i.e. encode `null` or `undefined` in parameters as `NULL`
+   and decode `NULL`s as atom `null`.
 - `replication` see [Streaming replication protocol](#streaming-replication-protocol)
 - `replication` see [Streaming replication protocol](#streaming-replication-protocol)
 
 
 Options may be passed as proplist or as map with the same key names.
 Options may be passed as proplist or as map with the same key names.