[
https://issues.apache.org/jira/browse/IGNITE-25954?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Igor Sapego updated IGNITE-25954:
---------------------------------
Description:
Below is the documentation comment from code, which contains all the arguments.
Let's make sure they all are described in the documentation.
{noformat}
"""
Establish connection with the Ignite cluster.
Parameters
----------
address: [str]
A list of cluster node addresses for the client to choose from. Used
for initial connection and fail-over.
Keyword Arguments
-----------------
identity: str, optional
An identifier to use for authentication. E.g. username.
secret: str, optional
A secret to use for authentication. E.g. password.
schema: str, optional
A schema name to be used by default. Default value: 'PUBLIC'.
timezone: str, optional
A timezone to use as a client's timezone. Required to correctly work
with date/time values, received from
the client. By default, a server's timezone is used.
page_size: int, optional
Maximum number of rows that can be received or sent in a single
request. Default value: 1024.
timeout: int, optional
A timeout for network operations, in seconds. Default value: 30.
autocommit: bool, optional
Connection autocommit mode. Default value: True (enabled).
use_ssl: bool, optional
Set to True if you like to use SSL for your connection. Make sure it's
configured on the server side as well.
ssl_keyfile: str, optional
A path to SSL key file to identify the local (client) party.
ssl_certfile: str, optional
A path to ssl certificate file to identify the local (client) party.
ssl_ca_certfile: str, optional
A path to a trusted certificate or a certificate chain.
Required to check the validity of the remote (server-side) certificate.
"""
{code}
was:
Below is the documentation comment from code, which contains all the arguments.
Let's make sure they all are described in the documentation.
{code:python}
"""
Establish connection with the Ignite cluster.
Parameters
----------
address: [str]
A list of cluster node addresses for the client to choose from. Used
for initial connection and fail-over.
Keyword Arguments
-----------------
identity: str, optional
An identifier to use for authentication. E.g. username.
secret: str, optional
A secret to use for authentication. E.g. password.
schema: str, optional
A schema name to be used by default. Default value: 'PUBLIC'.
timezone: str, optional
A timezone to use as a client's timezone. Required to correctly work
with date/time values, received from
the client. By default, a server's timezone is used.
page_size: int, optional
Maximum number of rows that can be received or sent in a single
request. Default value: 1024.
timeout: int, optional
A timeout for network operations, in seconds. Default value: 30.
autocommit: bool, optional
Connection autocommit mode. Default value: True (enabled).
use_ssl: bool, optional
Set to True if you like to use SSL for your connection. Make sure it's
configured on the server side as well.
ssl_keyfile: str, optional
A path to SSL key file to identify the local (client) party.
ssl_certfile: str, optional
A path to ssl certificate file to identify the local (client) party.
ssl_ca_certfile: str, optional
A path to a trusted certificate or a certificate chain.
Required to check the validity of the remote (server-side) certificate.
"""
{code}
> DB API Driver 3: Document additional arguments of pyignite_dbapi.connect()
> --------------------------------------------------------------------------
>
> Key: IGNITE-25954
> URL: https://issues.apache.org/jira/browse/IGNITE-25954
> Project: Ignite
> Issue Type: Improvement
> Components: documentation ai3, thin clients ai3
> Reporter: Igor Sapego
> Priority: Major
> Labels: ignite-3
>
> Below is the documentation comment from code, which contains all the
> arguments. Let's make sure they all are described in the documentation.
> {noformat}
> """
> Establish connection with the Ignite cluster.
> Parameters
> ----------
> address: [str]
> A list of cluster node addresses for the client to choose from. Used
> for initial connection and fail-over.
> Keyword Arguments
> -----------------
> identity: str, optional
> An identifier to use for authentication. E.g. username.
> secret: str, optional
> A secret to use for authentication. E.g. password.
> schema: str, optional
> A schema name to be used by default. Default value: 'PUBLIC'.
> timezone: str, optional
> A timezone to use as a client's timezone. Required to correctly work
> with date/time values, received from
> the client. By default, a server's timezone is used.
> page_size: int, optional
> Maximum number of rows that can be received or sent in a single
> request. Default value: 1024.
> timeout: int, optional
> A timeout for network operations, in seconds. Default value: 30.
> autocommit: bool, optional
> Connection autocommit mode. Default value: True (enabled).
> use_ssl: bool, optional
> Set to True if you like to use SSL for your connection. Make sure
> it's configured on the server side as well.
> ssl_keyfile: str, optional
> A path to SSL key file to identify the local (client) party.
> ssl_certfile: str, optional
> A path to ssl certificate file to identify the local (client) party.
> ssl_ca_certfile: str, optional
> A path to a trusted certificate or a certificate chain.
> Required to check the validity of the remote (server-side)
> certificate.
> """
> {code}
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
