Updated docs
This commit is contained in:
125
docs/build/html/cpl_core.database.html
vendored
125
docs/build/html/cpl_core.database.html
vendored
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<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 package — Common Python Library documentation</title>
|
||||
@@ -11,11 +11,11 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.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" />
|
||||
@@ -28,11 +28,15 @@
|
||||
<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 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="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>
|
||||
@@ -42,6 +46,7 @@
|
||||
<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>
|
||||
@@ -54,11 +59,21 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings">cpl_core.database.database_settings module</a></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></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.table_abc">cpl_core.database.table_abc module</a></li>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -90,9 +105,9 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li><a href="cpl_core.html">API reference</a> »</li>
|
||||
<li>cpl_core.database package</li>
|
||||
<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>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_core.database.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@@ -110,20 +125,66 @@
|
||||
<ul>
|
||||
<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>
|
||||
<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></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></li>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
</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>
|
||||
<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></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></li>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -138,60 +199,52 @@
|
||||
<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>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings">
|
||||
<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><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings" title="Permalink to this definition"></a></dt>
|
||||
<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><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">auth_plugin</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><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings" title="Permalink to this definition"></a></dt>
|
||||
<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>
|
||||
<p>Represents settings for the database connection</p>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.auth_plugin">
|
||||
<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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.auth_plugin" title="Permalink to this definition"></a></dt>
|
||||
<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>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.buffered">
|
||||
<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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.buffered" title="Permalink to this definition"></a></dt>
|
||||
<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>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.charset">
|
||||
<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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.charset" title="Permalink to this definition"></a></dt>
|
||||
<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>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.database">
|
||||
<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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.database" title="Permalink to this definition"></a></dt>
|
||||
<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>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.from_dict">
|
||||
<span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.from_dict" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sets attributes from given dict</p>
|
||||
<p>Parameter:
|
||||
settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.host">
|
||||
<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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.host" title="Permalink to this definition"></a></dt>
|
||||
<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>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.password">
|
||||
<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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.password" title="Permalink to this definition"></a></dt>
|
||||
<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>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.port">
|
||||
<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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.port" title="Permalink to this definition"></a></dt>
|
||||
<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>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.use_unicode">
|
||||
<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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.use_unicode" title="Permalink to this definition"></a></dt>
|
||||
<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>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.user">
|
||||
<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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.user" title="Permalink to this definition"></a></dt>
|
||||
<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>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@@ -292,15 +345,16 @@ settings: <code class="xref py py-class docutils literal notranslate"><span clas
|
||||
<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>
|
||||
<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</dt>
|
||||
<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.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>
|
||||
@@ -325,7 +379,6 @@ settings: <code class="xref py py-class docutils literal notranslate"><span clas
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user