Skip to content

Commit 22f4e95

Browse files
committed
Improve documentation
1 parent 02561df commit 22f4e95

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ You can also download all development versions from [Bintray](https://bintray.co
2525

2626
## Compatibility
2727
The latest CLI is always compatible with all database frameworks of the same major version.
28-
For example CLI-3.1.0 is compatible with database framework 3.0.0-3.1.0 but not with database framework 2.x.
28+
For example CLI-3.1.0 is compatible with database framework 3.0.0-3.1.2 but not with database framework 2.x.
2929

3030
## Localization and NLS settings
31-
utPLSQL-cli will use the environment variables (in that order) "NLS_LANG", "LC_ALL" or "LANG" to change the locale and therefore the NLS settings.
31+
utPLSQL-cli will use the environment variables "LC_ALL" or "LANG" to change the locale and therefore the client NLS settings.
3232
If neither environment variable is available, it will use the JVM default locale.
3333

3434
Example: to change the NLS-settings to English American, you can do the following:
@@ -38,6 +38,17 @@ export LC_ALL=en_US.utf-8
3838

3939
The charset-part of LC_ALL is ignored.
4040

41+
In addition, utPLSQL-cli will use an existing "NLS_LANG" environment variable to create corresponding
42+
`ALTER SESSION`-statements during initialization of the connection.
43+
44+
The variable is parsed according to the [Oracle globalization documentation](https://www.oracle.com/technetwork/database/database-technologies/globalization/nls-lang-099431.html#_Toc110410543)
45+
46+
Example: "NLS_LANG" of `AMERICAN_AMERICA.UTF8` will lead to the following statements:
47+
```sql
48+
ALTER SESSION SET NLS_LANGUAGE='AMERICAN';
49+
ALTER SESSION SET NLS_TERRITORY='AMERICA';
50+
```
51+
4152
## Usage
4253
Currently, utPLSQL-cli supports the following commands:
4354
- run

0 commit comments

Comments
 (0)