Add missing versionadded tag; make formatting consistent with other
files.
This commit is contained in:
parent
7f12d7339f
commit
c2b32a54b9
|
@ -35,11 +35,13 @@ ConnectParams Methods
|
||||||
.. method:: ConnectParams.parse_dsn_with_credentials(dsn)
|
.. method:: ConnectParams.parse_dsn_with_credentials(dsn)
|
||||||
|
|
||||||
Parses a dsn in the form <user>/<password>@<connect_string> or in the form
|
Parses a dsn in the form <user>/<password>@<connect_string> or in the form
|
||||||
<user>/<password> and returns a 3-tuple containing the parsed user, password
|
<user>/<password> and returns a 3-tuple containing the parsed user,
|
||||||
and connect string. Empty strings are returned as the value ``None``. This is
|
password and connect string. Empty strings are returned as the value
|
||||||
done automatically when a value is passed to the ``dsn`` parameter but no
|
``None``. This is done automatically when a value is passed to the ``dsn``
|
||||||
value is passed to the ``user`` password when creating a standalone
|
parameter but no value is passed to the ``user`` password when creating a
|
||||||
connection or connection pool.
|
standalone connection or connection pool.
|
||||||
|
|
||||||
|
.. versionadded:: 1.3.0
|
||||||
|
|
||||||
.. method:: ConnectParams.set(user=None, proxy_user=None, password=None, \
|
.. method:: ConnectParams.set(user=None, proxy_user=None, password=None, \
|
||||||
newpassword=None, wallet_password=None, access_token=None, host=None, \
|
newpassword=None, wallet_password=None, access_token=None, host=None, \
|
||||||
|
@ -61,9 +63,9 @@ ConnectParams Attributes
|
||||||
|
|
||||||
.. attribute:: ConnectParams.appcontext
|
.. attribute:: ConnectParams.appcontext
|
||||||
|
|
||||||
This read-only attribute is a list that specifies the application context used by
|
This read-only attribute is a list that specifies the application context
|
||||||
the connection. It is a list of 3-tuples that includes the namespace, name, and value.
|
used by the connection. It is a list of 3-tuples that includes the
|
||||||
Each entry in the tuple is a string.
|
namespace, name, and value. Each entry in the tuple is a string.
|
||||||
|
|
||||||
This attribute is only supported in the python-oracledb Thick mode.
|
This attribute is only supported in the python-oracledb Thick mode.
|
||||||
|
|
||||||
|
@ -87,11 +89,11 @@ ConnectParams Attributes
|
||||||
|
|
||||||
.. attribute:: ConnectParams.debug_jdwp
|
.. attribute:: ConnectParams.debug_jdwp
|
||||||
|
|
||||||
This read-only attribute is a string with the format "host=<host>;port=<port>"
|
This read-only attribute is a string with the format
|
||||||
that specifies the host and port of the PL/SQL debugger. This allows the
|
"host=<host>;port=<port>" that specifies the host and port of the PL/SQL
|
||||||
Java Debug Wire Protocol (JDWP) to debug the PL/SQL code invoked by the
|
debugger. This allows the Java Debug Wire Protocol (JDWP) to debug the
|
||||||
python-oracledb driver. The default value is the value of the environment
|
PL/SQL code invoked by the python-oracledb driver. The default value is the
|
||||||
variable ``ORA_DEBUG_JDWP``.
|
value of the environment variable ``ORA_DEBUG_JDWP``.
|
||||||
|
|
||||||
This attribute is only supported in the python-oracledb Thin mode. For
|
This attribute is only supported in the python-oracledb Thin mode. For
|
||||||
the python-oracledb Thick mode, set the ``ORA_DEBUG_JDWP`` environment
|
the python-oracledb Thick mode, set the ``ORA_DEBUG_JDWP`` environment
|
||||||
|
@ -119,8 +121,8 @@ ConnectParams Attributes
|
||||||
|
|
||||||
.. attribute:: ConnectParams.events
|
.. attribute:: ConnectParams.events
|
||||||
|
|
||||||
This read-only attribute is a boolean that specifies whether the events mode
|
This read-only attribute is a boolean that specifies whether the events
|
||||||
should be enabled.
|
mode should be enabled.
|
||||||
|
|
||||||
This attribute is needed for continuous query notification (CQN) and high
|
This attribute is needed for continuous query notification (CQN) and high
|
||||||
availability event notifications. The default value is False.
|
availability event notifications. The default value is False.
|
||||||
|
@ -131,8 +133,9 @@ ConnectParams Attributes
|
||||||
|
|
||||||
This read-only attribute is an integer that returns the number of minutes
|
This read-only attribute is an integer that returns the number of minutes
|
||||||
between the sending of keepalive probes.
|
between the sending of keepalive probes.
|
||||||
The default value is 0. If this attribute is set to a value greater than zero,
|
|
||||||
it enables keepalive.
|
The default value is 0. If this attribute is set to a value greater than
|
||||||
|
zero, it enables keepalive.
|
||||||
|
|
||||||
This attribute is supported in the python-oracledb Thin and Thick modes.
|
This attribute is supported in the python-oracledb Thin and Thick modes.
|
||||||
|
|
||||||
|
@ -165,96 +168,92 @@ ConnectParams Attributes
|
||||||
.. attribute:: ConnectParams.https_proxy_port
|
.. attribute:: ConnectParams.https_proxy_port
|
||||||
|
|
||||||
This read-only attribute is an integer that returns the port to be used to
|
This read-only attribute is an integer that returns the port to be used to
|
||||||
communicate with the proxy host.
|
communicate with the proxy host. The default value is 0.
|
||||||
The default value is 0.
|
|
||||||
|
|
||||||
This attribute is supported in the python-oracledb Thin and Thick modes.
|
This attribute is supported in the python-oracledb Thin and Thick modes.
|
||||||
|
|
||||||
.. attribute:: ConnectParams.matchanytag
|
.. attribute:: ConnectParams.matchanytag
|
||||||
|
|
||||||
This read-only attribute is a boolean that specifies whether any tag can be
|
This read-only attribute is a boolean that specifies whether any tag can be
|
||||||
used when acquiring a connection from the pool.
|
used when acquiring a connection from the pool. The default value is False.
|
||||||
The default value is False.
|
|
||||||
|
|
||||||
This attribute is only supported in the python-oracledb Thick mode.
|
This attribute is only supported in the python-oracledb Thick mode.
|
||||||
|
|
||||||
.. attribute:: ConnectParams.mode
|
.. attribute:: ConnectParams.mode
|
||||||
|
|
||||||
This read-only attribute is an integer that specifies the authorization mode
|
This read-only attribute is an integer that specifies the authorization mode
|
||||||
to use.
|
to use. The default value is :data:`~oracledb.AUTH_MODE_DEFAULT`.
|
||||||
The default value is :data:`~oracledb.AUTH_MODE_DEFAULT`.
|
|
||||||
|
|
||||||
This attribute is supported in the python-oracledb Thin and Thick modes.
|
This attribute is supported in the python-oracledb Thin and Thick modes.
|
||||||
|
|
||||||
.. attribute:: ConnectParams.port
|
.. attribute:: ConnectParams.port
|
||||||
|
|
||||||
This read-only attribute is an integer that returns the port number on which
|
This read-only attribute is an integer that returns the port number on
|
||||||
the database listener is listening. The default value is 1521.
|
which the database listener is listening. The default value is 1521.
|
||||||
|
|
||||||
This attribute is supported in the python-oracledb Thin and Thick modes.
|
This attribute is supported in the python-oracledb Thin and Thick modes.
|
||||||
|
|
||||||
.. attribute:: ConnectParams.protocol
|
.. attribute:: ConnectParams.protocol
|
||||||
|
|
||||||
This read-only attribute is a string that indicates whether unencrypted network
|
This read-only attribute is a string that indicates whether unencrypted
|
||||||
traffic or encrypted network traffic (TLS) is used and it can have the value
|
network traffic or encrypted network traffic (TLS) is used and it can have
|
||||||
tcp or tcps.
|
the value "tcp" or "tcps". The default value is "tcp".
|
||||||
The default value is tcp.
|
|
||||||
|
|
||||||
This attribute is supported in the python-oracledb Thin and Thick modes.
|
This attribute is supported in the python-oracledb Thin and Thick modes.
|
||||||
|
|
||||||
.. attribute:: ConnectParams.proxy_user
|
.. attribute:: ConnectParams.proxy_user
|
||||||
|
|
||||||
This read-only attribute is a string that specifies the name of the proxy user to connect to.
|
This read-only attribute is a string that specifies the name of the proxy
|
||||||
If this value is not specified, then it will be parsed out of the user if the user attribute
|
user to connect to. If this value is not specified, then it will be parsed
|
||||||
is in the form "user[proxy_user]".
|
out of the user if the user attribute is in the form "user[proxy_user]".
|
||||||
|
|
||||||
This attribute is supported in the python-oracledb Thin and Thick modes.
|
This attribute is supported in the python-oracledb Thin and Thick modes.
|
||||||
|
|
||||||
|
|
||||||
.. attribute:: ConnectParams.purity
|
.. attribute:: ConnectParams.purity
|
||||||
|
|
||||||
This read-only attribute is an integer that returns the purity used for DRCP.
|
This read-only attribute is an integer that returns the purity used for
|
||||||
When the value of this attribute is :attr:`oracledb.PURITY_DEFAULT`, then any
|
DRCP. When the value of this attribute is :attr:`oracledb.PURITY_DEFAULT`,
|
||||||
standalone connection will use :attr:`oracledb.PURITY_NEW` and any pooled
|
then any standalone connection will use :attr:`oracledb.PURITY_NEW` and any
|
||||||
connection will use :attr:`oracledb.PURITY_SELF`. The default value is
|
pooled connection will use :attr:`oracledb.PURITY_SELF`. The default value
|
||||||
:data:`~oracledb.PURITY_DEFAULT`.
|
is :data:`~oracledb.PURITY_DEFAULT`.
|
||||||
|
|
||||||
This attribute is supported in the python-oracledb Thin and Thick modes.
|
This attribute is supported in the python-oracledb Thin and Thick modes.
|
||||||
|
|
||||||
.. attribute:: ConnectParams.retry_count
|
.. attribute:: ConnectParams.retry_count
|
||||||
|
|
||||||
This read-only attribute is an integer that returns the number of times that a
|
This read-only attribute is an integer that returns the number of times
|
||||||
connection attempt should be retried before the attempt is terminated.
|
that a connection attempt should be retried before the attempt is
|
||||||
The default value is 0.
|
terminated. The default value is 0.
|
||||||
|
|
||||||
This attribute is supported in the python-oracledb Thin and Thick modes.
|
This attribute is supported in the python-oracledb Thin and Thick modes.
|
||||||
|
|
||||||
.. attribute:: ConnectParams.retry_delay
|
.. attribute:: ConnectParams.retry_delay
|
||||||
|
|
||||||
This read-only attribute is an integer that returns the number of seconds to
|
This read-only attribute is an integer that returns the number of seconds
|
||||||
wait before making a new connection attempt.
|
to wait before making a new connection attempt. The default value is 0.
|
||||||
The default value is 0.
|
|
||||||
|
|
||||||
This attribute is supported in the python-oracledb Thin and Thick modes.
|
This attribute is supported in the python-oracledb Thin and Thick modes.
|
||||||
|
|
||||||
.. attribute:: ConnectParams.server_type
|
.. attribute:: ConnectParams.server_type
|
||||||
|
|
||||||
This read-only attribute is a string that returns the type of server connection
|
This read-only attribute is a string that returns the type of server
|
||||||
that should be established. If specified, it should be one of `dedicated`, `shared`,
|
connection that should be established. If specified, it should be one of
|
||||||
or `pooled`.
|
`dedicated`, `shared`, or `pooled`.
|
||||||
|
|
||||||
This attribute is supported in the python-oracledb Thin and Thick modes.
|
This attribute is supported in the python-oracledb Thin and Thick modes.
|
||||||
|
|
||||||
.. attribute:: ConnectParams.service_name
|
.. attribute:: ConnectParams.service_name
|
||||||
|
|
||||||
This read-only attribute is a string that returns the service name of the database.
|
This read-only attribute is a string that returns the service name of the
|
||||||
|
database.
|
||||||
|
|
||||||
This attribute is supported in the python-oracledb Thin and Thick modes.
|
This attribute is supported in the python-oracledb Thin and Thick modes.
|
||||||
|
|
||||||
.. attribute:: ConnectParams.shardingkey
|
.. attribute:: ConnectParams.shardingkey
|
||||||
|
|
||||||
This read-only attribute is a list that specifies a sequence of strings, numbers,
|
This read-only attribute is a list that specifies a sequence of strings,
|
||||||
bytes, or dates that identify the database shard to connect to.
|
numbers, bytes, or dates that identify the database shard to connect to.
|
||||||
|
|
||||||
This attribute is only supported in the python-oracledb Thick mode.
|
This attribute is only supported in the python-oracledb Thick mode.
|
||||||
|
|
||||||
|
@ -267,9 +266,9 @@ ConnectParams Attributes
|
||||||
|
|
||||||
.. attribute:: ConnectParams.ssl_server_cert_dn
|
.. attribute:: ConnectParams.ssl_server_cert_dn
|
||||||
|
|
||||||
This read-only attribute is a string that returns the distinguished name (DN),
|
This read-only attribute is a string that returns the distinguished name
|
||||||
which should be matched with the server. If this value is specified, then it is
|
(DN), which should be matched with the server. If this value is specified,
|
||||||
used for any verification. Otherwise, the hostname will be used.
|
then it is used for any verification. Otherwise, the hostname will be used.
|
||||||
|
|
||||||
This value is ignored if the :attr:`~ConnectParams.ssl_server_dn_match`
|
This value is ignored if the :attr:`~ConnectParams.ssl_server_dn_match`
|
||||||
attribute is not set to the value `True`.
|
attribute is not set to the value `True`.
|
||||||
|
@ -278,12 +277,13 @@ ConnectParams Attributes
|
||||||
|
|
||||||
.. attribute:: ConnectParams.ssl_server_dn_match
|
.. attribute:: ConnectParams.ssl_server_dn_match
|
||||||
|
|
||||||
This read-only attribute is a boolean that indicates whether the server certificate
|
This read-only attribute is a boolean that indicates whether the server
|
||||||
distinguished name (DN) should be matched in addition to the regular
|
certificate distinguished name (DN) should be matched in addition to the
|
||||||
certificate verification that is performed. The default value is True.
|
regular certificate verification that is performed. The default value is
|
||||||
|
True.
|
||||||
|
|
||||||
Note that if the :attr:`~ConnectParams.ssl_server_cert_dn` attribute is not specified,
|
Note that if the :attr:`~ConnectParams.ssl_server_cert_dn` attribute is not
|
||||||
then host name matching is performed instead.
|
specified, then host name matching is performed instead.
|
||||||
|
|
||||||
This attribute is supported in the python-oracledb Thin and Thick modes.
|
This attribute is supported in the python-oracledb Thin and Thick modes.
|
||||||
|
|
||||||
|
@ -297,22 +297,22 @@ ConnectParams Attributes
|
||||||
|
|
||||||
.. attribute:: ConnectParams.supershardingkey
|
.. attribute:: ConnectParams.supershardingkey
|
||||||
|
|
||||||
This read-only attribute is a list that specifies a sequence of strings, numbers,
|
This read-only attribute is a list that specifies a sequence of strings,
|
||||||
bytes, or dates that identify the database shard to connect to.
|
numbers, bytes, or dates that identify the database shard to connect to.
|
||||||
|
|
||||||
This attribute is only supported in python-oracledb Thick mode.
|
This attribute is only supported in python-oracledb Thick mode.
|
||||||
|
|
||||||
.. attribute:: ConnectParams.tag
|
.. attribute:: ConnectParams.tag
|
||||||
|
|
||||||
This read-only attribute is a string that identifies the type of connection that
|
This read-only attribute is a string that identifies the type of connection
|
||||||
should be returned from a pool.
|
that should be returned from a pool.
|
||||||
|
|
||||||
This attribute is only supported in python-oracledb Thick mode.
|
This attribute is only supported in python-oracledb Thick mode.
|
||||||
|
|
||||||
.. attribute:: ConnectParams.tcp_connect_timeout
|
.. attribute:: ConnectParams.tcp_connect_timeout
|
||||||
|
|
||||||
This read-only attribute is a float that indicates the maximum number of seconds
|
This read-only attribute is a float that indicates the maximum number of
|
||||||
to wait for a connection to be established to the database host.
|
seconds to wait for a connection to be established to the database host.
|
||||||
The default value is 60.0.
|
The default value is 60.0.
|
||||||
|
|
||||||
This attribute is supported in the python-oracledb Thin and Thick modes.
|
This attribute is supported in the python-oracledb Thin and Thick modes.
|
||||||
|
@ -329,8 +329,8 @@ ConnectParams Attributes
|
||||||
This read-only attribute is a string that specifies the directory where the
|
This read-only attribute is a string that specifies the directory where the
|
||||||
wallet can be found.
|
wallet can be found.
|
||||||
|
|
||||||
In python-oracledb Thin mode, this attribute is the directory containing the
|
In python-oracledb Thin mode, this attribute is the directory containing
|
||||||
PEM-encoded wallet file, ewallet.pem. In python-oracledb Thick mode, this
|
the PEM-encoded wallet file, ewallet.pem. In python-oracledb Thick mode,
|
||||||
attribute is the directory containing the file, cwallet.sso.
|
this attribute is the directory containing the file, cwallet.sso.
|
||||||
|
|
||||||
This attribute is supported in the python-oracledb Thin and Thick modes.
|
This attribute is supported in the python-oracledb Thin and Thick modes.
|
||||||
|
|
Loading…
Reference in New Issue