253 lines
18 KiB
HTML
253 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>cpl_core.database.connection package — Common Python Library documentation</title>
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|
<!--[if lt IE 9]>
|
|
<script src="_static/js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
|
|
<script src="_static/jquery.js"></script>
|
|
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
|
<script src="_static/doctools.js"></script>
|
|
<script src="_static/sphinx_highlight.js"></script>
|
|
<script src="_static/js/theme.js"></script>
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|
<link rel="search" title="Search" href="search.html" />
|
|
<link rel="next" title="cpl_core.database.context package" href="cpl_core.database.context.html" />
|
|
<link rel="prev" title="cpl_core.database package" href="cpl_core.database.html" />
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search" >
|
|
|
|
|
|
|
|
<a href="index.html" class="icon icon-home">
|
|
Common Python Library
|
|
</a>
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration package</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console package</a></li>
|
|
<li class="toctree-l2 current"><a class="reference internal" href="cpl_core.database.html">cpl_core.database package</a><ul class="current">
|
|
<li class="toctree-l3 current"><a class="reference internal" href="cpl_core.database.html#subpackages">Subpackages</a><ul class="current">
|
|
<li class="toctree-l4 current"><a class="current reference internal" href="#">cpl_core.database.connection package</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html">cpl_core.database.context package</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#submodules">Submodules</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings">cpl_core.database.database_settings module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.table_abc">cpl_core.database.table_abc module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database">Module contents</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection package</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment package</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html">cpl_core.logging package</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html">cpl_core.mailing package</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes package</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time package</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils package</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="index.html">Common Python Library</a>
|
|
</nav>
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="Page navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
|
|
<li class="breadcrumb-item"><a href="cpl_core.database.html">cpl_core.database package</a></li>
|
|
<li class="breadcrumb-item active">cpl_core.database.connection package</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="_sources/cpl_core.database.connection.rst.txt" rel="nofollow"> View page source</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<section id="cpl-core-database-connection-package">
|
|
<h1>cpl_core.database.connection package<a class="headerlink" href="#cpl-core-database-connection-package" title="Permalink to this heading"></a></h1>
|
|
<section id="submodules">
|
|
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
|
</section>
|
|
<section id="module-cpl_core.database.connection.database_connection">
|
|
<span id="cpl-core-database-connection-database-connection-module"></span><h2>cpl_core.database.connection.database_connection module<a class="headerlink" href="#module-cpl_core.database.connection.database_connection" title="Permalink to this heading"></a></h2>
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection.DatabaseConnection">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.connection.database_connection.</span></span><span class="sig-name descname"><span class="pre">DatabaseConnection</span></span><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC" title="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatabaseConnectionABC</span></code></a></p>
|
|
<p>Representation of the database connection</p>
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection.DatabaseConnection.connect">
|
|
<span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection.connect" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Connects to a database by connection string</p>
|
|
<dl class="simple">
|
|
<dt>Parameter:</dt><dd><dl class="simple">
|
|
<dt>connection_string: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Database connection string, see: <a class="reference external" href="https://docs.sqlalchemy.org/en/14/core/engines.html">https://docs.sqlalchemy.org/en/14/core/engines.html</a></p>
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py property">
|
|
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection.DatabaseConnection.cursor">
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cursor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">MySQLCursorBuffered</span></em><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection.cursor" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py property">
|
|
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection.DatabaseConnection.server">
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">server</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">MySQLConnectionAbstract</span></em><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection.server" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</section>
|
|
<section id="module-cpl_core.database.connection.database_connection_abc">
|
|
<span id="cpl-core-database-connection-database-connection-abc-module"></span><h2>cpl_core.database.connection.database_connection_abc module<a class="headerlink" href="#module-cpl_core.database.connection.database_connection_abc" title="Permalink to this heading"></a></h2>
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.connection.database_connection_abc.</span></span><span class="sig-name descname"><span class="pre">DatabaseConnectionABC</span></span><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
|
<p>ABC for the <a class="reference internal" href="#cpl_core.database.connection.database_connection.DatabaseConnection" title="cpl_core.database.connection.database_connection.DatabaseConnection"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.connection.database_connection.DatabaseConnection</span></code></a></p>
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.connect">
|
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.connect" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Connects to a database by connection string</p>
|
|
<dl class="simple">
|
|
<dt>Parameter:</dt><dd><dl class="simple">
|
|
<dt>connection_string: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Database connection string, see: <a class="reference external" href="https://docs.sqlalchemy.org/en/14/core/engines.html">https://docs.sqlalchemy.org/en/14/core/engines.html</a></p>
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py property">
|
|
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.cursor">
|
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cursor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">MySQLCursorBuffered</span></em><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.cursor" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py property">
|
|
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.server">
|
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">server</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">MySQLConnectionAbstract</span></em><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.server" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</section>
|
|
<section id="module-cpl_core.database.connection">
|
|
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_core.database.connection" title="Permalink to this heading"></a></h2>
|
|
<section id="cpl-core-cpl-core">
|
|
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
|
|
<p>CPL core package</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">copyright<span class="colon">:</span></dt>
|
|
<dd class="field-odd"><ol class="loweralpha simple" start="3">
|
|
<li><p>2020 - 2023 sh-edraft.de</p></li>
|
|
</ol>
|
|
</dd>
|
|
<dt class="field-even">license<span class="colon">:</span></dt>
|
|
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="cpl_core.database.connection.VersionInfo">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.connection.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.connection.VersionInfo" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="cpl_core.database.connection.VersionInfo.major">
|
|
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_core.database.connection.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Alias for field number 0</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="cpl_core.database.connection.VersionInfo.micro">
|
|
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_core.database.connection.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Alias for field number 2</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="cpl_core.database.connection.VersionInfo.minor">
|
|
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_core.database.connection.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Alias for field number 1</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</section>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="cpl_core.database.html" class="btn btn-neutral float-left" title="cpl_core.database package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
<a href="cpl_core.database.context.html" class="btn btn-neutral float-right" title="cpl_core.database.context package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |