@@ -3727,8 +3727,8 @@ Standalone connection example:
37273727 # PROXY_USER: MYUSER
37283728 # SESSION_USER: MYSESSIONUSER
37293729
3730- You can also explicitly set the ``externalauth `` parameter to True in standalone
3731- connections as shown below. The `` externalauth `` parameter is optional.
3730+ You can also set the ``externalauth `` parameter to * True * in standalone
3731+ connections:
37323732
37333733.. code-block :: python
37343734
@@ -3738,7 +3738,7 @@ connections as shown below. The ``externalauth`` parameter is optional.
37383738 # PROXY_USER: MYUSER
37393739 # SESSION_USER: MYSESSIONUSER
37403740
3741- Pooled connection example:
3741+ A connection pool example is :
37423742
37433743.. code-block :: python
37443744
@@ -3949,8 +3949,8 @@ connect to Oracle Autonomous Database with mutual TLS (mTLS). See
39493949
39503950When using a class such as the :ref: `TokenHandlerOAuth class <oauthhandler >` to
39513951generate OAuth2 tokens to connect to Oracle Autonomous Database in Thin mode,
3952- you need to explicitly set the ``access_token ``, `` config_dir ``,
3953- ``wallet_location ``, and ``wallet_password `` parameters of
3952+ you need to explicitly set the ``access_token ``, and also any desired
3953+ ``config_dir ``, `` wallet_location ``, and ``wallet_password `` parameters of
39543954:func: `~oracledb.connect `. For example:
39553955
39563956.. code :: python
@@ -3966,9 +3966,10 @@ you need to explicitly set the ``access_token``, ``config_dir``,
39663966
39673967When using a class such as the :ref: `TokenHandlerOAuth class <oauthhandler >` to
39683968generate OAuth2 tokens to connect to Oracle Autonomous Database in Thin mode,
3969- you need to explicitly set the ``access_token ``, ``homogeneous ``,
3970- ``config_dir ``, ``wallet_location ``, and ``wallet_password `` parameters of
3971- :func: `~oracledb.create_pool `. For example:
3969+ you need to explicitly set the ``access_token `` parameter of
3970+ :func: `~oracledb.create_pool `, and also any desired ``config_dir ``,
3971+ ``wallet_location ``, and ``wallet_password `` parameters. The ``homogeneous ``
3972+ parameter must be *True * (its default value). For example:
39723973
39733974.. code :: python
39743975
@@ -4004,15 +4005,16 @@ parameters of :func:`~oracledb.connect`. For example:
40044005
40054006When using a class such as the :ref: `TokenHandlerOAuth class <oauthhandler >` to
40064007generate OAuth2 tokens to connect to Oracle Autonomous Database in Thick mode,
4007- you need to explicitly set the ``access_token ``, ``externalauth ``, and
4008- ``homogeneous `` parameters of :func: `~oracledb.create_pool `. For example:
4008+ you need to explicitly set the ``access_token `` and ``externalauth `` parameters
4009+ of :func: `~oracledb.create_pool `. The ``homogeneous `` parameter must be *True *
4010+ (which is its default value). For example:
40094011
40104012.. code :: python
40114013
40124014 pool = oracledb.create_pool(
40134015 access_token = TokenHandlerOAuth(),
40144016 externalauth = True , # must always be True in Thick mode
4015- homogeneous = True , # must always be True in connection pools
4017+ homogeneous = True , # must always be True for connection pools
40164018 dsn = mydb_low, min = 1 , max = 5 , increment = 2 )
40174019
40184020 Note that the ``access_token `` parameter should be set to a callable. This is
@@ -4200,9 +4202,9 @@ Oracle Autonomous Database with mutual TLS (mTLS). See :ref:`autonomousdb`.
42004202
42014203When using the :ref: `azure_tokens <azurecloudnativeauthplugin >` plugin to
42024204generate OAuth2 tokens to connect to Oracle Autonomous Database in Thin mode,
4203- you need to explicitly set the ``extra_auth_params ``, `` config_dir ``,
4204- `` wallet_location ``, and ``wallet_password `` parameter of
4205- :func: `~oracledb.connect `. For example:
4205+ you need to explicitly set the ``extra_auth_params `` parameter, and also any
4206+ required `` config_dir ``, `` wallet_location ``, and ``wallet_password ``
4207+ parameters of :func: `~oracledb.connect `. For example:
42064208
42074209.. code :: python
42084210
@@ -4227,9 +4229,10 @@ you need to explicitly set the ``extra_auth_params``, ``config_dir``,
42274229
42284230When using the :ref: `azure_tokens <azurecloudnativeauthplugin >` plugin to
42294231generate OAuth2 tokens to connect to Oracle Autonomous Database in Thin mode,
4230- you need to explicitly set the ``homogeneous ``, ``extra_auth_params ``,
4231- ``config_dir ``, ``wallet_location ``, and ``wallet_password `` parameters of
4232- :func: `~oracledb.create_pool `. For example:
4232+ you need to explicitly set the ``extra_auth_params `` parameter of
4233+ :func: `~oracledb.create_pool `, and also any desired ``config_dir ``,
4234+ ``wallet_location ``, and ``wallet_password `` parameters. The ``homogeneous ``
4235+ parameter must be *True * (its default value). For example:
42334236
42344237.. code :: python
42354238
@@ -4256,7 +4259,7 @@ you need to explicitly set the ``homogeneous``, ``extra_auth_params``,
42564259When using the :ref: `azure_tokens <azurecloudnativeauthplugin >` plugin to
42574260generate OAuth2 tokens to connect to Oracle Autonomous Database in Thick mode,
42584261you need to explicitly set the ``extra_auth_params `` and ``externalauth ``
4259- parameter of :func: `~oracledb.connect `. For example:
4262+ parameters of :func: `~oracledb.connect `. For example:
42604263
42614264.. code :: python
42624265
@@ -4279,8 +4282,9 @@ parameter of :func:`~oracledb.connect`. For example:
42794282
42804283When using the :ref: `azure_tokens <azurecloudnativeauthplugin >` plugin to
42814284generate OAuth2 tokens to connect to Oracle Autonomous Database in Thick mode,
4282- you need to explicitly set the ``extra_auth_params ``, ``externalauth ``, and
4283- ``homogeneous `` parameters of :func: `~oracledb.create_pool `.
4285+ you need to explicitly set the ``extra_auth_params `` and ``externalauth ``
4286+ parameters of :func: `~oracledb.create_pool `. The ``homogeneous `` parameter must
4287+ be *True * (its default value). For example:
42844288
42854289.. code :: python
42864290
@@ -4312,8 +4316,8 @@ issued by OCI IAM to authenticate to the Oracle Autonomous Database. Both Thin
43124316and Thick modes of the python-oracledb driver support OCI IAM token-based
43134317authentication.
43144318
4315- When using python-oracledb in Thick mode, Oracle Client libraries 19.14 (or later),
4316- or 21.5 (or later) are needed.
4319+ When using python-oracledb in Thick mode, Oracle Client libraries 19.14 (or
4320+ later), or 21.5 (or later) are needed.
43174321
43184322Standalone connections and pooled connections can be created in python-oracledb
43194323Thick and Thin modes using OCI IAM token-based authentication. This can be done
@@ -4414,9 +4418,9 @@ to Oracle Autonomous Database with mutual TLS (mTLS). See :ref:`autonomousdb`.
44144418
44154419When using a class such as the :ref: `TokenHandlerIAM class <iamhandler >` to
44164420generate OCI IAM tokens to connect to Oracle Autonomous Database in Thin mode,
4417- you need to explicitly set the ``access_token ``, `` config_dir ``,
4418- `` wallet_location `` , and `` wallet_password `` parameters of
4419- :func: ` ~oracledb.connect ` . For example:
4421+ you need to explicitly set the ``access_token `` parameter of
4422+ :func: ` ~oracledb.connect ` , and also any desired `` config_dir ``,
4423+ `` wallet_location ``, and `` wallet_password `` parameters . For example:
44204424
44214425.. code :: python
44224426
@@ -4431,15 +4435,16 @@ you need to explicitly set the ``access_token``, ``config_dir``,
44314435
44324436When using a class such as :ref: `TokenHandlerIAM class <iamhandler >` to
44334437generate OCI IAM tokens to connect to Oracle Autonomous Database in Thin mode,
4434- you need to explicitly set the ``access_token ``, ``homogeneous ``,
4435- ``config_dir ``, ``wallet_location ``, and ``wallet_password `` parameters of
4436- :func: `~oracledb.create_pool `. For example:
4438+ you need to explicitly set the ``access_token `` parameter of
4439+ :func: `~oracledb.create_pool `, and also any desired ``config_dir ``,
4440+ ``wallet_location ``, and ``wallet_password `` parameters. The ``homogeneous ``
4441+ parameter must be *True * (its default value). For example:
44374442
44384443.. code :: python
44394444
44404445 connection = oracledb.create_pool(
44414446 access_token = TokenHandlerIAM(),
4442- homogeneous = True , # must always be set to True for connection pools
4447+ homogeneous = True , # must always be True for connection pools
44434448 dsn = mydb_low,
44444449 config_dir = " path_to_unzipped_wallet" ,
44454450 wallet_location = " location_of_pem_file" ,
@@ -4469,15 +4474,16 @@ of :func:`~oracledb.connect`. For example:
44694474
44704475When using a class such as :ref: `TokenHandlerIAM class <iamhandler >` to
44714476generate OCI IAM tokens to connect to Oracle Autonomous Database in Thick mode,
4472- you need to explicitly set the ``access_token ``, ``externalauth ``, and
4473- ``homogeneous `` parameters of :func: `oracledb.create_pool `. For example:
4477+ you need to explicitly set the ``access_token `` and ``externalauth `` parameters
4478+ of :func: `oracledb.create_pool `. The ``homogeneous `` parameter must be *True *
4479+ (its default value). For example:
44744480
44754481.. code :: python
44764482
44774483 pool = oracledb.create_pool(
44784484 access_token = TokenHandlerIAM(),
44794485 externalauth = True , # must always be True in Thick mode
4480- homogeneous = True , # must always be True in connection pools
4486+ homogeneous = True , # must always be True for connection pools
44814487 dsn = mydb_low, min = 1 , max = 5 , increment = 2 )
44824488
44834489 Note that the ``access_token `` parameter should be set to a callable. This is
@@ -4683,8 +4689,9 @@ Oracle Autonomous Database with mutual TLS (mTLS). See :ref:`autonomousdb`.
46834689
46844690When using the :ref: `oci_tokens <ocicloudnativeauthplugin >` plugin to generate
46854691OCI IAM tokens to connect to Oracle Autonomous Database in Thin mode, you need
4686- to explicitly set the ``config_dir ``, ``wallet_location ``, ``wallet_password ``
4687- and ``extra_auth_params `` parameters of :func: `~oracledb.connect `. For example:
4692+ to explicitly set the ``extra_auth_params `` parameter of
4693+ :func: `~oracledb.connect `, and also any desired ``config_dir ``,
4694+ ``wallet_location ``, and ``wallet_password `` parameters. For example:
46884695
46894696.. code :: python
46904697
@@ -4707,9 +4714,10 @@ and ``extra_auth_params`` parameters of :func:`~oracledb.connect`. For example:
47074714
47084715When using the :ref: `oci_tokens <ocicloudnativeauthplugin >` plugin to generate
47094716OCI IAM tokens to connect to Oracle Autonomous Database in Thin mode, you need
4710- to explicitly set the ``config_dir ``, ``homogeneous ``, ``wallet_location ``,
4711- ``wallet_password ``, and ``extra_auth_params `` parameters of
4712- :func: `~oracledb.create_pool `. For example:
4717+ to explicitly set the ``extra_auth_params `` parameter of
4718+ :func: `~oracledb.create_pool `, and also any desired ``config_dir ``,
4719+ ``wallet_location ``, and ``wallet_password `` parameters. The ``homogeneous ``
4720+ parameter must be *True * (its default value). For example:
47134721
47144722.. code :: python
47154723
@@ -4761,9 +4769,10 @@ to explicitly set the ``externalauth`` and ``extra_auth_params`` parameters of
47614769 **Connection Pools in Thick Mode Using OCI IAM Tokens **
47624770
47634771When using the :ref: `oci_tokens <ocicloudnativeauthplugin >` plugin to generate
4764- OCI IAM tokens to connect to Oracle Autonomous Database in Thick mode, you
4765- need to explicitly set the ``externalauth ``, ``homogeneous ``, and
4766- ``extra_auth_params `` parameters of :func: `~oracledb.create_pool `. For example:
4772+ OCI IAM tokens to connect to Oracle Autonomous Database in Thick mode, you need
4773+ to explicitly set the ``extra_auth_params `` and ``externalauth `` parameters of
4774+ :func: `~oracledb.create_pool `. The ``homogeneous `` parameter must be *True *
4775+ (its default value). For example:
47674776
47684777.. code :: python
47694778
0 commit comments