1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<h1 class="pudge-member-page-heading">
<tt>DatabaseIndex</tt>
</h1>
<h4 class="pudge-member-page-subheading">
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:
</h4>
<p class="pudge-member-parent-link">
<small>
The DatabaseIndex class is accessible via the
<a href="module-sqlobject.index.html">
<tt>sqlobject.index</tt>
</a> module.
</small>
</p>
<div id="pudge-section-nav">
<ul>
<li>
<a href="#attributes" class="pudge-section-link">
Attributes (1)
</a>
</li><li>
<a href="#methods" class="pudge-section-link">
Methods (6)
</a>
</li>
<li>
<a href="sqlobject/index.py.html?f=134&l=188#134" class="pudge-section-link">
Source
</a>
</li>
</ul>
</div>
<div style="clear: left"></div>
<div class="rst pudge-module-doc">
<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>
</div>
<hr>
<a name="attributes"></a>
<h2>Attributes</h2>
<div class="pudge-member name">
<a name="name"></a>
<h4 class="pudge-member-name"><span class="prefix">a</span>
<tt><a href="class-sqlobject.index.DatabaseIndex.html#name" class="pudge-obj-link">name</a></tt></h4>
<div class="pudge-section rst">
<pre><property object at 0xb6606234></pre>
</div>
</div>
<a name="methods"></a>
<h2>Methods</h2>
<div class="pudge-member routine alias">
<a name="__format__"></a>
<h4 class="pudge-member-name"><span class="prefix">f</span>
<tt><a href="class-sqlobject.index.DatabaseIndex.html#__format__" class="pudge-obj-link">__format__</a>(...)</tt>
<a href="__builtin__.py.html" title="View Source">...</a>
</h4>
<div class="pudge-section rst">
<p class="pudge-member-blurb">
default object formatter
</p>
</div>
</div><div class="pudge-member routine alias">
<a name="__subclasshook__"></a>
<h4 class="pudge-member-name"><span class="prefix">f</span>
<tt><a href="class-sqlobject.index.DatabaseIndex.html#__subclasshook__" class="pudge-obj-link">__subclasshook__</a>(...)</tt>
<a href="None.html" title="View Source">...</a>
</h4>
<div class="pudge-section rst">
<p class="pudge-member-blurb">
Abstract classes can override this to customize issubclass().
</p>
<p>This is invoked early on by abc.ABCMeta.__subclasscheck__().
It should return True, False or NotImplemented. If it returns
NotImplemented, the normal algorithm is used. Otherwise, it
overrides the normal algorithm (and the outcome is cached).</p>
</div>
</div><div class="pudge-member routine alias">
<a name="__sizeof__"></a>
<h4 class="pudge-member-name"><span class="prefix">f</span>
<tt><a href="class-sqlobject.index.DatabaseIndex.html#__sizeof__" class="pudge-obj-link">__sizeof__</a>(...)</tt>
<a href="__builtin__.py.html" title="View Source">...</a>
</h4>
<div class="pudge-section rst">
<p class="pudge-member-blurb">
__sizeof__() -> int
size of object in memory, in bytes
</p>
</div>
</div><div class="pudge-member routine ">
<a name="__init__"></a>
<h4 class="pudge-member-name"><span class="prefix">f</span>
<tt><a href="class-sqlobject.index.DatabaseIndex.html#__init__" class="pudge-obj-link">__init__</a>(self, *columns, **kw)</tt>
<a href="sqlobject/index.py.html?f=160&l=164#160" title="View Source">...</a>
</h4>
<div class="pudge-section rst">
</div>
</div><div class="pudge-member routine ">
<a name="setName"></a>
<h4 class="pudge-member-name"><span class="prefix">f</span>
<tt><a href="class-sqlobject.index.DatabaseIndex.html#setName" class="pudge-obj-link">setName</a>(self, value)</tt>
<a href="sqlobject/index.py.html?f=165&l=170#165" title="View Source">...</a>
</h4>
<div class="pudge-section rst">
</div>
</div><div class="pudge-member routine ">
<a name="withClass"></a>
<h4 class="pudge-member-name"><span class="prefix">f</span>
<tt><a href="class-sqlobject.index.DatabaseIndex.html#withClass" class="pudge-obj-link">withClass</a>(self, soClass)</tt>
<a href="sqlobject/index.py.html?f=179&l=182#179" title="View Source">...</a>
</h4>
<div class="pudge-section rst">
</div>
</div>
<p>
<small>
See
<a href="sqlobject/index.py.html?f=134&l=188#134" title="sqlobject/index.py:134">the source</a>
for more information.
</small>
</p>
|
