sh_cpl/docs/build/html/cpl_core.database.context.html

272 lines
21 KiB
HTML
Raw Normal View History

2021-11-01 20:43:25 +01:00
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
2022-06-27 21:42:34 +02:00
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
2021-11-01 20:43:25 +01:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
2023-02-20 15:55:20 +01:00
<title>cpl_core.database.context package &mdash; Common Python Library documentation</title>
2022-06-27 21:42:34 +02:00
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
2021-11-01 20:43:25 +01:00
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
2022-06-27 21:42:34 +02:00
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
2021-11-01 20:43:25 +01:00
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
2022-06-27 21:42:34 +02:00
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
2021-11-01 20:43:25 +01:00
<script src="_static/doctools.js"></script>
2022-06-27 21:42:34 +02:00
<script src="_static/js/theme.js"></script>
2021-11-01 20:43:25 +01:00
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
2023-02-20 15:55:20 +01:00
<link rel="next" title="cpl_core.dependency_injection package" href="cpl_core.dependency_injection.html" />
<link rel="prev" title="cpl_core.database.connection package" href="cpl_core.database.connection.html" />
2021-11-01 20:43:25 +01:00
</head>
2022-06-27 21:42:34 +02:00
<body class="wy-body-for-nav">
2021-11-01 20:43:25 +01:00
<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" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
2022-06-27 21:42:34 +02:00
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
2021-11-01 20:43:25 +01:00
<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>
2022-07-31 11:30:05 +02:00
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
2022-12-04 00:50:24 +01:00
<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">
2023-02-20 15:55:20 +01:00
<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"><a class="reference internal" href="cpl_core.database.connection.html">cpl_core.database.connection package</a></li>
<li class="toctree-l4 current"><a class="current reference internal" href="#">cpl_core.database.context package</a></li>
2021-11-01 20:43:25 +01:00
</ul>
</li>
2023-02-20 15:55:20 +01:00
<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>
2021-11-01 20:43:25 +01:00
</ul>
</li>
2023-02-20 15:55:20 +01:00
<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>
2021-11-01 20:43:25 +01:00
</ul>
</li>
2023-04-04 13:16:19 +02:00
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
2022-12-04 00:50:24 +01:00
<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>
2021-11-01 20:43:25 +01:00
</ul>
</div>
</div>
</nav>
2022-06-27 21:42:34 +02:00
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
2021-11-01 20:43:25 +01:00
<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">
2022-06-27 21:42:34 +02:00
<div role="navigation" aria-label="Page navigation">
2021-11-01 20:43:25 +01:00
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
2022-12-04 00:50:24 +01:00
<li><a href="cpl_core.html">API reference</a> &raquo;</li>
2023-02-20 15:55:20 +01:00
<li><a href="cpl_core.database.html">cpl_core.database package</a> &raquo;</li>
<li>cpl_core.database.context package</li>
2021-11-01 20:43:25 +01:00
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.database.context.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">
2022-06-27 21:42:34 +02:00
2023-02-20 15:55:20 +01:00
<section id="cpl-core-database-context-package">
<h1>cpl_core.database.context package<a class="headerlink" href="#cpl-core-database-context-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>
2022-06-27 21:42:34 +02:00
<section id="module-cpl_core.database.context.database_context">
2023-02-20 15:55:20 +01:00
<span id="cpl-core-database-context-database-context-module"></span><h2>cpl_core.database.context.database_context module<a class="headerlink" href="#module-cpl_core.database.context.database_context" title="Permalink to this heading"></a></h2>
2021-11-01 20:43:25 +01:00
<dl class="py class">
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.database.context.database_context.DatabaseContext">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.context.database_context.</span></span><span class="sig-name descname"><span class="pre">DatabaseContext</span></span><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatabaseContextABC</span></code></a></p>
2021-11-01 20:43:25 +01:00
<p>Representation of the database context</p>
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><p>database_settings: <a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></code></a></p>
</dd>
</dl>
2021-11-01 20:43:25 +01:00
<dl class="py method">
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.database.context.database_context.DatabaseContext.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.context.database_context.DatabaseContext.connect" title="Permalink to this definition"></a></dt>
2021-12-02 08:20:38 +01:00
<dd><p>Connects to a database by connection settings</p>
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><p>database_settings <a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></code></a></p>
</dd>
</dl>
2021-11-01 20:43:25 +01:00
</dd></dl>
2022-06-27 21:42:34 +02:00
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.context.database_context.DatabaseContext.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.context.database_context.DatabaseContext.cursor" title="Permalink to this definition"></a></dt>
2021-11-01 20:43:25 +01:00
<dd></dd></dl>
<dl class="py method">
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.database.context.database_context.DatabaseContext.save_changes">
<span class="sig-name descname"><span class="pre">save_changes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.save_changes" title="Permalink to this definition"></a></dt>
2021-11-01 20:43:25 +01:00
<dd><p>Saves changes of the database</p>
</dd></dl>
2021-12-02 08:20:38 +01:00
<dl class="py method">
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.database.context.database_context.DatabaseContext.select">
<span class="sig-name descname"><span class="pre">select</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="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.select" title="Permalink to this definition"></a></dt>
2021-12-02 08:20:38 +01:00
<dd><p>Runs SQL Statements</p>
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><p>statement: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt>Returns:</dt><dd><p>list: Fetched list of selected elements</p>
</dd>
</dl>
2021-12-02 08:20:38 +01:00
</dd></dl>
2021-11-01 20:43:25 +01:00
</dd></dl>
2022-06-27 21:42:34 +02:00
</section>
<section id="module-cpl_core.database.context.database_context_abc">
2023-02-20 15:55:20 +01:00
<span id="cpl-core-database-context-database-context-abc-module"></span><h2>cpl_core.database.context.database_context_abc module<a class="headerlink" href="#module-cpl_core.database.context.database_context_abc" title="Permalink to this heading"></a></h2>
2021-11-01 20:43:25 +01:00
<dl class="py class">
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.database.context.database_context_abc.DatabaseContextABC">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.context.database_context_abc.</span></span><span class="sig-name descname"><span class="pre">DatabaseContextABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC" 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>
2021-11-01 20:43:25 +01:00
<p>ABC for the <a class="reference internal" href="#cpl_core.database.context.database_context.DatabaseContext" title="cpl_core.database.context.database_context.DatabaseContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.context.database_context.DatabaseContext</span></code></a></p>
<dl class="py method">
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.database.context.database_context_abc.DatabaseContextABC.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.context.database_context_abc.DatabaseContextABC.connect" title="Permalink to this definition"></a></dt>
2021-12-02 08:20:38 +01:00
<dd><p>Connects to a database by connection settings</p>
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><p>database_settings <a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></code></a></p>
</dd>
</dl>
2021-11-01 20:43:25 +01:00
</dd></dl>
2022-06-27 21:42:34 +02:00
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.context.database_context_abc.DatabaseContextABC.cursor">
2022-07-31 11:30:05 +02:00
<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.context.database_context_abc.DatabaseContextABC.cursor" title="Permalink to this definition"></a></dt>
2021-11-01 20:43:25 +01:00
<dd></dd></dl>
<dl class="py method">
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.database.context.database_context_abc.DatabaseContextABC.save_changes">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">save_changes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.save_changes" title="Permalink to this definition"></a></dt>
2021-11-01 20:43:25 +01:00
<dd><p>Saves changes of the database</p>
</dd></dl>
2021-12-02 08:20:38 +01:00
<dl class="py method">
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.database.context.database_context_abc.DatabaseContextABC.select">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">select</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="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.select" title="Permalink to this definition"></a></dt>
2021-12-02 08:20:38 +01:00
<dd><p>Runs SQL Statements</p>
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><p>statement: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt>Returns:</dt><dd><p>list: Fetched list of selected elements</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="module-cpl_core.database.context">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_core.database.context" 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</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</dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.database.context.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.context.</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.context.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.context.VersionInfo.major">
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_core.database.context.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.context.VersionInfo.micro">
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_core.database.context.VersionInfo.micro" title="Permalink to this definition"></a></dt>
<dd><p>Alias for field number 2</p>
2021-12-02 08:20:38 +01:00
</dd></dl>
2021-11-01 20:43:25 +01:00
2023-02-20 15:55:20 +01:00
<dl class="py attribute">
<dt class="sig sig-object py" id="cpl_core.database.context.VersionInfo.minor">
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_core.database.context.VersionInfo.minor" title="Permalink to this definition"></a></dt>
<dd><p>Alias for field number 1</p>
2021-11-01 20:43:25 +01:00
</dd></dl>
2023-02-20 15:55:20 +01:00
</dd></dl>
</section>
2022-06-27 21:42:34 +02:00
</section>
</section>
2021-11-01 20:43:25 +01:00
</div>
</div>
2022-06-27 21:42:34 +02:00
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
2023-02-20 15:55:20 +01:00
<a href="cpl_core.database.connection.html" class="btn btn-neutral float-left" title="cpl_core.database.connection package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="cpl_core.dependency_injection.html" class="btn btn-neutral float-right" title="cpl_core.dependency_injection package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
2021-11-01 20:43:25 +01:00
</div>
<hr/>
<div role="contentinfo">
2022-12-04 00:50:24 +01:00
<p>&#169; Copyright 2021 - 2023, Sven Heidemann.</p>
2021-12-02 08:20:38 +01:00
</div>
2022-06-27 21:42:34 +02:00
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
2021-11-01 20:43:25 +01:00
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
2022-06-27 21:42:34 +02:00
provided by <a href="https://readthedocs.org">Read the Docs</a>.
2021-11-01 20:43:25 +01:00
</footer>
</div>
</div>
</section>
</div>
2022-06-27 21:42:34 +02:00
<script>
2021-11-01 20:43:25 +01:00
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
2022-06-27 21:42:34 +02:00
</script>
2021-11-01 20:43:25 +01:00
</body>
</html>