mirror of
https://github.com/mariadb-corporation/mariadb-connector-python.git
synced 2025-08-04 08:04:45 +00:00
169 lines
8.6 KiB
HTML
169 lines
8.6 KiB
HTML
<!DOCTYPE html>
|
||
|
||
<html lang="en" data-content_root="./">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<title>Bug reports — MariaDB Connector/Python 1.1.13 documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
|
||
<link rel="stylesheet" type="text/css" href="_static/classic.css?v=2bf1fcf8" />
|
||
|
||
<script src="_static/documentation_options.js?v=1240c0c0"></script>
|
||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="MariaDB Connector/Python FAQ" href="faq.html" />
|
||
<link rel="prev" title="Release history" href="release.html" />
|
||
</head><body>
|
||
<div class="related" role="navigation" aria-label="Related">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="genindex.html" title="General Index"
|
||
accesskey="I">index</a></li>
|
||
<li class="right" >
|
||
<a href="py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="right" >
|
||
<a href="faq.html" title="MariaDB Connector/Python FAQ"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="release.html" title="Release history"
|
||
accesskey="P">previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.1.13 documentation</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">Bug reports</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<section class="tex2jax_ignore mathjax_ignore" id="bug-reports">
|
||
<h1>Bug reports<a class="headerlink" href="#bug-reports" title="Link to this heading">¶</a></h1>
|
||
<p>If you think that you have found a bug in MariaDB Software, please report it at
|
||
<a class="reference external" href="https://jira.mariadb.org">Jira issue tracker</a> and file it under Project CONPY (abbreviation for Connector/Python).</p>
|
||
<section id="how-to-report-a-bug">
|
||
<h2>How to report a bug?<a class="headerlink" href="#how-to-report-a-bug" title="Link to this heading">¶</a></h2>
|
||
<section id="search-first">
|
||
<h3>Search first<a class="headerlink" href="#search-first" title="Link to this heading">¶</a></h3>
|
||
<p>Always search the bug database first. Especially if you are using an older version of MariaDB Connector/Python it could
|
||
be reported already by someone else or it was already fixed in a more recent version.</p>
|
||
</section>
|
||
<section id="what">
|
||
<h3>What?<a class="headerlink" href="#what" title="Link to this heading">¶</a></h3>
|
||
<p>We need to know what you did, what happened and what you wanted to happen. A report stating that method xyz() hangs, will
|
||
not allow us to provide you with an advice or fix, since we just don’t know what the method is doing.
|
||
Beside versions a good bug report contains a short script which reproduces the problem. Sometimes it is also necessary to
|
||
provide the definition (and data) of used tables.</p>
|
||
</section>
|
||
<section id="versions-of-components">
|
||
<h3>Versions of components<a class="headerlink" href="#versions-of-components" title="Link to this heading">¶</a></h3>
|
||
<p>MariaDB Connector/Python interacts with two other components: The database server and MariaDB Connector/C. Latter one is responsible for client/server communication. An error does not necessarily have to exist in Connector / Python; it can also be an error in the database server or in Connector/C. In this case we will reclassify the bug (MDEV or CONC).</p>
|
||
</section>
|
||
<section id="avoid-screenshots">
|
||
<h3>Avoid screenshots!<a class="headerlink" href="#avoid-screenshots" title="Link to this heading">¶</a></h3>
|
||
<p>Use copy and paste instead. Screenshots create a lot more data volume and are often difficult to
|
||
read on mobile devices. Typing program code from a screenshot is also an unnecessary effort.</p>
|
||
</section>
|
||
<section id="keep-it-simple">
|
||
<h3>Keep it simple!<a class="headerlink" href="#keep-it-simple" title="Link to this heading">¶</a></h3>
|
||
<p>Scripts which are longer than 10 lines often contain code which is not relevant to the problem and increases
|
||
the time to figure out the real problem. So try to keep it simple and focus on the real problem.</p>
|
||
<p>The sane applies for database related components like tables, views and stored procedures. Avoid table definitions with
|
||
hundred of columns if the problem can be reproduced with only 4 columns,</p>
|
||
</section>
|
||
<section id="only-report-one-problem-in-one-bug-report">
|
||
<h3>Only report one problem in one bug report<a class="headerlink" href="#only-report-one-problem-in-one-bug-report" title="Link to this heading">¶</a></h3>
|
||
<p>If you have encountered two or more bugs which are not related, please file an issue for each of them.</p>
|
||
</section>
|
||
<section id="crashes">
|
||
<h3>Crashes<a class="headerlink" href="#crashes" title="Link to this heading">¶</a></h3>
|
||
<p>If your application crashes, please also provide if possible a backtrace and output of the exception.</p>
|
||
</section>
|
||
<section id="report-bugs-in-english-only">
|
||
<h3>Report bugs in English only!<a class="headerlink" href="#report-bugs-in-english-only" title="Link to this heading">¶</a></h3>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
<div class="clearer"></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
||
<div class="sphinxsidebarwrapper">
|
||
<div>
|
||
<h3><a href="index.html">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">Bug reports</a><ul>
|
||
<li><a class="reference internal" href="#how-to-report-a-bug">How to report a bug?</a><ul>
|
||
<li><a class="reference internal" href="#search-first">Search first</a></li>
|
||
<li><a class="reference internal" href="#what">What?</a></li>
|
||
<li><a class="reference internal" href="#versions-of-components">Versions of components</a></li>
|
||
<li><a class="reference internal" href="#avoid-screenshots">Avoid screenshots!</a></li>
|
||
<li><a class="reference internal" href="#keep-it-simple">Keep it simple!</a></li>
|
||
<li><a class="reference internal" href="#only-report-one-problem-in-one-bug-report">Only report one problem in one bug report</a></li>
|
||
<li><a class="reference internal" href="#crashes">Crashes</a></li>
|
||
<li><a class="reference internal" href="#report-bugs-in-english-only">Report bugs in English only!</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
<div>
|
||
<h4>Previous topic</h4>
|
||
<p class="topless"><a href="release.html"
|
||
title="previous chapter">Release history</a></p>
|
||
</div>
|
||
<div>
|
||
<h4>Next topic</h4>
|
||
<p class="topless"><a href="faq.html"
|
||
title="next chapter">MariaDB Connector/Python FAQ</a></p>
|
||
</div>
|
||
<search id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</search>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="related" role="navigation" aria-label="Related">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="genindex.html" title="General Index"
|
||
>index</a></li>
|
||
<li class="right" >
|
||
<a href="py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="right" >
|
||
<a href="faq.html" title="MariaDB Connector/Python FAQ"
|
||
>next</a> |</li>
|
||
<li class="right" >
|
||
<a href="release.html" title="Release history"
|
||
>previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.1.13 documentation</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">Bug reports</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2019-2025 MariaDB Corporation and Georg Richter.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.1.
|
||
</div>
|
||
</body>
|
||
</html> |