You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -7632,7 +7632,8 @@ be in an installation of Oracle Instant Client, in a full Oracle Client
7632
7632
installation, or in an Oracle Database installation (if Node.js is running on
7633
7633
the same machine as the database). The versions of Oracle Client and Oracle
7634
7634
Database do not have to be the same. For certified configurations see Oracle
7635
-
Support's [Doc ID 207303.1][187].
7635
+
Support's [Doc ID 207303.1][187] and see the [node-installation
7636
+
instructions][2].
7636
7637
7637
7638
Node-oracledb looks for the Oracle Client libraries as follows:
7638
7639
@@ -7644,7 +7645,7 @@ Node-oracledb looks for the Oracle Client libraries as follows:
7644
7645
'Basic' or 'Basic Light' package. If you pass the library directory from
7645
7646
a full client or database installation, such as Oracle Database "XE"
7646
7647
Express Edition, then you will need to have previously set your
7647
-
environment to use that software installation, otherwise files such as
7648
+
environment to use that software installation otherwise files such as
7648
7649
message files will not be located. If the Oracle Client libraries cannot
7649
7650
be loaded from `libDir`, then an error is thrown.
7650
7651
@@ -7675,21 +7676,23 @@ Node-oracledb looks for the Oracle Client libraries as follows:
7675
7676
node_modules/oracledb/build/Release/`. If the libraries are not found, no
7676
7677
error is thrown and the search continues, see next bullet point.
7677
7678
7678
-
- In `/usr/local/lib`. If the Oracle Client libraries cannot be loaded, then
7679
-
an error is thrown.
7679
+
- In the library search path such as set in `DYLD_LIBRARY_PATH` (note this
7680
+
variable does not propagate to sub-shells) or in `/usr/local/lib`. If the
7681
+
Oracle Client libraries cannot be loaded, then an error is thrown.
7680
7682
7681
7683
- On Linux and related platforms:
7682
7684
7683
7685
- In the [`libDir`](#odbinitoracleclientattrsopts) directory specified in a
7684
7686
call to [`oracledb.initOracleClient()`](#odbinitoracleclient). Note on
7685
7687
Linux this is only useful to force immediate loading of the libraries
7686
-
because the libraries must also be in the system library search path.
7687
-
This directory should contain the libraries from an unzipped Instant
7688
-
Client 'Basic' or 'Basic Light' package. If you pass the library
7689
-
directory from a full client or database installation, such as Oracle
7690
-
Database "XE" Express Edition then you will need to have previously set
7691
-
the `ORACLE_HOME` environment variable. If the Oracle Client libraries
7692
-
cannot be loaded from `libDir`, then an error is thrown.
7688
+
because the libraries must also be in the system library search path,
7689
+
i.e. configured with `ldconfig` or set in `LD_LIBRARY_PATH`. This
7690
+
directory should contain the libraries from an unzipped Instant Client
7691
+
'Basic' or 'Basic Light' package. If you pass the library directory from
7692
+
a full client or database installation, such as Oracle Database "XE"
7693
+
Express Edition then you will need to have previously set the
7694
+
`ORACLE_HOME` environment variable. If the Oracle Client libraries cannot
7695
+
be loaded from `libDir`, then an error is thrown.
7693
7696
7694
7697
- If `libDir` was not specified, then Oracle Client libraries are looked for
7695
7698
in the operating system library search path, such as configured with
@@ -7782,8 +7785,10 @@ Name | Description
7782
7785
The files should be in a directory accessible to Node.js, not on the
7783
7786
database server host.
7784
7787
7785
-
For example, if the file `/etc/my-oracle-config/tnsnames.ora` should be used,
7786
-
you can call [`oracledb.initOracleClient()`](#odbinitoracleclient):
7788
+
To make node-oracledb use the files you can set
7789
+
[`configDir`](#odbinitoracleclientattrsopts) in a call to
7790
+
[`oracledb.initOracleClient()`](#odbinitoracleclient). For example, if the file
7791
+
`/etc/my-oracle-config/tnsnames.ora` should be used, then your code could be:
7787
7792
7788
7793
```javascript
7789
7794
const oracledb = require('oracledb');
@@ -7865,14 +7870,23 @@ Name | Description
7865
7870
------|-------------
7866
7871
`LD_LIBRARY_PATH` | Used on Linux and some UNIX platforms. Set this to the directory containing the Oracle Client libraries, for example `/opt/oracle/instantclient_19_6` or `$ORACLE_HOME/lib`. The variable needs to be set in the environment before Node.js is invoked. The variable is not needed if the libraries are located by an alternative method, such as from running `ldconfig`. On some UNIX platforms an OS specific equivalent, such as `LIBPATH` or `SHLIB_PATH` is used instead of `LD_LIBRARY_PATH`.
7867
7872
`PATH` | The library search path for Windows should include the location where `OCI.DLL` is found. Not needed if you pass [`libDir`](#odbinitoracleclientattrsopts) when calling [`oracledb.initOracleClient()`](#odbinitoracleclient)
7868
-
`TNS_ADMIN` | The location of the optional [Oracle Net configuration files](#tnsadmin) and [Oracle Client configuration files](#oraaccess), including `tnsnames.ora`, `sqlnet.ora`, and `oraaccess.xml`, if they are not in a default location, or if [`configDir`](#odbinitoracleclientattrsopts) was not used in a call to [`oracledb.initOracleClient()`](#odbinitoracleclient).
7873
+
`TNS_ADMIN` | The location of the optional [Oracle Net configuration files](#tnsadmin) and [Oracle Client configuration files](#oraaccess), including `tnsnames.ora`, `sqlnet.ora`, and `oraaccess.xml`, if they are not in a default location. The [`configDir`](#odbinitoracleclientattrsopts) value in a call to [`oracledb.initOracleClient()`](#odbinitoracleclient) overrides `TNS_ADMIN`.
7869
7874
`ORA_SDTZ` | The default session time zone, see [Fetching Dates and Timestamps](#datehandling).
7870
7875
`ORA_TZFILE` | The name of the Oracle time zone file to use. See the notes below.
7871
7876
`ORACLE_HOME` | The directory containing the Oracle Database software. This directory must be accessible by the Node.js process. This variable should *not* be set if node-oracledb uses Oracle Instant Client.
7872
7877
`NLS_LANG` | Determines the 'national language support' globalization options for node-oracledb. If not set, a default value will be chosen by Oracle. Note that node-oracledb will always uses the AL32UTF8 character set. See [Globalization and National Language Support (NLS)](#nls).
7873
7878
`NLS_DATE_FORMAT`, `NLS_TIMESTAMP_FORMAT` | See [Fetching Numbers and Dates as String](#fetchasstringhandling). The variables are ignored if `NLS_LANG` is not set.
7874
7879
`NLS_NUMERIC_CHARACTERS` | See [Fetching Numbers and Dates as String](#fetchasstringhandling). The variable is ignored if `NLS_LANG` is not
7875
7880
7881
+
##### Time Zone File
7882
+
7883
+
The name of the Oracle time zone file to use can be set in `ORA_TZFILE`.
7884
+
7885
+
If node-oracledb is using Oracle Client libraries from an Oracle Database or
7886
+
full Oracle Client software installation, and you want to use a non-default time
7887
+
zone file, then set `ORA_TZFILE` to the file name with a directory prefix, for
0 commit comments