234 lines
17 KiB
HTML
234 lines
17 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>cpl_core.database — Common Python Library documentation</title>
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|
<!--[if lt IE 9]>
|
|
<script src="_static/js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
|
|
<script 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/doctools.js"></script>
|
|
<script src="_static/js/theme.js"></script>
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|
<link rel="search" title="Search" href="search.html" />
|
|
<link rel="next" title="cpl_core.database.connection" href="cpl_core.database.connection.html" />
|
|
<link rel="prev" title="cpl_core.console" href="cpl_core.console.html" />
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search" >
|
|
<a href="index.html" class="icon icon-home"> Common Python Library
|
|
</a>
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="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</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.database</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.connection.html">cpl_core.database.connection</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html">cpl_core.database.context</a></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_model">cpl_core.database.database_model</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings">cpl_core.database.database_settings</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</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html">cpl_core.logging</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html">cpl_core.mailing</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="index.html">Common Python Library</a>
|
|
</nav>
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="Page navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
|
<li><a href="cpl_core.html">API Reference</a> »</li>
|
|
<li>cpl_core.database</li>
|
|
<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">
|
|
|
|
<div class="section" id="cpl-core-database">
|
|
<h1>cpl_core.database<a class="headerlink" href="#cpl-core-database" title="Permalink to this headline"></a></h1>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.database.connection.html">cpl_core.database.connection</a><ul>
|
|
<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</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</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.database.context.html">cpl_core.database.context</a><ul>
|
|
<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</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</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="submodules">
|
|
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
|
|
</div>
|
|
<div class="section" id="module-cpl_core.database.database_model">
|
|
<span id="cpl-core-database-database-model"></span><h2>cpl_core.database.database_model<a class="headerlink" href="#module-cpl_core.database.database_model" title="Permalink to this headline"></a></h2>
|
|
</div>
|
|
<div class="section" id="module-cpl_core.database.database_settings">
|
|
<span id="cpl-core-database-database-settings"></span><h2>cpl_core.database.database_settings<a class="headerlink" href="#module-cpl_core.database.database_settings" title="Permalink to this headline"></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> </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>
|
|
<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">cpl_core.configuration.configuration_model_abc.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> </em><span class="sig-name descname"><span class="pre">auth_plugin</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</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.case_sensitive">
|
|
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">case_sensitive</span></span><em class="property"><span class="pre">:</span> <span class="pre">bool</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.case_sensitive" 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.connection_string">
|
|
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">connection_string</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.connection_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.database_settings.DatabaseSettings.credentials">
|
|
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">credentials</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.credentials" 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.echo">
|
|
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">echo</span></span><em class="property"><span class="pre">:</span> <span class="pre">bool</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.echo" 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.encoding">
|
|
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">encoding</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.encoding" 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="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>settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-cpl_core.database.database_settings_name_enum">
|
|
<span id="cpl-core-database-database-settings-name-enum"></span><h2>cpl_core.database.database_settings_name_enum<a class="headerlink" href="#module-cpl_core.database.database_settings_name_enum" title="Permalink to this headline"></a></h2>
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum">
|
|
<em class="property"><span class="pre">class</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.Enum</span></code></p>
|
|
<p>An enumeration.</p>
|
|
<dl class="py attribute">
|
|
<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="pre">=</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>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.case_sensitive">
|
|
<span class="sig-name descname"><span class="pre">case_sensitive</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'CaseSensitive'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.case_sensitive" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.connection_string">
|
|
<span class="sig-name descname"><span class="pre">connection_string</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'ConnectionString'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.connection_string" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.credentials">
|
|
<span class="sig-name descname"><span class="pre">credentials</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'Credentials'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.credentials" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.echo">
|
|
<span class="sig-name descname"><span class="pre">echo</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'Echo'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.echo" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.encoding">
|
|
<span class="sig-name descname"><span class="pre">encoding</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'Encoding'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.encoding" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="cpl_core.console.html" class="btn btn-neutral float-left" title="cpl_core.console" 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" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2021, Sven Heidemann.</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |