mirror of
https://github.com/mariadb-corporation/mariadb-connector-python.git
synced 2025-08-15 23:42:40 +00:00
Udated documentation
This commit is contained in:
Georg Richter
@ -81,15 +81,6 @@ client library for client server communication.</p>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#mariadb-connector-python-documentation">MariaDB Connector/Python documentation</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="release.html">Release notes</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="release.html#mariadb-connector-python-0-9-59-beta">MariaDB Connector/Python 0.9.59 beta</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="release.html#mariadb-connector-python-0-9-58-beta">MariaDB Connector/Python 0.9.58 beta</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="release.html#mariadb-connector-python-0-9-57-beta">MariaDB Connector/Python 0.9.57 beta</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="release.html#mariadb-connector-python-0-9-56-beta">MariaDB Connector/Python 0.9.56 beta</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="release.html#mariadb-connector-python-0-9-55-beta">MariaDB Connector/Python 0.9.55 beta</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="release.html#mariadb-connector-python-0-9-54-beta">MariaDB Connector/Python 0.9.54 beta</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="indices-and-tables">
|
||||
|
||||
@ -16,7 +16,7 @@
|
||||
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="The mariadb module" href="module.html" />
|
||||
<link rel="next" title="Basic usage" href="usage.html" />
|
||||
<link rel="prev" title="MariaDB Connector/Python" href="index.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
@ -29,7 +29,7 @@
|
||||
<a href="py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="module.html" title="The mariadb module"
|
||||
<a href="usage.html" title="Basic usage"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="index.html" title="MariaDB Connector/Python"
|
||||
@ -131,8 +131,8 @@ from the source directory.</p>
|
||||
<p class="topless"><a href="index.html"
|
||||
title="previous chapter">MariaDB Connector/Python</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="module.html"
|
||||
title="next chapter">The mariadb module</a></p>
|
||||
<p class="topless"><a href="usage.html"
|
||||
title="next chapter">Basic usage</a></p>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
@ -164,7 +164,7 @@ from the source directory.</p>
|
||||
<a href="py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="module.html" title="The mariadb module"
|
||||
<a href="usage.html" title="Basic usage"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="index.html" title="MariaDB Connector/Python"
|
||||
|
||||
@ -17,7 +17,7 @@
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="The connection class" href="connection.html" />
|
||||
<link rel="prev" title="Installation" href="install.html" />
|
||||
<link rel="prev" title="Basic usage" href="usage.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
@ -32,7 +32,7 @@
|
||||
<a href="connection.html" title="The connection class"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="install.html" title="Installation"
|
||||
<a href="usage.html" title="Basic usage"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.0.0 documentation</a> »</li>
|
||||
</ul>
|
||||
@ -56,10 +56,10 @@ object.</p>
|
||||
</div></blockquote>
|
||||
<p>The supported connection keywords are:</p>
|
||||
<ul class="simple">
|
||||
<li><p><strong>user</strong> (string): The username used to authenticate with the database server, defaults to current user</p></li>
|
||||
<li><p><strong>pasword</strong> (string): The password of the given user</p></li>
|
||||
<li><p><strong>user</strong>, <strong>username</strong> (string): The username used to authenticate with the database server, defaults to current user</p></li>
|
||||
<li><p><strong>password</strong>, <strong>passwd</strong> (string): The password of the given user</p></li>
|
||||
<li><p><strong>host</strong> (string): The host name or IP address of the database server</p></li>
|
||||
<li><p><strong>database</strong> (string): The database (schema) name to used when connecting with the database server</p></li>
|
||||
<li><p><strong>database</strong>, <strong>db</strong> (string): The database (schema) name to used when connecting with the database server</p></li>
|
||||
<li><p><strong>unix_socket</strong> (string): The location of the unix socket file to use instead of using an IP port to connect. If socket authentication is enabled, this can also be used in place of a password.</p></li>
|
||||
<li><p><strong>port</strong> (integer): The port number of the database server. If not specified the default value (=3306) will be used.</p></li>
|
||||
<li><p><strong>connect_timeout</strong> (integer): The connect timeout in seconds</p></li>
|
||||
@ -350,8 +350,8 @@ string-based (e.g. CHAR).</p>
|
||||
</ul>
|
||||
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="install.html"
|
||||
title="previous chapter">Installation</a></p>
|
||||
<p class="topless"><a href="usage.html"
|
||||
title="previous chapter">Basic usage</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="connection.html"
|
||||
title="next chapter">The connection class</a></p>
|
||||
@ -389,7 +389,7 @@ string-based (e.g. CHAR).</p>
|
||||
<a href="connection.html" title="The connection class"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="install.html" title="Installation"
|
||||
<a href="usage.html" title="Basic usage"
|
||||
>previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.0.0 documentation</a> »</li>
|
||||
</ul>
|
||||
|
||||
BIN
docs/objects.inv
BIN
docs/objects.inv
Binary file not shown.
@ -71,7 +71,13 @@ connection is available.</p>
|
||||
<dl class="method">
|
||||
<dt id="ConnectionPool.set_config">
|
||||
<code class="sig-name descname">set_config</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#ConnectionPool.set_config" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets the connection configuration for the connection pool.</p>
|
||||
<dd><p>Sets the connection configuration for the connection pool. For valid connection
|
||||
arguments see <a class="reference internal" href="module.html#mariadb.connect" title="mariadb.connect"><code class="xref py py-func docutils literal notranslate"><span class="pre">mariadb.connect()</span></code></a> method.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This method doesn’t create connections in the pool. To fill the pool one has to use
|
||||
the <a class="reference internal" href="#ConnectionPool.add_connection" title="ConnectionPool.add_connection"><code class="xref py py-func docutils literal notranslate"><span class="pre">add_connection()</span></code></a> ḿethod.</p>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="data">
|
||||
|
||||
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user