From 398743569f9faf63b1fd80ebe1c11c487954feb8 Mon Sep 17 00:00:00 2001 From: Anthony Tuininga Date: Fri, 16 Jun 2017 16:49:00 -0600 Subject: [PATCH] Improve documentation regarding encodings. --- doc/src/module.rst | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/doc/src/module.rst b/doc/src/module.rst index dea77dca..6a9efd59 100644 --- a/doc/src/module.rst +++ b/doc/src/module.rst @@ -65,10 +65,15 @@ Module Interface the password for the logon during the connection process. The encoding argument is expected to be a string if specified and sets the - encoding to use for regular database strings. + encoding to use for regular database strings. If not specified, the + environment variable NLS_LANG is used. If the environment variable NLS_LANG + is not set, ASCII is used. The nencoding argument is expected to be a string if specified and sets the - national encoding to use for national character set database strings. + encoding to use for national character set database strings. If not + specified, the environment variable NLS_NCHAR is used. If the environment + variable NLS_NCHAR is not used, the environment variable NLS_LANG is used + instead, and if the environment variable NLS_LANG is not set, ASCII is used. The edition argument is expected to be a string if specified and sets the edition to use for the session. It is only relevant if both the client and @@ -141,10 +146,16 @@ Module Interface about 10-15% which is why the default is False. The encoding argument is expected to be a string if specified and sets the - encoding to use for regular database strings. + encoding to use for regular database strings. If not specified, the + environment variable NLS_LANG is used. If the environment variable NLS_LANG + is not set, ASCII is used. The nencoding argument is expected to be a string if specified and sets the - national encoding to use for national character set database strings. + encoding to use for national character set database strings. If not + specified, the environment variable NLS_NCHAR is used. If the environment + variable NLS_NCHAR is not used, the environment variable NLS_LANG is used + instead, and if the environment variable NLS_LANG is not set, ASCII is used. + The edition argument is expected to be a string, if specified, and sets the edition to use for the sessions in the pool. It is only relevant if both the