<!doctype html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>sqlobject.index module — SQLObject 3.7.0 documentation</title>
<link rel="stylesheet" href="../_static/bizstyle.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/bizstyle.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<meta name="viewport" content="width=device-width,initial-scale=1.0">
<!--[if lt IE 9]>
<script type="text/javascript" src="_static/css3-mediaqueries.js"></script>
<![endif]-->
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">SQLObject 3.7.0 documentation</a> »</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/sqlobject.index.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-sqlobject.index">
<span id="sqlobject-index-module"></span><h1>sqlobject.index module<a class="headerlink" href="#module-sqlobject.index" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="sqlobject.index.DatabaseIndex">
<em class="property">class </em><code class="descclassname">sqlobject.index.</code><code class="descname">DatabaseIndex</code><span class="sig-paren">(</span><em>*columns</em>, <em>**kw</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/sqlobject/index.html#DatabaseIndex"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sqlobject.index.DatabaseIndex" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This takes a variable number of parameters, each of which is a
column for indexing. Each column may be a column object or the
string name of the column (<em>not</em> the database name). You may also
use dictionaries, to further customize the indexing of the column.
The dictionary may have certain keys:</p>
<dl class="docutils">
<dt>‘column’:</dt>
<dd>The column object or string identifier.</dd>
<dt>‘length’:</dt>
<dd>MySQL will only index the first N characters if this is
given. For other databases this is ignored.</dd>
<dt>‘expression’:</dt>
<dd>You can create an index based on an expression, e.g.,
‘lower(column)’. This can either be a string or a sqlbuilder
expression.</dd>
</dl>
<p>Further keys may be added to the column specs in the future.</p>
<p>The class also take the keyword argument <cite>unique</cite>; if true then
a UNIQUE index is created.</p>
<dl class="attribute">
<dt id="sqlobject.index.DatabaseIndex.baseClass">
<code class="descname">baseClass</code><a class="headerlink" href="#sqlobject.index.DatabaseIndex.baseClass" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">SODatabaseIndex</span></code></p>
</dd></dl>
<dl class="attribute">
<dt id="sqlobject.index.DatabaseIndex.name">
<code class="descname">name</code><a class="headerlink" href="#sqlobject.index.DatabaseIndex.name" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="sqlobject.index.DatabaseIndex.setName">
<code class="descname">setName</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/sqlobject/index.html#DatabaseIndex.setName"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sqlobject.index.DatabaseIndex.setName" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="sqlobject.index.DatabaseIndex.withClass">
<code class="descname">withClass</code><span class="sig-paren">(</span><em>soClass</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/sqlobject/index.html#DatabaseIndex.withClass"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sqlobject.index.DatabaseIndex.withClass" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">SQLObject 3.7.0 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2004-2018, Ian Bicking and contributors.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.4.
</div>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
f1af5ac4c8d0f3f6ef0bca84cf516f3e
>
files
>
1031
