Skip to content

Commit 64aefb6

Browse files
9EOR99EOR9
committed
Updated version number in generated
online documentation
1 parent e3ef9aa commit 64aefb6

17 files changed

+74
-68
lines changed

‎docs/_static/documentation_options.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '1.1.0-alpha2-alpha',
3+
VERSION: '1.1.0b1-beta',
44
LANGUAGE: 'None',
55
COLLAPSE_INDEX: false,
66
BUILDER: 'html',

‎docs/api.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>API Reference &#8212; MariaDB Connector/Python 1.1.0-alpha2-alpha documentation</title>
8+
<title>API Reference &#8212; MariaDB Connector/Python 1.1.0b1-beta documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
1111

@@ -34,7 +34,7 @@ <h3>Navigation</h3>
3434
<li class="right" >
3535
<a href="pooling.html" title="Connection pooling"
3636
accesskey="P">previous</a> |</li>
37-
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.1.0-alpha2-alpha documentation</a> &#187;</li>
37+
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.1.0b1-beta documentation</a> &#187;</li>
3838
<li class="nav-item nav-item-this"><a href="">API Reference</a></li>
3939
</ul>
4040
</div>
@@ -136,7 +136,7 @@ <h3>Navigation</h3>
136136
<li class="right" >
137137
<a href="pooling.html" title="Connection pooling"
138138
>previous</a> |</li>
139-
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.1.0-alpha2-alpha documentation</a> &#187;</li>
139+
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.1.0b1-beta documentation</a> &#187;</li>
140140
<li class="nav-item nav-item-this"><a href="">API Reference</a></li>
141141
</ul>
142142
</div>

‎docs/connection.html‎

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>The connection class &#8212; MariaDB Connector/Python 1.1.0-alpha2-alpha documentation</title>
8+
<title>The connection class &#8212; MariaDB Connector/Python 1.1.0b1-beta documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
1111

@@ -34,7 +34,7 @@ <h3>Navigation</h3>
3434
<li class="right" >
3535
<a href="module.html" title="The mariadb module"
3636
accesskey="P">previous</a> |</li>
37-
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.1.0-alpha2-alpha documentation</a> &#187;</li>
37+
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.1.0b1-beta documentation</a> &#187;</li>
3838
<li class="nav-item nav-item-1"><a href="api.html" accesskey="U">API Reference</a> &#187;</li>
3939
<li class="nav-item nav-item-this"><a href="">The connection class</a></li>
4040
</ul>
@@ -99,17 +99,13 @@ <h2>Connection constructors<a class="headerlink" href="#connection-constructors"
9999
</div>
100100
<dl class="py method">
101101
<dt class="sig sig-object py" id="mariadb.connections.Connection.xid">
102-
<span class="sig-prename descclassname"><span class="pre">Connection.</span></span><span class="sig-name descname"><span class="pre">xid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">transaction_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch_qualifier</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mariadb.connections.Connection.xid" title="Permalink to this definition"></a></dt>
102+
<span class="sig-prename descclassname"><span class="pre">Connection.</span></span><span class="sig-name descname"><span class="pre">xid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">format_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">global_transaction_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch_qualifier</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mariadb.connections.Connection.xid" title="Permalink to this definition"></a></dt>
103103
<dd><p>A transaction ID object suitable for passing to the .tpc_*()
104104
methods of this connection.</p>
105-
<dl class="simple">
106-
<dt>Parameters:</dt><dd><ul class="simple">
107-
<li><p>format_id: Format id. If not set default value <cite>0</cite> will be used.</p></li>
108-
<li><p>global_transaction_id: Global transaction qualifier, which must be unique. The maximum length of the global transaction id is limited to 64 characters.</p></li>
109-
<li><p>branch_qualifier: Branch qualifier which represents a local transaction identifier. The maximum length of the branch qualifier is limited to 64 characters.</p></li>
110-
</ul>
111-
</dd>
112-
</dl>
105+
<p>Parameters:
106+
:param int format_id: Format id. If not set default value <cite>0</cite> will be used.
107+
:param str global_transaction_id: Global transaction qualifier, which must be unique. The maximum length of the global transaction id is limited to 64 characters.
108+
:param str branch_qualifier: Branch qualifier which represents a local transaction identifier. The maximum length of the branch qualifier is limited to 64 characters.</p>
113109
</dd></dl>
114110

115111
</div>
@@ -270,7 +266,7 @@ <h2>Connection methods<a class="headerlink" href="#connection-methods" title="Pe
270266
</div>
271267
<dl class="py method">
272268
<dt class="sig sig-object py" id="mariadb.connections.Connection.select_db">
273-
<span class="sig-prename descclassname"><span class="pre">Connection.</span></span><span class="sig-name descname"><span class="pre">select_db</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_db</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mariadb.connections.Connection.select_db" title="Permalink to this definition"></a></dt>
269+
<span class="sig-prename descclassname"><span class="pre">Connection.</span></span><span class="sig-name descname"><span class="pre">select_db</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_db</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mariadb.connections.Connection.select_db" title="Permalink to this definition"></a></dt>
274270
<dd><p>Gets the default database for the current connection.</p>
275271
<p>The default database can also be obtained or changed by database attribute.</p>
276272
</dd></dl>
@@ -564,7 +560,7 @@ <h3>Navigation</h3>
564560
<li class="right" >
565561
<a href="module.html" title="The mariadb module"
566562
>previous</a> |</li>
567-
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.1.0-alpha2-alpha documentation</a> &#187;</li>
563+
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.1.0b1-beta documentation</a> &#187;</li>
568564
<li class="nav-item nav-item-1"><a href="api.html" >API Reference</a> &#187;</li>
569565
<li class="nav-item nav-item-this"><a href="">The connection class</a></li>
570566
</ul>

‎docs/constants.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Constants &#8212; MariaDB Connector/Python 1.1.0-alpha2-alpha documentation</title>
8+
<title>Constants &#8212; MariaDB Connector/Python 1.1.0b1-beta documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
1111

@@ -34,7 +34,7 @@ <h3>Navigation</h3>
3434
<li class="right" >
3535
<a href="pool.html" title="The ConnectionPool class"
3636
accesskey="P">previous</a> |</li>
37-
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.1.0-alpha2-alpha documentation</a> &#187;</li>
37+
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.1.0b1-beta documentation</a> &#187;</li>
3838
<li class="nav-item nav-item-1"><a href="api.html" accesskey="U">API Reference</a> &#187;</li>
3939
<li class="nav-item nav-item-this"><a href="">Constants</a></li>
4040
</ul>
@@ -564,7 +564,7 @@ <h3>Navigation</h3>
564564
<li class="right" >
565565
<a href="pool.html" title="The ConnectionPool class"
566566
>previous</a> |</li>
567-
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.1.0-alpha2-alpha documentation</a> &#187;</li>
567+
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.1.0b1-beta documentation</a> &#187;</li>
568568
<li class="nav-item nav-item-1"><a href="api.html" >API Reference</a> &#187;</li>
569569
<li class="nav-item nav-item-this"><a href="">Constants</a></li>
570570
</ul>

‎docs/cursor.html‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>The cursor class &#8212; MariaDB Connector/Python 1.1.0-alpha2-alpha documentation</title>
8+
<title>The cursor class &#8212; MariaDB Connector/Python 1.1.0b1-beta documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
1111

@@ -34,7 +34,7 @@ <h3>Navigation</h3>
3434
<li class="right" >
3535
<a href="connection.html" title="The connection class"
3636
accesskey="P">previous</a> |</li>
37-
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.1.0-alpha2-alpha documentation</a> &#187;</li>
37+
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.1.0b1-beta documentation</a> &#187;</li>
3838
<li class="nav-item nav-item-1"><a href="api.html" accesskey="U">API Reference</a> &#187;</li>
3939
<li class="nav-item nav-item-this"><a href="">The cursor class</a></li>
4040
</ul>
@@ -57,12 +57,17 @@ <h1>The cursor class<a class="headerlink" href="#the-cursor-class" title="Permal
5757
<h2>Cursor methods<a class="headerlink" href="#cursor-methods" title="Permalink to this headline"></a></h2>
5858
<dl class="py method">
5959
<dt class="sig sig-object py" id="mariadb.cursors.Cursor.callproc">
60-
<span class="sig-prename descclassname"><span class="pre">Cursor.</span></span><span class="sig-name descname"><span class="pre">callproc</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sp</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mariadb.cursors.Cursor.callproc" title="Permalink to this definition"></a></dt>
60+
<span class="sig-prename descclassname"><span class="pre">Cursor.</span></span><span class="sig-name descname"><span class="pre">callproc</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sp</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Sequence</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">()</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mariadb.cursors.Cursor.callproc" title="Permalink to this definition"></a></dt>
6161
<dd><p>Executes a stored procedure sp. The data sequence must contain an entry for
6262
each parameter the procedure expects.</p>
6363
<p>Input/Output or Output parameters have to be retrieved by .fetch methods,
64-
the .sp_outparams attribute indicates if the result set contains output”
65-
parameters</p>
64+
the .sp_outparams attribute indicates if the result set contains output
65+
parameters.</p>
66+
<dl class="simple">
67+
<dt>Args:</dt><dd><p>sp: Name of stored procedure.
68+
data: Optional sequence containing data for placeholder substitution.</p>
69+
</dd>
70+
</dl>
6671
<p>Example:</p>
6772
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="go">&gt;&gt;&gt;cursor.execute(&quot;CREATE PROCEDURE p1(IN i1 VAR CHAR(20), OUT o2 VARCHAR(40))&quot;</span>
6873
<span class="go"> &quot;BEGIN&quot;</span>
@@ -86,7 +91,7 @@ <h2>Cursor methods<a class="headerlink" href="#cursor-methods" title="Permalink
8691

8792
<dl class="py method">
8893
<dt class="sig sig-object py" id="mariadb.cursors.Cursor.execute">
89-
<span class="sig-prename descclassname"><span class="pre">Cursor.</span></span><span class="sig-name descname"><span class="pre">execute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">statement</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffered</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mariadb.cursors.Cursor.execute" title="Permalink to this definition"></a></dt>
94+
<span class="sig-prename descclassname"><span class="pre">Cursor.</span></span><span class="sig-name descname"><span class="pre">execute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">statement</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Sequence</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffered</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mariadb.cursors.Cursor.execute" title="Permalink to this definition"></a></dt>
9095
<dd><p>Prepare and execute a SQL statement.</p>
9196
<p>Parameters may be provided as sequence or mapping and will be bound
9297
to variables in the operation. Variables are specified as question
@@ -149,7 +154,7 @@ <h2>Cursor methods<a class="headerlink" href="#cursor-methods" title="Permalink
149154

150155
<dl class="py method">
151156
<dt class="sig sig-object py" id="mariadb.cursors.Cursor.fetchmany">
152-
<span class="sig-prename descclassname"><span class="pre">Cursor.</span></span><span class="sig-name descname"><span class="pre">fetchmany</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mariadb.cursors.Cursor.fetchmany" title="Permalink to this definition"></a></dt>
157+
<span class="sig-prename descclassname"><span class="pre">Cursor.</span></span><span class="sig-name descname"><span class="pre">fetchmany</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">int</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mariadb.cursors.Cursor.fetchmany" title="Permalink to this definition"></a></dt>
153158
<dd><p>Fetch the next set of rows of a query result, returning a sequence
154159
of sequences (e.g. a list of tuples). An empty sequence is returned
155160
when no more rows are available.</p>
@@ -188,7 +193,7 @@ <h2>Cursor methods<a class="headerlink" href="#cursor-methods" title="Permalink
188193

189194
<dl class="py method">
190195
<dt class="sig sig-object py" id="mariadb.cursors.Cursor.scroll">
191-
<span class="sig-prename descclassname"><span class="pre">Cursor.</span></span><span class="sig-name descname"><span class="pre">scroll</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'relative'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mariadb.cursors.Cursor.scroll" title="Permalink to this definition"></a></dt>
196+
<span class="sig-prename descclassname"><span class="pre">Cursor.</span></span><span class="sig-name descname"><span class="pre">scroll</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'relative'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mariadb.cursors.Cursor.scroll" title="Permalink to this definition"></a></dt>
192197
<dd><p>Scroll the cursor in the result set to a new position according to mode.</p>
193198
<p>If mode is “relative” (default), value is taken as offset to the current
194199
position in the result set, if set to absolute, value states an absolute
@@ -401,7 +406,7 @@ <h3>Navigation</h3>
401406
<li class="right" >
402407
<a href="connection.html" title="The connection class"
403408
>previous</a> |</li>
404-
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.1.0-alpha2-alpha documentation</a> &#187;</li>
409+
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.1.0b1-beta documentation</a> &#187;</li>
405410
<li class="nav-item nav-item-1"><a href="api.html" >API Reference</a> &#187;</li>
406411
<li class="nav-item nav-item-this"><a href="">The cursor class</a></li>
407412
</ul>

0 commit comments

Comments
 (0)