Skip to content

Commit 3987435

Browse files
Improve documentation regarding encodings.
1 parent d008553 commit 3987435

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

doc/src/module.rst

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,15 @@ Module Interface
6565
the password for the logon during the connection process.
6666

6767
The encoding argument is expected to be a string if specified and sets the
68-
encoding to use for regular database strings.
68+
encoding to use for regular database strings. If not specified, the
69+
environment variable NLS_LANG is used. If the environment variable NLS_LANG
70+
is not set, ASCII is used.
6971

7072
The nencoding argument is expected to be a string if specified and sets the
71-
national encoding to use for national character set database strings.
73+
encoding to use for national character set database strings. If not
74+
specified, the environment variable NLS_NCHAR is used. If the environment
75+
variable NLS_NCHAR is not used, the environment variable NLS_LANG is used
76+
instead, and if the environment variable NLS_LANG is not set, ASCII is used.
7277

7378
The edition argument is expected to be a string if specified and sets the
7479
edition to use for the session. It is only relevant if both the client and
@@ -141,10 +146,16 @@ Module Interface
141146
about 10-15% which is why the default is False.
142147

143148
The encoding argument is expected to be a string if specified and sets the
144-
encoding to use for regular database strings.
149+
encoding to use for regular database strings. If not specified, the
150+
environment variable NLS_LANG is used. If the environment variable NLS_LANG
151+
is not set, ASCII is used.
145152

146153
The nencoding argument is expected to be a string if specified and sets the
147-
national encoding to use for national character set database strings.
154+
encoding to use for national character set database strings. If not
155+
specified, the environment variable NLS_NCHAR is used. If the environment
156+
variable NLS_NCHAR is not used, the environment variable NLS_LANG is used
157+
instead, and if the environment variable NLS_LANG is not set, ASCII is used.
158+
148159

149160
The edition argument is expected to be a string, if specified, and sets the
150161
edition to use for the sessions in the pool. It is only relevant if both the

0 commit comments

Comments
 (0)