Skip to content

Commit a47d3e5

Browse files
9EOR99EOR9
committed
Implementation of CONPY-129:
Added connection attribute server_version_info and (for compatibiliry) get_server_version() method. Both return a tuple, describing the version number of connected server in following format: (MAJOR_VERSION, MINOR_VERSION, PATCH_VERSION)
1 parent 4a5d02a commit a47d3e5

20 files changed

+860
-808
lines changed

‎doc/source/connection.rst‎

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ Connection constructors
3232
- **buffered** (bool): When set to `True` the entire result set from a SELECT/SHOW statement will be stored in client memory
3333
- **prepared** (bool): When set to `True` cursor will remain in prepared state after the first :func:`~cursor.execute` method was called. Further calls to *execute()* method will ignore the sql statement.
3434
- **binary** (bool): When set to `True` cursor will be executed using the MariaDB client/server binary protocol.
35-
.. versionadded:: 1.0.1
3635

3736
:return: Returns a cursor object or raises an exception if an error occured.
3837

38+
.. versionadded:: 1.0.1
3939

4040
.. method:: xid(format_id, global_transaction_id, branch_qualifier)
4141

@@ -86,6 +86,15 @@ Connection methods
8686
use the connection. If the connection was obtained by *ConnectionPool*,
8787
the connection will not be closed but returned to the pool.
8888

89+
.. method:: get_server_version()
90+
91+
Returns numeric version of connected database server as tuple.
92+
The form of the tuple is (VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH).
93+
94+
The get_server_version() method was added for compatibility. New applications should use the connection attribute server_version_info.
95+
96+
.. versionadded:: 1.0.5
97+
8998
.. method:: escape_string(escape_str)
9099

91100
This function is used to create a legal SQL string that you can use in
@@ -237,7 +246,7 @@ Connection attributes
237246

238247
.. data:: server_info
239248

240-
Returns the alphanumeric version of connected database. Tthe numeric version
249+
Returns the alphanumeric version of connected database. The numeric version
241250
can be obtained via server_version() property.
242251

243252
.. data:: server_name
@@ -253,6 +262,13 @@ Connection attributes
253262
Returns numeric version of connected database server. The form of the version
254263
number is VERSION_MAJOR * 10000 + VERSION_MINOR * 100 + VERSION_PATCH
255264

265+
.. data:: server_version_info
266+
267+
Returns numeric version of connected database server as tuple.
268+
The form of the tuple is (VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH)
269+
270+
.. versionadded:: 1.0.5
271+
256272
.. data:: tls_cipher
257273

258274
Returns TLS cipher suite in use by connection

‎docs/connection.html‎

Lines changed: 165 additions & 163 deletions
Large diffs are not rendered by default.

‎docs/cursor.html‎

Lines changed: 112 additions & 131 deletions
Large diffs are not rendered by default.

‎docs/extension.html‎

Lines changed: 93 additions & 93 deletions
Large diffs are not rendered by default.

‎docs/genindex.html‎

Lines changed: 41 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
11

2+
<!DOCTYPE html>
23

3-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5-
6-
<html xmlns="http://www.w3.org/1999/xhtml">
4+
<html>
75
<head>
8-
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
9-
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6+
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
108
<title>Index &#8212; MariaDB Connector/Python 1.0.0 documentation</title>
11-
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
129
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
10+
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
1311

14-
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
15-
<script type="text/javascript" src="_static/jquery.js"></script>
16-
<script type="text/javascript" src="_static/underscore.js"></script>
17-
<script type="text/javascript" src="_static/doctools.js"></script>
18-
<script type="text/javascript" src="_static/language_data.js"></script>
12+
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
13+
<script src="_static/jquery.js"></script>
14+
<script src="_static/underscore.js"></script>
15+
<script src="_static/doctools.js"></script>
16+
<script src="_static/language_data.js"></script>
1917

2018
<link rel="index" title="Index" href="#" />
2119
<link rel="search" title="Search" href="search.html" />
@@ -29,7 +27,8 @@ <h3>Navigation</h3>
2927
<li class="right" >
3028
<a href="py-modindex.html" title="Python Module Index"
3129
>modules</a> |</li>
32-
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.0.0 documentation</a> &#187;</li>
30+
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.0.0 documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-this"><a href="">Index</a></li>
3332
</ul>
3433
</div>
3534

@@ -196,6 +195,10 @@ <h2 id="G">G</h2>
196195
<table style="width: 100%" class="indextable genindextable"><tr>
197196
<td style="width: 33%; vertical-align: top;"><ul>
198197
<li><a href="pool.html#ConnectionPool.get_connection">get_connection() (ConnectionPool method)</a>
198+
</li>
199+
</ul></td>
200+
<td style="width: 33%; vertical-align: top;"><ul>
201+
<li><a href="connection.html#get_server_version">get_server_version()</a>
199202
</li>
200203
</ul></td>
201204
</tr></table>
@@ -241,8 +244,13 @@ <h2 id="L">L</h2>
241244
<h2 id="M">M</h2>
242245
<table style="width: 100%" class="indextable genindextable"><tr>
243246
<td style="width: 33%; vertical-align: top;"><ul>
244-
<li><a href="module.html#module-mariadb">mariadb (module)</a>
247+
<li>
248+
mariadb
249+
250+
<ul>
251+
<li><a href="module.html#module-mariadb">module</a>
245252
</li>
253+
</ul></li>
246254
<li><a href="connection.html#mariadb.connection">mariadb.connection (built-in class)</a>
247255
</li>
248256
<li><a href="extension.html#mariadb.constants.CLIENT.COMPRESS">mariadb.constants.CLIENT.COMPRESS (built-in variable)</a>
@@ -281,10 +289,10 @@ <h2 id="M">M</h2>
281289
</li>
282290
<li><a href="extension.html#mariadb.constants.FIELD_TYPE.INT24">mariadb.constants.FIELD_TYPE.INT24 (built-in variable)</a>
283291
</li>
284-
</ul></td>
285-
<td style="width: 33%; vertical-align: top;"><ul>
286292
<li><a href="extension.html#mariadb.constants.FIELD_TYPE.JSON">mariadb.constants.FIELD_TYPE.JSON (built-in variable)</a>
287293
</li>
294+
</ul></td>
295+
<td style="width: 33%; vertical-align: top;"><ul>
288296
<li><a href="extension.html#mariadb.constants.FIELD_TYPE.LONG">mariadb.constants.FIELD_TYPE.LONG (built-in variable)</a>
289297
</li>
290298
<li><a href="extension.html#mariadb.constants.FIELD_TYPE.LONG_BLOB">mariadb.constants.FIELD_TYPE.LONG_BLOB (built-in variable)</a>
@@ -325,6 +333,13 @@ <h2 id="M">M</h2>
325333
</li>
326334
<li><a href="module.html#mariadb.mariadbapi_version">mariadbapi_version (in module mariadb)</a>
327335
</li>
336+
<li>
337+
module
338+
339+
<ul>
340+
<li><a href="module.html#module-mariadb">mariadb</a>
341+
</li>
342+
</ul></li>
328343
</ul></td>
329344
</tr></table>
330345

@@ -396,10 +411,12 @@ <h2 id="S">S</h2>
396411
<li><a href="connection.html#server_name">server_name (built-in variable)</a>
397412
</li>
398413
<li><a href="connection.html#server_port">server_port (built-in variable)</a>
414+
</li>
415+
<li><a href="connection.html#server_version">server_version (built-in variable)</a>
399416
</li>
400417
</ul></td>
401418
<td style="width: 33%; vertical-align: top;"><ul>
402-
<li><a href="connection.html#server_version">server_version (built-in variable)</a>
419+
<li><a href="connection.html#server_version_info">server_version_info (built-in variable)</a>
403420
</li>
404421
<li><a href="pool.html#ConnectionPool.set_config">set_config() (ConnectionPool method)</a>
405422
</li>
@@ -478,23 +495,22 @@ <h2 id="X">X</h2>
478495

479496

480497

498+
<div class="clearer"></div>
481499
</div>
482500
</div>
483501
</div>
484502
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
485503
<div class="sphinxsidebarwrapper">
486504
<div id="searchbox" style="display: none" role="search">
487-
<h3>Quick search</h3>
505+
<h3 id="searchlabel">Quick search</h3>
488506
<div class="searchformwrapper">
489507
<form class="search" action="search.html" method="get">
490-
<input type="text" name="q" />
508+
<input type="text" name="q" aria-labelledby="searchlabel" />
491509
<input type="submit" value="Go" />
492-
<input type="hidden" name="check_keywords" value="yes" />
493-
<input type="hidden" name="area" value="default" />
494510
</form>
495511
</div>
496512
</div>
497-
<script type="text/javascript">$('#searchbox').show(0);</script>
513+
<script>$('#searchbox').show(0);</script>
498514
</div>
499515
</div>
500516
<div class="clearer"></div>
@@ -508,12 +524,13 @@ <h3>Navigation</h3>
508524
<li class="right" >
509525
<a href="py-modindex.html" title="Python Module Index"
510526
>modules</a> |</li>
511-
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.0.0 documentation</a> &#187;</li>
527+
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.0.0 documentation</a> &#187;</li>
528+
<li class="nav-item nav-item-this"><a href="">Index</a></li>
512529
</ul>
513530
</div>
514531
<div class="footer" role="contentinfo">
515532
&#169; Copyright 2019,2020 MariaDB Corporation and Georg Richter.
516-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
533+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.3.1.
517534
</div>
518535
</body>
519536
</html>

‎docs/index.html‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11

2-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<!DOCTYPE html>
43

5-
<html xmlns="http://www.w3.org/1999/xhtml">
4+
<html>
65
<head>
7-
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
8-
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6+
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
98
<title>MariaDB Connector/Python &#8212; MariaDB Connector/Python 1.0.0 documentation</title>
10-
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
119
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
10+
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
1211

13-
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
14-
<script type="text/javascript" src="_static/jquery.js"></script>
15-
<script type="text/javascript" src="_static/underscore.js"></script>
16-
<script type="text/javascript" src="_static/doctools.js"></script>
17-
<script type="text/javascript" src="_static/language_data.js"></script>
12+
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
13+
<script src="_static/jquery.js"></script>
14+
<script src="_static/underscore.js"></script>
15+
<script src="_static/doctools.js"></script>
16+
<script src="_static/language_data.js"></script>
1817

1918
<link rel="index" title="Index" href="genindex.html" />
2019
<link rel="search" title="Search" href="search.html" />
@@ -32,7 +31,8 @@ <h3>Navigation</h3>
3231
<li class="right" >
3332
<a href="install.html" title="Installation"
3433
accesskey="N">next</a> |</li>
35-
<li class="nav-item nav-item-0"><a href="#">MariaDB Connector/Python 1.0.0 documentation</a> &#187;</li>
34+
<li class="nav-item nav-item-0"><a href="#">MariaDB Connector/Python 1.0.0 documentation</a> &#187;</li>
35+
<li class="nav-item nav-item-this"><a href="">MariaDB Connector/Python</a></li>
3636
</ul>
3737
</div>
3838

@@ -96,14 +96,15 @@ <h1>MariaDB Connector/Python<a class="headerlink" href="#mariadb-connector-pytho
9696
<div class="section" id="indices-and-tables">
9797
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h2>
9898
<ul class="simple">
99-
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
100-
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
101-
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
99+
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
100+
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
101+
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
102102
</ul>
103103
</div>
104104
</div>
105105

106106

107+
<div class="clearer"></div>
107108
</div>
108109
</div>
109110
</div>
@@ -128,17 +129,15 @@ <h3>This Page</h3>
128129
</ul>
129130
</div>
130131
<div id="searchbox" style="display: none" role="search">
131-
<h3>Quick search</h3>
132+
<h3 id="searchlabel">Quick search</h3>
132133
<div class="searchformwrapper">
133134
<form class="search" action="search.html" method="get">
134-
<input type="text" name="q" />
135+
<input type="text" name="q" aria-labelledby="searchlabel" />
135136
<input type="submit" value="Go" />
136-
<input type="hidden" name="check_keywords" value="yes" />
137-
<input type="hidden" name="area" value="default" />
138137
</form>
139138
</div>
140139
</div>
141-
<script type="text/javascript">$('#searchbox').show(0);</script>
140+
<script>$('#searchbox').show(0);</script>
142141
</div>
143142
</div>
144143
<div class="clearer"></div>
@@ -155,12 +154,13 @@ <h3>Navigation</h3>
155154
<li class="right" >
156155
<a href="install.html" title="Installation"
157156
>next</a> |</li>
158-
<li class="nav-item nav-item-0"><a href="#">MariaDB Connector/Python 1.0.0 documentation</a> &#187;</li>
157+
<li class="nav-item nav-item-0"><a href="#">MariaDB Connector/Python 1.0.0 documentation</a> &#187;</li>
158+
<li class="nav-item nav-item-this"><a href="">MariaDB Connector/Python</a></li>
159159
</ul>
160160
</div>
161161
<div class="footer" role="contentinfo">
162162
&#169; Copyright 2019,2020 MariaDB Corporation and Georg Richter.
163-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
163+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.3.1.
164164
</div>
165165
</body>
166166
</html>

0 commit comments

Comments
 (0)