sh-edraft.de/sh_cpl
1
1
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects 1 Releases 12 Wiki Activity
c1e65bf0dc
sh_cpl/docs/build/html/cpl_core.database.html

416 lines
41 KiB
HTML
Raw Normal View History

Improved docs
2021-11-01 20:43:25 +01:00
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
Updated docs
2023-04-05 21:43:21 +02:00
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
Improved docs
2021-11-01 20:43:25 +01:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
Updated docs
2023-02-20 15:55:20 +01:00
<title>cpl_core.database package &mdash; Common Python Library documentation</title>
Build docs and added tutorial files
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" />
Improved docs
2021-11-01 20:43:25 +01:00
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
Updated docs
2023-04-05 21:43:21 +02:00
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
Improved docs
2021-11-01 20:43:25 +01:00
<script src="_static/doctools.js"></script>
Updated docs
2023-04-05 21:43:21 +02:00
<script src="_static/sphinx_highlight.js"></script>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<script src="_static/js/theme.js"></script>
Improved docs
2021-11-01 20:43:25 +01:00
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Updated docs
2023-02-20 15:55:20 +01:00
<link rel="next" title="cpl_core.database.connection package" href="cpl_core.database.connection.html" />
<link rel="prev" title="cpl_core.console package" href="cpl_core.console.html" />
Improved docs
2021-11-01 20:43:25 +01:00
</head>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<body class="wy-body-for-nav">
Improved docs
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" >
Updated docs
2023-04-05 21:43:21 +02:00
<a href="index.html" class="icon icon-home">
Common Python Library
Improved docs
2021-11-01 20:43:25 +01:00
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Updated docs
2023-04-05 21:43:21 +02:00
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
Improved docs
2021-11-01 20:43:25 +01:00
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
Build docs and added tutorial files
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">
Improved docs
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>
Improved docs
2022-07-31 11:30:05 +02:00
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
Updated docs
2023-04-05 21:43:21 +02:00
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
Updated docs
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">
Updated docs
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="current reference internal" href="#">cpl_core.database package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#subpackages">Subpackages</a><ul>
<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"><a class="reference internal" href="cpl_core.database.context.html">cpl_core.database.context package</a></li>
Improved docs
2021-11-01 20:43:25 +01:00
</ul>
</li>
Updated docs
2023-02-20 15:55:20 +01:00
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
Updated docs
2023-04-05 21:43:21 +02:00
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings">cpl_core.database.database_settings module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.database.database_settings.DatabaseSettings"><code class="docutils literal notranslate"><span class="pre">DatabaseSettings</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">DatabaseSettingsNameEnum</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.table_abc">cpl_core.database.table_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.database.table_abc.TableABC"><code class="docutils literal notranslate"><span class="pre">TableABC</span></code></a></li>
</ul>
</li>
Updated docs
2023-02-20 15:55:20 +01:00
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
Updated docs
2023-04-05 21:43:21 +02:00
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.database.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
Improved docs
2021-11-01 20:43:25 +01:00
</ul>
</li>
Updated docs
2023-02-20 15:55:20 +01:00
</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>
Updated docs
2023-04-04 13:16:19 +02:00
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
Updated docs
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>
Improved docs
2021-11-01 20:43:25 +01:00
</ul>
</div>
</div>
</nav>
Build docs and added tutorial files
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" >
Improved docs
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">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<div role="navigation" aria-label="Page navigation">
Improved docs
2021-11-01 20:43:25 +01:00
<ul class="wy-breadcrumbs">
Updated docs
2023-04-05 21:43:21 +02:00
<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 active">cpl_core.database package</li>
Improved docs
2021-11-01 20:43:25 +01:00
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.database.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">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
Updated docs
2023-02-20 15:55:20 +01:00
<section id="cpl-core-database-package">
<h1>cpl_core.database package<a class="headerlink" href="#cpl-core-database-package" title="Permalink to this heading"></a></h1>
<section id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this heading"></a></h2>
Improved docs
2021-11-01 20:43:25 +01:00
<div class="toctree-wrapper compound">
<ul>
Updated docs
2023-02-20 15:55:20 +01:00
<li class="toctree-l1"><a class="reference internal" href="cpl_core.database.connection.html">cpl_core.database.connection package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.connection.html#submodules">Submodules</a></li>
Updated docs
2023-04-05 21:43:21 +02:00
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.connection.html#module-cpl_core.database.connection.database_connection">cpl_core.database.connection.database_connection module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection.DatabaseConnection"><code class="docutils literal notranslate"><span class="pre">DatabaseConnection</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection.DatabaseConnection.connect"><code class="docutils literal notranslate"><span class="pre">DatabaseConnection.connect()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection.DatabaseConnection.cursor"><code class="docutils literal notranslate"><span class="pre">DatabaseConnection.cursor</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection.DatabaseConnection.server"><code class="docutils literal notranslate"><span class="pre">DatabaseConnection.server</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.connection.html#module-cpl_core.database.connection.database_connection_abc">cpl_core.database.connection.database_connection_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC"><code class="docutils literal notranslate"><span class="pre">DatabaseConnectionABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.connect"><code class="docutils literal notranslate"><span class="pre">DatabaseConnectionABC.connect()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.cursor"><code class="docutils literal notranslate"><span class="pre">DatabaseConnectionABC.cursor</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.server"><code class="docutils literal notranslate"><span class="pre">DatabaseConnectionABC.server</span></code></a></li>
</ul>
</li>
</ul>
</li>
Updated docs
2023-02-20 15:55:20 +01:00
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.connection.html#module-cpl_core.database.connection">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.connection.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
Updated docs
2023-04-05 21:43:21 +02:00
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
</ul>
</li>
Updated docs
2023-02-20 15:55:20 +01:00
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.database.context.html">cpl_core.database.context package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.context.html#submodules">Submodules</a></li>
Updated docs
2023-04-05 21:43:21 +02:00
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.context.html#module-cpl_core.database.context.database_context">cpl_core.database.context.database_context module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context.DatabaseContext"><code class="docutils literal notranslate"><span class="pre">DatabaseContext</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context.DatabaseContext.connect"><code class="docutils literal notranslate"><span class="pre">DatabaseContext.connect()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context.DatabaseContext.cursor"><code class="docutils literal notranslate"><span class="pre">DatabaseContext.cursor</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context.DatabaseContext.save_changes"><code class="docutils literal notranslate"><span class="pre">DatabaseContext.save_changes()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context.DatabaseContext.select"><code class="docutils literal notranslate"><span class="pre">DatabaseContext.select()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.context.html#module-cpl_core.database.context.database_context_abc">cpl_core.database.context.database_context_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC.connect"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC.connect()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC.cursor"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC.cursor</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC.save_changes"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC.save_changes()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC.select"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC.select()</span></code></a></li>
</ul>
</li>
</ul>
</li>
Updated docs
2023-02-20 15:55:20 +01:00
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.context.html#module-cpl_core.database.context">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
Updated docs
2023-04-05 21:43:21 +02:00
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
</ul>
</li>
Improved docs
2021-11-01 20:43:25 +01:00
</ul>
</li>
</ul>
</li>
</ul>
</div>
Updated docs
2023-02-20 15:55:20 +01:00
</section>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
</section>
<section id="module-cpl_core.database.database_settings">
Updated docs
2023-02-20 15:55:20 +01:00
<span id="cpl-core-database-database-settings-module"></span><h2>cpl_core.database.database_settings module<a class="headerlink" href="#module-cpl_core.database.database_settings" title="Permalink to this heading"></a></h2>
Improved docs
2021-11-01 20:43:25 +01:00
<dl class="py class">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings">
Updated docs
2023-04-05 21:43:21 +02:00
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.database_settings.</span></span><span class="sig-name descname"><span class="pre">DatabaseSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">databse</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">charset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_unicode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffered</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><spa
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dd><p>Bases: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
Improved docs
2021-11-01 20:43:25 +01:00
<p>Represents settings for the database connection</p>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.auth_plugin">
Updated docs
2023-04-05 21:43:21 +02:00
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">auth_plugin</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.auth_plugin" title="Permalink to this definition"></a></dt>
Improved docs
2021-11-01 20:43:25 +01:00
<dd></dd></dl>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.buffered">
Updated docs
2023-04-05 21:43:21 +02:00
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">buffered</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.buffered" title="Permalink to this definition"></a></dt>
Improved docs
2021-11-01 20:43:25 +01:00
<dd></dd></dl>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.charset">
Updated docs
2023-04-05 21:43:21 +02:00
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">charset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.charset" title="Permalink to this definition"></a></dt>
Improved docs
2021-11-01 20:43:25 +01:00
<dd></dd></dl>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.database">
Updated docs
2023-04-05 21:43:21 +02:00
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">database</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.database" title="Permalink to this definition"></a></dt>
Improved docs
2021-11-01 20:43:25 +01:00
<dd></dd></dl>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.host">
Updated docs
2023-04-05 21:43:21 +02:00
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.host" title="Permalink to this definition"></a></dt>
Improved docs
2021-11-01 20:43:25 +01:00
<dd></dd></dl>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.password">
Updated docs
2023-04-05 21:43:21 +02:00
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">password</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.password" title="Permalink to this definition"></a></dt>
Improved docs
2021-11-01 20:43:25 +01:00
<dd></dd></dl>
Improved docs
2022-07-31 11:30:05 +02:00
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.port">
Updated docs
2023-04-05 21:43:21 +02:00
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.port" title="Permalink to this definition"></a></dt>
Improved docs
2022-07-31 11:30:05 +02:00
<dd></dd></dl>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.use_unicode">
Updated docs
2023-04-05 21:43:21 +02:00
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">use_unicode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.use_unicode" title="Permalink to this definition"></a></dt>
Build new docs
2021-12-02 08:20:38 +01:00
<dd></dd></dl>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.user">
Updated docs
2023-04-05 21:43:21 +02:00
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.user" title="Permalink to this definition"></a></dt>
Build new docs
2021-12-02 08:20:38 +01:00
<dd></dd></dl>
Improved docs
2021-11-01 20:43:25 +01:00
</dd></dl>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
</section>
<section id="module-cpl_core.database.database_settings_name_enum">
Updated docs
2023-02-20 15:55:20 +01:00
<span id="cpl-core-database-database-settings-name-enum-module"></span><h2>cpl_core.database.database_settings_name_enum module<a class="headerlink" href="#module-cpl_core.database.database_settings_name_enum" title="Permalink to this heading"></a></h2>
Improved docs
2021-11-01 20:43:25 +01:00
<dl class="py class">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.database_settings_name_enum.</span></span><span class="sig-name descname"><span class="pre">DatabaseSettingsNameEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
Improved docs
2021-11-01 20:43:25 +01:00
<p>An enumeration.</p>
<dl class="py attribute">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.auth_plugin">
<span class="sig-name descname"><span class="pre">auth_plugin</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'AuthPlugin'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.auth_plugin" title="Permalink to this definition"></a></dt>
Build new docs
2021-12-02 08:20:38 +01:00
<dd></dd></dl>
<dl class="py attribute">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.buffered">
<span class="sig-name descname"><span class="pre">buffered</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Buffered'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.buffered" title="Permalink to this definition"></a></dt>
Improved docs
2021-11-01 20:43:25 +01:00
<dd></dd></dl>
<dl class="py attribute">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.charset">
<span class="sig-name descname"><span class="pre">charset</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Charset'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.charset" title="Permalink to this definition"></a></dt>
Improved docs
2021-11-01 20:43:25 +01:00
<dd></dd></dl>
<dl class="py attribute">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.database">
<span class="sig-name descname"><span class="pre">database</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Database'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.database" title="Permalink to this definition"></a></dt>
Improved docs
2021-11-01 20:43:25 +01:00
<dd></dd></dl>
<dl class="py attribute">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.host">
<span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Host'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.host" title="Permalink to this definition"></a></dt>
Improved docs
2021-11-01 20:43:25 +01:00
<dd></dd></dl>
<dl class="py attribute">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.password">
<span class="sig-name descname"><span class="pre">password</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Password'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.password" title="Permalink to this definition"></a></dt>
Improved docs
2021-11-01 20:43:25 +01:00
<dd></dd></dl>
Improved docs
2022-07-31 11:30:05 +02:00
<dl class="py attribute">
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.port">
<span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Port'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.port" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
Improved docs
2021-11-01 20:43:25 +01:00
<dl class="py attribute">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.use_unicode">
<span class="sig-name descname"><span class="pre">use_unicode</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UseUnicode'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.use_unicode" title="Permalink to this definition"></a></dt>
Build new docs
2021-12-02 08:20:38 +01:00
<dd></dd></dl>
<dl class="py attribute">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.user">
<span class="sig-name descname"><span class="pre">user</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'User'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.user" title="Permalink to this definition"></a></dt>
Improved docs
2021-11-01 20:43:25 +01:00
<dd></dd></dl>
</dd></dl>
Updated docs
2023-02-20 15:55:20 +01:00
</section>
<section id="module-cpl_core.database.table_abc">
<span id="cpl-core-database-table-abc-module"></span><h2>cpl_core.database.table_abc module<a class="headerlink" href="#module-cpl_core.database.table_abc" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.database.table_abc.TableABC">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.table_abc.</span></span><span class="sig-name descname"><span class="pre">TableABC</span></span><a class="headerlink" href="#cpl_core.database.table_abc.TableABC" 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>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.table_abc.TableABC.created_at">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#cpl_core.database.table_abc.TableABC.created_at" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.table_abc.TableABC.delete_string">
<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">delete_string</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.database.table_abc.TableABC.delete_string" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.table_abc.TableABC.insert_string">
<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">insert_string</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.database.table_abc.TableABC.insert_string" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.table_abc.TableABC.modified_at">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">modified_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#cpl_core.database.table_abc.TableABC.modified_at" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.table_abc.TableABC.udpate_string">
<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">udpate_string</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.database.table_abc.TableABC.udpate_string" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-cpl_core.database">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_core.database" 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">
Updated docs
2023-04-05 21:43:21 +02:00
<dt class="field-odd">copyright<span class="colon">:</span></dt>
Updated docs
2023-02-20 15:55:20 +01:00
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2020 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
Updated docs
2023-04-05 21:43:21 +02:00
<dt class="field-even">license<span class="colon">:</span></dt>
Updated docs
2023-02-20 15:55:20 +01:00
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</section>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.database.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.</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.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.VersionInfo.major">
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_core.database.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.VersionInfo.micro">
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_core.database.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.VersionInfo.minor">
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_core.database.VersionInfo.minor" title="Permalink to this definition"></a></dt>
<dd><p>Alias for field number 1</p>
</dd></dl>
</dd></dl>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
</section>
</section>
Improved docs
2021-11-01 20:43:25 +01:00
</div>
</div>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
Updated docs
2023-02-20 15:55:20 +01:00
<a href="cpl_core.console.html" class="btn btn-neutral float-left" title="cpl_core.console package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="cpl_core.database.connection.html" class="btn btn-neutral float-right" title="cpl_core.database.connection package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
Improved docs
2021-11-01 20:43:25 +01:00
</div>
<hr/>
<div role="contentinfo">
Updated docs
2022-12-04 00:50:24 +01:00
<p>&#169; Copyright 2021 - 2023, Sven Heidemann.</p>
Build new docs
2021-12-02 08:20:38 +01:00
</div>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
Improved docs
2021-11-01 20:43:25 +01:00
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
provided by <a href="https://readthedocs.org">Read the Docs</a>.
Improved docs
2021-11-01 20:43:25 +01:00
</footer>
</div>
</div>
</section>
</div>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<script>
Improved docs
2021-11-01 20:43:25 +01:00
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
</script>
Improved docs
2021-11-01 20:43:25 +01:00
</body>
</html>
Reference in New Issue Copy Permalink