Skip to content

Commit 3cc3a6b

Browse files
anthony-tuiningaanthony-tuininga
committed
Update documentation for ssl_version attribute.
1 parent 5e0bed2 commit 3cc3a6b

File tree

1 file changed

+36
-30
lines changed

1 file changed

+36
-30
lines changed

‎doc/src/api_manual/module.rst‎

Lines changed: 36 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -342,13 +342,14 @@ Oracledb Methods
342342
The default value is False.
343343

344344
The ``ssl_version`` parameter is expected to be one of the constants
345-
"ssl.TLSVersion.TLSv1_2" or "ssl.TLSVersion.TLSv1_3" and specifies the TLS
346-
protocol version to use. These constants are defined in the Python
345+
"ssl.TLSVersion.TLSv1_2" or "ssl.TLSVersion.TLSv1_3" which identifies the
346+
TLS protocol version used. These constants are defined in the Python
347347
`ssl <https://docs.python.org/3/library/ssl.html>`__ module. This
348348
parameter can be specified when establishing connections with the protocol
349-
"tcps". This parameter is used in both python-oracledb Thin and Thick
350-
modes. The value "ssl.TLSVersion.TLSv1_3" requires Oracle Database 23ai
351-
and for Thick mode, Oracle Client 23ai is additionally required.
349+
"tcps". This value is used in both python-oracledb Thin and Thick modes.
350+
The value "ssl.TLSVersion.TLSv1_3" requires Oracle Database 23ai. If you
351+
are using python-oracledb Thick mode, Oracle Client 23ai is additionally
352+
required.
352353

353354
If the ``handle`` parameter is specified, it must be of type OCISvcCtx\*
354355
and is only of use when embedding Python in an application (like
@@ -616,13 +617,14 @@ Oracledb Methods
616617
The default value is False.
617618

618619
The ``ssl_version`` parameter is expected to be one of the constants
619-
"ssl.TLSVersion.TLSv1_2" or "ssl.TLSVersion.TLSv1_3" and specifies the TLS
620-
protocol version to use. These constants are defined in the Python
620+
"ssl.TLSVersion.TLSv1_2" or "ssl.TLSVersion.TLSv1_3" which identifies the
621+
TLS protocol version used. These constants are defined in the Python
621622
`ssl <https://docs.python.org/3/library/ssl.html>`__ module. This
622623
parameter can be specified when establishing connections with the protocol
623-
"tcps". This parameter is used in both python-oracledb Thin and Thick
624-
modes. The value "ssl.TLSVersion.TLSv1_3" requires Oracle Database 23ai
625-
and for Thick mode, Oracle Client 23ai is additionally required.
624+
"tcps". This value is used in both python-oracledb Thin and Thick modes.
625+
The value "ssl.TLSVersion.TLSv1_3" requires Oracle Database 23ai. If you
626+
are using python-oracledb Thick mode, Oracle Client 23ai is additionally
627+
required.
626628

627629
The ``handle`` parameter is ignored in the python-oracledb Thin mode.
628630

@@ -915,13 +917,14 @@ Oracledb Methods
915917
The default value is False.
916918

917919
The ``ssl_version`` parameter is expected to be one of the constants
918-
"ssl.TLSVersion.TLSv1_2" or "ssl.TLSVersion.TLSv1_3" and specifies the TLS
919-
protocol version to use. These constants are defined in the Python
920+
"ssl.TLSVersion.TLSv1_2" or "ssl.TLSVersion.TLSv1_3" which identifies the
921+
TLS protocol version used. These constants are defined in the Python
920922
`ssl <https://docs.python.org/3/library/ssl.html>`__ module. This
921923
parameter can be specified when establishing connections with the protocol
922-
"tcps". This parameter is used in both python-oracledb Thin and Thick
923-
modes. The value "ssl.TLSVersion.TLSv1_3" requires Oracle Database 23ai
924-
and for Thick mode, Oracle Client 23ai is additionally required.
924+
"tcps". This value is used in both python-oracledb Thin and Thick modes.
925+
The value "ssl.TLSVersion.TLSv1_3" requires Oracle Database 23ai. If you
926+
are using python-oracledb Thick mode, Oracle Client 23ai is additionally
927+
required.
925928

926929
The ``handle`` parameter is expected to be an integer which represents a
927930
pointer to a valid service context handle. This value is only used in the
@@ -1316,13 +1319,14 @@ Oracledb Methods
13161319
The default value is False.
13171320

13181321
The ``ssl_version`` parameter is expected to be one of the constants
1319-
"ssl.TLSVersion.TLSv1_2" or "ssl.TLSVersion.TLSv1_3" and specifies the TLS
1320-
protocol version to use. These constants are defined in the Python
1322+
"ssl.TLSVersion.TLSv1_2" or "ssl.TLSVersion.TLSv1_3" which identifies the
1323+
TLS protocol version used. These constants are defined in the Python
13211324
`ssl <https://docs.python.org/3/library/ssl.html>`__ module. This
13221325
parameter can be specified when establishing connections with the protocol
1323-
"tcps". This parameter is used in both python-oracledb Thin and Thick
1324-
modes. The value "ssl.TLSVersion.TLSv1_3" requires Oracle Database 23ai
1325-
and for Thick mode, Oracle Client 23ai is additionally required.
1326+
"tcps". This value is used in both python-oracledb Thin and Thick modes.
1327+
The value "ssl.TLSVersion.TLSv1_3" requires Oracle Database 23ai. If you
1328+
are using python-oracledb Thick mode, Oracle Client 23ai is additionally
1329+
required.
13261330

13271331
If the ``handle`` parameter is specified, it must be of type OCISvcCtx\*
13281332
and is only of use when embedding Python in an application (like
@@ -1657,13 +1661,14 @@ Oracledb Methods
16571661
The default value is False.
16581662

16591663
The ``ssl_version`` parameter is expected to be one of the constants
1660-
"ssl.TLSVersion.TLSv1_2" or "ssl.TLSVersion.TLSv1_3" and specifies the TLS
1661-
protocol version to use. These constants are defined in the Python
1664+
"ssl.TLSVersion.TLSv1_2" or "ssl.TLSVersion.TLSv1_3" which identifies the
1665+
TLS protocol version used. These constants are defined in the Python
16621666
`ssl <https://docs.python.org/3/library/ssl.html>`__ module. This
16631667
parameter can be specified when establishing connections with the protocol
1664-
"tcps". This parameter is used in both python-oracledb Thin and Thick
1665-
modes. The value "ssl.TLSVersion.TLSv1_3" requires Oracle Database 23ai
1666-
and for Thick mode, Oracle Client 23ai is additionally required.
1668+
"tcps". This value is used in both python-oracledb Thin and Thick modes.
1669+
The value "ssl.TLSVersion.TLSv1_3" requires Oracle Database 23ai. If you
1670+
are using python-oracledb Thick mode, Oracle Client 23ai is additionally
1671+
required.
16671672

16681673
The ``handle`` parameter is ignored in the python-oracledb Thin mode.
16691674

@@ -2125,13 +2130,14 @@ Oracledb Methods
21252130
The default value is False.
21262131

21272132
The ``ssl_version`` parameter is expected to be one of the constants
2128-
"ssl.TLSVersion.TLSv1_2" or "ssl.TLSVersion.TLSv1_3" and specifies the TLS
2129-
protocol version to use. These constants are defined in the Python
2133+
"ssl.TLSVersion.TLSv1_2" or "ssl.TLSVersion.TLSv1_3" which identifies the
2134+
TLS protocol version used. These constants are defined in the Python
21302135
`ssl <https://docs.python.org/3/library/ssl.html>`__ module. This
21312136
parameter can be specified when establishing connections with the protocol
2132-
"tcps". This parameter is used in both python-oracledb Thin and Thick
2133-
modes. The value "ssl.TLSVersion.TLSv1_3" requires Oracle Database 23ai
2134-
and for Thick mode, Oracle Client 23ai is additionally required.
2137+
"tcps". This value is used in both python-oracledb Thin and Thick modes.
2138+
The value "ssl.TLSVersion.TLSv1_3" requires Oracle Database 23ai. If you
2139+
are using python-oracledb Thick mode, Oracle Client 23ai is additionally
2140+
required.
21352141

21362142
The ``handle`` parameter is expected to be an integer which represents a
21372143
pointer to a valid service context handle. This value is only used in the

0 commit comments

Comments
 (0)