Add missing versionadded tag; make formatting consistent with other
files.
This commit is contained in:
Anthony Tuininga
parent
7f12d7339f
commit
c2b32a54b9
|
|
@ -18,28 +18,30 @@ ConnectParams Methods
|
|||
|
||||
.. method:: ConnectParams.copy()
|
||||
|
||||
Creates a copy of the ConnectParams instance and returns it.
|
||||
Creates a copy of the ConnectParams instance and returns it.
|
||||
|
||||
.. method:: ConnectParams.get_connect_string()
|
||||
|
||||
Returns the connection string associated with the ConnectParams instance.
|
||||
Returns the connection string associated with the ConnectParams instance.
|
||||
|
||||
.. method:: ConnectParams.parse_connect_string(connect_string)
|
||||
|
||||
Parses the connect string into its components and stores the parameters.
|
||||
Parses the connect string into its components and stores the parameters.
|
||||
|
||||
The ``connect string`` parameter can be an Easy Connect string, name-value
|
||||
pairs, or a simple alias which is looked up in ``tnsnames.ora``. Parameters
|
||||
that are found in the connect string override any currently stored values.
|
||||
The ``connect string`` parameter can be an Easy Connect string, name-value
|
||||
pairs, or a simple alias which is looked up in ``tnsnames.ora``. Parameters
|
||||
that are found in the connect string override any currently stored values.
|
||||
|
||||
.. method:: ConnectParams.parse_dsn_with_credentials(dsn)
|
||||
|
||||
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
|
||||
and connect string. Empty strings are returned as the value ``None``. This is
|
||||
done automatically when a value is passed to the ``dsn`` parameter but no
|
||||
value is passed to the ``user`` password when creating a standalone
|
||||
connection or connection pool.
|
||||
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 and connect string. Empty strings are returned as the value
|
||||
``None``. This is done automatically when a value is passed to the ``dsn``
|
||||
parameter but no value is passed to the ``user`` password when creating a
|
||||
standalone connection or connection pool.
|
||||
|
||||
.. versionadded:: 1.3.0
|
||||
|
||||
.. method:: ConnectParams.set(user=None, proxy_user=None, password=None, \
|
||||
newpassword=None, wallet_password=None, access_token=None, host=None, \
|
||||
|
|
@ -51,7 +53,7 @@ ConnectParams Methods
|
|||
matchanytag=None, config_dir=None, appcontext=[], shardingkey=[], supershardingkey=[], \
|
||||
debug_jdwp=None, handle=None)
|
||||
|
||||
Sets one or more of the parameters.
|
||||
Sets one or more of the parameters.
|
||||
|
||||
|
||||
.. _connparamsattr:
|
||||
|
|
@ -61,276 +63,274 @@ ConnectParams Attributes
|
|||
|
||||
.. attribute:: ConnectParams.appcontext
|
||||
|
||||
This read-only attribute is a list that specifies the application context used by
|
||||
the connection. It is a list of 3-tuples that includes the namespace, name, and value.
|
||||
Each entry in the tuple is a string.
|
||||
This read-only attribute is a list that specifies the application context
|
||||
used by the connection. It is a list of 3-tuples that includes the
|
||||
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.
|
||||
|
||||
.. attribute:: ConnectParams.cclass
|
||||
|
||||
This read-only attribute is a string that specifies the connection class
|
||||
to use for Database Resident Connection Pooling (DRCP).
|
||||
This read-only attribute is a string that specifies the connection class
|
||||
to use for Database Resident Connection Pooling (DRCP).
|
||||
|
||||
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.config_dir
|
||||
|
||||
This read-only attribute is a string that identifies the directory in which
|
||||
the configuration files such as tnsnames.ora are found. The default is the
|
||||
value of :attr:`defaults.config_dir`.
|
||||
This read-only attribute is a string that identifies the directory in which
|
||||
the configuration files such as tnsnames.ora are found. The default is the
|
||||
value of :attr:`defaults.config_dir`.
|
||||
|
||||
This attribute is only supported in the python-oracledb Thin mode.
|
||||
This attribute is only supported in the python-oracledb Thin mode.
|
||||
|
||||
For the python-oracledb Thick mode, use the ``config_dir`` parameter of
|
||||
:func:`oracledb.init_oracle_client`.
|
||||
For the python-oracledb Thick mode, use the ``config_dir`` parameter of
|
||||
:func:`oracledb.init_oracle_client`.
|
||||
|
||||
.. attribute:: ConnectParams.debug_jdwp
|
||||
|
||||
This read-only attribute is a string with the format "host=<host>;port=<port>"
|
||||
that specifies the host and port of the PL/SQL debugger. This allows the
|
||||
Java Debug Wire Protocol (JDWP) to debug the PL/SQL code invoked by the
|
||||
python-oracledb driver. The default value is the value of the environment
|
||||
variable ``ORA_DEBUG_JDWP``.
|
||||
This read-only attribute is a string with the format
|
||||
"host=<host>;port=<port>" that specifies the host and port of the PL/SQL
|
||||
debugger. This allows the Java Debug Wire Protocol (JDWP) to debug the
|
||||
PL/SQL code invoked by the python-oracledb driver. The default value is the
|
||||
value of the environment variable ``ORA_DEBUG_JDWP``.
|
||||
|
||||
This attribute is only supported in the python-oracledb Thin mode. For
|
||||
the python-oracledb Thick mode, set the ``ORA_DEBUG_JDWP`` environment
|
||||
variable which has the same syntax. See :ref:`applntracing` for more
|
||||
information.
|
||||
This attribute is only supported in the python-oracledb Thin mode. For
|
||||
the python-oracledb Thick mode, set the ``ORA_DEBUG_JDWP`` environment
|
||||
variable which has the same syntax. See :ref:`applntracing` for more
|
||||
information.
|
||||
|
||||
.. attribute:: ConnectParams.disable_oob
|
||||
|
||||
This read-only attribute is a boolean that indicates whether out-of-band
|
||||
breaks should be disabled. The default value is False. Note that this value
|
||||
has no effect on Windows, which does not support this functionality.
|
||||
This read-only attribute is a boolean that indicates whether out-of-band
|
||||
breaks should be disabled. The default value is False. Note that this value
|
||||
has no effect on Windows, which does not support this functionality.
|
||||
|
||||
This attribute is only supported in the python-oracledb Thin mode.
|
||||
This attribute is only supported in the python-oracledb Thin mode.
|
||||
|
||||
For the python-oracledb Thick mode, set the equivalent option in a
|
||||
``sqlnet.ora`` file.
|
||||
For the python-oracledb Thick mode, set the equivalent option in a
|
||||
``sqlnet.ora`` file.
|
||||
|
||||
.. attribute:: ConnectParams.edition
|
||||
|
||||
This read-only attribute is a string that specifies the edition to use
|
||||
for the connection. This attribute cannot be used simultaneously with the
|
||||
:attr:`ConnectParams.cclass` attribute.
|
||||
This read-only attribute is a string that specifies the edition to use
|
||||
for the connection. This attribute cannot be used simultaneously with the
|
||||
:attr:`ConnectParams.cclass` attribute.
|
||||
|
||||
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.events
|
||||
|
||||
This read-only attribute is a boolean that specifies whether the events mode
|
||||
should be enabled.
|
||||
This read-only attribute is a boolean that specifies whether the events
|
||||
mode should be enabled.
|
||||
|
||||
This attribute is needed for continuous query notification (CQN) and high
|
||||
availability event notifications. The default value is False.
|
||||
This attribute is needed for continuous query notification (CQN) and high
|
||||
availability event notifications. 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.expire_time
|
||||
|
||||
This read-only attribute is an integer that returns the number of minutes
|
||||
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.
|
||||
This read-only attribute is an integer that returns the number of minutes
|
||||
between the sending of keepalive probes.
|
||||
|
||||
This attribute is supported in the python-oracledb Thin and Thick modes.
|
||||
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.
|
||||
|
||||
.. attribute:: ConnectParams.externalauth
|
||||
|
||||
This read-only attribute is a boolean that specifies whether external
|
||||
authentication should be used. The default value is False.
|
||||
This read-only attribute is a boolean that specifies whether external
|
||||
authentication should be used. The default value is False.
|
||||
|
||||
For standalone connections, external authentication occurs when the
|
||||
``user`` and ``password`` attributes are not used. If these attributes,
|
||||
are not used, you can optionally set the ``externalauth`` attribute to
|
||||
True, which may aid code auditing.
|
||||
For standalone connections, external authentication occurs when the
|
||||
``user`` and ``password`` attributes are not used. If these attributes,
|
||||
are not used, you can optionally set the ``externalauth`` attribute to
|
||||
True, which may aid code auditing.
|
||||
|
||||
This attribute is only supported in the python-oracledb Thick mode.
|
||||
This attribute is only supported in the python-oracledb Thick mode.
|
||||
|
||||
.. attribute:: ConnectParams.host
|
||||
|
||||
This read-only attribute is a string that returns the name or IP address of
|
||||
the machine hosting the database.
|
||||
This read-only attribute is a string that returns the name or IP address of
|
||||
the machine hosting 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.https_proxy
|
||||
|
||||
This read-only attribute is a string that returns the name or IP address of
|
||||
a proxy host that is to be used for tunneling secure connections.
|
||||
This read-only attribute is a string that returns the name or IP address of
|
||||
a proxy host that is to be used for tunneling secure connections.
|
||||
|
||||
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.https_proxy_port
|
||||
|
||||
This read-only attribute is an integer that returns the port to be used to
|
||||
communicate with the proxy host.
|
||||
The default value is 0.
|
||||
This read-only attribute is an integer that returns the port to be used to
|
||||
communicate with the proxy host. 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
|
||||
|
||||
This read-only attribute is a boolean that specifies whether any tag can be
|
||||
used when acquiring a connection from the pool.
|
||||
The default value is False.
|
||||
This read-only attribute is a boolean that specifies whether any tag can be
|
||||
used when acquiring a connection from the pool. 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
|
||||
|
||||
This read-only attribute is an integer that specifies the authorization mode
|
||||
to use.
|
||||
The default value is :data:`~oracledb.AUTH_MODE_DEFAULT`.
|
||||
This read-only attribute is an integer that specifies the authorization mode
|
||||
to use. 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
|
||||
|
||||
This read-only attribute is an integer that returns the port number on which
|
||||
the database listener is listening. The default value is 1521.
|
||||
This read-only attribute is an integer that returns the port number on
|
||||
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
|
||||
|
||||
This read-only attribute is a string that indicates whether unencrypted network
|
||||
traffic or encrypted network traffic (TLS) is used and it can have the value
|
||||
tcp or tcps.
|
||||
The default value is tcp.
|
||||
This read-only attribute is a string that indicates whether unencrypted
|
||||
network traffic or encrypted network traffic (TLS) is used and it can have
|
||||
the value "tcp" or "tcps". 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
|
||||
|
||||
This read-only attribute is a string that specifies the name of the proxy user to connect to.
|
||||
If this value is not specified, then it will be parsed out of the user if the user attribute
|
||||
is in the form "user[proxy_user]".
|
||||
This read-only attribute is a string that specifies the name of the proxy
|
||||
user to connect to. If this value is not specified, then it will be parsed
|
||||
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
|
||||
|
||||
This read-only attribute is an integer that returns the purity used for DRCP.
|
||||
When the value of this attribute is :attr:`oracledb.PURITY_DEFAULT`, then any
|
||||
standalone connection will use :attr:`oracledb.PURITY_NEW` and any pooled
|
||||
connection will use :attr:`oracledb.PURITY_SELF`. The default value is
|
||||
:data:`~oracledb.PURITY_DEFAULT`.
|
||||
This read-only attribute is an integer that returns the purity used for
|
||||
DRCP. When the value of this attribute is :attr:`oracledb.PURITY_DEFAULT`,
|
||||
then any standalone connection will use :attr:`oracledb.PURITY_NEW` and any
|
||||
pooled connection will use :attr:`oracledb.PURITY_SELF`. The default value
|
||||
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
|
||||
|
||||
This read-only attribute is an integer that returns the number of times that a
|
||||
connection attempt should be retried before the attempt is terminated.
|
||||
The default value is 0.
|
||||
This read-only attribute is an integer that returns the number of times
|
||||
that a connection attempt should be retried before the attempt is
|
||||
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
|
||||
|
||||
This read-only attribute is an integer that returns the number of seconds to
|
||||
wait before making a new connection attempt.
|
||||
The default value is 0.
|
||||
This read-only attribute is an integer that returns the number of seconds
|
||||
to wait before making a new connection attempt. 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
|
||||
|
||||
This read-only attribute is a string that returns the type of server connection
|
||||
that should be established. If specified, it should be one of `dedicated`, `shared`,
|
||||
or `pooled`.
|
||||
This read-only attribute is a string that returns the type of server
|
||||
connection that should be established. If specified, it should be one of
|
||||
`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
|
||||
|
||||
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
|
||||
|
||||
This read-only attribute is a list that specifies a sequence of strings, numbers,
|
||||
bytes, or dates that identify the database shard to connect to.
|
||||
This read-only attribute is a list that specifies a sequence of strings,
|
||||
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.
|
||||
|
||||
.. attribute:: ConnectParams.sid
|
||||
|
||||
This read-only attribute is a string that returns the SID of the database.
|
||||
It is recommended to use the :attr:`ConnectParams.service_name` instead.
|
||||
This read-only attribute is a string that returns the SID of the database.
|
||||
It is recommended to use the :attr:`ConnectParams.service_name` 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.
|
||||
|
||||
.. attribute:: ConnectParams.ssl_server_cert_dn
|
||||
|
||||
This read-only attribute is a string that returns the distinguished name (DN),
|
||||
which should be matched with the server. If this value is specified, then it is
|
||||
used for any verification. Otherwise, the hostname will be used.
|
||||
This read-only attribute is a string that returns the distinguished name
|
||||
(DN), which should be matched with the server. If this value is specified,
|
||||
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`
|
||||
attribute is not set to the value `True`.
|
||||
This value is ignored if the :attr:`~ConnectParams.ssl_server_dn_match`
|
||||
attribute is not set to the value `True`.
|
||||
|
||||
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.ssl_server_dn_match
|
||||
|
||||
This read-only attribute is a boolean that indicates whether the server certificate
|
||||
distinguished name (DN) should be matched in addition to the regular
|
||||
certificate verification that is performed. The default value is True.
|
||||
This read-only attribute is a boolean that indicates whether the server
|
||||
certificate distinguished name (DN) should be matched in addition to the
|
||||
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,
|
||||
then host name matching is performed instead.
|
||||
Note that if the :attr:`~ConnectParams.ssl_server_cert_dn` attribute is not
|
||||
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.
|
||||
|
||||
.. attribute:: ConnectParams.stmtcachesize
|
||||
|
||||
This read-only attribute is an integer that identifies the initial size of
|
||||
the statement cache. The default is the value of
|
||||
:attr:`defaults.stmtcachesize`.
|
||||
This read-only attribute is an integer that identifies the initial size of
|
||||
the statement cache. The default is the value of
|
||||
:attr:`defaults.stmtcachesize`.
|
||||
|
||||
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.supershardingkey
|
||||
|
||||
This read-only attribute is a list that specifies a sequence of strings, numbers,
|
||||
bytes, or dates that identify the database shard to connect to.
|
||||
This read-only attribute is a list that specifies a sequence of strings,
|
||||
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
|
||||
|
||||
This read-only attribute is a string that identifies the type of connection that
|
||||
should be returned from a pool.
|
||||
This read-only attribute is a string that identifies the type of connection
|
||||
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
|
||||
|
||||
This read-only attribute is a float that indicates the maximum number of seconds
|
||||
to wait for a connection to be established to the database host.
|
||||
The default value is 60.0.
|
||||
This read-only attribute is a float that indicates the maximum number of
|
||||
seconds to wait for a connection to be established to the database host.
|
||||
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.
|
||||
|
||||
.. attribute:: ConnectParams.user
|
||||
|
||||
This read-only attribute is a string that specifies the name of the user to
|
||||
connect to.
|
||||
This read-only attribute is a string that specifies the name of the user to
|
||||
connect to.
|
||||
|
||||
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.wallet_location
|
||||
|
||||
This read-only attribute is a string that specifies the directory where the
|
||||
wallet can be found.
|
||||
This read-only attribute is a string that specifies the directory where the
|
||||
wallet can be found.
|
||||
|
||||
In python-oracledb Thin mode, this attribute is the directory containing the
|
||||
PEM-encoded wallet file, ewallet.pem. In python-oracledb Thick mode, this
|
||||
attribute is the directory containing the file, cwallet.sso.
|
||||
In python-oracledb Thin mode, this attribute is the directory containing
|
||||
the PEM-encoded wallet file, ewallet.pem. In python-oracledb Thick mode,
|
||||
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