Files
mariadb-connector-python/docs/extension.html
2020-11-25 13:44:18 +01:00

371 lines
20 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Extensions to the DB API &#8212; MariaDB Connector/Python 1.0.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="License" href="license.html" />
<link rel="prev" title="The ConnectionPool class" href="pool.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<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="license.html" title="License"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="pool.html" title="The ConnectionPool class"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.0.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Extensions to the DB API</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="extensions-to-the-db-api">
<span id="extensions"></span><h1>Extensions to the DB API<a class="headerlink" href="#extensions-to-the-db-api" title="Permalink to this headline"></a></h1>
<div class="section" id="constants">
<h2>Constants<a class="headerlink" href="#constants" title="Permalink to this headline"></a></h2>
<p>For using constants of various types they have to be imported first:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">mariadb.constants</span> <span class="kn">import</span> <span class="o">*</span>
</pre></div>
</div>
<div class="section" id="cursor">
<h3>Cursor<a class="headerlink" href="#cursor" title="Permalink to this headline"></a></h3>
<p>MariaDB Connector/Python defines the following cursor types for server side cursors:</p>
<dl class="py data">
<dt id="mariadb.constants.CURSOR.NONE">
<code class="sig-prename descclassname">mariadb.constants.CURSOR.</code><code class="sig-name descname">NONE</code><a class="headerlink" href="#mariadb.constants.CURSOR.NONE" title="Permalink to this definition"></a></dt>
<dd><p>Dont use a server side cursor (default)</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.CURSOR.READ_ONLY">
<code class="sig-prename descclassname">mariadb.constants.CURSOR.</code><code class="sig-name descname">READ_ONLY</code><a class="headerlink" href="#mariadb.constants.CURSOR.READ_ONLY" title="Permalink to this definition"></a></dt>
<dd><p>Use a read-only server side cursor.</p>
</dd></dl>
</div>
<div class="section" id="indicators">
<h3>Indicators<a class="headerlink" href="#indicators" title="Permalink to this headline"></a></h3>
<p>Indicators hold supplementary information when you are modify (insert/update/delete) data with cursors <cite>executemany</cite> method. There are several distinct uses for indicator variables:</p>
<dl class="py data">
<dt id="mariadb.constants.INDICATOR.NULL">
<code class="sig-prename descclassname">mariadb.constants.INDICATOR.</code><code class="sig-name descname">NULL</code><a class="headerlink" href="#mariadb.constants.INDICATOR.NULL" title="Permalink to this definition"></a></dt>
<dd><p>A null value will be inserted or updated</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.INDICATOR.DEFAULT">
<code class="sig-prename descclassname">mariadb.constants.INDICATOR.</code><code class="sig-name descname">DEFAULT</code><a class="headerlink" href="#mariadb.constants.INDICATOR.DEFAULT" title="Permalink to this definition"></a></dt>
<dd><p>The default value of a column will be inserted or updated</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.INDICATOR.IGNORE">
<code class="sig-prename descclassname">mariadb.constants.INDICATOR.</code><code class="sig-name descname">IGNORE</code><a class="headerlink" href="#mariadb.constants.INDICATOR.IGNORE" title="Permalink to this definition"></a></dt>
<dd><p>Dont update column at all</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.INDICATOR.IGNORE_ROW">
<code class="sig-prename descclassname">mariadb.constants.INDICATOR.</code><code class="sig-name descname">IGNORE_ROW</code><a class="headerlink" href="#mariadb.constants.INDICATOR.IGNORE_ROW" title="Permalink to this definition"></a></dt>
<dd><p>Dont update or delete row</p>
</dd></dl>
</div>
<div class="section" id="capability-flags">
<h3>Capability flags<a class="headerlink" href="#capability-flags" title="Permalink to this headline"></a></h3>
<p>These flags are used when establishing a connection or to check if the database is
capable of a certain feature.</p>
<dl class="py data">
<dt id="mariadb.constants.CLIENT.MYSQL">
<code class="sig-prename descclassname">mariadb.constants.CLIENT.</code><code class="sig-name descname">MYSQL</code><a class="headerlink" href="#mariadb.constants.CLIENT.MYSQL" title="Permalink to this definition"></a></dt>
<dd><p>not in use/supported by MariaDB Server</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.CLIENT.FOUND_ROWS">
<code class="sig-prename descclassname">mariadb.constants.CLIENT.</code><code class="sig-name descname">FOUND_ROWS</code><a class="headerlink" href="#mariadb.constants.CLIENT.FOUND_ROWS" title="Permalink to this definition"></a></dt>
<dd><p>return the number of matched rows instead of number of changed rows</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.CLIENT.NO_SCHEMA">
<code class="sig-prename descclassname">mariadb.constants.CLIENT.</code><code class="sig-name descname">NO_SCHEMA</code><a class="headerlink" href="#mariadb.constants.CLIENT.NO_SCHEMA" title="Permalink to this definition"></a></dt>
<dd><p>forbids the use of database.tablename.columnname syntax and forces SQL parser
to generate an error.</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.CLIENT.LOCAL_FILES">
<code class="sig-prename descclassname">mariadb.constants.CLIENT.</code><code class="sig-name descname">LOCAL_FILES</code><a class="headerlink" href="#mariadb.constants.CLIENT.LOCAL_FILES" title="Permalink to this definition"></a></dt>
<dd><p>Allows LOAD DATA LOCAL INFILE statements (if not disabled on server).</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.CLIENT.COMPRESS">
<code class="sig-prename descclassname">mariadb.constants.CLIENT.</code><code class="sig-name descname">COMPRESS</code><a class="headerlink" href="#mariadb.constants.CLIENT.COMPRESS" title="Permalink to this definition"></a></dt>
<dd><p>Use compressed protocol</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.CLIENT.IGNORE_SPACE">
<code class="sig-prename descclassname">mariadb.constants.CLIENT.</code><code class="sig-name descname">IGNORE_SPACE</code><a class="headerlink" href="#mariadb.constants.CLIENT.IGNORE_SPACE" title="Permalink to this definition"></a></dt>
<dd><p>Allows spaces after function names. This implies, that all function names will
become reserved words.</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.CLIENT.MULTI_RESULTS">
<code class="sig-prename descclassname">mariadb.constants.CLIENT.</code><code class="sig-name descname">MULTI_RESULTS</code><a class="headerlink" href="#mariadb.constants.CLIENT.MULTI_RESULTS" title="Permalink to this definition"></a></dt>
<dd><p>Indicates that the client is able to handle multiple result sets.</p>
</dd></dl>
</div>
<div class="section" id="field-types">
<h3>Field types<a class="headerlink" href="#field-types" title="Permalink to this headline"></a></h3>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.DECIMAL">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">DECIMAL</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.DECIMAL" title="Permalink to this definition"></a></dt>
<dd><p>Old decimal format: Not in use anymore, instead of use NEWDECIMAL.</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.TINY">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">TINY</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.TINY" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type TINYINT</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.SHORT">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">SHORT</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.SHORT" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type SMALLINT</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.LONG">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">LONG</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.LONG" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type INT</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.FLOAT">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">FLOAT</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.FLOAT" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type FLOAT</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.DOUBLE">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">DOUBLE</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.DOUBLE" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type DOUBLE</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.NULL">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">NULL</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.NULL" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type NULL</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.TIMESTAMP">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">TIMESTAMP</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.TIMESTAMP" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type TIMESTAMP</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.LONGLONG">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">LONGLONG</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.LONGLONG" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type BIGINT</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.INT24">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">INT24</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.INT24" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type MEDIUMINT</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.DATETIME">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">DATETIME</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.DATETIME" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type DATETIME</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.YEAR">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">YEAR</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.YEAR" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type YEAR</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.NEWDATE">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">NEWDATE</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.NEWDATE" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type DATE</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.VARCHAR">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">VARCHAR</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.VARCHAR" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type VARCHAR</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.BIT">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">BIT</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.BIT" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type BIT</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.JSON">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">JSON</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.JSON" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type JSON</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.NEWDECIMAL">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">NEWDECIMAL</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.NEWDECIMAL" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type DECIMAL</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.ENUM">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">ENUM</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.ENUM" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type ENUM</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.SET">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">SET</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.SET" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type SET</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.TINY_BLOB">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">TINY_BLOB</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.TINY_BLOB" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type TINYBLOB or TINYTEXT</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.MEDIUM_BLOB">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">MEDIUM_BLOB</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.MEDIUM_BLOB" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type MEDIUMBLOB or MEDIUMTEXT</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.LONG_BLOB">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">LONG_BLOB</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.LONG_BLOB" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type LONGBLOB or LONGTEXT</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.BLOB">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">BLOB</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.BLOB" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type BLOB or TEXT</p>
</dd></dl>
<dl class="py data">
<dt id="mariadb.constants.FIELD_TYPE.GEOMETRY">
<code class="sig-prename descclassname">mariadb.constants.FIELD_TYPE.</code><code class="sig-name descname">GEOMETRY</code><a class="headerlink" href="#mariadb.constants.FIELD_TYPE.GEOMETRY" title="Permalink to this definition"></a></dt>
<dd><p>Represents SQL type GEOMETRY</p>
</dd></dl>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Extensions to the DB API</a><ul>
<li><a class="reference internal" href="#constants">Constants</a><ul>
<li><a class="reference internal" href="#cursor">Cursor</a></li>
<li><a class="reference internal" href="#indicators">Indicators</a></li>
<li><a class="reference internal" href="#capability-flags">Capability flags</a></li>
<li><a class="reference internal" href="#field-types">Field types</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="pool.html"
title="previous chapter">The ConnectionPool class</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="license.html"
title="next chapter">License</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/extension.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div 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" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<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="license.html" title="License"
>next</a> |</li>
<li class="right" >
<a href="pool.html" title="The ConnectionPool class"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">MariaDB Connector/Python 1.0.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Extensions to the DB API</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2019,2020 MariaDB Corporation and Georg Richter.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.3.1.
</div>
</body>
</html>